slack-ruby-bot-server 0.9.0 → 0.12.1

data/UPGRADING.md

@@ -1,9 +1,49 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 0.11.0
+
+#### Removed Legacy Migrations
+
+Several legacy migrations have been removed, including the code to automatically create a team from a legacy `SLACK_API_TOKEN`, setting `Team#active`, `name` and `team_id`.
+
+See [#101](https://github.com/slack-ruby/slack-ruby-bot-server/pull/101) for more information.
+
+#### Unicorn Dependency
+
+The dependency on `unicorn` has been removed from gemspec. Use `unicorn` or `puma` or another application server as you see fit by explicitly adding a dependency in your Gemfile.
+
+See [#98](https://github.com/slack-ruby/slack-ruby-bot-server/pull/98) for more information.
+
+### Upgrading to >= 0.10.0
+
+#### New Team Fields
+
+The following fields have been added to `Team`.
+
+* `bot_user_id`: the bot `user_id` during installation
+* `activated_user_id`: the installing Slack user `user_id`
+* `activated_user_access_token`: the installing Slack user `access_token`
+
+No action is required for Mongoid.
+
+If you're using ActiveRecord, create a migration similar to [sample_apps/sample_app_activerecord/db/migrate/20190323181453_add_activated_fields.rb](sample_apps/sample_app_activerecord/db/migrate/20190323181453_add_activated_fields.rb) to add these fields.
+
+```ruby
+class AddActivatedFields < ActiveRecord::Migration[5.0]
+  def change
+    add_column :teams, :bot_user_id, :string
+    add_column :teams, :activated_user_id, :string
+    add_column :teams, :activated_user_access_token, :string
+  end
+end
+```
+
+See [#96](https://github.com/slack-ruby/slack-ruby-bot-server/pull/96) for more information.
+
 ### Upgrading to >= 0.9.0
 
-### Removed Ping Worker
+#### 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.
 
@@ -11,7 +51,7 @@ See [slack-ruby-client#226](https://github.com/slack-ruby/slack-ruby-client/pull
 
 ### Upgrading to >= 0.8.0
 
-### Different Asynchronous I/O Library
+#### Different Asynchronous I/O Library
 
 The library now uses [async-websocket](https://github.com/socketry/async-websocket) instead of [celluloid-io](https://github.com/celluloid/celluloid-io). If your application is built on Celluloid you may need to make changes and use `Async::Reactor.run` and the likes.
 

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

@@ -2,15 +2,13 @@ require 'async/websocket'
 
 require 'grape-swagger'
 require 'slack-ruby-bot'
-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 'slack-ruby-bot-server/service'
+require_relative 'slack-ruby-bot-server/service'
+require_relative 'slack-ruby-bot-server/server'
+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

@@ -33,6 +33,7 @@ module SlackRubyBotServer
           desc 'Create a team using an OAuth token.'
           params do
             requires :code, type: String
+            optional :state, type: String
           end
           post do
             client = Slack::Web::Client.new
@@ -46,21 +47,35 @@ module SlackRubyBotServer
             )
 
             token = rc['bot']['bot_access_token']
+            bot_user_id = rc['bot']['bot_user_id']
+            user_id = rc['user_id']
+            access_token = rc['access_token']
             team = Team.where(token: token).first
             team ||= Team.where(team_id: rc['team_id']).first
-            if team && !team.active?
+
+            if team
+              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)
-            elsif team
-              raise "Team #{team.name} is already registered."
             else
               team = Team.create!(
                 token: token,
                 team_id: rc['team_id'],
-                name: rc['team_name']
+                name: rc['team_name'],
+                activated_user_id: user_id,
+                activated_user_access_token: access_token,
+                bot_user_id: bot_user_id
               )
             end
 
-            Service.instance.create!(team)
+            options = params.slice(:state)
+
+            Service.instance.create!(team, options)
             present team, with: Presenters::TeamPresenter
           end
         end

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

@@ -30,11 +30,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/app.rb

@@ -3,9 +3,6 @@ module SlackRubyBotServer
     def prepare!
       check_database!
       init_database!
-      mark_teams_active!
-      migrate_from_single_team!
-      update_team_name_and_id!
       purge_inactive_teams!
       configure_global_aliases!
     end
@@ -31,30 +28,6 @@ module SlackRubyBotServer
       SlackRubyBotServer::DatabaseAdapter.init!
     end
 
-    def mark_teams_active!
-      Team.where(active: nil).update_all(active: true)
-    end
-
-    def update_team_name_and_id!
-      Team.active.where(team_id: nil).each do |team|
-        begin
-          auth = team.ping![:auth]
-          team.update_attributes!(team_id: auth['team_id'], name: auth['team'])
-        rescue StandardError => e
-          logger.warn "Error pinging team #{team.id}: #{e.message}."
-          team.set(active: false)
-        end
-      end
-    end
-
-    def migrate_from_single_team!
-      return unless ENV.key?('SLACK_API_TOKEN')
-      logger.info 'Migrating from env SLACK_API_TOKEN ...'
-      team = Team.find_or_create_from_env!
-      logger.info "Automatically migrated team: #{team}."
-      logger.warn "You should unset ENV['SLACK_API_TOKEN']."
-    end
-
     def purge_inactive_teams!
       Team.purge!
     end

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

@@ -3,10 +3,20 @@ module SlackRubyBotServer
     extend self
 
     attr_accessor :server_class
+    attr_accessor :service_class
     attr_accessor :database_adapter
+    attr_accessor :view_paths
 
     def reset!
       self.server_class = SlackRubyBotServer::Server
+      self.service_class = SlackRubyBotServer::Service
+
+      self.view_paths = [
+        'views',
+        'public',
+        File.expand_path(File.join(__dir__, '../../public'))
+      ]
+
       self.database_adapter = if defined?(::Mongoid)
                                 :mongoid
                               elsif defined?(::ActiveRecord)

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
@@ -12,11 +12,15 @@ module SlackRubyBotServer
 
     def self.init!
       return if ActiveRecord::Base.connection.tables.include?('teams')
+
       ActiveRecord::Base.connection.create_table :teams do |t|
         t.string :team_id
         t.string :name
         t.string :domain
         t.string :token
+        t.string :bot_user_id
+        t.string :activated_user_id
+        t.string :activated_user_access_token
         t.boolean :active, default: true
         t.timestamps
       end
@@ -24,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/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,18 +38,5 @@ module Methods
         presence: client.users_getPresence(user: auth['user_id'])
       }
     end
-
-    def self.find_or_create_from_env!
-      token = ENV['SLACK_API_TOKEN']
-      return unless token
-      team = Team.where(token: token).first
-      team ||= Team.new(token: token)
-      info = Slack::Web::Client.new(token: token).team_info
-      team.team_id = info['team']['id']
-      team.name = info['team']['name']
-      team.domain = info['team']['domain']
-      team.save!
-      team
-    end
   end
 end

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

@@ -9,14 +9,21 @@ class Team
   field :domain, type: String
   field :token, type: String
   field :active, type: Boolean, default: true
+  field :bot_user_id, type: String
+  field :activated_user_id, type: String
+  field :activated_user_access_token, type: String
 
   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/server.rb

@@ -8,6 +8,7 @@ module SlackRubyBotServer
       attrs = attrs.dup
       @team = attrs.delete(:team)
       raise 'Missing team' unless @team
+
       attrs[:token] = @team.token
       super(attrs)
       open!

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

@@ -10,21 +10,40 @@ module SlackRubyBotServer
     end
 
     def self.instance
-      @instance ||= new
+      @instance ||= SlackRubyBotServer::Config.service_class.new
     end
 
     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)
-      run_callbacks :creating, team
+    def create!(team, options = {})
+      run_callbacks :creating, team, nil, options
       start!(team)
-      run_callbacks :created, team
+      run_callbacks :created, team, nil, options
     end
 
     def start!(team)
@@ -49,7 +68,7 @@ module SlackRubyBotServer
     def stop!(team)
       logger.info "Stopping team #{team}."
       run_callbacks :stopping, team
-      team.server.stop! if team.server
+      team.server&.stop!
       run_callbacks :stopped, team
     rescue StandardError => e
       run_callbacks :error, team, e
@@ -64,6 +83,15 @@ 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)
@@ -86,6 +114,19 @@ module SlackRubyBotServer
 
     private
 
+    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 start_server!(team, server, wait = 1)
       team.server = server
       server.start_async
@@ -103,11 +144,12 @@ module SlackRubyBotServer
       end
     end
 
-    def run_callbacks(type, team = nil, error = nil)
+    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
+        c.call team, error, options
       end
       true
     rescue StandardError => e