matrix_sdk 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cf8d41f930fae4069a51d6fff87e211a790529c5f157ff6402c15b44770f64d
-  data.tar.gz: 7c06c98e08232dd24f9667dfbb850a2d12ed2021b2f30cb3ad0cbd2a38e8f6e0
+  metadata.gz: dee0d341f6962b850245ebbea4e85a9e4e3ac14d809a3f3bf1236d5458e9ef80
+  data.tar.gz: 9a1c731a321aee4f85ad4b6f39f85c975aa763308c069494448b200c7b88b1d3
 SHA512:
-  metadata.gz: dfc1717d3b368fffd50f3fb717a3742bf821f3863e4c493797117f15a724ee4bf15be3b45d2dc1d7971a0206e1f21febf128eef389cdd8fa42274e6da1208530
-  data.tar.gz: 1025e4fc9d9f6fe7718971ba3b4c74a0ac35297eb0bb592ad3e25505ec2ec39a36c5d518a835e357b93994db4197066566b17c0696c2298017cdc560e7e7a1ee
+  metadata.gz: ce68baa4997e7ba558c06458d3660d8c1429f352989c1dbef9b47943d77180bb646d45c8a727d29928318f3908ca51240335851b8ee66a345750bef71fd5bfd7
+  data.tar.gz: 51d7bb564f54c1f4f82700ea7f149837b24035859319be96357bfcb538d948a07b62dbe78e570ebc0090befcd099c5892422c71cc2ab3567296250772af70ae9

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 ---
-image: "ruby:2.4"
+image: "ruby:2.6"
 
 # Cache gems in between builds
 cache:
@@ -17,9 +17,13 @@ rubocop:
     - rubocop lib
 
 test:
+  coverage: '/\((\d+.\d+\%)\) covered/'
   script:
     - GENERATE_REPORTS=true CI_REPORTS=reports bundle exec rake test
   artifacts:
+    expire_in: 1 week
+    paths:
+      - coverage/
     reports:
       junit: "reports/TEST-*.xml"
 

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.6
   Exclude:
     - '*.spec'
     - 'Rakefile'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.0.0 - 2019-05-17
+
+- Improves testing and code coverage of existing code
+- Fixes a series of minor bugs found during the writing of tests
+
 ## v0.1.0 - 2019-05-10
 
 - Adds code for handling member lazy load in the client abstraction, and activates it by default

data/lib/matrix_sdk.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'matrix_sdk/extensions'
 require 'matrix_sdk/version'
 

data/lib/matrix_sdk/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'matrix_sdk'
 
 require 'erb'
@@ -13,7 +15,7 @@ module MatrixSdk
     include MatrixSdk::Protocols::IS
     include MatrixSdk::Protocols::CS
 
-    USER_AGENT = "Ruby Matrix SDK v#{MatrixSdk::VERSION}".freeze
+    USER_AGENT = "Ruby Matrix SDK v#{MatrixSdk::VERSION}"
     DEFAULT_HEADERS = {
       'accept' => 'application/json',
       'user-agent' => USER_AGENT
@@ -41,9 +43,11 @@ module MatrixSdk
     # @option params [Hash] :well_known The .well-known object that the server was discovered through, should not be set manually
     def initialize(homeserver, params = {})
       @homeserver = homeserver
+      raise ArgumentError, 'Homeserver URL must be String or URI' unless @homeserver.is_a?(String) || @homeserver.is_a?(URI)
+
       @homeserver = URI.parse("#{'https://' unless @homeserver.start_with? 'http'}#{@homeserver}") unless @homeserver.is_a? URI
       @homeserver.path.gsub!(/\/?_matrix\/?/, '') if @homeserver.path =~ /_matrix\/?$/
-      raise 'Please use the base URL for your HS (without /_matrix/)' if @homeserver.path.include? '/_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
@@ -61,6 +65,7 @@ module MatrixSdk
       @well_known = params.fetch(:well_known, {})
       @global_headers = DEFAULT_HEADERS.dup
       @global_headers.merge!(params.fetch(:global_headers)) if params.key? :global_headers
+      @http = nil
 
       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]
