slack-ruby-bot-server 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f81d3aefa974e927adeaa66b98092695463ff4f4dc8d1c0294a0efb7c824c01
-  data.tar.gz: 17731a13443a9c2cdc4e8bfa0183501c07395c670a04b4fa45efdaec503cd30e
+  metadata.gz: ce55bd11d1164eaaa7985395b77ac8d104f69adfd1a5d3ccd1e6a195e02aceb2
+  data.tar.gz: '08700bcdc5768db23d313ac4cdde14c4b315f83f407b26fcff764b0249d5ca31'
 SHA512:
-  metadata.gz: d2f99691dda8529a626456196f0359fd0a16e5ee28c831e23f7fc061038fb95b34b9bb0dc10cba562490c2d2b8b84bf23530d6d2e489e7747100e360d7fef8f9
-  data.tar.gz: ecb8a80e8c191111daab48367d7f9d2afa0a9ee0618d9ad339484af25e6a80cf36af9c047295a626b43403e94514343b19a383b7ecdb97d3875133fec8ab669f
+  metadata.gz: 4f2585a8f933f806ff9cb998e58d7a03efda4a0aee1afeccd5f07289156e37c8ccf9092058b19413a22986031c0a82cca7dd35a9f6dbc9d7211d0823b363e708
+  data.tar.gz: b5139b404dfc9c6c1b5027286126438e81da1c577805aedd3273f07e5e0f2ee9fdb89572d32f652d2e9c8f372c062b74c5ae948b4b2a0347383b908ac29648b9

data/.github/workflows/danger.yml

@@ -0,0 +1,23 @@
+---
+name: danger
+on: [pull_request]
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+        bundler-cache: true
+    - name: Run Danger
+      env:
+        BUNDLE_GEMFILE: Gemfile.danger      
+      run: |
+        bundle install
+        # the personal token is public, this is ok, base64 encode to avoid tripping Github
+        TOKEN=$(echo -n NWY1ZmM5MzEyMzNlYWY4OTZiOGU3MmI3MWQ3Mzk0MzgxMWE4OGVmYwo= | base64 --decode)
+        DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+---
+name: test
+on: [push, pull_request]
+jobs:
+  lint:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Run RuboCop
+        run: bundle exec rubocop

data/.github/workflows/test-mongodb.yml

@@ -0,0 +1,32 @@
+---
+name: test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        entry:
+          - { ruby: 2.6.2, mongoid: 6.4.8, mongodb: 4.4 }
+          - { ruby: 2.6.2, mongoid: 7.2.3, mongodb: 4.4 }
+          - { ruby: 2.6.2, mongoid: 7.3.0, mongodb: 4.4 }
+    name: test (ruby=${{ matrix.entry.ruby }}, mongoid=${{ matrix.entry.mongoid }}, mongodb=${{ matrix.entry.mongodb }})
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.entry.ruby }}
+      - uses: browser-actions/setup-geckodriver@latest
+      - run: geckodriver --version
+      - uses: supercharge/mongodb-github-action@1.7.0
+        with:
+          mongodb-version: ${{ matrix.entry.mongodb }}
+      - name: Test
+        uses: GabrielBB/xvfb-action@v1
+        env:
+          DATABASE_ADAPTER: mongoid
+          MONGOID_VERSION: ${{ matrix.entry.mongoid }}
+        with:
+          run: |
+            bundle install
+            bundle exec rake spec

data/.github/workflows/test-postgresql.yml

@@ -0,0 +1,33 @@
+---
+name: test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        entry:
+          - { ruby: 2.6.2, postgresql: 11 }
+    name: test (ruby=${{ matrix.entry.ruby }}, postgresql=${{ matrix.entry.postgresql }})
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.entry.ruby }}
+      - uses: browser-actions/setup-geckodriver@latest
+      - run: geckodriver --version
+      - uses: harmon758/postgresql-action@v1
+        with:
+          postgresql version: ${{ matrix.entry.postgresql }}
+          postgresql db: slack_ruby_bot_server_test
+          postgresql user: test
+          postgresql password: password
+      - name: Test
+        uses: GabrielBB/xvfb-action@v1
+        env:
+          DATABASE_ADAPTER: activerecord
+          DATABASE_URL: postgres://test:password@localhost/slack_ruby_bot_server_test
+        with:
+          run: |
+            bundle install
+            bundle exec rake spec

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ### Changelog
 
