rocketchat 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ff674c069b6c5cc2bb466966c996007d1cc286b
-  data.tar.gz: 2d8ba00018c162adea4a1a7204419aa52c3fdb61
+  metadata.gz: ac447ec59a2cd4858ce06737a597577f1536fb86
+  data.tar.gz: b7d860d2d1118d6a2e694e90f6118aa061018434
 SHA512:
-  metadata.gz: 40935960e7f75f53ae5eeb87608f2e232e6e837e7b1cb24247ed94f2b54cebcba1685ad9b4c7ef6d6892217727624985eef57a287d2c7041856833458a6ba3d3
-  data.tar.gz: fb0484eae8d74644066810a156ce8cc1b2adeb7ddf001f855362d92469f18d168bca08815877e5bed8d06816a8a0327d5bc9372d305600481379ea3167174ad9
+  metadata.gz: 1bfd1e5f79ac35ad403164f11d88876873c709b1b6bfe660fe8fb7eb00e6114345ca62bac956528edbf0b96ffdd2cef517d53d40e7cafd9057978da3564e1cc2
+  data.tar.gz: cf974f96c266e81049f977a42814477cfa2b7cf48ce63f42cac340f21fc3e8a7a1ac46ff692dda360859af4dc1ad1be839b66f9d9700717dc7a2ca78d530d40f

data/README.md

@@ -28,23 +28,26 @@ And then execute:
 This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.54)
 
 #### Miscellaneous information
