slack-ruby-client 0.13.1 → 2.0.0

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

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::Web::Faraday::Response::RaiseError do
-  describe '#on_complete' do
-    let(:subject) { described_class.new }
-    let(:status) { 200 }
-    let(:response) { nil }
-    let(:body) { {} }
-    let(:env) { double status: status, response: response, body: body }
+  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 }
+      let(:response) { OpenStruct.new(headers: { 'retry-after' => 10 }) }
 
       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 +26,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 be_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 +74,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

data/spec/spec_helper.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 
 require 'rubygems'
 require 'rspec'
+require 'timecop'
 
-require 'slack-ruby-client'
+require 'slack_ruby_client'
 
 Dir[File.join(File.dirname(__FILE__), 'support', '**/*.rb')].each do |file|
   require file
 end
 
 Slack.configure do |config|
-  config.token = ENV['SLACK_API_TOKEN']
+  config.token = '<SLACK_API_TOKEN>' # ENV['SLACK_API_TOKEN']
+end
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
 end

data/spec/support/queue_with_timeout.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # http://spin.atomicobject.com/2014/07/07/ruby-queue-pop-timeout/
 class QueueWithTimeout
   def initialize
@@ -6,15 +7,15 @@ class QueueWithTimeout
     @recieved = ConditionVariable.new
   end
 
-  def push(x)
+  def push(item)
     @mutex.synchronize do
-      @queue << x
+      @queue << item
       @recieved.signal
     end
   end
 
-  def <<(x)
-    push(x)
+  def <<(item)
+    push(item)
   end
 
   def pop(non_block = false)

data/spec/support/real_time/concurrency/mock.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Concurrency

data/spec/support/real_time/connected_client.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
 RSpec.shared_context 'connected client' do |opts|
   let(:client) { Slack::RealTime::Client.new(opts || {}) }
   let(:ws) { double(Slack::RealTime::Concurrency::Mock::WebSocket) }
-  let(:url) do
-    Slack::RealTime.config.store_class == Slack::RealTime::Stores::Store ?
-      'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' :
-      'wss://mpmulti-w5tz.slack-msgs.com/websocket/uid'
-  end
+  let(:url) { 'wss://cerberus-xxxx.lb.slack-msgs.com/websocket/uid' }
   let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
   before do
     Slack::RealTime.configure do |config|
       config.concurrency = Slack::RealTime::Concurrency::Mock
       config.store_class = (opts || {})[:store_class] || Slack::RealTime::Stores::Store
     end
-    allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30, logger: Slack::Logger.default).and_return(socket)
+    allow(Slack::RealTime::Socket).to(
+      receive(:new).with(url, { ping: 30, logger: Slack::Logger.default }).and_return(socket)
+    )
     allow(socket).to receive(:start_sync)
     allow(socket).to receive(:connect!)
     allow(ws).to receive(:on)

data/spec/support/real_time/event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     class Event

data/spec/support/real_time/loaded_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'loaded client' do
+  before do
+    client.users['U07KECJ77'] = Slack::RealTime::Models::User.new(
+      id: 'U07KECJ77',
+      team_id: 'T04KB5WQH',
+      name: 'aws',
+      deleted: true,
+      profile: { title: '', real_name: 'AWS Cloud', display_name: 'aws' },
+      is_bot: true,
+      is_app_user: false,
+      updated: 1504224679,
+      presence: 'away'
+    )
+    client.users['U0J1GAHN1'] = Slack::RealTime::Models::User.new(
+      id: 'U0J1GAHN1',
+      team_id: 'T04KB5WQH',
+      name: 'travis-ci',
+      deleted: false,
+      color: '5a4592',
+      presence: 'away',
+      real_name: 'travis-ci',
+      tz: 'America\/Los_Angeles',
+      tz_label: 'Pacific Standard Time',
+      profile: {
+        title: 'Used for Travis-CI integration tests on https://github.com/dblock/slack-ruby-client.',
+        real_name: 'travis-ci',
+        bot_id: 'B0J1L75DY',
+        team: 'T04KB5WQH'
+      }
+    )
+
+    client.bots['B0751JU2H'] = Slack::RealTime::Models::Bot.new(
+      id: 'B0751JU2H',
+      name: 'bot',
+      deleted: false,
+      updated: 1435864714
+    )
+
+    client.public_channels['C0HNTD0CW'] = Slack::RealTime::Models::Channel.new(
+      id: 'C0HNTD0CW',
+      name: 'chess',
+      is_channel: true,
+      is_group: false,
+      is_im: false,
+      is_mpim: false,
+      is_private: false,
+      created: 1452005790,
+      is_archived: false,
+      is_general: false,
+      unlinked: 0,
+      name_normalized: 'chess',
+      is_shared: false,
+      is_org_shared: false,
+      is_pending_ext_shared: false,
+      pending_shared: [],
+      parent_conversation: nil,
+      creator: 'U04KB5WQR',
+      is_ext_shared: false,
+      shared_team_ids: ['T04KB5WQH'],
+      pending_connected_team_ids: [],
+      has_pins: false,
+      is_member: false,
+      previous_names: [],
+      priority: 0
+    )
+    client.public_channels['C0HLE0BBL'] = Slack::RealTime::Models::Channel.new(
+      id: 'C0HLE0BBL',
+      name: 'gifs',
+      is_channel: true,
+      is_group: false,
+      is_im: false,
+      is_mpim: false,
+      is_private: false,
+      created: 1451913914,
+      is_archived: true,
+      is_general: false
+    )
+    client.public_channels['C0JHNAB5H'] = Slack::RealTime::Models::Channel.new(
+      id: 'C0JHNAB5H',
+      name: 'rubybot-test',
+      is_channel: true,
+      is_group: false,
+      is_private: false,
+      members: %w[U0J1GAHN1 U07518DTL]
+    )
+
+    client.public_channels['C0BTNJI59'] = Slack::RealTime::Models::Channel.new(
+      id: 'C0BTNJI59',
+      name: 'recent-priv-chan',
+      is_channel: true,
+      is_group: false,
+      is_private: true,
+      members: %w[U0J1GAHN1 U07518DTL]
+    )
+    client.private_channels['G0K7EV5A7'] = Slack::RealTime::Models::Channel.new(
+      id: 'G0K7EV5A7',
+      name: 'mpdm-dblock--rubybot--player1-1',
+      is_channel: false,
+      is_group: true,
+      is_im: false,
+      is_mpim: true,
+      is_private: true,
+      is_archived: false,
+      members: %w[U04KB5WQR U0J1GAHN1 U07518DTL],
+      created: 1453561861,
+      creator: 'U04KB5WQR'
+    )
+
+    client.ims['D0J1H6QTV'] = Slack::RealTime::Models::Im.new(
+      id: 'D0J1H6QTV',
+      is_im: true,
+      is_archived: false,
+      is_open: true,
+      user: 'U04KB5WQR',
+      created: 1452270861
+    )
+  end
+end

data/spec/support/token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 RSpec.configure do |config|
   config.before do
     @old_token = Slack::Config.token

data/spec/support/vcr.rb

@@ -1,9 +1,45 @@
+# frozen_string_literal: true
 require 'vcr'
 require 'webmock/rspec'
 
 VCR.configure do |config|
   config.cassette_library_dir = 'spec/fixtures/slack'
   config.hook_into :webmock
-  # config.default_cassette_options = { record: :new_episodes }
   config.configure_rspec_metadata!
+  if ENV.key?('SLACK_API_TOKEN')
+    config.filter_sensitive_data('<SLACK_API_TOKEN>') do
+      ENV['SLACK_API_TOKEN']
+    end
+  end
+  config.before_record do |i|
+    i.response.body.force_encoding('UTF-8')
+  end
+  config.register_request_matcher :client_headers do |recorded, actual|
+    authorizations = ENV.key?('SLACK_API_TOKEN') ? actual.headers['Authorization'].map do |auth|
+      auth.gsub(ENV['SLACK_API_TOKEN'], '<SLACK_API_TOKEN>')
+    end : actual.headers['Authorization']
+    actual.headers['Accept'] == recorded.headers['Accept'] &&
+      authorizations == recorded.headers['Authorization']
+  end
+  config.default_cassette_options = {
+    match_requests_on: %i[method uri body client_headers]
+    # record: :new_episodes
+  }
+end
+
+module VCR
+  module Errors
+    class UnhandledHTTPRequestError
+      private
+
+      # Force unhandled HTTP error reports to include the headers
+      # for our custom matcher `client_headers`.
+      #
+      # This patch can be removed if https://github.com/vcr/vcr/issues/912
+      # is ever resolved.
+      def match_request_on_headers?
+        true
+      end
+    end
+  end
 end