matrix_sdk 2.1.0 → 2.3.0

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/{extensions.rb → util/events.rb}

@@ -1,91 +1,6 @@
 # frozen_string_literal: true
 
-module URI
-  # A mxc:// Matrix content URL
-  class MATRIX < Generic
-    def full_path
-      select(:host, :port, :path, :query, :fragment)
-        .reject(&:nil?)
-        .join
-    end
-  end
-
-  @@schemes['MXC'] = MATRIX
-end
-
-unless Object.respond_to? :yield_self
-  class Object
-    def yield_self
-      yield(self)
-    end
-  end
-end
-
 module MatrixSdk
-  module Extensions
-    def events(*symbols)
-      module_name = "#{name}Events"
-
-      initializers = []
-      readers = []
-      methods = []
-
-      symbols.each do |sym|
-        name = sym.to_s
-
-        initializers << "
-          @on_#{name} = MatrixSdk::EventHandlerArray.new
-        "
-        readers << ":on_#{name}"
-        methods << "
-          def fire_#{name}(ev, filter = nil)
-            @on_#{name}.fire(ev, filter)
-            when_#{name}(ev) if !ev.handled?
-          end
-
-          def when_#{name}(ev); end
-        "
-      end
-
-      class_eval "
-        module #{module_name}
-          attr_reader #{readers.join ', '}
-
-          def event_initialize
-            #{initializers.join}
-          end
-
-          #{methods.join}
-        end
-
-        include #{module_name}
-      ", __FILE__, __LINE__ - 12
-    end
-
-    def ignore_inspect(*symbols)
-      class_eval %*
-        def inspect
-          reentrant = caller_locations.any? { |l| l.absolute_path == __FILE__ && l.label == 'inspect' }
-          "\#{to_s[0..-2]} \#{instance_variables
-            .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
-            .map { |f| "\#{f}=\#{reentrant ? instance_variable_get(f) : instance_variable_get(f).inspect}" }.join " " }}>"
-        end
-      *, __FILE__, __LINE__ - 7
-    end
-  end
-
-  module Logging
-    def logger
-      return MatrixSdk.logger if MatrixSdk.global_logger?
-
-      @logger ||= ::Logging.logger[self]
-    end
-
-    def logger=(logger)
-      @logger = logger
-    end
-  end
-
   class EventHandlerArray < Hash
     include MatrixSdk::Logging
     attr_accessor :reraise_exceptions
@@ -154,6 +69,7 @@ module MatrixSdk
 
   class MatrixEvent < Event
     attr_accessor :event, :filter
+    alias data event
 
     ignore_inspect :sender
 
@@ -189,7 +105,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/util/extensions.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module URI
+  # A mxc:// Matrix content URL
+  class MATRIX < Generic
+    def full_path
+      select(:host, :port, :path, :query, :fragment)
+        .reject(&:nil?)
+        .join
+    end
+  end
+
+  @@schemes['MXC'] = MATRIX
+end
+
+unless Object.respond_to? :yield_self
+  class Object
+    def yield_self
+      yield(self)
+    end
+  end
+end
+
+module MatrixSdk
+  module Extensions
+    def events(*symbols)
+      module_name = "#{name}Events"
+
+      initializers = []
+      readers = []
+      methods = []
+
+      symbols.each do |sym|
+        name = sym.to_s
+
+        initializers << "
+          @on_#{name} = MatrixSdk::EventHandlerArray.new
+        "
+        readers << ":on_#{name}"
+        methods << "
+          def fire_#{name}(ev, filter = nil)
+            @on_#{name}.fire(ev, filter)
+            when_#{name}(ev) if !ev.handled?
+          end
+
+          def when_#{name}(ev); end
+        "
+      end
+
+      class_eval "
+        module #{module_name}
+          attr_reader #{readers.join ', '}
+
+          def event_initialize
+            #{initializers.join}
+          end
+
+          #{methods.join}
+        end
+
+        include #{module_name}
+      ", __FILE__, __LINE__ - 12
+    end
+
+    def ignore_inspect(*symbols)
+      class_eval %*
+        def inspect
+          reentrant = caller_locations.any? { |l| l.absolute_path == __FILE__ && l.label == 'inspect' }
+          "\#{to_s[0..-2]} \#{instance_variables
+            .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
+            .map { |f| "\#{f}=\#{reentrant ? instance_variable_get(f) : instance_variable_get(f).inspect}" }.join " " }}>"
+        end
+      *, __FILE__, __LINE__ - 7
+    end
+  end
+
+  module Logging
+    def logger
+      return MatrixSdk.logger if MatrixSdk.global_logger?
+
+      @logger ||= ::Logging.logger[self]
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+end

