slack-ruby-bot-server 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98fcac8e33fc669ff0a331717491c75cc7e819c1cf3c43b405901731ec4febc7
-  data.tar.gz: 728424653814376e017fbfe66f0d9fadaa65f8d116c10fd8d4b108753f8052b6
+  metadata.gz: 02acf8078e1ec2fb418d45f9fac6823d7af6b473ad00c8992f59ff4a64311609
+  data.tar.gz: d1da43dc7201cd30a5e49eb6193eb476820edd936b804e714e8952aafaf4d566
 SHA512:
-  metadata.gz: 44a081620509fa8a7e1effdf25f87a87e0c4b96c1ea67ccdad7cd02437c1bc0be74ec9e330816ba58c4642e8edf7e609734b1302c1bf6e4eea2445c4eff5dd76
-  data.tar.gz: b2a3ab5234473ea2cb9cf8079425bc63e84b515c439cbe0042893ed9683b98d149d05fb1854108d928a92004e9eb5573c84f4bd197db9b496e61fa6321d1ac1f
+  metadata.gz: bc2b495018d4d24f36c75eada4e9eb218205611bc2ab94d77b89326e4c23ac0e254302747a6d3bee758dc20fb46f44a4722da93fcac69a262754eb106aca80a6
+  data.tar.gz: 4e503d3c5f70d464a4c07f429cd81b1aa6bdc3414e95fa9b3e668ad6649f644e6df83a8401bf491147c9e5821a3b865052c3a74532cb4ca0e711a495047d5753

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-09-08 18:09:56 -0400 using RuboCop version 0.58.2.
+# on 2019-02-25 14:24:34 -0500 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
@@ -16,11 +16,6 @@ Layout/IndentHeredoc:
     - 'sample_apps/sample_app_activerecord/commands/help.rb'
     - 'sample_apps/sample_app_mongoid/commands/help.rb'
 
-# Offense count: 1
-Lint/HandleExceptions:
-  Exclude:
-    - 'lib/slack-ruby-bot-server/ping.rb'
-
 # Offense count: 3
 # Configuration parameters: Blacklist.
 # Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ### Changelog
 
-#### 0.8.3 (2019/01/17)
+#### 0.9.0 (2019/2/25)
+
+* [#93](https://github.com/slack-ruby/slack-ruby-bot-server/pull/93): Removed ping worker in favor of slack-ruby-client lower level ping - [@dblock](https://github.com/dblock).
+
+#### 0.8.3 (2019/1/17)
 
 * [#88](https://github.com/slack-ruby/slack-ruby-bot-server/issues/88): Fix: compatibility with Grape 1.2.x - [@dblock](https://github.com/dblock).
 

data/README.md

@@ -13,7 +13,7 @@ A library that contains a [Grape](http://github.com/ruby-grape/grape) API servin
 
 ### Stable Release
 
-You're reading the documentation for the **next** release of slack-ruby-bot-server. Please see the documentation for the [last stable release, v0.8.2](https://github.com/slack-ruby/slack-ruby-bot-server/blob/v0.8.2/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, v0.9.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ### Try Me
 
@@ -152,22 +152,6 @@ SlackRubyBotServer.configure do |config|
 end
 ```
 
-#### Ping Worker
-
-Each `SlackRubyBotServer::Server` instance will start a ping worker that will periodically check the online status of the bot via the Slack web [auth.test](https://api.slack.com/methods/auth.test) and [users.getPresence](https://api.slack.com/methods/users.getPresence) APIs, and will forcefully close the connection if the bot goes offline, causing an automatic reconnect.
-
-You can configure the ping interval, number of retries before restart, and disable the ping worker entirely.
-
-```ruby
-SlackRubyBotServer.configure do |config|
-  config.ping = {
-    enabled: true, # set to false to disable the ping worker
-    ping_interval: 30, # interval in seconds
-    retry_count: 3 # number of unsuccessful retries until a restart
-  }
-end
-```
-
 ### Access Tokens
 
 By default the implementation of [Team](lib/slack-ruby-bot-server/models/team) stores a `bot_access_token` that grants a certain amount of privileges to the bot user as described in [Slack OAuth Docs](https://api.slack.com/docs/oauth). You may not want a bot user at all, or may require different auth scopes, such as `users.profile:read` to access user profile information via `Slack::Web::Client#users_profile_get`. To obtain the non-bot access token make the following changes.

data/UPGRADING.md

@@ -1,6 +1,14 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 0.9.0
+
+### Removed Ping Worker
+
+The ping worker that was added in 0.7.0 has been removed in favor of a lower level implementation in slack-ruby-client. Remove any references to `ping` options.
+
+See [slack-ruby-client#226](https://github.com/slack-ruby/slack-ruby-client/pull/226) and [#93](https://github.com/slack-ruby/slack-ruby-bot-server/pull/93) for more information.
+
 ### Upgrading to >= 0.8.0
 
 ### Different Asynchronous I/O Library

data/lib/slack-ruby-bot-server.rb

@@ -3,7 +3,6 @@ require 'async/websocket'
 require 'grape-swagger'
 require 'slack-ruby-bot'
 require 'slack-ruby-bot-server/server'
-require 'slack-ruby-bot-server/ping'
 require 'slack-ruby-bot-server/config'
 
 require 'slack-ruby-bot-server/ext'

data/lib/slack-ruby-bot-server/config.rb

@@ -3,11 +3,9 @@ module SlackRubyBotServer
     extend self
 
     attr_accessor :server_class
-    attr_accessor :ping
     attr_accessor :database_adapter
 
     def reset!
-      self.ping = nil
       self.server_class = SlackRubyBotServer::Server
       self.database_adapter = if defined?(::Mongoid)
                                 :mongoid

data/lib/slack-ruby-bot-server/server.rb

@@ -7,7 +7,6 @@ module SlackRubyBotServer
     def initialize(attrs = {})
       attrs = attrs.dup
       @team = attrs.delete(:team)
-      @ping_options = attrs.delete(:ping) || {}
       raise 'Missing team' unless @team
       attrs[:token] = @team.token
       super(attrs)
@@ -24,19 +23,8 @@ module SlackRubyBotServer
 
     private
 
-    attr_reader :ping_options
-
-    def create_ping
-      return unless !ping_options.key?(:enabled) || ping_options[:enabled]
-      SlackRubyBotServer::Ping.new(client, ping_options)
-    end
-
     def open!
       client.owner = team
-      client.on :open do |_event|
-        worker = create_ping
-        worker.start! if worker
-      end
     end
   end
 end

data/lib/slack-ruby-bot-server/service.rb

@@ -31,7 +31,6 @@ module SlackRubyBotServer
       run_callbacks :starting, team
       logger.info "Starting team #{team}."
       options = { team: team }
-      options[:ping] = SlackRubyBotServer::Config.ping if SlackRubyBotServer::Config.ping
       server = SlackRubyBotServer::Config.server_class.new(options)
       start_server! team, server
       run_callbacks :started, team

data/lib/slack-ruby-bot-server/version.rb

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '0.8.3'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/slack-ruby-bot-server.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack-cors'
   spec.add_dependency 'rack-rewrite'
   spec.add_dependency 'rack-server-pages'
-  spec.add_dependency 'slack-ruby-bot'
+  spec.add_dependency 'slack-ruby-bot', '>= 0.12.0'
   spec.add_dependency 'unicorn'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot-server
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: unicorn
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +225,6 @@ files:
 - lib/slack-ruby-bot-server/models/team/activerecord.rb
 - lib/slack-ruby-bot-server/models/team/methods.rb
 - lib/slack-ruby-bot-server/models/team/mongoid.rb
-- lib/slack-ruby-bot-server/ping.rb
 - lib/slack-ruby-bot-server/rspec.rb
 - lib/slack-ruby-bot-server/rspec/fabricators/team.rb
 - lib/slack-ruby-bot-server/server.rb

data/lib/slack-ruby-bot-server/ping.rb

@@ -1,149 +0,0 @@
-require 'active_support/core_ext/string/filters'
-
-module SlackRubyBotServer
-  class Ping
-    attr_reader :client
-    attr_reader :options
-    attr_reader :error_count
-
-    def initialize(client, options = {})
-      @options = options
-      @client = client
-      @error_count = 0
-    end
-
-    def start!
-      ::Async::Reactor.run do |task|
-        run(task)
-      end
-    end
-
-    private
-
-    def run(task)
-      logger.debug "PING: #{owner}, every #{ping_interval} second(s)"
-      loop do
-        task.sleep ping_interval
-        break unless check!
-      end
-      logger.debug "PING: #{owner}, done."
-    rescue StandardError => e
-      logger.error e
-      raise e
-    end
-
-    def check!
-      if online?
-        @error_count = 0
-        true
-      else
-        down!
-      end
-    rescue StandardError => e
-      case e.message
-      when 'account_inactive', 'invalid_auth' then
-        logger.warn "Error pinging team #{owner.id}: #{e.message}, terminating."
-        false
-      else
-        message = e.message.truncate(24, separator: "\n", omission: '...')
-        logger.warn "Error pinging team #{owner.id}: #{message}."
-        true
-      end
-    end
-
-    def offline?
-      !online?
-    end
-
-    def online?
-      presence.online
-    end
-
-    def presence
-      owner.ping![:presence]
-    end
-
-    def down!
-      logger.warn "DOWN: #{owner}, #{retries_left} #{retries_left == 1 ? 'retry' : 'retries'} left"
-      @error_count += 1
-      return true if retries_left?
-      restart!
-    end
-
-    def restart!
-      logger.warn "RESTART: #{owner}"
-      close_driver
-      emit_close
-      close_connection
-      false
-    rescue StandardError => e
-      logger.warn "Error restarting team #{owner.id}: #{e.message}."
-      true
-    end
-
-    def close_connection
-      return unless connection
-      connection.close
-    rescue Async::Wrapper::Cancelled
-      # ignore, from connection.close
-    rescue StandardError => e
-      logger.warn "Error closing connection for #{owner.id}: #{e.message}."
-      raise e
-    end
-
-    def close_driver
-      return unless driver
-      driver.close
-    rescue StandardError => e
-      logger.warn "Error closing driver for #{owner.id}: #{e.message}."
-      raise e
-    end
-
-    def emit_close
-      return unless driver
-      driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'bot offline'))
-    rescue StandardError => e
-      logger.warn "Error sending :close event to driver for #{owner.id}: #{e.message}."
-      raise e
-    end
-
-    def ping_interval
-      options[:ping_interval] || 60
-    end
-
-    def retries_left?
-      retry_count - error_count >= 0
-    end
-
-    def retries_left
-      [0, retry_count - error_count].max
-    end
-
-    def retry_count
-      options[:retry_count] || 2
-    end
-
-    def socket
-      client.instance_variable_get(:@socket) if client
-    end
-
-    def driver
-      socket.instance_variable_get(:@driver) if socket
-    end
-
-    def connection
-      driver.instance_variable_get(:@socket) if driver
-    end
-
-    def logger
-      @logger ||= begin
-        STDOUT.sync = true
-        Logger.new(STDOUT)
-      end
-    end
-
-    def owner
-      client.owner
-    end
-  end
-end