slack-ruby-client 1.1.0 → 2.0.0

data/spec/slack/real_time/client_spec.rb

@@ -25,6 +25,7 @@ RSpec.describe Slack::RealTime::Client do
       expect(client.token).to eq '<SLACK_API_TOKEN>'
       expect(client.web_client.token).to eq '<SLACK_API_TOKEN>'
     end
+
     context 'with real time config' do
       before do
         described_class.configure do |config|
@@ -37,6 +38,7 @@ RSpec.describe Slack::RealTime::Client do
         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 = described_class.new(token: 'local token')
         expect(client.token).to eq 'local token'
@@ -64,7 +66,7 @@ RSpec.describe Slack::RealTime::Client do
   end
 
   context 'client with a full store',
-          vcr: { cassette_name: 'web/rtm_start', allow_playback_repeats: true } do
+          vcr: { cassette_name: 'web/rtm_connect', allow_playback_repeats: true } do
     let(:client) { described_class.new(store_class: Slack::RealTime::Stores::Store) }
     let(:url) { 'wss://cerberus-xxxx.lb.slack-msgs.com/websocket/uid' }
 
@@ -84,35 +86,25 @@ RSpec.describe Slack::RealTime::Client do
         it 'sets url' do
           expect(client.url).to eq url
         end
+
         it 'sets team' do
           expect(client.team.domain).to eq 'dblockdotorg'
         end
+
         it 'sets teams' do
           expect(client.teams.count).to eq 1
           expect(client.teams.values.first).to eq client.team
         end
+
         it 'sets self' do
           expect(client.self.id).to eq 'U0J1GAHN1'
         end
-        it 'sets users' do
-          expect(client.users.count).to eq 35
+
+        it 'sets user' do
+          expect(client.users.count).to eq 1
           expect(client.users.values.first['id']).to eq 'U0J1GAHN1'
         end
-        it 'sets channels' do
-          expect(client.channels.count).to eq 156
-          expect(client.channels.values.first['name']).to eq 'general'
-        end
-        it 'sets ims' do
-          expect(client.ims.count).to eq 10
-          expect(client.ims.values.first['user']).to eq 'U04KB5WQR'
-        end
-        it 'sets bots' do
-          expect(client.bots.count).to eq 83
-          expect(client.bots.values.first['name']).to eq 'bot'
-        end
-        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}"
@@ -123,14 +115,17 @@ RSpec.describe Slack::RealTime::Client do
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
       end
+
       it 'remembers socket' do
         expect(client.instance_variable_get(:@socket)).to eq socket
       end
+
       it 'cannot be invoked twice' do
         expect do
           client.start!
         end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
       end
+
       describe '#stop!' do
         before do
           allow(socket).to receive(:disconnect!)
@@ -164,18 +159,18 @@ RSpec.describe Slack::RealTime::Client do
       end
 
       describe '#run_handlers' do
-        describe 'empty events' do
+        context 'when store has no event hooks' do
           before do
-            @e = client.store.class.events
-            client.store.class.events = nil
+            @events = client.store.class.events.dup
+            client.store.class.events.clear
           end
 
           after do
-            client.store.class.events = @e
+            client.store.class.events.merge!(@events)
           end
 
-          it 'returns false when event is nil' do
-            expect(client.send(:run_handlers, 'example', {})).to be_nil
+          it 'returns empty array of handlers' do
+            expect(client.send(:run_handlers, 'example', {})).to be_empty
           end
         end
       end
@@ -199,6 +194,7 @@ RSpec.describe Slack::RealTime::Client do
           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)
@@ -206,6 +202,7 @@ RSpec.describe Slack::RealTime::Client do
           expect(socket).to receive(:restart_async)
           client.run_ping!
         end
+
         [
           EOFError,
           Errno::ECONNRESET,
@@ -266,30 +263,43 @@ RSpec.describe Slack::RealTime::Client do
         it 'sets url' do
           expect(client.url).to eq url
         end
+
         it 'sets team' do
           expect(client.team.domain).to eq 'dblockdotorg'
         end
+
         it 'sets self' do
           expect(client.self.id).to eq 'U0J1GAHN1'
         end
+
+        it 'no teams' do
+          expect(client.teams).to be_nil
+        end
+
         it 'no users' do
           expect(client.users).to be_nil
         end
-        it 'no teams' do
-          expect(client.teams).to be_nil
+
+        it 'no bots' do
+          expect(client.bots).to be_nil
         end
-        it 'no channels' do
-          expect(client.channels).to be_nil
+
+        it 'no public channels' do
+          expect(client.public_channels).to be_nil
         end
+
+        it 'no private channels' do
+          expect(client.private_channels).to be_nil
+        end
+
         it 'no ims' do
           expect(client.ims).to be_nil
         end
-        it 'no bots' do
-          expect(client.bots).to be_nil
-        end
-        it 'no groups' do
-          expect(client.groups).to be_nil
+
+        it 'no mpims' do
+          expect(client.mpims).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}"
@@ -300,14 +310,17 @@ RSpec.describe Slack::RealTime::Client do
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
       end
