matrix_sdk 2.6.0 → 2.7.0

data/lib/matrix_sdk/bot/main.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MatrixSdk::Bot
+  PARAMS_CONFIG = {} # rubocop:disable Style/MutableConstant Intended
+
+  require 'optparse'
+  parser = OptionParser.new do |op|
+    op.on('-s homeserver', 'Specify homeserver') { |val| PARAMS_CONFIG[:homeserver] = val }
+
+    op.on('-T token', 'Token') { |val| PARAMS_CONFIG[:access_token] = val }
+    op.on('-U username', 'Username') { |val| PARAMS_CONFIG[:username] = val }
+    op.on('-P password', 'Password') { |val| PARAMS_CONFIG[:password] = val }
+
+    op.on('-q', 'Disable logging') { PARAMS_CONFIG[:logging] = false }
+    op.on('-v', 'Enable verbose output') { PARAMS_CONFIG[:logging] = !(PARAMS_CONFIG[:log_level] = :debug).nil? }
+  end
+
+  begin
+    parser.parse!(ARGV.dup)
+  rescue StandardError => e
+    PARAMS_CONFIG[:optparse_error] = e
+  end
+
+  MatrixSdk.logger.appenders.each do |log|
+    log.layout = Logging::Layouts.pattern(
+      pattern: "%d|%.1l %c : %m\n"
+    )
+  end
+  MatrixSdk.debug! if ENV['MATRIX_DEBUG'] == '1'
+
+  require 'matrix_sdk/bot/base'
+  class Instance < Base
+    set :logging, true
+    set :log_level, :info
+
+    set :app_file, caller_files.first || $PROGRAM_NAME
+    set(:run) { File.expand_path($PROGRAM_NAME) == File.expand_path(app_file) }
+
+    if run? && ARGV.any?
+      error = PARAMS_CONFIG.delete(:optparse_error)
+      raise error if error
+
+      PARAMS_CONFIG.each { |k, v| set k, v }
+    end
+  end
+
+  module Delegator
+    def self.delegate(*methods)
+      methods.each do |method_name|
+        define_method(method_name) do |*args, &block|
+          return super(*args, &block) if respond_to? method_name
+
+          Delegator.target.send(method_name, *args, &block)
+        end
+        # ensure keyword argument passing is compatible with ruby >= 2.7
+        ruby2_keywords(method_name) if respond_to?(:ruby2_keywords, true)
+        private method_name
+      end
+    end
+
+    delegate :command, :client, :event,
+             :settings,
+             :set, :enable, :disable
+
+    class << self
+      attr_accessor :target
+    end
+
+    self.target = Instance
+  end
+
+  # Trigger the global instance to run once the main class finishes
+  at_exit do
+    remove_const(:PARAMS_CONFIG)
+    Instance.run! if $!.nil? && Instance.run? # rubocop:disable Style/SpecialGlobalVars Don't want to require into global scope
+  end
+end
+
+extend MatrixSdk::Bot::Delegator # rubocop:disable Style/MixinUsage Intended

data/lib/matrix_sdk/bot.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'matrix_sdk'
+require 'matrix_sdk/bot/main'

data/lib/matrix_sdk/client.rb

@@ -22,11 +22,11 @@ module MatrixSdk
     #   @return [Hash,String] A filter definition, either as defined by the
     #           Matrix spec, or as an identifier returned by a filter creation request
     attr_reader :api, :next_batch
-    attr_accessor :cache, :sync_filter
+    attr_accessor :cache, :sync_filter, :sync_token
 
-    events :error, :event, :presence_event, :invite_event, :leave_event, :ephemeral_event, :state_event
+    events :error, :event, :account_data, :presence_event, :invite_event, :leave_event, :ephemeral_event, :state_event
     ignore_inspect :api,
-                   :on_event, :on_presence_event, :on_invite_event, :on_leave_event, :on_ephemeral_event
+                   :on_event, :on_account_data, :on_presence_event, :on_invite_event, :on_leave_event, :on_ephemeral_event
 
     def_delegators :@api,
                    :access_token, :access_token=, :device_id, :device_id=, :homeserver, :homeserver=,
@@ -45,10 +45,10 @@ module MatrixSdk
     # @see #initialize
     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')
