matrix_sdk 2.1.2 → 2.4.0

data/lib/matrix_sdk/util/uri.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module URI
+  # A mxc:// Matrix content URL
+  class MXC < Generic
+    def full_path
+      select(:host, :port, :path, :query, :fragment)
+        .reject(&:nil?)
+        .join
+    end
+  end
+
+  @@schemes['MXC'] = MXC
+
+  unless @@schemes.key? 'MATRIX'
+    # A matrix: URI according to MSC2312
+    class MATRIX < Generic
+      attr_reader :authority, :action, :mxid, :mxid2, :via
+
+      def initialize(*args)
+        super(*args)
+
+        @action = nil
+        @authority = nil
+        @mxid = nil
+        @mxid2 = nil
+        @via = nil
+
+        raise InvalidComponentError, 'missing opaque part for matrix URL' if !@opaque && !@path
+
+        if @path
+          @authority = @host
+          @authority += ":#{@port}" if @port
+        else
+          @path, @query = @opaque.split('?')
+          @query, @fragment = @query.split('#') if @query&.include? '#'
+          @path, @fragment = @path.split('#') if @path&.include? '#'
+          @path = "/#{path}"
+          @opaque = nil
+        end
+
+        components = @path.delete_prefix('/').split('/', -1)
+        raise InvalidComponentError, 'component count must be 2 or 4' if components.size != 2 && components.size != 4
+
+        sigil = case components.shift
+                when 'u', 'user'
+                  '@'
+                when 'r', 'room'
+                  '#'
+                when 'roomid'
+                  '!'
+                else
+                  raise InvalidComponentError, 'invalid component in path'
+                end
+
+        component = components.shift
+        raise InvalidComponentError, "component can't be empty" if component.nil? || component.empty?
+
+        @mxid = MatrixSdk::MXID.new("#{sigil}#{component}")
+
+        if components.size == 2
+          sigil2 = case components.shift
+                   when 'e', 'event'
+                     '$'
+                   else
+                     raise InvalidComponentError, 'invalid component in path'
+                   end
+          component = components.shift
+          raise InvalidComponentError, "component can't be empty" if component.nil? || component.empty?
+
+          @mxid2 = MatrixSdk::MXID.new("#{sigil2}#{component}")
+        end
+
+        return unless @query
+
+        @action = @query.match(/action=([^&]+)/)&.captures&.first&.to_sym
+        @via = @query.scan(/via=([^&]+)/)&.flatten&.compact
+      end
+
+      def mxid2?
+        !@mxid2.nil?
+      end
+    end
+
+    @@schemes['MATRIX'] = MATRIX
+  end
+end

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Alexander Olofsson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-07-19 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
@@ -107,13 +105,19 @@ files:
 - lib/matrix_sdk/protocols/ss.rb
 - lib/matrix_sdk/response.rb
 - lib/matrix_sdk/room.rb
+- lib/matrix_sdk/rooms/space.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/util/uri.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 +132,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.14
+signing_key:
 specification_version: 4
 summary: SDK for applications using the Matrix protocol
 test_files: []

data/lib/matrix_sdk/application_service.rb

