slack-ruby-client 0.5.4 → 0.6.0

data/spec/integration/integration_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe 'integration test', skip: !ENV['SLACK_API_TOKEN'] && 'missing SLA
 
   before do
     client.on :hello do
-      logger.info "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+      logger.info "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
     end
 
     client.on :close do
@@ -69,7 +69,7 @@ RSpec.describe 'integration test', skip: !ENV['SLACK_API_TOKEN'] && 'missing SLA
       start_server
     end
 
-    let(:channel) { "@#{client.self['name']}" }
+    let(:channel) { "@#{client.self.name}" }
 
     it 'responds to message' do
       message = SecureRandom.hex
@@ -77,9 +77,9 @@ RSpec.describe 'integration test', skip: !ENV['SLACK_API_TOKEN'] && 'missing SLA
       client.on :message do |data|
         logger.debug data
         # concurrent execution of tests causes messages to arrive in any order
-        next unless data['text'] == message
-        expect(data['text']).to eq message
-        expect(data['subtype']).to eq 'bot_message'
+        next unless data.text == message
+        expect(data.text).to eq message
+        expect(data.subtype).to eq 'bot_message'
         logger.debug 'client.stop!'
         expect(client.started?).to be true
         client.stop!

data/spec/slack/real_time/client_spec.rb

@@ -59,29 +59,33 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
             expect(client.url).to eq url
           end
           it 'sets team' do
-            expect(client.team['domain']).to eq 'dblockdotorg'
+            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 'U07518DTL'
+            expect(client.self.id).to eq 'U07518DTL'
           end
           it 'sets users' do
-            expect(client.users.count).to eq 7
-            expect(client.users.first['id']).to eq 'U07KECJ77'
+            expect(client.users.count).to eq 18
+            expect(client.users.values.first['id']).to eq 'U092BDCLV'
           end
           it 'sets channels' do
-            expect(client.channels.count).to eq 8
-            expect(client.channels.first['name']).to eq 'demo'
+            expect(client.channels.count).to eq 37
+            expect(client.channels.values.first['name']).to eq 'a1'
           end
           it 'sets ims' do
             expect(client.ims.count).to eq 2
-            expect(client.ims.first['user']).to eq 'USLACKBOT'
+            expect(client.ims.values.first['user']).to eq 'USLACKBOT'
           end
           it 'sets bots' do
-            expect(client.bots.count).to eq 5
-            expect(client.bots.first['name']).to eq 'bot'
+            expect(client.bots.count).to eq 16
+            expect(client.bots.values.first['name']).to eq 'bot'
           end
           it 'sets groups' do
-            expect(client.groups.count).to eq 0
+            expect(client.groups.count).to eq 1
           end
         end
         it 'uses web client to fetch url' do
@@ -113,6 +117,37 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
             expect(client.send(:next_id)).to eq previous_id + 1
           end
         end
+        context 'store_class: nil' do
+          let(:client) { Slack::RealTime::Client.new(store_class: nil) }
+          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',
+              'name' => 'New Team Name Inc.'
+            )
+            expect(client).to_not 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
+        end
+        context 'subclassed' do
+          let(:client) { Class.new(Slack::RealTime::Client).new }
+          it 'runs event handlers' do
+            event = Slack::RealTime::Event.new(
+              'type' => 'team_rename',
+              'name' => 'New Team Name Inc.'
+            )
+            client.send(:dispatch, event)
+            expect(client.store.team.name).to eq 'New Team Name Inc.'
+          end
+        end
       end
     end
     context 'with defaults' do
@@ -163,6 +198,9 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
           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({})
+        end
       end
     end
     context 'proxy' do
@@ -194,5 +232,29 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
         end
       end
     end
+    context 'start_options' do
+      before do
+        Slack::RealTime::Client.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).and_yield
+          end
+          it 'calls rtm_start with start options' do
+            expect(client.web_client).to receive(:rtm_start).with(simple_latest: true).and_call_original
+            client.start!
+          end
+        end
+      end
+    end
   end
 end

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

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } 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(
+          'type' => 'bot_added',
+          'bot' => {
+            'id' => 'B024BE7LH',
+            'name' => 'hugbot',
+            'icons' => {
+              'image_48' => 'https:\/\/slack.com\/path\/to\/hugbot_48.png'
+            }
+          })
+        client.send(:dispatch, event)
+      end.to change(client.bots, :count).by(1)
+      bot = client.bots['B024BE7LH']
+      expect(bot['id']).to eq 'B024BE7LH'
+      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'
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+  include_context 'connected client'
+
+  context 'channel' do
+    it 'sets channel data' do
+      expect(client.channels.count).to eq 37
+    end
+    it 'channel_archive' do
+      channel = client.channels['C0HNTD0CW']
+      expect(channel.is_archived).to be false
+      event = Slack::RealTime::Event.new(
+        'type' => 'channel_archive',
+        'channel' => 'C0HNTD0CW',
+        'user' => 'U04KB5WQR'
+      )
+      client.send(:dispatch, event)
+      expect(channel.is_archived).to be true
+    end
+    it 'channel_created' do
+      expect(client.channels['C024BE91L']).to be nil
+      event = Slack::RealTime::Event.new(
+        'type' => 'channel_created',
+        'channel' => {
+          'id' => 'C024BE91L',
+          'name' => 'fun',
+          'created' => 1_360_782_804,
+          'creator' => 'U04KB5WQR'
+        }
+      )
+      client.send(:dispatch, event)
+      channel = client.channels['C024BE91L']
+      expect(channel).to_not be nil
+      expect(channel.name).to eq 'fun'
+      expect(channel.creator).to eq 'U04KB5WQR'
+      expect(channel.created).to eq 1_360_782_804
+    end
+    it 'channel_deleted' do
+      expect(client.channels['C0HLE0BBL']).to_not be nil
+      event = Slack::RealTime::Event.new(
+        'type' => 'channel_deleted',
+        'channel' => 'C0HLE0BBL'
+      )
+      client.send(:dispatch, event)
+      expect(client.channels['C0HLE0BBL']).to be nil
+    end
+    context 'channel_joined' do
+      it 'creates channel' do
+        expect(client.channels['CDEADBEEF']).to be nil
+        event = Slack::RealTime::Event.new(
+          'type' => 'channel_joined',
+          'channel' => {
+            'id' => 'CDEADBEEF',
+            'name' => 'beef'
+          }
+        )
+        client.send(:dispatch, event)
+        channel = client.channels['CDEADBEEF']
+        expect(channel).to_not 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')
+        event = Slack::RealTime::Event.new(
+          'type' => 'channel_joined',
+          'channel' => {
+            'id' => 'CDEADBEEF',
+            'name' => 'beef',
+            'updated' => true
+          }
+        )
+        client.send(:dispatch, event)
+        channel = client.channels['CDEADBEEF']
+        expect(channel).to_not be nil
+        expect(channel.updated).to be true
+      end
+    end
+    it 'channel_left' do
+      channel = client.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
+    end
+    it 'channel_rename' do
+      channel = client.channels['C0HLE0BBL']
+      expect(channel.name).to eq 'gifs'
+      event = Slack::RealTime::Event.new(
+        'type' => 'channel_rename',
+        'channel' => {
+          'id' => 'C0HLE0BBL',
+          'name' => 'updated',
+          'created' => 1_360_782_804
+        }
+      )
+      client.send(:dispatch, event)
+      expect(channel.name).to eq 'updated'
+    end
+    it 'channel_unarchive' do
+      channel = client.channels['C0HLE0BBL']
+      expect(channel.is_archived).to be true
+      event = Slack::RealTime::Event.new(
+        'type' => 'channel_unarchive',
+        'channel' => 'C0HLE0BBL',
+        'user' => 'U04KB5WQR'
+      )
+      client.send(:dispatch, event)
+      expect(channel.is_archived).to be false
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+  include_context 'connected client'
+
+  context 'group' do
+    it 'sets group data' do
+      expect(client.groups.count).to eq 1
+    end
+    it 'group_joined' do
+      expect(client.groups['CDEADBEEF']).to be nil
+      event = Slack::RealTime::Event.new(
+        'type' => 'group_joined',
+        'channel' => {
+          'id' => 'CDEADBEEF',
+          'name' => 'beef'
+        }
+      )
+      client.send(:dispatch, event)
+      group = client.groups['CDEADBEEF']
+      expect(group).to_not be nil
+      expect(group.name).to eq 'beef'
+    end
+    it 'group_left' do
+      group = client.groups['G0K7EV5A7']
+      expect(group.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
+    end
+    it 'group_archive' do
+      group = client.groups['G0K7EV5A7']
+      expect(group.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
+    end
+    it 'group_unarchive' do
+      group = client.groups['G0K7EV5A7']
+      group.is_archived = true
+      event = Slack::RealTime::Event.new(
+        'type' => 'group_unarchive',
+        'channel' => 'G0K7EV5A7'
+      )
+      client.send(:dispatch, event)
+      expect(group.is_archived).to be false
+    end
+    it 'group_rename' do
+      group = client.groups['G0K7EV5A7']
+      expect(group.name).to eq 'mpdm-dblock--rubybot--player1-1'
+      event = Slack::RealTime::Event.new(
+        'type' => 'group_rename',
+        'channel' => {
+          'id' => 'G0K7EV5A7',
+          'name' => 'updated',
+          'created' => 1_360_782_804
+        }
+      )
+      client.send(:dispatch, event)
+      expect(group.name).to eq 'updated'
+    end
+    it 'group_open' do
+      group = client.groups['G0K7EV5A7']
+      expect(group).to_not be_nil
+      event = Slack::RealTime::Event.new(
+        'type' => 'group_open',
+        'channel' => 'G0K7EV5A7'
+      )
+      client.send(:dispatch, event)
+      expect(group.is_open).to be true
+    end
+    it 'group_close' do
+      group = client.groups['G0K7EV5A7']
+      expect(group).to_not be_nil
+      group.is_open = true
+      event = Slack::RealTime::Event.new(
+        'type' => 'group_close',
+        'channel' => 'G0K7EV5A7'
+      )
+      client.send(:dispatch, event)
+      expect(group.is_open).to be false
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } 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
+      event = Slack::RealTime::Event.new(
+        'type' => 'im_created',
+        'channel' => {
+          'id' => 'CDEADBEEF',
+          'name' => 'beef'
+        }
+      )
+      client.send(:dispatch, event)
+      im = client.ims['CDEADBEEF']
+      expect(im).to_not 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
+    end
+  end
+end