matrix_sdk 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 550080056a38ee354ff8e633069d71f207e1927a567fcaed4f7ed9792bcbb79a
-  data.tar.gz: ae8909f5a1092873453c4b7a876315efd29882cee353252d9bd92f069ce3c4ac
+  metadata.gz: 4f16ccd1ed10b02a963b9dbd736e577375ca41b26fb45743bc0344f219b1d70f
+  data.tar.gz: 3d8eef54f71ccf9e04c0da896e6189fd8d4c2c34c269e2890de37dd4cec023a6
 SHA512:
-  metadata.gz: 5838b47c8ea7df7becdb7dadcb07e57c31526c8c3cdd025a18cc2add7db9e9da9f0aff62a16ed4a3a5306566785f941e7cdba90e664f2b872959c7774b4ec4bc
-  data.tar.gz: 3fcad5ea834b2dd0e6d68e55a8e88e5a88b444d07491f381420c4749ca1ff5375030f3a7c4b1b535ff947422caf7c4b86f81633d425614a05e5577aa9a4963ff
+  metadata.gz: 01de0cccbcf0724a101526190ea4e164ec1235daaa0e0c3d42ed445e760246b2b81a054ba4bd7e88229fdb0833e4fe3a8624a4de3dfd032bfa50b4f23946caf1
+  data.tar.gz: 1b177862e3b01aef4c10de6a4318b8348a5c6e00885f0b137ce13a269bf0d5579e6a72b93a87a9366b8d75ec2549518a7d21f2da5db4d7f1d60fa464ff11d83b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.2.0 - 2020-11-20
+
+- Adds direct message (1:1) room mapping to client abstraction
+- Adds Api#get_room_event_context (#13)
+- Improves support for JRuby
+
 ## 2.1.3 - 2020-09-18
 
 - Adds separate state event handler as Client#on_state_event

data/lib/matrix_sdk/api.rb

@@ -268,23 +268,6 @@ module MatrixSdk
         u.query = [u.query, URI.encode_www_form(options.fetch(:query))].flatten.compact.join('&') if options[:query]
         u.query = nil if u.query.nil? || u.query.empty?
       end
-      request = Net::HTTP.const_get(method.to_s.capitalize.to_sym).new url.request_uri
-      request.body = options[:body] if options.key? :body
-      request.body = request.body.to_json if options.key?(:body) && !request.body.is_a?(String)
-      request.body_stream = options[:body_stream] if options.key? :body_stream
-
-      global_headers.each { |h, v| request[h] = v }
-      if request.body || request.body_stream
-        request.content_type = 'application/json'
-        request.content_length = (request.body || request.body_stream).size
-      end
-
-      request['authorization'] = "Bearer #{access_token}" if access_token && !options.fetch(:skip_auth, false)
-      if options.key? :headers
-        options[:headers].each do |h, v|
-          request[h.to_s.downcase] = v
-        end
-      end
 
       failures = 0
       loop do
@@ -292,10 +275,11 @@ module MatrixSdk
 
         req_id = ('A'..'Z').to_a.sample(4).join
 
-        print_http(request, id: req_id)
+        req_obj = construct_request(url: url, method: method, **options)
+        print_http(req_obj, id: req_id)
         begin
           dur_start = Time.now
-          response = http.request request
+          response = http.request req_obj
           dur_end = Time.now
           duration = dur_end - dur_start
         rescue EOFError
@@ -344,14 +328,38 @@ module MatrixSdk
 
     private
 
+    def construct_request(method:, url:, **options)
+      request = Net::HTTP.const_get(method.to_s.capitalize.to_sym).new url.request_uri
+
+      # FIXME: Handle bodies better, avoid duplicating work
+      request.body = options[:body] if options.key? :body
+      request.body = request.body.to_json if options.key?(:body) && !request.body.is_a?(String)
+      request.body_stream = options[:body_stream] if options.key? :body_stream
+
+      global_headers.each { |h, v| request[h] = v }
+      if request.body || request.body_stream
+        request.content_type = 'application/json'
+        request.content_length = (request.body || request.body_stream).size
+      end
+
+      request['authorization'] = "Bearer #{access_token}" if access_token && !options.fetch(:skip_auth, false)
+      if options.key? :headers
+        options[:headers].each do |h, v|
+          request[h.to_s.downcase] = v
+        end
+      end
+
+      request
+    end
+
     def print_http(http, body: true, duration: nil, id: nil)
       return unless logger.debug?
 
       if http.is_a? Net::HTTPRequest
-        dir = "#{id ? id + ' : ' : nil}>"
+        dir = "#{id ? "#{id} : " : nil}>"
         logger.debug "#{dir} Sending a #{http.method} request to `#{http.path}`:"
       else
