matrix_sdk 2.1.2 → 2.4.0

data/lib/matrix_sdk/errors.rb

@@ -41,9 +41,13 @@ module MatrixSdk
   end
 
   class MatrixNotAuthorizedError < MatrixRequestError; end
+
   class MatrixForbiddenError < MatrixRequestError; end
+
   class MatrixNotFoundError < MatrixRequestError; end
+
   class MatrixConflictError < MatrixRequestError; end
+
   class MatrixTooManyRequestsError < MatrixRequestError; end
 
   # An error raised when errors occur in the connection layer

data/lib/matrix_sdk/mxid.rb

@@ -12,7 +12,7 @@ module MatrixSdk
 
       # TODO: Community-as-a-Room / Profile-as-a-Room, in case they're going for room aliases
       @sigil = identifier[0]
-      @localpart, @domain, @port = identifier[1..-1].split(':')
+      @localpart, @domain, @port = identifier[1..].split(':')
       @port = @port.to_i if @port
 
       raise ArgumentError, 'Identifier is not a valid MXID' unless valid?
@@ -32,13 +32,13 @@ module MatrixSdk
     #
     # @return [String]
     def homeserver
-      port_s = port ? ':' + port.to_s : ''
+      port_s = port ? ":#{port}" : ''
       domain ? domain + port_s : ''
     end
 
     # Gets the homserver part of the ID as a suffix (':homeserver')
     def homeserver_suffix
-      ':' + homeserver if domain
+      ":#{homeserver}" if domain
     end
 
     def to_s
@@ -49,18 +49,13 @@ module MatrixSdk
     #
     # @return [Symbol] The MXID type, one of (:user_id, :room_id, :event_id, :group_id, or :room_alias)
     def type
-      case sigil
-      when '@'
-        :user_id
-      when '!'
-        :room_id
-      when '$'
-        :event_id
-      when '+'
-        :group_id
-      when '#'
-        :room_alias
-      end
+      {
+        '@' => :user_id,
+        '!' => :room_id,
+        '$' => :event_id,
+        '+' => :group_id,
+        '#' => :room_alias
+      }[sigil]
     end
 
     # Checks if the ID is valid
@@ -105,5 +100,45 @@ module MatrixSdk
     def room_alias?
       type == :room_alias
     end
+
+    # Converts the MXID to a matrix: URI according to MSC2312
+    # @param event_id [String,MXID] An event ID to append to the URI (only valid for rooms)
+    # @param action [String,Symbol] The action that should be requested
+    # @param via [Array[String]] The list of servers to use for a join
+    # @see https://github.com/matrix-org/matrix-doc/blob/master/proposals/2312-matrix-uri.md
+    def to_uri(event_id: nil, action: nil, via: nil)
+      uri = ''
+
+      case sigil
+      when '@'
+        raise ArgumentError, "can't provide via for user URIs" if via
+        raise ArgumentError, "can't provide event_id for user URIs" if event_id
+
+        uri += 'u'
+      when '#'
+        uri += 'r'
+      when '!'
+        uri += 'roomid'
+      else
+        raise ArgumentError, "this MXID can't be converted to a URI"
+      end
+
+      uri = "matrix:#{uri}/#{localpart}#{homeserver_suffix}"
+
+      uri += "/e/#{event_id.to_s.delete_prefix('$')}" if event_id
+      query = []
+      query << "action=#{action}" if action
+      [via].flatten.compact.each { |v| query << "via=#{v}" }
+
+      uri += "?#{query.join('&')}" unless query.empty?
+
+      URI(uri)
+    end
+
+    # Check if two MXIDs are equal
+    # @return [Boolean]
+    def ==(other)
+      to_s == other.to_s
+    end
   end
 end

data/lib/matrix_sdk/protocols/cs.rb

@@ -584,7 +584,7 @@ module MatrixSdk::Protocols::CS
     }
     content.merge!(params.fetch(:extra_content)) if params.key? :extra_content
 
-    send_message_event(room_id, 'm.room.message', content, params)
+    send_message_event(room_id, 'm.room.message', content, **params)
   end
 
   # Send a geographic location to a room
