slack-ruby-client 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb40a47e675fcf0265b109933983e54e11b6c9df574d355debde7c8ec5430148
-  data.tar.gz: 3e32b46f06a4e0d28db8e2bcdd329b57b1d719adadc8e8fcc246f45e6128c59e
+  metadata.gz: 7a9bf266ef0726336ea6cdd36426970d5a21663646cf066e72a74a23b4c175d6
+  data.tar.gz: e36dd13202ddfe6bb65cc2bfde27f8ac27350da4114dfdf9545d1c6f2d0f0611
 SHA512:
-  metadata.gz: 53da5f288963057384831ff33711031fa866aad91f3857eeaae312e303640a60316459ddd20f18940d145aa4b9cf57cd7c8fdff9dee82ecb912b809f85db49cd
-  data.tar.gz: f235bb2ea8e6b5e64d247e2727d50618d54e9af471a4fd73c0e02bf43d0d70dda712b5e973c8033ecebd20501843eb6eb11eaf57cd53c1f71b4b45fd411b03f5
+  metadata.gz: 5ab13f62322d8f5b9f3b6723a003fc7303806b03f42a68d53eaf2bf12d6f96375d895c03ce6a4657cd26f74ce2c137fb04c4b88946ff0e3c5dbd8076ea285ee2
+  data.tar.gz: cf23b660a516ce28249b8de57e814bd997e828f712c467db46c28a6ea9be64827cf82d594369df686b4ab3c00c4a4968a40f83308b73d49b19469d667c385551

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-20 08:24:54 -0400 using RuboCop version 0.58.2.
+# on 2018-08-27 13:29:57 +0200 using RuboCop version 0.58.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/.travis.yml

@@ -18,6 +18,8 @@ matrix:
       env: CONCURRENCY=celluloid-io
     - rvm: 2.4.1
       env: CONCURRENCY=faye-websocket
