matrix_sdk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d0b5d000dfb07e1f488a66587a403c087c7056b2cde52cd2ee87e4835972a23
-  data.tar.gz: 1fdd6f7a913b42cf8654eeed0b198d14337f47ab7da71baf43c1b2779d752eb5
+  metadata.gz: fc787a1c2e4bac79cf05357500571df2e7734464023a5182d08614b9e45e9aac
+  data.tar.gz: 465ea39af281892dcb299014b8a5b4bc0c869f6914974f40cb6fd21301090129
 SHA512:
-  metadata.gz: 466f80ee4d8b06c1827de39e7526a23e62e654db99c2102db5552492992a58fd6f6a4883d1c90d2a577c345d67312de51d5cbdb0a2bfbcab461278141dffcbc4
-  data.tar.gz: 189b5b6243fb574b60ac02036850bfe33f20499b4a88ea9840491892f840fd367167be5233da73e08811d6d8721523bce9027e4907ea6c927a9c70a8c1ed20cc
+  metadata.gz: a18893ee520aedfacc011cf5888b310875ee6929fa94967a0eeee01e91d592a56b19b190e6400e5e9338ccf477f9ac4cb1c480866fb720c1eecee7f0fb005a6f
+  data.tar.gz: ed1d6b9eaad9795147ffb8bf319c4fed25598147a2af2f97048eb0285684c32fc7809e36ad891917f3499105778eb11409d8577941258c9fb94cee84b4c41dbd

data/.gitlab-ci.yml

@@ -0,0 +1,33 @@
+---
+image: "ruby:2.4"
+
+# Cache gems in between builds
+cache:
+  paths:
+    - vendor/ruby
+
+before_script:
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install -j $(nproc) --path vendor
+
+rubocop:
+  before_script: []
+  script:
+    - gem install rubocop --no-ri --no-rdoc
+    - rubocop
+
+# rspec:
+#   script:
+#   - rspec spec
+
+pages:
+  stage: deploy
+  before_script: []
+  script:
+    - gem install yard
+    - yard doc -o public/
+  artifacts:
+    paths:
+      - public/
+  only:
+    - master

data/.rubocop.yml

@@ -8,6 +8,9 @@ AllCops:
 Style/Documentation:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/MethodLength:
   Max: 40
 

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+## v0.0.3 - 2018-08-14
+
+- Adds missing accessors for HTTP timeout
+- Adds methods for checking auth status to client API
+- Adds a wrapper class for API responses to ease use
+- Adds option (and defaults) to store login details on registration
+- Allows creating a MatrixSdk::Client off of an existing MatrixSdk::Api
+- Extends event handling
+
+- Fixes batch handling in sync
+- Fixes event handling in the sample
+- Removes unimplemented API methods to avoid confusion
+
+- Plenty of documentation work
+
+## v0.0.2 - 2018-05-11
+
+- Fixes for multiple issues discovered after initial release
+- Adds additional API methods
+- Higher-level client API gets room and user abstractions
+
+## v0.0.1 - 2018-05-06
+
+Initial release

data/README.md

@@ -2,6 +2,7 @@
 
 A Ruby gem for easing the development of software that communicates with servers implementing the Matrix protocol.
 
+Live YARD documentation can be found at; http://aleol57.gitlab-pages.liu.se/ruby-matrix-sdk
 
 ## Example usage
 

data/examples/simple_client.rb

@@ -11,7 +11,7 @@ class SimpleClient < MatrixSdk::Client
   end
 
   def add_listener(room)
-    room.on_event { |ev| on_message(room, ev) }
+    room.on_event.add_handler { |ev| on_message(room, ev) }
   end
 
   def run
@@ -26,20 +26,22 @@ class SimpleClient < MatrixSdk::Client
   end
 
   def on_message(room, event)
-    puts "Event: #{ev}"
-    case ev[:type]
+    case event.type
     when 'm.room.member'
-      puts "#{Time.now.strftime '%H:%M'} #{event[:content][:displayname]} joined." if event['membership'] == 'join'
+      puts "[#{Time.now.strftime '%H:%M'}] #{event[:content][:displayname]} joined." if event.membership == 'join'
     when 'm.room.message'
