matrix_sdk 2.1.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 550080056a38ee354ff8e633069d71f207e1927a567fcaed4f7ed9792bcbb79a
-  data.tar.gz: ae8909f5a1092873453c4b7a876315efd29882cee353252d9bd92f069ce3c4ac
+  metadata.gz: 24a67aeb6af66f75480104c5c0dc44987e2fe54163ed96047da58bf091476752
+  data.tar.gz: e5935a94b430a1b195b55d748415cc0ad95ea649e32f5e97045cc82726dd2bd3
 SHA512:
-  metadata.gz: 5838b47c8ea7df7becdb7dadcb07e57c31526c8c3cdd025a18cc2add7db9e9da9f0aff62a16ed4a3a5306566785f941e7cdba90e664f2b872959c7774b4ec4bc
-  data.tar.gz: 3fcad5ea834b2dd0e6d68e55a8e88e5a88b444d07491f381420c4749ca1ff5375030f3a7c4b1b535ff947422caf7c4b86f81633d425614a05e5577aa9a4963ff
+  metadata.gz: 1ea88ea4c76b573dad7b03aeba49e91b8f7c01040118c38032b49ca00cfbe687bd931c4e17387545e27df529f6ae06fc835ee964b5e79489fb0c5cf84186b35b
+  data.tar.gz: e2a6a5cd78e7629ffb2cc4af5ec9c9154f2f63db570479ebb2c6fa9aff13b7b231bea877d56694ae799019698af8d4a87394f88fa162dcb172dbbd1ede09fc8f

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## 2.5.0 - 2022-01-14
+
+- Adds preliminary support for the Matrix v1.1 `client/v3` API
+- Adds some support for knocking rooms
+- Adds mutex synchronization on API requests to avoid some threading issues
+- Fixes error on attempting to skip cache for certain requests (#19)
+- Fixes inconsistency in MXID typing for the Client abstraction (#18 #20)
+- Fixes missed autoloader entries for errors (#22)
+- Fixes some potential issues arising from broken user-provided state data
+
+## 2.4.0 - 2021-07-19
+
+- Adds support for matrix: URI's according to MSC2312
+- Adds some basic support for detecting Spaces (MSC1772)
+- Fixes sync against Synapse 1.38.0 missing empty fields
+
+## 2.3.0 - 2021-03-26
+
+- Adds support for Ruby 3.0 (#15)
+- Adds support for requests against the Synapse admin API
+- Adds helper methods for checking and changing user power levels
+- Adds a proper caching system for room data
+- Fixes argument error in `#get_room_messages`
+- Removes unfinished and broken AS abstraction
+
+## 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/README.md

@@ -4,7 +4,7 @@ A Ruby gem for easing the development of software that communicates with servers
 
 There is a Matrix room for the discussion about usage and development at [#ruby-matrix-sdk:kittenface.studio](https://matrix.to/#/#ruby-matrix-sdk:kittenface.studio).
 
-Live YARD documentation can be found at; http://aleol57.gitlab-pages.liu.se/ruby-matrix-sdk
+Live YARD documentation can be found at; https://ruby-sdk.ananace.dev
 
 ## Example usage
 

data/lib/matrix_sdk/api.rb

@@ -38,6 +38,7 @@ module MatrixSdk
     # @option params [Numeric] :read_timeout (240) The timeout in seconds for reading responses
     # @option params [Hash] :global_headers Additional headers to set for all requests
     # @option params [Boolean] :skip_login Should the API skip logging in if the HS URL contains user information
+    # @option params [Boolean] :synapse (true) Is the API connecting to a Synapse instance
     # @option params [Hash] :well_known The .well-known object that the server was discovered through, should not be set manually
     def initialize(homeserver, **params)
       @homeserver = homeserver
@@ -56,12 +57,14 @@ module MatrixSdk
       @validate_certificate = params.fetch(:validate_certificate, false)
       @transaction_id = params.fetch(:transaction_id, 0)
       @backoff_time = params.fetch(:backoff_time, 5000)
-      @open_timeout = params.fetch(:open_timeout, 60)
-      @read_timeout = params.fetch(:read_timeout, 240)
+      @open_timeout = params.fetch(:open_timeout, nil)
+      @read_timeout = params.fetch(:read_timeout, nil)
       @well_known = params.fetch(:well_known, {})
       @global_headers = DEFAULT_HEADERS.dup
       @global_headers.merge!(params.fetch(:global_headers)) if params.key? :global_headers
+      @synapse = params.fetch(:synapse, true)
       @http = nil
+      @http_lock = Mutex.new
 
       ([params.fetch(:protocols, [:CS])].flatten - protocols).each do |proto|
         self.class.include MatrixSdk::Protocols.const_get(proto)
@@ -161,11 +164,13 @@ module MatrixSdk
 
       params[:well_known] = well_known if keep_wellknown
 
-      new(uri,
-          params.merge(
-            address: target_uri.host,
-            port: target_uri.port
-          ))
+      new(
+        uri,
+        **params.merge(
+          address: target_uri.host,
+          port: target_uri.port
+        )
+      )
     end
 
     # Get a list of enabled protocols on the API client
@@ -268,23 +273,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 +280,13 @@ module MatrixSdk
 
         req_id = ('A'..'Z').to_a.sample(4).join
 
-        print_http(request, id: req_id)
-        begin
+        req_obj = construct_request(url: url, method: method, **options)
+        print_http(req_obj, id: req_id)
+        response = duration = nil
+
+        @http_lock.synchronize do
           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 +335,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 +375,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
@@ -369,6 +384,8 @@ module MatrixSdk
     end
 
     def api_to_path(api)
+      return "/_synapse/#{api.to_s.split('_').join('/')}" if @synapse && api.to_s.start_with?('admin_')
+
       # TODO: <api>_current / <api>_latest
       "/_matrix/#{api.to_s.split('_').join('/')}"
     end
@@ -384,8 +401,8 @@ module MatrixSdk
                   Net::HTTP.new(host, port)
                 end
 
-      @http.open_timeout = open_timeout
-      @http.read_timeout = read_timeout
+      @http.open_timeout = open_timeout if open_timeout
+      @http.read_timeout = read_timeout if read_timeout
       @http.use_ssl = homeserver.scheme == 'https'
       @http.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_PEER : ::OpenSSL::SSL::VERIFY_NONE
       @http.start

data/lib/matrix_sdk/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'matrix_sdk'
+require 'matrix_sdk/util/events'
 
 require 'English'
 require 'forwardable'
@@ -67,11 +68,12 @@ module MatrixSdk
           api.instance_variable_set("@#{k}", v) if api.instance_variable_defined? "@#{k}"
         end
       else
-        @api = Api.new hs_url, params
+        @api = Api.new hs_url, **params
       end
 
       @cache = client_cache
       @identity_server = nil
+      @mxid = nil
 
       @sync_token = nil
       @sync_thread = nil
@@ -101,9 +103,8 @@ module MatrixSdk
     #
     # @return [MXID] The MXID of the current user
     def mxid
-      @mxid ||= begin
-        MXID.new api.whoami?[:user_id] if api&.access_token
-      end
+      @mxid ||= MXID.new api.whoami?[:user_id] if api&.access_token
+      @mxid
     end
 
     alias user_id mxid
@@ -156,6 +157,25 @@ 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
+      api.get_account_data(mxid, 'm.direct').transform_keys(&:to_s)
+    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
     #
@@ -172,6 +192,19 @@ module MatrixSdk
       @rooms.values
     end
 
+    # Get a list of all joined Matrix Spaces
+    #
+    # @return [Array[Room]] All the currently joined Spaces
+    def spaces
+      rooms = if cache == :none
+                api.get_joined_rooms.joined_rooms.map { |id| Room.new(self, id) }
+              else
+                self.rooms
+              end
+
+      rooms.select(&:space?)
+    end
+
     # Refresh the list of currently handled rooms, replacing it with the user's
     # currently joined rooms.
     #
@@ -189,6 +222,7 @@ module MatrixSdk
       true
     end
     alias refresh_rooms! reload_rooms!
+    alias reload_spaces! reload_rooms!
 
     # Register - and log in - on the connected HS as a guest
     #
@@ -339,7 +373,7 @@ module MatrixSdk
     # @return [Room] The resulting room
     # @see Protocols::CS#create_room
     def create_room(room_alias = nil, **params)
-      data = api.create_room(params.merge(room_alias: room_alias))
+      data = api.create_room(**params.merge(room_alias: room_alias))
       ensure_room(data.room_id)
     end
 
@@ -407,13 +441,13 @@ module MatrixSdk
 
     # Upload a piece of data to the media repo
     #
-    # @return [URI::MATRIX] A Matrix content (mxc://) URL pointing to the uploaded data
+    # @return [URI::MXC] A Matrix content (mxc://) URL pointing to the uploaded data
     # @param content [String] The data to upload
     # @param content_type [String] The MIME type of the data
     # @see Protocols::CS#media_upload
     def upload(content, content_type)
       data = api.media_upload(content, content_type)
-      return data[:content_uri] if data.key? :content_uri
+      return URI(data[:content_uri]) if data.key? :content_uri
 
       raise MatrixUnexpectedResponseError, 'Upload succeeded, but no media URI returned'
     end
@@ -433,10 +467,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
 
@@ -447,7 +482,7 @@ module MatrixSdk
 
         @should_listen = cancel_token
       else
-        thread = Thread.new { listen_forever(params) }
+        thread = Thread.new { listen_forever(**params) }
       end
       @sync_thread = thread
       thread.run
@@ -495,11 +530,9 @@ module MatrixSdk
 
       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
+        break api.sync(**extra_params)
+      rescue MatrixSdk::MatrixTimeoutError => e
+        raise e if (attempts += 1) >= params.fetch(:allow_sync_retry, 0)
       end
 
       @next_batch = data[:next_batch] unless skip_store_batch
@@ -519,18 +552,21 @@ module MatrixSdk
       raise ArgumentError, 'Must be a room ID' unless room_id.room_id?
 
       room_id = room_id.to_s
-      @rooms.fetch(room_id) do
+      ret = @rooms.fetch(room_id) do
         room = Room.new(self, room_id)
         @rooms[room_id] = room unless cache == :none
         room
       end
+      # Need to figure out a way to handle multiple types
+      ret = @rooms[room_id] = ret.to_space if ret.instance_variable_get :@room_type
+      ret
     end
 
     def listen_forever(timeout: 30, bad_sync_timeout: 5, sync_interval: 0, **params)
       orig_bad_sync_timeout = bad_sync_timeout + 0
       while @should_listen
         begin
-          sync(params.merge(timeout: timeout))
+          sync(**params.merge(timeout: timeout))
 
           bad_sync_timeout = orig_bad_sync_timeout
           sleep(sync_interval) if sync_interval.positive?
@@ -552,7 +588,7 @@ module MatrixSdk
     private
 
     def post_authentication(data)
-      @mxid = data[:user_id]
+      @mxid = MXID.new data[:user_id]
       @api.access_token = data[:access_token]
       @api.device_id = data[:device_id]
       @api.homeserver = data[:home_server]
@@ -566,65 +602,38 @@ module MatrixSdk
 
       room = ensure_room(room_id)
       room.send :put_state_event, state_event
-      content = state_event[:content]
-      case state_event[:type]
-      when 'm.room.name'
-        room.instance_variable_set '@name', content[:name]
-      when 'm.room.canonical_alias'
-        room.instance_variable_set '@canonical_alias', content[:alias]
-        # Also add as a regular alias
-        room.instance_variable_get('@aliases').concat [content[:alias]]
-      when 'm.room.topic'
-        room.instance_variable_set '@topic', content[:topic]
-      when 'm.room.aliases'
-        room.instance_variable_get('@aliases').concat content[:aliases]
-      when 'm.room.join_rules'
-        room.instance_variable_set '@join_rule', content[:join_rule].nil? ? nil : content[:join_rule].to_sym
-      when 'm.room.guest_access'
-        room.instance_variable_set '@guest_access', content[:guest_access].nil? ? nil : content[:guest_access].to_sym
-      when 'm.room.member'
-        return unless cache == :all
-
-        if content[:membership] == 'join'
-          room.send(:ensure_member, get_user(state_event[:state_key]).dup.tap do |u|
-            u.instance_variable_set :@display_name, content[:displayname]
-          end)
-        elsif %w[leave kick invite].include? content[:membership]
-          room.members.delete_if { |m| m.id == state_event[:state_key] }
-        end
-      end
     end
 
     def handle_sync_response(data)
-      data[:presence][:events].each do |presence_update|
+      data.dig(:presence, :events)&.each do |presence_update|
         fire_presence_event(MatrixEvent.new(self, presence_update))
       end
 
-      data[:rooms][:invite].each do |room_id, invite|
+      data.dig(:rooms, :invite)&.each do |room_id, invite|
         invite[:room_id] = room_id.to_s
         fire_invite_event(MatrixEvent.new(self, invite), room_id.to_s)
       end
 
-      data[:rooms][:leave].each do |room_id, left|
+      data.dig(:rooms, :leave)&.each do |room_id, left|
         left[:room_id] = room_id.to_s
         fire_leave_event(MatrixEvent.new(self, left), room_id.to_s)
       end
 
-      data[:rooms][:join].each do |room_id, join|
+      data.dig(:rooms, :join)&.each do |room_id, join|
         room = ensure_room(room_id)
-        room.instance_variable_set '@prev_batch', join[:timeline][:prev_batch]
+        room.instance_variable_set '@prev_batch', join.dig(:timeline, :prev_batch)
         room.instance_variable_set :@members_loaded, true unless sync_filter.fetch(:room, {}).fetch(:state, {}).fetch(:lazy_load_members, false)
 
-        join[:state][:events].each do |event|
+        join.dig(:state, :events)&.each do |event|
           event[:room_id] = room_id.to_s
           handle_state(room_id, event)
         end
 
-        join[:timeline][:events].each do |event|
+        join.dig(:timeline, :events)&.each do |event|
           event[:room_id] = room_id.to_s
           # Avoid sending two identical state events if it's both in state and timeline
           if event.key?(:state_key)
-            state_event = join.dig(:state, :events).find { |ev| ev[:event_id] == event[:event_id] }
+            state_event = join.dig(:state, :events)&.find { |ev| ev[:event_id] == event[:event_id] }
 
             handle_state(room_id, event) unless event == state_event
           end
@@ -633,7 +642,7 @@ module MatrixSdk
           fire_event(MatrixEvent.new(self, event), event[:type])
         end
 
-        join[:ephemeral][:events].each do |event|
+        join.dig(:ephemeral, :events)&.each do |event|
           event[:room_id] = room_id.to_s
           room.send :put_ephemeral_event, event
 
@@ -641,6 +650,14 @@ module MatrixSdk
         end
       end
 
+      unless cache == :none
+        @rooms.each do |_id, room|
+          # Clean up old cache data after every sync
+          # TODO Run this in a thread?
+          room.tinycache_adapter.cleanup
+        end
+      end
+
       nil
     end
   end

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