slack-ruby-client 0.9.1 → 0.10.0

data/spec/slack/real_time/concurrency/celluloid_spec.rb

@@ -7,45 +7,55 @@ begin
     context 'with url' do
       let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
       let(:logger) { ::Logger.new(STDOUT) }
-      let(:test_socket) do
-        Class.new(described_class) do
-          def read
-            fail EOFError
+
+      [EOFError, Errno::EPIPE].each do |err|
+        context "finishing run_loop with #{err}" do
+          let(:test_socket) do
+            Class.new(described_class) do
+              def read
+                fail options[:err]
+              end
+            end
           end
-        end
-      end
-      let(:socket) { test_socket.new(url, ping: 42, logger: logger) }
-      let(:driver) { WebSocket::Driver::Client }
-      let(:ws) { double(driver) }
-      subject { socket }
-
-      describe '#connect!' do
-        pending 'connects'
-        pending 'pings every 30s'
-      end
 
-      context 'with a driver' do
-        before do
-          socket.instance_variable_set('@driver', ws)
-        end
+          let(:socket) do
+            test_socket.new(url, ping: 42, logger: logger, err: err)
+          end
 
-        describe '#disconnect!' do
-          it 'closes and nils the websocket' do
-            expect(ws).to receive(:close)
-            socket.disconnect!
+          let(:driver) { WebSocket::Driver::Client }
+          let(:ws) { double(driver) }
+          subject { socket }
+
+          describe '#connect!' do
+            pending 'connects'
+            pending 'pings every 30s'
           end
-        end
 
-        describe '#run_loop' do
-          it 'runs' do
-            expect(ws).to receive(:emit)
-            expect(ws).to receive(:start)
-            socket.run_loop
+          context 'with a driver' do
+            before do
+              socket.instance_variable_set('@driver', ws)
+            end
+
+            describe '#disconnect!' do
+              it 'closes and nils the websocket' do
+                expect(ws).to receive(:close)
+                socket.disconnect!
+              end
+            end
+
+            context 'consumes data' do
+              it 'runs' do
+                expect(ws).to receive(:emit)
+                expect(ws).to receive(:start)
+                expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
+                socket.run_loop
+              end
+            end
           end
+
+          pending 'send_data'
         end
       end
-
-      pending 'send_data'
     end
   end
 rescue LoadError

data/spec/slack/web/api/endpoints/conversations_spec.rb

@@ -0,0 +1,100 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::Conversations do
+  let(:client) { Slack::Web::Client.new }
+  context 'conversations_archive' do
+    it 'requires channel' do
+      expect { client.conversations_archive }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_close' do
+    it 'requires channel' do
+      expect { client.conversations_close }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_create' do
+    it 'requires name' do
+      expect { client.conversations_create }.to raise_error ArgumentError, /Required arguments :name missing/
+    end
+  end
+  context 'conversations_history' do
+    it 'requires channel' do
+      expect { client.conversations_history }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_info' do
+    it 'requires channel' do
+      expect { client.conversations_info }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_invite' do
+    it 'requires channel' do
+      expect { client.conversations_invite(users: 'W1234567890,U2345678901,U3456789012') }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+    it 'requires users' do
+      expect { client.conversations_invite(channel: 'C1234567890') }.to raise_error ArgumentError, /Required arguments :users missing/
+    end
+  end
+  context 'conversations_join' do
+    it 'requires channel' do
+      expect { client.conversations_join }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_kick' do
+    it 'requires channel' do
+      expect { client.conversations_kick(user: 'W1234567890') }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+    it 'requires user' do
+      expect { client.conversations_kick(channel: 'C1234567890') }.to raise_error ArgumentError, /Required arguments :user missing/
+    end
+  end
+  context 'conversations_leave' do
+    it 'requires channel' do
+      expect { client.conversations_leave }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_members' do
+    it 'requires channel' do
+      expect { client.conversations_members }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+  context 'conversations_rename' do
+    it 'requires channel' do
+      expect { client.conversations_rename(name: ' ') }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+    it 'requires name' do
+      expect { client.conversations_rename(channel: 'C1234567890') }.to raise_error ArgumentError, /Required arguments :name missing/
+    end
+  end
+  context 'conversations_replies' do
+    it 'requires channel' do
+      expect { client.conversations_replies(ts: '1234567890.123456') }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+    it 'requires ts' do
+      expect { client.conversations_replies(channel: 'C1234567890') }.to raise_error ArgumentError, /Required arguments :ts missing/
+    end
+  end
+  context 'conversations_setPurpose' do
+    it 'requires channel' do
+      expect { client.conversations_setPurpose(purpose: 'My More Special Purpose') }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+    it 'requires purpose' do
+      expect { client.conversations_setPurpose(channel: 'C1234567890') }.to raise_error ArgumentError, /Required arguments :purpose missing/
+    end
+  end
+  context 'conversations_setTopic' do
+    it 'requires channel' do
+      expect { client.conversations_setTopic(topic: 'Apply topically for best effects') }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+    it 'requires topic' do
+      expect { client.conversations_setTopic(channel: 'C1234567890') }.to raise_error ArgumentError, /Required arguments :topic missing/
+    end
+  end
+  context 'conversations_unarchive' do
+    it 'requires channel' do
+      expect { client.conversations_unarchive }.to raise_error ArgumentError, /Required arguments :channel missing/
+    end
+  end
+end