@@ -610,7 +610,7 @@ module MatrixSdk::Protocols::CS
     content[:info][:thumbnail_url] = params.delete(:thumbnail_url) if params.key? :thumbnail_url
     content[:info][:thumbnail_info] = params.delete(:thumbnail_info) if params.key? :thumbnail_info
 
-    send_message_event(room_id, 'm.room.message', content, params)
+    send_message_event(room_id, 'm.room.message', content, **params)
   end
 
   # Send a plaintext message to a room
@@ -628,7 +628,7 @@ module MatrixSdk::Protocols::CS
       msgtype: params.delete(:msg_type) { 'm.text' },
       body: message
     }
-    send_message_event(room_id, 'm.room.message', content, params)
+    send_message_event(room_id, 'm.room.message', content, **params)
   end
 
   # Send a plaintext emote to a room
@@ -646,7 +646,7 @@ module MatrixSdk::Protocols::CS
       msgtype: params.delete(:msg_type) { 'm.emote' },
       body: emote
     }
-    send_message_event(room_id, 'm.room.message', content, params)
+    send_message_event(room_id, 'm.room.message', content, **params)
   end
 
   # Send a plaintext notice to a room
@@ -664,7 +664,7 @@ module MatrixSdk::Protocols::CS
       msgtype: params.delete(:msg_type) { 'm.notice' },
       body: notice
     }
-    send_message_event(room_id, 'm.room.message', content, params)
+    send_message_event(room_id, 'm.room.message', content, **params)
   end
 
   # Report an event in a room
@@ -702,7 +702,7 @@ module MatrixSdk::Protocols::CS
   # @return [Response] A response hash with the message information containing :start, :end, and :chunk fields
   # @see https://matrix.org/docs/spec/client_server/latest.html#get-matrix-client-r0-rooms-roomid-messages
   #      The Matrix Spec, for more information about the call and response
