rocketchat 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5f446da6cb7e901ef27edc15d4294fdb1db3a7c6386c35aeec2acbf513a2246
-  data.tar.gz: 19bda5415f803dd4a7cf7bc05ec2ec1fcf925d364e55068f0d7630d28e5da190
+  metadata.gz: 0414d925c282330700662c6a617328a2c91610c5969285da247c653a1b512133
+  data.tar.gz: db1fab6b741dd083488e1a1b60f36fff5130e5cff10ee88ed2847ef4853cee14
 SHA512:
-  metadata.gz: d9c94588357cbeb32f18afe79b3439bded7fc8191b31627a440288642842d971119591cdf47e981836c7ea8b3d4ff76ed36040701b6c0fb24d33e9e7a349ef1a
-  data.tar.gz: b14f92c34a2b9a6f17d4da573b793268b3c8f83590326b5faca1e1d6b0b4ebba5bbdea73c1ea5bcc406aa5a729988ac6eb230359f1fbbb8de23b2694b60bc652
+  metadata.gz: 002475521b99ee9dcc766622ed1630c08daf488ba68c0f10dd620b568882b022aace8e79a6f2419b8fa6d8780290ea2df442b1537118d97415ca759cb53254bc
+  data.tar.gz: 6f896d0c30470e16702567320ed083c63d6cce9325734295bfd553d710f8669bfd11148d79c590a89465ba06f0e7be870c02679ddab01d60858be9af6ab7b9bb

data/.rubocop.yml

@@ -47,6 +47,9 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Max: 15
 
+RSpec/NestedGroups:
+  Max: 4
+
 Style/ExponentialNotation:
   Enabled: true
 
@@ -63,6 +66,9 @@ Style/NumericLiterals:
   Exclude:
     - "**/*_spec.rb"
 
+Style/RedundantFetchBlock:
+  Enabled: true
+
 Style/RedundantRegexpCharacterClass:
   Enabled: true
 

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Unreleased
 - None
 