-* /api/v1/info
+* [/api/v1/info](#info)
 
 #### Authentication
-* /api/v1/login
-* /api/v1/logout
+* [/api/v1/login](#authentication)
+* [/api/v1/logout](#authentication)
 * /api/v1/me
 
 ### Users
-* /api/v1/users.create
-* /api/v1/users.delete
-* /api/v1/users.info
-* /api/v1/users.setAvatar
-* /api/v1/users.update
+* [/api/v1/users.create](docs/users.md#userscreate)
+* [/api/v1/users.delete](docs/users.md#usersdelete)
+* [/api/v1/users.getPresence](docs/users.md#usersgetpresence)
+* [/api/v1/users.info](docs/users.md#usersinfo)
+* [/api/v1/users.list](docs/users.md#userslist)
+* [/api/v1/users.setAvatar](docs/users.md#userssetavatar)
+* [/api/v1/users.update](docs/users.md#usersupdate)
 
 
 ## Usage
 
+#### info
 To get Rocket.Chat version
 
 ```ruby
@@ -55,7 +58,7 @@ info = rocket_server.info
 puts "Rocket.Chat version: #{info.version}"
 ```
 
-
+#### authentication
 To logout from a server:
 
 ```ruby
@@ -68,78 +71,9 @@ session.logout
 ```
 
 
-To create a user:
-
-```ruby
-require 'rocketchat'
-
-rocket_server = RocketChat::Server.new('http://your.server.address/')
-session = rocket_server.login('username', 'password')
-user = session.users.create('new_username', 'user@example.com', 'New User', '123456',
-                     active: true, send_welcome_email: false)
-```
-
-Optional parameters for create are:
-
-:active, :roles, :join_default_channels, :require_password_change, :send_welcome_email, :verified, :custom_fields
-
-
-To update a user:
-
-```ruby
-require 'rocketchat'
-
-rocket_server = RocketChat::Server.new('http://your.server.address/')
-session = rocket_server.login('username', 'password')
-user = session.users.update('LAjzCDLqggCT7B82M',
-  email: 'updated@example.com',
-  name: 'Updated Name',
-  roles: ['user', 'moderator']
-)
-```
-
-Optional parameters for update are:
-
-:username, :email, :password, :name, :active, :roles, :join_default_channels, :require_password_change, :send_welcome_email, :verified, :custom_fields
-
-
-To get user info:
-
-```ruby
-require 'rocketchat'
-
-rocket_server = RocketChat::Server.new('http://your.server.address/')
-session = rocket_server.login('username', 'password')
-user = session.users.info(username: 'some_username')
-```
-
-Either user_id (RocketChat's ID) or username can be used.
-
-
-To delete a user, the same options as an info request can be used (`user_id` or `username`).
-
-To search for (list) users:
-
-```ruby
-require 'rocketchat'
-
-rocket_server = RocketChat::Server.new('http://your.server.address/')
-session = rocket_server.login('username', 'password')
-users = session.users.list(query: { email: 'foo@example.com' })
-```
-
-
-To set a user's avatar:
-
-```ruby
-require 'rocketchat'
-
-rocket_server = RocketChat::Server.new('http://your.server.address/')
-session = rocket_server.login('username', 'password')
-success = session.users.set_avatar('http://image_url')
-```
+For details of specific APIs:
 
-There is an optional parameter user_id, that works if the setting user is allowed to set other's avatar.
+* [Users](docs/users.md)
 
 
 ## Contributing

data/lib/rocket_chat/gem_version.rb

@@ -1,3 +1,3 @@
 module RocketChat
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/lib/rocket_chat/messages/user.rb

@@ -65,7 +65,7 @@ module RocketChat
         session.request_json(
           '/api/v1/users.delete',
           method: :post,
-          body: user_id ? { userId: user_id } : { username: username },
+          body: user_params(user_id, username),
           upstreamed_errors: ['error-invalid-user']
         )['success']
       end
@@ -81,16 +81,9 @@ module RocketChat
       # @raise [HTTPError, StatusError]
       #
       def list(offset: nil, count: nil, sort: nil, fields: nil, query: nil)
-        body = {}
-        body[:offset] = offset.to_i if offset.is_a? Integer
-        body[:count] = count.to_i if count.is_a? Integer
-        body[:sort] = sort.to_json if sort.is_a? Hash
-        body[:fields] = fields.to_json if fields.is_a? Hash
-        body[:query] = query.to_json if query.is_a? Hash
-
         response = session.request_json(
           '/api/v1/users.list',
-          body: body
+          body: build_list_body(offset, count, sort, fields, query)
         )
 
         response['users'].map { |hash| RocketChat::User.new hash } if response['success']
@@ -106,13 +99,29 @@ module RocketChat
       def info(user_id: nil, username: nil)
         response = session.request_json(
           '/api/v1/users.info',
-          body: user_id ? { userId: user_id } : { username: username },
+          body: user_params(user_id, username),
           upstreamed_errors: ['error-invalid-user']
         )
 
         RocketChat::User.new response['user'] if response['success']
       end
 
+      #
+      # users.getPresence REST API
+      # @param [String] user_id Rocket.Chat user id
+      # @param [String] username Username
+      # @return [PresenceStatus]
+      # @raise [HTTPError, StatusError]
+      #
+      def get_presence(user_id: nil, username: nil)
+        response = session.request_json(
+          '/api/v1/users.getPresence',
+          body: user_params(user_id, username)
+        )
+
+        RocketChat::PresenceStatus.new response if response['success']
+      end
+
       #
       # users.setAvatar REST API
       # @param [String] avatar_url URL to use for avatar
@@ -146,6 +155,26 @@ module RocketChat
         options.each { |key, value| new_hash[Util.camelize(key)] = value }
         new_hash
       end
+
+      def build_list_body(offset, count, sort, fields, query)
+        body = {}
+
+        body[:offset] = offset.to_i if offset.is_a? Integer
+        body[:count] = count.to_i if count.is_a? Integer
+        body[:sort] = sort.to_json if sort.is_a? Hash
+        body[:fields] = fields.to_json if fields.is_a? Hash
+        body[:query] = query.to_json if query.is_a? Hash
+
+        body
+      end
+
+      def user_params(id, username)
+        if id
+          { userId: id }
+        elsif username
+          { username: username }
+        end
+      end
     end
   end
 end

data/lib/rocket_chat/presence_status.rb

@@ -0,0 +1,42 @@
+module RocketChat
+  #
+  # Rocket.Chat PresenceStatus
+  #
+  class PresenceStatus
+    # Raw presence status data
+    attr_reader :data
+
+    #
+    # @param [Hash] data Raw presence status data
+    #
+    def initialize(data)
+      @data = Util.stringify_hash_keys data
+    end
+
+    # Presence
+    def presence
+      data['presence']
+    end
+
+    # Connection status
+    def connection_status
+      data['connectionStatus']
+    end
+
+    # Last login
+    def last_login
+      DateTime.parse data['lastLogin']
+    rescue
+      nil
+    end
+
+    def inspect
+      format(
+        '#<%s:0x%p @presence="%s">',
+        self.class.name,
+        object_id,
+        presence
+      )
+    end
+  end
+end

data/lib/rocketchat.rb

@@ -12,4 +12,5 @@ require 'rocket_chat/server'
 require 'rocket_chat/session'
 require 'rocket_chat/info'
 require 'rocket_chat/token'
+require 'rocket_chat/presence_status'
 require 'rocket_chat/user'

data/rocketchat.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/abrom/rocketchat-ruby'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - int512
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - lib/rocket_chat/gem_version.rb
 - lib/rocket_chat/info.rb
 - lib/rocket_chat/messages/user.rb
+- lib/rocket_chat/presence_status.rb
 - lib/rocket_chat/request_helper.rb
 - lib/rocket_chat/server.rb
 - lib/rocket_chat/session.rb