-      user = get_user event[:sender]
-      admin_level = get_user_level(room, user.id)
-      prefix = (admin_level >= 100 ? '@' : (admin_level >= 50 ? '+' : ' '))
-      if %w[m.text m.notice].include? event[:content][:msgtype]
-        puts "#{Time.now.strftime '%H:%M'} <#{prefix}#{user.display_name}> #{event[:content][:body]}"
+      user = get_user event.sender
+      admin_level = get_user_level(room, user.id) || 0
+      prefix = ' '
+      prefix = '+' if admin_level >= 50
+      prefix = '@' if admin_level >= 100
+      if %w[m.text m.notice].include? event.content[:msgtype]
+        notice = event.content[:msgtype] == 'm.notice'
+        puts "[#{Time.now.strftime '%H:%M'}] <#{prefix}#{user.display_name}> #{"\033[1;30m" if notice}#{event.content[:body]}#{"\033[0m" if notice}"
       elsif event[:content][:msgtype] == 'm.emote'
-        puts "#{Time.now.strftime '%H:%M'} *#{prefix}#{user.display_name} #{event[:content][:body]}"
+        puts "[#{Time.now.strftime '%H:%M'}] *#{prefix}#{user.display_name} #{event.content[:body]}"
       else
-        puts "#{Time.now.strftime '%H:%M'} <#{prefix}#{user.display_name}> [#{event[:content][:msgtype]}] #{event[:content][:body]} - #{api.get_download_url event[:content][:url]}"
+        puts "[#{Time.now.strftime '%H:%M'}] <#{prefix}#{user.display_name}> (#{event.content[:msgtype]}) #{event.content[:body]} - #{api.get_download_url event.content[:url]}"
       end
     end
   end
@@ -54,6 +56,7 @@ if $PROGRAM_NAME == __FILE__
     end
 
     client = SimpleClient.new ARGV.first
+    ARGV.shift
 
     print 'Username: '
     user = STDIN.gets.strip
@@ -87,7 +90,9 @@ if $PROGRAM_NAME == __FILE__
         room.send_text msg
       end
     end
+  rescue Interrupt
+    puts 'Interrupted, exiting...'
   ensure
-    client.logout if client
+    client.logout if client && client.logged_in?
   end
 end

data/lib/matrix_sdk/api.rb

@@ -7,14 +7,31 @@ require 'uri'
 
 module MatrixSdk
   class Api
-    attr_accessor :access_token, :device_id
-    attr_reader :homeserver, :validate_certificate
-
-    ignore_inspect :access_token
-
+    USER_AGENT = "Ruby Matrix SDK v#{MatrixSdk::VERSION}".freeze
+    DEFAULT_HEADERS = {
+      'accept'     => 'application/json',
+      'user-agent' => USER_AGENT
+    }.freeze
+
+    attr_accessor :access_token, :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] :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
+    # @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] :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
     def initialize(homeserver, params = {})
       @homeserver = homeserver
-      @homeserver = URI.parse(@homeserver.to_s) unless @homeserver.is_a? URI
+      @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/'
@@ -26,24 +43,41 @@ module MatrixSdk
 
       @access_token = params.fetch(:access_token, nil)
       @device_id = params.fetch(:device_id, nil)
+      @autoretry = params.fetch(:autoretry, true)
       @validate_certificate = params.fetch(:validate_certificate, false)
       @transaction_id = params.fetch(:transaction_id, 0)
       @backoff_time = params.fetch(:backoff_time, 5000)
+      @read_timeout = params.fetch(:read_timeout, 240)
+      @global_headers = DEFAULT_HEADERS.dup
+      @global_headers.merge!(params.fetch(:global_headers)) if params.key? :global_headers
 
       login(user: @homeserver.user, password: @homeserver.password) if @homeserver.user && @homeserver.password && !@access_token && !params[:skip_login]
       @homeserver.userinfo = '' unless params[:skip_login]
     end
 
+    # Gets the logger for the API
+    # @return [Logging::Logger] The API-scope logger
     def logger
-      @logger ||= Logging.logger[self.class.name]
+      @logger ||= Logging.logger[self]
+    end
+
+    # @param seconds [Numeric]
+    # @return [Numeric]
+    def read_timeout=(seconds)
+      @http.finish if @http && @read_timeout != seconds
+      @read_timeout = seconds
     end
 
+    # @param validate [Boolean]
+    # @return [Boolean]
     def validate_certificate=(validate)
       # The HTTP connection needs to be reopened if this changes
       @http.finish if @http && validate != @validate_certificate
       @validate_certificate = validate
     end
 
+    # @param hs_info [URI]
+    # @return [URI]
     def homeserver=(hs_info)
       # TODO: DNS query for SRV information about HS?
       return unless hs_info.is_a? URI
@@ -51,10 +85,34 @@ module MatrixSdk
       @homeserver = hs_info
     end
 
-    def api_versions
-      request(:get, :client, '/versions')
+    # Gets the available client API versions
+    # @return [Array]
+    def client_api_versions
+      @client_api_versions ||= request(:get, :client, '/versions').versions
+    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
+          def to_s
+            "#{name} #{version}"
+          end
+        CODE
+      end
     end
 
+    # Runs the client API /sync method
+    # @param params [Hash] The sync options to use
+    # @option params [Numeric] :timeout (30.0) The timeout in seconds for the sync
+    # @option params :since The value of the batch token to base the sync from
+    # @option params [String,Hash] :filter The filter to use on the sync
+    # @option params [Boolean] :full_state Should the sync include the full state
+    # @option params [Boolean] :set_presence Should the sync set the user status to online
+    # @return [Response]
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#get-matrix-client-r0-sync
+    #      For more information on the parameters and what they mean
     def sync(params = {})
       query = {
         timeout: 30.0
@@ -68,29 +126,76 @@ module MatrixSdk
       request(:get, :client_r0, '/sync', query: query)
     end
 
+    # Registers a user using the client API /register endpoint
+    #
+    # @example Regular user registration and login
+    #   api.register(username: 'example', password: 'NotARealPass')
+    #   # => { user_id: '@example:matrix.org', access_token: '...', home_server: 'matrix.org', device_id: 'ABCD123' }
+    #   api.whoami?
+    #   # => { user_id: '@example:matrix.org' }
+    #
+    # @param params [Hash] The registration information, all not handled by Ruby will be passed as JSON in the body
+    # @option params [String,Symbol] :kind ('user') The kind of registration to use
+    # @option params [Boolean] :store_token (true) Should the resulting access token be stored for the API
+    # @option params [Boolean] :store_device_id (store_token value) Should the resulting device ID be stored for the API
+    # @return [Response]
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#post-matrix-client-r0-register
+    #      For options that are permitted in this call
     def register(params = {})
       kind = params.delete(:kind) { 'user' }
+      store_token = params.delete(:store_token) { true }
+      store_device_id = params.delete(:store_device_id) { store_token }
 
-      request(:post, :client_r0, '/register', body: params, query: { kind: kind })
+      request(:post, :client_r0, '/register', body: params, query: { kind: kind }).tap do |resp|
+        @access_token = resp.token if resp.key?(:token) && store_token
+        @device_id = resp.device_id if resp.key?(:device_id) && store_device_id
+      end
     end
 
+    # Logs in using the client API /login endpoint, and optionally stores the resulting access for API usage
+    #
+    # @example Logging in with username and password
+    #   api.login(user: 'example', password: 'NotARealPass')
+    #   # => { user_id: '@example:matrix.org', access_token: '...', home_server: 'matrix.org', device_id: 'ABCD123' }
+    #   api.whoami?
+    #   # => { user_id: '@example:matrix.org' }
+    #
+    # @example Advanced login, without storing details
+    #   api.whoami?
+    #   # => { user_id: '@example:matrix.org' }
+    #   api.login(medium: 'email', address: 'someone@somewhere.net', password: '...', store_token: false)
+    #   # => { user_id: '@someone:matrix.org', access_token: ...
+    #   api.whoami?.user_id
+    #   # => '@example:matrix.org'
+    #
+    # @param params [Hash] The login information to use, along with options for said log in
+    # @option params [Boolean] :store_token (true) Should the resulting access token be stored for the API
+    # @option params [Boolean] :store_device_id (store_token value) Should the resulting device ID be stored for the API
+    # @option params [String] :login_type ('m.login.password') The type of login to attempt
+    # @option params [String] :initial_device_display_name (USER_AGENT) The device display name to specify for this login attempt
+    # @option params [String] :device_id The device ID to set on the login
+    # @return [Response] A response hash with the parameters :user_id, :access_token, :home_server, and :device_id.
+    # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#post-matrix-client-r0-login
+    #      The Matrix Spec, for more information about the call and response
     def login(params = {})
       options = {}
       options[:store_token] = params.delete(:store_token) { true }
-      options[:store_device_id] = params.delete(:store_device_id) { true }
+      options[:store_device_id] = params.delete(:store_device_id) { options[:store_token] }
 
       data = {
         type: params.delete(:login_type) { 'm.login.password' },
-        initial_device_display_name: params.delete(:initial_device_display_name) { user_agent }
+        initial_device_display_name: params.delete(:initial_device_display_name) { USER_AGENT }
       }.merge params
       data[:device_id] = device_id if device_id
 
       request(:post, :client_r0, '/login', body: data).tap do |resp|
-        @access_token = resp[:token] if resp[:token] && options[:store_token]
-        @device_id = resp[:device_id] if resp[:device_id] && options[:store_device_id]
+        @access_token = resp.token if resp.key?(:token) && options[:store_token]
+        @device_id = resp.device_id if resp.key?(:device_id) && options[:store_device_id]
       end
     end
 
+    # Logs out the currently logged in user
+    # @return [Response]
     def logout
       request(:post, :client_r0, '/logout')
     end
@@ -106,14 +211,20 @@ module MatrixSdk
     end
 
     def join_room(id_or_alias)
-      request(:post, :client_r0, "/join/#{CGI.escape id_or_alias}")
+      id_or_alias = CGI.escape id_or_alias.to_s
+
+      request(:post, :client_r0, "/join/#{id_or_alias}")
     end
 
     def send_state_event(room_id, event_type, content, params = {})
       query = {}
       query[:ts] = params[:timestamp].to_i if params.key? :timestamp
 
-      request(:put, :client_r0, "/rooms/#{room_id}/state/#{event_type}#{"/#{params[:state_key]}" if params.key? :state_key}", body: content, query: query)
+      room_id = CGI.escape room_id.to_s
+      event_type = CGI.escape event_type.to_s
+      state_key = CGI.escape params[:state_key].to_s if params.key? :state_key
+
+      request(:put, :client_r0, "/rooms/#{room_id}/state/#{event_type}#{"/#{state_key}" unless state_key.nil?}", body: content, query: query)
     end
 
     def send_message_event(room_id, event_type, content, params = {})
@@ -123,6 +234,10 @@ module MatrixSdk
       txn_id = transaction_id
       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
+      txn_id = CGI.escape txn_id.to_s
+
       request(:put, :client_r0, "/rooms/#{room_id}/send/#{event_type}/#{txn_id}", body: content, query: query)
     end
 
@@ -136,6 +251,10 @@ module MatrixSdk
       txn_id = transaction_id
       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
+      txn_id = CGI.escape txn_id.to_s
+
       request(:put, :client_r0, "/rooms/#{room_id}/redact/#{event_type}/#{txn_id}", body: content, query: query)
     end
 
@@ -195,11 +314,20 @@ module MatrixSdk
       }
       query[:to] = params[:to] if params.key? :to
 
+      room_id = CGI.escape room_id.to_s
+
       request(:get, :client_r0, "/rooms/#{room_id}/messages", query: query)
     end
 
+    def get_room_state(room_id, state_type)
+      room_id = CGI.escape room_id.to_s
+      state_type = CGI.escape state_type.to_s
+
+      request(:get, :client_r0, "/rooms/#{room_id}/state/#{state_type}")
+    end
+
     def get_room_name(room_id)
-      request(:get, :client_r0, "/rooms/#{room_id}/state/m.room.name")
+      get_room_state(room_id, 'm.room.name')
     end
 
     def set_room_name(room_id, name, params = {})
@@ -210,7 +338,7 @@ module MatrixSdk
     end
 
     def get_room_topic(room_id)
-      request(:get, :client_r0, "/rooms/#{room_id}/state/m.room.topic")
+      get_room_state(room_id, 'm.room.topic')
     end
 
     def set_room_topic(room_id, topic, params = {})
@@ -221,7 +349,7 @@ module MatrixSdk
     end
 
     def get_power_levels(room_id)
-      request(:get, :client_r0, "/rooms/#{room_id}/state/m.room.power_levels")
+      get_room_state(room_id, 'm.room.power_levels')
     end
 
     def set_power_levels(room_id, content)
@@ -230,10 +358,14 @@ module MatrixSdk
     end
 
     def leave_room(room_id)
+      room_id = CGI.escape room_id.to_s
+
       request(:post, :client_r0, "/rooms/#{room_id}/leave")
     end
 
     def forget_room(room_id)
+      room_id = CGI.escape room_id.to_s
+
       request(:post, :client_r0, "/rooms/#{room_id}/forget")
     end
 
@@ -241,6 +373,9 @@ module MatrixSdk
       content = {
         user_id: user_id
       }
+
+      room_id = CGI.escape room_id.to_s
+
       request(:post, :client_r0, "/rooms/#{room_id}/invite", body: content)
     end
 
@@ -249,6 +384,9 @@ module MatrixSdk
     end
 
     def get_membership(room_id, user_id)
+      room_id = CGI.escape room_id.to_s
+      user_id = CGI.escape user_id.to_s
+
       request(:get, :client_r0, "/rooms/#{room_id}/state/m.room.member/#{user_id}")
     end
 
@@ -268,6 +406,9 @@ module MatrixSdk
         user_id: user_id,
         reason: params[:reason] || ''
       }
+
+      room_id = CGI.escape room_id.to_s
+
       request(:post, :client_r0, "/rooms/#{room_id}/ban", body: content)
     end
 
@@ -275,14 +416,24 @@ module MatrixSdk
       content = {
         user_id: user_id
       }
+
+      room_id = CGI.escape room_id.to_s
+
       request(:post, :client_r0, "/rooms/#{room_id}/unban", body: content)
     end
 
     def get_user_tags(user_id, room_id)
+      room_id = CGI.escape room_id.to_s
+      user_id = CGI.escape user_id.to_s
+
       request(:get, :client_r0, "/user/#{user_id}/rooms/#{room_id}/tags")
     end
 
     def remove_user_tag(user_id, room_id, tag)
+      room_id = CGI.escape room_id.to_s
+      user_id = CGI.escape user_id.to_s
+      tag = CGI.escape tag.to_s
+
       request(:delete, :client_r0, "/user/#{user_id}/rooms/#{room_id}/tags/#{tag}")
     end
 
@@ -293,34 +444,47 @@ module MatrixSdk
         content = {}
         content[:order] = params[:order] if params.key? :order
       end
+
+      room_id = CGI.escape room_id.to_s
+      user_id = CGI.escape user_id.to_s
+      tag = CGI.escape tag.to_s
+
       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)
+    #   request(:get, :client_r0, "/user/#{user_id}/account_data/#{type}")
+    # end
 
-    def set_account_data(user_id, type, account_data)
-      request(:put, :client_r0, "/user/#{user_id}/account_data/#{type}", body: account_data)
-    end
+    def set_account_data(user_id, type_key, account_data)
+      user_id = CGI.escape user_id.to_s
+      type_key = CGI.escape type_key.to_s
 
-    def get_room_account_data(user_id, room_id, type)
-      request(:get, :client_r0, "/user/#{user_id}/rooms/#{room_id}/account_data/#{type}")
+      request(:put, :client_r0, "/user/#{user_id}/account_data/#{type_key}", body: account_data)
     end
 
-    def set_room_account_data(user_id, room_id, type, account_data)
-      request(:put, :client_r0, "/user/#{user_id}/rooms/#{room_id}/account_data/#{type}", 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 set_room_account_data(user_id, room_id, type_key, account_data)
+      user_id = CGI.escape user_id.to_s
+      room_id = CGI.escape room_id.to_s
+      type_key = CGI.escape type_key.to_s
 
-    def get_room_state(room_id)
-      request(:get, :client_r0, "/rooms/#{room_id}/state")
+      request(:put, :client_r0, "/user/#{user_id}/rooms/#{room_id}/account_data/#{type_key}", body: account_data)
     end
 
     def get_filter(user_id, filter_id)
+      user_id = CGI.escape user_id.to_s
+      filter_id = CGI.escape filter_id.to_s
+
       request(:get, :client_r0, "/user/#{user_id}/filter/#{filter_id}")
     end
 
     def create_filter(user_id, filter_params)
+      user_id = CGI.escape user_id.to_s
+
       request(:post, :client_r0, "/user/#{user_id}/filter", body: filter_params)
     end
 
@@ -329,17 +493,24 @@ module MatrixSdk
     end
 
     def get_display_name(user_id)
+      user_id = CGI.escape user_id.to_s
+
       request(:get, :client_r0, "/profile/#{user_id}/displayname")
     end
 
     def set_display_name(user_id, display_name)
       content = {
-        display_name: display_name
+        displayname: display_name
       }
+
+      user_id = CGI.escape user_id.to_s
+
       request(:put, :client_r0, "/profile/#{user_id}/displayname", body: content)
     end
 
     def get_avatar_url(user_id)
+      user_id = CGI.escape user_id.to_s
+
       request(:get, :client_r0, "/profile/#{user_id}/avatar_url")
     end
 
@@ -347,6 +518,9 @@ module MatrixSdk
       content = {
         avatar_url: url
       }
+
+      user_id = CGI.escape user_id.to_s
+
       request(:put, :client_r0, "/profile/#{user_id}/avatar_url", body: content)
     end
 
@@ -355,11 +529,14 @@ module MatrixSdk
       raise 'Not a mxc:// URL' unless mxcurl.is_a? URI::MATRIX
 
       homeserver.dup.tap do |u|
-        u.path = "/_matrix/media/r0/download/#{mxcurl.full_path}"
+        full_path = CGI.escape mxcurl.full_path.to_s
+        u.path = "/_matrix/media/r0/download/#{full_path}"
       end
     end
 
     def get_room_id(room_alias)
+      room_alias = CGI.escape room_alias.to_s
+
       request(:get, :client_r0, "/directory/room/#{room_alias}")
     end
 
@@ -367,14 +544,21 @@ module MatrixSdk
       content = {
         room_id: room_id
       }
+
+      room_alias = CGI.escape room_alias.to_s
+
       request(:put, :client_r0, "/directory/room/#{room_alias}", body: content)
     end
 
     def remove_room_alias(room_alias)
+      room_alias = CGI.escape room_alias.to_s
+
       request(:delete, :client_r0, "/directory/room/#{room_alias}")
     end
 
     def get_room_members(room_id)
+      room_id = CGI.escape room_id.to_s
+
       request(:get, :client_r0, "/rooms/#{room_id}/members")
     end
 
@@ -382,6 +566,7 @@ module MatrixSdk
       content = {
         join_rule: join_rule
       }
+
       send_state_event(room_id, 'm.room.join_rules', content)
     end
 
@@ -400,7 +585,7 @@ module MatrixSdk
     def request(method, api, path, options = {})
       url = homeserver.dup.tap do |u|
         u.path = api_to_path(api) + path
-        u.query = [u.query, options[:query].map { |k, v| "#{k}#{"=#{v}" unless v.nil?}" }].flatten.reject(&:nil?).join('&') if options[:query]
+        u.query = [u.query, URI.encode_www_form(options.fetch(:query))].flatten.compact.join('&') if options[:query]
         u.query = nil if u.query.nil? || u.query.empty?
       end
       request = Net::HTTP.const_get(method.to_s.capitalize.to_sym).new url.request_uri
@@ -408,10 +593,13 @@ module MatrixSdk
       request.body = request.body.to_json if options.key?(:body) && !request.body.is_a?(String)
       request.body_stream = options[:body_stream] if options.key? :body_stream
 
-      request.content_type = 'application/json' if request.body || request.body_stream
+      global_headers.each { |h, v| request[h] = v }
+      if request.body || request.body_stream
+        request.content_type = 'application/json'
+        request.content_length = (request.body || request.body_stream).size
+      end
 
       request['authorization'] = "Bearer #{access_token}" if access_token
-      request['user-agent'] = user_agent
       if options.key? :headers
         options[:headers].each do |h, v|
           request[h.to_s.downcase] = v
@@ -428,13 +616,14 @@ module MatrixSdk
         data = JSON.parse(response.body, symbolize_names: true) rescue nil
 
         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)
           next
         end
 
-        return data if response.is_a? Net::HTTPSuccess
+        return MatrixSdk::Response.new self, data if response.is_a? Net::HTTPSuccess
         raise MatrixRequestError.new(data, response.code) if data
         raise MatrixConnectionError, response
       end
@@ -443,6 +632,8 @@ module MatrixSdk
     private
 
     def print_http(http)
+      return unless logger.debug?
+
       if http.is_a? Net::HTTPRequest
         dir = '>'
         logger.debug "#{dir} Sending a #{http.method} request to `#{http.path}`:"
@@ -450,11 +641,12 @@ module MatrixSdk
         dir = '<'
         logger.debug "#{dir} Received a #{http.code} #{http.message} response:"
       end
-      http.to_hash.map { |k, v| "#{k}: #{k == 'authorization' ? '[redacted]' : v.join(', ')}" }.each do |h|
+      http.to_hash.map { |k, v| "#{k}: #{k == 'authorization' ? '[ REDACTED ]' : v.join(', ')}" }.each do |h|
         logger.debug "#{dir} #{h}"
       end
       logger.debug dir
-      logger.debug "#{dir} #{http.body.length < 200 ? http.body : http.body.slice(0..200) + '... [truncated]'}" if http.body
+      clean_body = JSON.parse(http.body).each { |k, v| v.replace('[ REDACTED ]') if %w[password access_token].include? k }.to_json if http.body
+      logger.debug "#{dir} #{clean_body.length < 200 ? clean_body : clean_body.slice(0..200) + "... [truncated, #{clean_body.length} Bytes]"}" if clean_body
     end
 
     def transaction_id
@@ -472,13 +664,10 @@ module MatrixSdk
       @http ||= Net::HTTP.new homeserver.host, homeserver.port
       return @http if @http.active?
 
+      @http.read_timeout = read_timeout
       @http.use_ssl = homeserver.scheme == 'https'
       @http.verify_mode = validate_certificate ? ::OpenSSL::SSL::VERIFY_NONE : nil
       @http.start
     end
-
-    def user_agent
-      "Ruby Matrix SDK v#{MatrixSdk::VERSION}"
-    end
   end
 end

data/lib/matrix_sdk/client.rb

@@ -7,13 +7,13 @@ module MatrixSdk
     extend Forwardable
 
     attr_reader :api
-    attr_accessor :cache, :mxid, :sync_filter
+    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
     alias user_id= mxid=
 
     def_delegators :@api,
@@ -23,19 +23,27 @@ module MatrixSdk
     def initialize(hs_url, params = {})
       event_initialize
 
-      params[:user_id] = params[:mxid] if params[:mxid]
-      raise ArgumentError, 'Must provide user_id with access_token' if params[:access_token] && !params[:user_id]
+      params[:user_id] ||= params[:mxid] if params[:mxid]
 
-      @api = Api.new hs_url, params
+      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
 
       @rooms = {}
-      @cache = :all
+      @users = {}
+      @cache = params.fetch(:client_cache, :all)
 
       @sync_token = nil
       @sync_thread = nil
       @sync_filter = { room: { timeline: { limit: params.fetch(:sync_filter_limit, 20) } } }
 
       @should_listen = false
+      @next_batch = nil
 
       @bad_sync_timeout_limit = 60 * 60
 
@@ -47,13 +55,20 @@ module MatrixSdk
 
       return unless params[:user_id]
       @mxid = params[:user_id]
-      sync
     end
 
     def logger
-      @logger ||= Logging.logger[self.class.name]
+      @logger ||= Logging.logger[self]
+    end
+
+    def mxid
+      @mxid ||= begin
+        api.whoami?[:user_id] if api && api.access_token
+      end
     end
 
+    alias user_id mxid
+
     def rooms
       @rooms.values
     end
@@ -72,7 +87,7 @@ module MatrixSdk
       data = api.login(user: username, password: password)
       post_authentication(data)
 
-      sync(timeout: params.fetch(:sync_timeout, 15)) unless params[:no_sync]
+      sync(timeout: params.fetch(:sync_timeout, 15), full_state: params.fetch(:full_state, false)) unless params[:no_sync]
     end
 
     def logout
@@ -81,6 +96,10 @@ module MatrixSdk
       @mxid = nil
     end
 
+    def logged_in?
+      !(mxid.nil? || @api.access_token.nil?)
+    end
+
     def create_room(room_alias = nil, params = {})
       api.create_room(params.merge(room_alias: room_alias))
     end
@@ -95,7 +114,11 @@ module MatrixSdk
     end
 
     def get_user(user_id)
-      User.new(self, user_id)
+      if cache == :all
+        @users[user_id] ||= User.new(self, user_id)
+      else
+        User.new(self, user_id)
+      end
     end
 
     def remove_room_alias(room_alias)
@@ -108,8 +131,8 @@ module MatrixSdk
       raise MatrixUnexpectedResponseError, 'Upload succeeded, but no media URI returned'
     end
 
-    def listen_for_events(timeout = 30)
-      sync(timeout: timeout)
+    def listen_for_events(timeout = 30, arguments = {})
+      sync(arguments.merge(timeout: timeout))
     end
 
     def start_listener_thread(params = {})
@@ -131,12 +154,14 @@ module MatrixSdk
     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]
       while @should_listen
         begin
           sync(timeout: timeout)
           bad_sync_timeout = params[:bad_sync_timeout]
+          sleep(params[:sync_interval]) if params[:sync_interval] > 0
         rescue MatrixRequestError => ex
           logger.warn("A #{ex.class} occurred during sync")
           if ex.httpstatus >= 500
@@ -191,7 +216,12 @@ module MatrixSdk
     end
 
     def sync(params = {})
-      data = api.sync params.merge(filter: sync_filter.to_json)
+      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]
 
       data[:presence][:events].each do |presence_update|
         fire_presence_event(MatrixEvent.new(self, presence_update))

data/lib/matrix_sdk/extensions.rb

@@ -52,13 +52,23 @@ end
 def ignore_inspect(*symbols)
   class_eval %*
     def inspect
-      "#<\#{self.class.name}:\#{"%016x" % (object_id << 1)} \#{instance_variables.reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }.map { |f| "\#{f}=\#{instance_variable_get(f).inspect}" }.join ' ' }>"
+      "\#{to_s[0..-2]} \#{instance_variables
+        .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
+        .map { |f| "\#{f}=\#{instance_variable_get(f).inspect}" }.join " " }}>"
     end
   *, __FILE__, __LINE__ - 4
 end
 
 module MatrixSdk
   class EventHandlerArray < Hash
