Class: MatrixSdk::Client

Inherits:
Object show all
Extended by:
Forwardable
Includes:
Logging
Defined in:
lib/matrix_sdk/client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Logging

#logger

Constructor Details

#initialize(hs_url, client_cache: :all, **params) ⇒ Client

Returns a new instance of Client.

Parameters:

  • hs_url (String, URI, Api) —

    The URL to the Matrix homeserver, without the /_matrix/ part, or an existing Api instance

  • client_cache (:all, :some, :none) (defaults to: :all) —

    (:all) How much data should be cached in the client

  • params (Hash) —

    Additional parameters on creation

Options Hash (**params):

  • :user_id (String, MXID) —

    The user ID of the logged-in user

  • :sync_filter_limit (Integer) — default: 20 —

    Limit of timeline entries in syncs

Raises:

  • (ArgumentError)

See Also:

  • for additional usable params


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/matrix_sdk/client.rb', line 35

def initialize(hs_url, client_cache: :all, **params)
  event_initialize

  params[:user_id] ||= params[:mxid] if params[:mxid]

  if hs_url.is_a? Api
    @api = hs_url
    params.each do |k, v|
      api.instance_variable_set("@#{k}", v) if api.instance_variable_defined? "@#{k}"
    end
  else
    @api = Api.new hs_url, params
  end

  @rooms = {}
  @users = {}
  @cache = client_cache
  @identity_server = params.fetch(:identity_server, nil)

  @sync_token = nil
  @sync_thread = nil
  @sync_filter = { room: { timeline: { limit: params.fetch(:sync_filter_limit, 20) }, state: { lazy_load_members: true } } }

  @should_listen = false
  @next_batch = nil

  @bad_sync_timeout_limit = 60 * 60

  params.each do |k, v|
    instance_variable_set("@#{k}", v) if instance_variable_defined? "@#{k}"
  end

  raise ArgumentError, 'Cache value must be one of of [:all, :some, :none]' unless %i[all some none].include? @cache

  return unless params[:user_id]

  @mxid = params[:user_id]
end

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.



10
11
12
 
# File 'lib/matrix_sdk/client.rb', line 10

def api
  @api
end

#cache ⇒ Object

Returns the value of attribute cache.



11
12
13
 
# File 'lib/matrix_sdk/client.rb', line 11

def cache
  @cache
end

#sync_filter ⇒ Object

Returns the value of attribute sync_filter.



11
12
13
 
# File 'lib/matrix_sdk/client.rb', line 11

def sync_filter
  @sync_filter
end

Class Method Details

.new_for_domain(domain, **params) ⇒ Object 



21
22
23
24
25
26
27
 
# File 'lib/matrix_sdk/client.rb', line 21

def self.new_for_domain(domain, **params)
  api = MatrixSdk::Api.new_for_domain(domain, keep_wellknown: true)
  return new(api, params) unless api.well_known.key? 'm.identity_server'

  identity_server = MatrixSdk::Api.new(api.well_known['m.identity_server']['base_url'], protocols: %i[IS])
  new(api, params.merge(identity_server: identity_server))
end

Instance Method Details

#create_room(room_alias = nil, params = {}) ⇒ Object 



154
155
156
 
# File 'lib/matrix_sdk/client.rb', line 154

def create_room(room_alias = nil, params = {})
  api.create_room(params.merge(room_alias: room_alias))
end

#find_room(room_id_or_alias, only_canonical: false) ⇒ Object

Raises:

  • (ArgumentError) 


163
164
165
166
167
168
169
170
171
172
 
# File 'lib/matrix_sdk/client.rb', line 163

def find_room(room_id_or_alias, only_canonical: false)
  room_id_or_alias = MXID.new(room_id_or_alias.to_s) unless room_id_or_alias.is_a? MXID
  raise ArgumentError, 'Must be a room id or alias' unless %i[room_id room_alias].include? room_id_or_alias.type

  return @rooms.fetch(room_id_or_alias, nil) if room_id_or_alias.room_id?

  return @rooms.values.find { |r| r.canonical_alias == room_id_or_alias.to_s } if only_canonical

  @rooms.values.find { |r| r.aliases.include? room_id_or_alias.to_s }
end

#get_user(user_id) ⇒ Object 



174
175
176
177
178
179
180
 
# File 'lib/matrix_sdk/client.rb', line 174

def get_user(user_id)
  if cache == :all
    @users[user_id] ||= User.new(self, user_id)
  else
    User.new(self, user_id)
  end
end

#join_room(room_id_or_alias) ⇒ Object 



158
159
160
161
 
# File 'lib/matrix_sdk/client.rb', line 158

def join_room(room_id_or_alias)
  data = api.join_room(room_id_or_alias)
  ensure_room(data.fetch(:room_id, room_id_or_alias))
end

#logged_in? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/matrix_sdk/client.rb', line 150

def logged_in?
  !(mxid.nil? || @api.access_token.nil?)
end

#login(username, password, sync_timeout: 15, full_state: false, **params) ⇒ Object

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/matrix_sdk/client.rb', line 110