-  def get_room_messages(room_id, token, direction, limit: 10, **params)
+  def get_room_messages(room_id, token, direction:, limit: 10, **params)
     query = {
       from: token,
       dir: direction,
@@ -767,6 +767,30 @@ module MatrixSdk::Protocols::CS
     request(:get, :client_r0, "/rooms/#{room_id}/state", query: query)
   end
 
+  # Retrieves number of events that happened just before and after the specified event
+  #
+  # @param room_id [MXID,String] The room to get events from.
+  # @param event_id [MXID,String] The event to get context around.
+  # @option params [Integer] :limit (10) The limit of messages to retrieve
+  # @option params [String] :filter A filter to limit the retrieval to
+  # @return [Response] A response hash with contextual event information
+  # @see https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-rooms-roomid-context-eventid
+  #      The Matrix Spec, for more information about the call and response
+  # @example Find event context with filter and limit specified
+  #   api.get_room_event_context('#room:example.com', '$event_id:example.com', filter: { types: ['m.room.message'] }.to_json, limit: 20)
+  def get_room_event_context(room_id, event_id, **params)
+    query = {}
+    query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
+
+    query[:limit] = params.fetch(:limit) if params.key? :limit
+    query[:filter] = params.fetch(:filter) if params.key? :filter
+
+    room_id = ERB::Util.url_encode room_id.to_s
+    event_id = ERB::Util.url_encode event_id.to_s
+
+    request(:get, :client_r0, "/rooms/#{room_id}/context/#{event_id}", query: query)
+  end
+
   ## Specialized getters for specced state
   #
 
@@ -780,7 +804,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-name
   #      The Matrix Spec, for more information about the event and data
   def get_room_name(room_id, **params)
-    get_room_state(room_id, 'm.room.name', params)
+    get_room_state(room_id, 'm.room.name', **params)
   end
 
   # Sets the display name of a room
@@ -795,7 +819,7 @@ module MatrixSdk::Protocols::CS
     content = {
       name: name
     }
-    send_state_event(room_id, 'm.room.name', content, params)
+    send_state_event(room_id, 'm.room.name', content, **params)
   end
 
   # Gets the current topic of a room
@@ -808,7 +832,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-topic
   #      The Matrix Spec, for more information about the event and data
   def get_room_topic(room_id, **params)
-    get_room_state(room_id, 'm.room.topic', params)
+    get_room_state(room_id, 'm.room.topic', **params)
   end
 
   # Sets the topic of a room
@@ -823,7 +847,7 @@ module MatrixSdk::Protocols::CS
     content = {
       topic: topic
     }
-    send_state_event(room_id, 'm.room.topic', content, params)
+    send_state_event(room_id, 'm.room.topic', content, **params)
   end
 
   # Gets the current avatar URL of a room
@@ -836,7 +860,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-avatar
   #      The Matrix Spec, for more information about the event and data
   def get_room_avatar(room_id, **params)
-    get_room_state(room_id, 'm.room.avatar', params)
+    get_room_state(room_id, 'm.room.avatar', **params)
   end
 
   # Sets the avatar URL for a room
@@ -851,7 +875,7 @@ module MatrixSdk::Protocols::CS
     content = {
       url: url
     }
-    send_state_event(room_id, 'm.room.avatar', content, params)
+    send_state_event(room_id, 'm.room.avatar', content, **params)
   end
 
   # Gets a list of current aliases of a room
@@ -878,7 +902,7 @@ module MatrixSdk::Protocols::CS
   #      .compact
   #   # => ["#synapse:im.kabi.tk", "#synapse:matrix.org", "#synapse-community:matrix.org", "#synapse-ops:matrix.org", "#synops:matrix.org", ...
   def get_room_aliases(room_id, **params)
-    get_room_state(room_id, 'm.room.aliases', params)
+    get_room_state(room_id, 'm.room.aliases', **params)
   end
 
   # Gets a list of pinned events in a room
@@ -891,7 +915,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-pinned-events
   #      The Matrix Spec, for more information about the event and data
   def get_room_pinned_events(room_id, **params)
-    get_room_state(room_id, 'm.room.pinned_events', params)
+    get_room_state(room_id, 'm.room.pinned_events', **params)
   end
 
   # Sets the list of pinned events in a room
@@ -906,7 +930,7 @@ module MatrixSdk::Protocols::CS
     content = {
       pinned: events
     }
-    send_state_event(room_id, 'm.room.pinned_events', content, params)
+    send_state_event(room_id, 'm.room.pinned_events', content, **params)
   end
 
   # Gets the configured power levels for a room
@@ -918,7 +942,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-power-levels
   #      The Matrix Spec, for more information about the event and data
   def get_room_power_levels(room_id, **params)
-    get_room_state(room_id, 'm.room.power_levels', params)
+    get_room_state(room_id, 'm.room.power_levels', **params)
   end
   alias get_power_levels get_room_power_levels
 
@@ -932,7 +956,7 @@ module MatrixSdk::Protocols::CS
   #      The Matrix Spec, for more information about the event and data
   def set_room_power_levels(room_id, content, **params)
     content[:events] = {} unless content.key? :events
-    send_state_event(room_id, 'm.room.power_levels', content, params)
+    send_state_event(room_id, 'm.room.power_levels', content, **params)
   end
   alias set_power_levels set_room_power_levels
 
@@ -945,7 +969,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-join-rules
   #      The Matrix Spec, for more information about the event and data
   def get_room_join_rules(room_id, **params)
-    get_room_state(room_id, 'm.room.join_rules', params)
+    get_room_state(room_id, 'm.room.join_rules', **params)
   end
 
   # Sets the join rules for a room
@@ -961,7 +985,7 @@ module MatrixSdk::Protocols::CS
       join_rule: join_rule
     }
 
-    send_state_event(room_id, 'm.room.join_rules', content, params)
+    send_state_event(room_id, 'm.room.join_rules', content, **params)
   end
 
   # Gets the guest access settings for a room
@@ -973,7 +997,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-guest-access
   #      The Matrix Spec, for more information about the event and data
   def get_room_guest_access(room_id, **params)
-    get_room_state(room_id, 'm.room.guest_access', params)
+    get_room_state(room_id, 'm.room.guest_access', **params)
   end
 
   # Sets the guest access settings for a room
