matrix_sdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d011936f4351fdcdba80a37592a243e30632355c1b85dcb03afe59b0684775ea
-  data.tar.gz: e5e569f87cb325a18bd0996d542bc7baca25e85aa42df1dfafdec05f9bc28dea
+  metadata.gz: 5b922104b5ab91c432c502117ed7f8f6a4c25121a8c407658427c28a9a9f47a3
+  data.tar.gz: 99bc5b83c327b3ac326ce4515f77bd9801c260797036daaf2cb4192e08e74ec1
 SHA512:
-  metadata.gz: 6f6881da6dc7b9e9bac6ac59386298f4e09595c6e9445a970b64f77bee3140220e5a0884575e91cc9d88198edebaf1e8074c1eeadb7a301c6d484617c904ed77
-  data.tar.gz: 8f0c02e302015dac5f9ef70da92bd073b17c31d3e8e43eb4403bb4df6c0e769f106a3af52733463651deb74ccd0437ba23d0c02138534db8767fb950c31212b6
+  metadata.gz: cd9020a5792c251aca178339ecd836495b07e414e7121711be4af78aef5fdd45d2c106fb59f9bead22767825dd694d0a43429c3db7c394bd90d9b48ddb9517c2
+  data.tar.gz: d0a15efe764f0b6b9d0fd0ec11f50385da455a1fa3e3ad92f092cfd728f377726f3d84e4d961554519b724e6dc6e402113767050281e55bcee6e9328604091d2

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v1.1.0 - 2019-06-04
+
+- The create_room method in the client abstraction now automatically stores the created room
+- Adds more CS API endpoints, exposed as #get_joined_rooms, #get_public_rooms, and #username_available?
+- Adds a method to the client abstraction to reload all joined rooms
+- Adds a method to the client abstraction to get a list of all public rooms
+- Adds avatar tracking to rooms in the client abstraction
+- Adds lazy loading of join rules and guest access for rooms in the client abstraction
+- Adds granular error classes like MatrixSdk::MatrixNotFoundError to make error handling easier
+- Improves the CS API endpoint for room state retrieval
+- Fixes an issue in the client abstraction where it would fail to load aliases if multiple HSes have applied aliases to a room
+
 ## v1.0.1 - 2019-05-24
 
 - Fixes an error in the room creation code

data/README.md

@@ -27,8 +27,8 @@ api.request :get, :federation_v1, '/version'
 # Client wrapper
 require 'matrix_sdk'
 
-client = MatrixSdk::Client.new 'https://matrix.org'
-client.login user: 'example', password: 'notarealpass' # no_sync: true
+client = MatrixSdk::Client.new 'https://example.com'
+client.login 'username', 'notarealpass' #, no_sync: true
 
 client.rooms.count
 # => 5
@@ -40,6 +40,22 @@ hq.send_text "This is an example message - don't actually do this ;)"
 # => {:event_id=>"$123457890abcdef:matrix.org"}
 ```
 
+```ruby
+# Client wrapper
+require 'matrix_sdk'
+
+client = MatrixSdk::Client.new 'https://example.com'
+client.api.access_token = 'thisisnotarealtoken'
+
+# Doesn't automatically trigger a sync when setting the token directly
+client.rooms.count
+# => 0
+
+client.sync
+client.rooms.count
+# => 5
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-matrix-sdk

data/lib/matrix_sdk/api.rb

@@ -41,7 +41,7 @@ module MatrixSdk
     # @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
     # @option params [Hash] :well_known The .well-known object that the server was discovered through, should not be set manually
-    def initialize(homeserver, params = {})
+    def initialize(homeserver, **params)
       @homeserver = homeserver
       raise ArgumentError, 'Homeserver URL must be String or URI' unless @homeserver.is_a?(String) || @homeserver.is_a?(URI)
 
@@ -178,7 +178,7 @@ module MatrixSdk
       @homeserver = hs_info
     end
 
-    def request(method, api, path, options = {})
+    def request(method, api, path, **options)
       url = homeserver.dup.tap do |u|
         u.path = api_to_path(api) + path
         u.query = [u.query, URI.encode_www_form(options.fetch(:query))].flatten.compact.join('&') if options[:query]