+      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))
+      new(api, **params.merge(identity_server: identity_server))
     end
 
     # @param hs_url [String,URI,Api] The URL to the Matrix homeserver, without the /_matrix/ part, or an existing Api instance
@@ -161,7 +161,14 @@ module MatrixSdk
     #
     # @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)
+      account_data['m.direct'].transform_keys(&:to_s)
+    end
+
+    # Retrieve an account data helper
+    def account_data
+      return MatrixSdk::Util::AccountDataCache.new self if cache == :none
+
+      @account_data ||= MatrixSdk::Util::AccountDataCache.new self
     end
 
     # Gets a direct message room for the given user if one exists
@@ -498,8 +505,9 @@ module MatrixSdk
       else
         @should_listen = false
       end
+
       if @sync_thread.alive?
-        ret = @sync_thread.join(2)
+        ret = @sync_thread.join(0.1)
         @sync_thread.kill unless ret
       end
       @sync_thread = nil
@@ -568,10 +576,13 @@ module MatrixSdk
       while @should_listen
         begin
           sync(**params.merge(timeout: timeout))
+          return unless @should_listen
 
           bad_sync_timeout = orig_bad_sync_timeout
           sleep(sync_interval) if sync_interval.positive?
         rescue MatrixRequestError => e
+          return unless @should_listen
+
           logger.warn("A #{e.class} occurred during sync")
           if e.httpstatus >= 500
             logger.warn("Serverside error, retrying in #{bad_sync_timeout} seconds...")
@@ -606,6 +617,14 @@ module MatrixSdk
     end
 
     def handle_sync_response(data)
+      data.dig(:account_data, :events)&.each do |account_data|
+        if cache != :none
+          adapter = self.account_data.tinycache_adapter
+          adapter.write(account_data[:type], account_data[:content], expires_in: self.account_data.cache_time)
+        end
+        fire_account_data(MatrixEvent.new(self, account_data))
+      end
+
       data.dig(:presence, :events)&.each do |presence_update|
         fire_presence_event(MatrixEvent.new(self, presence_update))
       end
@@ -625,6 +644,13 @@ module MatrixSdk
         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.dig(:account_data, :events)&.each do |account_data|
+          account_data[:room_id] = room_id.to_s
+          room.send :put_account_data, account_data
+
+          fire_account_data(MatrixEvent.new(self, account_data))
+        end
+
         join.dig(:state, :events)&.each do |event|
           event[:room_id] = room_id.to_s
           handle_state(room_id, event)
@@ -652,10 +678,12 @@ module MatrixSdk
       end
 
       unless cache == :none
+        account_data.tinycache_adapter.cleanup if instance_variable_defined?(:@account_data) && @account_data
         @rooms.each do |_id, room|
           # Clean up old cache data after every sync
           # TODO Run this in a thread?
           room.tinycache_adapter.cleanup
+          room.account_data.tinycache_adapter.cleanup
         end
       end
 

data/lib/matrix_sdk/mxid.rb

@@ -45,6 +45,8 @@ module MatrixSdk
       "#{sigil}#{localpart}#{homeserver_suffix}"
     end
 
+    alias to_str to_s
+
     # Returns the type of the ID
     #
     # @return [Symbol] The MXID type, one of (:user_id, :room_id, :event_id, :group_id, or :room_alias)

data/lib/matrix_sdk/response.rb

@@ -31,6 +31,8 @@ module MatrixSdk
         return data
       end
 
+      return data if data.instance_variables.include? :@api
+
       raise ArgumentError, 'Input data was not a hash' unless data.is_a? Hash
 
       data.extend(Extensions)

data/lib/matrix_sdk/room.rb

@@ -127,6 +127,12 @@ module MatrixSdk
       ensure_room_handlers[:event]
     end
 
+    # @!attribute [r] on_account_data
+    #   @return [EventHandlerArray] The list of event handlers for account data changes
+    def on_account_data
+      ensure_room_handlers[:account_data]
+    end
+
     # @!attribute [r] on_state_event
     #   @return [EventHandlerArray] The list of event handlers for only state events
     def on_state_event
@@ -208,6 +214,32 @@ module MatrixSdk
       nil
     end
 
