matrix_sdk 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc787a1c2e4bac79cf05357500571df2e7734464023a5182d08614b9e45e9aac
-  data.tar.gz: 465ea39af281892dcb299014b8a5b4bc0c869f6914974f40cb6fd21301090129
+  metadata.gz: 39fdb05386da317f2810f25e668ae14bdd261c807bafc61056fa09dd1d6a8175
+  data.tar.gz: 88b32840ca73b6588f36e35edcccac15e721b071c69a60c6cfc383dceaf67e5f
 SHA512:
-  metadata.gz: a18893ee520aedfacc011cf5888b310875ee6929fa94967a0eeee01e91d592a56b19b190e6400e5e9338ccf477f9ac4cb1c480866fb720c1eecee7f0fb005a6f
-  data.tar.gz: ed1d6b9eaad9795147ffb8bf319c4fed25598147a2af2f97048eb0285684c32fc7809e36ad891917f3499105778eb11409d8577941258c9fb94cee84b4c41dbd
+  metadata.gz: b04d1f07b5d9dd97f3a80a2adffe9a4a29983efc4ee7d1c116c0036233e017d5d9ead02abc9a3048fc9b0ba51c1ee3353fd7ae999a7b5bfc8a41294cd9c1b47c
+  data.tar.gz: a27b7a3bf9b8c411e6026107d3d0a66cd0e86ac96f6bd6284ccc37ec35e3fd67a94a99b1ad2e67f948dd63003bd4f7495fc66baf3b0d1dc880ee300e1aa49b70

data/.gitlab-ci.yml

@@ -7,27 +7,31 @@ cache:
     - vendor/ruby
 
 before_script:
-  - gem install bundler --no-ri --no-rdoc
+  - gem install bundler -N
   - bundle install -j $(nproc) --path vendor
 
 rubocop:
   before_script: []
   script:
-    - gem install rubocop --no-ri --no-rdoc
-    - rubocop
+    - gem install rubocop -N
+    - rubocop lib
 
-# rspec:
-#   script:
-#   - rspec spec
+test:
+  script:
+    - GENERATE_REPORTS=true CI_REPORTS=reports bundle exec rake test
+  artifacts:
+    reports:
+      junit: "reports/TEST-*.xml"
 
 pages:
   stage: deploy
   before_script: []
   script:
-    - gem install yard
+    - gem install yard -N
     - yard doc -o public/
   artifacts:
     paths:
       - public/
   only:
     - master
+  when: always

data/.rubocop.yml

@@ -4,6 +4,10 @@ AllCops:
     - '*.spec'
     - 'Rakefile'
 
+# Broken in CI
+Lint/Void:
+  Enabled: false
+
 # Don't enforce documentation
 Style/Documentation:
   Enabled: false
@@ -12,7 +16,7 @@ Metrics/ClassLength:
   Enabled: false
 
 Metrics/MethodLength:
-  Max: 40
+  Max: 50
 
 Metrics/LineLength:
   Max: 190

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v0.0.4 - 2019-02-20
+
+- Adds a parameter to the client abstraction to allow retrying syncs on timeouts
+- Adds support for token-based login in the client abstraction
+- Adds rudimentary username and password validation in the client abstraction
+- Adds MXID validation in the client abstraction
+- Adds a method to discover a homeserver address based on a domain.
+    - Supporting both SRV and .well-known lookups
+- Adds methods from the r0.4.0 spec
+- Adds support for version 3 event IDs
+- Extends the connection exceptions with a specific timeout error
+- Sets a series of filters in the simple client example to skip unhandled event
+- Fixes an exception when null values end up in the body cleaner during debugging
+- Fixes an error with CGI not being required correctly
+
 ## v0.0.3 - 2018-08-14
 
 - Adds missing accessors for HTTP timeout

data/Rakefile

@@ -7,4 +7,9 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+if ENV['GENERATE_REPORTS'] == 'true'
+  require 'ci/reporter/rake/test_unit'
+  task :test => 'ci:setup:testunit'
+end
+
 task :default => :test

data/examples/simple_client.rb

@@ -3,19 +3,61 @@
 require 'io/console'
 require 'matrix_sdk'
 
+# A filter to only discover joined rooms
+ROOM_DISCOVERY_FILTER = {
+  event_fields: %w[sender membership],
+  presence: { senders: [], types: [] },
+  account_data: { senders: [], types: [] },
+  room: {
+    ephemeral: { senders: [], types: [] },
+    state: {
+      senders: [],
+      types: [
+        'm.room.aliases',
+        'm.room.canonical_alias',
+        'm.room.member'
+      ]
+    },
+    timeline: { senders: [], types: [] },
+    account_data: { senders: [], types: [] }
+  }
+}.freeze
+
+# A filter to only retrieve messages from rooms
+ROOM_STATE_FILTER = {
+  presence: { senders: [], types: [] },
+  account_data: { senders: [], types: [] },
+  room: {
+    ephemeral: { senders: [], types: [] },
+    state: {
+      types: ['m.room.member']
+    },
+    timeline: {
+      types: ['m.room.message']
+    },
+    account_data: { senders: [], types: [] }
+  }
+}.freeze
+
+
 class SimpleClient < MatrixSdk::Client
   def initialize(hs_url)
     super hs_url, sync_filter_limit: 10
 
     @pls = {}
+    @tracked_rooms = []
+    @filter = ROOM_STATE_FILTER.dup
   end
 
   def add_listener(room)
     room.on_event.add_handler { |ev| on_message(room, ev) }
+    @tracked_rooms << room.id
   end
 
   def run
-    start_listener_thread
+    # Only track messages from the listened rooms
+    @filter[:room][:rooms] = @tracked_rooms
+    start_listener_thread(filter: @filter.to_json)
   end
 
   private
@@ -64,7 +106,12 @@ if $PROGRAM_NAME == __FILE__
     password = STDIN.noecho(&:gets).strip
 
     puts 'Logging in...'
-    client.login(user, password, sync_timeout: 5)
+    client.login(user, password, no_sync: true)
+
+    # Only retrieve list of joined room in first sync
+    sync_filter = client.sync_filter.merge(ROOM_DISCOVERY_FILTER)
+    sync_filter[:room][:state][:senders] << client.mxid
+    client.listen_for_events(5, filter: sync_filter.to_json)
 
     puts 'Finding room...'
     room = client.find_room(ARGV.last)

data/lib/matrix_sdk/api.rb

@@ -1,5 +1,6 @@
 require 'matrix_sdk'
 
+require 'cgi'
 require 'json'
 require 'net/http'
 require 'openssl'
@@ -9,17 +10,19 @@ module MatrixSdk
   class Api
     USER_AGENT = "Ruby Matrix SDK v#{MatrixSdk::VERSION}".freeze
     DEFAULT_HEADERS = {
-      'accept'     => 'application/json',
+      'accept' => 'application/json',
       'user-agent' => USER_AGENT
     }.freeze
 
-    attr_accessor :access_token, :device_id, :autoretry, :global_headers
+    attr_accessor :access_token, :connection_address, :connection_port, :device_id, :autoretry, :global_headers
     attr_reader :homeserver, :validate_certificate, :read_timeout
 
     ignore_inspect :access_token, :logger
 
     # @param homeserver [String,URI] The URL to the Matrix homeserver, without the /_matrix/ part
     # @param params [Hash] Additional parameters on creation
+    # @option params [String] :address The connection address to the homeserver, if different to the HS URL
+    # @option params [Integer] :port The connection port to the homeserver, if different to the HS URL
     # @option params [String] :access_token The access token to use for the connection
     # @option params [String] :device_id The ID of the logged in decide to use
     # @option params [Boolean] :autoretry (true) Should requests automatically be retried in case of rate limits
@@ -32,15 +35,11 @@ module MatrixSdk
     def initialize(homeserver, params = {})
       @homeserver = homeserver
       @homeserver = URI.parse("#{'https://' unless @homeserver.start_with? 'http'}#{@homeserver}") unless @homeserver.is_a? URI
-      if @homeserver.path.end_with? '_matrix/'
-        @homeserver.path = begin
-          split = @homeserver.path.rpartition '_matrix/'
-          (split[(split.find_index '_matrix/')] = '/') rescue nil
-          split.join
-        end
-      end
+      @homeserver.path.gsub!(/\/?_matrix\/?/, '') if @homeserver.path =~ /_matrix\/?$/
       raise 'Please use the base URL for your HS (without /_matrix/)' if @homeserver.path.include? '/_matrix/'
 
+      @connection_address = params.fetch(:address, nil)
+      @connection_port = params.fetch(:port, nil)
       @access_token = params.fetch(:access_token, nil)
       @device_id = params.fetch(:device_id, nil)
       @autoretry = params.fetch(:autoretry, true)
@@ -55,6 +54,60 @@ module MatrixSdk
       @homeserver.userinfo = '' unless params[:skip_login]
     end
 
+    # Create an API connection to a domain entry
+    #
+    # This will follow the server discovery spec for client-server and federation
+    #
+    # @example Opening a Matrix API connection to a homeserver
+    #   hs = MatrixSdk::API.new_for_domain 'example.com'
+    #   hs.connection_address
+    #   # => 'matrix.example.com'
+    #   hs.connection_port
+    #   # => 443
+    #
+    # @param domain [String] The domain to set up the API connection for, can contain a ':' to denote a port
+    # @param params [Hash] Additional options to pass to .new
+    # @return [API] The API connection
+    def self.new_for_domain(domain, params = {})
+      # Attempt SRV record discovery
+      srv = if domain.include? ':'
+              addr, port = domain.split ':'
+              Resolv::DNS::Resource::IN::SRV.new 10, 1, port.to_i, addr
+            else
+              require 'resolv'
+              resolver = Resolv::DNS.new
+              begin
+                resolver.getresource("_matrix._tcp.#{domain}")
+              rescue Resolv::ResolvError
+                nil
+              end
+            end
+
+      # Attempt .well-known discovery
+      if srv.nil?
+        well_known = begin
+                       data = Net::HTTP.get("https://#{domain}/.well-known/matrix/client")
+                       JSON.parse(data)
+                     rescue StandardError
+                       nil
+                     end
+
+        return new(well_known['m.homeserver']['base_url']) if well_known &&
+                                                              well_known.key?('m.homeserver') &&
+                                                              well_known['m.homerserver'].key?('base_url')
+      end
+
+      # Fall back to A record on domain
+      srv ||= Resolv::DNS::Resource::IN::SRV.new 10, 1, 8448, domain
+
+      domain = domain.split(':').first if domain.include? ':'
+      new("https://#{domain}",
+          params.merge(
+            address: srv.target.to_s,
+            port: srv.port
+          ))
+    end
+
     # Gets the logger for the API
     # @return [Logging::Logger] The API-scope logger
     def logger