+#### 1.2.1 (2022/03/06)
+
+* [#140](https://github.com/slack-ruby/slack-ruby-bot-server/pull/140): Fix: `NameError` for `Boolean` types with mongoid >= 7.3.0 - [@dblock](https://github.com/dblock).
+* [#142](https://github.com/slack-ruby/slack-ruby-bot-server/pull/142): Replace Travis-CI with GitHub Actions - [@dblock](https://github.com/dblock).
+
 #### 1.2.0 (2020/11/27)
 
 * [#133](https://github.com/slack-ruby/slack-ruby-bot-server/pull/133): Added `Team#oauth_version` and `#scope` - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 case ENV['DATABASE_ADAPTER']
 when 'mongoid' then
   gem 'kaminari-mongoid'
-  gem 'mongoid'
+  gem 'mongoid', ENV['MONGOID_VERSION'] || '~> 7.3.0'
   gem 'mongoid-scroll'
   gem 'mongoid-shell'
 when 'activerecord' then
@@ -23,10 +23,11 @@ group :development, :test do
   gem 'bundler'
   gem 'byebug'
   gem 'capybara', '~> 2.15.1'
-  gem 'database_cleaner'
+  gem 'database_cleaner', '~> 1.8.5'
   gem 'fabrication'
   gem 'faker'
-  gem 'hyperclient'
+  gem 'faraday', '0.17.5'
+  gem 'hyperclient', '~> 0.9.3'
   gem 'rack-server-pages'
   gem 'rack-test'
   gem 'rake'
@@ -35,9 +36,5 @@ group :development, :test do
   gem 'selenium-webdriver', '~> 3.4.4'
   gem 'vcr'
   gem 'webmock'
-end
-
-group :test do
-  gem 'danger-toc', '~> 0.2.0', require: false
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'webrick', '~> 1.6.1'
 end

data/Gemfile.danger

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'danger-toc', '~> 0.2.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
+end

data/MIGRATING.md

@@ -0,0 +1,98 @@
+### Introduction
+
+Slack recently [introduced granular permissions](https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3) and is now requiring all new apps to use them. The old apps are called _classic_ apps. Slack also provided a [migration guide](https://api.slack.com/authentication/migration).
+
+> As of December 4th, 2020 Slack 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. So you better get going with a migration ASAP.
+
+New bots cannot use real-time, and there's no way to automatically migrate existing installations - users must reinstall a newer version of the bot. This migration guide avoids a data migration by allowing you to operate both the old and the new version on top of the same database.
+
+> The migration effectively involves replacing `slack-ruby-bot-server-rtm` with `slack-ruby-bot-server-events`.
+
+### Upgrade to Slack-Ruby-Bot-Server 1.2.0 and Slack-Ruby-Bot-Server-Rtm
+
+Upgrade to the latest version of [slack-ruby-bot-server-rtm](https://github.com/slack-ruby/slack-ruby-bot-server-rtm) , which extracts real-time components. This involves replacing `SlackRubyBotServer::Server` with `SlackRubyBotServer::RealTime::Server`.
+
+Upgrade to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) >= 1.2.0. This version introduces two new `Team` fields, `oauth_version` and `oauth_scope` to store which version of the bot performed the install. This allows slack-ruby-bot-server-rtm to ignore newer bots and only boot RTM for legacy bots.
+
+See [UPGRADING](https://github.com/slack-ruby/slack-ruby-bot-server/blob/master/UPGRADING.md#upgrading-to--120) for more information on ActiveRecord database migrations.
+
+Deploy your bot and make sure everything is working without any changes.
+
+### Create a New Slack App
+
+In order not to affect existing users, [create a new Slack app](https://api.slack.com/apps) with new granular permissions and scopes. For example, to send messages to Slack you will need `chat:write`. To read messages in public channels, `channels:history`. To receive bot mentions you'll need `app_mentions:read` and to receive DMs, `im:history`.
+
+### Respond to Slack Events
+
+#### App Mentions
+
+A typical bot may want to respond to mentions, which is made very easy by the new [slack-ruby-bot-server-events-app-mentions](https://github.com/slack-ruby/slack-ruby-bot-server-events-app-mentions) gem. This is similar to the [commands in slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot#commands-and-operators), but you'll need to do the work to actually migrate functionality to mentions, and not all variations of commands and operators are currently supported.
+
+```ruby
+SlackRubyBotServer.configure do |config|
+  config.oauth_version = :v2
+  config.oauth_scope = ['app_mentions:read', 'im:history', 'chat:write']
+end
+```
+
+```ruby
+class Ping < SlackRubyBotServer::Events::AppMentions::Mention
+  mention 'ping'
+
+  def self.call(data)
+    client = Slack::Web::Client.new(token: data.team.token)
+    client.chat_postMessage(channel: data.channel, text: 'pong')
+  end
+end
+```
+
+See a [complete sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-app-mentions-sample) for more details.
+
+#### Other Messages
+
+More advanced bots may want to handle all kinds of messages. For example, [slack-shellbot#22](https://github.com/slack-ruby/slack-shellbot/pull/22) configures scopes to receive the kitchen sink of events, then handles them carefully avoiding handling its own messages.
+
+```ruby
+SlackRubyBotServer.configure do |config|
+  config.oauth_version = :v2
+  config.oauth_scope = ['chat:write', 'im:history', 'mpim:history', 'channels:history', 'groups:history']
+end
+```
+
+```ruby
+SlackRubyBotServer::Events.configure do |config|
+  config.on :event, 'event_callback', 'message' do |event|
+    # SlackShellbot::Commands::Base.logger.info event
+
+    next true if event['event']['subtype'] # updates, etc.
+    next true if event['authorizations'][0]['user_id'] == event['event']['user'] # self
+
+    team = Team.where(team_id: event['team_id']).first
+    next true unless team
+
+    data = Slack::Messages::Message.new(event['event'])
+
+    # handles event data here
+
+    true
+  end
+end
+```
+
+### Deploy
+
+Create a new app deployment, use the same database as your production bot. The new bot needs a configuration with the `SLACK_CLIENT_ID`, `SLACK_CLIENT_SECRET` and `SLACK_SIGNING_SECRET` from the new app with granular permissions. Use the same database instance as the old RTM bot.
+
+Now there are two versions of the app running on top of the same database: one is the legacy one, and the other is the granular scopes app. The old app will ignore new bot installations that use granular permissions. The new app should ignore any old bot installations. Thus both apps should work.
+
+### Switch DNS
+
+Switch DNS, new bot registrations can use the new granular scopes app. Make sure in Slack the event URLs are configured properly to point to this DNS.
+
+### Slow Migration for Existing Teams
+
+Existing teams can uninstall the old bot and re-install the new one. The old real-time implementation will stop working once the token has been switched, but the data will remain intact and the team will get reactivated using the new bot with granular permissions.
+
+### Long Version
+
+See [this blog post](http://localhost:4000/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html) for a longer, opinionated version of this migration guide.

data/README.md

@@ -2,8 +2,10 @@ Slack Ruby Bot Server
 =====================
 
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server.svg)](https://badge.fury.io/rb/slack-ruby-bot-server)
-[![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server)
 [![Code Climate](https://codeclimate.com/github/slack-ruby/slack-ruby-bot-server.svg)](https://codeclimate.com/github/slack-ruby/slack-ruby-bot-server)
+[![mongodb](https://github.com/slack-ruby/slack-ruby-bot-server/actions/workflows/test-mongodb.yml/badge.svg)](https://github.com/slack-ruby/slack-ruby-bot-server/actions/workflows/test-mongodb.yml)
+[![postgresql](https://github.com/slack-ruby/slack-ruby-bot-server/actions/workflows/test-postgresql.yml/badge.svg)](https://github.com/slack-ruby/slack-ruby-bot-server/actions/workflows/test-postgresql.yml)
+[![rubocop](https://github.com/slack-ruby/slack-ruby-bot-server/actions/workflows/rubocop.yml/badge.svg)](https://github.com/slack-ruby/slack-ruby-bot-server/actions/workflows/rubocop.yml)
 
 Build a complete Slack bot service with Slack button integration, in Ruby.
 
@@ -34,15 +36,15 @@ Build a complete Slack bot service with Slack button integration, in Ruby.
 
 ## What is this?
 
-A library that contains a web server and a RESTful [Grape](http://github.com/ruby-grape/grape) API serving a Slack bot to multiple teams. Use in conjunction with [slack-ruby-bot-server-events](https://github.com/slack-ruby/slack-ruby-bot-server-events) to build a complete Slack bot service, or [slack-ruby-bot-server-rtm](https://github.com/slack-ruby/slack-ruby-bot-server-rtm) to build a Class RealTime Slack bot. Your customers can use a Slack button to install the bot.
+A library that contains a web server and a RESTful [Grape](http://github.com/ruby-grape/grape) API serving a Slack bot to multiple teams. Use in conjunction with [slack-ruby-bot-server-events](https://github.com/slack-ruby/slack-ruby-bot-server-events) to build a complete Slack bot service, or [slack-ruby-bot-server-rtm](https://github.com/slack-ruby/slack-ruby-bot-server-rtm) to build a (legacy) Classic RealTime Slack bot. Your customers can use a Slack button to install the bot.
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot-server, v1.2.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server. See [UPGRADING](UPGRADING.md) when upgrading from an older version. See [MIGRATING](MIGRATING.md) for help with migrating Legacy Slack Apps to Granular Scopes.
 
 ## Make Your Own
 
-This library alone will only register a new bot, but will not include any bot functionality. To make something useful, we recommend you get started from a [slack-ruby-bot-events-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-sample) app to bootstrap your project.
+This library alone will only register a new bot, but will not include any bot functionality. To make something useful, we recommend you get started from either [slack-ruby-bot-server-events-app-mentions-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-app-mentions-sample) (handles a single kind of event), or [slack-ruby-bot-server-events-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-sample) (handles all kinds of events) to bootstrap your project.
 
 ## Usage
 
@@ -63,7 +65,7 @@ gem 'slack-ruby-bot-server'
 
 #### ActiveRecord
 
-Use ActiveRecord with, for example, PostgreSQL via [pg](https://github.com/ged/ruby-pg). Configure the database connection in `postgresql.yml`. Add the `activerecord`, `pg`, `otr-activerecord` and `cursor_pagination` gems to your Gemfile.
+Use ActiveRecord with, for example, PostgreSQL via [pg](https://github.com/ged/ruby-pg). Add the `activerecord`, `pg`, `otr-activerecord` and `cursor_pagination` gems to your Gemfile.
 
 ```
 gem 'pg'
@@ -73,6 +75,40 @@ gem 'otr-activerecord'
 gem 'cursor_pagination'
 ```
 
+Configure the database connection in `config/postgresql.yml`. 
+
+```yaml
+default: &default
+  adapter: postgresql
+  pool: 10
+  timeout: 5000
+  encoding: unicode
+
+development:
+  <<: *default
+  database: bot_development
+
+test:
+  <<: *default
+  database: bot_test
+
+production:
+  <<: *default
+  database: bot
+```
+
+Establish a connection in your startup code.
+
+```ruby
+ActiveRecord::Base.establish_connection(
+  YAML.safe_load(
+    ERB.new(
+      File.read('config/postgresql.yml')
+    ).result, [], [], true
+  )[ENV['RACK_ENV']]
+)
+```
+
 ### OAuth Version and Scopes
 
 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.

data/UPGRADING.md

@@ -23,6 +23,8 @@ class AddOauthFields < ActiveRecord::Migration[5.0]
 end
 ```
 
+See [MIGRATING](MIGRATING.md) for help with migrating Legacy Slack Apps to Granular Scopes.
+
 ### Upgrading to >= 1.1.0
 
 #### Extracted RealTime (Legacy) Support

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

@@ -19,7 +19,7 @@ module SlackRubyBotServer
 
           desc 'Get all the teams.'
           params do
-            optional :active, type: Boolean, desc: 'Return active teams only.'
+            optional :active, type: ::Grape::API::Boolean, desc: 'Return active teams only.'
             use :pagination
           end
           sort Team::SORT_ORDERS

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

@@ -10,7 +10,7 @@ module SlackRubyBotServer
         property :team_id, type: String, desc: 'Slack team ID.'
         property :name, type: String, desc: 'Team name.'
         property :domain, type: String, desc: 'Team domain.'
-        property :active, type: Boolean, desc: 'Team is active.'
+        property :active, type: ::Grape::API::Boolean, desc: 'Team is active.'
         property :created_at, type: DateTime, desc: 'Date/time when the team was created.'
         property :updated_at, type: DateTime, desc: 'Date/time when the team was accepted, declined or canceled.'
 

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

@@ -10,7 +10,7 @@ class Team
   field :token, type: String
   field :oauth_scope, type: String
   field :oauth_version, type: String, default: 'v1'
-  field :active, type: Boolean, default: true
+  field :active, type: Mongoid::Boolean, default: true
   field :bot_user_id, type: String
   field :activated_user_id, type: String
   field :activated_user_access_token, type: String

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

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot-server
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -158,18 +158,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/danger.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test-mongodb.yml"
+- ".github/workflows/test-postgresql.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DEBUGGING.md
 - Dangerfile
 - Gemfile
+- Gemfile.danger
 - Guardfile
 - LICENSE
+- MIGRATING.md
 - README.md
 - RELEASING.md
 - Rakefile

data/.travis.yml

@@ -1,33 +0,0 @@
-language: ruby
-
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.6.2
-      script:
-        - bundle exec danger
-      services:
-        - xvfb
-    - rvm: 2.6.2
-      env: DATABASE_ADAPTER=activerecord
-      services:
-        - xvfb
-        - postgresql
-    - rvm: 2.6.2
-      env: DATABASE_ADAPTER=mongoid
-      services:
-        - xvfb
-        - mongodb
-
-addons:
-  firefox: 54.0
-
-before_install:
-  - wget https://github.com/mozilla/geckodriver/releases/download/v0.18.0/geckodriver-v0.18.0-linux64.tar.gz
-  - mkdir geckodriver
-  - tar -xzf geckodriver-v0.18.0-linux64.tar.gz -C geckodriver
-  - export PATH=$PATH:$PWD/geckodriver
-
-script:
-  - bundle exec rake