+
       it 'remembers socket' do
         expect(client.instance_variable_get(:@socket)).to eq socket
       end
+
       it 'cannot be invoked twice' do
         expect do
           client.start!
         end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
       end
+
       describe '#stop!' do
         before do
           allow(socket).to receive(:disconnect!)
@@ -338,6 +351,7 @@ RSpec.describe Slack::RealTime::Client do
     it 'sets store to nil' do
       expect(client.store).to be_nil
     end
+
     it "doesn't handle events" do
       event = Slack::RealTime::Event.new(
         'type' => 'team_rename',
@@ -346,12 +360,15 @@ RSpec.describe Slack::RealTime::Client do
       expect(client).not_to receive(:run_handlers)
       client.send(:dispatch, event)
     end
+
     it 'self' do
       expect(client.self).to be_nil
     end
+
     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+>$/)
@@ -366,15 +383,19 @@ RSpec.describe Slack::RealTime::Client do
       it 'sets ping' do
         expect(client.websocket_ping).to eq 30
       end
+
       it "doesn't set proxy" do
         expect(client.websocket_proxy).to be_nil
       end
+
       it 'defaults logger' do
         expect(client.send(:logger)).to be_a ::Logger
       end
+
       it 'sets default store_class' do
-        expect(client.send(:store_class)).to eq Slack::RealTime::Store
+        expect(client.send(:store_class)).to eq Slack::RealTime::Stores::Starter
       end
+
       (Slack::RealTime::Config::ATTRIBUTES - %i[logger store_class token]).each do |key|
         it "sets #{key}" do
           expect(client.send(key)).to eq Slack::RealTime::Config.send(key)
@@ -387,6 +408,7 @@ RSpec.describe Slack::RealTime::Client 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
@@ -416,6 +438,7 @@ RSpec.describe Slack::RealTime::Client do
       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
@@ -441,12 +464,14 @@ RSpec.describe Slack::RealTime::Client 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
+
+        it 'creates a connection with custom ping', vcr: { cassette_name: 'web/rtm_connect' } do
           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
           expect(client.start_options).to eq(request: { timeout: 180 })
         end
@@ -470,7 +495,8 @@ RSpec.describe Slack::RealTime::Client do
             headers: { 'User-Agent' => 'ruby' }
           )
         end