+## [0.1.21](releases/tag/v0.1.21) - 2021-08-30
+### Added
+- [#36] Improve support for various REST APIs ([@abrom][])
+
 ## [0.1.20](releases/tag/v0.1.20) - 2021-03-29
 ### Added
 - [#34] Support for channels.members and groups.members ([@alinavancea][])

data/lib/rocket_chat/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RocketChat
-  VERSION = '0.1.20'
+  VERSION = '0.1.21'
 end

data/lib/rocket_chat/messages/group.rb

@@ -57,6 +57,38 @@ module RocketChat
         response['groups'].map { |hash| RocketChat::Room.new hash } if response['success']
       end
 
+      # groups.listAll REST API
+      # @param [Integer] offset Query offset
+      # @param [Integer] count Query count/limit
+      # @param [Hash] sort Query field sort hash. eg `{ msgs: 1, name: -1 }`
+      # @param [Hash] fields Query fields to return. eg `{ name: 1, ro: 0 }`
+      # @return [Room[]]
+      # @raise [HTTPError, StatusError]
+      #
+      def list_all(offset: nil, count: nil, sort: nil, fields: nil, query: nil)
+        response = session.request_json(
+          '/api/v1/groups.listAll',
+          body: build_list_body(offset, count, sort, fields, query)
+        )
+
+        response['groups'].map { |hash| RocketChat::Room.new hash } if response['success']
+      end
+
+      #
+      # groups.online REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @return [Users[]]
+      # @raise [HTTPError, StatusError]
+      #
+      def online(room_id: nil, name: nil)
+        response = session.request_json(
+          '/api/v1/groups.online',
+          body: room_params(room_id, name)
+        )
+
+        response['online'].map { |hash| RocketChat::User.new hash } if response['success']
+      end
+
       # Keys for set_attr:
       # * [String] description A room's description
       # * [String] purpose Alias for description

data/lib/rocket_chat/messages/im.rb

@@ -6,6 +6,8 @@ module RocketChat
     # Rocket.Chat Direct messages
     #
     class Im
+      include ListSupport
+
       #
       # @param [Session] session Session
       #
@@ -16,18 +18,63 @@ module RocketChat
       #
       # im.create REST API
       # @param [String] username Rocket.Chat username
+      # @param [String[]] usernames Array of Rocket.Chat usernames
+      # @param [Boolean] exclude_self Flag indicating whether the authenticated user should be included in the group
       # @return [RocketChat::Room]
       # @raise [HTTPError, StatusError]
       #
-      def create(username:)
+      def create(username: nil, usernames: nil, exclude_self: false)
+        params =
+          if exclude_self
+            { usernames: usernames.join(','), excludeSelf: true }
+          elsif usernames
+            { usernames: usernames.join(',') }
+          else
+            { username: username }
+          end
+
         response = session.request_json(
           '/api/v1/im.create',
           method: :post,
-          body: { username: username }
+          body: params
         )
         RocketChat::Room.new response['room']
       end
 
+      #
+      # im.delete REST API
+      # @param [String] room_id Rocket.Chat direct message room ID
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def delete(room_id: nil)
+        session.request_json(
+          '/api/v1/im.delete',
+          method: :post,
+          body: { roomId: room_id },
+          upstreamed_errors: ['error-room-not-found']
+        )['success']
+      end
+
+      #
+      # im.list.everyone REST API
+      # @param [Integer] offset Query offset
+      # @param [Integer] count Query count/limit
+      # @param [Hash] sort Query field sort hash. eg `{ msgs: 1, name: -1 }`
+      # @param [Hash] fields Query fields to return. eg `{ name: 1, ro: 0 }`
+      # @param [Hash] query The query. `{ active: true, type: { '$in': ['name', 'general'] } }`
+      # @return [Room[]]
+      # @raise [HTTPError, StatusError]
+      #
+      def list_everyone(offset: nil, count: nil, sort: nil, fields: nil, query: nil)
+        response = session.request_json(
+          '/api/v1/im.list.everyone',
+          body: build_list_body(offset, count, sort, fields, query)
+        )
+
+        response['ims'].map { |hash| RocketChat::Room.new hash } if response['success']
+      end
+
       #
       # im.counters REST API
       # @param [String] room_id Rocket.Chat roomId

data/lib/rocket_chat/messages/user.rb

@@ -114,13 +114,16 @@ module RocketChat
       # users.info REST API
       # @param [String] user_id Rocket.Chat user id
       # @param [String] username Username
+      # @param [Boolean] include_rooms Whether to include rooms in the response.
+      #                                Requires calling user to have the `view-other-user-channels` permission
       # @return [User]
       # @raise [HTTPError, StatusError]
       #
-      def info(user_id: nil, username: nil)
+      def info(user_id: nil, username: nil, include_rooms: false)
         response = session.request_json(
           '/api/v1/users.info',
-          body: user_params(user_id, username),
+          body: user_params(user_id, username)
+            .merge(include_rooms ? { fields: { userRooms: 1 }.to_json } : {}),
           upstreamed_errors: ['error-invalid-user']
         )
 

data/lib/rocket_chat/user.rb

@@ -70,6 +70,21 @@ module RocketChat
       data['roles']
     end
 
+    # User rooms
+    def rooms
+      return [] unless data['rooms'].is_a? Array
+
+      data['rooms'].map do |hash|
+        # the users.info API returns the rooms data with the subscription ID as `_id` and room ID as `rid`
+        if hash['rid']
+          hash['subscription_id'] = hash['_id']
+          hash['_id'] = hash['rid']
+        end
+
+        RocketChat::Room.new hash
+      end
+    end
+
     def inspect
       format(
         '#<%<class_name>s:0x%<object_id>p @id="%<id>s" @username="%<username>s" @active="%<active>s">',

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - int512
 - abrom
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,7 +204,7 @@ homepage: https://github.com/abrom/rocketchat-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.0.6
+signing_key: 
 specification_version: 4
 summary: Rocket.Chat REST API v1 for Ruby
 test_files: []