+    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 }
@@ -70,9 +80,19 @@ module MatrixSdk
 
     def fire(event, filter = nil)
       reverse_each do |_k, h|
-        h[:block].call(event) unless event.matches?(h[:filter], filter)
+        begin
+          h[:block].call(event) if event.matches?(h[:filter], filter)
+        rescue StandardError => ex
+          logger.error "#{ex.class.name} occurred when firing event (#{event})\n#{ex}"
+
+          raise ex if @reraise_exceptions
+        end
       end
     end
+
+    def logger
+      @logger ||= Logging.logger[self]
+    end
   end
 
   class Event
@@ -115,5 +135,22 @@ module MatrixSdk
         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

data/lib/matrix_sdk/response.rb

@@ -0,0 +1,41 @@
+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
+  #
+  # @example Simple usage of the response wrapper to get the avatar URL
+  #   resp = api.get_avatar_url(api.whoami?.user_id)
+  #   # => { avatar_url: 'mxc://matrix.org/SDGdghriugerRg' }
+  #   resp.is_a? Hash
+  #   # => true
+  #   resp.key? :avatar_url
+  #   # => true
+  #   resp.avatar_url
+  #   # => 'mxc://matrix.org/SDGdghriugerRg'
+  #   resp.api.set_avatar_url(...)
+  #   # => {}
+  #
+  # @since 0.0.3
+  # @see Hash
+  # @!attribute [r] api
+  #   @return [Api] The API connection that returned the response
+  module Response
+    def self.new(api, data)
+      data.extend(Extensions)
+      data.instance_variable_set(:@api, api)
+      data
+    end
+
+    module Extensions
+      attr_reader :api
+
+      def respond_to_missing?(name, *_args)
+        key? name
+      end
+
+      def method_missing(name, *args)
+        return fetch(name) if key?(name) && args.empty?
+        super
+      end
+    end
+  end
+end

