Merge pull request #132 from dblock/oauth-v2

Add support for OAuth v2.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-11-15 11:38:22 -0500 using RuboCop version 0.81.0.
+# on 2020-11-16 09:56:54 -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
 
-#### 1.0.1 (Next)
+#### 1.1.0 (Next)
 
+* [#132](https://github.com/slack-ruby/slack-ruby-bot-server/pull/132): Add support for OAuth v2 - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 #### 1.0.0 (2020/11/15)

README.md

@@ -16,7 +16,7 @@ Build a complete Slack bot service with Slack button integration, in Ruby.
   - [Storage](#storage)
     - [MongoDB](#mongodb)
     - [ActiveRecord](#activerecord)
-  - [OAuth Scopes](#oauth-scopes)
+  - [OAuth Version and Scopes](#oauth-version-and-scopes)
   - [Slack App](#slack-app)
   - [API](#api)
     - [App](#app)
@@ -73,13 +73,14 @@ gem 'otr-activerecord'
 gem 'cursor_pagination'
 ```
 
-### OAuth Scopes
+### OAuth Version and Scopes
 
-Configure your app's [OAuth scopes](https://api.slack.com/legacy/oauth-scopes) as needed by your application.
+Configure your app's [OAuth version](https://api.slack.com/authentication/oauth-v2) and [scopes](https://api.slack.com/legacy/oauth-scopes) as needed by your application.
 
 ```ruby
 SlackRubyBotServer.configure do |config|
-  config.oauth_scope = ['channels:read', 'chat:write:user']
+  config.oauth_version = :v2
+  config.oauth_scope = ['channels:read', 'chat:write']
 end
 ```
 
@@ -91,11 +92,26 @@ Create a new Slack App [here](https://api.slack.com/applications/new).
 
 ![](images/create-app.png)
 
-Follow Slack's instructions, note the app client ID and secret, give the bot a default name, etc. The redirect URL should be the location of your app. For local testing purposes use a public tunneling service such as [ngrok](https://ngrok.com/) to expose local port 9292.
+Follow Slack's instructions, note the app client ID and secret, give the bot a default name, etc.
 
 Within your application, edit your `.env` file and add `SLACK_CLIENT_ID=...` and `SLACK_CLIENT_SECRET=...` in it.
 
-Run `bundle install` and `foreman start` to boot the app. Navigate to [localhost:9292](http://localhost:9292). You should see an "Add to Slack" button. Use it to install the app into your own Slack team.
+Run `bundle install` and `foreman start` to boot the app.
+
+```
+$ foreman start
+07:44:47 web.1  | started with pid 59258
+07:44:50 web.1  | * Listening on tcp://0.0.0.0:5000
+```
+
+Set the redirect URL in "OAuth & Permissions" be the location of your app. Since you cannot receive notifications on localhost from Slack use a public tunneling service such as [ngrok](https://ngrok.com/) to expose local port 9292 for testing.
+
+```
+$ ngrok http 5000
+Forwarding https://ddfd97f80615.ngrok.io -> http://localhost:5000
+```
+
+Navigate to either [localhost:9292](http://localhost:9292) or the ngrok URL above. You should see an "Add to Slack" button. Use it to install the app into your own Slack team.
 
 ### API
 
@@ -174,7 +190,7 @@ The [Add to Slack button](https://api.slack.com/docs/slack-button) also allows f
 auth = OpenSSL::HMAC.hexdigest("SHA256", "key", "data")
 ```
 ```html
-<a href="https://slack.com/oauth/authorize?scope=<%= SlackRubyBotServer::Config.oauth_scope_s %>&client_id=<%= ENV['SLACK_CLIENT_ID'] %>&state=#{auth)"> ... </a>
+<a href="<%= SlackRubyBotServer::Config.oauth_authorize_url %>?scope=<%= SlackRubyBotServer::Config.oauth_scope_s %>&client_id=<%= ENV['SLACK_CLIENT_ID'] %>&state=#{auth)"> ... </a>
 ```
 ```ruby
 instance = SlackRubyBotServer::Service.instance

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

@@ -40,22 +40,41 @@ class TeamsEndpoint < Grape::API
 
             raise 'Missing SLACK_CLIENT_ID or SLACK_CLIENT_SECRET.' unless ENV.key?('SLACK_CLIENT_ID') && ENV.key?('SLACK_CLIENT_SECRET')
 
-            rc = client.oauth_access(
+            options = {
               client_id: ENV['SLACK_CLIENT_ID'],
               client_secret: ENV['SLACK_CLIENT_SECRET'],
               code: params[:code]
-            )
+            }
 
-            access_token = rc['access_token']
-            user_id = rc['user_id']
+            rc = client.send(SlackRubyBotServer.config.oauth_access_method, options)
 
-            bot = rc['bot']
+            token = nil
+            access_token = nil
+            user_id = nil
+            bot_user_id = nil
+            team_id = nil
+            team_name = nil
 
-            token = bot ? bot['bot_access_token'] : access_token
-            bot_user_id = bot['bot_user_id'] if bot
+            case SlackRubyBotServer::Config.oauth_version
+            when :v2
+              access_token = rc.access_token
+              token = rc.access_token
+              user_id = rc.authed_user&.id
+              bot_user_id = rc.bot_user_id
+              team_id = rc.team&.id
+              team_name = rc.team&.name
+            when :v1
+              access_token = rc.access_token
+              bot = rc.bot if rc.key?(:bot)
+              token = bot ? bot.bot_access_token : access_token
+              user_id = rc.user_id
+              bot_user_id = bot ? bot.bot_user_id : nil
+              team_id = rc.team_id
+              team_name = rc.team_name
+            end
 
             team = Team.where(token: token).first
-            team ||= Team.where(team_id: rc['team_id']).first
+            team ||= Team.where(team_id: team_id).first
 
             if team
               team.ping_if_active!
@@ -72,8 +91,8 @@ class TeamsEndpoint < Grape::API
             else
               team = Team.create!(
                 token: token,
-                team_id: rc['team_id'],
-                name: rc['team_name'],
+                team_id: team_id,
+                name: team_name,
                 activated_user_id: user_id,
                 activated_user_access_token: access_token,
                 bot_user_id: bot_user_id

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

@@ -1,10 +1,11 @@
 module SlackRubyBotServer
   class App
+    include SlackRubyBotServer::Loggable
+
     def prepare!
       check_database!
       init_database!
       purge_inactive_teams!
-      configure_global_aliases!
     end
 
     def self.instance
@@ -13,13 +14,6 @@ def self.instance
 
     private
 
-    def logger
-      @logger ||= begin
-        STDOUT.sync = true
-        Logger.new(STDOUT)
-      end
-    end
-
     def check_database!
       SlackRubyBotServer::DatabaseAdapter.check!
     end
@@ -31,11 +25,5 @@ def init_database!
     def purge_inactive_teams!
       Team.purge!
     end
-
-    def configure_global_aliases!
-      SlackRubyBot.configure do |config|
-        config.aliases = ENV['SLACK_RUBY_BOT_ALIASES'].split(' ') if ENV['SLACK_RUBY_BOT_ALIASES']
-      end
-    end
   end
 end

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

@@ -7,11 +7,13 @@ module Config
     attr_accessor :database_adapter
     attr_accessor :view_paths
     attr_accessor :oauth_scope
+    attr_accessor :oauth_version
 
     def reset!
       self.logger = nil
       self.service_class = SlackRubyBotServer::Service
       self.oauth_scope = nil
+      self.oauth_version = :v2
 
       self.view_paths = [
         'views',
@@ -28,6 +30,28 @@ def reset!
                               end
     end
 
+    def oauth_authorize_url
+      case oauth_version
+      when :v2
+        'https://slack.com/oauth/v2/authorize'
+      when :v1
+        'https://slack.com/oauth/authorize'
+      else
+        raise ArgumentError, 'Invalid oauth_version, must be one of :v1 or v2.'
+      end
+    end
+
+    def oauth_access_method
+      case oauth_version
+      when :v2
+        :oauth_v2_access
+      when :v1
+        :oauth_access
+      else
+        raise ArgumentError, 'Invalid oauth_version, must be one of :v1 or v2.'
+      end
+    end
+
     def oauth_scope_s
       oauth_scope&.join('+')
     end

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

@@ -32,10 +32,18 @@ def to_s
 
     def ping!
       client = Slack::Web::Client.new(token: token)
+
       auth = client.auth_test
+
+      presence = begin
+        client.users_getPresence(user: auth['user_id'])
+                 rescue Slack::Web::Api::Errors::MissingScope
+                   nil
+      end
+
       {
         auth: auth,
-        presence: client.users_getPresence(user: auth['user_id'])
+        presence: presence
       }
     end
 

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

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

public/index.html.erb

@@ -16,7 +16,7 @@
   </p>
   <p id='messages' />
   <p id='register'>
-    <a href="https://slack.com/oauth/authorize?scope=<%= SlackRubyBotServer::Config.oauth_scope_s %>&client_id=<%= ENV['SLACK_CLIENT_ID'] %>"><img alt="Add to Slack" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png" srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/[email protected] 2x"></a>
+    <a href="<%= SlackRubyBotServer::Config.oauth_authorize_url %>?scope=<%= SlackRubyBotServer::Config.oauth_scope_s %>&client_id=<%= ENV['SLACK_CLIENT_ID'] %>"><img alt="Add to Slack" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png" srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/[email protected] 2x"></a>
   </p>
   <p id='active_teams_count'>&nbsp;</p>
   <p>