slack-ruby-client 0.11.1 → 1.1.0

data/.travis.yml

@@ -1,30 +0,0 @@
-language: ruby
-
-cache: bundler
-
-rvm:
-  - 2.2
-  - 2.1
-  - 2.3.4
-  - ruby-head
-  - jruby-head
-
-matrix:
-  include:
-    - rvm: 2.4.1
-      script:
-        - bundle exec danger
-    - rvm: 2.4.1
-      env: CONCURRENCY=celluloid-io
-    - rvm: 2.4.1
-      env: CONCURRENCY=faye-websocket
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-
-git:
-  submodules: false
-
-before_install:
-  - gem update bundler
-  - gem update --system

data/examples/hi_real_time/Gemfile

@@ -1,5 +0,0 @@
-source 'http://rubygems.org'
-
-gem 'slack-ruby-client', path: '../..'
-
-gem 'celluloid-io', require: ['celluloid/current', 'celluloid/io']

data/examples/hi_real_time/hi.rb

@@ -1,37 +0,0 @@
-require 'slack-ruby-client'
-
-Slack.configure do |config|
-  config.token = ENV['SLACK_API_TOKEN']
-  config.logger = Logger.new(STDOUT)
-  config.logger.level = Logger::INFO
-  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
-end
-
-client = Slack::RealTime::Client.new
-
-client.on :hello do
-  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-end
-
-client.on :message do |data|
-  puts data
-
-  client.typing channel: data.channel
-
-  case data.text
-  when 'bot hi' then
-    client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-  when /^bot/ then
-    client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
-  end
-end
-
-client.on :close do |_data|
-  puts 'Connection closing, exiting.'
-end
-
-client.on :closed do |_data|
-  puts 'Connection has been disconnected.'
-end
-
-client.start!

data/examples/hi_real_time_async_celluloid/Gemfile

@@ -1,6 +0,0 @@
-source 'http://rubygems.org'
-
-gem 'slack-ruby-client', path: '../..'
-
-gem 'celluloid-io', require: ['celluloid/current', 'celluloid/io']
-gem 'foreman'

data/examples/hi_real_time_async_eventmachine/Procfile

@@ -1,2 +0,0 @@
-console: bundle exec ruby hi.rb
-

data/examples/hi_real_time_async_eventmachine/hi.rb

@@ -1,36 +0,0 @@
-require 'slack-ruby-client'
-
-raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
-
-$stdout.sync = true
-logger = Logger.new($stdout)
-logger.level = Logger::DEBUG
-
-ENV['SLACK_API_TOKENS'].split.each do |token|
-  logger.info "Starting #{token[0..12]} ..."
-
-  client = Slack::RealTime::Client.new(token: token)
-
-  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."
-  end
-
-  client.on :message do |data|
-    logger.info data
-
-    client.typing channel: data.channel
-
-    case data.text
-    when 'bot hi' then
-      client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    when /^bot/ then
-      client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
-    end
-  end
-
-  client.start_async
-end
-
-loop do
-  Thread.pass
-end

data/lib/slack/real_time/concurrency/celluloid.rb

@@ -1,117 +0,0 @@
-require 'websocket/driver'
-require 'socket'
-require 'forwardable'
-require 'celluloid/current'
-require 'celluloid/io'
-
-module Slack
-  module RealTime
-    module Concurrency
-      module Celluloid
-        class Socket < Slack::RealTime::Socket
-          include ::Celluloid::IO
-          include ::Celluloid::Internals::Logger
-
-          BLOCK_SIZE = 4096
-
-          extend ::Forwardable
-          def_delegators :driver, :text, :binary
-
-          attr_reader :socket
-
-          def initialize(*args)
-            super
-          end
-
-          def connect!
-            super
-            run_loop
-          end
-
-          def run_loop
-            @closing = false
-            @socket = build_socket
-            @connected = @socket.connect
-            driver.start
-            loop { read } if socket
-          rescue EOFError, Errno::EPIPE => e
-            logger.debug("#{self.class}##{__method__}") { e }
-            driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')) unless @closing
-          ensure
-            begin
-              current_actor.terminate if current_actor.alive?
-            rescue
-              nil
-            end
-          end
-
-          def close
-            @closing = true
-            driver.close
-            super
-          end
-
-          def read
-            buffer = socket.readpartial(BLOCK_SIZE)
-            async.handle_read(buffer)
-          end
-
-          def handle_read(buffer)
-            logger.debug("#{self.class}##{__method__}") { buffer }
-            driver.parse buffer
-          end
-
-          def write(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            socket.write(data)
-          end
-
-          def start_async(client)
-            @client = client
-            Actor.new(future.run_client_loop)
-          end
-
-          def run_client_loop
-            @client.run_loop
-          end
-
-          def connected?
-            !@connected.nil?
-          end
-
-          protected
-
-          class Actor
-            attr_reader :future
-
-            def initialize(future)
-              @future = future
-            end
-
-            def join
-              @future.value
-            end
-          end
-
-          def build_socket
-            socket = ::Celluloid::IO::TCPSocket.new(addr, port)
-            socket = ::Celluloid::IO::SSLSocket.new(socket, build_ssl_context) if secure?
-            socket
-          end
-
-          def build_ssl_context
-            OpenSSL::SSL::SSLContext.new(:TLSv1_2_client)
-          end
-
-          def build_driver
-            ::WebSocket::Driver.client(self)
-          end
-
-          def connect
-            @driver = build_driver
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/real_time/concurrency/eventmachine.rb

@@ -1,60 +0,0 @@
-require 'faye/websocket'
-require 'eventmachine'
-
-module Slack
-  module RealTime
-    module Concurrency
-      module Eventmachine
-        class Client < Faye::WebSocket::Client
-          attr_reader :logger
-          protected :logger
-
-          def initialize(url, protocols = nil, options = {})
-            @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
-            super
-          end
-
-          def parse(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            super data
-          end
-
-          def write(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            super data
-          end
-        end
-
-        class Socket < Slack::RealTime::Socket
-          def start_async(client)
-            thread = ensure_reactor_running
-
-            client.run_loop
-
-            thread
-          end
-
-          def send_data(message)
-            logger.debug("#{self.class}##{__method__}") { message }
-            driver.send(message)
-          end
-
-          protected
-
-          # @return [Thread]
-          def ensure_reactor_running
-            return if EventMachine.reactor_running?
-
-            reactor = Thread.new { EventMachine.run }
-            Thread.pass until EventMachine.reactor_running?
-            reactor
-          end
-
-          def connect
-            @driver = Client.new(url, nil, options.merge(logger: logger))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/mixins/channels.id.json

@@ -1,20 +0,0 @@
-{
-  "mixin": true,
-  "group": "channels",
-  "name": "channels.id",
-  "desc": "This method returns the ID of a team channel.",
-  "args": {
-    "channel": {
-      "required": true,
-      "example": "#general",
-      "desc": "Channel to get ID for, prefixed with #.",
-      "type": "channel"
-    }
-  },
-  "errors": {
-    "channel_not_found": "Value passed for channel was invalid.",
-    "not_authed": "No authentication token provided.",
-    "invalid_auth": "Invalid authentication token.",
-    "account_inactive": "Authentication token is for a deleted user or team."
-  }
-}

data/lib/slack/web/api/mixins/groups.id.json

@@ -1,20 +0,0 @@
-{
-  "mixin": true,
-  "group": "groups",
-  "name": "groups.id",
-  "desc": "This method returns the ID of a group.",
-  "args": {
-    "channel": {
-      "required": true,
-      "example": "#general",
-      "desc": "Group channel to get ID for, prefixed with #.",
-      "type": "group"
-    }
-  },
-  "errors": {
-    "channel_not_found": "Value passed for group was invalid.",
-    "not_authed": "No authentication token provided.",
-    "invalid_auth": "Invalid authentication token.",
-    "account_inactive": "Authentication token is for a deleted user or team."
-  }
-}

data/lib/slack/web/api/mixins/groups.id.rb

@@ -1,26 +0,0 @@
-require_relative 'ids.id'
-
-module Slack
-  module Web
-    module Api
-      module Mixins
-        module Groups
-          include Ids
-          #
-          # This method returns a group ID given a group name.
-          #
-          # @option options [channel] :channel
-          #   Group channel to get ID for, prefixed with #.
-          def groups_id(options = {})
-            name = options[:channel]
-            throw ArgumentError.new('Required arguments :channel missing') if name.nil?
-
-            id_for(:group, name, '#', :groups, 'channel_not_found') do
-              groups_list
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch

@@ -1,13 +0,0 @@
-diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
-index 1f7a8d7..2ec4bed 100644
---- a/lib/slack/web/api/endpoints/chat.rb
-+++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -49,7 +49,7 @@ module Slack
-           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
-           def chat_postMessage(options = {})
-             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
--            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
-+            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
-             post('chat.postMessage', options)
-           end
-

data/lib/slack/web/api/patches/chat.2.attachments-json.patch

@@ -1,17 +0,0 @@
-diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
-index 1f7a8d7..89b1562 100644
---- a/lib/slack/web/api/endpoints/chat.rb
-+++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -50,6 +50,12 @@ module Slack
-           def chat_postMessage(options = {})
-             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-             throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
-+            # attachments must be passed as an encoded JSON string
-+            if options.key?(:attachments)
-+              attachments = options[:attachments]
-+              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
-+              options = options.merge(attachments: attachments)
-+            end
-             post('chat.postMessage', options)
-           end
-

data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch

@@ -1,21 +0,0 @@
-diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
-index 5186416..490bc91 100644
---- a/lib/slack/web/api/endpoints/chat.rb
-+++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -154,9 +154,15 @@ module Slack
-           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
-           def chat_update(options = {})
-             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
--            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
-+            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
-             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
-             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-+            # attachments must be passed as an encoded JSON string
-+            if options.key?(:attachments)
-+              attachments = options[:attachments]
-+              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
-+              options = options.merge(attachments: attachments)
-+            end
-             post('chat.update', options)
-           end
-         end

data/lib/slack/web/api/patches/chat.4.postEphemeral-attachments-support.patch

@@ -1,17 +0,0 @@
-diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
-index 846126e..0c254c6 100644
---- a/lib/slack/web/api/endpoints/chat.rb
-+++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -62,6 +62,12 @@ module Slack
-             throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
-             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
-             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-+            # attachments must be passed as an encoded JSON string
-+            if options.key?(:attachments)
-+              attachments = options[:attachments]
-+              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
-+              options = options.merge(attachments: attachments)
-+            end
-             post('chat.postEphemeral', options)
-           end
- 

data/spec/fixtures/slack/web/503_error.yml

@@ -1,14 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/auth.test
-  response:
-    status:
-      code: 503
-      message: Service Unavailable
-    body:
-      encoding: US-ASCII
-      string: ''
-    http_version:
-  recorded_at: Thu, 30 Nov 2017 14:36:26 GMT

data/spec/fixtures/slack/web/channels_info.yml

@@ -1,46 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/channels.list
-    body:
-      encoding: UTF-8
-      string: token=token
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=utf-8
-    body:
-      encoding: UTF-8
-      string: '{"ok":true,"channels":[{"id":"C04KB5X4D","name":"general","is_channel":true,"created":1430222230,"creator":"U04KB5WQR","is_archived":false,"is_general":true,"is_member":true,"last_read":"1435863302.000026","latest":{"type":"message","user":"U0HPMN0GY","text":"```\n{\"ok\":true,\"args\":{\"token\":\"xoxb-17803748576-H794PZkqOo4DkjYddb438F2J\"}}```","ts":"1452025068.000045"},"unread_count":321,"unread_count_display":283,"members":["U04JPQ0JS","U04JZBDQQ","U04KB5WQR"],"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"This
-        channel is for team-wide communication and announcements. All team members
-        are in this channel.","creator":"","last_set":0}}]}'
-    http_version:
-  recorded_at: Fri, 22 Jan 2016 19:01:46 GMT
-- request:
-    method: post
-    uri: https://slack.com/api/channels.info
-    body:
-      encoding: UTF-8
-      string: channel=C04KB5X4D&token=token
-    headers:
-      Content-Type:
-      - application/x-www-form-urlencoded
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=utf-8
-    body:
-      encoding: UTF-8
-      string: '{"ok":true,"channel":{"id":"C04KB5X4D","name":"general","is_channel":true,"created":1430222230,"creator":"U04KB5WQR","is_archived":false,"is_general":true,"is_member":true,"last_read":"1435863302.000026","latest":{"type":"message","user":"U0HPMN0GY","text":"```\n{\"ok\":true,\"args\":{\"token\":\"xoxb-17803748576-H794PZkqOo4DkjYddb438F2J\"}}```","ts":"1452025068.000045"},"unread_count":321,"unread_count_display":283,"members":["U04JPQ0JS","U04JZBDQQ","U04KB5WQR","U06JGTU5V","U07518DTL","U07KECJ77","U092BDCLV","U092V4E9L","U0EA7TZJN","U0H701CJZ","U0HLFUZLJ","U0HPMN0GY"],"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"This
-        channel is for team-wide communication and announcements. All team members
-        are in this channel.","creator":"","last_set":0}}}'
-    http_version:
-  recorded_at: Fri, 22 Jan 2016 19:01:46 GMT
-recorded_with: VCR 3.0.1

data/spec/fixtures/slack/web/groups_info.yml

@@ -1,43 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/groups.list
-    body:
-      encoding: UTF-8
-      string: token=token
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=utf-8
-    body:
-      encoding: ASCII-8BIT
-      string: '{"ok":true,"groups":[{"id":"G0K7EV5A7","name":"mpdm-dblock--rubybot--player1-1","is_group":true,"created":1453561861,"creator":"U04KB5WQR","is_archived":false,"is_mpim":true,"members":["U04KB5WQR","U0HLFUZLJ","U07518DTL"],"topic":{"value":"Group
-        messaging","creator":"U04KB5WQR","last_set":1453561861},"purpose":{"value":"Group
-        messaging with: @dblock @rubybot @player1","creator":"U04KB5WQR","last_set":1453561861}}]}'
-    http_version:
-  recorded_at: Sat, 23 Jan 2016 15:19:10 GMT
-- request:
-    method: post
-    uri: https://slack.com/api/groups.info
-    body:
-      encoding: UTF-8
-      string: channel=G0K7EV5A7&token=token
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=utf-8
-    body:
-      encoding: ASCII-8BIT
-      string: '{"ok":true,"group":{"id":"G0K7EV5A7","name":"mpdm-dblock--rubybot--player1-1","is_group":true,"created":1453561861,"creator":"U04KB5WQR","is_archived":false,"is_mpim":true,"is_open":false,"last_read":"0000000000.000000","latest":null,"unread_count":0,"unread_count_display":0,"members":["U04KB5WQR","U0HLFUZLJ","U07518DTL"],"topic":{"value":"Group
-        messaging","creator":"U04KB5WQR","last_set":1453561861},"purpose":{"value":"Group
-        messaging with: @dblock @rubybot @player1","creator":"U04KB5WQR","last_set":1453561861}}}'
-    http_version:
-  recorded_at: Sat, 23 Jan 2016 15:19:46 GMT
-recorded_with: VCR 3.0.0

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

@@ -1,62 +0,0 @@
-require 'spec_helper'
-require_relative './it_behaves_like_a_realtime_socket'
-
-begin
-  RSpec.describe Slack::RealTime::Concurrency::Celluloid::Socket do
-    it_behaves_like 'a realtime socket'
-    context 'with url' do
-      let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
-      let(:logger) { ::Logger.new(STDOUT) }
-
-      [EOFError, Errno::EPIPE].each do |err|
-        context "finishing run_loop with #{err}" do
-          let(:test_socket) do
-            Class.new(described_class) do
-              def read
-                raise options[:err]
-              end
-            end
-          end
-
-          let(:socket) do
-            test_socket.new(url, ping: 42, logger: logger, err: err)
-          end
-
-          let(:driver) { WebSocket::Driver::Client }
-          let(:ws) { double(driver) }
-          subject { socket }
-
-          describe '#connect!' do
-            pending 'connects'
-            pending 'pings every 30s'
-          end
-
-          context 'with a driver' do
-            before do
-              socket.instance_variable_set('@driver', ws)
-            end
-
-            describe '#disconnect!' do
-              it 'closes and nils the websocket' do
-                expect(ws).to receive(:close)
-                socket.disconnect!
-              end
-            end
-
-            context 'consumes data' do
-              it 'runs' do
-                expect(ws).to receive(:emit)
-                expect(ws).to receive(:start)
-                expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
-                socket.run_loop
-              end
-            end
-          end
-
-          pending 'send_data'
-        end
-      end
-    end
-  end
-rescue LoadError
-end

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

@@ -1,47 +0,0 @@
-require 'spec_helper'
-require_relative './it_behaves_like_a_realtime_socket'
-
-begin
-  RSpec.describe Slack::RealTime::Concurrency::Eventmachine::Socket do
-    it_behaves_like 'a realtime socket'
-    context 'with url' do
-      let(:url) { 'wss://ms174.slack-msgs.com/websocket/xyz' }
-      let(:logger) { ::Logger.new($stdout) }
-      let(:socket) { described_class.new(url, ping: 42, logger: logger) }
-      let(:ws) { double(Faye::WebSocket::Client) }
-      describe '#connect!' do
-        before do
-          allow(ws).to receive(:on).with(:close)
-        end
-        it 'connects' do
-          allow(Faye::WebSocket::Client).to receive(:new).and_return(ws)
-          socket.connect!
-          expect(socket.instance_variable_get('@driver')).to eq ws
-        end
-        it 'pings every 30s' do
-          expect(Faye::WebSocket::Client).to receive(:new).with(url, nil, ping: 42, logger: logger).and_return(ws)
-          socket.connect!
-        end
-      end
-      describe '#disconnect!' do
-        it 'closes and nils the websocket' do
-          socket.instance_variable_set('@driver', ws)
-          expect(ws).to receive(:close)
-          socket.disconnect!
-        end
-      end
-      describe 'send_data' do
-        before do
-          allow(Faye::WebSocket::Client).to receive(:new).and_return(ws)
-          allow(ws).to receive(:on)
-          socket.connect!
-        end
-        it 'sends data' do
-          expect(ws).to receive(:send).with('data')
-          socket.send_data('data')
-        end
-      end
-    end
-  end
-rescue LoadError
-end