slack-ruby-bot-server 0.11.1 → 1.0.0

data/UPGRADING.md

@@ -1,6 +1,20 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 1.0.0
+
+#### Extracted RealTime (Legacy) Support
+
+New slack apps may no longer access RTM. Classic Slack apps can no longer be submitted to the app directory as of December 4th, 2020. In preparation for these changes slack-ruby-bot-server no longer includes RTM components by default. These have been extracted to a new gem [slack-ruby-bot-server-rtm](https://github.com/slack-ruby/slack-ruby-bot-server-rtm).
+
+To upgrade an existing classic Slack app that uses slack-ruby-bot-server do the following.
+
+1. Add `slack-ruby-bot-server-rtm` as an additional dependency.
+2. Replace any reference to `SlackRubyBotServer::Server` to `SlackRubyBotServer::RealTime::Server`.
+3. Replace any `require 'slack-ruby-bot-server/rspec'` with `require 'slack-ruby-bot-server-rtm/rspec'`.
+
+Existing RTM Slack bots will continue working and be listed in the Slack App Directory. On December 4th, 2020 Slack will no longer accept resubmissions from apps that are not using granular permissions. On November 18, 2021 Slack will start delisting apps that have not migrated to use granular permissions. Use [slack-ruby-bot-server-events](https://github.com/slack-ruby/slack-ruby-bot-server-events) to create a Slack bot with granular permissions. See [migration](https://api.slack.com/authentication/migration) for more details.
+
 ### Upgrading to >= 0.11.0
 
 #### Removed Legacy Migrations

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

@@ -1,16 +1,14 @@
-require 'async/websocket'
+require 'async'
 
+require 'slack-ruby-client'
 require 'grape-swagger'
-require 'slack-ruby-bot'
-require 'slack-ruby-bot-server/service'
-require 'slack-ruby-bot-server/server'
-require 'slack-ruby-bot-server/config'
 
-require 'slack-ruby-bot-server/ext'
-require 'slack-ruby-bot-server/version'
-require 'slack-ruby-bot-server/info'
-
-require "slack-ruby-bot-server/config/database_adapters/#{SlackRubyBotServer::Config.database_adapter}.rb"
-
-require 'slack-ruby-bot-server/api'
-require 'slack-ruby-bot-server/app'
+require_relative 'slack-ruby-bot-server/loggable'
+require_relative 'slack-ruby-bot-server/service'
+require_relative 'slack-ruby-bot-server/config'
+require_relative 'slack-ruby-bot-server/ext'
+require_relative 'slack-ruby-bot-server/version'
+require_relative 'slack-ruby-bot-server/info'
+require_relative "slack-ruby-bot-server/config/database_adapters/#{SlackRubyBotServer::Config.database_adapter}.rb"
+require_relative 'slack-ruby-bot-server/api'
+require_relative 'slack-ruby-bot-server/app'

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

@@ -3,7 +3,7 @@ require 'roar'
 require 'grape-roar'
 
 require_relative 'ext/grape/sort_extension'
-require 'slack-ruby-bot-server/api/helpers'
-require 'slack-ruby-bot-server/api/presenters'
-require 'slack-ruby-bot-server/api/endpoints'
-require 'slack-ruby-bot-server/api/middleware'
+require_relative 'api/helpers'
+require_relative 'api/presenters'
+require_relative 'api/endpoints'
+require_relative 'api/middleware'

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

@@ -1,3 +1,3 @@
-require 'slack-ruby-bot-server/api/endpoints/teams_endpoint'
-require 'slack-ruby-bot-server/api/endpoints/status_endpoint'
-require 'slack-ruby-bot-server/api/endpoints/root_endpoint'
+require_relative 'endpoints/teams_endpoint'
+require_relative 'endpoints/status_endpoint'
+require_relative 'endpoints/root_endpoint'

data/lib/slack-ruby-bot-server/api/endpoints/teams_endpoint.rb

@@ -46,20 +46,28 @@ module SlackRubyBotServer
               code: params[:code]
             )
 
-            token = rc['bot']['bot_access_token']
-            bot_user_id = rc['bot']['bot_user_id']
-            user_id = rc['user_id']
             access_token = rc['access_token']
+            user_id = rc['user_id']
+
+            bot = rc['bot']
+
+            token = bot ? bot['bot_access_token'] : access_token
+            bot_user_id = bot['bot_user_id'] if bot
+
             team = Team.where(token: token).first
             team ||= Team.where(team_id: rc['team_id']).first
 
             if team
+              team.ping_if_active!
+
               team.update_attributes!(
                 activated_user_id: user_id,
                 activated_user_access_token: access_token,
                 bot_user_id: bot_user_id
               )
+
               raise "Team #{team.name} is already registered." if team.active?
+
               team.activate!(token)
             else
               team = Team.create!(

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

@@ -1,4 +1,4 @@
-require 'slack-ruby-bot-server/api/helpers/cursor_helpers'
-require 'slack-ruby-bot-server/api/helpers/pagination_parameters'
-require 'slack-ruby-bot-server/api/helpers/sort_helpers'
-require 'slack-ruby-bot-server/api/helpers/error_helpers'
+require_relative 'helpers/cursor_helpers'
+require_relative 'helpers/pagination_parameters'
+require_relative 'helpers/sort_helpers'
+require_relative 'helpers/error_helpers'

data/lib/slack-ruby-bot-server/api/helpers/cursor_helpers.rb

@@ -11,6 +11,7 @@ module SlackRubyBotServer
         if SlackRubyBotServer::Config.mongoid?
           def paginate_by_cursor(coll, _options)
             raise 'Both cursor and offset parameters are present, these are mutually exclusive.' if params.key?(:offset) && params.key?(:cursor)
+
             results = { results: [], next: nil }
             coll = coll.skip(params[:offset].to_i) if params.key?(:offset)
             size = (params[:size] || 10).to_i
@@ -26,6 +27,7 @@ module SlackRubyBotServer
         elsif SlackRubyBotServer::Config.activerecord?
           def paginate_by_cursor(coll, options)
             raise 'Both cursor and offset parameters are present, these are mutually exclusive.' if params.key?(:offset) && params.key?(:cursor)
+
             results = { results: [], next: nil }
             size = (params[:size] || 10).to_i
             results[:total_count] = coll.count(:all) if params[:total_count]

data/lib/slack-ruby-bot-server/api/helpers/sort_helpers.rb

@@ -7,6 +7,7 @@ module SlackRubyBotServer
         def sort_order(options = {})
           params[:sort] = options[:default_sort_order] unless params[:sort]
           return [] unless params[:sort]
+
           sort_order = params[:sort].to_s
           unless options[:default_sort_order] == sort_order
             supported_sort_orders = route_sort

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

@@ -6,11 +6,10 @@ require 'otr-activerecord' if SlackRubyBotServer::Config.activerecord? && !defin
 module SlackRubyBotServer
   module Api
     class Middleware
-      def self.logger
-        @logger ||= begin
-          STDOUT.sync = true
-          Logger.new(STDOUT)
-        end
+      include SlackRubyBotServer::Loggable
+
+      def self.reset!
+        @instance = nil
       end
 
       def self.instance
@@ -30,11 +29,7 @@ module SlackRubyBotServer
           end
 
           use Rack::ServerPages do |config|
-            config.view_path = [
-              'views', # relative to Dir.pwd
-              'public', # relative to Dir.pwd
-              File.expand_path(File.join(__dir__, '../../../public')) # built-in fallback
-            ]
+            config.view_path = SlackRubyBotServer::Config.view_paths
           end
 
           run Middleware.new

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

@@ -2,8 +2,8 @@ require 'roar/representer'
 require 'roar/json'
 require 'roar/json/hal'
 
-require 'slack-ruby-bot-server/api/presenters/paginated_presenter'
-require 'slack-ruby-bot-server/api/presenters/status_presenter'
-require 'slack-ruby-bot-server/api/presenters/team_presenter'
-require 'slack-ruby-bot-server/api/presenters/teams_presenter'
-require 'slack-ruby-bot-server/api/presenters/root_presenter'
+require_relative 'presenters/paginated_presenter'
+require_relative 'presenters/status_presenter'
+require_relative 'presenters/team_presenter'
+require_relative 'presenters/teams_presenter'
+require_relative 'presenters/root_presenter'

data/lib/slack-ruby-bot-server/api/presenters/status_presenter.rb

@@ -23,6 +23,7 @@ module SlackRubyBotServer
             raise 'Unsupported database driver.'
           end
           return unless team
+
           team.ping!
         end
 

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

@@ -2,13 +2,23 @@ module SlackRubyBotServer
   module Config
     extend self
 
-    attr_accessor :server_class
+    attr_accessor :logger
     attr_accessor :service_class
     attr_accessor :database_adapter
+    attr_accessor :view_paths
+    attr_accessor :oauth_scope
 
     def reset!
-      self.server_class = SlackRubyBotServer::Server
+      self.logger = nil
       self.service_class = SlackRubyBotServer::Service
+      self.oauth_scope = nil
+
+      self.view_paths = [
+        'views',
+        'public',
+        File.expand_path(File.join(__dir__, '../../public'))
+      ]
+
       self.database_adapter = if defined?(::Mongoid)
                                 :mongoid
                               elsif defined?(::ActiveRecord)
@@ -18,6 +28,10 @@ module SlackRubyBotServer
                               end
     end
 
+    def oauth_scope_s
+      oauth_scope&.join('+')
+    end
+
     def activerecord?
       database_adapter == :activerecord
     end

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

@@ -1,4 +1,4 @@
-require 'slack-ruby-bot-server/models/team/activerecord.rb'
+require_relative '../../models/team/activerecord.rb'
 
 module SlackRubyBotServer
   module DatabaseAdapter
@@ -28,4 +28,4 @@ module SlackRubyBotServer
   end
 end
 
-::Boolean = Virtus::Attribute::Boolean
+::Boolean = Grape::API::Boolean

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

@@ -1,4 +1,5 @@
-require 'slack-ruby-bot-server/models/team/mongoid.rb'
+require_relative '../../models/team/mongoid.rb'
+
 require 'kaminari/grape'
 require 'mongoid-scroll'
 
@@ -6,7 +7,8 @@ module SlackRubyBotServer
   module DatabaseAdapter
     def self.check!
       rc = Mongoid.default_client.command(ping: 1)
-      return if rc && rc.ok?
+      return if rc&.ok?
+
       raise rc.documents.first['error'] || 'Unexpected error.'
     rescue StandardError => e
       warn "Error connecting to MongoDB: #{e.message}"

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

@@ -1,3 +1,3 @@
-%w[bson/object_id grape/sort_extension slack-ruby-bot].each do |ext|
+%w[bson/object_id grape/sort_extension].each do |ext|
   require_relative "ext/#{ext}"
 end

data/lib/slack-ruby-bot-server/ext/mongoid/slack-ruby-bot/commands/base.rb

@@ -8,12 +8,12 @@ module SlackRubyBot
           _invoke client, data
         rescue Mongoid::Errors::Validations => e
           logger.info "#{name.demodulize.upcase}: #{client.owner}, error - #{e.document.class}, #{e.document.errors.to_hash}"
-          client.say(channel: data.channel, text: e.document.errors.first[1], gif: 'error')
+          client.say(channel: data.channel, text: e.document.errors.first[1])
           true
         rescue StandardError => e
           logger.info "#{name.demodulize.upcase}: #{client.owner}, #{e.class}: #{e}"
           logger.debug e.backtrace.join("\n")
-          client.say(channel: data.channel, text: e.message, gif: 'error')
+          client.say(channel: data.channel, text: e.message)
           true
         end
       end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SlackRubyBotServer
+  module Loggable
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def logger
+        @logger ||= SlackRubyBotServer::Config.logger || begin
+          $stdout.sync = true
+          Logger.new($stdout)
+        end
+      end
+    end
+
+    module InstanceMethods
+      def logger
+        self.class.logger
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot-server/models/team/activerecord.rb

@@ -3,11 +3,14 @@ require_relative 'methods'
 class Team < ActiveRecord::Base
   include Methods
 
-  def self.purge!
-    # destroy teams inactive for two weeks
-    Team.where(active: false).where('updated_at <= ?', 2.weeks.ago).each do |team|
-      puts "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
-      team.destroy
+  def self.purge!(dt = 2.weeks.ago)
+    Team.where(active: false).where('updated_at <= ?', dt).each do |team|
+      begin
+        logger.info "Destroying #{team}, inactive since #{team.updated_at}."
+        team.destroy
+      rescue StandardError => e
+        logger.warn "Error destroying #{team}, #{e.message}."
+      end
     end
   end
 end

data/lib/slack-ruby-bot-server/models/team/methods.rb

@@ -38,5 +38,17 @@ module Methods
         presence: client.users_getPresence(user: auth['user_id'])
       }
     end
+
+    def ping_if_active!
+      return unless active?
+
+      ping!
+    rescue Slack::Web::Api::Errors::SlackError => e
+      logger.warn "Active team #{self} ping, #{e.message}."
+      case e.message
+      when 'account_inactive', 'invalid_auth'
+        deactivate!
+      end
+    end
   end
 end

data/lib/slack-ruby-bot-server/models/team/mongoid.rb

@@ -15,11 +15,15 @@ class Team
 
   include Methods
 
-  def self.purge!
+  def self.purge!(dt = 2.weeks.ago)
     # destroy teams inactive for two weeks
-    Team.where(active: false, :updated_at.lte => 2.weeks.ago).each do |team|
-      Mongoid.logger.info "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
-      team.destroy
+    Team.where(active: false, :updated_at.lte => dt).each do |team|
+      begin
+        logger.info "Destroying #{team}, inactive since #{team.updated_at}."
+        team.destroy
+      rescue StandardError => e
+        logger.warn "Error destroying #{team}, #{e.message}."
+      end
     end
   end
 end

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

@@ -1,4 +1,3 @@
-require 'slack-ruby-bot/rspec'
 require 'slack-ruby-bot-server'
 require 'fabrication'
 require 'faker'

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

@@ -1,6 +1,6 @@
 module SlackRubyBotServer
   class Service
-    include SlackRubyBot::Loggable
+    include SlackRubyBotServer::Loggable
 
     def self.start!
       Thread.new do
@@ -15,10 +15,29 @@ module SlackRubyBotServer
 
     def initialize
       @callbacks = Hash.new { |h, k| h[k] = [] }
+      @intervals = Hash.new { |h, k| h[k] = [] }
     end
 
-    def on(type, &block)
-      @callbacks[type.to_s] << block
+    def on(*types, &block)
+      Array(types).each do |type|
+        @callbacks[type.to_s] << block
+      end
+    end
+
+    def every(*intervals, &block)
+      Array(intervals).each do |interval|
+        case interval
+        when :minute
+          interval = 60
+        when :hour
+          interval = 60 * 60
+        when :day
+          interval = 60 * 60 * 24
+        end
+        raise "Invalid interval \"#{interval}\"." unless interval.is_a?(Integer) && interval > 0
+
+        @intervals[interval] << block
+      end
     end
 
     def create!(team, options = {})
@@ -28,34 +47,30 @@ module SlackRubyBotServer
     end
 
     def start!(team)
-      run_callbacks :starting, team
       logger.info "Starting team #{team}."
-      options = { team: team }
-      server = SlackRubyBotServer::Config.server_class.new(options)
-      start_server! team, server
+      run_callbacks :starting, team
       run_callbacks :started, team
-      server
     rescue StandardError => e
       run_callbacks :error, team, e
       logger.error e
     end
 
-    def restart!(team, server, wait = 1)
+    def restart!(team)
+      logger.info "Restarting team #{team}."
       run_callbacks :restarting, team
-      start_server! team, server, wait
       run_callbacks :restarted, team
+    rescue StandardError => e
+      run_callbacks :error, team, e
+      logger.error e
     end
 
     def stop!(team)
       logger.info "Stopping team #{team}."
       run_callbacks :stopping, team
-      team.server.stop! if team.server
       run_callbacks :stopped, team
     rescue StandardError => e
       run_callbacks :error, team, e
       logger.error e
-    ensure
-      team.server = nil
     end
 
     def start_from_database!
@@ -64,20 +79,24 @@ module SlackRubyBotServer
         start!(team)
         run_callbacks :booted, team
       end
+      start_intervals!
+    end
+
+    def start_intervals!
+      @intervals.each_pair do |period, calls|
+        _every period do
+          calls.each(&:call)
+        end
+      end
     end
 
     def deactivate!(team)
       run_callbacks :deactivating, team
       team.deactivate!
       run_callbacks :deactivated, team
-    rescue Mongoid::Errors::Validations => e
-      run_callbacks :error, team, e
-      logger.error "#{team.name}: #{e.message}, error - #{e.document.class}, #{e.document.errors.to_hash}, ignored."
     rescue StandardError => e
       run_callbacks :error, team, e
       logger.error "#{team.name}: #{e.class}, #{e.message}, ignored."
-    ensure
-      team.server = nil
     end
 
     def self.reset!
@@ -86,26 +105,23 @@ module SlackRubyBotServer
 
     private
 
-    def start_server!(team, server, wait = 1)
-      team.server = server
-      server.start_async
-    rescue StandardError => e
-      run_callbacks :error, team, e
-      case e.message
-      when 'account_inactive', 'invalid_auth' then
-        logger.error "#{team.name}: #{e.message}, team will be deactivated."
-        deactivate!(team)
-      else
-        wait = e.retry_after if e.is_a?(Slack::Web::Api::Errors::TooManyRequestsError)
-        logger.error "#{team.name}: #{e.message}, restarting in #{wait} second(s)."
-        sleep(wait)
-        start_server! team, server, [wait * 2, 60].min
+    def _every(tt, &_block)
+      ::Async::Reactor.run do |task|
+        loop do
+          begin
+            task.sleep tt
+            yield
+          rescue StandardError => e
+            logger.error e
+          end
+        end
       end
     end
 
     def run_callbacks(type, team = nil, error = nil, options = {})
       callbacks = @callbacks[type.to_s]
       return false unless callbacks
+
       callbacks.each do |c|
         c.call team, error, options
       end