Fix room (channel/group) online API queries (#38)

These RocketChat APIs were updated to use the more flexible query
syntax in favour of limiting to just room ID and name.

lib/rocket_chat/messages/channel.rb

@@ -46,13 +46,15 @@ def list(offset: nil, count: nil, sort: nil, fields: nil, query: nil)
       #
       # channels.online REST API
       # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name
       # @return [Users[]]
+      # @note Must provide either `room_id` or `name` parameter. `room_id` will take precedence if providing both
       # @raise [HTTPError, StatusError]
       #
       def online(room_id: nil, name: nil)
         response = session.request_json(
           '/api/v1/channels.online',
-          body: room_params(room_id, name)
+          body: { query: room_query_params(room_id, name) }
         )
 
         response['online'].map { |hash| RocketChat::User.new hash } if response['success']

lib/rocket_chat/messages/group.rb

@@ -77,13 +77,15 @@ def list_all(offset: nil, count: nil, sort: nil, fields: nil, query: nil)
       #
       # groups.online REST API
       # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name
       # @return [Users[]]
+      # @note Must provide either `room_id` or `name` parameter. `room_id` will take precedence if providing both
       # @raise [HTTPError, StatusError]
       #
       def online(room_id: nil, name: nil)
         response = session.request_json(
           '/api/v1/groups.online',
-          body: room_params(room_id, name)
+          body: { query: room_query_params(room_id, name) }
         )
 
         response['online'].map { |hash| RocketChat::User.new hash } if response['success']

lib/rocket_chat/messages/room_support.rb

@@ -15,6 +15,16 @@ def room_params(id, name)
           {}
         end
       end
+
+      def room_query_params(id, name)
+        if id
+          { _id: id }
+        elsif name
+          { name: name }
+        else
+          {}
+        end.to_json
+      end
     end
   end
 end

rocketchat.gemspec

@@ -31,10 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', ['>= 1.11', '< 3.0']
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.12'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.10'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.13'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
   spec.add_development_dependency 'simplecov', '~> 0.16', '< 0.18'
   spec.add_development_dependency 'webmock', '~> 3.12'
   spec.add_development_dependency 'yard', '~> 0.9.11'

spec/rocket_chat/messages/channel_spec.rb

@@ -95,15 +95,18 @@
 
     before do
       # Stubs for /api/v1/channels.online REST API
-      stub_unauthed_request :get, described_class.api_path('online?roomName=authed')
+      stub_unauthed_request :get, described_class.api_path('online?query=%7B%22name%22:%22authed%22%7D')
 
-      stub_authed_request(:get, described_class.api_path('online?roomName=wrong-room'))
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22name%22:%22wrong-room%22%7D'))
         .to_return(invalid_room_response)
 
-      stub_authed_request(:get, described_class.api_path('online?roomName=room-one'))
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22name%22:%22room-one%22%7D'))
         .to_return(online_users_response)
 
-      stub_authed_request(:get, described_class.api_path('online?roomName=empty-room'))
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22_id%22:%22TZtANZwQt369rR4UR%22%7D'))
+        .to_return(online_users_response)
+
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22name%22:%22empty-room%22%7D'))
         .to_return(empty_room_response)
     end
 
@@ -131,6 +134,18 @@
       end
     end
 
+    context 'with a valid room id' do
+      it 'returns online users for a filled room' do
+        online_users = scope.online(room_id: 'TZtANZwQt369rR4UR')
+
+        expect(online_users.map(&:class)).to eq [RocketChat::User, RocketChat::User]
+        expect(online_users[0].id).to eq 'rocketID1'
+        expect(online_users[0].username).to eq 'rocketUserName1'
+        expect(online_users[1].id).to eq 'rocketID2'
+        expect(online_users[1].username).to eq 'rocketUserName2'
+      end
+    end
+
     context 'with an invalid session token' do
       let(:token) { RocketChat::Token.new(authToken: nil, groupId: nil) }
 

spec/rocket_chat/messages/group_spec.rb

@@ -251,15 +251,18 @@
 
     before do
       # Stubs for /api/v1/groups.online REST API
-      stub_unauthed_request :get, described_class.api_path('online?roomName=authed')
+      stub_unauthed_request :get, described_class.api_path('online?query=%7B%22name%22:%22authed%22%7D')
 
-      stub_authed_request(:get, described_class.api_path('online?roomName=wrong-room'))
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22name%22:%22wrong-room%22%7D'))
         .to_return(invalid_room_response)
 
-      stub_authed_request(:get, described_class.api_path('online?roomName=room-one'))
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22name%22:%22room-one%22%7D'))
         .to_return(online_users_response)
 
-      stub_authed_request(:get, described_class.api_path('online?roomName=empty-room'))
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22_id%22:%22TZtANZwQt369rR4UR%22%7D'))
+        .to_return(online_users_response)
+
+      stub_authed_request(:get, described_class.api_path('online?query=%7B%22name%22:%22empty-room%22%7D'))
         .to_return(empty_room_response)
     end
 
@@ -287,6 +290,18 @@
       end
     end
 
+    context 'with a valid room id' do
+      it 'returns online users for a filled room' do
+        online_users = scope.online(room_id: 'TZtANZwQt369rR4UR')
+
+        expect(online_users.map(&:class)).to eq [RocketChat::User, RocketChat::User]
+        expect(online_users[0].id).to eq 'rocketID1'
+        expect(online_users[0].username).to eq 'rocketUserName1'
+        expect(online_users[1].id).to eq 'rocketID2'
+        expect(online_users[1].username).to eq 'rocketUserName2'
+      end
+    end
+
     context 'with an invalid session token' do
       let(:token) { RocketChat::Token.new(authToken: nil, groupId: nil) }
 

spec/shared/room_behaviors.rb

@@ -17,8 +17,8 @@
     }
   end
   let(:invalid_room_message) do
-    %(The required "roomId" or "roomName" param provided does not match any #{described_class.field}) \
-      ' [error-room-not-found]'
+    %(The required "roomId" or "roomName" param provided does not match any #{described_class.field} ) \
+      '[error-room-not-found]'
   end
   let(:invalid_room_body) do
     {