@@ -108,7 +113,7 @@ module MatrixSdk
                          nil
                        end
 
-          target_uri = well_known['m.server'] if well_known && well_known.key?('m.server')
+          target_uri = well_known['m.server'] if well_known&.key?('m.server')
         else
           target_uri = URI("https://#{target_uri.target}:#{target_uri.port}")
         end
@@ -169,7 +174,7 @@ module MatrixSdk
       # TODO: DNS query for SRV information about HS?
       return unless hs_info.is_a? URI
 
-      @http.finish if @http
+      @http.finish if @http && homeserver != hs_info
       @homeserver = hs_info
     end
 
@@ -264,6 +269,7 @@ module MatrixSdk
       @http.use_ssl = homeserver.scheme == 'https'
       @http.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_NONE : nil
       @http.start
+      @http
     end
   end
 end

data/lib/matrix_sdk/application_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'matrix_sdk'
 
 module MatrixSdk
@@ -154,7 +156,7 @@ module MatrixSdk
     end
 
     def stop_server
-      @server.shutdown if @server
+      @server&.shutdown
       @server = nil
     end
 

data/lib/matrix_sdk/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'matrix_sdk'
 
 require 'forwardable'
@@ -73,7 +75,7 @@ module MatrixSdk
 
     def mxid
       @mxid ||= begin
-        api.whoami?[:user_id] if api && api.access_token
+        api.whoami?[:user_id] if api&.access_token
       end
     end
 
@@ -96,7 +98,7 @@ module MatrixSdk
       post_authentication(data)
     end
 
-    def register_with_password(username, password)
+    def register_with_password(username, password, full_state: true, **params)
       username = username.to_s unless username.is_a?(String)
       password = password.to_s unless password.is_a?(String)
 
@@ -105,6 +107,11 @@ module MatrixSdk
 
       data = api.register(auth: { type: 'm.login.dummy' }, username: username, password: password)
       post_authentication(data)
+
+      return if params[:no_sync]
+
+      sync full_state: full_state,
+           allow_sync_retry: params.fetch(:allow_sync_retry, nil)
     end
 
     def login(username, password, sync_timeout: 15, full_state: false, **params)
@@ -164,7 +171,7 @@ module MatrixSdk
       room_id_or_alias = MXID.new(room_id_or_alias.to_s) unless room_id_or_alias.is_a? MXID
       raise ArgumentError, 'Must be a room id or alias' unless %i[room_id room_alias].include? room_id_or_alias.type
 
-      return @rooms.fetch(room_id_or_alias, nil) if room_id_or_alias.room_id?
+      return @rooms.fetch(room_id_or_alias.to_s, nil) if room_id_or_alias.room_id?
 
       return @rooms.values.find { |r| r.canonical_alias == room_id_or_alias.to_s } if only_canonical
 
@@ -216,7 +223,7 @@ module MatrixSdk
 
       attempts = 0
       data = loop do
-        begin
+        begin # rubocop:disable Style/RedundantBegin
           break api.sync extra_params
         rescue MatrixSdk::MatrixTimeoutError => e
           raise e if (attempts += 1) >= params.fetch(:allow_sync_retry, 0)
@@ -239,12 +246,12 @@ module MatrixSdk
           sync(params.merge(timeout: timeout))
 
           bad_sync_timeout = orig_bad_sync_timeout
-          sleep(sync_interval) if sync_interval > 0
+          sleep(sync_interval) if sync_interval.positive?
         rescue MatrixRequestError => e
           logger.warn("A #{e.class} occurred during sync")
           if e.httpstatus >= 500
             logger.warn("Serverside error, retrying in #{bad_sync_timeout} seconds...")
