matrix_sdk 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e0e5819346e56fd4eac1564434e88399500adefe0def16bc706a25ec7a254b2
-  data.tar.gz: 2d74cd2d5203f5431396b03717c4302f9a0c7816c47eaa969e2395ab2eb46586
+  metadata.gz: e1de46ea35a8763e17d834c9395dc95a12c3084557085a0eb6b8e5f1fa25979a
+  data.tar.gz: 13a55698bf72695e8e690d4d5f6618d7efe595f06c32c65580b10e9bf550724e
 SHA512:
-  metadata.gz: 7eb8ef8277b0bda1191915e5be4dcf93856cd876f611b77974b8dc88e5e230ba5c3300995157f9717a4b00d1a7cba7f7a618844cc436ad0b6a3ea5865367049d
-  data.tar.gz: bd888c36cf3a082360dbecc408c0a67e16ddb337a721105be7abf3a9662d81bfa564a1093a64d1f934d484af6a22a36e5b91bafde70f02a882e6d092e81d5459
+  metadata.gz: 919a27ee7fd758c382eafe3f8aad89c13da2a6cc6542ccd8bfe52d09186d93453b12406dfe6b03b6aa63d1898dbacfb6dbced4f4e9606722ad04df4f237cf600
+  data.tar.gz: a8f5c0bc4fb07a089e0d1daebeb8996c6d36157550e73e3869a8bb55f25cc2c405a064654fc49c8bdb323f9d8c168b3c785e52b9f88fbc168ee29c152f7472a5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.1 - 2020-03-13
+
+- Add code for handling non-final MSC's in protocols
+  - Currently implementing clients parts of MSC2018 for Sync over Server Sent Events
+
 ## 2.0.0 - 2020-02-14
 
 **NB**, this release includes backwards-incompatible changes;  

data/lib/matrix_sdk.rb

@@ -27,6 +27,9 @@ module MatrixSdk
     autoload :CS, 'matrix_sdk/protocols/cs'
     autoload :IS, 'matrix_sdk/protocols/is'
     autoload :SS, 'matrix_sdk/protocols/ss'
+
+    # Non-final protocol extensions
+    autoload :MSC, 'matrix_sdk/protocols/msc'
   end
 
   def self.debug!

data/lib/matrix_sdk/api.rb

@@ -11,10 +11,6 @@ module MatrixSdk
   class Api
     extend MatrixSdk::Extensions
     include MatrixSdk::Logging
-    include MatrixSdk::Protocols::AS
-    include MatrixSdk::Protocols::CS
-    include MatrixSdk::Protocols::IS
-    include MatrixSdk::Protocols::SS
 
     USER_AGENT = "Ruby Matrix SDK v#{MatrixSdk::VERSION}"
     DEFAULT_HEADERS = {
@@ -23,7 +19,7 @@ module MatrixSdk
     }.freeze
 
     attr_accessor :access_token, :connection_address, :connection_port, :device_id, :autoretry, :global_headers
-    attr_reader :homeserver, :validate_certificate, :open_timeout, :read_timeout, :protocols, :well_known, :proxy_uri
+    attr_reader :homeserver, :validate_certificate, :open_timeout, :read_timeout, :well_known, :proxy_uri
 
     ignore_inspect :access_token, :logger
 
@@ -51,10 +47,6 @@ module MatrixSdk
       @homeserver.path.gsub!(/\/?_matrix\/?/, '') if @homeserver.path =~ /_matrix\/?$/
       raise ArgumentError, 'Please use the base URL for your HS (without /_matrix/)' if @homeserver.path.include? '/_matrix/'
 
-      @protocols = params.fetch(:protocols, %i[CS])
-      @protocols = [@protocols] unless @protocols.is_a? Array
-      @protocols << :CS if @protocols.include?(:AS) && !@protocols.include?(:CS)
-
       @proxy_uri = params.fetch(:proxy_uri, nil)
       @connection_address = params.fetch(:address, nil)
       @connection_port = params.fetch(:port, nil)
@@ -71,6 +63,10 @@ module MatrixSdk
       @global_headers.merge!(params.fetch(:global_headers)) if params.key? :global_headers
       @http = nil
 
+      ([params.fetch(:protocols, [:CS])].flatten - protocols).each do |proto|
+        self.class.include MatrixSdk::Protocols.const_get(proto)
+      end
+
       login(user: @homeserver.user, password: @homeserver.password) if @homeserver.user && @homeserver.password && !@access_token && !params[:skip_login] && protocol?(:CS)
       @homeserver.userinfo = '' unless params[:skip_login]
     end
@@ -155,6 +151,20 @@ module MatrixSdk
           ))
     end
 
+    # Get a list of enabled protocols on the API client
+    #
+    # @example
+    #   MatrixSdk::Api.new_for_domain('matrix.org').protocols
+    #   # => [:IS, :CS]
+    #
+    # @return [Symbol[]] An array of enabled APIs
+    def protocols
+      self
+        .class.included_modules
+        .select { |m| m.name.start_with? 'MatrixSdk::Protocols::' }
+        .map { |m| m.name.split('::').last.to_sym }
+    end
+
     # Check if a protocol is enabled on the API connection
     #
     # @example Checking for identity server API support
@@ -233,6 +243,7 @@ module MatrixSdk
     # @option options [Hash,String] :body The body to attach to the request, will be JSON-encoded if sent as a hash
     # @option options [IO] :body_stream A body stream to attach to the request
     # @option options [Hash] :headers Additional headers to set on the request
+    # @option options [Boolean] :skip_auth (false) Skip authentication
     def request(method, api, path, **options)
       url = homeserver.dup.tap do |u|
         u.path = api_to_path(api) + path
@@ -250,7 +261,7 @@ module MatrixSdk
         request.content_length = (request.body || request.body_stream).size
       end
 