@@ -81,6 +134,7 @@ module MatrixSdk
     def homeserver=(hs_info)
       # TODO: DNS query for SRV information about HS?
       return unless hs_info.is_a? URI
+
       @http.finish if @http
       @homeserver = hs_info
     end
@@ -88,14 +142,32 @@ module MatrixSdk
     # Gets the available client API versions
     # @return [Array]
     def client_api_versions
-      @client_api_versions ||= request(:get, :client, '/versions').versions
+      @client_api_versions ||= request(:get, :client, '/versions').versions.tap do |vers|
+        vers.instance_eval <<-'CODE', __FILE__, __LINE__ + 1
+          def latest
+            latest
+          end
+        CODE
+      end
+    end
+
+    # Gets the list of available unstable client API features
+    # @return [Array]
+    def client_api_unstable_features
+      @client_api_unstable_features ||= request(:get, :client, '/versions').unstable_features.tap do |vers|
+        vers.instance_eval <<-'CODE', __FILE__, __LINE__ + 1
+          def has?(feature)
+            fetch(feature, nil)
+          end
+        CODE
+      end
     end
 
     # Gets the server version
     # @note This uses the unstable federation/v1 API
     def server_version
       Response.new(self, request(:get, :federation_v1, '/version').server).tap do |resp|
-        resp.instance_eval <<-'CODE', __FILE__, __LINE__ - 1
+        resp.instance_eval <<-'CODE', __FILE__, __LINE__ + 1
           def to_s
             "#{name} #{version}"
           end
@@ -195,11 +267,21 @@ module MatrixSdk
     end
 
     # Logs out the currently logged in user
-    # @return [Response]
+    # @return [Response] An empty response if the logout was successful
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#post-matrix-client-r0-logout
+    #      The Matrix Spec, for more information about the call and response
     def logout
       request(:post, :client_r0, '/logout')
     end
 