+    - rvm: 2.5
+      env: CONCURRENCY=async-websocket
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.13.0 (Next)
+
+* [#219](https://github.com/slack-ruby/slack-ruby-client/pull/219): Added support for `async-websocket` - [@dblock](https://github.com/dblock), [@ioquatix](https://github.com/ioquatix).
+* [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224): Celluloid async support now uses  a thread per client - [@dblock](https://github.com/dblock).
+* [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224): Attempt to shutdown EventMachine if a reactor wasn't already running on start - [@dblock](https://github.com/dblock).
+* Your contribution here.
+
 ### 0.12.0 (8/20/2018)
 
 * [#216](https://github.com/slack-ruby/slack-ruby-client/pull/216): Handle `Errno::ECONNRESET` and empty buffer reads with celluloid-io - [@dblock](https://github.com/dblock).

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.12.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, v0.13.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -28,11 +28,10 @@ Add to Gemfile.
 gem 'slack-ruby-client'
 ```
 
-If you're going to be using the RealTime client, add either `eventmachine` and `faye-websocket` or `celluloid-io`. See below for more information about concurrency.
+If you're going to be using the RealTime client, add either `async-websocket`, `eventmachine` and `faye-websocket` or `celluloid-io`. See below for more information about concurrency. We recommend you use `async-websocket`.
 
 ```
-gem 'eventmachine'
-gem 'faye-websocket'
+gem 'async-websocket'
 ```
 
 Run `bundle install`.
@@ -374,11 +373,11 @@ See [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134) for a dis
 
 #### Concurrency
 
-`Slack::RealTime::Client` needs help from a concurrency library and supports [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine) and [Celluloid](https://github.com/celluloid/celluloid). It will auto-detect one or the other depending on the gems in your Gemfile, but you can also set concurrency explicitly.
+`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async), [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine) and [Celluloid](https://github.com/celluloid/celluloid). It will auto-detect one or the other depending on the gems in your Gemfile, but you can also set concurrency explicitly.
 
 ```ruby
 Slack::RealTime.configure do |config|
-  config.concurrency = Slack::RealTime::Concurrency::Eventmachine
+  config.concurrency = Slack::RealTime::Concurrency::Async
 end
 ```
 
@@ -390,6 +389,16 @@ client = Slack::RealTime::Client.new
 client.start_async
 ```
 
+##### Async
+
+This is the recommended library. Add `async-websocket` to your Gemfile.
+
+```
+gem 'async-websocket'
+```
+
+See a fully working example in [examples/hi_real_time_async_async](examples/hi_real_time_async_async/hi.rb).
+
 ##### Faye::Websocket with Eventmachine
 
 Add the following to your Gemfile.

data/UPGRADING.md

@@ -1,6 +1,22 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 0.13.0
+
+#### Recommended Async Library
+
+The RealTime client now supports [async-websocket](https://github.com/socketry/async-websocket), which is actively maintained and is now the recommended library.
+
+See [#219](https://github.com/slack-ruby/slack-ruby-client/pull/219) for implementation details.
+
+#### Async Library Threading and Reactor Changes
+
+The RealTime celluloid-io implementation now uses a `Thread` per client. Previous versions used an `Actor`.
+
+The faye-websocket implementation with EventMachine will attempt to shutdown EventMachine via `EventMachine.stop` upon shutdown if a reactor wasn't already running.
+
+See [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224) for more information.
+
 ### Upgrading to >= 0.9.0
 
 #### Changes in How the RTM Client Connects
@@ -37,7 +53,7 @@ Slack::RealTime::Client.config do |config|
 end
 ```
 
-See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more details.
+See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more information.
 
 ### Upgrading to >= 0.6.0
 

data/examples/hi_real_time_async_async/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-client', path: '../..'
+
+gem 'async-websocket'
+gem 'foreman'

data/examples/hi_real_time_async_async/Procfile

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

data/examples/hi_real_time_async_async/hi.rb

@@ -0,0 +1,37 @@
+require 'slack-ruby-client'
+require 'async'
+
+raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
+
+$stdout.sync = true
+logger = Logger.new($stdout)
+logger.level = Logger::DEBUG
+
+threads = []
+
+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 /hi/ then
+      client.message channel: data.channel, text: "Hi <@#{data.user}>!"
+    else
+      client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
+    end
+  end
+
+  threads << client.start_async
+end
+
+threads.each(&:join)

data/lib/slack/real_time/concurrency.rb

@@ -1,6 +1,7 @@
 module Slack
   module RealTime
     module Concurrency
+      autoload :Async, 'slack/real_time/concurrency/async'
       autoload :Eventmachine, 'slack/real_time/concurrency/eventmachine'
       autoload :Celluloid, 'slack/real_time/concurrency/celluloid'
     end

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

@@ -0,0 +1,67 @@
+require 'async/websocket'
+
+module Slack
+  module RealTime
+    module Concurrency
+      module Async
+        class Client < ::Async::WebSocket::Client
+          extend ::Forwardable
+          def_delegators :@driver, :on, :text, :binary, :emit
+        end
+
+        class Socket < Slack::RealTime::Socket
+          attr_reader :client
+
+          def start_async(client)
+            Thread.new do
+              ::Async::Reactor.run do
+                client.run_loop
+              end
+            end
+          end
+
+          def connect!
+            super
+            run_loop
+          end
+
+          def close
+            @closing = true
+            @driver.close if @driver
+            super
+          end
+
+          def run_loop
+            @closing = false
+            while @driver && @driver.next_event
+              # $stderr.puts event.inspect
+            end
+          end
+
+          protected
+
+          def build_ssl_context
+            OpenSSL::SSL::SSLContext.new(:TLSv1_2_client).tap do |ctx|
+              ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
+            end
+          end
+
+          def build_endpoint
+            endpoint = ::Async::IO::Endpoint.tcp(addr, port)
+            endpoint = ::Async::IO::SSLEndpoint.new(endpoint, ssl_context: build_ssl_context) if secure?
+            endpoint
+          end
+
+          def connect_socket
+            build_endpoint.connect
+          end
+
+          def connect
+            @socket = connect_socket
+            @driver = Client.new(@socket, url)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -68,12 +68,9 @@ module Slack
           end
 
           def start_async(client)
-            @client = client
-            Actor.new(future.run_client_loop)
-          end
-
-          def run_client_loop
-            @client.run_loop
+            Thread.new do
+              client.run_loop
+            end
           end
 
           def connected?
@@ -82,18 +79,6 @@ module Slack
 
           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?

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

@@ -27,11 +27,17 @@ module Slack
 
         class Socket < Slack::RealTime::Socket
           def start_async(client)
-            thread = ensure_reactor_running
+            @thread = ensure_reactor_running
 
             client.run_loop
 
-            thread
+            @thread
+          end
+
+          def close
+            super
+            EventMachine.stop if @thread
+            @thread = nil
           end
 
           def send_data(message)

data/lib/slack/real_time/config.rb

@@ -36,7 +36,7 @@ module Slack
       private
 
       def detect_concurrency
-        %i[Eventmachine Celluloid].each do |concurrency|
+        %i[Async Eventmachine Celluloid].each do |concurrency|
           begin
             return Slack::RealTime::Concurrency.const_get(concurrency)
           rescue LoadError, NameError
@@ -44,7 +44,7 @@ module Slack
           end
         end
 
-        raise NoConcurrencyError, 'Missing concurrency. Add faye-websocket or celluloid-io to your Gemfile.'
+        raise NoConcurrencyError, 'Missing concurrency. Add async-websocket, faye-websocket or celluloid-io to your Gemfile.'
       end
     end
 

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.12.0'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/spec/integration/integration_spec.rb

@@ -74,6 +74,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
   after do
     wait_for_server
+    connection.join
   end
 
   context 'client connected' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -256,6 +256,9 @@ files:
 - examples/hi_real_time_and_web/Gemfile
 - examples/hi_real_time_and_web/hi.gif
 - examples/hi_real_time_and_web/hi.rb
+- examples/hi_real_time_async_async/Gemfile
+- examples/hi_real_time_async_async/Procfile
+- examples/hi_real_time_async_async/hi.rb
 - examples/hi_real_time_async_celluloid/Gemfile
 - examples/hi_real_time_async_celluloid/Procfile
 - examples/hi_real_time_async_celluloid/hi.rb
@@ -281,6 +284,7 @@ files:
 - lib/slack/real_time/api/typing.rb
 - lib/slack/real_time/client.rb
 - lib/slack/real_time/concurrency.rb
+- lib/slack/real_time/concurrency/async.rb
 - lib/slack/real_time/concurrency/celluloid.rb
 - lib/slack/real_time/concurrency/eventmachine.rb
 - lib/slack/real_time/config.rb