data/lib/matrix_sdk/room.rb

@@ -78,7 +78,7 @@ module MatrixSdk
     end
 
     def logger
-      Logging.logger[self.class.name]
+      @logger ||= Logging.logger[self]
     end
 
     #
@@ -261,34 +261,54 @@ module MatrixSdk
     # User Management
     #
 
+    # Invites a user into the room
+    # @param user_id [String,User] the MXID of the user
+    # @return [Boolean] wether the action succeeded
     def invite_user(user_id)
+      user_id = user_id.id if user_id.is_a? MatrixSdk::User
       client.api.invite_user(id, user_id)
       true
     rescue MatrixError
       false
     end
 
+    # Kicks a user from the room
+    # @param user_id [String,User] the MXID of the user
+    # @param reason [String] the reason for the kick
+    # @return [Boolean] wether the action succeeded
     def kick_user(user_id, reason = '')
+      user_id = user_id.id if user_id.is_a? MatrixSdk::User
       client.api.kick_user(id, user_id, reason: reason)
       true
     rescue MatrixError
       false
     end
 
+    # Bans a user from the room
+    # @param user_id [String,User] the MXID of the user
+    # @param reason [String] the reason for the ban
+    # @return [Boolean] wether the action succeeded
     def ban_user(user_id, reason = '')