+    # Creates a new room
+    # @param params [Hash] The room creation details
+    # @option params [Symbol] :visibility (:public) The room visibility
+    # @option params [String] :room_alias A room alias to apply on creation
+    # @option params [Boolean] :invite Should the room be created invite-only
+    # @return [Response] A response hash with ...
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#post-matrix-client-r0-createroom
+    #      The Matrix Spec, for more information about the call and response
     def create_room(params = {})
       content = {
         visibility: params.fetch(:visibility, :public)
@@ -210,12 +292,31 @@ module MatrixSdk
       request(:post, :client_r0, '/createRoom', content)
     end
 
+    # Joins a room
+    # @param id_or_alias [MXID,String] The room ID or Alias to join
+    # @return [Response] A response hash with the parameter :room_id
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#post-matrix-client-r0-join-roomidoralias
+    #      The Matrix Spec, for more information about the call and response
     def join_room(id_or_alias)
+      # id_or_alias = MXID.new id_or_alias.to_s unless id_or_alias.is_a? MXID
+      # raise ArgumentError, 'Not a room ID or alias' unless id_or_alias.room?
+
       id_or_alias = CGI.escape id_or_alias.to_s
 
       request(:post, :client_r0, "/join/#{id_or_alias}")
     end
 
+    # Sends a state event to a room
+    # @param room_id [MXID,String] The room ID to send the state event to
+    # @param event_type [String] The event type to send
+    # @param content [Hash] The contents of the state event
+    # @param params [Hash] Options for the request
+    # @option params [Integer] :timestamp The timestamp when the event was created, only used for AS events
+    # @option params [String] :state_key The state key of the event, if there is one
+    # @return [Response] A response hash with the parameter :event_id
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype-statekey
+    #      https://matrix.org/docs/spec/client_server/r0.3.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype
+    #      The Matrix Spec, for more information about the call and response
     def send_state_event(room_id, event_type, content, params = {})
       query = {}
       query[:ts] = params[:timestamp].to_i if params.key? :timestamp
@@ -227,6 +328,16 @@ module MatrixSdk
       request(:put, :client_r0, "/rooms/#{room_id}/state/#{event_type}#{"/#{state_key}" unless state_key.nil?}", body: content, query: query)
     end
 
+    # Sends a message event to a room
+    # @param room_id [MXID,String] The room ID to send the message event to
+    # @param event_type [String] The event type of the message
+    # @param content [Hash] The contents of the message
+    # @param params [Hash] Options for the request
+    # @option params [Integer] :timestamp The timestamp when the event was created, only used for AS events
+    # @option params [Integer] :txn_id The ID of the transaction, or automatically generated
+    # @return [Response] A response hash with the parameter :event_id
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#put-matrix-client-r0-rooms-roomid-send-eventtype-txnid
+    #      The Matrix Spec, for more information about the call and response
     def send_message_event(room_id, event_type, content, params = {})
       query = {}
       query[:ts] = params[:timestamp].to_i if params.key? :timestamp
@@ -241,7 +352,17 @@ module MatrixSdk
       request(:put, :client_r0, "/rooms/#{room_id}/send/#{event_type}/#{txn_id}", body: content, query: query)
     end
 
-    def redact_event(room_id, event_type, params = {})
+    # Redact an event in a room
+    # @param room_id [MXID,String] The room ID to send the message event to
+    # @param event_id [String] The event ID of the event to redact
+    # @param params [Hash] Options for the request
+    # @option params [Integer] :timestamp The timestamp when the event was created, only used for AS events
+    # @option params [String] :reason The reason for the redaction
+    # @option params [Integer] :txn_id The ID of the transaction, or automatically generated
+    # @return [Response] A response hash with the parameter :event_id
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#put-matrix-client-r0-rooms-roomid-redact-eventid-txnid
+    #      The Matrix Spec, for more information about the call and response
+    def redact_event(room_id, event_id, params = {})
       query = {}
       query[:ts] = params[:timestamp].to_i if params.key? :timestamp
 
@@ -252,12 +373,53 @@ module MatrixSdk
       txn_id = params.fetch(:txn_id, "#{txn_id}#{Time.now.to_i}")
 
       room_id = CGI.escape room_id.to_s
-      event_type = CGI.escape event_type.to_s
+      event_id = CGI.escape event_id.to_s
       txn_id = CGI.escape txn_id.to_s
 
-      request(:put, :client_r0, "/rooms/#{room_id}/redact/#{event_type}/#{txn_id}", body: content, query: query)
+      request(:put, :client_r0, "/rooms/#{room_id}/redact/#{event_id}/#{txn_id}", body: content, query: query)
     end
 
+    # Send a content message to a room
+    #
+    # @example Sending an image to a room
+    #   send_content('!abcd123:localhost',
+    #                'mxc://localhost/1234567',
+    #                'An image of a cat',
+    #                'm.image',
+    #                extra_information: {
+    #                  h: 128,
+    #                  w: 128,
+    #                  mimetype: 'image/png',
+    #                  size: 1024
+    #                })
+    #
+    # @example Sending a file to a room
+    #   send_content('!example:localhost',
+    #                'mxc://localhost/fileurl',
+    #                'Contract.pdf',
+    #                'm.file',
+    #                extra_content: {
+    #                  filename: 'contract.pdf'
+    #                },
+    #                extra_information: {
+    #                  mimetype: 'application/pdf',
+    #                  size: 96674
+    #                })
+    #
+    # @param room_id [MXID,String] The room ID to send the content to
+    # @param url [URI,String] The URL to the content
+    # @param name [String] The name of the content
+    # @param msg_type [String] The message type of the content
+    # @param params [Hash] Options for the request
+    # @option params [Hash] :extra_information ({}) Extra information for the content
+    # @option params [Hash] :extra_content Extra data to insert into the content hash
+    # @return [Response] A response hash with the parameter :event_id
+    # @see send_message_event For more information on the underlying call
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-image
+    #      https://matrix.org/docs/spec/client_server/r0.3.0.html#m-file
+    #      https://matrix.org/docs/spec/client_server/r0.3.0.html#m-video
+    #      https://matrix.org/docs/spec/client_server/r0.3.0.html#m-audio
+    #      The Matrix Spec, for more information about the call and response
     def send_content(room_id, url, name, msg_type, params = {})
       content = {
         url: url,
@@ -265,22 +427,47 @@ module MatrixSdk
         body: name,
         info: params.delete(:extra_information) { {} }
       }
+      content.merge!(params.fetch(:extra_content)) if params.key? :extra_content
 
       send_message_event(room_id, 'm.room.message', content, params)
     end
 
+    # Send a geographic location to a room
+    #
+    # @param room_id [MXID,String] The room ID to send the location to
+    # @param geo_uri [URI,String] The geographical URI to send
+    # @param name [String] The name of the location
+    # @param params [Hash] Options for the request
+    # @option params [Hash] :extra_information ({}) Extra information for the location
+    # @option params [URI,String] :thumbnail_url The URL to a thumbnail of the location
+    # @option params [Hash] :thumbnail_info Image information about the location thumbnail
+    # @return [Response] A response hash with the parameter :event_id
+    # @see send_message_event For more information on the underlying call
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-location
+    #      The Matrix Spec, for more information about the call and response
     def send_location(room_id, geo_uri, name, params = {})
       content = {
         geo_uri: geo_uri,
         msgtype: 'm.location',
-        body: name
+        body: name,
+        info: params.delete(:extra_information) { {} }
       }
-      content[:thumbnail_url] = params.delete(:thumbnail_url) if params.key? :thumbnail_url
-      content[:thumbnail_info] = params.delete(:thumbnail_info) if params.key? :thumbnail_info
+      content[:info][:thumbnail_url] = params.delete(:thumbnail_url) if params.key? :thumbnail_url
+      content[:info][:thumbnail_info] = params.delete(:thumbnail_info) if params.key? :thumbnail_info
 
       send_message_event(room_id, 'm.room.message', content, params)
     end
 
+    # Send a plaintext message to a room
+    #
+    # @param room_id [MXID,String] The room ID to send the message to
+    # @param message [String] The message to send
+    # @param params [Hash] Options for the request
+    # @option params [String] :msg_type ('m.text') The message type to send
+    # @return [Response] A response hash with the parameter :event_id
+    # @see send_message_event For more information on the underlying call
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-text
+    #      The Matrix Spec, for more information about the call and response
     def send_message(room_id, message, params = {})
       content = {
         msgtype: params.delete(:msg_type) { 'm.text' },
@@ -289,6 +476,16 @@ module MatrixSdk
       send_message_event(room_id, 'm.room.message', content, params)
     end
 
+    # Send a plaintext emote to a room
+    #
+    # @param room_id [MXID,String] The room ID to send the message to
+    # @param emote [String] The emote to send
+    # @param params [Hash] Options for the request
+    # @option params [String] :msg_type ('m.emote') The message type to send
+    # @return [Response] A response hash with the parameter :event_id
+    # @see send_message_event For more information on the underlying call
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-emote
+    #      The Matrix Spec, for more information about the call and response
     def send_emote(room_id, emote, params = {})
       content = {
         msgtype: params.delete(:msg_type) { 'm.emote' },
@@ -297,6 +494,16 @@ module MatrixSdk
       send_message_event(room_id, 'm.room.message', content, params)
     end
 
+    # Send a plaintext notice to a room
+    #
+    # @param room_id [MXID,String] The room ID to send the message to
+    # @param notice [String] The notice to send
+    # @param params [Hash] Options for the request
+    # @option params [String] :msg_type ('m.notice') The message type to send
+    # @return [Response] A response hash with the parameter :event_id
+    # @see send_message_event For more information on the underlying call
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-notice
+    #      The Matrix Spec, for more information about the call and response
     def send_notice(room_id, notice, params = {})
       content = {
         msgtype: params.delete(:msg_type) { 'm.notice' },
@@ -305,6 +512,18 @@ module MatrixSdk
       send_message_event(room_id, 'm.room.message', content, params)
     end
 
+    # Retrieve additional messages in a room
+    #
+    # @param room_id [MXID,String] The room ID to retrieve messages for
+    # @param token [String] The token to start retrieving from, can be from a sync or from an earlier get_room_messages call
+    # @param direction [:b,:f] The direction to retrieve messages
+    # @param params [Hash] Additional options for the request
+    # @option params [Integer] :limit (10) The limit of messages to retrieve
+    # @option params [String] :to A token to limit retrieval to
+    # @option params [String] :filter A filter to limit the retrieval to
+    # @return [Response] A response hash with the message information containing :start, :end, and :chunk fields
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#get-matrix-client-r0-rooms-roomid-messages
+    #      The Matrix Spec, for more information about the call and response
     def get_room_messages(room_id, token, direction, params = {})
       query = {
         roomId: room_id,
@@ -313,12 +532,20 @@ module MatrixSdk
         limit: params.fetch(:limit, 10)
       }
       query[:to] = params[:to] if params.key? :to
+      query[:filter] = params.fetch(:filter) if params.key? :filter
 
       room_id = CGI.escape room_id.to_s
 
       request(:get, :client_r0, "/rooms/#{room_id}/messages", query: query)
     end
 
+    # Reads the latest instance of a room state event
+    #
+    # @param room_id [MXID,String] The room ID to read from
+    # @param state_type [String] The state type to read
+    # @return [Response] A response hash with the contents of the state event
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#get-matrix-client-r0-rooms-roomid-state-eventtype
+    #      The Matrix Spec, for more information about the call and response
     def get_room_state(room_id, state_type)
       room_id = CGI.escape room_id.to_s
       state_type = CGI.escape state_type.to_s
@@ -326,6 +553,13 @@ module MatrixSdk
       request(:get, :client_r0, "/rooms/#{room_id}/state/#{state_type}")
     end
 
+    # Gets the display name of a room
+    #
+    # @param room_id [MXID,String] The room ID to look up
+    # @return [Response] A response hash with the parameter :name
+    # @see get_room_state
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-room-name
+    #      The Matrix Spec, for more information about the event and data
     def get_room_name(room_id)
       get_room_state(room_id, 'm.room.name')
     end
@@ -452,9 +686,12 @@ module MatrixSdk
       request(:put, :client_r0, "/user/#{user_id}/rooms/#{room_id}/tags/#{tag}", body: content)
     end
 
-    # def get_account_data(user_id, type)
-    #   request(:get, :client_r0, "/user/#{user_id}/account_data/#{type}")
-    # end
+    def get_account_data(user_id, type_key)
+      user_id = CGI.escape user_id.to_s
+      type_key = CGI.escape type_key.to_s
+
+      request(:get, :client_r0, "/user/#{user_id}/account_data/#{type_key}")
+    end
 
     def set_account_data(user_id, type_key, account_data)
       user_id = CGI.escape user_id.to_s
@@ -463,9 +700,13 @@ module MatrixSdk
       request(:put, :client_r0, "/user/#{user_id}/account_data/#{type_key}", body: account_data)
     end
 
-    # def get_room_account_data(user_id, room_id, type)
-    #   request(:get, :client_r0, "/user/#{user_id}/rooms/#{room_id}/account_data/#{type}")
-    # end
+    def get_room_account_data(user_id, room_id, type_key)
+      user_id = CGI.escape user_id.to_s
+      room_id = CGI.escape room_id.to_s
+      type_key = CGI.escape type_key.to_s
+
+      request(:get, :client_r0, "/user/#{user_id}/rooms/#{room_id}/account_data/#{type_key}")
+    end
 
     def set_room_account_data(user_id, room_id, type_key, account_data)
       user_id = CGI.escape user_id.to_s
@@ -617,6 +858,7 @@ module MatrixSdk
 
         if response.is_a? Net::HTTPTooManyRequests
           raise MatrixRequestError.new(data, response.code) unless autoretry
+
           failures += 1
           waittime = data[:retry_after_ms] || data[:error][:retry_after_ms] || @backoff_time
           sleep(waittime.to_f / 1000.0)
@@ -625,7 +867,8 @@ module MatrixSdk
 
         return MatrixSdk::Response.new self, data if response.is_a? Net::HTTPSuccess
         raise MatrixRequestError.new(data, response.code) if data
-        raise MatrixConnectionError, response
+
+        raise MatrixConnectionError.class_by_code(response.code), response
       end
     end
 
@@ -645,8 +888,11 @@ module MatrixSdk
         logger.debug "#{dir} #{h}"
       end
       logger.debug dir
-      clean_body = JSON.parse(http.body).each { |k, v| v.replace('[ REDACTED ]') if %w[password access_token].include? k }.to_json if http.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
       logger.debug "#{dir} #{clean_body.length < 200 ? clean_body : clean_body.slice(0..200) + "... [truncated, #{clean_body.length} Bytes]"}" if clean_body
+    rescue StandardError => ex
+      logger.warn "#{ex.class} occured while printing request debug; #{ex.message}\n#{ex.backtrace.join "\n"}"
     end
 
     def transaction_id
@@ -661,7 +907,7 @@ module MatrixSdk
     end
 
     def http
-      @http ||= Net::HTTP.new homeserver.host, homeserver.port
+      @http ||= Net::HTTP.new (@connection_address || homeserver.host), (@connection_port || homeserver.port)
       return @http if @http.active?
 
       @http.read_timeout = read_timeout

data/lib/matrix_sdk/client.rb

@@ -7,20 +7,23 @@ module MatrixSdk
     extend Forwardable
 
     attr_reader :api
-    attr_writer :mxid
     attr_accessor :cache, :sync_filter
 
     events :event, :presence_event, :invite_event, :left_event, :ephemeral_event
     ignore_inspect :api,
                    :on_event, :on_presence_event, :on_invite_event, :on_left_event, :on_ephemeral_event
 
-    alias user_id= mxid=
-
     def_delegators :@api,
                    :access_token, :access_token=, :device_id, :device_id=, :homeserver, :homeserver=,
                    :validate_certificate, :validate_certificate=
 
-    def initialize(hs_url, params = {})
+    # @param hs_url [String,URI,Api] The URL to the Matrix homeserver, without the /_matrix/ part, or an existing Api instance
+    # @param client_cache [:all,:some,:none] (:all) How much data should be cached in the client
+    # @param params [Hash] Additional parameters on creation
+    # @option params [String,MXID] :user_id The user ID of the logged-in user
+    # @option params [Integer] :sync_filter_limit (20) Limit of timeline entries in syncs
+    # @see MatrixSdk::Api.new for additional usable params
+    def initialize(hs_url, client_cache: :all, **params)
       event_initialize
 
       params[:user_id] ||= params[:mxid] if params[:mxid]
@@ -36,7 +39,7 @@ module MatrixSdk
 
       @rooms = {}
       @users = {}
-      @cache = params.fetch(:client_cache, :all)
+      @cache = client_cache
 
       @sync_token = nil
       @sync_thread = nil
@@ -54,6 +57,7 @@ module MatrixSdk
       raise ArgumentError, 'Cache value must be one of of [:all, :some, :none]' unless %i[all some none].include? @cache
 
       return unless params[:user_id]
+
       @mxid = params[:user_id]
     end
 
@@ -67,7 +71,15 @@ module MatrixSdk
       end
     end
 
+    def mxid=(id)
+      id = MXID.new id.to_s unless id.is_a? MXID
+      raise ArgumentError, 'Must be a User ID' unless id.user?
+
+      @mxid = id
+    end
+
     alias user_id mxid
+    alias user_id= mxid=
 
     def rooms
       @rooms.values
@@ -79,15 +91,48 @@ module MatrixSdk
     end
 
     def register_with_password(username, password)
+      username = username.to_s unless username.is_a?(String)
+      password = password.to_s unless password.is_a?(String)
+
+      raise ArgumentError, "Username can't be nil or empty" if username.nil? || username.empty?
+      raise ArgumentError, "Password can't be nil or empty" if password.nil? || username.empty?
+
       data = api.register(auth: { type: 'm.login.dummy' }, username: username, password: password)
       post_authentication(data)
     end
 
-    def login(username, password, params = {})
+    def login(username, password, sync_timeout: 15, full_state: false, **params)
+      username = username.to_s unless username.is_a?(String)
+      password = password.to_s unless password.is_a?(String)
+
+      raise ArgumentError, "Username can't be nil or empty" if username.nil? || username.empty?
+      raise ArgumentError, "Password can't be nil or empty" if password.nil? || password.empty?
+
       data = api.login(user: username, password: password)
       post_authentication(data)
 
-      sync(timeout: params.fetch(:sync_timeout, 15), full_state: params.fetch(:full_state, false)) unless params[:no_sync]
+      return if params[:no_sync]
+
+      sync timeout: sync_timeout,
+           full_state: full_state,
+           allow_sync_retry: params.fetch(:allow_sync_retry, nil)
+    end
+
+    def login_with_token(username, token, sync_timeout: 15, full_state: false, **params)
+      username = username.to_s unless username.is_a?(String)
+      token = token.to_s unless token.is_a?(String)
+
+      raise ArgumentError, "Username can't be nil or empty" if username.nil? || username.empty?
+      raise ArgumentError, "Token can't be nil or empty" if token.nil? || token.empty?
+
+      data = api.login(user: username, token: token, type: 'm.login.token')
+      post_authentication(data)
+
+      return if params[:no_sync]
+
+      sync timeout: sync_timeout,
+           full_state: full_state,
+           allow_sync_retry: params.fetch(:allow_sync_retry, nil)
     end
 
     def logout
@@ -128,10 +173,11 @@ module MatrixSdk
     def upload(content, content_type)
       data = api.media_upload(content, content_type)
       return data[:content_uri] if data.key? :content_uri
+
       raise MatrixUnexpectedResponseError, 'Upload succeeded, but no media URI returned'
     end
 
-    def listen_for_events(timeout = 30, arguments = {})
+    def listen_for_events(timeout: 30, **arguments)
       sync(arguments.merge(timeout: timeout))
     end
 
@@ -144,6 +190,7 @@ module MatrixSdk
 
     def stop_listener_thread
       return unless @sync_thread
+
       @should_listen = false
       @sync_thread.join if @sync_thread.alive?
       @sync_thread = nil
@@ -151,17 +198,14 @@ module MatrixSdk
 
     private
 
-    def listen_forever(params = {})
-      timeout = params.fetch(:timeout, 30)
-      params[:bad_sync_timeout] = params.fetch(:bad_sync_timeout, 5)
-      params[:sync_interval] = params.fetch(:sync_interval, 30)
-
-      bad_sync_timeout = params[:bad_sync_timeout]
+    def listen_forever(timeout: 30, bad_sync_timeout: 5, sync_interval: 30, **params)
+      orig_bad_sync_timeout = bad_sync_timeout.dup
       while @should_listen
         begin
-          sync(timeout: timeout)
-          bad_sync_timeout = params[:bad_sync_timeout]
-          sleep(params[:sync_interval]) if params[:sync_interval] > 0
+          sync(params.merge(timeout: timeout))
+
+          bad_sync_timeout = orig_bad_sync_timeout
+          sleep(sync_interval) if sync_interval > 0
         rescue MatrixRequestError => ex
           logger.warn("A #{ex.class} occurred during sync")
           if ex.httpstatus >= 500
@@ -215,14 +259,27 @@ module MatrixSdk
       end
     end
 
-    def sync(params = {})
+    def sync(skip_store_batch: false, **params)
       extra_params = {
         filter: sync_filter.to_json
       }
       extra_params[:since] = @next_batch unless @next_batch.nil?
-      data = api.sync params.merge(extra_params)
-      @next_batch = data[:next_batch]
 
+      attempts = 0
+      data = loop do
+        begin
+          break api.sync extra_params.merge(params)
+        rescue MatrixTimeoutError => ex
+          raise ex if (attempts += 1) > params.fetch(:allow_sync_retry, 0)
+        end
+      end
+
+      @next_batch = data[:next_batch] unless skip_store_batch
+
+      handle_sync_response(data)
+    end
+
+    def handle_sync_response(data)
       data[:presence][:events].each do |presence_update|
         fire_presence_event(MatrixEvent.new(self, presence_update))
       end

data/lib/matrix_sdk/errors.rb

@@ -23,6 +23,14 @@ module MatrixSdk
 
   # An error raised when errors occur in the connection layer
   class MatrixConnectionError < MatrixError
+    def self.class_by_code(code)
+      return MatrixTimeoutError if code == 504
+
+      MatrixConnectionError
+    end
+  end
+
+  class MatrixTimeoutError < MatrixConnectionError
   end
 
   # An error raised when the homeserver returns an unexpected response to the client

data/lib/matrix_sdk/extensions.rb

@@ -56,7 +56,7 @@ def ignore_inspect(*symbols)
         .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
         .map { |f| "\#{f}=\#{instance_variable_get(f).inspect}" }.join " " }}>"
     end
-  *, __FILE__, __LINE__ - 4
+  *, __FILE__, __LINE__ - 6
 end
 
 module MatrixSdk
@@ -146,6 +146,7 @@ module MatrixSdk
 
     def method_missing(method, *args)
       return event[method] if event.key? method
+
       super
     end
 

data/lib/matrix_sdk/mxid.rb

@@ -0,0 +1,82 @@
+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 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(':')
+
+      raise ArgumentError, 'Identifier is not a valid MXID' unless valid?
+    end
+
+    def to_s
+      "#{sigil}#{localpart}#{domain ? ':' + domain : ''}"
+    end
+
+    # Returns the type of the ID
+    #
+    # @return [Symbol] The MXID type, one of (:user_id, :room_id, :event_id, :group_id, or :room_alias)
+    def type
+      case sigil
+      when '@'
+        :user_id
+      when '!'
+        :room_id
+      when '$'
+        :event_id
+      when '+'
+        :group_id
+      when '#'
+        :room_alias
+      end
+    end
+
+    # Checks if the ID is valid
+    #
+    # @return [Boolean] If the ID is a valid Matrix ID
+    def valid?
+      !type.nil?
+    end
+
+    # Check if the ID is of a user
+    # @return [Boolean] if the ID is of the user_id type
+    def user?
+      type == :user_id
+    end
+
+    # Check if the ID is of a group
+    # @return [Boolean] if the ID is of the group_id type
+    def group?
+      type == :group_id
+    end
+
+    # Check if the ID is of a room
+    # @return [Boolean] if the ID is of the room_id or room_alias types
+    def room?
+      type == :room_id || type == :room_alias
+    end
+
+    # Check if the ID is of a event
+    # @return [Boolean] if the ID is of the event_id type
+    def event?
+      type == :event_id
+    end
+
+    # Check if the ID is a room_id
+    # @return [Boolean] if the ID is of the room_id type
+    def room_id?
+      type == :room_id
+    end
+
+    # Check if the ID is a room_alias
+    # @return [Boolean] if the ID is of the room_alias type
+    def room_alias?
+      type == :room_alias
+    end
+  end
+end

data/lib/matrix_sdk/response.rb

@@ -34,6 +34,7 @@ module MatrixSdk
 
       def method_missing(name, *args)
         return fetch(name) if key?(name) && args.empty?
+
         super
       end
     end

data/lib/matrix_sdk/room.rb

@@ -115,6 +115,7 @@ module MatrixSdk
 
       client.api.get_room_members(id)[:chunk].each do |chunk|
         next unless chunk [:content][:membership] == 'join'
+
         ensure_member(User.new(client, chunk[:state_key], display_name: chunk[:content].fetch(:displayname)))
       end
       members
@@ -149,7 +150,7 @@ module MatrixSdk
     #      Possible message types as defined by the spec
     def send_html(html, body = nil, msg_type = 'm.text')
       content = {
-        body: body ? body : html.gsub(/<\/?[^>]*>/, ''),
+        body: body || html.gsub(/<\/?[^>]*>/, ''),
         msgtype: msg_type,
         format: 'org.matrix.custom.html',
         formatted_body: html
@@ -338,6 +339,7 @@ module MatrixSdk
     # @note the avatar URL should be a mxc:// URI
     def set_user_profile(params = {})
       return nil unless params[:display_name] || params[:avatar_url]
+
       data = client.api.get_membership(id, client.mxid)
       raise "Can't set profile if you haven't joined the room" unless data[:membership] == 'join'
 
@@ -348,7 +350,21 @@ module MatrixSdk
     end
 
     def tags
-      client.api.get_user_tags(client.mxid, id)
+      client.api.get_user_tags(client.mxid, id)[:tags].tap do |tag_obj|
+        tag_obj.instance_variable_set(:@room, self)
+        tag_obj.define_singleton_method(:room) do
+          @room
+        end
+        tag_obj.define_singleton_method(:add) do |tag, params = {}|
+          @room.add_tag(tag.to_s.to_sym, params)
+          self[tag.to_s.to_sym] = params
+          self
+        end
+        tag_obj.define_singleton_method(:remove) do |tag|
+          @room.remove_tag(tag.to_s.to_sym)
+          delete tag.to_s.to_sym
+        end
+      end
     end
 
     def remove_tag(tag)
@@ -458,6 +474,7 @@ module MatrixSdk
     # @return [Boolean] if the change was successful
     def modify_user_power_levels(users = nil, users_default = nil)
       return false if users.nil? && users_default.nil?
+
       data = client.api.get_power_levels(id)
       data[:users_default] = users_default unless users_default.nil?
 
@@ -479,6 +496,7 @@ module MatrixSdk
     # @return [Boolean] if the change was successful
     def modify_required_power_levels(events = nil, params = {})
       return false if events.nil? && (params.nil? || params.empty?)
+
       data = client.api.get_power_levels(id)
       data.merge!(params)
       data.delete_if { |_k, v| v.nil? }

data/lib/matrix_sdk/version.rb

@@ -1,3 +1,3 @@
 module MatrixSdk
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/lib/matrix_sdk.rb

@@ -6,6 +6,7 @@ autoload :Logging, 'logging'
 module MatrixSdk
   autoload :Api, 'matrix_sdk/api'
   autoload :Client, 'matrix_sdk/client'
+  autoload :MXID, 'matrix_sdk/mxid'
   autoload :Response, 'matrix_sdk/response'
   autoload :Room, 'matrix_sdk/room'
   autoload :User, 'matrix_sdk/user'

data/matrix-sdk.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'logging', '~> 2'
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+
+  # TODO: Put this in a better location
+  spec.add_development_dependency 'ci_reporter_test_unit'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -25,47 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_test_unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: ''
 email:
 - ace@haxalot.com
@@ -88,6 +102,7 @@ files:
 - lib/matrix_sdk/client.rb
 - lib/matrix_sdk/errors.rb
 - lib/matrix_sdk/extensions.rb
+- lib/matrix_sdk/mxid.rb
 - lib/matrix_sdk/response.rb
 - lib/matrix_sdk/room.rb
 - lib/matrix_sdk/user.rb
@@ -113,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: ''