@@ -989,7 +1013,7 @@ module MatrixSdk::Protocols::CS
       guest_access: guest_access
     }
 
-    send_state_event(room_id, 'm.room.guest_access', content, params)
+    send_state_event(room_id, 'm.room.guest_access', content, **params)
   end
 
   # Gets the creation configuration object for a room
@@ -1001,7 +1025,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-create
   #      The Matrix Spec, for more information about the event and data
   def get_room_creation_info(room_id, **params)
-    get_room_state(room_id, 'm.room.create', params)
+    get_room_state(room_id, 'm.room.create', **params)
   end
 
   # Gets the encryption configuration for a room
@@ -1013,7 +1037,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-encryption
   #      The Matrix Spec, for more information about the event and data
   def get_room_encryption_settings(room_id, **params)
-    get_room_state(room_id, 'm.room.encryption', params)
+    get_room_state(room_id, 'm.room.encryption', **params)
   end
 
   # Sets the encryption configuration for a room
@@ -1032,7 +1056,7 @@ module MatrixSdk::Protocols::CS
       rotation_period_ms: rotation_period_ms,
       rotation_period_msgs: rotation_period_msgs
     }
-    send_state_event(room_id, 'm.room.encryption', content, params)
+    send_state_event(room_id, 'm.room.encryption', content, **params)
   end
 
   # Gets the history availabiilty for a room
@@ -1044,7 +1068,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-history-visibility
   #      The Matrix Spec, for more information about the event and data
   def get_room_history_visibility(room_id, **params)
-    get_room_state(room_id, 'm.room.history_visibility', params)
+    get_room_state(room_id, 'm.room.history_visibility', **params)
   end
 
   # Sets the history availability for a room
@@ -1060,7 +1084,7 @@ module MatrixSdk::Protocols::CS
       history_visibility: visibility
     }
 
-    send_state_event(room_id, 'm.room.history_visibility', content, params)
+    send_state_event(room_id, 'm.room.history_visibility', content, **params)
   end
 
   # Gets the server ACLs for a room
@@ -1072,7 +1096,7 @@ module MatrixSdk::Protocols::CS
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-server-acl
   #      The Matrix Spec, for more information about the event and data
   def get_room_server_acl(room_id, **params)
-    get_room_state(room_id, 'm.room.server_acl', params)
+    get_room_state(room_id, 'm.room.server_acl', **params)
   end
 
   # Sets the server ACL configuration for a room
@@ -1085,14 +1109,14 @@ module MatrixSdk::Protocols::CS
   # @return [Response] The resulting state event
   # @see https://matrix.org/docs/spec/client_server/latest.html#m-room-guest-server-acl
   #      The Matrix Spec, for more information about the event and data
-  def set_room_server_acl(room_id, allow_ip_literals: false, allow:, deny:, **params)
+  def set_room_server_acl(room_id, allow:, deny:, allow_ip_literals: false, **params)
     content = {
       allow_ip_literals: allow_ip_literals,
       allow: allow,
       deny: deny
     }
 
-    send_state_event(room_id, 'm.room.server_acl', content, params)
+    send_state_event(room_id, 'm.room.server_acl', content, **params)
   end
 
   def leave_room(room_id, **params)
@@ -1411,7 +1435,7 @@ module MatrixSdk::Protocols::CS
   #   api.set_avatar_url(api.whoami?[:user_id], mxc)
   #
   # @param [String,MXID] user_id The ID of the user to set the avatar for
-  # @param [String,URI::MATRIX] url The new avatar URL, should be a mxc:// URL
+  # @param [String,URI::MXC] url The new avatar URL, should be a mxc:// URL
   # @return [Response] An empty response hash if the change was successful
   # @see https://matrix.org/docs/spec/client_server/latest#put-matrix-client-r0-profile-userid-avatar-url
   #      The Matrix Spec, for more information about the event and data