-        it 'creates a connection with custom proxy', vcr: { cassette_name: 'web/rtm_start' } do
+
+        it 'creates a connection with custom proxy', vcr: { cassette_name: 'web/rtm_connect' } do
           expect(Slack::RealTime::Concurrency::Mock::WebSocket).to receive(:new).with(
             url,
             nil,
@@ -490,14 +516,15 @@ RSpec.describe Slack::RealTime::Client do
     context 'start_options' do
       before do
         described_class.configure do |config|
-          config.start_options = { simple_latest: true }
+          config.start_options = { presence_sub: true }
         end
       end
 
       describe '#initialize' do
         it 'sets start_options' do
-          expect(client.start_options).to eq(simple_latest: true)
+          expect(client.start_options).to eq(presence_sub: true)
         end
+
         context 'start!' do
           let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
 
@@ -507,9 +534,9 @@ RSpec.describe Slack::RealTime::Client do
             allow(socket).to receive(:start_sync)
           end
 
-          it 'calls rtm_start with start options', vcr: { cassette_name: 'web/rtm_start' } do
+          it 'calls rtm.connect with start options', vcr: { cassette_name: 'web/rtm_connect' } do
             expect(client.web_client).to(
-              receive(:rtm_start).with({ simple_latest: true }).and_call_original
+              receive(:rtm_connect).with({ presence_sub: true }).and_call_original
             )
             client.start!
           end
@@ -518,7 +545,7 @@ RSpec.describe Slack::RealTime::Client do
     end
 
     context 'store_class' do
-      context 'starter' do
+      context 'when configured with Starter class' do
         before do
           described_class.configure do |config|
             config.store_class = Slack::RealTime::Stores::Starter
@@ -526,13 +553,15 @@ RSpec.describe Slack::RealTime::Client do
         end
 
         describe '#initialize' do
-          it 'can be overriden explicitly' do
-            client = described_class.new(store_class: Slack::RealTime::Store)
-            expect(client.send(:store_class)).to eq Slack::RealTime::Store
+          it 'can override the configured store class' do
+            client = described_class.new(store_class: Slack::RealTime::Stores::Store)
+            expect(client.send(:store_class)).to eq Slack::RealTime::Stores::Store
           end
+
           it 'sets store_class' do
             expect(client.send(:store_class)).to eq(Slack::RealTime::Stores::Starter)
           end
+
           context 'start!' do
             let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
 
@@ -549,73 +578,6 @@ RSpec.describe Slack::RealTime::Client do
           end
         end
       end
-
-      context 'store' do
-        before do
-          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!
-            end
-          end
-        end
-      end
-    end
-
-    context 'start_method' do
-      describe '#initialize' do
-        it 'can be overriden explicitly' do
-          client = described_class.new(start_method: :overriden)
-          expect(client.send(:start_method)).to eq :overriden
-        end
-        context 'with start_method' do
-          before do
-            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
-          it 'calls the overriden method' do
-            expect(client.web_client).to receive(:overriden).and_raise('overriden')
-            expect do
-              client.start!
-            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
-            expect(client.web_client).to receive(:rtm_start).and_call_original
-            client.start!
-          end
-        end
-      end
     end
   end
 end

data/spec/slack/real_time/event_handlers/bot_spec.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
 
   context 'bot' do
-    it 'sets bot data on rtm.start' do
-      expect(client.bots.count).to eq 83
-    end
     it 'bot_added' do
       expect do
         event = Slack::RealTime::Event.new(
@@ -27,19 +24,24 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       expect(bot['name']).to eq 'hugbot'
       expect(bot['icons']['image_48']).to eq 'https:\/\/slack.com\/path\/to\/hugbot_48.png'
     end
-    it 'bot_changed' do
-      expect do
-        event = Slack::RealTime::Event.new(
-          'type' => 'bot_changed',
-          'bot' => {
-            'id' => 'B0751JU2H',
-            'name' => 'hugbot'
-          }
-        )
-        client.send(:dispatch, event)
-      end.not_to change(client.bots, :count)
-      bot = client.bots['B0751JU2H']
-      expect(bot['name']).to eq 'hugbot'
+
+    context 'with bot loaded in the store' do
+      include_context 'loaded client'
+
+      it 'bot_changed' do
+        expect do
+          event = Slack::RealTime::Event.new(
+            'type' => 'bot_changed',
+            'bot' => {
+              'id' => 'B0751JU2H',
+              'name' => 'hugbot'
+            }
+          )
+          client.send(:dispatch, event)
+        end.not_to change(client.bots, :count)
+        bot = client.bots['B0751JU2H']
+        expect(bot['name']).to eq 'hugbot'
+      end
     end
   end
 end

data/spec/slack/real_time/event_handlers/event_handlers_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
 
   it 'is not fatal' do

data/spec/slack/real_time/event_handlers/im_spec.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
 
   context 'im' do
-    it 'sets im data' do
-      expect(client.ims.count).to eq 10
-    end
     it 'im_created' do
       expect(client.ims['CDEADBEEF']).to be_nil
       event = Slack::RealTime::Event.new(
@@ -22,27 +19,33 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       expect(im).not_to be_nil
       expect(im.name).to eq 'beef'
     end
-    it 'im_open' do
-      im = client.ims['D0J1H6QTV']
-      expect(im).not_to be_nil
-      im.is_open = false
-      event = Slack::RealTime::Event.new(
-        'type' => 'im_open',
-        'channel' => 'D0J1H6QTV'
-      )
-      client.send(:dispatch, event)
-      expect(im.is_open).to be true
-    end
-    it 'im_close' do
-      im = client.ims['D0J1H6QTV']
-      expect(im).not_to be_nil
-      expect(im.is_open).to be true
-      event = Slack::RealTime::Event.new(
-        'type' => 'im_close',
-        'channel' => 'D0J1H6QTV'
-      )
-      client.send(:dispatch, event)
-      expect(im.is_open).to be false
+
+    context 'with im loaded in the store' do
+      include_context 'loaded client'
+
+      it 'im_open' do
+        im = client.ims['D0J1H6QTV']
+        expect(im).not_to be_nil
+        im.is_open = false
+        event = Slack::RealTime::Event.new(
+          'type' => 'im_open',
+          'channel' => 'D0J1H6QTV'
+        )
+        client.send(:dispatch, event)
+        expect(im.is_open).to be true
+      end
+
+      it 'im_close' do
+        im = client.ims['D0J1H6QTV']
+        expect(im).not_to be_nil
+        expect(im.is_open).to be true
+        event = Slack::RealTime::Event.new(
+          'type' => 'im_close',
+          'channel' => 'D0J1H6QTV'
+        )
+        client.send(:dispatch, event)
+        expect(im.is_open).to be false
+      end
     end
   end
 end

data/spec/slack/real_time/event_handlers/{group_spec.rb → private_channel_spec.rb}

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
+  include_context 'loaded client'
 
-  context 'group' do
-    it 'sets group data' do
-      expect(client.groups.count).to eq 1
+  context 'private channel' do
+    it 'sets private channel data' do
+      expect(client.private_channels.count).to eq 1
     end
+
     it 'group_joined' do
-      expect(client.groups['CDEADBEEF']).to be_nil
+      expect(client.private_channels['CDEADBEEF']).to be_nil
       event = Slack::RealTime::Event.new(
         'type' => 'group_joined',
         'channel' => {
@@ -18,43 +20,47 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
         }
       )
       client.send(:dispatch, event)
-      group = client.groups['CDEADBEEF']
-      expect(group).not_to be_nil
-      expect(group.name).to eq 'beef'
+      channel = client.private_channels['CDEADBEEF']
+      expect(channel).not_to be_nil
+      expect(channel.name).to eq 'beef'
     end
+
     it 'group_left' do
-      group = client.groups['G0K7EV5A7']
-      expect(group.members).to include client.self.id
+      channel = client.private_channels['G0K7EV5A7']
+      expect(channel.members).to include client.self.id
       event = Slack::RealTime::Event.new(
         'type' => 'group_left',
         'channel' => 'G0K7EV5A7'
       )
       client.send(:dispatch, event)
-      expect(group.members).not_to include client.self.id
+      expect(client.private_channels['G0K7EV5A7']).to be_nil
     end
+
     it 'group_archive' do
-      group = client.groups['G0K7EV5A7']
-      expect(group.is_archived).to be false
+      channel = client.private_channels['G0K7EV5A7']
+      expect(channel.is_archived).to be false
       event = Slack::RealTime::Event.new(
         'type' => 'group_archive',
         'channel' => 'G0K7EV5A7'
       )
       client.send(:dispatch, event)
-      expect(group.is_archived).to be true
+      expect(channel.is_archived).to be true
     end
+
     it 'group_unarchive' do
-      group = client.groups['G0K7EV5A7']
-      group.is_archived = true
+      channel = client.private_channels['G0K7EV5A7']
+      channel.is_archived = true
       event = Slack::RealTime::Event.new(
         'type' => 'group_unarchive',
         'channel' => 'G0K7EV5A7'
       )
       client.send(:dispatch, event)
-      expect(group.is_archived).to be false
+      expect(channel.is_archived).to be false
     end
+
     it 'group_rename' do
-      group = client.groups['G0K7EV5A7']
-      expect(group.name).to eq 'mpdm-dblock--rubybot--player1-1'
+      channel = client.private_channels['G0K7EV5A7']
+      expect(channel.name).to eq 'mpdm-dblock--rubybot--player1-1'
       event = Slack::RealTime::Event.new(
         'type' => 'group_rename',
         'channel' => {
@@ -64,28 +70,30 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
         }
       )
       client.send(:dispatch, event)
-      expect(group.name).to eq 'updated'
+      expect(channel.name).to eq 'updated'
     end
+
     it 'group_open' do
-      group = client.groups['G0K7EV5A7']
-      expect(group).not_to be_nil
+      channel = client.private_channels['G0K7EV5A7']
+      expect(channel).not_to be_nil
       event = Slack::RealTime::Event.new(
         'type' => 'group_open',
         'channel' => 'G0K7EV5A7'
       )
       client.send(:dispatch, event)
-      expect(group.is_open).to be true
+      expect(channel.is_open).to be true
     end
+
     it 'group_close' do
-      group = client.groups['G0K7EV5A7']
-      expect(group).not_to be_nil
-      group.is_open = true
+      channel = client.private_channels['G0K7EV5A7']
+      expect(channel).not_to be_nil
+      channel.is_open = true
       event = Slack::RealTime::Event.new(
         'type' => 'group_close',
         'channel' => 'G0K7EV5A7'
       )
       client.send(:dispatch, event)
-      expect(group.is_open).to be false
+      expect(channel.is_open).to be false
     end
   end
 end