matrix_sdk 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7caf62bbb9e17fc9bde42dcba441902469abd8a9457e80b150861cf598fe75f
-  data.tar.gz: 4b5ab256c15ab0d049e3116eac211c452a7f031fd1fb12ea39a7fe362cf3eb9e
+  metadata.gz: 44e3f36b32757df6369cafc95f4b6d9b42cff5a8b5152373519556a227aa6be4
+  data.tar.gz: dfdb434855b6ceea028a2f374f239aeec92504f36d52e8400d500193d0642d80
 SHA512:
-  metadata.gz: 3c055dabe5d53ca57cd9ca26c7b3d7e1bbe0631f0e118d81bf6b076aff4172c59afd109e32b7c1ab9573a91bc0771f6d1708c17ec1e607a2754b692242b0e3d8
-  data.tar.gz: 3ad9198ca10caca92f0a7efa8a7ac8c4362693e3be9fa140d6e1187d0f22b0fd94517714f7e1777092b9aabe82d53334d7e04c3fbc593fcd7e5917701383b7f9
+  metadata.gz: c5a57bafba59ce9616041f64172c4e5c117f7a46455612c8ae8c74693c691037e25dc5037be90c3d18600a3b30cdc2827761bfdcd9baea7ef5e5f6e7cbccc4cc
+  data.tar.gz: 99792cb46ab43e6e9d0757c5f2c171da05233d5b8d697ef1ad9d60eb2e2bdb707dca57e35b157687b6ea77ecfb955c579f72289d684699077af1f29de4ce0e54

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.4.0 - 2019-09-30
+
+- Adds the option to change the logger globally or per-object.
+
+## 1.3.0 - 2019-07-16
+
+- Improves response handling to add accessors recursively
+- Removes MatrixSdk extensions from the global scope,
+  if you've been using these in your own code you must now remember to
+  `extend MatrixSdk::Extensions` in order for them to be available.
+
 ## 1.2.1 - 2019-07-02
 
 - Fixes mxc download URL generation

data/lib/matrix_sdk.rb

@@ -39,4 +39,13 @@ module MatrixSdk
       logger.level = :info
     end
   end
+
+  def self.logger=(global_logger)
+    @logger = global_logger
+    @use_global_logger = !global_logger.nil?
+  end
+
+  def self.global_logger?
+    @use_global_logger || false
+  end
 end

data/lib/matrix_sdk/api.rb

@@ -9,6 +9,7 @@ require 'uri'
 
 module MatrixSdk
   class Api
+    extend MatrixSdk::Extensions
     include MatrixSdk::Logging
     include MatrixSdk::Protocols::AS
     include MatrixSdk::Protocols::CS

data/lib/matrix_sdk/client.rb

@@ -6,6 +6,7 @@ require 'forwardable'
 
 module MatrixSdk
   class Client
+    extend MatrixSdk::Extensions
     include MatrixSdk::Logging
     extend Forwardable
 

data/lib/matrix_sdk/extensions.rb

@@ -20,61 +20,69 @@ unless Object.respond_to? :yield_self
   end
 end
 
-def events(*symbols)
-  module_name = "#{name}Events"
-
-  initializers = []
-  readers = []
-  methods = []
-
-  symbols.each do |sym|
-    name = sym.to_s
-
-    initializers << "
-      @on_#{name} = MatrixSdk::EventHandlerArray.new
-    "
-    readers << ":on_#{name}"
-    methods << "
-      def fire_#{name}(ev, filter = nil)
-        @on_#{name}.fire(ev, filter)
-        when_#{name}(ev) if !ev.handled?
+module MatrixSdk
+  module Extensions
+    def events(*symbols)
+      module_name = "#{name}Events"
+
+      initializers = []
+      readers = []
+      methods = []
+
+      symbols.each do |sym|
+        name = sym.to_s
+
+        initializers << "
+          @on_#{name} = MatrixSdk::EventHandlerArray.new
+        "
+        readers << ":on_#{name}"
+        methods << "
+          def fire_#{name}(ev, filter = nil)
+            @on_#{name}.fire(ev, filter)
+            when_#{name}(ev) if !ev.handled?
+          end
+
+          def when_#{name}(ev); end
+        "
       end
 