-      request['authorization'] = "Bearer #{access_token}" if access_token
+      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
@@ -289,7 +300,7 @@ module MatrixSdk
 
     private
 
-    def print_http(http)
+    def print_http(http, body: true)
       return unless logger.debug?
 
       if http.is_a? Net::HTTPRequest
@@ -303,10 +314,12 @@ module MatrixSdk
         logger.debug "#{dir} #{h}"
       end
       logger.debug dir
-      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 = 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
+      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 = 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
     rescue StandardError => e
       logger.warn "#{e.class} occured while printing request debug; #{e.message}\n#{e.backtrace.join "\n"}"
     end

data/lib/matrix_sdk/client.rb

@@ -423,7 +423,16 @@ module MatrixSdk
       return if listening?
 
       @should_listen = true
-      thread = Thread.new { listen_forever(params) }
+      if api.protocol?(:MSC) && api.msc2108?
+        params[:since] = @next_batch if @next_batch
+        thread = api.msc2108_sync_sse(params) do |data, event:, id:|
+          logger.debug "Handling SSE event '#{event}' from '#{id}'"
+          @next_batch = id if id
+          handle_sync_response(data) if event.to_sym == :sync
+        end
+      else
+        thread = Thread.new { listen_forever(params) }
+      end
       @sync_thread = thread
       thread.run
     end

data/lib/matrix_sdk/mxid.rb

@@ -10,6 +10,7 @@ module MatrixSdk
       raise ArgumentError, 'Identifier is too long' if identifier.size > 255
       raise ArgumentError, 'Identifier lacks required data' unless identifier =~ %r{^([@!$+#][^:]+:[^:]+(?::\d+)?)|(\$[A-Za-z0-9+/]+)$}
 
+      # 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(':')
       @port = @port.to_i if @port

data/lib/matrix_sdk/protocols/msc.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# Preliminary support for unmerged MSCs (Matrix Spec Changes)
+module MatrixSdk::Protocols::MSC
+  def self.included(_)
+    @msc = {}
+  end
+
+  def refresh_mscs
+    @msc = {}
+  end
+
+  # Check if there's support for MSC2108 - Sync over Server Sent Events
+  def msc2108?
+    @msc[2108] ||= \
+      begin
+        request(:get, :client_r0, '/sync/sse', skip_auth: true, headers: { accept: 'text/event-stream' })
+      rescue MatrixSdk::MatrixNotAuthorizedError # Returns 401 if implemented
+        true
+      rescue MatrixSdk::MatrixRequestError
+        false
+      end
+  end
+
+  # Sync over Server Sent Events - MSC2108
+  #
+  # @note With the default Ruby Net::HTTP server, body fragments are cached up to 16kB,
+  #       which will result in large batches and delays if your filters trim a lot of data.
+  #
+  # @example Syncing over SSE
+  #   @since = 'some token'
+  #   api.msc2108_sync_sse(since: @since) do |data, event:, id:|
+  #     if event == 'sync'
+  #       handle(data) # data is the same as a normal sync response
+  #       @since = id
+  #     end
+  #   end
+  #
+  # @see Protocols::CS#sync
+  # @see https://github.com/matrix-org/matrix-doc/pull/2108/
+  def msc2108_sync_sse(since: nil, **params, &on_data)
+    raise ArgumentError, 'Must be given a block accepting two args - data and { event:, id: }' \
+      unless on_data.is_a?(Proc) && on_data.arity == 2
+    raise MatrixNotAuthorizedError unless access_token
+
+    query = params.select do |k, _v|
+      %i[filter full_state set_presence].include? k
+    end
+    query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
+
+    req = Net::HTTP::Get.new(homeserver.dup.tap do |u|
+      u.path = api_to_path(:client_r0) + '/sync/sse'
+      u.query = URI.encode_www_form(query)
+    end)
+    req['accept'] = 'text/event-stream'
+    req['authorization'] = "Bearer #{access_token}"
+    req['last-event-id'] = since if since
+
+    # rubocop:disable Metrics/BlockLength
+    thread = Thread.new do
+      print_http(req)
+      http.request req do |response|
+        print_http(response, body: false)
+        raise MatrixRequestError.new_by_code(JSON.parse(response.body, symbolize_names: true), response.code) unless response.is_a? Net::HTTPSuccess
+
+        buffer = ''
+        response.read_body do |chunk|
+          buffer += chunk
+          logger.debug "< MSC2108: Received #{chunk.length}B of data."
+
+          while (index = buffer.index(/\r\n\r\n|\n\n/))
+            stream = buffer.slice!(0..index)
+
+            data = ''
+            event = nil
+            id = nil
+
+            stream.split(/\r?\n/).each do |part|
+              /^data:(.+)$/.match(part) do |m_data|
+                data += "\n" unless data.empty?
+                data += m_data[1].strip
+              end
+              /^event:(.+)$/.match(part) do |m_event|
+                event = m_event[1].strip
+              end
+              /^id:(.+)$/.match(part) do |m_id|
+                id = m_id[1].strip
+              end
+            end
+
+            data = JSON.parse(data, symbolize_names: true)
+
+            yield((MatrixSdk::Response.new self, data), event: event, id: id)
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/BlockLength
+
+    thread.abort_on_exception = true
+    thread.run
+
+    thread
+  end
+end

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -103,6 +103,7 @@ files:
 - lib/matrix_sdk/protocols/as.rb
 - lib/matrix_sdk/protocols/cs.rb
 - lib/matrix_sdk/protocols/is.rb
+- lib/matrix_sdk/protocols/msc.rb
 - lib/matrix_sdk/protocols/ss.rb
 - lib/matrix_sdk/response.rb
 - lib/matrix_sdk/room.rb