@@ -212,7 +212,7 @@ 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
+          raise MatrixRequestError.new_by_code(data, response.code) unless autoretry
 
           failures += 1
           waittime = data[:retry_after_ms] || data[:error][:retry_after_ms] || @backoff_time
@@ -221,7 +221,7 @@ module MatrixSdk
         end
 
         return MatrixSdk::Response.new self, data if response.is_a? Net::HTTPSuccess
-        raise MatrixRequestError.new(data, response.code) if data
+        raise MatrixRequestError.new_by_code(data, response.code) if data
 
         raise MatrixConnectionError.class_by_code(response.code), response
       end

data/lib/matrix_sdk/client.rb

@@ -89,10 +89,52 @@ module MatrixSdk
     alias user_id mxid
     alias user_id= mxid=
 
+    def public_rooms
+      rooms = []
+      since = nil
+      loop do
+        data = api.get_public_rooms since: since
+
+        data[:chunk].each do |chunk|
+          rooms << Room.new(self, chunk[:room_id],
+                            name: chunk[:name], topic: chunk[:topic], aliases: chunk[:aliases],
+                            canonical_alias: chunk[:canonical_alias], avatar_url: chunk[:avatar_url],
+                            join_rule: :public, world_readable: chunk[:world_readable]).tap do |r|
+            r.instance_variable_set :@guest_access, chunk[:guest_can_join] ? :can_join : :forbidden
+          end
+        end
+
+        break if data[:next_batch].nil?
+
+        since = data.next_batch
+      end
+
+      rooms
+    end
+
     def rooms
+      if @rooms.empty? && cache != :none
+        api.get_joined_rooms.joined_rooms.each do |id|
+          ensure_room(id)
+        end
+      end
+
       @rooms.values
     end
 
+    def reload_rooms!
+      return true if cache == :none
+
+      @rooms.clear
+      api.get_joined_rooms.joined_rooms.each do |id|
+        r = ensure_room(id)
+        r.reload!
+      end
+
+      true
+    end
+    alias refresh_rooms! reload_rooms!
+
     def register_as_guest
       data = api.register(kind: :guest)
       post_authentication(data)
@@ -158,8 +200,9 @@ module MatrixSdk
       !(mxid.nil? || @api.access_token.nil?)
     end
 
-    def create_room(room_alias = nil, params = {})
-      api.create_room(params.merge(room_alias: room_alias))
+    def create_room(room_alias = nil, **params)
+      data = api.create_room(params.merge(room_alias: room_alias))
+      ensure_room(data.room_id)
     end
 
     def join_room(room_id_or_alias)
@@ -197,7 +240,7 @@ module MatrixSdk
       raise MatrixUnexpectedResponseError, 'Upload succeeded, but no media URI returned'
     end
 
-    def start_listener_thread(params = {})
+    def start_listener_thread(**params)
       @should_listen = true
       thread = Thread.new { listen_forever(params) }
       @sync_thread = thread

data/lib/matrix_sdk/errors.rb

@@ -10,6 +10,22 @@ module MatrixSdk
     attr_reader :code, :httpstatus, :message
     alias error message
 
+    def self.class_by_code(code)
+      code = code.to_i
+
+      return MatrixNotAuthorizedError if code == 401
+      return MatrixForbiddenError if code == 403
+      return MatrixNotFoundError if code == 404
+      return MatrixConflictError if code == 409
+      return MatrixTooManyRequestsError if code == 429
+
+      MatrixRequestError
+    end
+
+    def self.new_by_code(data, code)
+      class_by_code(code).new(data, code)
+    end
+
     def initialize(error, status)
       @code = error[:errcode]
       @httpstatus = status
@@ -23,6 +39,12 @@ module MatrixSdk
     end
   end
 
+  class MatrixNotAuthorizedError < MatrixRequestError; end
+  class MatrixForbiddenError < MatrixRequestError; end
+  class MatrixNotFoundError < MatrixRequestError; end
+  class MatrixConflictError < MatrixRequestError; end
+  class MatrixTooManyRequestsError < MatrixRequestError; end
+
   # An error raised when errors occur in the connection layer
   class MatrixConnectionError < MatrixError
     def self.class_by_code(code)

data/lib/matrix_sdk/protocols/cs.rb

@@ -82,6 +82,19 @@ module MatrixSdk::Protocols::CS
     end
   end
 