@@ -1,212 +0,0 @@
-# frozen_string_literal: true
-
-require 'matrix_sdk'
-
-module MatrixSdk
-  class ApplicationService
-    include MatrixSdk::Logging
-    attr_reader :api, :port
-
-    def_delegators :@api,
-                   :access_token, :access_token=, :device_id, :device_id=, :homeserver, :homeserver=,
-                   :validate_certificate, :validate_certificate=
-
-    def initialize(hs_url, as_token:, hs_token:, default_routes: true, **params)
-      logger.warning 'This abstraction is still under HEAVY development, expect errors'
-
-      params = { protocols: %i[AS CS] }.merge(params).merge(access_token: as_token)
-      if hs_url.is_a? Api
-        @api = hs_url
-        params.each do |k, v|
-          api.instance_variable_set("@#{k}", v) if api.instance_variable_defined? "@#{k}"
-        end
-      else
-        @api = Api.new hs_url, params
-      end
-
-      @id = params.fetch(:id, MatrixSdk::Api::USER_AGENT)
-      @port = params.fetch(:port, 8888)
-      @url = params.fetch(:url, URI("http://localhost:#{@port}"))
-      @as_token = as_token
-      @hs_token = hs_token
-
-      @method_map = {}
-
-      if default_routes
-        add_method(:GET, '/_matrix/app/v1/users/', %r{^/_matrix/app/v1/users/(?<user>[^/]+)$}, :do_get_user)
-        add_method(:GET, '/_matrix/app/v1/rooms/', %r{^/_matrix/app/v1/rooms/(?<room>[^/]+)$}, :do_get_room)
-
-        add_method(:GET, '/_matrix/app/v1/thirdparty/protocol/', %r{^/_matrix/app/v1/thirdparty/protocol/(?<protocol>[^/]+)$}, :do_get_3p_protocol_p)
-        add_method(:GET, '/_matrix/app/v1/thirdparty/user/', %r{^/_matrix/app/v1/thirdparty/user/(?<protocol>[^/]+)$}, :do_get_3p_user_p)
-        add_method(:GET, '/_matrix/app/v1/thirdparty/location/', %r{^/_matrix/app/v1/thirdparty/location/(?<protocol>[^/]+)$}, :do_get_3p_location_p)
-        add_method(:GET, '/_matrix/app/v1/thirdparty/user', %r{^/_matrix/app/v1/thirdparty/user$}, :do_get_3p_user)
-        add_method(:GET, '/_matrix/app/v1/thirdparty/location', %r{^/_matrix/app/v1/thirdparty/location$}, :do_get_3p_location)
-
-        add_method(:PUT, '/_matrix/app/v1/transactions/', %r{^/_matrix/app/v1/transactions/(?<txn_id>[^/]+)$}, :do_put_transaction)
-
-        if params.fetch(:legacy_routes, false)
-          add_method(:GET, '/users/', %r{^/users/(?<user>[^/]+)$}, :do_get_user)
-          add_method(:GET, '/rooms/', %r{^/rooms/(?<room>[^/]+)$}, :do_get_room)
-
-          add_method(:GET, '/_matrix/app/unstable/thirdparty/protocol/', %r{^/_matrix/app/unstable/thirdparty/protocol/(?<protocol>[^/]+)$}, :do_get_3p_protocol_p)
-          add_method(:GET, '/_matrix/app/unstable/thirdparty/user/', %r{^/_matrix/app/unstable/thirdparty/user/(?<protocol>[^/]+)$}, :do_get_3p_user_p)
-          add_method(:GET, '/_matrix/app/unstable/thirdparty/location/', %r{^/_matrix/app/unstable/thirdparty/location/(?<protocol>[^/]+)$}, :do_get_3p_location_p)
-          add_method(:GET, '/_matrix/app/unstable/thirdparty/user', %r{^/_matrix/app/unstable/thirdparty/user$}, :do_get_3p_user)
-          add_method(:GET, '/_matrix/app/unstable/thirdparty/location', %r{^/_matrix/app/unstable/thirdparty/location$}, :do_get_3p_location)
-
-          add_method(:PUT, '/transactions/', %r{^/transactions/(?<txn_id>[^/]+)$}, :do_put_transaction)
-        end
-      end
-
-      start_server
-    end
-
-    def registration
-      {
-        id: @id,
-        url: @url,
-        as_token: @as_token,
-        hs_token: @hs_token,
-        sender_localpart: '',
-        namespaces: {
-          users: [],
-          aliases: [],
-          rooms: []
-        },
-        rate_limited: false,
-        protocols: []
-      }
-    end
-
-    def port=(port)
-      raise ArgumentError, 'Port must be a number' unless port.is_a? Numeric
-
-      raise NotImplementedError, "Can't change port of a running server" if server.status != :Stop
-
-      @port = port
-    end
-
-    protected
-
-    def add_method(verb, prefix, regex, proc = nil, &block)
-      proc ||= block
-      raise ArgumentError, 'No method specified' if proc.nil?
-
-      method_entry = (@method_map[verb] ||= {})[regex] = {
-        verb: verb,
-        prefix: prefix,
-        proc: proc
-      }
-      return true unless @server
-
-      server.mount_proc(method.prefix) { |req, res| _handle_proc(verb, method_entry, req, res) }
-    end
-
-    def do_get_user(user:, **params)
-      [user, params]
-      raise NotImplementedError
-    end
-
-    def do_get_room(room:, **params)
-      [room, params]
-      raise NotImplementedError
-    end
-
-    def do_get_3p_protocol_p(protocol:, **params)
-      [protocol, params]
-      raise NotImplementedError
-    end
-
-    def do_get_3p_user_p(protocol:, **params)
-      [protocol, params]
-      raise NotImplementedError
-    end
-
-    def do_get_3p_location_p(protocol:, **params)
-      [protocol, params]
-      raise NotImplementedError
-    end
-
-    def do_get_3p_location(**params)
-      [protocol, params]
-      raise NotImplementedError
-    end
-
-    def do_get_3p_user(**params)
-      [protocol, params]
-      raise NotImplementedError
-    end
-
-    def do_put_transaction(txn_id:, **params)
-      [txn_id, params]
-      raise NotImplementedError
-    end
-
-    def start_server
-      server.start
-
-      @method_map.each do |verb, method_entry|
-        # break if verb != method_entry[:verb]
-
-        method = method_entry[:proc]
-        server.mount_proc(method.prefix) { |req, res| _handle_proc(verb, method_entry, req, res) }
-      end
-
-      logger.info "Application Service is now running on port #{port}"
-    end
-
-    def stop_server
-      @server&.shutdown
-      @server = nil
-    end
-
-    private
-
-    def _handle_proc(verb, method_entry, req, res)
-      logger.debug "Received request for #{verb} #{method_entry}"
-      match = regex.match(req.request_uri.path)
-      match_hash = Hash[match.names.zip(match.captures)].merge(
-        request: req,
-        response: res
-      )
-
-      if method.is_a? Symbol
-        send method, match_hash
-      else
-        method.call match_hash
-      end
-    end
-
-    def server
-      @server ||= WEBrick::HTTPServer.new(Port: port, ServerSoftware: "#{MatrixSdk::Api::USER_AGENT} (Ruby #{RUBY_VERSION})").tap do |server|
-        server.mount_proc '/', &:handle_request
-      end
-    end
-
-    def handle_request(request, response)
-      logger.debug "Received request #{request.inspect}"
-
-      req_method = request.request_method.to_s.to_sym
-      req_uri = request.request_uri
-
-      map = @method_map[req_method]
-      raise WEBrick::HTTPStatus[405], { message: 'Unsupported verb' }.to_json if map.nil?
-
-      discovered = map.find { |k, _v| k =~ req_uri.path }
-      raise WEBrick::HTTPStatus[404], { message: 'Unknown request' }.to_json if discovered.nil?
-
-      method = discovered.last
-      match = Regexp.last_match
-      match_hash = Hash[match.names.zip(match.captures)].merge(
-        request: request,
-        response: response
-      )
-
-      if method.is_a? Symbol
-        send method, match_hash
-      else
-        method.call match_hash
-      end
-    end
-  end
-end