+    # Checks if the room is a direct message / 1:1 room
+    #
+    # @param members_only [Boolean] Should directness only care about member count?
+    # @return [Boolean]
+    def dm?(members_only: false)
+      return true if !members_only && client.direct_rooms.any? { |_uid, rooms| rooms.include? id.to_s }
+
+      joined_members.count <= 2
+    end
+
+    # Mark a room as a direct (1:1) message Room
+    def dm=(direct)
+      rooms = client.direct_rooms
+      dirty = false
+      list_for_room = (rooms[id.to_s] ||= [])
+      if direct && !list_for_room.include?(id.to_s)
+        list_for_room << id.to_s
+        dirty = true
+      elsif !direct && list_for_room.include?(id.to_s)
+        list_for_room.delete id.to_s
+        rooms.delete id.to_s if list_for_room.empty?
+        dirty = true
+      end
+      client.account_data['m.direct'] = rooms if dirty
+    end
+
     # Gets the avatar url of the room - if any
     #
     # @return [String,nil] The avatar URL - if any
@@ -400,6 +432,31 @@ module MatrixSdk
       client.api.send_content(id, url, name, 'm.audio', extra_information: audio_info)
     end
 
+    # Sends a customized message to the Room
+    #
+    # @param body [String] The clear-text body of the message
+    # @param content [Hash] The custom content of the message
+    # @param msgtype [String] The type of the message, should be one of the known types (m.text, m.notice, m.emote, etc)
+    def send_custom_message(body, content = {}, msgtype: nil)
+      content.merge!(
+        body: body,
+        msgtype: msgtype || 'm.text'
+      )
+
+      client.api.send_message_event(id, 'm.room.message', content)
+    end
+
+    # Sends a custom timeline event to the Room
+    #
+    # @param type [String,Symbol] The type of the Event.
+    #   For custom events, this should be written in reverse DNS format (e.g. com.example.event)
+    # @param content [Hash] The contents of the message, this will be the
+    #   :content key of the resulting event object
+    # @see Protocols::CS#send_message_event
+    def send_event(type, content = {})
+      client.api.send_message_event(id, type, content)
+    end
+
     # Redacts a message from the room
     #
     # @param event_id [String] the ID of the event to redact
@@ -496,12 +553,18 @@ module MatrixSdk
       true
     end
 
+    def account_data
+      return MatrixSdk::Util::AccountDataCache.new client, room: self if client.cache == :none
+
+      @account_data ||= MatrixSdk::Util::AccountDataCache.new client, room: self
+    end
+
     # Retrieves a custom entry from the room-specific account data
     #
     # @param type [String] the data type to retrieve
     # @return [Hash] the data that was stored under the given type
     def get_account_data(type)
-      client.api.get_room_account_data(client.mxid, id, type)
+      account_data[type]
     end
 
     # Stores a custom entry into the room-specific account data
@@ -509,7 +572,7 @@ module MatrixSdk
     # @param type [String] the data type to store
     # @param account_data [Hash] the data to store
     def set_account_data(type, account_data)
-      client.api.set_room_account_data(client.mxid, id, type, account_data)
+      self.account_data[type] = account_data
       true
     end
 
@@ -741,13 +804,27 @@ module MatrixSdk
     def user_powerlevel(user, use_default: true)
       user = user.id if user.is_a? User
       user = MXID.new(user.to_s) unless user.is_a? MXID
-      raise ArgumentError, 'Must provide a valid user or MXID' unless user.user?
+      raise ArgumentError, 'Must provide a valid User or MXID' unless user.user?
 
       level = power_levels.dig(:users, user.to_s.to_sym)
-      level = power_levels[:users_default] || 0 if level.nil? && use_default
+      level ||= power_levels[:users_default] || 0 if use_default
       level
     end
 
+    # Checks if a user can send a given event type in the room
+    #
+    # @param user [User,MXID,String] The user to check
+    # @param event [String,Symbol] The event type to check
+    # @param state [Boolean] If the given event is a state event or a message event
+    # @return [Boolean] If the given user is allowed to send an event of the given type
+    def user_can_send?(user, event, state: false)
+      user_pl = user_powerlevel(user)
+      event_pl = power_levels.dig(:events, event.to_s.to_sym)
+      event_pl ||= state ? (power_levels[:state_default] || 50) : (power_levels[:events_default] || 0)
+
+      user_pl >= event_pl
+    end
+
     # Check if a user is an admin in the room
     #
     # @param user [User,MXID,String] The user to check for admin privileges