data/lib/matrix_sdk/util/tinycache.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'matrix_sdk/util/tinycache_adapter'
+
+module MatrixSdk::Util
+  module Tinycache
+    CACHE_LEVELS = {
+      none: 0,
+      some: 1,
+      all: 2
+    }.freeze
+
+    def self.adapter
+      @adapter ||= TinycacheAdapter
+    end
+
+    def self.adapter=(adapter)
+      @adapter = adapter
+    end
+
+    def self.extended(base)
+      helper_name = base.send(:cache_helper_module_name)
+      base.remove_const(helper_name) if base.const_defined?(helper_name)
+      base.prepend base.const_set(helper_name, Module.new)
+
+      base.include InstanceMethods
+    end
+
+    def cached(*methods, **opts)
+      methods.each { |method| build_cache_methods(method, **opts) }
+    end
+
+    module InstanceMethods
+      def tinycache_adapter
+        @tinycache_adapter ||= Tinycache.adapter.new.tap do |adapter|
+          adapter.config = self.class.tinycache_adapter_config if adapter.respond_to? :config=
+          adapter.client = client if respond_to?(:client) && adapter.respond_to?(:client=)
+        end
+      end
+    end
+
+    def tinycache_adapter_config
+      @tinycache_adapter_config ||= {}
+    end
+
+    private
+
+    def default_cache_key
+      proc do |method_name, _method_args|
+        method_name.to_sym
+      end
+    end
+
+    def cache_helper_module_name
+      class_name = name&.gsub(/:/, '') || to_s.gsub(/[^a-zA-Z_0-9]/, '')
+      "#{class_name}Tinycache"
+    end
+
+    def build_cache_methods(method_name, cache_key: default_cache_key, cache_level: :none, expires_in: nil, **opts)
+      raise ArgumentError, 'Cache key must be a three-arg proc' unless cache_key.is_a? Proc
+
+      method_names = build_method_names(method_name)
+      tinycache_adapter_config[method_name] = {
+        level: cache_level,
+        expires: expires_in || 1 * 365 * 24 * 60 * 60 # 1 year
+      }
+
+      const_get(cache_helper_module_name).class_eval do
+        define_method(method_names[:cache_key]) do |*args|
+          cache_key.call(method_name, args)
+        end
+
+        define_method(method_names[:with_cache]) do |*args|
+          tinycache_adapter.fetch(__send__(method_names[:cache_key], *args), expires_in: expires_in) do
+            __send__(method_names[:without_cache], *args)
+          end
+        end
+
+        define_method(method_names[:without_cache]) do |*args|
+          orig = method(method_name).super_method
+          orig.call(*args)
+        end
+
+        define_method(method_names[:clear_cache]) do |*args|
+          tinycache_adapter.delete(__send__(method_names[:cache_key], *args))
+        end
+
+        define_method(method_names[:cached]) do
+          true
+        end
+
+        define_method(method_name) do |*args|
+          unless_proc = opts[:unless].is_a?(Symbol) ? opts[:unless].to_proc : opts[:unless]
+
+          skip_cache = false
+          skip_cache ||= unless_proc&.call(self, method_name, args)
+          skip_cache ||= CACHE_LEVELS[client&.cache || :all] < CACHE_LEVELS[cache_level]
+
+          if skip_cache
+            __send__(method_names[:without_cache], *args)
+          else
+            __send__(method_names[:with_cache], *args)
+          end
+        end
+      end
+    end
+
+    def build_method_names(method)
+      # Clean up method name (split any suffix)
+      method_name = method.to_s.sub(/([?!=])$/, '')
+      punctuation = Regexp.last_match(-1)
+
+      {
+        cache_key: "#{method_name}_cache_key#{punctuation}",
+        with_cache: "#{method_name}_with_cache#{punctuation}",
+        without_cache: "#{method_name}_without_cache#{punctuation}",
+        clear_cache: "clear_#{method_name}_cache#{punctuation}",
+        cached: "#{method}_cached?"
+      }
+    end
+  end
+end