+      user_id = user_id.id if user_id.is_a? MatrixSdk::User
       client.api.ban_user(id, user_id, reason: reason)
       true
     rescue MatrixError
       false
     end
 
+    # Unbans a user from the room
+    # @param user_id [String,User] the MXID of the user
+    # @return [Boolean] wether the action succeeded
     def unban_user(user_id)
+      user_id = user_id.id if user_id.is_a? MatrixSdk::User
       client.api.unban_user(id, user_id)
       true
     rescue MatrixError
       false
     end
 
+    # Requests to be removed from the room
+    # @return [Boolean] wether the request succeeded
     def leave
       client.api.leave_room(id)
       client.rooms.delete id
@@ -297,14 +317,25 @@ module MatrixSdk
       false
     end
 
+    # Retrieves a custom entry from the room-specific account data
+    # @param type [String] the data type to retrieve
+    # @return [Hash] the data that was stored under the given type
     def get_account_data(type)
       client.api.get_room_account_data(client.mxid, id, type)
     end
 
+    # Stores a custom entry into the room-specific account data
+    # @param type [String] the data type to store
+    # @param account_data [Hash] the data to store
     def set_account_data(type, account_data)
       client.api.set_room_account_data(client.mxid, id, type, account_data)
     end
 
+    # Changes the room-specific user profile
+    # @param params [Hash] the user profile changes to apply
+    # @option params [String] :display_name the new display name to use in the room
+    # @option params [String,URI] :avatar_url the new avatar URL to use in the room
+    # @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)
@@ -339,6 +370,8 @@ module MatrixSdk
       nil
     end
 
+    # Reloads the name of the room
+    # @return [Boolean] if the name was changed or not
     def reload_name!
       data = client.api.get_room_name(id)
       changed = data[:name] != name
@@ -355,6 +388,8 @@ module MatrixSdk
       nil
     end
 
+    # Reloads the topic of the room
+    # @return [Boolean] if the topic was changed or not
     def reload_topic!
       data = client.api.get_room_topic(id)
       changed = data[:topic] != topic
@@ -395,7 +430,7 @@ module MatrixSdk
 
     def invite_only=(invite_only)
       self.join_rule = invite_only ? :invite : :public
-      @join_rule == :invite # rubocop:disable Lint/Void
+      @join_rule == :invite
     end
 
     def join_rule=(join_rule)
@@ -407,7 +442,7 @@ module MatrixSdk
 
     def allow_guests=(allow_guests)
       self.guest_access = (allow_guests ? :can_join : :forbidden)
-      @guest_access == :can_join # rubocop:disable Lint/Void
+      @guest_access == :can_join
     end
 
     def guest_access=(guest_access)
@@ -417,6 +452,10 @@ module MatrixSdk
       nil
     end
 
+    # Modifies the power levels of the room
+    # @param users [Hash] the user-specific power levels to set or remove
+    # @param users_default [Hash] the default user power levels to set
+    # @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)
@@ -434,6 +473,10 @@ module MatrixSdk
       false
     end
 
