matrix_sdk 1.4.0 → 2.1.1

data/lib/matrix_sdk/user.rb

@@ -7,10 +7,6 @@ module MatrixSdk
   class User
     extend MatrixSdk::Extensions
 
-    # @!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
 
@@ -32,14 +28,14 @@ module MatrixSdk
       end
     end
 
-    # @!attribute [r] display_name
     # @return [String] the display name
+    # @see MatrixSdk::Protocols::CS#get_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
+    # @see MatrixSdk::Protocols::CS#set_display_name
     def display_name=(name)
       client.api.set_display_name(id, name)
       @display_name = name
@@ -51,21 +47,92 @@ module MatrixSdk
       display_name || id
     end
 
-    # @!attribute [r] avatar_url
+    # Gets the avatar for the user
+    #
+    # @see MatrixSdk::Protocols::CS#get_avatar_url
     def avatar_url
       @avatar_url ||= client.api.get_avatar_url(id)[:avatar_url]
     end
 
-    # @!attribute [w] avatar_url
+    # Set a new avatar for the user
+    #
+    # Only works for the current user object, as requested by
+    #     client.get_user(:self)
+    #
+    # @param url [String,URI::MATRIX] the new avatar URL
+    # @note Requires a mxc:// URL, check example on
+    #   {MatrixSdk::Protocols::CS#set_avatar_url} for how this can be done
+    # @see MatrixSdk::Protocols::CS#set_avatar_url
     def avatar_url=(url)
       client.api.set_avatar_url(id, url)
       @avatar_url = url
     end
 
+    # Get the user's current presence status
+    #
+    # @return [Symbol] One of :online, :offline, :unavailable
+    # @see MatrixSdk::Protocols::CS#get_presence_status
+    # @note This information is not cached in the abstraction layer
+    def presence
+      raw_presence[:presence].to_sym
+    end
+
+    # Sets the user's current presence status
+    # Should be one of :online, :offline, or :unavailable
+    #
+    # @param new_presence [:online,:offline,:unavailable] The new presence status to set
+    # @see MatrixSdk::Protocols::CS#set_presence_status
+    def presence=(new_presence)
+      raise ArgumentError, 'Presence must be one of :online, :offline, :unavailable' unless %i[online offline unavailable].include?(presence)
+
+      client.api.set_presence_status(id, new_presence)
+    end
+
+    # @return [Boolean] if the user is currently active
+    # @note This information is not cached in the abstraction layer
+    def active?
+      raw_presence[:currently_active] == true
+    end
+
+    # Gets the user-specified status message - if any
+    #
+    # @see MatrixSdk::Protocols::CS#get_presence_status
+    # @note This information is not cached in the abstraction layer
+    def status_msg
+      raw_presence[:status_msg]
+    end
+
+    # Sets the user-specified status message
+    #
+    # @param message [String,nil] The message to set, or nil for no message
+    # @see MatrixSdk::Protocols::CS#set_presence_status
+    def status_msg=(message)
+      client.api.set_presence_status(id, presence, message: message)
+    end
+
+    # Gets the last time the user was active at, from the server's side
+    #
+    # @return [Time] when the user was last active
+    # @see MatrixSdk::Protocols::CS#get_presence_status
+    # @note This information is not cached in the abstraction layer
+    def last_active
+      since = raw_presence[:last_active_ago]
+      return unless since
+
+      Time.now - (since / 1000)
+    end
+
+    # Returns all the current device keys for the user, retrieving them if necessary
     def device_keys
       @device_keys ||= client.api.keys_query(device_keys: { id => [] }).yield_self do |resp|
         resp[:device_keys][id.to_sym]
       end
     end
+
+    private
+
+    def raw_presence
+      client.api.get_presence_status(id).tap { |h| h.delete :user_id }
+    end
   end
 end

data/lib/matrix_sdk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -103,6 +103,7 @@ files:
 - lib/matrix_sdk/protocols/as.rb
 - lib/matrix_sdk/protocols/cs.rb
 - lib/matrix_sdk/protocols/is.rb
+- lib/matrix_sdk/protocols/msc.rb
 - lib/matrix_sdk/protocols/ss.rb
 - lib/matrix_sdk/response.rb
 - lib/matrix_sdk/room.rb
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SDK for applications using the Matrix protocol