data/lib/matrix_sdk/util/tinycache_adapter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MatrixSdk::Util
+  class TinycacheAdapter
+    attr_accessor :config, :client
+
+    def initialize
+      @config = {}
+
+      clear
+    end
+
+    def read(key)
+      cache[key]&.value
+    end
+
+    def write(key, value, expires_in: nil, cache_level: nil)
+      expires_in ||= config.dig(key, :expires)
+      cache_level ||= client&.cache
+      cache_level ||= :all
+      cache_level = Tinycache::CACHE_LEVELS[cache_level] unless cache_level.is_a? Integer
+
+      return value if cache_level < Tinycache::CACHE_LEVELS[config.dig(key, :level) || :none]
+
+      cache[key] = Value.new(value, Time.now, Time.now + expires_in)
+      value
+    end
+
+    def exist?(key)
+      cache.key?(key)
+    end
+
+    def fetch(key, expires_in: nil, cache_level: nil, **_opts)
+      expires_in ||= config.dig(key, :expires)
+      cache_level ||= client&.cache
+      cache_level ||= :all
+      cache_level = Tinycache::CACHE_LEVELS[cache_level]
+
+      return read(key) if exist?(key) && !cache[key].expired?
+
+      value = yield
+      write(key, value, expires_in: expires_in, cache_level: cache_level)
+    end
+
+    def delete(key)
+      return false unless exist?(key)
+
+      cache.delete key
+      true
+    end
+
+    def clear
+      @cache = {}
+    end
+
+    def cleanup
+      @cache.delete_if { |_, v| v.expired? }
+    end
+
+    private
+
+    Value = Struct.new(:value, :timestamp, :expires_at) do
+      def expired?
+        return false if expires_at.nil?
+
+        Time.now > expires_at
+      end
+    end
+
+    attr_reader :cache
+  end
+end

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Alexander Olofsson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -95,10 +95,8 @@ files:
 - README.md
 - lib/matrix_sdk.rb
 - lib/matrix_sdk/api.rb
-- lib/matrix_sdk/application_service.rb
 - lib/matrix_sdk/client.rb
 - lib/matrix_sdk/errors.rb
-- lib/matrix_sdk/extensions.rb
 - lib/matrix_sdk/mxid.rb
 - lib/matrix_sdk/protocols/as.rb
 - lib/matrix_sdk/protocols/cs.rb
@@ -108,12 +106,16 @@ files:
 - lib/matrix_sdk/response.rb
 - lib/matrix_sdk/room.rb
 - lib/matrix_sdk/user.rb
+- lib/matrix_sdk/util/events.rb
+- lib/matrix_sdk/util/extensions.rb
+- lib/matrix_sdk/util/tinycache.rb
+- lib/matrix_sdk/util/tinycache_adapter.rb
 - lib/matrix_sdk/version.rb
 homepage: https://github.com/ananace/ruby-matrix-sdk
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: SDK for applications using the Matrix protocol
 test_files: []