def (username, password, sync_timeout: 15, full_state: false, **params)
  username = username.to_s unless username.is_a?(String)
  password = password.to_s unless password.is_a?(String)

  raise ArgumentError, "Username can't be nil or empty" if username.nil? || username.empty?
  raise ArgumentError, "Password can't be nil or empty" if password.nil? || password.empty?

  data = api.(user: username, password: password)
  post_authentication(data)

  return if params[:no_sync]

  sync timeout: sync_timeout,
       full_state: full_state,
       allow_sync_retry: params.fetch(:allow_sync_retry, nil)
end

#login_with_token(username, token, sync_timeout: 15, full_state: false, **params) ⇒ Object

Raises:

  • (ArgumentError) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/matrix_sdk/client.rb', line 127

def (username, token, sync_timeout: 15, full_state: false, **params)
  username = username.to_s unless username.is_a?(String)
  token = token.to_s unless token.is_a?(String)

  raise ArgumentError, "Username can't be nil or empty" if username.nil? || username.empty?
  raise ArgumentError, "Token can't be nil or empty" if token.nil? || token.empty?

  data = api.(user: username, token: token, type: 'm.login.token')
  post_authentication(data)

  return if params[:no_sync]

  sync timeout: sync_timeout,
       full_state: full_state,
       allow_sync_retry: params.fetch(:allow_sync_retry, nil)
end

#logout ⇒ Object 



144
145
146
147
148
 
# File 'lib/matrix_sdk/client.rb', line 144

def logout
  api.logout
  @api.access_token = nil
  @mxid = nil
end

#mxid ⇒ Object Also known as: user_id 



74
75
76
77
78
 
# File 'lib/matrix_sdk/client.rb', line 74

def mxid
  @mxid ||= begin
    api.whoami?[:user_id] if api && api.access_token
  end
end

#mxid=(id) ⇒ Object Also known as: user_id=

Raises:

  • (ArgumentError) 


80
81
82
83
84
85
 
# File 'lib/matrix_sdk/client.rb', line 80

def mxid=(id)
  id = MXID.new id.to_s unless id.is_a? MXID
  raise ArgumentError, 'Must be a User ID' unless id.user?

  @mxid = id
end

#register_as_guest ⇒ Object 



94
95
96
97
 
# File 'lib/matrix_sdk/client.rb', line 94

def register_as_guest
  data = api.register(kind: :guest)
  post_authentication(data)
end

#register_with_password(username, password) ⇒ Object

Raises:

  • (ArgumentError) 


99
100
101
102
103
104
105
106
107
108
 
# File 'lib/matrix_sdk/client.rb', line 99

def register_with_password(username, password)
  username = username.to_s unless username.is_a?(String)
  password = password.to_s unless password.is_a?(String)

  raise ArgumentError, "Username can't be nil or empty" if username.nil? || username.empty?
  raise ArgumentError, "Password can't be nil or empty" if password.nil? || username.empty?

  data = api.register(auth: { type: 'm.login.dummy' }, username: username, password: password)
  post_authentication(data)
end

#remove_room_alias(room_alias) ⇒ Object 



182
183
184
 
# File 'lib/matrix_sdk/client.rb', line 182

def remove_room_alias(room_alias)
  api.remove_room_alias(room_alias)
end

#rooms ⇒ Object 



90
91
92
 
# File 'lib/matrix_sdk/client.rb', line 90

def rooms
  @rooms.values
end

#start_listener_thread(params = {}) ⇒ Object 



193
194
195
196
197
198
 
# File 'lib/matrix_sdk/client.rb', line 193

def start_listener_thread(params = {})
  @should_listen = true
  thread = Thread.new { listen_forever(params) }
  @sync_thread = thread
  thread.run
end

#stop_listener_thread ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/matrix_sdk/client.rb', line 200

def stop_listener_thread
  return unless @sync_thread

  @should_listen = false
  @sync_thread.join if @sync_thread.alive?
  @sync_thread = nil
end

#sync(skip_store_batch: false, **params) ⇒ Object Also known as: listen_for_events 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/matrix_sdk/client.rb', line 208

def sync(skip_store_batch: false, **params)
  extra_params = {
    filter: sync_filter,
    timeout: 30
  }
  extra_params[:since] = @next_batch unless @next_batch.nil?
  extra_params.merge!(params)
  extra_params[:filter] = extra_params[:filter].to_json unless extra_params[:filter].is_a? String

  attempts = 0
  data = loop do
    begin
      break api.sync extra_params
    rescue MatrixSdk::MatrixTimeoutError => e
      raise e if (attempts += 1) >= params.fetch(:allow_sync_retry, 0)
    end
  end

  @next_batch = data[:next_batch] unless skip_store_batch

  handle_sync_response(data)
end

#upload(content, content_type) ⇒ Object

Raises:



186
187
188
189
190
191
 
# File 'lib/matrix_sdk/client.rb', line 186

def upload(content, content_type)
  data = api.media_upload(content, content_type)
  return data[:content_uri] if data.key? :content_uri

  raise MatrixUnexpectedResponseError, 'Upload succeeded, but no media URI returned'
end