matrix_sdk 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f16ccd1ed10b02a963b9dbd736e577375ca41b26fb45743bc0344f219b1d70f
-  data.tar.gz: 3d8eef54f71ccf9e04c0da896e6189fd8d4c2c34c269e2890de37dd4cec023a6
+  metadata.gz: fb2cd8492e977a8c63d80d3a250841111f872b45ef48a06ac610dd6c871c5704
+  data.tar.gz: b5932dc63938f86a4bec522f2d5736871f3a5461ad5d25581c2ba1cd79b20ab2
 SHA512:
-  metadata.gz: 01de0cccbcf0724a101526190ea4e164ec1235daaa0e0c3d42ed445e760246b2b81a054ba4bd7e88229fdb0833e4fe3a8624a4de3dfd032bfa50b4f23946caf1
-  data.tar.gz: 1b177862e3b01aef4c10de6a4318b8348a5c6e00885f0b137ce13a269bf0d5579e6a72b93a87a9366b8d75ec2549518a7d21f2da5db4d7f1d60fa464ff11d83b
+  metadata.gz: 0ed57a7d4b3296a15c244c88ca88777d6ed3f9b67a6c4cdaae017f56c6e15cf94ba0781c6831a70f7adf9c55605073c84c451b0c1b0b8bffe323015330294f19
+  data.tar.gz: f77aaa05a45917b80aa296b7ff73f37d60ba5fb36f29a3e753cec1a730681a428c33ccdae9f4c26648952d6a7b05f9636e7d7ffbbe8757d23d2c435378d3466b

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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

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.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'matrix_sdk/extensions'
+require 'matrix_sdk/util/extensions'
 require 'matrix_sdk/version'
 
 require 'json'
@@ -22,6 +22,11 @@ module MatrixSdk
   autoload :MatrixTimeoutError, 'matrix_sdk/errors'
   autoload :MatrixUnexpectedResponseError, 'matrix_sdk/errors'
 
+  module Util
+    autoload :Tinycache, 'matrix_sdk/util/tinycache'
+    autoload :TinycacheAdapter, 'matrix_sdk/util/tinycache_adapter'
+  end
+
   module Protocols
     autoload :AS, 'matrix_sdk/protocols/as'
     autoload :CS, 'matrix_sdk/protocols/cs'

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
@@ -61,6 +62,7 @@ module MatrixSdk
       @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
 
       ([params.fetch(:protocols, [:CS])].flatten - protocols).each do |proto|
@@ -161,11 +163,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
@@ -377,6 +381,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

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,7 +68,7 @@ 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
@@ -360,7 +361,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
 
@@ -469,7 +470,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
@@ -518,7 +519,7 @@ module MatrixSdk
       attempts = 0
       data = loop do
         begin
-          break api.sync extra_params
+          break api.sync **extra_params
         rescue MatrixSdk::MatrixTimeoutError => e
           raise e if (attempts += 1) >= params.fetch(:allow_sync_retry, 0)
         end
@@ -552,7 +553,7 @@ module MatrixSdk
       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?
@@ -588,33 +589,6 @@ 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)
@@ -663,6 +637,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/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,
@@ -804,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
@@ -819,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
@@ -832,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
@@ -847,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
@@ -860,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
@@ -875,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
@@ -902,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
@@ -915,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
@@ -930,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
@@ -942,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
 
@@ -956,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
 
@@ -969,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
@@ -985,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
@@ -997,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
@@ -1013,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
@@ -1025,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
@@ -1037,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
@@ -1056,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
@@ -1068,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
@@ -1084,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
@@ -1096,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
@@ -1116,7 +1116,7 @@ module MatrixSdk::Protocols::CS
       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)