@@ -861,10 +938,14 @@ module MatrixSdk
     private
 
     def ensure_member(member)
+      return unless client.cache == :all
+
       tinycache_adapter.write(:joined_members, []) unless tinycache_adapter.exist? :joined_members
 
       members = tinycache_adapter.read(:joined_members) || []
       members << member unless members.any? { |m| m.id == member.id }
+
+      tinycache_adapter.write(:joined_members, members)
     end
 
     def handle_power_levels(event)
@@ -915,6 +996,7 @@ module MatrixSdk
 
     def ensure_room_handlers
       client.instance_variable_get(:@room_handlers)[id] ||= {
+        account_data: MatrixSdk::EventHandlerArray.new,
         event: MatrixSdk::EventHandlerArray.new,
         state_event: MatrixSdk::EventHandlerArray.new,
         ephemeral_event: MatrixSdk::EventHandlerArray.new
@@ -930,6 +1012,7 @@ module MatrixSdk
       'm.room.power_levels' => :handle_power_levels,
       'm.room.topic' => :handle_room_topic
     }.freeze
+
     def put_event(event)
       ensure_room_handlers[:event].fire(MatrixEvent.new(self, event), event[:type]) if room_handlers?
 
@@ -937,6 +1020,17 @@ module MatrixSdk
       @events.shift if @events.length > @event_history_limit
     end
 
+    def put_account_data(event)
+      if client.cache != :none
+        adapter = account_data.tinycache_adapter
+        adapter.write(event[:type], event[:content], expires_in: account_data.cache_time)
+      end
+
+      return unless room_handlers?
+
+      ensure_room_handlers[:account_data].fire(MatrixEvent.new(self, event))
+    end
+
     def put_ephemeral_event(event)
       return unless room_handlers?
 

data/lib/matrix_sdk/user.rb

@@ -28,6 +28,12 @@ module MatrixSdk
       end
     end
 
+    def to_s
+      "#{display_name} (#{id})" if @display_name
+
+      @id.to_s
+    end
+
     # @return [String] the display name
     # @see MatrixSdk::Protocols::CS#get_display_name
     def display_name
@@ -68,6 +74,22 @@ module MatrixSdk
       @avatar_url = url
     end
 
+    # Check if the user is an admin in a given room
+    #
+    # @param room [String,MXID] the room to check
+    # @return [Boolean] If the user is an admin (PL >= 100)
+    def admin?(room)
+      client.ensure_room(room).user_powerlevel(self) >= 100
+    end
+
+    # Check if the user is a moderator in a given room
+    #
+    # @param room [String,MXID] the room to check
+    # @return [Boolean] If the user is an admin (PL >= 50)
+    def moderator?(room)
+      client.ensure_room(room).user_powerlevel(self) >= 50
+    end
+
     # Get the user's current presence status
     #
     # @return [Symbol] One of :online, :offline, :unavailable

data/lib/matrix_sdk/util/account_data_cache.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module MatrixSdk::Util
+  class AccountDataCache
+    extend MatrixSdk::Extensions
+    extend MatrixSdk::Util::Tinycache
+    include Enumerable
+
+    attr_reader :client, :room
+
+    attr_accessor :cache_time
+
+    ignore_inspect :client, :room, :tinycache_adapter
+
+    def initialize(client, room: nil, cache_time: 1 * 60 * 60, **_params)
+      raise ArgumentError, 'Must be given a Client instance' unless client.is_a? MatrixSdk::Client
+
+      @client = client
+      @cache_time = cache_time
+
+      return unless room
+
+      @room = room
+      @room = client.ensure_room room unless @room.is_a? MatrixSdk::Room
+    end
+
+    def reload!
+      tinycache_adapter.clear
+    end
+
+    def keys
+      tinycache_adapter.send(:cache).keys
+    end
+
+    def values
+      keys.map { |key| tinycache_adapter.read(key) }
+    end
+
+    def size
+      keys.count
+    end
+
+    def key?(key)
+      keys.key?(key.to_s)
+    end
+
+    def each(live: false)
+      return to_enum(__method__, live: live) { keys.count } unless block_given?
+
+      keys.each do |key|
+        v = live ? self[key] : tinycache_adapter.read(key)
+        # hash = v.hash
+        yield key, v
+        # self[key] = v if hash != v.hash
+      end
+    end
+
+    def delete(key)
+      key = key.to_s unless key.is_a? String
+      if room
+        client.api.set_room_account_data(client.mxid, room.id, key, {})
+      else
+        client.api.set_account_data(client.mxid, key, {})
+      end
+      tinycache_adapter.delete(key)
+    end
+
+    def [](key)
+      key = key.to_s unless key.is_a? String
+      tinycache_adapter.fetch(key, expires_in: @cache_time) do
+        if room
+          client.api.get_room_account_data(client.mxid, room.id, key)
+        else
+          client.api.get_account_data(client.mxid, key)
+        end
+      rescue MatrixSdk::MatrixNotFoundError
+        {}
+      end
+    end
+
+    def []=(key, value)
+      key = key.to_s unless key.is_a? String
+      if room
+        client.api.set_room_account_data(client.mxid, room.id, key, value)
+      else
+        client.api.set_account_data(client.mxid, key, value)
+      end
+      tinycache_adapter.write(key, value)
+    end
+  end
+end