+  # Checks if a given username is available and valid for registering
+  #
+  # @example Verifying a username
+  #   api.username_available?('example')
+  #   # => { available: true }
+  #
+  # @param username [String] The username to check
+  # @return [Response]
+  # @see https://matrix.org/docs/spec/client_server/latest.html#get-matrix-client-r0-register-available
+  def username_available?(username)
+    request(:get, :client_r0, '/register/available', query: { username: username })
+  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
@@ -138,6 +151,50 @@ module MatrixSdk::Protocols::CS
     request(:post, :client_r0, '/logout', query: query)
   end
 
+  # Gets the list of rooms joined by the current user
+  #
+  # @return [Response] An array of room IDs under the key :joined_rooms
+  # @see https://matrix.org/docs/spec/client_server/latest.html#get-matrix-client-r0-joined-rooms
+  def get_joined_rooms(**params)
+    query = {}
+    query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
+
+    request(:get, :client_r0, '/joined_rooms', query: query)
+  end
+
+  # Gets the list of public rooms on a Matrix server
+  #
+  # @param limit [Integer] Limits the number of results returned
+  # @param since [String] A pagination token received from an earlier call
+  # @param server [String] The Matrix server to request public rooms from
+  # @return [Response] An array of public rooms in the :chunk key, along with
+  #                    :next_batch, :prev_batch, and :total_room_count_estimate
+  #                    for pagination
+  # @see https://matrix.org/docs/spec/client_server/latest.html#get-matrix-client-r0-publicrooms
+  #      https://matrix.org/docs/spec/client_server/latest.html#post-matrix-client-r0-publicrooms
+  def get_public_rooms(server: nil, **params)
+    query = {
+      server: server
+    }.compact
+    body = nil
+    method = :get
+
+    if !params[:filter].nil? || !params[:include_all_networks].nil? || !params[:third_party_instance_id].nil?
+      body = {
+        limit: params[:limit],
+        since: params[:since],
+        filter: params[:filter],
+        include_all_networks: params[:include_all_networks],
+        third_party_instance_id: params[:third_party_instance_id]
+      }.merge(params).compact
+      method = :post
+    else
+      query = query.merge(params).compact
+    end
+
+    request(method, :client_r0, '/publicRooms', query: query, body: body)
+  end
+
   # Creates a new room
   # @param params [Hash] The room creation details
   # @option params [Symbol] :visibility (:public) The room visibility
@@ -418,14 +475,15 @@ module MatrixSdk::Protocols::CS
   # @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, **params)