+    # Modifies the required power levels for actions in the room
+    # @param events [Hash] the event-specific power levels to change
+    # @param params [Hash] other power-level params to change
+    # @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/lib/matrix_sdk/user.rb

@@ -3,9 +3,17 @@ require 'matrix_sdk'
 module MatrixSdk
   # A class for tracking information about a user on Matrix
   class User
+    # @!attribute [r] id
+    #   @return [String] the MXID of the user
+    # @!attribute [r] client
+    #   @return [Client] the client for the user
     attr_reader :id, :client
     alias user_id :id
 
+    # @!method inspect
+    #   An inspect method that skips a handful of instance variables to avoid
+    #   flooding the terminal with debug data.
+    #   @return [String] a regular inspect string without the data for some variables
     ignore_inspect :client
 
     def initialize(client, id, data = {})
@@ -20,10 +28,14 @@ module MatrixSdk
       end
     end
 
+    # @!attribute [r] display_name
+    # @return [String] the display name
     def display_name
       @display_name ||= client.api.get_display_name(id)[:displayname]
     end
 
+    # @!attribute [w] display_name
+    # @param name [String] the display name to set
     def display_name=(name)
       client.api.set_display_name(id, name)
       @display_name = name
@@ -31,14 +43,18 @@ module MatrixSdk
       nil
     end
 