data/lib/matrix_sdk/util/extensions.rb

@@ -62,7 +62,7 @@ module MatrixSdk
         end
 
         def pretty_print(pp)
-          pp.pp_object(self)
+          pp.pp(self)
         end
 
         alias inspect pretty_print_inspect
@@ -73,8 +73,9 @@ module MatrixSdk
   module Logging
     def logger
       return MatrixSdk.logger if MatrixSdk.global_logger?
+      return @logger if instance_variable_defined?(:@logger) && @logger
 
-      @logger ||= ::Logging.logger[self]
+      ::Logging.logger[self]
     end
 
     def logger=(logger)

data/lib/matrix_sdk/util/tinycache_adapter.rb

@@ -2,8 +2,12 @@
 
 module MatrixSdk::Util
   class TinycacheAdapter
+    extend MatrixSdk::Extensions
+
     attr_accessor :config, :client
 
+    ignore_inspect :client
+
     def initialize
       @config = {}
 
@@ -59,7 +63,7 @@ module MatrixSdk::Util
     end
 
     def cleanup
-      @cache.delete_if { |_, v| v.expired? }
+      @cache.select { |_, v| v.expired? }.each { |_, v| v.value = nil }
     end
 
     private

data/lib/matrix_sdk/version.rb

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

data/lib/matrix_sdk.rb

@@ -10,7 +10,7 @@ autoload :Logging, 'logging'
 
 module MatrixSdk
   autoload :Api, 'matrix_sdk/api'
-  autoload :ApplicationService, 'matrix_sdk/application_service'
+  # autoload :ApplicationService, 'matrix_sdk/application_service'
   autoload :Client, 'matrix_sdk/client'
   autoload :MXID, 'matrix_sdk/mxid'
   autoload :Response, 'matrix_sdk/response'
@@ -28,11 +28,16 @@ module MatrixSdk
   autoload :MatrixTimeoutError, 'matrix_sdk/errors'
   autoload :MatrixUnexpectedResponseError, 'matrix_sdk/errors'
 
+  module Bot
+    autoload :Base, 'matrix_sdk/bot/base'
+  end
+
   module Rooms
     autoload :Space, 'matrix_sdk/rooms/space'
   end
 
   module Util
+    autoload :AccountDataCache, 'matrix_sdk/util/account_data_cache'
     autoload :Tinycache, 'matrix_sdk/util/tinycache'
     autoload :TinycacheAdapter, 'matrix_sdk/util/tinycache_adapter'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -95,6 +95,9 @@ files:
 - README.md
 - lib/matrix_sdk.rb
 - lib/matrix_sdk/api.rb
+- lib/matrix_sdk/bot.rb
+- lib/matrix_sdk/bot/base.rb
+- lib/matrix_sdk/bot/main.rb
 - lib/matrix_sdk/client.rb
 - lib/matrix_sdk/errors.rb
 - lib/matrix_sdk/mxid.rb
@@ -107,6 +110,7 @@ files:
 - lib/matrix_sdk/room.rb
 - lib/matrix_sdk/rooms/space.rb
 - lib/matrix_sdk/user.rb
+- lib/matrix_sdk/util/account_data_cache.rb
 - lib/matrix_sdk/util/events.rb
 - lib/matrix_sdk/util/extensions.rb
 - lib/matrix_sdk/util/tinycache.rb