-            sleep params[:bad_sync_timeout]
+            sleep(bad_sync_timeout) if bad_sync_timeout.positive? # rubocop:disable Metrics/BlockNesting
             bad_sync_timeout = [bad_sync_timeout * 2, @bad_sync_timeout_limit].min
           end
         end

data/lib/matrix_sdk/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk
   # A generic error raised for issues in the MatrixSdk
   class MatrixError < StandardError

data/lib/matrix_sdk/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module URI
   class MATRIX < Generic
     def full_path
@@ -96,7 +98,7 @@ module MatrixSdk
 
     def fire(event, filter = nil)
       reverse_each do |_k, h|
-        begin
+        begin # rubocop:disable Style/RedundantBegin
           h[:block].call(event) if event.matches?(h[:filter], filter)
         rescue StandardError => e
           logger.error "#{e.class.name} occurred when firing event (#{event})\n#{e}"

data/lib/matrix_sdk/mxid.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 module MatrixSdk
   class MXID
     attr_accessor :sigil, :localpart, :domain, :port
 
     # @param identifier [String] The Matrix ID string in the format of '&<localpart>:<domain>' where '&' is the sigil
     def initialize(identifier)
-      raise ArugmentError, 'Identifier must be a String' unless identifier.is_a? String
+      raise ArgumentError, 'Identifier must be a String' unless identifier.is_a? String
       raise ArgumentError, 'Identifier is too long' if identifier.size > 255
       raise ArgumentError, 'Identifier lacks required data' unless identifier =~ %r{^([@!$+#][^:]+:[^:]+(?::\d+)?)|(\$[A-Za-z0-9+/]+)$}
 
       @sigil = identifier[0]
       @localpart, @domain, @port = identifier[1..-1].split(':')
+      @port = @port.to_i if @port
 
       raise ArgumentError, 'Identifier is not a valid MXID' unless valid?
     end
 
     def to_s
-      "#{sigil}#{localpart}#{domain ? ':' + domain : ''}"
+      port_s = port ? ':' + port.to_s : ''
+      "#{sigil}#{localpart}#{domain ? ':' + domain + port_s : ''}"
     end
 
     # Returns the type of the ID

data/lib/matrix_sdk/protocols/as.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk::Protocols::AS
   def self.included(_klass)
     # XXX

data/lib/matrix_sdk/protocols/cs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk::Protocols::CS
   # Gets the available client API versions
   # @return [Array]
@@ -5,7 +7,7 @@ module MatrixSdk::Protocols::CS
     @client_api_versions ||= request(:get, :client, '/versions').versions.tap do |vers|
       vers.instance_eval <<-'CODE', __FILE__, __LINE__ + 1
         def latest
-          latest
+          last
         end
       CODE
     end

data/lib/matrix_sdk/protocols/is.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk::Protocols::IS
   def identity_status
     request(:get, :identity_api_v1, '/')

data/lib/matrix_sdk/protocols/ss.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk::Protocols::SS
   # Gets the server version
   def server_version

data/lib/matrix_sdk/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk
   # An usability wrapper for API responses as an extended [Hash]
   # All results can be read as both hash keys and as read-only methods on the key

data/lib/matrix_sdk/room.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'matrix_sdk'
 
 module MatrixSdk
@@ -306,7 +308,7 @@ module MatrixSdk
     # @return [Boolean] wether the request succeeded
     def leave
       client.api.leave_room(id)
-      client.rooms.delete id
+      client.instance_variable_get(:@rooms).delete id
       true
     end
 
@@ -485,7 +487,7 @@ module MatrixSdk
         data[:events].delete_if { |_k, v| v.nil? }
       end
 
-      client.api.set_power.levels(id, data)
+      client.api.set_power_levels(id, data)
       true
     end
 

data/lib/matrix_sdk/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'matrix_sdk'
 
 module MatrixSdk

data/lib/matrix_sdk/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MatrixSdk
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging