matrix_sdk 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444586f27d6c0e30f71f5a9c064c0a3690ac692c819c477642fd143949d06c67
-  data.tar.gz: 5391c9869e9534f2e3fffd09313423c12228e90931d41d5e3724795b96ea4d20
+  metadata.gz: 540f933e3c288eb2cfb590fdc95ba37b44b7e507754885a0a2f02c0227977ab8
+  data.tar.gz: 6ebee0cb09293d01ce214cbc718d811954d3e6265c683dce008f4538bfa7d278
 SHA512:
-  metadata.gz: 641b169f971c77acc2123f3750f920aff520074972e5bf307706a0bd644eafd9415a4a7d2a9996f9389aed40683da823c26615b6766b0785fdaeec3c9686be71
-  data.tar.gz: 6c0486fab519db6bc9e33bd1f3826d49128d84974d463105d82370461fba2dba3e6aa44f9b2dc0b4662e8bb4d43106b9b10025833b3be860f68402dc32737bdb
+  metadata.gz: '08783bd47d2b55dfeda55bb1301d934f3314f7e642bfa6518d0233e9d29087328658729aa5288c146dbbf0c5c3ddf263bc4c1cb6c85789ff32a95e7397248f3b'
+  data.tar.gz: e06303208ca67b7ae2494ae11561c0a59eb1d02d6b9cfa634b0208f1161358cebdecbe44f505019358e928cd424aaa9d5dd6eaaf009192eed138c43f324e17d0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.2.0 - 2019-06-28
+
+- Adds getters and setters for more specced room state
+- Fixes handling of the timeout parameter for the sync endpoint (#7)
+    - Additionally also now allows for running sync with a nil timeout
+- Cleans up the CS protocol implementation slightly, removing a mutation that's not supposed to be there
+- Cleans up the gemspec slightly, no longer uses `git ls-files`
+- Add support for explicitly setting proxy config for API
+
 ## v1.1.1 - 2019-06-05
 
 - Fixes a faulty include which broke the single implemented S2S endpoint

data/lib/matrix_sdk/api.rb

@@ -22,7 +22,7 @@ module MatrixSdk
     }.freeze
 
     attr_accessor :access_token, :connection_address, :connection_port, :device_id, :autoretry, :global_headers
-    attr_reader :homeserver, :validate_certificate, :read_timeout, :protocols, :well_known
+    attr_reader :homeserver, :validate_certificate, :read_timeout, :protocols, :well_known, :proxy_uri
 
     ignore_inspect :access_token, :logger
 
@@ -53,6 +53,7 @@ module MatrixSdk
       @protocols = [@protocols] unless @protocols.is_a? Array
       @protocols << :CS if @protocols.include?(:AS) && !@protocols.include?(:CS)
 
+      @proxy_uri = params.fetch(:proxy_uri, nil)
       @connection_address = params.fetch(:address, nil)
       @connection_port = params.fetch(:port, nil)
       @access_token = params.fetch(:access_token, nil)
@@ -178,6 +179,18 @@ module MatrixSdk
       @homeserver = hs_info
     end
 
+    # @param [URI] proxy_uri The URI for the proxy to use
+    # @return [URI]
+    def proxy_uri=(proxy_uri)
+      proxy_uri = URI(proxy_uri.to_s) unless proxy_uri.is_a? URI
+
+      if @http && @proxy_uri != proxy_uri
+        @http.finish
+        @http = nil
+      end
+      @proxy_uri = proxy_uri
+    end
+
     def request(method, api, path, **options)
       url = homeserver.dup.tap do |u|
         u.path = api_to_path(api) + path
@@ -262,8 +275,15 @@ module MatrixSdk
     end
 
     def http
