slack-ruby-client 0.7.9 → 0.16.0

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

@@ -0,0 +1,100 @@
+# 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(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) { 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(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) { 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

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,5 +149,187 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+
+    context 'adapter option' do
+      let(:adapter) { Faraday.default_adapter }
+      let(:adapter_class) { Faraday::Adapter::NetHttp }
+
+      around do |ex|
+        previous_adapter = Faraday.default_adapter
+        # ensure default adapter is set for this spec
+        Faraday.default_adapter = :net_http
+        ex.run
+        Faraday.default_adapter = previous_adapter
+      end
+
+      context 'default adapter' do
+        describe '#initialize' do
+          it 'sets adapter' do
+            expect(client.adapter).to eq adapter
+          end
+          it 'creates a connection with an adapter' do
+            expect(client.send(:connection).adapter).to eq adapter_class
+          end
+        end
+      end
+
+      context 'non default adapter' do
+        let(:adapter) { :typhoeus }
+        let(:adapter_class) { Faraday::Adapter::Typhoeus }
+
+        before do
+          described_class.configure do |config|
+            config.adapter = adapter
+          end
+        end
+
+        describe '#initialize' do
+          it 'sets adapter' do
+            expect(client.adapter).to eq adapter
+          end
+          it 'creates a connection with an adapter' do
+            expect(client.send(:connection).adapter).to eq adapter_class
+          end
+        end
+      end
+    end
+
+    context 'timeout options' do
+      before do
+        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
+          expect(client.open_timeout).to eq 15
+        end
+        it 'creates a connection with timeout options' do
+          conn = client.send(:connection)
+          expect(conn.options.timeout).to eq 10
+          expect(conn.options.open_timeout).to eq 15
+        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
+        request = nil
+        response = conn.post do |r|
+          r.path = 'rtm.start'
+          r.body = { token: 'token' }
+          request = r
+        end
+
+        expect(conn).to receive(:post).and_yield(request).and_return(response)
+
+        client.rtm_start(request: { timeout: 3 })
+
+        expect(request.options.timeout).to eq 3
+      end
+    end
+
+    context 'calling undocumented methods' do
+      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).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
+
+    context 'server failures' do
+      subject(:request) { client.api_test }
+
+      let(:stub_slack_request) { stub_request(:post, 'https://slack.com/api/api.test') }
+      let(:exception) do
+        begin
+          request
+        rescue Slack::Web::Api::Errors::ServerError => e
+          return e
+        end
+      end
+
+      context 'parsing error' do
+        before {  stub_slack_request.to_return(body: '<html></html>') }
+
+        it 'raises ParsingError' do
+          expect { request }.to raise_error(Slack::Web::Api::Errors::ParsingError).with_message('parsing_error')
+          expect(exception.response.body).to eq('<html></html>')
+          expect(exception.cause).to be_a(Faraday::ParsingError)
+          expect(exception.cause.cause.cause).to be_a(JSON::ParserError)
+        end
+      end
+
+      context 'timeout' do
+        context 'open timeout' do
+          before { stub_slack_request.to_timeout }
+
+          it 'raises TimoutError' do
+            expect { request }.to raise_error(Slack::Web::Api::Errors::TimeoutError).with_message('timeout_error')
+            expect(exception.cause).to be_a(Faraday::ConnectionFailed)
+            expect(exception.cause.cause).to be_a(Net::OpenTimeout)
+          end
+        end
+
+        context 'read timeout' do
+          before { stub_slack_request.to_raise(Net::ReadTimeout) }
+
+          it 'raises TimeoutError' do
+            expect { request }.to raise_error(Slack::Web::Api::Errors::TimeoutError).with_message('timeout_error')
+            expect(exception.cause).to be_a(Faraday::TimeoutError)
+            expect(exception.cause.cause).to be_a(Net::ReadTimeout)
+          end
+        end
+      end
+
+      context '5xx response' do
+        before { stub_slack_request.to_return(status: 500, body: '{}') }
+
+        it 'raises UnavailableError' do
+          expect { request }.to raise_error(Slack::Web::Api::Errors::UnavailableError).with_message('unavailable_error')
+          expect(exception.cause).to be_a(Faraday::ServerError)
+          expect(exception.response.status).to eq(500)
+        end
+      end
+    end
   end
 end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Faraday::Response::RaiseError do
+  subject(:raise_error_obj) { described_class.new(app) }
+
+  let(:app) { proc {} }
+  let(:status) { 200 }
+  let(:response) { nil }
+  let(:body) { {} }
+  let(:env) { double status: status, response: response, body: body, success?: true }
+
+  describe '#on_complete' do
+    context 'with status of 429' do
+      let(:status) { 429 }
+
+      it 'raises a TooManyRequestsError' do
+        expect { raise_error_obj.on_complete(env) }.to(
+          raise_error(Slack::Web::Api::Errors::TooManyRequestsError)
+        )
+      end
+    end
+
+    context 'with an ok payload in the body' do
+      let(:body) { { 'ok' => 'true' } }
+
+      it 'is nil' do
+        expect(raise_error_obj.on_complete(env)).to eq nil
+      end
+    end
+
+    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 { 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' }
+          ]
+        }
+      end
+
+      it 'raises a SlackError with the concatenated error messages' do
+        expect { raise_error_obj.on_complete(env) }.to(
+          raise_error(
+            Slack::Web::Api::Errors::SlackError,
+            'already_in_channel,something_else_terrible'
+          )
+        )
+      end
+    end
+  end
+end