slack-ruby-client 0.13.1 → 2.0.0

data/spec/slack/real_time/concurrency/it_behaves_like_a_realtime_socket.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.shared_examples_for 'a realtime socket' do
@@ -9,6 +10,7 @@ RSpec.shared_examples_for 'a realtime socket' do
       expect(socket.url).to eq url
     end
   end
+
   describe 'api' do
     %i[start_sync start_sync disconnect! connect! connected? send_data close].each do |m|
       it m do

data/spec/slack/real_time/concurrency/with_concurrency_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe 'with CONCURRENCY', skip: ( # rubocop:disable RSpec/DescribeClass
+  (!ENV['CONCURRENCY']) && 'missing CONCURRENCY'
+) do
+  it 'detects concurrency' do
+    expect(Slack::RealTime::Config.concurrency).to eq Slack::RealTime::Concurrency::Async
+  end
+end

data/spec/slack/real_time/concurrency/without_concurrency_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe 'without CONCURRENCY', skip: ( # rubocop:disable RSpec/DescribeClass
+  (ENV['CONCURRENCY']) && 'CONCURRENCY is set'
+) do
+  it 'raises NoConcurrencyError' do
+    expect { Slack::RealTime::Config.concurrency }.to raise_error Slack::RealTime::Config::NoConcurrencyError
+  end
+end

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

@@ -1,12 +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 16
-    end
     it 'bot_added' do
       expect do
         event = Slack::RealTime::Event.new(
@@ -26,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.to_not 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,6 +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
@@ -10,6 +11,6 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       'value' => 'updated.mp3'
     )
     expect(client.self).to receive(:prefs) { raise ArgumentError }
-    expect { client.send(:dispatch, event) }.to_not raise_error
+    expect { client.send(:dispatch, event) }.not_to raise_error
   end
 end

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

@@ -1,14 +1,12 @@
+# 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 2
-    end
     it 'im_created' do
-      expect(client.ims['CDEADBEEF']).to be nil
+      expect(client.ims['CDEADBEEF']).to be_nil
       event = Slack::RealTime::Event.new(
         'type' => 'im_created',
         'channel' => {
@@ -18,30 +16,36 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       )
       client.send(:dispatch, event)
       im = client.ims['CDEADBEEF']
-      expect(im).to_not be nil
+      expect(im).not_to be_nil
       expect(im.name).to eq 'beef'
     end
-    it 'im_open' do
-      im = client.ims['D07519J57']
-      expect(im).to_not be_nil
-      im.is_open = false
-      event = Slack::RealTime::Event.new(
-        'type' => 'im_open',
-        'channel' => 'D07519J57'
-      )
-      client.send(:dispatch, event)
-      expect(im.is_open).to be true
-    end
-    it 'im_close' do
-      im = client.ims['D07519J57']
-      expect(im).to_not be_nil
-      expect(im.is_open).to be true
-      event = Slack::RealTime::Event.new(
-        'type' => 'im_close',
-        'channel' => 'D07519J57'
-      )
-      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,14 +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' => {
@@ -17,43 +20,47 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
         }
       )
       client.send(:dispatch, event)
-      group = client.groups['CDEADBEEF']
-      expect(group).to_not 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).to_not 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' => {
@@ -63,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).to_not 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).to_not 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

data/spec/slack/real_time/event_handlers/{channel_spec.rb → public_channel_spec.rb}

@@ -1,14 +1,13 @@
+# 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 'channel' do
-    it 'sets channel data' do
-      expect(client.channels.count).to eq 37
-    end
+  context 'public channel' do
     it 'channel_archive' do
-      channel = client.channels['C0HNTD0CW']
+      channel = client.public_channels['C0HNTD0CW']
       expect(channel.is_archived).to be false
       event = Slack::RealTime::Event.new(
         'type' => 'channel_archive',
@@ -18,36 +17,39 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       client.send(:dispatch, event)
       expect(channel.is_archived).to be true
     end
+
     it 'channel_created' do
-      expect(client.channels['C024BE91L']).to be nil
+      expect(client.public_channels['C024BE91L']).to be_nil
       event = Slack::RealTime::Event.new(
         'type' => 'channel_created',
         'channel' => {
           'id' => 'C024BE91L',
           'name' => 'fun',
-          'created' => 1_360_782_804,
+          'created' => 1360782804,
           'creator' => 'U04KB5WQR'
         }
       )
       client.send(:dispatch, event)
-      channel = client.channels['C024BE91L']
-      expect(channel).to_not be nil
+      channel = client.public_channels['C024BE91L']
+      expect(channel).not_to be_nil
       expect(channel.name).to eq 'fun'
       expect(channel.creator).to eq 'U04KB5WQR'
-      expect(channel.created).to eq 1_360_782_804
+      expect(channel.created).to eq 1360782804
     end
+
     it 'channel_deleted' do
-      expect(client.channels['C0HLE0BBL']).to_not be nil
+      expect(client.public_channels['C0HLE0BBL']).not_to be_nil
       event = Slack::RealTime::Event.new(
         'type' => 'channel_deleted',
         'channel' => 'C0HLE0BBL'
       )
       client.send(:dispatch, event)
-      expect(client.channels['C0HLE0BBL']).to be nil
+      expect(client.public_channels['C0HLE0BBL']).to be_nil
     end
+
     context 'channel_joined' do
       it 'creates channel' do
-        expect(client.channels['CDEADBEEF']).to be nil
+        expect(client.public_channels['CDEADBEEF']).to be_nil
         event = Slack::RealTime::Event.new(
           'type' => 'channel_joined',
           'channel' => {
@@ -56,13 +58,15 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
           }
         )
         client.send(:dispatch, event)
-        channel = client.channels['CDEADBEEF']
-        expect(channel).to_not be nil
+        channel = client.public_channels['CDEADBEEF']
+        expect(channel).not_to be_nil
         expect(channel.name).to eq 'beef'
       end
+
       it 'updates channel' do
-        expect(client.channels['CDEADBEEF']).to be nil
-        client.channels['CDEADBEEF'] = Slack::RealTime::Models::Channel.new('id' => 'CDEADBEEF', name: 'beef')
+        expect(client.public_channels['CDEADBEEF']).to be_nil
+        client.public_channels['CDEADBEEF'] =
+          Slack::RealTime::Models::Channel.new('id' => 'CDEADBEEF', name: 'beef')
         event = Slack::RealTime::Event.new(
           'type' => 'channel_joined',
           'channel' => {
@@ -72,23 +76,25 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
           }
         )
         client.send(:dispatch, event)
-        channel = client.channels['CDEADBEEF']
-        expect(channel).to_not be nil
+        channel = client.public_channels['CDEADBEEF']
+        expect(channel).not_to be_nil
         expect(channel.updated).to be true
       end
     end
+
     it 'channel_left' do
-      channel = client.channels['C0JHNAB5H']
+      channel = client.public_channels['C0JHNAB5H']
       expect(channel.members).to include client.self.id
       event = Slack::RealTime::Event.new(
         'type' => 'channel_left',
         'channel' => 'C0JHNAB5H'
       )
       client.send(:dispatch, event)
-      expect(channel.members).to_not include client.self.id
+      expect(channel.members).not_to include client.self.id
     end
+
     it 'channel_rename' do
-      channel = client.channels['C0HLE0BBL']
+      channel = client.public_channels['C0HLE0BBL']
       expect(channel.name).to eq 'gifs'
       event = Slack::RealTime::Event.new(
         'type' => 'channel_rename',
@@ -101,8 +107,9 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       client.send(:dispatch, event)
       expect(channel.name).to eq 'updated'
     end
+
     it 'channel_unarchive' do
-      channel = client.channels['C0HLE0BBL']
+      channel = client.public_channels['C0HLE0BBL']
       expect(channel.is_archived).to be true
       event = Slack::RealTime::Event.new(
         'type' => 'channel_unarchive',

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

@@ -1,19 +1,16 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 [Slack::RealTime::Stores::Store, Slack::RealTime::Stores::Starter].each do |store_class|
-  RSpec.describe store_class, vcr: { cassette_name: store_class == Slack::RealTime::Stores::Store ? 'web/rtm_start' : 'web/rtm_connect' } do
+  RSpec.describe store_class, vcr: { cassette_name: 'web/rtm_connect' } do
     include_context 'connected client', store_class: store_class
 
     context 'team' do
-      it 'sets team data on rtm.start' do
+      it 'sets team data on rtm.connect' do
         expect(client.team.name).to eq 'dblock'
         expect(client.team.domain).to eq 'dblockdotorg'
-        if store_class == Slack::RealTime::Stores::Store
-          expect(client.team.email_domain).to eq 'dblock.org'
-          expect(client.team.prefs.invites_only_admins).to be true
-          expect(client.team.plan).to eq ''
-        end
       end
+
       it 'team_domain_change' do
         event = Slack::RealTime::Event.new(
           'type' => 'team_domain_change',
@@ -24,6 +21,7 @@ require 'spec_helper'
         expect(client.team.domain).to eq 'my'
         expect(client.team['url']).to eq 'https://my.slack.com'
       end
+
       it 'email_domain_changed' do
         event = Slack::RealTime::Event.new(
           'type' => 'email_domain_changed',
@@ -32,6 +30,7 @@ require 'spec_helper'
         client.send(:dispatch, event)
         expect(client.team.email_domain).to eq 'example.com'
       end
+
       it 'team_pref_change' do
         event = Slack::RealTime::Event.new(
           'type' => 'team_pref_change',
@@ -41,6 +40,7 @@ require 'spec_helper'
         client.send(:dispatch, event)
         expect(client.team.prefs.invites_only_admins).to be false
       end
+
       it 'team_rename' do
         event = Slack::RealTime::Event.new(
           'type' => 'team_rename',
@@ -49,6 +49,7 @@ require 'spec_helper'
         client.send(:dispatch, event)
         expect(client.team.name).to eq 'New Team Name Inc.'
       end
+
       it 'team_plan_change' do
         event = Slack::RealTime::Event.new(
           'type' => 'team_plan_change',

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

@@ -1,13 +1,11 @@
+# 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 'user' do
-    it 'combines user and self data on rtm.start' do
-      expect(client.users['U07518DTL'].name).to eq 'rubybot'
-      expect(client.users['U07518DTL']['prefs']['push_sound']).to eq 'b2.mp3'
-    end
     it 'user_change' do
       expect(client.users['U07KECJ77'].name).to eq 'aws'
       event = Slack::RealTime::Event.new(
@@ -19,6 +17,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       client.send(:dispatch, event)
       expect(client.users['U07KECJ77'].name).to eq 'renamed'
     end
+
     it 'team_join' do
       expect do
         event = Slack::RealTime::Event.new(
@@ -31,6 +30,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       end.to change(client.users, :count).by(1)
       expect(client.users['DEADBEEF'].name).to eq 'added'
     end
+
     it 'pref_change' do
       event = Slack::RealTime::Event.new(
         'type' => 'pref_change',
@@ -40,6 +40,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       client.send(:dispatch, event)
       expect(client.self.prefs['push_sound']).to eq 'updated.mp3'
     end
+
     it 'presence_change' do
       expect(client.users['U07KECJ77'].presence).to eq 'away'
       event = Slack::RealTime::Event.new(
@@ -50,6 +51,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       client.send(:dispatch, event)
       expect(client.users['U07KECJ77'].presence).to eq 'updated'
     end
+
     it 'manual_presence_change' do
       expect(client.self['presence']).to eq 'away'
       event = Slack::RealTime::Event.new(

data/spec/slack/real_time/rtm_connect_spec.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 # require 'spec_helper'
 
 #
 # to re-record a rtm_connect fixture run with
-# SLACK_API_TOKEN=... CONCURRENCY=faye-websocket rspec spec/slack/real_time/rtm_connect_spec.rb
+# SLACK_API_TOKEN=... CONCURRENCY=async-websocket rspec spec/slack/real_time/rtm_connect_spec.rb
 # edit rtm_connect.yml and remove the token, fix wss:// path (run specs, fix failures)
 #
 

data/spec/slack/real_time/stores/store_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Slack::RealTime::Stores::Store do
+  it 'can be initialized with an empty hash' do
+    store = described_class.new(Hashie::Mash.new)
+    expect(store.team).to be_nil
+    expect(store.teams.count).to eq 0
+    expect(store.self).to be_nil
+    expect(store.public_channels.count).to eq 0
+    expect(store.private_channels.count).to eq 0
+  end
+
+  it 'includes event handlers in subclasses' do
+    subclass = Class.new(described_class)
+    expect(subclass.events.key?('channel_created')).to be true
+  end
+
+  context 'with client started' do
+    let(:client) { Slack::RealTime::Client.new(store_class: described_class, concurrency: Slack::RealTime::Concurrency::Mock) }
+
+    before do
+      client.store = described_class.new(Hashie::Mash.new, { caches: :all })
+    end
+
+    it 'initializes itself with data' do
+      team_info = Hashie::Mash.new(team: {})
+      allow(client.web_client).to receive(:team_info).and_return(team_info)
+      expect(client.web_client).to receive(:team_info)
+      expect(client.web_client).to receive(:users_list)
+      expect(client.web_client).to receive(:conversations_list).with(types: 'public_channel,private_channel,im,mpim')
+      event = Slack::RealTime::Event.new('type' => 'hello', 'start' => true)
+      client.send(:dispatch, event)
+    end
+
+    context 'when configured to only cache some types' do
+      before do
+        client.store = described_class.new(Hashie::Mash.new, { caches: %i[users public_channels] })
+      end
+
+      it 'initializes specified caches with data' do
+        expect(client.web_client).to receive(:users_list)
+        expect(client.web_client).to receive(:conversations_list).with(types: 'public_channel')
+        event = Slack::RealTime::Event.new('type' => 'hello', 'start' => true)
+        client.send(:dispatch, event)
+      end
+    end
+  end
+end