data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb

@@ -9,6 +9,14 @@ RSpec.describe Slack::Web::Api::Endpoints::Users do
       expect(json.members.size).to eq 9
       expect(json.members.first.presence).to eq 'away'
     end
+    it 'list', vcr: { cassette_name: 'web/paginated_users_list' } do
+      members = []
+      client.users_list(presence: true, limit: 5) do |json|
+        expect(json.ok).to be true
+        members.concat json.members
+      end
+      expect(members.size).to eq 23
+    end
     it 'info', vcr: { cassette_name: 'web/users_info' } do
       json = client.users_info(user: '@aws')
       expect(json.user.name).to eq 'aws'

data/spec/slack/web/api/pagination/cursor_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Pagination::Cursor do
+  let(:client) { Slack::Web::Client.new }
+  context 'default cursor' do
+    let(:cursor) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', {}) }
+    it 'provides a default limit' do
+      expect(client).to receive(:users_list).with(limit: 100, cursor: nil)
+      cursor.first
+    end
+    it 'handles blank response metadata' do
+      expect(client).to receive(:users_list).once.and_return(Slack::Messages::Message.new)
+      cursor.to_a
+    end
+    it 'handles nil response metadata' do
+      expect(client).to receive(:users_list).once.and_return(Slack::Messages::Message.new(response_metadata: nil))
+      cursor.to_a
+    end
+    it 'paginates with a cursor inside response metadata' do
+      expect(client).to receive(:users_list).twice.and_return(
+        Slack::Messages::Message.new(response_metadata: { next_cursor: 'next' }),
+        Slack::Messages::Message.new
+      )
+      expect(cursor).not_to receive(:sleep)
+      cursor.to_a
+    end
+    context 'with rate limiting' do
+      let(:error) { Slack::Web::Api::Errors::TooManyRequestsError.new(nil) }
+      context 'with default max retries' do
+        it 'sleeps after a TooManyRequestsError' do
+          expect(client).to receive(:users_list).with(limit: 100, cursor: nil).ordered.and_return(Slack::Messages::Message.new(response_metadata: { next_cursor: 'next' }))
+          expect(client).to receive(:users_list).with(limit: 100, cursor: 'next').ordered.and_raise(error)
+          expect(error).to receive(:retry_after).once.ordered.and_return(9)
+          expect(cursor).to receive(:sleep).once.ordered.with(9)
+          expect(client).to receive(:users_list).with(limit: 100, cursor: 'next').ordered.and_return(Slack::Messages::Message.new)
+          cursor.to_a
+        end
+      end
+      context 'with a custom max_retries' do
+        let(:cursor) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', max_retries: 4) }
+        it 'raises the error after hitting the max retries' do
+          expect(client).to receive(:users_list).with(limit: 100, cursor: nil).and_return(Slack::Messages::Message.new(response_metadata: { next_cursor: 'next' }))
+          expect(client).to receive(:users_list).with(limit: 100, cursor: 'next').exactly(5).times.and_raise(error)
+          expect(error).to receive(:retry_after).exactly(4).times.and_return(9)
+          expect(cursor).to receive(:sleep).exactly(4).times.with(9)
+          expect { cursor.to_a }.to raise_error(error)
+        end
+      end
+    end
+  end
+  context 'with a custom limit' do
+    let(:cursor) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', limit: 42) }
+    it 'overrides default limit' do
+      expect(client).to receive(:users_list).with(limit: 42, cursor: nil)
+      cursor.first
+    end
+  end
+  context 'with a custom sleep_interval' do
+    let(:cursor) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', sleep_interval: 3) }
+    it 'sleeps between requests' do
+      expect(client).to receive(:users_list).exactly(3).times.and_return(
+        Slack::Messages::Message.new(response_metadata: { next_cursor: 'next_a' }),
+        Slack::Messages::Message.new(response_metadata: { next_cursor: 'next_b' }),
+        Slack::Messages::Message.new
+      )
+      expect(cursor).to receive(:sleep).with(3).twice
+      cursor.to_a
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,6 +235,7 @@ files:
 - bin/commands/bots.rb
 - bin/commands/channels.rb
 - bin/commands/chat.rb
+- bin/commands/conversations.rb
 - bin/commands/dnd.rb
 - bin/commands/emoji.rb
 - bin/commands/files.rb
@@ -311,6 +312,7 @@ files:
 - lib/slack/web/api/endpoints/bots.rb
 - lib/slack/web/api/endpoints/channels.rb
 - lib/slack/web/api/endpoints/chat.rb
+- lib/slack/web/api/endpoints/conversations.rb
 - lib/slack/web/api/endpoints/dnd.rb
 - lib/slack/web/api/endpoints/emoji.rb
 - lib/slack/web/api/endpoints/files.rb
@@ -361,6 +363,7 @@ files:
 - lib/slack/web/faraday/connection.rb
 - lib/slack/web/faraday/request.rb
 - lib/slack/web/faraday/response/raise_error.rb
+- lib/slack/web/pagination/cursor.rb
 - lib/slack_ruby_client.rb
 - lib/tasks/git.rake
 - lib/tasks/real_time.rake
@@ -374,6 +377,7 @@ files:
 - spec/fixtures/slack/web/auth_test_success.yml
 - spec/fixtures/slack/web/channels_info.yml
 - spec/fixtures/slack/web/groups_info.yml
+- spec/fixtures/slack/web/paginated_users_list.yml
 - spec/fixtures/slack/web/rtm_connect.yml
 - spec/fixtures/slack/web/rtm_start.yml
 - spec/fixtures/slack/web/users_info.yml
@@ -403,6 +407,7 @@ files:
 - spec/slack/web/api/endpoints/api_spec.rb
 - spec/slack/web/api/endpoints/apps_permissions_spec.rb
 - spec/slack/web/api/endpoints/bots_spec.rb
+- spec/slack/web/api/endpoints/conversations_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/auth_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/channels_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/chat_spec.rb
@@ -431,6 +436,7 @@ files:
 - spec/slack/web/api/mixins/channels_spec.rb
 - spec/slack/web/api/mixins/groups_spec.rb
 - spec/slack/web/api/mixins/users_spec.rb
+- spec/slack/web/api/pagination/cursor_spec.rb
 - spec/slack/web/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/queue_with_timeout.rb
@@ -459,7 +465,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Slack Web and RealTime API client.
@@ -469,6 +475,7 @@ test_files:
 - spec/fixtures/slack/web/auth_test_success.yml
 - spec/fixtures/slack/web/channels_info.yml
 - spec/fixtures/slack/web/groups_info.yml
+- spec/fixtures/slack/web/paginated_users_list.yml
 - spec/fixtures/slack/web/rtm_connect.yml
 - spec/fixtures/slack/web/rtm_start.yml
 - spec/fixtures/slack/web/users_info.yml
@@ -498,6 +505,7 @@ test_files:
 - spec/slack/web/api/endpoints/api_spec.rb
 - spec/slack/web/api/endpoints/apps_permissions_spec.rb
 - spec/slack/web/api/endpoints/bots_spec.rb
+- spec/slack/web/api/endpoints/conversations_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/auth_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/channels_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/chat_spec.rb
@@ -526,6 +534,7 @@ test_files:
 - spec/slack/web/api/mixins/channels_spec.rb
 - spec/slack/web/api/mixins/groups_spec.rb
 - spec/slack/web/api/mixins/users_spec.rb
+- spec/slack/web/api/pagination/cursor_spec.rb
 - spec/slack/web/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/queue_with_timeout.rb