data/lib/matrix_sdk/extensions.rb

@@ -1,197 +0,0 @@
-# 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
-
-  class EventHandlerArray < Hash
-    include MatrixSdk::Logging
-    attr_accessor :reraise_exceptions
-
-    def initialize(*args)
-      @reraise_exceptions = false
-
-      super(*args)
-    end
-
-    def add_handler(filter = nil, id = nil, &block)
-      id ||= block.hash
-      self[id] = { filter: filter, id: id, block: block }
-    end
-
-    def remove_handler(id)
-      delete id
-    end
-
-    def fire(event, filter = nil)
-      reverse_each do |_k, h|
-        begin
-          h[:block].call(event) if !h[:filter] || event.matches?(h[:filter], filter)
-        rescue StandardError => e
-          logger.error "#{e.class.name} occurred when firing event (#{event})\n#{e}"
-
-          raise e if @reraise_exceptions
-        end
-      end
-    end
-  end
-
-  class Event
-    extend MatrixSdk::Extensions
-
-    attr_writer :handled
-
-    ignore_inspect :sender
-
-    def initialize(sender)
-      @sender = sender
-      @handled = false
-    end
-
-    def handled?
-      @handled
-    end
-
-    def matches?(_filter)
-      true
-    end
-  end
-
-  class ErrorEvent < Event
-    attr_accessor :error
-
-    def initialize(error, source)
-      @error = error
-      super source
-    end
-
-    def source
-      @sender
-    end
-  end
-
-  class MatrixEvent < Event
-    attr_accessor :event, :filter
-
-    ignore_inspect :sender
-
-    def initialize(sender, event = nil, filter = nil)
-      @event = event
-      @filter = filter || @event[:type]
-      super sender
-    end
-
-    def matches?(filter, filter_override = nil)
-      return true if filter_override.nil? && (@filter.nil? || filter.nil?)
-
-      to_match = filter_override || @filter
-      if filter.is_a? Regexp
-        filter.match(to_match) { true } || false
-      else
-        to_match == filter
-      end
-    end
-
-    def [](key)
-      event[key]
-    end
-
-    def to_s
-      "#{event[:type]}: #{event.reject { |k, _v| k == :type }.to_json}"
-    end
-
-    def method_missing(method, *args)
-      return event[method] if event.key? method
-
-      super
-    end
-
-    def respond_to_missing?(method, *)
-      event.key? method
-    end
-  end
-end