-      @http ||= Net::HTTP.new (@connection_address || homeserver.host), (@connection_port || homeserver.port)
-      return @http if @http.active?
+      return @http if @http&.active?
+
+      host = (@connection_address || homeserver.host)
+      port = (@connection_port || homeserver.port)
+      @http ||= if proxy_uri
+                  Net::HTTP.new(host, port, proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+                else
+                  Net::HTTP.new(host, port)
+                end
 
       @http.read_timeout = read_timeout
       @http.use_ssl = homeserver.scheme == 'https'

data/lib/matrix_sdk/client.rb

@@ -205,8 +205,9 @@ module MatrixSdk
       ensure_room(data.room_id)
     end
 
-    def join_room(room_id_or_alias)
-      data = api.join_room(room_id_or_alias)
+    def join_room(room_id_or_alias, server_name: [])
+      server_name = [server_name] unless server_name.is_a? Array
+      data = api.join_room(room_id_or_alias, server_name: server_name)
       ensure_room(data.fetch(:room_id, room_id_or_alias))
     end
 
@@ -266,7 +267,7 @@ module MatrixSdk
 
       attempts = 0
       data = loop do
-        begin # rubocop:disable Style/RedundantBegin
+        begin
           break api.sync extra_params
         rescue MatrixSdk::MatrixTimeoutError => e
           raise e if (attempts += 1) >= params.fetch(:allow_sync_retry, 0)

data/lib/matrix_sdk/errors.rb

@@ -7,7 +7,7 @@ module MatrixSdk
 
   # An error specialized and raised for failed requests
   class MatrixRequestError < MatrixError
-    attr_reader :code, :httpstatus, :message
+    attr_reader :code, :data, :httpstatus, :message
     alias error message
 
     def self.class_by_code(code)
@@ -30,6 +30,7 @@ module MatrixSdk
       @code = error[:errcode]
       @httpstatus = status
       @message = error[:error]
+      @data = error.reject { |k, _v| %i[errcode error].include? k }
 
       super error[:error]
     end

data/lib/matrix_sdk/extensions.rb

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

data/lib/matrix_sdk/protocols/cs.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ModuleLength
 module MatrixSdk::Protocols::CS
   # Gets the available client API versions
   # @return [Array]
   def client_api_versions
-    @client_api_versions ||= request(:get, :client, '/versions').versions.tap do |vers|
+    (@client_api_versions ||= request(:get, :client, '/versions')).versions.tap do |vers|
       vers.instance_eval <<-'CODE', __FILE__, __LINE__ + 1
         def latest
           last
@@ -14,9 +15,9 @@ module MatrixSdk::Protocols::CS
   end
 
   # Gets the list of available unstable client API features
-  # @return [Array]
+  # @return [Hash]
   def client_api_unstable_features
-    @client_api_unstable_features ||= request(:get, :client, '/versions').unstable_features.tap do |vers|
+    (@client_api_versions ||= request(:get, :client, '/versions')).unstable_features.tap do |vers|
       vers.instance_eval <<-'CODE', __FILE__, __LINE__ + 1
         def has?(feature)
           fetch(feature, nil)
@@ -25,8 +26,10 @@ module MatrixSdk::Protocols::CS
     end
   end
 
+  # Gets the list of available methods for logging in
+  # @return [Response]
   def allowed_login_methods
-    request(:get, :client_r0, '/login').flows
+    request(:get, :client_r0, '/login')
   end
 
   # Runs the client API /sync method
@@ -37,16 +40,14 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#get-matrix-client-r0-sync
   #      For more information on the parameters and what they mean
   def sync(timeout: 30.0, **params)
-    query = {
-      timeout: timeout
-    }.merge(params).select do |k, _v|
+    query = params.select do |k, _v|
       %i[since filter full_state set_presence].include? k
     end
 
-    query[:timeout] = (query.fetch(:timeout, 30) * 1000).to_i
+    query[:timeout] = (timeout * 1000).to_i if timeout
     query[:timeout] = params.delete(:timeout_ms).to_i if params.key? :timeout_ms
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
 
@@ -66,7 +67,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#post-matrix-client-r0-register
   #      For options that are permitted in this call
   def register(kind: 'user', **params)
     query = {}
@@ -118,7 +119,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#post-matrix-client-r0-login
   #      The Matrix Spec, for more information about the call and response
   def login(login_type: 'm.login.password', **params)
     query = {}
@@ -142,7 +143,7 @@ module MatrixSdk::Protocols::CS
 
   # Logs out the currently logged in user
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#post-matrix-client-r0-logout
   #      The Matrix Spec, for more information about the call and response
   def logout(**params)
     query = {}
@@ -201,7 +202,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#post-matrix-client-r0-createroom
   #      The Matrix Spec, for more information about the call and response
   def create_room(visibility: :public, **params)
     query = {}
@@ -222,7 +223,7 @@ module MatrixSdk::Protocols::CS
   # @param params [Hash] Extra room join options
   # @option params [String[]] :server_name A list of servers to perform the join through
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#post-matrix-client-r0-join-roomidoralias
   #      The Matrix Spec, for more information about the call and response
   # @todo Add support for 3rd-party signed objects
   def join_room(id_or_alias, **params)
@@ -245,8 +246,8 @@ module MatrixSdk::Protocols::CS
   # @param params [Hash] Options for the request
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#put-matrix-client-r0-rooms-roomid-state-eventtype-statekey
+  #      https://matrix.org/docs/spec/client_server/r0.5.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 = {}
@@ -266,7 +267,7 @@ module MatrixSdk::Protocols::CS
   # @param params [Hash] Options for the request
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.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 = {}
@@ -289,7 +290,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.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 = {}
@@ -344,10 +345,10 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-image
+  #      https://matrix.org/docs/spec/client_server/r0.5.0.html#m-file
+  #      https://matrix.org/docs/spec/client_server/r0.5.0.html#m-video
+  #      https://matrix.org/docs/spec/client_server/r0.5.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 = {
@@ -372,7 +373,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.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 = {
@@ -395,7 +396,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-text
   #      The Matrix Spec, for more information about the call and response
   def send_message(room_id, message, **params)
     content = {
@@ -413,7 +414,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-emote
   #      The Matrix Spec, for more information about the call and response
   def send_emote(room_id, emote, **params)
     content = {
@@ -431,7 +432,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-notice
   #      The Matrix Spec, for more information about the call and response
   def send_notice(room_id, notice, **params)
     content = {
@@ -451,7 +452,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.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, limit: 10, **params)
     query = {
@@ -473,7 +474,7 @@ module MatrixSdk::Protocols::CS
   # @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
+  # @see https://matrix.org/docs/spec/client_server/r0.5.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 = nil, key: nil, **params)
     query = {}
@@ -486,17 +487,30 @@ module MatrixSdk::Protocols::CS
     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
+  ## Specialized getters for specced state
+  #
+
+  # Gets the current display name of a room
   #
   # @param room_id [MXID,String] The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
   # @return [Response] A response hash with the parameter :name
+  # @raise [MatrixNotFoundError] Raised if no name has been set on the room
   # @see get_room_state
-  # @see https://matrix.org/docs/spec/client_server/r0.3.0.html#m-room-name
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-name
   #      The Matrix Spec, for more information about the event and data
   def get_room_name(room_id, **params)
     get_room_state(room_id, 'm.room.name', params)
   end
 
+  # Sets the display name of a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [String] name The new name of the room
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-name
+  #      The Matrix Spec, for more information about the event and data
   def set_room_name(room_id, name, **params)
     content = {
       name: name
@@ -504,10 +518,27 @@ module MatrixSdk::Protocols::CS
     send_state_event(room_id, 'm.room.name', content, params)
   end
 
+  # Gets the current topic of a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the parameter :topic
+  # @raise [MatrixNotFoundError] Raised if no topic has been set on the room
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-topic
+  #      The Matrix Spec, for more information about the event and data
   def get_room_topic(room_id, **params)
     get_room_state(room_id, 'm.room.topic', params)
   end
 
+  # Sets the topic of a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [String] topic The new topic of the room
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-topic
+  #      The Matrix Spec, for more information about the event and data
   def set_room_topic(room_id, topic, **params)
     content = {
       topic: topic
@@ -515,14 +546,274 @@ module MatrixSdk::Protocols::CS
     send_state_event(room_id, 'm.room.topic', content, params)
   end
 
-  def get_power_levels(room_id, **params)
+  # Gets the current avatar URL of a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the parameters :url and (optionally) :info
+  # @raise [MatrixNotFoundError] Raised if no avatar has been set on the room
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-avatar
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_avatar(room_id, **params)
+    get_room_state(room_id, 'm.room.avatar', params)
+  end
+
+  # Sets the avatar URL for a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [String,URI] url The new avatar URL for the room
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-avatar
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_avatar(room_id, url, **params)
+    content = {
+      url: url
+    }
+    send_state_event(room_id, 'm.room.avatar', content, params)
+  end
+
+  # Gets a list of current aliases of a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the array :aliases
+  # @raise [MatrixNotFoundError] Raised if no aliases has been set on the room by the specified HS
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-avatar
+  #      The Matrix Spec, for more information about the event and data
+  # @example Looking up aliases for a room
+  #   api.get_room_aliases('!QtykxKocfZaZOUrTwp:matrix.org')
+  #   # MatrixSdk::MatrixNotFoundError: HTTP 404 (M_NOT_FOUND): Event not found.
+  #   api.get_room_aliases('!QtykxKocfZaZOUrTwp:matrix.org', key: 'matrix.org')
+  #   # => {:aliases=>["#matrix:matrix.org"]}
+  #   api.get_room_aliases('!QtykxKocfZaZOUrTwp:matrix.org', key: 'kittenface.studio')
+  #   # => {:aliases=>["#worlddominationhq:kittenface.studio"]}
+  # @example A way to find all aliases for a room
+  #   api.get_room_state('!mjbDjyNsRXndKLkHIe:matrix.org')
+  #      .select { |ch| ch[:type] == 'm.room.aliases' }
+  #      .map { |ch| ch[:content][:aliases] }
+  #      .flatten
+  #      .compact
+  #   # => ["#synapse:im.kabi.tk", "#synapse:matrix.org", "#synapse-community:matrix.org", "#synapse-ops:matrix.org", "#synops:matrix.org", ...
+  def get_room_aliases(room_id, **params)
+    get_room_state(room_id, 'm.room.aliases', params)
+  end
+
+  # Gets a list of pinned events in a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the array :pinned
+  # @raise [MatrixNotFoundError] Raised if no aliases has been set on the room by the specified HS
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-pinned-events
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_pinned_events(room_id, **params)
+    get_room_state(room_id, 'm.room.pinned_events', params)
+  end
+
+  # Sets the list of pinned events in a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [Array[String]] events The new list of events to set as pinned
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-pinned-events
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_pinned_events(room_id, events, **params)
+    content = {
+      pinned: events
+    }
+    send_state_event(room_id, 'm.room.pinned_events', content, params)
+  end
+
+  # Gets the configured power levels for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with power level information
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-power-levels
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_power_levels(room_id, **params)
     get_room_state(room_id, 'm.room.power_levels', params)
   end
+  alias get_power_levels get_room_power_levels
 
-  def set_power_levels(room_id, content, **params)
+  # Sets the configuration for power levels in a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [Hash] content The new power level configuration
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-power-levels
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_power_levels(room_id, content, **params)
     content[:events] = {} unless content.key? :events
     send_state_event(room_id, 'm.room.power_levels', content, params)
   end
+  alias set_power_levels set_room_power_levels
+
+  # Gets the join rules for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the key :join_rule
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-join-rules
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_join_rules(room_id, **params)
+    get_room_state(room_id, 'm.room.join_rules', params)
+  end
+
+  # Sets the join rules for a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [String,Symbol] join_rule The new join rule setting (Currently only public and invite are implemented)
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-join-rules
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_join_rules(room_id, join_rule, **params)
+    content = {
+      join_rule: join_rule
+    }
+
+    send_state_event(room_id, 'm.room.join_rules', content, params)
+  end
+
+  # Gets the guest access settings for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the key :guest_acces, either :can_join or :forbidden
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-guest-access
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_guest_access(room_id, **params)
+    get_room_state(room_id, 'm.room.guest_access', params)
+  end
+
+  # Sets the guest access settings for a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [:can_join, :forbidden] guest_access The new guest access setting for the room
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-guest-access
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_guest_access(room_id, guest_access, **params)
+    content = {
+      guest_access: guest_access
+    }
+
+    send_state_event(room_id, 'm.room.guest_access', content, params)
+  end
+
+  # Gets the creation configuration object for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the configuration the room was created for
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-create
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_creation_info(room_id, **params)
+    get_room_state(room_id, 'm.room.create', params)
+  end
+
+  # Gets the encryption configuration for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the configuration the room was created for
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-encryption
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_encryption_settings(room_id, **params)
+    get_room_state(room_id, 'm.room.encryption', params)
+  end
+
+  # Sets the encryption configuration for a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param ['m.megolm.v1.aes-sha2'] algorithm The encryption algorithm to use
+  # @param [Integer] rotation_period_ms The interval between key rotation in milliseconds
+  # @param [Integer] rotation_period_msgs The interval between key rotation in messages
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-guest-encryption
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_encryption_settings(room_id, algorithm: 'm.megolm.v1.aes-sha2', rotation_period_ms: 1 * 7 * 24 * 60 * 60 * 1000, rotation_period_msgs: 100, **params)
+    content = {
+      algorithm: algorithm,
+      rotation_period_ms: rotation_period_ms,
+      rotation_period_msgs: rotation_period_msgs
+    }
+    send_state_event(room_id, 'm.room.encryption', content, params)
+  end
+
+  # Gets the history availabiilty for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with the key :history_visibility
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-history-visibility
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_history_visibility(room_id, **params)
+    get_room_state(room_id, 'm.room.history_visibility', params)
+  end
+
+  # Sets the history availability for a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [:invited, :joined, :shared, :world_readable] visibility The new history visibility level
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-guest-history-visibility
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_history_visibility(room_id, visibility, **params)
+    content = {
+      history_visibility: visibility
+    }
+
+    send_state_event(room_id, 'm.room.history_visibility', content, params)
+  end
+
+  # Gets the server ACLs for a room
+  #
+  # @param [MXID,String] room_id The room ID to look up
+  # @param [Hash] params Extra options to provide to the request, see #get_room_state
+  # @return [Response] A response hash with server ACL information
+  # @see get_room_state
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-server-acl
+  #      The Matrix Spec, for more information about the event and data
+  def get_room_server_acl(room_id, **params)
+    get_room_state(room_id, 'm.room.server_acl', params)
+  end
+
+  # Sets the server ACL configuration for a room
+  #
+  # @param [MXID,String] room_id The room ID to work on
+  # @param [Boolean] allow_ip_literals If HSes with literal IP domains should be allowed
+  # @param [Array[String]] allow A list of HS wildcards that are allowed to communicate with the room
+  # @param [Array[String]] deny A list of HS wildcards that are denied from communicating with the room
+  # @param [Hash] params Extra options to set on the request, see #send_state_event
+  # @return [Response] The resulting state event
+  # @see https://matrix.org/docs/spec/client_server/r0.5.0.html#m-room-guest-server-acl
+  #      The Matrix Spec, for more information about the event and data
+  def set_room_server_acl(room_id, allow_ip_literals: false, allow:, deny:, **params)
+    content = {
+      allow_ip_literals: allow_ip_literals,
+      allow: allow,
+      deny: deny
+    }
+
+    send_state_event(room_id, 'm.room.server_acl', content, params)
+  end
 
   def leave_room(room_id, **params)
     query = {}
@@ -774,16 +1065,34 @@ module MatrixSdk::Protocols::CS
     request(:get, :client_r0, "/profile/#{user_id}", query: query)
   end
 
-  def get_download_url(mxcurl, **_params)
+  # Converts a Matrix content URL (mxc://) to a media download URL
+  # @param [String,URI] mxcurl The Matrix content URL to convert
+  # @param [String,URI] source A source HS to use for the convertion, defaults to the connected HS
+  # @return [URI] The full download URL for the requested piece of media
+  #
+  # @example Converting a MXC URL
+  #   url = 'mxc://example.com/media_hash'
+  #
+  #   api.get_download_url(url)
+  #   # => #<URI::HTTPS https://example.com/_matrix/media/r0/download/example.com/media_hash>
+  #   api.get_download_url(url, source: 'matrix.org')
+  #   # => #<URI::HTTPS https://matrix.org/_matrix/media/r0/download/example.com/media_hash>
+  def get_download_url(mxcurl, source: nil, **_params)
     mxcurl = URI.parse(mxcurl.to_s) unless mxcurl.is_a? URI
     raise 'Not a mxc:// URL' unless mxcurl.is_a? URI::MATRIX
 
-    homeserver.dup.tap do |u|
+    source ||= homeserver.dup
+    source = URI(hs.to_s) unless hs.is_a? URI
+    source.tap do |u|
       full_path = ERB::Util.url_encode mxcurl.full_path.to_s
       u.path = "/_matrix/media/r0/download/#{full_path}"
     end
   end
 
+  # Gets the room ID for an alias
+  # @param [String,MXID] room_alias The room alias to look up
+  # @return [Response] An object containing the :room_id key and a key of :servers that know of the room
+  # @raise [MatrixNotFoundError] No room with the requested alias exists
   def get_room_id(room_alias, **params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
@@ -793,6 +1102,11 @@ module MatrixSdk::Protocols::CS
     request(:get, :client_r0, "/directory/room/#{room_alias}", query: query)
   end
 
+  # Sets the room ID for an alias
+  # @param [String,MXID] room_id The room to set an alias for
+  # @param [String,MXID] room_alias The alias to configure for the room
+  # @return [Response] An empty object denoting success
+  # @raise [MatrixConflictError] The alias is already in use
   def set_room_alias(room_id, room_alias, **params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
@@ -805,6 +1119,9 @@ module MatrixSdk::Protocols::CS
     request(:put, :client_r0, "/directory/room/#{room_alias}", body: content, query: query)
   end
 
+  # Remove an alias from its room
+  # @param [String,MXID] room_alias The alias to remove
+  # @return [Response] An empty object denoting success
   def remove_room_alias(room_alias, **params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
@@ -823,45 +1140,63 @@ module MatrixSdk::Protocols::CS
     request(:get, :client_r0, "/rooms/#{room_id}/members", query: query)
   end
 
-  def set_join_rule(room_id, join_rule, **params)
-    content = {
-      join_rule: join_rule
-    }
-
-    send_state_event(room_id, 'm.room.join_rules', params.merge(content))
-  end
-
-  def set_guest_access(room_id, guest_access, **params)
-    # raise ArgumentError, '`guest_access` must be one of [:can_join, :forbidden]' unless %i[can_join forbidden].include? guest_access
-    content = {
-      guest_access: guest_access
-    }
-
-    send_state_event(room_id, 'm.room.guest_access', params.merge(content))
-  end
-
+  # Gets a list of the current users registered devices
+  # @return [Response] An object including all information about the users devices.
+  # @see https://matrix.org/docs/spec/client_server/r0.4.0#get-matrix-client-r0-devices
+  #      The Matrix Spec, for more information about the data
   def get_devices
     request(:get, :client_r0, '/devices')
   end
 
+  # Gets the information about a certain client device
+  # @param [String] device_id The ID of the device to look up
+  # @return [Response] An object containing all available device information
+  # @see https://matrix.org/docs/spec/client_server/r0.4.0#get-matrix-client-r0-devices-deviceid
+  #      The Matrix Spec, for more information about the data
   def get_device(device_id)
     device_id = ERB::Util.url_encode device_id.to_s
 
     request(:get, :client_r0, "/devices/#{device_id}")
   end
 
+  # Sets the metadata for a device
+  # @param [String] device_id The ID of the device to modify
+  # @param [String] display_name The new display name to set for the device
+  # @see https://matrix.org/docs/spec/client_server/r0.4.0#put-matrix-client-r0-devices-deviceid
+  #      The Matrix Spec, for more information about the data
   def set_device(device_id, display_name:)
     device_id = ERB::Util.url_encode device_id.to_s
 
     request(:put, :client_r0, "/devices/#{device_id}", body: { display_name: display_name })
   end
 
+  # Removes a device from the current user
+  # @param [String] device_id The device to remove
+  # @param [Hash] auth Authentication data for the removal request
+  # @raise [MatrixNotAuthorizeedError] The request did not contain enough authentication information,
+  #        the data in this error will include the necessary information to perform interactive auth
+  # @see https://matrix.org/docs/spec/client_server/r0.4.0#delete-matrix-client-r0-devices-deviceid
+  #      The Matrix Spec, for more information about the data
   def delete_device(device_id, auth:)
     device_id = ERB::Util.url_encode device_id.to_s
 
     request(:delete, :client_r0, "/devices/#{device_id}", body: { auth: auth })
   end
 
+  # Run a query for device keys
+  # @param [Numeric] timeout The timeout - in seconds - for the query
+  # @param [Array] device_keys The list of devices to query
+  # @param [String] token The sync token that led to this query - if any
+  # @param [Hash] params Additional parameters
+  # @option params [Integer] timeout_ms The timeout in milliseconds for the query, overrides _timeout_
+  # @example Looking up all the device keys for a user
+  #   api.keys_query(device_keys: { '@alice:example.com': [] })
+  #   # => { :device_keys => { :'@alice:example.com' => { :JLAFKJWSCS => { ...
+  # @example Looking up a specific device for a user
+  #   api.keys_query(device_keys: { '@alice:example.com': ['ABCDEFGHIJ'] })
+  #   # => { :device_keys => { :'@alice:example.com' => { :ABCDEFGHIJ => { ...
+  # @see https://matrix.org/docs/spec/client_server/r0.4.0#post-matrix-client-r0-keys-query
+  #      The Matrix Spec, for more information about the parameters and data
   def keys_query(timeout: nil, device_keys:, token: nil, **params)
     body = {
       timeout: (timeout || 10) * 1000,
@@ -873,6 +1208,8 @@ module MatrixSdk::Protocols::CS
     request(:post, :client_r0, '/keys/query', body: body)
   end
 
+  # Gets the MXID of the currently logged-in user
+  # @return [Response] An object containing the key :user_id
   def whoami?(**params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
@@ -880,3 +1217,4 @@ module MatrixSdk::Protocols::CS
     request(:get, :client_r0, '/account/whoami', query: query)
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/matrix_sdk/room.rb

@@ -139,18 +139,18 @@ module MatrixSdk
 
     # Gets the avatar url of the room - if any
     def avatar_url
-      @avatar_url ||= client.api.get_room_state(id, 'm.room.avatar').url
+      @avatar_url ||= client.api.get_room_avatar(id).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
+      @guest_access ||= client.api.get_room_guest_access(id).guest_access.to_sym
     end
 
     def join_rule
-      @join_rule ||= client.api.get_room_state(id, 'm.room.join_rules').join_rule.to_sym
+      @join_rule ||= client.api.get_room_join_rules(id).join_rule.to_sym
     end
 
     # Checks if +guest_access+ is set to +:can_join+
@@ -374,15 +374,24 @@ module MatrixSdk
       true
     end
 
+    # Returns a list of the room tags
+    # @return [Response] A list of the tags and their data, with add and remove methods implemented
+    # @example Managing tags
+    #   room.tags
+    #   # => { :room_tag => { data: false } }
+    #   room.tags.add('some_tag', data: true)
+    #   # => { :some_tag => { data: true }, :room_tag => { data: false} }
+    #   room.tags.remove('room_tag')
+    #   # => { :some_tag => { data: true} }
     def tags
       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
+        tag_obj.define_singleton_method(:add) do |tag, **data|
+          @room.add_tag(tag.to_s.to_sym, data)
+          self[tag.to_s.to_sym] = data
           self
         end
         tag_obj.define_singleton_method(:remove) do |tag|
@@ -392,13 +401,18 @@ module MatrixSdk
       end
     end
 
+    # Remove a tag from the room
+    # @param [String] tag The tag to remove
     def remove_tag(tag)
       client.api.remove_user_tag(client.mxid, id, tag)
       true
     end
 
-    def add_tag(tag, params = {})
-      client.api.add_user_tag(client.mxid, id, tag, params)
+    # Add a tag to the room
+    # @param [String] tag The tag to add
+    # @param [Hash] data The data to assign to the tag
+    def add_tag(tag, **data)
+      client.api.add_user_tag(client.mxid, id, tag, data)
       true
     end
 
@@ -466,7 +480,7 @@ module MatrixSdk
     #       alias list updates.
     def reload_aliases!
       begin
-        new_aliases = client.api.get_room_state(id, 'm.room.aliases').aliases
+        new_aliases = client.api.get_room_aliases(id).aliases
       rescue MatrixNotFoundError
         data = client.api.get_room_state(id)
         new_aliases = data.select { |chunk| chunk[:type] == 'm.room.aliases' && chunk.key?(:content) && chunk[:content].key?(:aliases) }
@@ -507,10 +521,7 @@ module MatrixSdk
       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)
+      client.api.set_room_avatar(id, avatar_url)
       @avatar_url = avatar_url
     end
 

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: logging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -81,36 +67,32 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ci_reporter_test_unit
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 description: SDK for applications using the Matrix protocol
 email:
 - ace@haxalot.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 files:
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/simple_client.rb
 - lib/matrix_sdk.rb
 - lib/matrix_sdk/api.rb
 - lib/matrix_sdk/application_service.rb
@@ -126,7 +108,6 @@ files:
 - lib/matrix_sdk/room.rb
 - lib/matrix_sdk/user.rb
 - lib/matrix_sdk/version.rb
-- matrix-sdk.gemspec
 homepage: https://github.com/ananace/ruby-matrix-sdk
 licenses:
 - MIT

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.gitlab-ci.yml

@@ -1,41 +0,0 @@
----
-image: "ruby:2.6"
-
-# Cache gems in between builds
-cache:
-  paths:
-    - vendor/ruby
-
-before_script:
-  - gem install bundler -N
-  - bundle install -j $(nproc) --path vendor
-
-rubocop:
-  before_script: []
-  script:
-    - gem install rubocop -N
-    - rubocop lib
-
-test:
-  coverage: '/\((\d+.\d+\%)\) covered/'
-  script:
-    - GENERATE_REPORTS=true CI_REPORTS=reports bundle exec rake test
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - coverage/
-    reports:
-      junit: "reports/TEST-*.xml"
-
-pages:
-  stage: deploy
-  before_script: []
-  script:
-    - gem install yard -N
-    - yard doc -o public/
-  artifacts:
-    paths:
-      - public/
-  only:
-    - master
-  when: always

data/.rubocop.yml

@@ -1,53 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-  Exclude:
-    - '*.spec'
-    - 'Rakefile'
-
-# Broken in CI
-Lint/Void:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-# Don't enforce documentation
-Style/Documentation:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 50
-
-# Matrix has a lot of methods in the CS API
-Metrics/ModuleLength:
-  Max: 500
-
-Metrics/LineLength:
-  Max: 190
-
-Style/RescueModifier:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/MultilineBlockChain:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
-Naming/AccessorMethodName:
-  Enabled: false

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.7
-before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in matrix-sdk.gemspec
-gemspec

data/Rakefile

@@ -1,15 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  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

@@ -1,148 +0,0 @@
-#!/usr/bin/env ruby
-
-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'
-      ],
-      lazy_load_members: true
-    },
-    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'],
-      lazy_load_members: true
-    },
-    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
-    # Only track messages from the listened rooms
-    @filter[:room][:rooms] = @tracked_rooms
-    start_listener_thread(filter: @filter.to_json)
-  end
-
-  private
-
-  def get_user_level(room, mxid)
-    levels = @pls[room.id] ||= api.get_power_levels(room.id)[:users]
-    levels[mxid.to_sym]
-  end
-
-  def on_message(room, event)
-    case event.type
-    when 'm.room.member'
-      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) || 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]}"
-      else
-        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
-end
-
-if $PROGRAM_NAME == __FILE__
-  raise "Usage: #{$PROGRAM_NAME} [-d] homeserver_url room_id_or_alias" unless ARGV.length >= 2
-  begin
-    if ARGV.first == '-d'
-      Thread.abort_on_exception = true
-      MatrixSdk.debug!
-      ARGV.shift
-    end
-
-    client = SimpleClient.new ARGV.first
-    ARGV.shift
-
-    print 'Username: '
-    user = STDIN.gets.strip
-    puts 'Password: '
-    password = STDIN.noecho(&:gets).strip
-
-    puts 'Logging in...'
-    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(timeout: 5, filter: sync_filter.to_json)
-
-    puts 'Finding room...'
-    room = client.find_room(ARGV.last)
-    room ||= begin
-      puts 'Joining room...'
-      client.join_room(ARGV.last)
-    end
-
-    client.add_listener(room)
-
-    puts 'Starting listener'
-    client.run
-
-    puts 'Entering main loop'
-    loop do
-      print '> '
-      msg = STDIN.gets.strip
-      break if msg.start_with? '/quit'
-
-      if msg.start_with? '/me'
-        room.send_emote msg.gsub(/\/me\s*/, '')
-      else
-        room.send_text msg
-      end
-    end
-  rescue Interrupt
-    puts 'Interrupted, exiting...'
-  ensure
-    client.logout if client && client.logged_in?
-  end
-end

data/matrix-sdk.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require File.join File.expand_path('lib', __dir__), 'matrix_sdk/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'matrix_sdk'
-  spec.version       = MatrixSdk::VERSION
-  spec.authors       = ['Alexander Olofsson']
-  spec.email         = ['ace@haxalot.com']
-
-  spec.summary       = 'SDK for applications using the Matrix protocol'
-  spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/ananace/ruby-matrix-sdk'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'logging', '~> 2'
-
-  spec.add_development_dependency 'mocha'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'test-unit'
-
-  # TODO: Put this in a better location
-  spec.add_development_dependency 'ci_reporter_test_unit'
-end