slack-ruby-client 0.7.2 → 1.0.0

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::TeamBilling do
+  let(:client) { Slack::Web::Client.new }
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::TeamPreferences do
+  let(:client) { Slack::Web::Client.new }
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::TeamProfile do
+  let(:client) { Slack::Web::Client.new }
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 require 'spec_helper'

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::ToolingTokens do
+  let(:client) { Slack::Web::Client.new }
+  context 'tooling.tokens_rotate' do
+    it 'requires refresh_token' do
+      expect { client.tooling_tokens_rotate }.to raise_error ArgumentError, /Required arguments :refresh_token missing/
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 require 'spec_helper'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 require 'spec_helper'
@@ -11,10 +12,10 @@ RSpec.describe Slack::Web::Api::Endpoints::UsergroupsUsers do
   end
   context 'usergroups.users_update' do
     it 'requires usergroup' do
-      expect { client.usergroups_users_update(users: 'U060R4BJ4,U060RNRCZ') }.to raise_error ArgumentError, /Required arguments :usergroup missing/
+      expect { client.usergroups_users_update(users: %q[]) }.to raise_error ArgumentError, /Required arguments :usergroup missing/
     end
     it 'requires users' do
-      expect { client.usergroups_users_update(usergroup: 'S0604QSJC') }.to raise_error ArgumentError, /Required arguments :users missing/
+      expect { client.usergroups_users_update(usergroup: %q[]) }.to raise_error ArgumentError, /Required arguments :users missing/
     end
   end
 end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::UsersAdmin do
+  let(:client) { Slack::Web::Client.new }
+  context 'users.admin_invite' do
+    it 'requires email' do
+      expect { client.users_admin_invite }.to raise_error ArgumentError, /Required arguments :email missing/
+    end
+  end
+  context 'users.admin_setInactive' do
+    it 'requires user' do
+      expect { client.users_admin_setInactive }.to raise_error ArgumentError, /Required arguments :user missing/
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::UsersPrefs do
+  let(:client) { Slack::Web::Client.new }
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::UsersProfile do
+  let(:client) { Slack::Web::Client.new }
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::Workflows do
+  let(:client) { Slack::Web::Client.new }
+  context 'workflows_stepCompleted' do
+    it 'requires workflow_step_execute_id' do
+      expect { client.workflows_stepCompleted }.to raise_error ArgumentError, /Required arguments :workflow_step_execute_id missing/
+    end
+  end
+  context 'workflows_stepFailed' do
+    it 'requires error' do
+      expect { client.workflows_stepFailed(workflow_step_execute_id: %q[]) }.to raise_error ArgumentError, /Required arguments :error missing/
+    end
+    it 'requires workflow_step_execute_id' do
+      expect { client.workflows_stepFailed(error: %q[]) }.to raise_error ArgumentError, /Required arguments :workflow_step_execute_id missing/
+    end
+  end
+  context 'workflows_updateStep' do
+    it 'requires workflow_step_edit_id' do
+      expect { client.workflows_updateStep }.to raise_error ArgumentError, /Required arguments :workflow_step_edit_id missing/
+    end
+  end
+end

data/spec/slack/web/api/error_spec.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Error do
   let(:client) { Slack::Web::Client.new }
+
   it 'provides access to the response object', vcr: { cassette_name: 'web/auth_test_error' } do
-    begin
-      client.auth_test
-      fail 'Expected to receive Slack::Web::Api::Error.'
-    rescue Slack::Web::Api::Error => e
-      expect(e.response).to_not be_nil
-      expect(e.response.status).to eq 200
-    end
+    client.auth_test
+    raise 'Expected to receive Slack::Web::Api::Error.'
+  rescue described_class => e
+    expect(e.response).not_to be_nil
+    expect(e.response.status).to eq 200
   end
 end

data/spec/slack/web/api/errors/slack_error_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Errors::SlackError do
+  let(:client) { Slack::Web::Client.new }
+
+  it 'provides access to the response object', vcr: { cassette_name: 'web/auth_test_error' } do
+    client.auth_test
+    raise 'Expected to receive Slack::Web::Api::Errors::SlackError.'
+  rescue described_class => e
+    expect(e.response).not_to be_nil
+    expect(e.response.status).to eq 200
+    expect(e.message).to eql 'not_authed'
+    expect(e.error).to eql 'not_authed'
+    expect(e.response_metadata).to be_nil
+  end
+
+  it 'provides access to any response_metadata', vcr: { cassette_name: 'web/views_open_error' } do
+    client.views_open(trigger_id: 'trigger_id', view: {})
+    raise 'Expected to receive Slack::Web::Api::Errors::SlackError.'
+  rescue described_class => e
+    expect(e.response).not_to be_nil
+    expect(e.response.status).to eq 200
+    expect(e.message).to eql 'invalid_arguments'
+    expect(e.error).to eql 'invalid_arguments'
+    expect(e.response_metadata).to eq(
+      'messages' => [
+        '[ERROR] failed to match all allowed schemas [json-pointer:/view]',
+        '[ERROR] missing required field: type [json-pointer:/view]'
+      ]
+    )
+  end
+end

data/spec/slack/web/api/mixins/conversations_list_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Client do
+  context 'conversations_setTopic' do
+    it 'does not invoke conversations_list', vcr: { cassette_name: 'web/conversations_setTopic' } do
+      rc = subject.conversations_setTopic({ channel: 'C019CV63UTC', topic: 'new topic' })
+      expect(rc.channel.topic.value).to eq 'new topic'
+    end
+
+    it 'resolves IDs via conversations_list', vcr: { cassette_name: 'web/conversations_setTopic_one_page' } do
+      rc = subject.conversations_setTopic({ channel: '#1', topic: 'new topic' })
+      expect(rc.channel.topic.value).to eq 'new topic'
+    end
+
+    it 'paginates to resolve IDs', vcr: { cassette_name: 'web/conversations_setTopic_paginated' } do
+      rc = subject.conversations_setTopic({ channel: '#topic', topic: 'new topic' })
+      expect(rc.channel.topic.value).to eq 'new topic'
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Mixins::Conversations do
+  subject(:conversations) do
+    klass.new
+  end
+
+  let(:klass) do
+    Class.new do
+      include Slack::Web::Api::Mixins::Conversations
+    end
+  end
+
+  before do
+    allow(conversations).to receive(:conversations_list).and_yield(
+      Slack::Messages::Message.new(
+        'channels' => [{
+          'id' => 'CDEADBEEF',
+          'name' => 'general'
+        }]
+      )
+    )
+  end
+
+  describe '#conversations_id' do
+    it 'leaves channels specified by ID alone' do
+      expect(conversations.conversations_id(channel: 'C123456')).to(
+        eq('ok' => true, 'channel' => { 'id' => 'C123456' })
+      )
+    end
+    it 'translates a channel that starts with a #' do
+      expect(conversations.conversations_id(channel: '#general')).to(
+        eq('ok' => true, 'channel' => { 'id' => 'CDEADBEEF' })
+      )
+    end
+    it 'fails with an exception' do
+      expect { conversations.conversations_id(channel: '#invalid') }.to(
+        raise_error(Slack::Web::Api::Errors::SlackError, 'channel_not_found')
+      )
+    end
+  end
+end

data/spec/slack/web/api/mixins/users_spec.rb

@@ -1,37 +1,50 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Mixins::Users do
+  subject(:users) do
+    klass.new
+  end
+
   let(:klass) do
     Class.new do
       include Slack::Web::Api::Mixins::Users
     end
   end
-  subject do
-    klass.new
-  end
+
   before do
-    allow(subject).to receive(:users_list).and_return(Slack::Messages::Message.new(
-                                                        'members' => [{
-                                                          'id' => 'UDEADBEEF',
-                                                          'name' => 'aws',
-                                                          'profile' => {}
-                                                        }]
-    ))
+    allow(users).to receive(:users_list).and_yield(
+      Slack::Messages::Message.new(
+        'members' => [{
+          'id' => 'UDEADBEEF',
+          'name' => 'aws',
+          'profile' => {}
+        }]
+      )
+    )
   end
+
   context '#users_id' do
     it 'leaves users specified by ID alone' do
-      expect(subject.users_id(user: 'U123456')).to eq('ok' => true, 'user' => { 'id' => 'U123456' })
+      expect(users.users_id(user: 'U123456')).to eq('ok' => true, 'user' => { 'id' => 'U123456' })
     end
     it 'translates a user that starts with a #' do
-      expect(subject.users_id(user: '@aws')).to eq('ok' => true, 'user' => { 'id' => 'UDEADBEEF' })
+      expect(users.users_id(user: '@aws')).to eq('ok' => true, 'user' => { 'id' => 'UDEADBEEF' })
     end
     it 'fails with an exception' do
-      expect { subject.users_id(user: '@foo') }.to raise_error Slack::Web::Api::Error, 'user_not_found'
+      expect { users.users_id(user: '@foo') }.to(
+        raise_error(Slack::Web::Api::Errors::SlackError, 'user_not_found')
+      )
     end
   end
-  context '#users_search' do
-    it 'finds a user' do
-      expect(subject.users_search(user: 'aws')).to eq('ok' => true, 'members' => [{ 'id' => 'UDEADBEEF', 'name' => 'aws', 'profile' => {} }])
+
+  if defined?(Picky)
+    context '#users_search' do
+      it 'finds a user' do
+        expect(users.users_search(user: 'aws')).to(
+          eq('ok' => true, 'members' => [{ 'id' => 'UDEADBEEF', 'name' => 'aws', 'profile' => {} }])
+        )
+      end
     end
-  end if defined?(Picky)
+  end
 end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Pagination::Cursor do
+  let(:client) { Slack::Web::Client.new }
+
+  context 'default cursor' do
+    let(:cursor) { described_class.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(OpenStruct.new(headers: { 'retry-after' => 9 })) }
+
+      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(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) { described_class.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(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) { described_class.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) { described_class.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