@@ -1521,7 +1545,7 @@ module MatrixSdk::Protocols::CS
   #   # => #<URI::HTTPS https://matrix.org/_matrix/media/r0/download/example.com/media_hash>
   def get_download_url(mxcurl, source: nil, **_params)
     mxcurl = URI.parse(mxcurl.to_s) unless mxcurl.is_a? URI
-    raise 'Not a mxc:// URL' unless mxcurl.is_a? URI::MATRIX
+    raise 'Not a mxc:// URL' unless mxcurl.is_a? URI::MXC
 
     if source
       source = "https://#{source}" unless source.include? '://'
@@ -1712,7 +1736,7 @@ module MatrixSdk::Protocols::CS
   #   # => { :device_keys => { :'@alice:example.com' => { :ABCDEFGHIJ => { ...
   # @see https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-keys-query
   #      The Matrix Spec, for more information about the parameters and data
-  def keys_query(timeout: nil, device_keys:, token: nil, **params)
+  def keys_query(device_keys:, timeout: nil, token: nil, **params)
     body = {
       timeout: (timeout || 10) * 1000,
       device_keys: device_keys
@@ -1834,7 +1858,7 @@ module MatrixSdk::Protocols::CS
   # @return [Response] A response hash containing the full data of the requested push rule
   # @see https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushrules-scope-kind-ruleid
   #      The Matrix Spec, for more information about the parameters and data
-  def get_pushrule(scope: 'global', kind:, id:)
+  def get_pushrule(kind:, id:, scope: 'global')
     scope = ERB::Util.url_encode scope.to_s
     kind = ERB::Util.url_encode kind.to_s
     id = ERB::Util.url_encode id.to_s
@@ -1850,7 +1874,7 @@ module MatrixSdk::Protocols::CS
   # @return [Response] A response hash containing an :enabled key for if the rule is enabled or not
   # @see https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushrules-scope-kind-ruleid-enabled
   #      The Matrix Spec, for more information about the parameters and data
-  def get_pushrule_enabled(scope: 'global', kind:, id:)
+  def get_pushrule_enabled(kind:, id:, scope: 'global')
     scope = ERB::Util.url_encode scope.to_s
     kind = ERB::Util.url_encode kind.to_s
     id = ERB::Util.url_encode id.to_s
@@ -1867,7 +1891,7 @@ module MatrixSdk::Protocols::CS
   # @return [Response] An empty response hash if the push rule was enabled/disabled successfully
   # @see https://matrix.org/docs/spec/client_server/latest#put-matrix-client-r0-pushrules-scope-kind-ruleid-enabled
   #      The Matrix Spec, for more information about the parameters and data
-  def set_pushrule_enabled(enabled, scope: 'global', kind:, id:)
+  def set_pushrule_enabled(enabled, kind:, id:, scope: 'global')
     scope = ERB::Util.url_encode scope.to_s
     kind = ERB::Util.url_encode kind.to_s
     id = ERB::Util.url_encode id.to_s
@@ -1887,7 +1911,7 @@ module MatrixSdk::Protocols::CS
   # @return [Response] A response hash containing an :enabled key for if the rule is enabled or not
   # @see https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-pushrules-scope-kind-ruleid-actions
   #      The Matrix Spec, for more information about the parameters and data
-  def get_pushrule_actions(scope: 'global', kind:, id:)
+  def get_pushrule_actions(kind:, id:, scope: 'global')
     scope = ERB::Util.url_encode scope.to_s
     kind = ERB::Util.url_encode kind.to_s
     id = ERB::Util.url_encode id.to_s
@@ -1904,7 +1928,7 @@ module MatrixSdk::Protocols::CS
   # @return [Response] An empty response hash if the push rule actions were modified successfully
   # @see https://matrix.org/docs/spec/client_server/latest#put-matrix-client-r0-pushrules-scope-kind-ruleid-actions
   #      The Matrix Spec, for more information about the parameters and data
-  def set_pushrule_actions(actions, scope: 'global', kind:, id:)
+  def set_pushrule_actions(actions, kind:, id:, scope: 'global')
     scope = ERB::Util.url_encode scope.to_s
     kind = ERB::Util.url_encode kind.to_s
     id = ERB::Util.url_encode id.to_s