+  def get_room_state(room_id, state_type = nil, key: nil, **params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
 
     room_id = ERB::Util.url_encode room_id.to_s
     state_type = ERB::Util.url_encode state_type.to_s
+    key = ERB::Util.url_encode key.to_s
 
-    request(:get, :client_r0, "/rooms/#{room_id}/state/#{state_type}", query: query)
+    request(:get, :client_r0, "/rooms/#{room_id}/state#{state_type.empty? ? nil : "/#{state_type}"}#{key.empty? ? nil : "/#{key}"}", query: query)
   end
 
   # Gets the display name of a room
@@ -707,6 +765,15 @@ module MatrixSdk::Protocols::CS
     request(:put, :client_r0, "/profile/#{user_id}/avatar_url", body: content, query: query)
   end
 
+  def get_profile(user_id, **params)
+    query = {}
+    query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
+
+    user_id = ERB::Util.url_encode user_id.to_s
+
+    request(:get, :client_r0, "/profile/#{user_id}", query: query)
+  end
+
   def get_download_url(mxcurl, **_params)
     mxcurl = URI.parse(mxcurl.to_s) unless mxcurl.is_a? URI
     raise 'Not a mxc:// URL' unless mxcurl.is_a? URI::MATRIX

data/lib/matrix_sdk/room.rb

@@ -39,7 +39,7 @@ module MatrixSdk
     #   @return [Array(Object)] the last +event_history_limit+ events to arrive in the room
     #   @see https://matrix.org/docs/spec/client_server/r0.3.0.html#get-matrix-client-r0-sync
     #        The timeline events are what will end up in here
-    attr_reader :id, :client, :name, :topic, :aliases, :join_rule, :guest_access, :members, :events
+    attr_reader :id, :client, :name, :topic, :aliases, :members, :events
 
     # @!attribute [r] on_event
     #   @return [EventHandlerArray] The list of event handlers for all events
@@ -68,10 +68,12 @@ module MatrixSdk
       @aliases = []
       @join_rule = nil
       @guest_access = nil
+      @world_readable = nil
       @members = []
       @events = []
       @members_loaded = false
       @event_history_limit = 10
+      @avatar_url = nil
 
       @prev_batch = nil
 
@@ -123,6 +125,22 @@ module MatrixSdk
       members
     end
 
+    # Gets the avatar url of the room - if any
+    def avatar_url
+      @avatar_url ||= client.api.get_room_state(id, 'm.room.avatar').url
+    rescue MatrixNotFoundError
+      # No avatar has been set
+      nil
+    end
+
+    def guest_access
+      @guest_access ||= client.api.get_room_state(id, 'm.room.guest_access').guest_access.to_sym
+    end
+
+    def join_rule
+      @join_rule ||= client.api.get_room_state(id, 'm.room.join_rules').join_rule.to_sym
+    end
+
     # Checks if +guest_access+ is set to +:can_join+
     def guest_access?
       guest_access == :can_join
@@ -328,20 +346,19 @@ module MatrixSdk
     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
+    # @param display_name [String] the new display name to use in the room
+    # @param avatar_url [String,URI] 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]
+    def set_user_profile(display_name: nil, avatar_url: nil, reason: nil)
+      return nil unless display_name || 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'
 
-      data[:displayname] = params[:display_name] unless params[:display_name].nil?
-      data[:avatar_url] = params[:avatar_url] unless params[:avatar_url].nil?
+      data[:displayname] = display_name unless display_name.nil?
+      data[:avatar_url] = avatar_url unless avatar_url.nil?
 
-      client.api.set_membership(id, client.mxid, 'join', params.fetch(:reason, 'Updating room profile information'), data)
+      client.api.set_membership(id, client.mxid, 'join', reason || 'Updating room profile information', data)
       true
     end
 
@@ -377,6 +394,14 @@ module MatrixSdk
     # State updates
     #
 
+    def reload!
+      reload_name!
+      reload_topic!
+      reload_aliases!
+      true
+    end
+    alias refresh! reload!
+
     def name=(name)
       client.api.set_room_name(id, name)
       @name = name
@@ -389,7 +414,10 @@ module MatrixSdk
       changed = data[:name] != name
       @name = data[:name] if changed
       changed
+    rescue MatrixNotFoundError
+      nil
     end
+    alias refresh_name! reload_name!
 
     def topic=(topic)
       client.api.set_room_topic(id, topic)
@@ -403,7 +431,10 @@ module MatrixSdk
       changed = data[:topic] != topic
       @topic = data[:topic] if changed
       changed
+    rescue MatrixNotFoundError
+      nil
     end
+    alias refresh_topic! reload_topic!
 
     # Add an alias to the room
     # @return [Boolean] if the addition was successful or not
@@ -419,16 +450,19 @@ module MatrixSdk
     #       alias list updates.
     def reload_aliases!
       data = client.api.get_room_state(id)
-      new_aliases = data.select { |chunk| chunk.key?(:content) && chunk[:content].key?(:aliases) }
+      new_aliases = data.select { |chunk| chunk[:type] == 'm.room.aliases' && chunk.key?(:content) && chunk[:content].key?(:aliases) }
                         .map { |chunk| chunk[:content][:aliases] }
                         .flatten
-                        .reject(&:nil?)
+                        .compact
       return false if new_aliases.nil?
 
       changed = new_aliases != aliases
       @aliases = new_aliases if changed
       changed
+    rescue MatrixNotFoundError
+      nil
     end
+    alias refresh_aliases! reload_aliases!
 
     def invite_only=(invite_only)
       self.join_rule = invite_only ? :invite : :public
@@ -450,6 +484,17 @@ module MatrixSdk
       @guest_access = guest_access
     end
 
+    def avatar_url=(avatar_url)
+      avatar_url = URI(avatar_url) unless avatar_url.is_a? URI
+      raise ArgumentError, 'Must be a valid MXC URL' unless avatar_url.is_a? URI::MATRIX
+
+      content = {
+        url: avatar_url
+      }
+      client.api.send_state_event(id, 'm.room.avatar', content)
+      @avatar_url = avatar_url
+    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

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: SDK for applications using the Matrix protocol