slack-ruby-client 0.13.0 → 0.17.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 require 'spec_helper'
@@ -6,10 +7,10 @@ RSpec.describe Slack::Web::Api::Endpoints::Reminders do
   let(:client) { Slack::Web::Client.new }
   context 'reminders_add' do
     it 'requires text' do
-      expect { client.reminders_add(time: '1602288000') }.to raise_error ArgumentError, /Required arguments :text missing/
+      expect { client.reminders_add(time: %q[1602288000]) }.to raise_error ArgumentError, /Required arguments :text missing/
     end
     it 'requires time' do
-      expect { client.reminders_add(text: 'eat a banana') }.to raise_error ArgumentError, /Required arguments :time missing/
+      expect { client.reminders_add(text: %q[eat a banana]) }.to raise_error ArgumentError, /Required arguments :time missing/
     end
   end
   context 'reminders_complete' do

data/spec/slack/web/api/endpoints/rtm_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/search_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/stars_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/team_profile_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/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/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[U060R4BJ4,U060RNRCZ]) }.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[S0604QSJC]) }.to raise_error ArgumentError, /Required arguments :users missing/
     end
   end
 end

data/spec/slack/web/api/endpoints/users_admin_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/users_prefs_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/users_profile_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/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,13 +1,15 @@
+# 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
       raise 'Expected to receive Slack::Web::Api::Error.'
-    rescue Slack::Web::Api::Error => e
-      expect(e.response).to_not be_nil
+    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

@@ -1,14 +1,38 @@
+# 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
     begin
       client.auth_test
       raise 'Expected to receive Slack::Web::Api::Errors::SlackError.'
-    rescue Slack::Web::Api::Errors::SlackError => e
-      expect(e.response).to_not be_nil
+    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
+  end
+
+  it 'provides access to any response_metadata', vcr: { cassette_name: 'web/views_open_error' } do
+    begin
+      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] missing required field: title [json-pointer:\/view]",
+          "[ERROR] missing required field: blocks [json-pointer:\/view]",
+          "[ERROR] missing required field: type [json-pointer:\/view]"
+        ]
+      )
     end
   end
 end

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

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Mixins::Channels do
+  subject(:channels) do
+    klass.new
+  end
+
   let(:klass) do
     Class.new do
       include Slack::Web::Api::Mixins::Channels
     end
   end
-  subject do
-    klass.new
-  end
+
   before do
-    allow(subject).to receive(:channels_list).and_return(
+    allow(channels).to receive(:channels_list).and_yield(
       Slack::Messages::Message.new(
         'channels' => [{
           'id' => 'CDEADBEEF',
@@ -19,15 +22,22 @@ RSpec.describe Slack::Web::Api::Mixins::Channels do
       )
     )
   end
+
   context '#channels_id' do
     it 'leaves channels specified by ID alone' do
-      expect(subject.channels_id(channel: 'C123456')).to eq('ok' => true, 'channel' => { 'id' => 'C123456' })
+      expect(channels.channels_id(channel: 'C123456')).to(
+        eq('ok' => true, 'channel' => { 'id' => 'C123456' })
+      )
     end
     it 'translates a channel that starts with a #' do
-      expect(subject.channels_id(channel: '#general')).to eq('ok' => true, 'channel' => { 'id' => 'CDEADBEEF' })
+      expect(channels.channels_id(channel: '#general')).to(
+        eq('ok' => true, 'channel' => { 'id' => 'CDEADBEEF' })
+      )
     end
     it 'fails with an exception' do
-      expect { subject.channels_id(channel: '#invalid') }.to raise_error Slack::Web::Api::Errors::SlackError, 'channel_not_found'
+      expect { channels.channels_id(channel: '#invalid') }.to(
+        raise_error(Slack::Web::Api::Errors::SlackError, 'channel_not_found')
+      )
     end
   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: 'C018Y6VH39D', 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/groups_spec.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Mixins::Groups do
+  subject(:groups) do
+    klass.new
+  end
+
   let(:klass) do
     Class.new do
       include Slack::Web::Api::Mixins::Groups
     end
   end
-  subject do
-    klass.new
-  end
+
   before do
-    allow(subject).to receive(:groups_list).and_return(
+    allow(groups).to receive(:groups_list).and_yield(
       Slack::Messages::Message.new(
         'groups' => [{
           'id' => 'CDEADBEEF',
@@ -19,15 +22,22 @@ RSpec.describe Slack::Web::Api::Mixins::Groups do
       )
     )
   end
+
   context '#groups_id' do
     it 'leaves groups specified by ID alone' do
-      expect(subject.groups_id(channel: 'C123456')).to eq('ok' => true, 'group' => { 'id' => 'C123456' })
+      expect(groups.groups_id(channel: 'C123456')).to(
+        eq('ok' => true, 'group' => { 'id' => 'C123456' })
+      )
     end
     it 'translates a channel that starts with a #' do
-      expect(subject.groups_id(channel: '#general')).to eq('ok' => true, 'group' => { 'id' => 'CDEADBEEF' })
+      expect(groups.groups_id(channel: '#general')).to(
+        eq('ok' => true, 'group' => { 'id' => 'CDEADBEEF' })
+      )
     end
     it 'fails with an exception' do
-      expect { subject.groups_id(channel: '#invalid') }.to raise_error Slack::Web::Api::Errors::SlackError, 'channel_not_found'
+      expect { groups.groups_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,16 +1,19 @@
+# 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(
+    allow(users).to receive(:users_list).and_yield(
       Slack::Messages::Message.new(
         'members' => [{
           'id' => 'UDEADBEEF',
@@ -20,21 +23,27 @@ RSpec.describe Slack::Web::Api::Mixins::Users do
       )
     )
   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::Errors::SlackError, 'user_not_found'
+      expect { users.users_id(user: '@foo') }.to(
+        raise_error(Slack::Web::Api::Errors::SlackError, 'user_not_found')
+      )
     end
   end
+
   if defined?(Picky)
     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' => {} }])
+        expect(users.users_search(user: 'aws')).to(
+          eq('ok' => true, 'members' => [{ 'id' => 'UDEADBEEF', 'name' => 'aws', 'profile' => {} }])
+        )
       end
     end
   end

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

@@ -1,9 +1,12 @@
+# 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) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', {}) }
+    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
@@ -13,7 +16,9 @@ RSpec.describe Slack::Web::Api::Pagination::Cursor do
       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))
+      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
@@ -26,21 +31,42 @@ RSpec.describe Slack::Web::Api::Pagination::Cursor do
     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(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)
+          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) }
+        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(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)
@@ -48,15 +74,19 @@ RSpec.describe Slack::Web::Api::Pagination::Cursor do
       end
     end
   end
+
   context 'with a custom limit' do
-    let(:cursor) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', limit: 42) }
+    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) { Slack::Web::Api::Pagination::Cursor.new(client, 'users_list', sleep_interval: 3) }
+    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' }),