Merge pull request #1 from dblock/oauth-version

Only start OAuth v1 teams with a bot token.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-11-14 17:59:41 -0500 using RuboCop version 0.81.0.
+# on 2020-11-27 15:32:33 -0500 using RuboCop version 0.81.0.
 # 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

CHANGELOG.md

@@ -1,7 +1,8 @@
 ### Changelog
 
-#### 0.1.2 (Next)
+#### 0.2.0 (Next)
 
+* [#1](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/pull/1): Only start OAuth v1 teams with a bot token - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 #### 0.1.1 (2020/11/15)

README.md

@@ -4,7 +4,19 @@ Slack Ruby Bot Server RealTime (RTM) Extension
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server-rtm.svg)](https://badge.fury.io/rb/slack-ruby-bot-server-rtm)
 [![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-rtm.svg?branch=main)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-rtm)
 
-An extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that makes it easy to implement Slack RTM bots.
+# Table of Contents
+
+- [Introduction](#introduction)
+- [Samples](#samples)
+- [Usage](#usage)
+  - [Gemfile](#gemfile)
+  - [Configure](#configure)
+    - [Server Class](#server-class)
+- [Copyright & License](#copyright--license)
+
+### Introduction
+
+This library is an extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that makes it easy to implement Slack RTM bots.
 
 ### Samples
 

lib/slack-ruby-bot-server-rtm/lifecycle.rb

@@ -5,6 +5,8 @@
 end
 
 SlackRubyBotServer::Config.service_class.instance.on :starting do |team, _error, options|
+  next if team.respond_to?(:oauth_version) && team.oauth_version != 'v1'
+
   SlackRubyBotServer::Config.service_class.instance.logger.info "Starting real-time team #{team}."
   options = { team: team }
   server = SlackRubyBotServer::RealTime::Config.server_class.new(options)
@@ -26,6 +28,6 @@
 end
 
 SlackRubyBotServer::Config.service_class.instance.on :deactivated do |team, _error, _options|
-  SlackRubyBotServer::Config.service_class.instance.logger.info "De-activating real-time team #{team}."
+  SlackRubyBotServer::Config.service_class.instance.logger.info "De-activated real-time team #{team}."
   team.server = nil
 end

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

@@ -23,9 +23,13 @@ def self.start_server!(team, server, wait = 1)
       rescue StandardError => e
         SlackRubyBotServer::Config.service_class.instance.send(:run_callbacks, :error, team, e)
         case e.message
-        when 'account_inactive', 'invalid_auth' then
-          SlackRubyBotServer::Config.service_class.instance.logger.error "#{team.name}: #{e.message}, team will be deactivated."
-          SlackRubyBotServer::Config.service_class.instance.deactivate! team
+        when 'account_inactive', 'invalid_auth'
+          if team.respond_to?(:oauth_version) && team.oauth_version != 'v1'
+            SlackRubyBotServer::Config.service_class.instance.logger.info "#{team.name}: #{e.message}, team OAuth scope has been upgraded."
+          else
+            SlackRubyBotServer::Config.service_class.instance.logger.error "#{team.name}: #{e.message}, team will be deactivated."
+            SlackRubyBotServer::Config.service_class.instance.deactivate! team
+          end
         else
           wait = e.retry_after if e.is_a?(Slack::Web::Api::Errors::TooManyRequestsError)
           SlackRubyBotServer::Config.service_class.instance.logger.error "#{team.name}: #{e.message}, restarting in #{wait} second(s)."

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

@@ -2,6 +2,6 @@
 
 module SlackRubyBotServer
   module RealTime
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

sample_apps/sample_app_activerecord/db/migrate/20201125164500_add_oauth_fields.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddOauthFields < ActiveRecord::Migration[5.0]
+  def change
+    add_column :teams, :oauth_scope, :string
+    add_column :teams, :oauth_version, :string, default: 'v1', null: false
+  end
+end

sample_apps/sample_app_activerecord/db/schema.rb

@@ -12,7 +12,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20_190_323_181_453) do
+ActiveRecord::Schema.define(version: 20_201_125_164_500) do
   # These are extensions that must be enabled in order to support this database
   enable_extension 'plpgsql'
 
@@ -22,10 +22,12 @@
     t.boolean  'active', default: true
     t.string   'domain'
     t.string   'token'
-    t.datetime 'created_at',                                 null: false
-    t.datetime 'updated_at',                                 null: false
+    t.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
     t.string   'bot_user_id'
     t.string   'activated_user_id'
     t.string   'activated_user_access_token'
+    t.string   'oauth_scope'
+    t.string   'oauth_version', default: 'v1', null: false
   end
 end

spec/database_adapters/activerecord/schema.rb

@@ -13,6 +13,8 @@
     t.string :bot_user_id
     t.string :activated_user_id
     t.string :activated_user_access_token
+    t.string :oauth_scope
+    t.string :oauth_version, default: 'v1', null: false
     t.boolean :active, default: true
     t.timestamps
   end

spec/slack-ruby-bot-server-rtm/lifecycle_spec.rb

@@ -3,8 +3,8 @@
 require 'spec_helper'
 
 describe SlackRubyBotServer::Config do
-  let(:team) { Fabricate(:team) }
   context 'with defaults' do
+    let(:team) { Fabricate(:team) }
     let(:server) { SlackRubyBotServer::RealTime::Server.new(team: team) }
     let(:services) { SlackRubyBotServer::Service.instance.instance_variable_get(:@services) }
     before do
@@ -39,6 +39,7 @@
     end
   end
   context 'overriding server_class' do
+    let(:team) { Fabricate(:team) }
     let(:server_class) do
       Class.new(SlackRubyBotServer::RealTime::Server) do
         attr_reader :called
@@ -65,4 +66,16 @@ def initialize(options = {})
       SlackRubyBotServer::Service.instance.stop!(team)
     end
   end
+  context 'v2 oauth scope' do
+    let(:team) { Fabricate(:team, oauth_version: 'v2') }
+    let(:server) { SlackRubyBotServer::RealTime::Server.new(team: team) }
+    let(:services) { SlackRubyBotServer::Service.instance.instance_variable_get(:@services) }
+    before do
+      allow(SlackRubyBotServer::RealTime::Server).to receive(:new).with(team: team).and_return(server)
+    end
+    it 'does not support real-time and is ignored' do
+      expect(server).to_not receive(:start_async)
+      SlackRubyBotServer::Service.instance.start!(team)
+    end
+  end
 end