+    # Gets a friendly name of the user
+    # @return [String] either the display name or MXID if unset
     def friendly_name
       display_name || id
     end
 
+    # @!attribute [r] avatar_url
     def avatar_url
       @avatar_url ||= client.api.get_avatar_url(id)[:avatar_url]
     end
 
+    # @!attribute [w] avatar_url
     def avatar_url=(url)
       client.api.set_avatar_url(id, url)
       @avatar_url = url

data/lib/matrix_sdk/version.rb

@@ -1,3 +1,3 @@
 module MatrixSdk
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.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 :Response, 'matrix_sdk/response'
   autoload :Room, 'matrix_sdk/room'
   autoload :User, 'matrix_sdk/user'
 
@@ -19,9 +20,9 @@ module MatrixSdk
   end
 
   def self.logger
-    @logger ||= Logging.logger[name].tap do |logger|
+    @logger ||= Logging.logger[self].tap do |logger|
       logger.add_appenders Logging.appenders.stdout
-      logger.level = :warn
+      logger.level = :info
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -74,8 +74,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,6 +88,7 @@ files:
 - lib/matrix_sdk/client.rb
 - lib/matrix_sdk/errors.rb
 - lib/matrix_sdk/extensions.rb
+- lib/matrix_sdk/response.rb
 - lib/matrix_sdk/room.rb
 - lib/matrix_sdk/user.rb
 - lib/matrix_sdk/version.rb