matrix_sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44e3f36b32757df6369cafc95f4b6d9b42cff5a8b5152373519556a227aa6be4
-  data.tar.gz: dfdb434855b6ceea028a2f374f239aeec92504f36d52e8400d500193d0642d80
+  metadata.gz: c3aa6522f1b8b49ed1ea60dc27c67fefb9479b5aa27d87c4597edf97e76d4eb6
+  data.tar.gz: b2a6d3b5ff58c037092515ccf42e0a2683f1ef024a8b6731c824faade7649a0a
 SHA512:
-  metadata.gz: c5a57bafba59ce9616041f64172c4e5c117f7a46455612c8ae8c74693c691037e25dc5037be90c3d18600a3b30cdc2827761bfdcd9baea7ef5e5f6e7cbccc4cc
-  data.tar.gz: 99792cb46ab43e6e9d0757c5f2c171da05233d5b8d697ef1ad9d60eb2e2bdb707dca57e35b157687b6ea77ecfb955c579f72289d684699077af1f29de4ce0e54
+  metadata.gz: b55690dbf6fe96eeb24a6831d390e122962b1c68d5e0031deb32641eaeb7f38568d47ec728d0adbd4eb9aea5d1f2064ff926667588b9b77893314b999366245b
+  data.tar.gz: 73eb136cd9285ffc1415b79c25ac05807eb0b17f52865df329ebff1a83962a5005802a3f914b7ebfe8f6a2371097967955dcdcd6de01d4148c5fd9d3c96dafbd

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.5.0 - 2019-10-25
+
+- Adds error event to the client abstraction, for handling errors in the background listener
+- Adds an `open_timeout` setter to the API
+- Fixes an overly aggressive filter for event handlers
+
 ## 1.4.0 - 2019-09-30
 
 - Adds the option to change the logger globally or per-object.

data/lib/matrix_sdk.rb

@@ -42,10 +42,10 @@ module MatrixSdk
 
   def self.logger=(global_logger)
     @logger = global_logger
-    @use_global_logger = !global_logger.nil?
+    @global_logger = !global_logger.nil?
   end
 
   def self.global_logger?
-    @use_global_logger || false
+    @global_logger ||= false
   end
 end

data/lib/matrix_sdk/api.rb

@@ -23,7 +23,7 @@ module MatrixSdk
     }.freeze
 
     attr_accessor :access_token, :connection_address, :connection_port, :device_id, :autoretry, :global_headers
-    attr_reader :homeserver, :validate_certificate, :read_timeout, :protocols, :well_known, :proxy_uri
+    attr_reader :homeserver, :validate_certificate, :open_timeout, :read_timeout, :protocols, :well_known, :proxy_uri
 
     ignore_inspect :access_token, :logger
 
@@ -38,6 +38,7 @@ module MatrixSdk
     # @option params [Boolean] :validate_certificate (false) Should the connection require valid SSL certificates
     # @option params [Integer] :transaction_id (0) The starting ID for transactions
     # @option params [Numeric] :backoff_time (5000) The request backoff time in milliseconds
+    # @option params [Numeric] :open_timeout (60) The timeout in seconds to wait for a TCP session to open
     # @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
@@ -63,6 +64,7 @@ module MatrixSdk
       @validate_certificate = params.fetch(:validate_certificate, false)
       @transaction_id = params.fetch(:transaction_id, 0)
       @backoff_time = params.fetch(:backoff_time, 5000)
+      @open_timeout = params.fetch(:open_timeout, 60)
       @read_timeout = params.fetch(:read_timeout, 240)
       @well_known = params.fetch(:well_known, {})
       @global_headers = DEFAULT_HEADERS.dup
@@ -155,6 +157,13 @@ module MatrixSdk
       protocols.include? protocol
     end
 
+    # @param seconds [Numeric]
+    # @return [Numeric]
+    def open_timeout=(seconds)
+      @http.finish if @http && @open_timeout != seconds
+      @open_timeout = seconds
+    end
+
     # @param seconds [Numeric]
     # @return [Numeric]
     def read_timeout=(seconds)
@@ -291,6 +300,7 @@ module MatrixSdk
                   Net::HTTP.new(host, port)
                 end
 
+      @http.open_timeout = open_timeout
       @http.read_timeout = read_timeout
       @http.use_ssl = homeserver.scheme == 'https'
       @http.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_NONE : nil

data/lib/matrix_sdk/client.rb

@@ -2,6 +2,7 @@
 
 require 'matrix_sdk'
 
+require 'English'
 require 'forwardable'
 
 module MatrixSdk
@@ -13,7 +14,7 @@ module MatrixSdk
     attr_reader :api
     attr_accessor :cache, :sync_filter
 
-    events :event, :presence_event, :invite_event, :leave_event, :ephemeral_event
+    events :error, :event, :presence_event, :invite_event, :leave_event, :ephemeral_event
     ignore_inspect :api,
                    :on_event, :on_presence_event, :on_invite_event, :on_leave_event, :on_ephemeral_event
 
@@ -257,6 +258,10 @@ module MatrixSdk
       @sync_thread = nil
     end
 
+    def listening?
+      @sync_thread&.alive? == true
+    end
+
     def sync(skip_store_batch: false, **params)
       extra_params = {
         filter: sync_filter,
@@ -301,6 +306,10 @@ module MatrixSdk
           end
         end
       end
+    rescue StandardError => e
+      logger.error "Unhandled #{e.class} raised in background listener"
+      logger.error [e.message, *e.backtrace].join($RS)
+      fire_error(ErrorEvent.new(e, :listener_thread))
     end
 
     def post_authentication(data)

data/lib/matrix_sdk/extensions.rb

@@ -107,7 +107,7 @@ module MatrixSdk
     def fire(event, filter = nil)
       reverse_each do |_k, h|
         begin
-          h[:block].call(event) if event.matches?(h[:filter], filter)
+          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}"
 
@@ -138,6 +138,19 @@ module MatrixSdk
     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
 

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha