rocketchat 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f9a112c5cf656264bbe91bad91ee9e23179ed22
-  data.tar.gz: 9a77fb3eebaec176d585702b360b605c998e7ccf
+  metadata.gz: 6ff674c069b6c5cc2bb466966c996007d1cc286b
+  data.tar.gz: 2d8ba00018c162adea4a1a7204419aa52c3fdb61
 SHA512:
-  metadata.gz: 126d2db13b2fa89806af8547acfd56da801900535b6ba40b4ec1b417379503b74d39c40eaedd6f21475a8e8450deee20d2041330ae1261c87c36e2b48b40b76c
-  data.tar.gz: 93dfc3721073de047dd2bd5680c7c3ef8200d9d066b2a6bc0b7a60fc1bf308266711c127d4eead3d3c1b65029caa77d9eaded608e4693722c636d5d0bd32bbbc
+  metadata.gz: 40935960e7f75f53ae5eeb87608f2e232e6e837e7b1cb24247ed94f2b54cebcba1685ad9b4c7ef6d6892217727624985eef57a287d2c7041856833458a6ba3d3
+  data.tar.gz: fb0484eae8d74644066810a156ce8cc1b2adeb7ddf001f855362d92469f18d168bca08815877e5bed8d06816a8a0327d5bc9372d305600481379ea3167174ad9

data/README.md

@@ -75,7 +75,7 @@ require 'rocketchat'
 
 rocket_server = RocketChat::Server.new('http://your.server.address/')
 session = rocket_server.login('username', 'password')
-session.users.create('new_username', 'user@example.com', 'New User', '123456',
+user = session.users.create('new_username', 'user@example.com', 'New User', '123456',
                      active: true, send_welcome_email: false)
 ```
 
@@ -91,7 +91,7 @@ require 'rocketchat'
 
 rocket_server = RocketChat::Server.new('http://your.server.address/')
 session = rocket_server.login('username', 'password')
-session.users.update('LAjzCDLqggCT7B82M',
+user = session.users.update('LAjzCDLqggCT7B82M',
   email: 'updated@example.com',
   name: 'Updated Name',
   roles: ['user', 'moderator']
@@ -110,12 +110,23 @@ require 'rocketchat'
 
 rocket_server = RocketChat::Server.new('http://your.server.address/')
 session = rocket_server.login('username', 'password')
-session.users.info(username: 'some_username')
+user = session.users.info(username: 'some_username')
 ```
 
 Either user_id (RocketChat's ID) or username can be used.
 
-Deleting a user can be done with the same options.
+
+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:
@@ -125,7 +136,7 @@ require 'rocketchat'
 
 rocket_server = RocketChat::Server.new('http://your.server.address/')
 session = rocket_server.login('username', 'password')
-session.users.set_avatar('http://image_url')
+success = session.users.set_avatar('http://image_url')
 ```
 
 There is an optional parameter user_id, that works if the setting user is allowed to set other's avatar.

data/lib/rocket_chat/gem_version.rb

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

data/lib/rocket_chat/messages/user.rb

@@ -70,6 +70,32 @@ module RocketChat
         )['success']
       end
 
+      #
+      # users.list REST API
+      # @param [Integer] offset Query offset
+      # @param [Integer] count Query count/limit
+      # @param [Hash] sort Query field sort hash. eg `{ active: 1, email: -1 }`
+      # @param [Hash] fields Query fields to return. eg `{ name: 1, email: 0 }`
+      # @param [Hash] query The query. `{ active: true, type: { $in: ['user', 'bot'] } }`
+      # @return [User[]]
+      # @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
+        )
+
+        response['users'].map { |hash| RocketChat::User.new hash } if response['success']
+      end
+
       #
       # users.info REST API
       # @param [String] user_id Rocket.Chat user id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - int512
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler