slack-ruby-client 0.12.0 → 0.14.6

data/spec/slack/messages/formatting_spec.rb

@@ -1,42 +1,54 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Slack::Messages::Formatting do
-  subject do
-    Slack::Messages::Formatting
+  subject(:formatting) do
+    described_class
   end
+
   context '#unescape' do
     it 'plain text' do
-      expect(subject.unescape('plain text')).to eq 'plain text'
+      expect(formatting.unescape('plain text')).to eq 'plain text'
     end
     it 'decodes an HTML-encoded message' do
-      expect(subject.unescape('Hello &amp; &lt;world&gt;')).to eq 'Hello & <world>'
+      expect(formatting.unescape('Hello &amp; &lt;world&gt;')).to eq 'Hello & <world>'
     end
     it 'unescapes a user reference' do
-      expect(subject.unescape('Hey <@U024BE7LH|bob>, did you see my file?')).to eq 'Hey @bob, did you see my file?'
+      expect(formatting.unescape('Hey <@U024BE7LH|bob>, did you see my file?')).to(
+        eq('Hey @bob, did you see my file?')
+      )
     end
     it 'unescapes a user reference without a name' do
-      expect(subject.unescape('<@U02BEFY4U> ^^^')).to eq '@U02BEFY4U ^^^'
+      expect(formatting.unescape('<@U02BEFY4U> ^^^')).to eq '@U02BEFY4U ^^^'
     end
     it 'unescapes a URL without text' do
-      expect(subject.unescape('This message contains a URL <http://foo.com/>')).to eq 'This message contains a URL http://foo.com/'
+      expect(formatting.unescape('This message contains a URL <http://foo.com/>')).to(
+        eq('This message contains a URL http://foo.com/')
+      )
     end
     it 'unescapes a URL with text' do
-      expect(subject.unescape('So does this one: <http://www.foo.com|www.foo.com>')).to eq 'So does this one: www.foo.com'
+      expect(formatting.unescape('So does this one: <http://www.foo.com|www.foo.com>')).to(
+        eq('So does this one: www.foo.com')
+      )
     end
     it 'removes mailto' do
-      expect(subject.unescape('<mailto:bob@example.com|Bob>')).to eq 'Bob'
+      expect(formatting.unescape('<mailto:bob@example.com|Bob>')).to eq 'Bob'
     end
     it 'unlinkifies references' do
-      expect(subject.unescape('Hello <@U123|bob>, say hi to <!everyone> in <#C1234|general>')).to eq 'Hello @bob, say hi to @everyone in #general'
+      expect(
+        formatting.unescape('Hello <@U123|bob>, say hi to <!everyone> in <#C1234|general>')
+      ).to(
+        eq('Hello @bob, say hi to @everyone in #general')
+      )
     end
     it 'can handle a lone &gt;' do
-      expect(subject.unescape('Hello <@U123|bob> &gt; file.txt')).to eq 'Hello @bob > file.txt'
+      expect(formatting.unescape('Hello <@U123|bob> &gt; file.txt')).to eq 'Hello @bob > file.txt'
     end
     it 'unescapes a double smart quote' do
-      expect(subject.unescape('“hello”')).to eq '"hello"'
+      expect(formatting.unescape('“hello”')).to eq '"hello"'
     end
     it 'unescapes a single smart quote' do
-      expect(subject.unescape('‘hello’')).to eq "'hello'"
+      expect(formatting.unescape('‘hello’')).to eq "'hello'"
     end
   end
 end

data/spec/slack/real_time/api/message_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
@@ -7,8 +8,12 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
     before do
       allow(client).to receive(:next_id).and_return(42)
     end
+
     it 'sends message' do
-      expect(socket).to receive(:send_data).with({ type: 'message', id: 42, text: 'hello world', channel: 'channel' }.to_json)
+      expect(socket).to(
+        receive(:send_data)
+          .with({ type: 'message', id: 42, text: 'hello world', channel: 'channel' }.to_json)
+      )
       client.message(text: 'hello world', channel: 'channel')
     end
   end

data/spec/slack/real_time/api/ping_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
@@ -7,6 +8,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
     before do
       allow(client).to receive(:next_id).and_return(42)
     end
+
     it 'sends message' do
       expect(socket).to receive(:send_data).with({ type: 'ping', id: 42 }.to_json)
       client.ping

data/spec/slack/real_time/api/typing_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
@@ -7,8 +8,11 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
     before do
       allow(client).to receive(:next_id).and_return(42)
     end
+
     it 'sends a typing indicator' do
-      expect(socket).to receive(:send_data).with({ type: 'typing', id: 42, channel: 'channel' }.to_json)
+      expect(socket).to(
+        receive(:send_data).with({ type: 'typing', id: 42, channel: 'channel' }.to_json)
+      )
       client.typing(channel: 'channel')
     end
   end

data/spec/slack/real_time/client_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client do
+RSpec.describe Slack::RealTime::Client do # rubocop:disable Metrics/BlockLength
   let(:ws) { double(Slack::RealTime::Concurrency::Mock::WebSocket, on: true) }
+
   before do
     @token = ENV.delete('SLACK_API_TOKEN')
     Slack::Config.reset
@@ -10,49 +12,78 @@ RSpec.describe Slack::RealTime::Client do
       config.concurrency = Slack::RealTime::Concurrency::Mock
     end
   end
+
   after do
     ENV['SLACK_API_TOKEN'] = @token if @token
   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::RealTime::Client.new
+      client = described_class.new
       expect(client.token).to eq 'global default'
       expect(client.web_client.token).to eq 'global default'
     end
     context 'with real time config' do
       before do
-        Slack::RealTime::Client.configure do |config|
+        described_class.configure do |config|
           config.token = 'custom real time token'
         end
       end
+
       it 'overrides token to real time config' do
-        client = Slack::RealTime::Client.new
+        client = described_class.new
         expect(client.token).to eq 'custom real time token'
         expect(client.web_client.token).to eq 'custom real time token'
       end
       it 'overrides token to specific token' do
-        client = Slack::RealTime::Client.new(token: 'local token')
+        client = described_class.new(token: 'local token')
         expect(client.token).to eq 'local token'
         expect(client.web_client.token).to eq 'local token'
       end
     end
   end
-  context 'client with a full store', vcr: { cassette_name: 'web/rtm_start' } do
-    let(:client) { Slack::RealTime::Client.new(store_class: Slack::RealTime::Stores::Store) }
+
+  context 'websocket_ping_timer' do
+    context 'with defaults' do
+      let(:client) { described_class.new }
+
+      it 'defaults to websocket_ping / 2' do
+        expect(client.websocket_ping_timer).to eq 15
+      end
+    end
+
+    context 'with websocket_ping value changed' do
+      let(:client) { described_class.new(websocket_ping: 22) }
+
+      it 'defaults to websocket_ping / 2' do
+        expect(client.websocket_ping_timer).to eq 11
+      end
+    end
+  end
+
+  context 'client with a full store',
+          vcr: { cassette_name: 'web/rtm_start', allow_playback_repeats: true } do
+    let(:client) { described_class.new(store_class: Slack::RealTime::Stores::Store) }
     let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
+
     describe '#start!' do
       let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
       before do
-        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(:connect!)
         allow(socket).to receive(:start_sync)
         client.start!
       end
+
       describe 'properties provided upon connection' do
         it 'sets url' do
           expect(client.url).to eq url
@@ -86,7 +117,13 @@ RSpec.describe Slack::RealTime::Client do
         it 'sets groups' do
           expect(client.groups.count).to eq 1
         end
+        it 'includes team name in to_s' do
+          expect(client.to_s).to eq(
+            "id=#{client.team.id}, name=#{client.team.name}, domain=#{client.team.domain}"
+          )
+        end
       end
+
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
       end
@@ -100,9 +137,10 @@ RSpec.describe Slack::RealTime::Client do
       end
       describe '#stop!' do
         before do
-          expect(socket).to receive(:disconnect!)
+          allow(socket).to receive(:disconnect!)
           client.stop!
         end
+
         it 'cannot be invoked twice' do
           client.instance_variable_set('@socket', nil) # caused by a :close callback
           expect do
@@ -110,12 +148,14 @@ RSpec.describe Slack::RealTime::Client do
           end.to raise_error Slack::RealTime::Client::ClientNotStartedError
         end
       end
+
       describe '#next_id' do
         it 'increments' do
           previous_id = client.send(:next_id)
           expect(client.send(:next_id)).to eq previous_id + 1
         end
       end
+
       context 'subclassed' do
         it 'runs event handlers' do
           event = Slack::RealTime::Event.new(
@@ -127,18 +167,88 @@ RSpec.describe Slack::RealTime::Client do
         end
       end
     end
+
+    describe '#start_async' do
+      let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
+      before do
+        allow(Slack::RealTime::Socket).to(
+          receive(:new).with(url, ping: 30, logger: Slack::Logger.default).and_return(socket)
+        )
+        allow(socket).to receive(:connect!)
+        allow(socket).to receive(:start_async)
+        client.start_async
+      end
+
+      describe '#run_ping!' do
+        it 'sends ping messages when the websocket connection is idle' do
+          allow(socket).to receive(:time_since_last_message).and_return(30)
+          expect(socket).to receive(:send_data).with('{"type":"ping","id":1}')
+          client.run_ping!
+        end
+        it 'reconnects the websocket if it has been idle for too long' do
+          allow(socket).to receive(:time_since_last_message).and_return(75)
+          allow(socket).to receive(:connected?).and_return(true)
+          expect(socket).to receive(:close)
+          expect(socket).to receive(:restart_async)
+          client.run_ping!
+        end
+        [
+          EOFError,
+          Errno::ECONNRESET,
+          Errno::EPIPE,
+          Faraday::ClientError,
+          Slack::Web::Api::Errors::SlackError
+        ].each do |err|
+          context "raising #{err}" do
+            it 'does not terminate the ping worker' do
+              allow(socket).to receive(:time_since_last_message) { raise err }
+              expect(socket).not_to receive(:send_data)
+              client.run_ping!
+            end
+          end
+        end
+        context 'raising Slack::Web::Api::Errors::SlackError' do
+          %w[invalid_auth account_inactive].each do |code|
+            context code do
+              it 'does not terminate the ping worker' do
+                allow(socket).to receive(:time_since_last_message) {
+                  raise Slack::Web::Api::Errors::SlackError, code
+                }
+                expect(socket).not_to receive(:send_data)
+                expect do
+                  client.run_ping!
+                end.to raise_error Slack::Web::Api::Errors::SlackError, code
+              end
+            end
+          end
+        end
+      end
+    end
+
+    describe 'to_s' do
+      it 'defaults to class instance' do
+        expect(client.to_s).to match(/^#<Slack::RealTime::Client:0x\h+>$/)
+      end
+    end
   end
+
   context 'client with starter store', vcr: { cassette_name: 'web/rtm_connect' } do
-    let(:client) { Slack::RealTime::Client.new(store_class: Slack::RealTime::Stores::Starter) }
+    let(:client) { described_class.new(store_class: Slack::RealTime::Stores::Starter) }
     let(:url) { 'wss://mpmulti-w5tz.slack-msgs.com/websocket/uid' }
+
     describe '#start!' do
       let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
       before do
-        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(:connect!)
         allow(socket).to receive(:start_sync)
         client.start!
       end
+
       describe 'properties provided upon connection' do
         it 'sets url' do
           expect(client.url).to eq url
@@ -167,7 +277,13 @@ RSpec.describe Slack::RealTime::Client do
         it 'no groups' do
           expect(client.groups).to be_nil
         end
+        it 'includes team name in to_s' do
+          expect(client.to_s).to eq(
+            "id=#{client.team.id}, name=#{client.team.name}, domain=#{client.team.domain}"
+          )
+        end
       end
+
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
       end
@@ -181,9 +297,10 @@ RSpec.describe Slack::RealTime::Client do
       end
       describe '#stop!' do
         before do
-          expect(socket).to receive(:disconnect!)
+          allow(socket).to receive(:disconnect!)
           client.stop!
         end
+
         it 'cannot be invoked twice' do
           client.instance_variable_set('@socket', nil) # caused by a :close callback
           expect do
@@ -191,6 +308,7 @@ RSpec.describe Slack::RealTime::Client do
           end.to raise_error Slack::RealTime::Client::ClientNotStartedError
         end
       end
+
       describe '#next_id' do
         it 'increments' do
           previous_id = client.send(:next_id)
@@ -199,9 +317,11 @@ RSpec.describe Slack::RealTime::Client do
       end
     end
   end
+
   context 'client with nil store', vcr: { cassette_name: 'web/rtm_connect' } do
-    let(:client) { Slack::RealTime::Client.new(store_class: nil) }
+    let(:client) { described_class.new(store_class: nil) }
     let(:url) { 'wss://mpmulti-w5tz.slack-msgs.com/websocket/uid' }
+
     it 'sets store to nil' do
       expect(client.store).to be nil
     end
@@ -210,7 +330,7 @@ RSpec.describe Slack::RealTime::Client do
         'type' => 'team_rename',
         'name' => 'New Team Name Inc.'
       )
-      expect(client).to_not receive(:run_handlers)
+      expect(client).not_to receive(:run_handlers)
       client.send(:dispatch, event)
     end
     it 'self' do
@@ -219,9 +339,16 @@ RSpec.describe Slack::RealTime::Client do
     it 'team' do
       expect(client.team).to be nil
     end
+    describe 'to_s' do
+      it 'defaults to class instance' do
+        expect(client.to_s).to match(/^#<Slack::RealTime::Client:0x\h+>$/)
+      end
+    end
   end
+
   context 'client with defaults' do
-    let(:client) { Slack::RealTime::Client.new }
+    let(:client) { described_class.new }
+
     describe '#initialize' do
       it 'sets ping' do
         expect(client.websocket_ping).to eq 30
@@ -241,38 +368,70 @@ RSpec.describe Slack::RealTime::Client do
         end
       end
     end
+
+    describe '#run_ping?' do
+      it 'returns true when websocket_ping is greater than 0' do
+        client.websocket_ping = 30
+        expect(client.run_ping?).to be true
+      end
+      it 'returns false when websocket_ping is less than 1' do
+        client.websocket_ping = 0
+        expect(client.run_ping?).to be false
+        client.websocket_ping = nil
+        expect(client.run_ping?).to be false
+      end
+    end
   end
+
   context 'with custom settings' do
     describe '#initialize' do
       Slack::RealTime::Config::ATTRIBUTES.each do |key|
-        context key do
-          let(:client) { Slack::RealTime::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::RealTime::Config.send(key)
+            expect(client.send(key)).not_to eq Slack::RealTime::Config.send(key)
             expect(client.send(key)).to eq 'custom'
           end
         end
       end
     end
+
+    describe 'logger accessor' do
+      let(:client) { described_class.new }
+
+      it 'exposes public logger' do
+        expect(client.logger).to be_a(::Logger)
+      end
+      it 'exposes public logger=' do
+        expect { client.logger = nil }.not_to raise_error(NoMethodError)
+      end
+    end
   end
+
   context 'global config' do
     after do
-      Slack::RealTime::Client.config.reset
+      described_class.config.reset
     end
+
     let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
-    let(:client) { Slack::RealTime::Client.new }
+    let(:client) { described_class.new }
+
     context 'ping' do
       before do
-        Slack::RealTime::Client.configure do |config|
+        described_class.configure do |config|
           config.websocket_ping = 15
         end
       end
+
       describe '#initialize' do
         it 'sets ping' do
           expect(client.websocket_ping).to eq 15
         end
         it 'creates a connection with custom ping', vcr: { cassette_name: 'web/rtm_start' } do
-          expect(Slack::RealTime::Concurrency::Mock::WebSocket).to receive(:new).with(url, nil, ping: 15).and_return(ws)
+          expect(Slack::RealTime::Concurrency::Mock::WebSocket).to(
+            receive(:new).with(url, nil, ping: 15).and_return(ws)
+          )
           client.start!
         end
         it 'sets start_options' do
@@ -280,15 +439,17 @@ RSpec.describe Slack::RealTime::Client do
         end
       end
     end
+
     context 'proxy' do
       before do
-        Slack::RealTime::Client.configure do |config|
+        described_class.configure do |config|
           config.websocket_proxy = {
             origin: 'http://username:password@proxy.example.com',
             headers: { 'User-Agent' => 'ruby' }
           }
         end
       end
+
       describe '#initialize' do
         it 'sets proxy' do
           expect(client.websocket_proxy).to eq(
@@ -310,40 +471,48 @@ RSpec.describe Slack::RealTime::Client do
         end
       end
     end
+
     context 'start_options' do
       before do
-        Slack::RealTime::Client.configure do |config|
+        described_class.configure do |config|
           config.start_options = { simple_latest: true }
         end
       end
+
       describe '#initialize' do
         it 'sets start_options' do
           expect(client.start_options).to eq(simple_latest: true)
         end
         context 'start!' do
           let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
           before do
             allow(Slack::RealTime::Socket).to receive(:new).and_return(socket)
             allow(socket).to receive(:connect!)
             allow(socket).to receive(:start_sync)
           end
+
           it 'calls rtm_start with start options', vcr: { cassette_name: 'web/rtm_start' } do
-            expect(client.web_client).to receive(:rtm_start).with(simple_latest: true).and_call_original
+            expect(client.web_client).to(
+              receive(:rtm_start).with(simple_latest: true).and_call_original
+            )
             client.start!
           end
         end
       end
     end
+
     context 'store_class' do
       context 'starter' do
         before do
-          Slack::RealTime::Client.configure do |config|
+          described_class.configure do |config|
             config.store_class = Slack::RealTime::Stores::Starter
           end
         end
+
         describe '#initialize' do
           it 'can be overriden explicitly' do
-            client = Slack::RealTime::Client.new(store_class: Slack::RealTime::Store)
+            client = described_class.new(store_class: Slack::RealTime::Store)
             expect(client.send(:store_class)).to eq Slack::RealTime::Store
           end
           it 'sets store_class' do
@@ -351,11 +520,13 @@ RSpec.describe Slack::RealTime::Client do
           end
           context 'start!' do
             let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
             before do
               allow(Slack::RealTime::Socket).to receive(:new).and_return(socket)
               allow(socket).to receive(:connect!)
               allow(socket).to receive(:start_sync)
             end
+
             it 'instantiates the correct store class', vcr: { cassette_name: 'web/rtm_connect' } do
               client.start!
               expect(client.store).to be_a Slack::RealTime::Stores::Starter
@@ -363,20 +534,24 @@ RSpec.describe Slack::RealTime::Client do
           end
         end
       end
+
       context 'store' do
         before do
-          Slack::RealTime::Client.configure do |config|
+          described_class.configure do |config|
             config.store_class = Slack::RealTime::Stores::Store
           end
         end
+
         describe '#initialize' do
           context 'start!' do
             let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
             before do
               allow(Slack::RealTime::Socket).to receive(:new).and_return(socket)
               allow(socket).to receive(:connect!)
               allow(socket).to receive(:start_sync)
             end
+
             it 'calls rtm_start and not rtm_connect', vcr: { cassette_name: 'web/rtm_start' } do
               expect(client.web_client).to receive(:rtm_start).and_call_original
               client.start!
@@ -385,18 +560,20 @@ RSpec.describe Slack::RealTime::Client do
         end
       end
     end
+
     context 'start_method' do
       describe '#initialize' do
         it 'can be overriden explicitly' do
-          client = Slack::RealTime::Client.new(start_method: :overriden)
+          client = described_class.new(start_method: :overriden)
           expect(client.send(:start_method)).to eq :overriden
         end
         context 'with start_method' do
           before do
-            Slack::RealTime::Client.configure do |config|
+            described_class.configure do |config|
               config.start_method = :overriden
             end
           end
+
           it 'sets start_method' do
             expect(client.send(:start_method)).to eq :overriden
           end
@@ -407,14 +584,18 @@ RSpec.describe Slack::RealTime::Client do
             end.to raise_error RuntimeError, 'overriden'
           end
         end
+
         context 'start!' do
           let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+
           before do
             allow(Slack::RealTime::Socket).to receive(:new).and_return(socket)
             allow(socket).to receive(:connect!)
             allow(socket).to receive(:start_sync)
           end
-          it 'defaults to :rtm_start when using full store', vcr: { cassette_name: 'web/rtm_start' } do
+
+          it 'defaults to :rtm_start when using full store',
+             vcr: { cassette_name: 'web/rtm_start' } do
             expect(client.web_client).to receive(:rtm_start).and_call_original
             client.start!
           end