-      def when_#{name}(ev); end
-    "
-  end
+      class_eval "
+        module #{module_name}
+          attr_reader #{readers.join ', '}
 
-  class_eval "
-    module #{module_name}
-      attr_reader #{readers.join ', '}
+          def event_initialize
+            #{initializers.join}
+          end
 
-      def event_initialize
-        #{initializers.join}
-      end
+          #{methods.join}
+        end
 
-      #{methods.join}
+        include #{module_name}
+      ", __FILE__, __LINE__ - 12
     end
 
-    include #{module_name}
-  ", __FILE__, __LINE__ - 12
-end
-
-def ignore_inspect(*symbols)
-  class_eval %*
-    def inspect
-      reentrant = caller_locations.any? { |l| l.absolute_path == __FILE__ && l.label == 'inspect' }
-      "\#{to_s[0..-2]} \#{instance_variables
-        .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
-        .map { |f| "\#{f}=\#{reentrant ? instance_variable_get(f) : instance_variable_get(f).inspect}" }.join " " }}>"
+    def ignore_inspect(*symbols)
+      class_eval %*
+        def inspect
+          reentrant = caller_locations.any? { |l| l.absolute_path == __FILE__ && l.label == 'inspect' }
+          "\#{to_s[0..-2]} \#{instance_variables
+            .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
+            .map { |f| "\#{f}=\#{reentrant ? instance_variable_get(f) : instance_variable_get(f).inspect}" }.join " " }}>"
+        end
+      *, __FILE__, __LINE__ - 7
     end
-  *, __FILE__, __LINE__ - 7
-end
+  end
 
-module MatrixSdk
   module Logging
     def logger
+      return MatrixSdk.logger if MatrixSdk.global_logger?
+
       @logger ||= ::Logging.logger[self]
     end
+
+    def logger=(logger)
+      @logger = logger
+    end
   end
 
   class EventHandlerArray < Hash
@@ -110,6 +118,8 @@ module MatrixSdk
   end
 
   class Event
+    extend MatrixSdk::Extensions
+
     attr_writer :handled
 
     ignore_inspect :sender

data/lib/matrix_sdk/protocols/cs.rb

@@ -1009,6 +1009,10 @@ module MatrixSdk::Protocols::CS
     request(:get, :client_r0, "/user/#{user_id}/filter/#{filter_id}", query: query)
   end
 
+  # Creates a filter for future use
+  #
+  # @param [String,MXID] user_id The user to create the filter for
+  # @param [Hash] filter_params The filter to create
   def create_filter(user_id, filter_params, **params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)
@@ -1069,6 +1073,14 @@ module MatrixSdk::Protocols::CS
     request(:put, :client_r0, "/profile/#{user_id}/avatar_url", body: content, query: query)
   end
 
+  # Gets the combined profile object of a user.
+  #
+  # This includes their display name and avatar
+  #
+  # @param [String,MXID] user_id The User ID to read the profile for
+  # @return [Response] The user profile object
+  # @see #get_display_name
+  # @see #get_avatar_url
   def get_profile(user_id, **params)
     query = {}
     query[:user_id] = params.delete(:user_id) if protocol?(:AS) && params.key?(:user_id)

data/lib/matrix_sdk/response.rb

@@ -24,6 +24,10 @@ module MatrixSdk
     def self.new(api, data)
       data.extend(Extensions)
       data.instance_variable_set(:@api, api)
+
+      data.select { |_k, v| v.is_a? Hash }
+          .each { |_v, v| Response.new api, v }
+
       data
     end
 

data/lib/matrix_sdk/room.rb

@@ -5,6 +5,7 @@ require 'matrix_sdk'
 module MatrixSdk
   # A class for tracking the information about a room on Matrix
   class Room
+    extend MatrixSdk::Extensions
     include MatrixSdk::Logging
 
     # @!attribute [rw] canonical_alias

data/lib/matrix_sdk/user.rb

@@ -5,6 +5,8 @@ require 'matrix_sdk'
 module MatrixSdk
   # A class for tracking information about a user on Matrix
   class User
+    extend MatrixSdk::Extensions
+
     # @!attribute [r] id
     #   @return [String] the MXID of the user
     # @!attribute [r] client

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: SDK for applications using the Matrix protocol