-        dir = "#{id ? id + ' : ' : nil}<"
+        dir = "#{id ? "#{id} : " : nil}<"
         logger.debug "#{dir} Received a #{http.code} #{http.message} response:#{duration ? " [#{(duration * 1000).to_i}ms]" : nil}"
       end
       http.to_hash.map { |k, v| "#{k}: #{k == 'authorization' ? '[ REDACTED ]' : v.join(', ')}" }.each do |h|
@@ -360,7 +368,7 @@ module MatrixSdk
       logger.debug dir
       if body
         clean_body = JSON.parse(http.body) rescue nil if http.body
-        clean_body.keys.each { |k| clean_body[k] = '[ REDACTED ]' if %w[password access_token].include?(k) }.to_json if clean_body.is_a? Hash
+        clean_body.each_key { |k| clean_body[k] = '[ REDACTED ]' if %w[password access_token].include?(k) }.to_json if clean_body.is_a? Hash
         clean_body = clean_body.to_s if clean_body
         logger.debug "#{dir} #{clean_body.length < 200 ? clean_body : clean_body.slice(0..200) + "... [truncated, #{clean_body.length} Bytes]"}" if clean_body
       end

data/lib/matrix_sdk/client.rb

@@ -156,6 +156,27 @@ module MatrixSdk
       rooms
     end
 
+    # Gets a list of all direct chat rooms (1:1 chats / direct message chats) for the currenct user
+    #
+    # @return [Hash[String,Array[String]]] A mapping of MXIDs to a list of direct rooms with that user
+    def direct_rooms
+      Hash[api.get_account_data(mxid, 'm.direct').map do |mxid, rooms|
+        [mxid.to_s, rooms]
+      end]
+    end
+
+    # Gets a direct message room for the given user if one exists
+    #
+    # @note Will return the oldest room if multiple exist
+    # @return [Room,nil] A direct message room if one exists
+    def direct_room(mxid)
+      mxid = MatrixSdk::MXID.new mxid.to_s unless mxid.is_a? MatrixSdk::MXID
+      raise ArgumentError, 'Must be a valid user ID' unless mxid.user?
+
+      room_id = direct_rooms[mxid.to_s]&.first
+      ensure_room room_id if room_id
+    end
+
     # Gets a list of all relevant rooms, either the ones currently handled by
     # the client, or the list of currently joined ones if no rooms are handled
     #
@@ -433,10 +454,11 @@ module MatrixSdk
         errors = 0
         thread, cancel_token = api.msc2108_sync_sse(params) do |data, event:, id:|
           @next_batch = id if id
-          if event.to_sym == :sync
+          case event.to_sym
+          when :sync
             handle_sync_response(data)
             errors = 0
-          elsif event.to_sym == :sync_error
+          when :sync_error
             logger.error "SSE Sync error received; #{data.type}: #{data.message}"
             errors += 1
 

data/lib/matrix_sdk/extensions.rb

@@ -191,7 +191,9 @@ module MatrixSdk
     end
 
     def respond_to_missing?(method, *)
-      event.key? method
+      return true if event.key? method
+
+      super
     end
   end
 end

data/lib/matrix_sdk/mxid.rb

@@ -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

data/lib/matrix_sdk/protocols/cs.rb

@@ -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
   #
 
@@ -1085,7 +1109,7 @@ 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,
@@ -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

data/lib/matrix_sdk/protocols/msc.rb

@@ -47,7 +47,7 @@ module MatrixSdk::Protocols::MSC
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
 
     req = Net::HTTP::Get.new(homeserver.dup.tap do |u|
-      u.path = api_to_path(:client_r0) + '/sync/sse'
+      u.path = "#{api_to_path :client_r0}/sync/sse"
       u.query = URI.encode_www_form(query)
     end)
     req['accept'] = 'text/event-stream'

data/lib/matrix_sdk/response.rb

@@ -46,7 +46,9 @@ module MatrixSdk
       attr_reader :api
 
       def respond_to_missing?(name, *_args)
-        key? name
+        return true if key? name
+
+        super
       end
 
       def method_missing(name, *args)

data/lib/matrix_sdk/room.rb

@@ -104,7 +104,6 @@ module MatrixSdk
       logger.debug "Created room #{room_id}"
     end
 
-
     #
     # Event handlers
     #
@@ -127,7 +126,6 @@ module MatrixSdk
       ensure_room_handlers[:ephemeral_event]
     end
 
-
     #
     # State readers
     #
@@ -365,7 +363,7 @@ module MatrixSdk
     # @param reverse [Boolean] whether to fill messages in reverse or not
     # @param limit [Integer] the maximum number of messages to backfill
     # @note This will trigger the `on_event` events as messages are added
-    def backfill_messages(reverse = false, limit = 10)
+    def backfill_messages(reverse = false, limit = 10) # rubocop:disable Style/OptionalBooleanParameter
       data = client.api.get_room_messages(id, @prev_batch, direction: :b, limit: limit)
 
       events = data[:chunk]

data/lib/matrix_sdk/user.rb

@@ -122,6 +122,14 @@ module MatrixSdk
       Time.now - (since / 1000)
     end
 
+    # Gets a direct message room with the user if one exists
+    #
+    # @return [Room,nil] A direct message room if one exists
+    # @see MatrixSdk::Client#direct_room
+    def direct_room
+      client.direct_room(id)
+    end
+
     # Returns all the current device keys for the user, retrieving them if necessary
     def device_keys
       @device_keys ||= client.api.keys_query(device_keys: { id => [] }).yield_self do |resp|

data/lib/matrix_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MatrixSdk
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha