slack-ruby-client 0.14.2 → 0.15.0

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_return(
       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' }),

data/spec/slack/web/client_spec.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Client do
   before do
     Slack::Config.reset
   end
+
   context 'with defaults' do
-    let(:client) { Slack::Web::Client.new }
+    let(:client) { described_class.new }
+
     describe '#initialize' do
       it 'sets user-agent' do
         expect(client.user_agent).to eq Slack::Web::Config.user_agent
@@ -18,30 +21,36 @@ RSpec.describe Slack::Web::Client do
       end
     end
   end
+
   context 'with custom settings' do
     describe '#initialize' do
       Slack::Web::Config::ATTRIBUTES.each do |key|
-        context key do
-          let(:client) { Slack::Web::Client.new(key => 'custom') }
+        context key.to_s do
+          let(:client) { described_class.new(key => 'custom') }
+
           it "sets #{key}" do
-            expect(client.send(key)).to_not eq Slack::Web::Config.send(key)
+            expect(client.send(key)).not_to eq Slack::Web::Config.send(key)
             expect(client.send(key)).to eq 'custom'
           end
         end
       end
     end
   end
+
   context 'global config' do
     after do
-      Slack::Web::Client.config.reset
+      described_class.config.reset
     end
-    let(:client) { Slack::Web::Client.new }
+
+    let(:client) { described_class.new }
+
     context 'user-agent' do
       before do
-        Slack::Web::Client.configure do |config|
+        described_class.configure do |config|
           config.user_agent = 'custom/user-agent'
         end
       end
+
       describe '#initialize' do
         it 'sets user-agent' do
           expect(client.user_agent).to eq 'custom/user-agent'
@@ -54,38 +63,43 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+
     context 'token' do
       before do
         Slack.configure do |config|
           config.token = 'global default'
         end
       end
+
       it 'defaults token to global default' do
-        client = Slack::Web::Client.new
+        client = described_class.new
         expect(client.token).to eq 'global default'
       end
       context 'with web config' do
         before do
-          Slack::Web::Client.configure do |config|
+          described_class.configure do |config|
             config.token = 'custom web token'
           end
         end
+
         it 'overrides token to web config' do
-          client = Slack::Web::Client.new
+          client = described_class.new
           expect(client.token).to eq 'custom web token'
         end
         it 'overrides token to specific token' do
-          client = Slack::Web::Client.new(token: 'local token')
+          client = described_class.new(token: 'local token')
           expect(client.token).to eq 'local token'
         end
       end
     end
+
     context 'proxy' do
       before do
-        Slack::Web::Client.configure do |config|
+        described_class.configure do |config|
           config.proxy = 'http://localhost:8080'
         end
       end
+
       describe '#initialize' do
         it 'sets proxy' do
           expect(client.proxy).to eq 'http://localhost:8080'
@@ -95,13 +109,15 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+
     context 'SSL options' do
       before do
-        Slack::Web::Client.configure do |config|
+        described_class.configure do |config|
           config.ca_path = '/ca_path'
           config.ca_file = '/ca_file'
         end
       end
+
       describe '#initialize' do
         it 'sets ca_path and ca_file' do
           expect(client.ca_path).to eq '/ca_path'
@@ -114,13 +130,16 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+
     context 'logger option' do
       let(:logger) { Logger.new(STDOUT) }
+
       before do
-        Slack::Web::Client.configure do |config|
+        described_class.configure do |config|
           config.logger = logger
         end
       end
+
       describe '#initialize' do
         it 'sets logger' do
           expect(client.logger).to eq logger
@@ -130,13 +149,15 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+
     context 'timeout options' do
       before do
-        Slack::Web::Client.configure do |config|
+        described_class.configure do |config|
           config.timeout = 10
           config.open_timeout = 15
         end
       end
+
       describe '#initialize' do
         it 'sets timeout and open_timeout' do
           expect(client.timeout).to eq 10
@@ -149,13 +170,15 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+
     context 'per-request options' do
       it 'applies timeout', vcr: { cassette_name: 'web/rtm_start', allow_playback_repeats: true } do
         # reuse the same connection for the test, otherwise it creates a new one every time
         conn = client.send(:connection)
         expect(client).to receive(:connection).and_return(conn)
 
-        # get the yielded request to reuse in the next call to rtm_start so that we can examine request.options later
+        # get the yielded request to reuse in the next call to
+        # rtm_start so that we can examine request.options later
         request = nil
         response = conn.post do |r|
           r.path = 'rtm.start'
@@ -170,13 +193,43 @@ RSpec.describe Slack::Web::Client do
         expect(request.options.timeout).to eq 3
       end
     end
+
     context 'calling undocumented methods' do
-      let(:client) { Slack::Web::Client.new }
+      let(:client) { described_class.new }
+
       it 'produces a warning' do
-        expect(client.logger).to receive(:warn).with('The users.admin.setInactive method is undocumented.')
+        expect(client.logger).to(
+          receive(:warn).with('The users.admin.setInactive method is undocumented.')
+        )
         expect(client).to receive(:post)
         client.users_admin_setInactive(user: 'U092BDCLV')
       end
     end
+
+    context 'when calling deprecated methods' do
+      let(:client) { described_class.new }
+
+      it 'produces a warning' do
+        expect(client.logger).to receive(:warn).with(/
+          ^channels\.archive:\ This\ method\ is\ deprecated
+          .+
+          Alternative\ methods:\ conversations\.archive\.
+        /x)
+
+        expect(client).to receive(:post)
+        client.channels_archive(channel: 'test')
+      end
+    end
+
+    context 'persistent capability' do
+      describe '#initialize' do
+        it 'caches the Faraday connection to allow persistent adapters' do
+          first = client.send(:connection)
+          second = client.send(:connection)
+
+          expect(first).to equal second
+        end
+      end
+    end
   end
 end

data/spec/slack/web/faraday/response/raise_error_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Faraday::Response::RaiseError do
+  subject(:raise_error_obj) { described_class.new }
+
   describe '#on_complete' do
-    let(:subject) { described_class.new }
     let(:status) { 200 }
     let(:response) { nil }
     let(:body) { {} }
@@ -12,7 +14,9 @@ RSpec.describe Slack::Web::Faraday::Response::RaiseError do
       let(:status) { 429 }
 
       it 'raises a TooManyRequestsError' do
-        expect { subject.on_complete(env) }.to raise_error(Slack::Web::Api::Errors::TooManyRequestsError)
+        expect { raise_error_obj.on_complete(env) }.to(
+          raise_error(Slack::Web::Api::Errors::TooManyRequestsError)
+        )
       end
     end
 
@@ -20,21 +24,46 @@ RSpec.describe Slack::Web::Faraday::Response::RaiseError do
       let(:body) { { 'ok' => 'true' } }
 
       it 'is nil' do
-        expect(subject.on_complete(env)).to eq nil
+        expect(raise_error_obj.on_complete(env)).to eq nil
       end
     end
 
-    context 'with a single error in the body' do
-      let(:body) { { 'error' => 'already_in_channel' } }
+    context 'with a single known error in the body' do
+      let(:body) do
+        {
+          'ok' => false,
+          'error' => 'already_in_channel',
+          'response_metadata' => { 'messages' => [] }
+        }
+      end
+
+      it 'raises an error of the matching type with the error message' do
+        expect { raise_error_obj.on_complete(env) }.to(
+          raise_error(Slack::Web::Api::Errors::AlreadyInChannel, 'already_in_channel')
+        )
+      end
+    end
+
+    context 'with a single unknown error in the body' do
+      let(:body) do
+        {
+          'ok' => false,
+          'error' => 'unknown_error',
+          'response_metadata' => { 'messages' => [] }
+        }
+      end
 
       it 'raises a SlackError with the error message' do
-        expect { subject.on_complete(env) }.to raise_error(Slack::Web::Api::Errors::SlackError, 'already_in_channel')
+        expect { raise_error_obj.on_complete(env) }.to(
+          raise_error(Slack::Web::Api::Errors::SlackError, 'unknown_error')
+        )
       end
     end
 
     context 'with multiple errors in the body' do
       let(:body) do
         {
+          'ok' => false,
           'errors' => [
             { 'error' => 'already_in_channel' },
             { 'error' => 'something_else_terrible' }
@@ -43,7 +72,12 @@ RSpec.describe Slack::Web::Faraday::Response::RaiseError do
       end
 
       it 'raises a SlackError with the concatenated error messages' do
-        expect { subject.on_complete(env) }.to raise_error(Slack::Web::Api::Errors::SlackError, 'already_in_channel,something_else_terrible')
+        expect { raise_error_obj.on_complete(env) }.to(
+          raise_error(
+            Slack::Web::Api::Errors::SlackError,
+            'already_in_channel,something_else_terrible'
+          )
+        )
       end
     end
   end