slack-ruby-bot-server 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7080b4c298a9246ee55a74395a69e185657e7999e7acd19c55792f3a5cc2fd4
-  data.tar.gz: 4a5495629509d5b4352d42b0290ead69db7ffd8a157841eb7a85dd7d1053b928
+  metadata.gz: 8190478be418eff0f5da4e0cfede6b2203664c4e0812783575e9e00519b42b1c
+  data.tar.gz: 8a06246c7bd7052c5adf79b3aedfd95493408d909faca16eaca538f638b0aa9f
 SHA512:
-  metadata.gz: 769de3df16397c503ed1075acda16a9b6f67a8a6dba7d2acad8a6d28c6a06dade0f7f2046f6f6cd560883dbee849dd17bdf913a0ee6b8eedc5928b9db58f40c1
-  data.tar.gz: cabe33848ffe7d6895d1b659e28ff43922740062964d29c6ae7d7f152e33f38820b0849f5fdfe90d28f924904dc0b61496a4da723462aa6c1670688251843f78
+  metadata.gz: 26e3f8e38c8196c079ae1eaa8c5a6f7ec32cb71e963cb8e3f61f1f017dde997a739d0208d25f5a6dc1d84d38c9ba90b50072a16536b38a4b1444cbf9fbbc0e3b
+  data.tar.gz: 371ab36d34805242886ed780d01784535a133156fe633349389281effde66d62d607422ec6539fa892a430390eada2f5c6e66f0bd54be7591f17097db6b9ee94

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

@@ -21,12 +21,7 @@ jobs:
         entry:
           # These Active Support versions pass quirks_mode, removed in JSON 3.
           - { ruby: '3.2', mongoid: '6.4.8', mongodb: '4.4', json: '~> 2.0' }
-          - { ruby: '3.2', mongoid: '7.2.3', mongodb: '4.4', json: '~> 2.0' }
-          - { ruby: '3.2', mongoid: '7.3.0', mongodb: '4.4', json: '~> 2.0' }
-          - { ruby: '3.3', mongoid: '7.3.0', mongodb: '5.0', json: '~> 2.0' }
           - { ruby: '3.4', mongoid: '7.5.2', mongodb: '5.0', json: '~> 2.0' }
-          - { ruby: '3.4', mongoid: '8.1.11', mongodb: '6.0', json: '~> 2.0' }
-          - { ruby: '3.4', mongoid: '8.1.11', mongodb: '7.0', json: '~> 2.0' }
           - { ruby: '3.4', mongoid: '8.1.11', mongodb: '8.0', json: '~> 2.0' }
           - { ruby: '3.3', mongoid: '~> 9.1', mongodb: '8.0', grape: '~> 3.2', json: '~> 3.0' }
           - { ruby: '3.4', mongoid: '~> 9.1', mongodb: '8.0', grape: '~> 4.0', json: '~> 3.0' }

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

@@ -20,14 +20,9 @@ jobs:
       fail-fast: false
       matrix:
         entry:
-          # Active Support 6.x, 7.0, and 8.0 pass quirks_mode, removed in JSON 3.
-          - { ruby: '3.2', postgresql: '11', active_record: '~> 6.0.0', json: '~> 2.0' }
+          # Active Support 6.x and 8.0 pass quirks_mode, removed in JSON 3.
           - { ruby: '3.2', postgresql: '11', active_record: '~> 6.1.0', json: '~> 2.0' }
-          - { ruby: '3.2', postgresql: '14', active_record: '~> 7.0.0', json: '~> 2.0' }
           - { ruby: '3.3', postgresql: '14', active_record: '~> 7.2.0', json: '~> 3.0' }
-          - { ruby: '3.4', postgresql: '14', active_record: '~> 7.2.0', json: '~> 3.0' }
-          - { ruby: '3.4', postgresql: '15', active_record: '~> 8.0.2', json: '~> 2.0' }
-          - { ruby: '3.4', postgresql: '16', active_record: '~> 8.0.2', json: '~> 2.0' }
           - { ruby: '3.4', postgresql: '17', active_record: '~> 8.0.2', json: '~> 2.0' }
           - { ruby: '3.3', postgresql: '18', active_record: '~> 8.1', grape: '~> 3.2', json: '~> 3.0' }
           - { ruby: '3.4', postgresql: '18', active_record: '~> 8.1', grape: '~> 4.0', json: '~> 3.0' }

data/AGENTS.md

@@ -44,7 +44,7 @@ Browser tests require Firefox. Selenium Manager provisions geckodriver when need
 
 ## Changes and Compatibility
 
-Preserve both database adapters and the existing unique CI matrix combinations, including explicit Grape 3/4 coverage. Quote version strings in workflow YAML and validate workflow changes with `actionlint`.
+Preserve both database adapters, representative legacy ORM major versions, and the modern Ruby/Grape 3/4 combinations in the six-job-per-adapter CI matrices. Avoid multiplying equivalent jobs across database server versions. Quote version strings in workflow YAML and validate workflow changes with `actionlint`.
 
 Keep JSON 2 constraints scoped to affected legacy matrix jobs through `JSON_VERSION`; modern jobs explicitly test JSON 3. Do not add a blanket JSON upper bound to the Gemfile or gemspec.
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ### Changelog
 
+### 2.3.0 (2026/10/25)
+
+* [#188](https://github.com/slack-ruby/slack-ruby-bot-server/pull/188): Reduce the database CI matrices from 22 to 12 jobs while retaining representative legacy ORM majors and modern Ruby/Grape 3/4 coverage - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#189](https://github.com/slack-ruby/slack-ruby-bot-server/pull/189): Add a prefixed Team fabricator entry point and preserve application-defined `:team` fabricators in the legacy RSpec helper - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#186](https://github.com/slack-ruby/slack-ruby-bot-server/pull/186): Document persisted custom Team attributes for both adapters and Rails concern loading/reloading - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#183](https://github.com/slack-ruby/slack-ruby-bot-server/pull/183): Add a `config.server_pages` block to configure page middleware options centrally without changing the installed library's defaults - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#184](https://github.com/slack-ruby/slack-ruby-bot-server/pull/184): Add a configurable API application and separately mountable team read/registration endpoints, preserving the default API while supporting custom routes and registration-only applications - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
+* [#185](https://github.com/slack-ruby/slack-ruby-bot-server/pull/185): Skip inactive installations in status checks and deactivate revoked credentials through service callbacks, returning an explicit failed ping instead of failing the whole status response - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).
 ### 2.2.1 (2026/10/24)
 
 * [#182](https://github.com/slack-ruby/slack-ruby-bot-server/pull/182): Modernize CI with current actions, native database services, dependency caching, and explicit Ruby 4, Mongoid 9, Active Record 8.1, PostgreSQL 18, Grape 3/4, and JSON 2/3 coverage while retaining existing compatibility combinations - [@dblock](https://github.com/dblock), [@Copilot](https://github.com/apps/copilot-swe-agent).

data/CONTRIBUTING.md

@@ -39,7 +39,9 @@ bundle exec rake
 
 For PostgreSQL, set `DATABASE_ADAPTER=activerecord`, `ACTIVERECORD_VERSION`, and `DATABASE_URL` instead. `GRAPE_VERSION` optionally constrains the Grape version for either adapter; without it, Bundler selects a compatible version. CI preserves the older compatibility combinations and adds explicit Grape 3 and 4 jobs with current ORM versions, including Ruby 4. Each database runs in a health-checked service container, while Firefox runs under Xvfb. Selenium Manager provisions the matching driver.
 
-`JSON_VERSION` optionally constrains the development/test JSON dependency; otherwise it is unrestricted. CI uses JSON 2 for Mongoid 6-8 and Active Record 6.x, 7.0, and 8.0 because their Active Support versions pass `quirks_mode`, removed in JSON 3. Mongoid 9, Active Record 7.2, and Active Record 8.1 jobs explicitly test JSON 3. These selectors do not restrict the published gem's runtime dependencies.
+CI runs six jobs per adapter: three representative legacy ORM/database stacks and three modern combinations (Ruby 3.3/Grape 3, Ruby 3.4/Grape 4, and Ruby 4/Grape 4). Mongoid retains 6.4, 7.5, 8.1, and 9.1; Active Record retains 6.1, 7.2, 8.0, and 8.1. Redundant database-server variants and older ORM minor combinations are omitted. A combination no longer appearing in CI is not by itself a change to the gem's supported runtime dependencies.
+
+`JSON_VERSION` optionally constrains the development/test JSON dependency; otherwise it is unrestricted. CI uses JSON 2 for Mongoid 6-8 and Active Record 6.1 and 8.0 because their Active Support versions pass `quirks_mode`, removed in JSON 3. Mongoid 9, Active Record 7.2, and Active Record 8.1 jobs explicitly test JSON 3. These selectors do not restrict the published gem's runtime dependencies.
 
 On Linux, install [Firefox](https://www.mozilla.org/firefox/) and `Xvfb`, then run:
 

data/README.md

@@ -17,9 +17,15 @@ Build a complete Slack bot service with Slack button integration, in Ruby.
   - [Storage](#storage)
     - [MongoDB](#mongodb)
     - [ActiveRecord](#activerecord)
+    - [Extending Team](#extending-team)
+      - [Mongoid Attributes](#mongoid-attributes)
+      - [Active Record Attributes](#active-record-attributes)
+      - [Rails Loading and Reloading](#rails-loading-and-reloading)
   - [OAuth Version and Scopes](#oauth-version-and-scopes)
   - [Slack App](#slack-app)
   - [API](#api)
+    - [Custom Endpoints](#custom-endpoints)
+    - [Team Endpoint Visibility](#team-endpoint-visibility)
     - [App](#app)
     - [Service Manager](#service-manager)
       - [Lifecycle Callbacks](#lifecycle-callbacks)
@@ -27,7 +33,9 @@ Build a complete Slack bot service with Slack button integration, in Ruby.
       - [Extensions](#extensions)
     - [Service Class](#service-class)
   - [HTML Templates](#html-templates)
+    - [Page Middleware Configuration](#page-middleware-configuration)
   - [Access Tokens](#access-tokens)
+- [Testing](#testing)
 - [Sample Bots Using Slack Ruby Bot Server](#sample-bots-using-slack-ruby-bot-server)
 - [Copyright & License](#copyright--license)
 
@@ -37,7 +45,7 @@ A library that contains a web server and a RESTful [Grape](http://github.com/rub
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot-server, 2.2.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version. See [MIGRATING](MIGRATING.md) for help with migrating Legacy Slack Apps to Granular Scopes.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, 2.3.0. 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
 
@@ -107,6 +115,76 @@ db_config = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0.pre1'
 ActiveRecord::Base.establish_connection(db_config)
 ```
 
+#### Extending Team
+
+The installation model is the top-level `::Team` class for both adapters, not `SlackRubyBotServer::Models::Team`. Load `slack-ruby-bot-server` before extending it. The model already includes its database adapter and timestamps; do not include them again or declare a different superclass.
+
+##### Mongoid Attributes
+
+Add fields by reopening the existing class in an application file, for example `lib/team_extensions.rb`:
+
+```ruby
+require 'slack-ruby-bot-server'
+
+class Team
+  field :subscription_plan, type: String, default: 'free'
+
+  def paid_plan?
+    subscription_plan == 'paid'
+  end
+end
+```
+
+Require that file from your startup code after loading the framework and before serving requests or starting the service. Mongoid does not require a schema migration for the new field.
+
+##### Active Record Attributes
+
+Add a column to the existing `teams` table with an application migration. Use your application's migration version; this example is also compatible with older supported Active Record versions:
+
+```ruby
+class AddSubscriptionPlanToTeams < ActiveRecord::Migration[6.0]
+  def change
+    add_column :teams, :subscription_plan, :string, default: 'free', null: false
+  end
+end
+```
+
+Run the migration before code uses the attribute. Active Record provides its reader and writer from the column; do not use `attr_accessor`, which would bypass persistence. Add methods by reopening `class Team` after loading the framework, as above, but omit the Mongoid-only `field` declaration.
+
+##### Rails Loading and Reloading
+
+Putting another `app/models/team.rb` in a Rails app is not a reliable way to extend a class already loaded by a gem. Put reloadable behavior in a concern instead:
+
+```ruby
+# app/models/concerns/team_extensions.rb
+module TeamExtensions
+  extend ActiveSupport::Concern
+
+  def paid_plan?
+    subscription_plan == 'paid'
+  end
+end
+```
+
+Include it in `::Team` from a reloader callback, rather than autoloading the concern directly during initializer execution:
+
+```ruby
+# config/initializers/team_extensions.rb
+require 'slack-ruby-bot-server'
+
+if SlackRubyBotServer.config.mongoid?
+  ::Team.field :subscription_plan, type: String, default: 'free'
+end
+
+Rails.application.config.to_prepare do
+  ::Team.include(TeamExtensions)
+end
+```
+
+With Active Record, use the migration above instead of declaring a field in the initializer. The callback runs at boot and after development reloads; including the same concern more than once is safe. Keep one-time field declarations outside the callback. Do not query the database or swallow database errors just to attach methods: the extension can be loaded before the `teams` table exists.
+
+The framework currently owns the global `Team` constant. An unrelated application model with the same name is a separate [name-collision limitation](https://github.com/slack-ruby/slack-ruby-bot-server/pull/83), not an extension mechanism.
+
 ### 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.
@@ -151,6 +229,58 @@ Navigate to either [localhost:9292](http://localhost:9292) or the ngrok URL abov
 
 This library implements an app, [SlackRubyBotServer::App](lib/slack-ruby-bot-server/app.rb) and a service manager, [SlackRubyBotServer::Service](lib/slack-ruby-bot-server/service.rb). It also provides [default HTML templates and JS scripts](public) for Slack integration.
 
+#### Custom Endpoints
+
+Set `config.api` to a Rack application, typically a `Grape::API` class, to customize the API without reopening the framework's classes. The default is `nil`, which uses `SlackRubyBotServer::Api::Endpoints::RootEndpoint`, including extensions mounted there by other gems. `SlackRubyBotServer::Config.reset!` restores this default.
+
+To add an endpoint alongside the default API:
+
+```ruby
+class ExtraApi < Grape::API
+  prefix 'api'
+  format :json
+
+  get :foobar do
+    { ok: true }
+  end
+end
+
+class ApplicationApi < Grape::API
+  mount SlackRubyBotServer::Api::Endpoints::RootEndpoint
+  mount ExtraApi
+end
+
+SlackRubyBotServer.configure do |config|
+  config.api = ApplicationApi
+end
+```
+
+Configure this before starting the application. In `config.ru`, continue running `SlackRubyBotServer::Api::Middleware.instance`; both `/api/foobar` and the existing `/api` routes then share the framework's CORS, URL-rewrite, and page middleware. A separate `Rack::Cascade` stack is unnecessary.
+
+In Rails, require the file defining `ApplicationApi` from your initializer before assigning `config.api`. For reloadable classes, make the assignment inside `Rails.application.config.to_prepare` so it references the current class. Mount `SlackRubyBotServer::Api::Middleware.instance` in your routes, for example `mount SlackRubyBotServer::Api::Middleware.instance => '/'`, rather than bypassing that middleware stack.
+
+#### Team Endpoint Visibility
+
+The default API exposes `GET /api/teams` and `GET /api/teams/:id` publicly. To retain OAuth registration without those read endpoints, use the separately mountable `TeamsEndpoint::Create`. `TeamsEndpoint::Read` contains the list and detail routes; `TeamsEndpoint` continues to mount both for backward compatibility.
+
+```ruby
+class RegistrationApi < Grape::API
+  include SlackRubyBotServer::Api::Helpers::ErrorHelpers
+
+  prefix 'api'
+  format :json
+  formatter :json, Grape::Formatter::Roar
+
+  mount SlackRubyBotServer::Api::Endpoints::TeamsEndpoint::Create
+end
+
+SlackRubyBotServer.configure do |config|
+  config.api = RegistrationApi
+end
+```
+
+This replaces the default root API: it does not expose its status, root discovery, Swagger, or team-read routes. Do not also mount `RootEndpoint` or `TeamsEndpoint`, since either would restore the public team reads. If you use the Events extension or other custom endpoints, explicitly mount their routes with their required signature verification too. Add your own authentication before mounting `TeamsEndpoint::Read` if you need protected team queries. OAuth registration still requires a valid Slack authorization code; this configuration does not add a general authentication layer.
+
 #### App
 
 The app instance checks for a working database connection, ensures indexes, performs migrations, sets up bot aliases and log levels. You can introduce custom behavior into the app lifecycle by subclassing `SlackRubyBotServer::App` and creating an instance of the child class in `config.ru`.
@@ -307,10 +437,51 @@ SlackRubyBotServer.configure do |config|
 end
 ```
 
+#### Page Middleware Configuration
+
+Use `config.server_pages` to configure the underlying [`Rack::ServerPages`](https://github.com/migrs/rack-server-pages) middleware in an initializer, before `SlackRubyBotServer::Api::Middleware.instance` is first accessed. The block receives its configuration object after the framework applies `view_paths`, so it can customize any option supported by your installed `rack-server-pages` version.
+
+For example, with `rack-server-pages` 0.3.0 or newer:
+
+```ruby
+SlackRubyBotServer.configure do |config|
+  config.server_pages do |pages|
+    pages.cache_control = 'private, no-cache'
+    pages.static_cache_control = 'public, no-cache'
+  end
+end
+```
+
+`cache_control` sets the default `Cache-Control` header for rendered templates, including generated CSS. `static_cache_control` sets it for static files. `no-cache` allows storage but requires revalidation before reuse; use `private, no-store` for sensitive pages. You can also configure `static_etags` and `static_timestamps` with version 0.3.0 or newer. These settings do not change downstream API responses.
+
+Without a block, the framework preserves the installed library's defaults and existing `view_paths` behavior. Registering another block replaces the previous one, and `SlackRubyBotServer::Config.reset!` clears it. The block runs when the middleware stack is built, not on each request. If you change configuration after initialization, rebuild the stack with `SlackRubyBotServer::Api::Middleware.reset!`; configure it before startup in production.
+
 ### Access Tokens
 
 By default the implementation of [Team](lib/slack-ruby-bot-server/models/team) stores the value of the token with all the requested OAuth scopes in both `token` and `activated_user_access_token` (for backwards compatibility), along with `oauth_version` and `oauth_scope`. If a legacy Slack bot integration `bot_access_token` is present, it is stored as `token`, and `activated_user_access_token` is the token that has all the requested OAuth scopes.
 
+## Testing
+
+The optional test helpers use [Fabrication](https://fabricationgem.org/) and Faker. Add `fabrication` and `faker` to your application's test dependencies; neither is a runtime dependency of this gem.
+
+To use the framework's installation defaults without reserving your application's `:team` fabricator name, load the prefixed-only helper:
+
+```ruby
+require 'slack-ruby-bot-server/rspec/fabricators'
+
+team = Fabricate(:slack_ruby_bot_server_team)
+```
+
+This fabricator creates the existing `::Team` model with unique token/team ID sequences and a generated name. Applications can register their own `:team` before or after this helper, or inherit the framework defaults:
+
+```ruby
+Fabricator(:team, from: :slack_ruby_bot_server_team) do
+  name { 'My application team' }
+end
+```
+
+The existing `require 'slack-ruby-bot-server/rspec'` remains supported. It loads the prefixed fabricator and registers the legacy `:team` alias only when no `:team` definition already exists. If your application defines `:team` later, replace the legacy require with `slack-ruby-bot-server/rspec/fabricators`; loading both entry points still opts into the legacy alias.
+
 ## Sample Bots Using Slack Ruby Bot Server
 
 * [slack-ruby-bot-server-events-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-sample), a generic sample

data/UPGRADING.md

@@ -1,6 +1,30 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 2.3.0
+
+#### Recommended Test Helper Migration
+
+If your application defines its own `:team` fabricator, replace `require 'slack-ruby-bot-server/rspec'` with `require 'slack-ruby-bot-server/rspec/fabricators'`. This is recommended, not required: the new entry point registers only `:slack_ruby_bot_server_team`, leaving `:team` available regardless of whether your application's fabricator is loaded before or after the helper.
+
+Use `Fabricate(:slack_ruby_bot_server_team)` for the framework defaults, or inherit them in your application's fabricator:
+
+```ruby
+require 'slack-ruby-bot-server/rspec/fabricators'
+
+Fabricator(:team, from: :slack_ruby_bot_server_team) do
+  name { 'My application team' }
+end
+```
+
+The legacy helper remains supported and registers `:team` only if no definition already exists. Replace the old require rather than adding the new one alongside it; loading both still opts into the legacy alias and can conflict with a `:team` definition loaded later.
+
+#### Status Checks and Inactive Installations
+
+`GET /api/status` now pings only active installations. When Slack returns `account_inactive` or `invalid_auth`, the installation is deactivated through `Service#deactivate!`, and the endpoint returns HTTP `200` with `ping: { "ok": false, "error": "account_inactive" }` (or `"invalid_auth"`). The active-team count reflects that deactivation. Monitoring should inspect the failed `ping` as well as the HTTP status.
+
+When no active installations remain, no Slack ping is attempted. Other Slack errors retain their existing error response and do not deactivate installations.
+
 ### Upgrading to >= 2.2.0
 
 #### Cursor Helper Iterator Changes

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

@@ -2,118 +2,129 @@ module SlackRubyBotServer
   module Api
     module Endpoints
       class TeamsEndpoint < Grape::API
-        format :json
-        helpers Helpers::CursorHelpers
-        helpers Helpers::SortHelpers
-        helpers Helpers::PaginationParameters
-
-        namespace :teams do
-          desc 'Get a team.'
-          params do
-            requires :id, type: String, desc: 'Team ID.'
-          end
-          get ':id' do
-            team = Team.find(params[:id]) || error!('Not Found', 404)
-            present team, with: Presenters::TeamPresenter
-          end
+        class Read < Grape::API
+          format :json
+          helpers Helpers::CursorHelpers
+          helpers Helpers::SortHelpers
+          helpers Helpers::PaginationParameters
 
-          desc 'Get all the teams.'
-          params do
-            optional :active, type: ::Grape::API::Boolean, desc: 'Return active teams only.'
-            use :pagination
-          end
-          sort Team::SORT_ORDERS
-          get do
-            teams = Team.all
-            teams = teams.active if params[:active]
-            teams = paginate_and_sort_by_cursor(teams, default_sort_order: '-id')
-            present teams, with: Presenters::TeamsPresenter
-          end
+          namespace :teams do
+            desc 'Get a team.'
+            params do
+              requires :id, type: String, desc: 'Team ID.'
+            end
+            get ':id' do
+              team = Team.find(params[:id]) || error!('Not Found', 404)
+              present team, with: Presenters::TeamPresenter
+            end
 
-          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
-
-            raise 'Missing SLACK_CLIENT_ID or SLACK_CLIENT_SECRET.' unless ENV.key?('SLACK_CLIENT_ID') && ENV.key?('SLACK_CLIENT_SECRET')
-
-            options = {
-              client_id: ENV.fetch('SLACK_CLIENT_ID', nil),
-              client_secret: ENV.fetch('SLACK_CLIENT_SECRET', nil),
-              code: params[:code]
-            }
-
-            rc = client.send(SlackRubyBotServer.config.oauth_access_method, options)
-
-            token = nil
-            access_token = nil
-            user_id = nil
-            bot_user_id = nil
-            team_id = nil
-            team_name = nil
-            oauth_scope = nil
-            oauth_version = SlackRubyBotServer::Config.oauth_version
-
-            case 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
-              oauth_scope = rc.scope
-            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
-              oauth_scope = rc.scope
+            desc 'Get all the teams.'
+            params do
+              optional :active, type: ::Grape::API::Boolean, desc: 'Return active teams only.'
+              use :pagination
+            end
+            sort Team::SORT_ORDERS
+            get do
+              teams = Team.all
+              teams = teams.active if params[:active]
+              teams = paginate_and_sort_by_cursor(teams, default_sort_order: '-id')
+              present teams, with: Presenters::TeamsPresenter
             end
+          end
+        end
+
+        class Create < Grape::API
+          format :json
 
-            team = Team.where(token: token).first
-            team ||= Team.where(team_id: team_id, oauth_version: oauth_version).first
-            team ||= Team.where(team_id: team_id).first
-
-            if team
-              team.ping_if_active!
-
-              team.update!(
-                oauth_version: oauth_version,
-                oauth_scope: oauth_scope,
-                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!(
-                token: token,
-                oauth_version: oauth_version,
-                oauth_scope: oauth_scope,
-                team_id: team_id,
-                name: team_name,
-                activated_user_id: user_id,
-                activated_user_access_token: access_token,
-                bot_user_id: bot_user_id
-              )
+          namespace :teams do
+            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
+
+              raise 'Missing SLACK_CLIENT_ID or SLACK_CLIENT_SECRET.' unless ENV.key?('SLACK_CLIENT_ID') && ENV.key?('SLACK_CLIENT_SECRET')
 
-            options = params.slice(:state)
+              options = {
+                client_id: ENV.fetch('SLACK_CLIENT_ID', nil),
+                client_secret: ENV.fetch('SLACK_CLIENT_SECRET', nil),
+                code: params[:code]
+              }
 
-            Service.instance.create!(team, options)
-            present team, with: Presenters::TeamPresenter
+              rc = client.send(SlackRubyBotServer.config.oauth_access_method, options)
+
+              token = nil
+              access_token = nil
+              user_id = nil
+              bot_user_id = nil
+              team_id = nil
+              team_name = nil
+              oauth_scope = nil
+              oauth_version = SlackRubyBotServer::Config.oauth_version
+
+              case 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
+                oauth_scope = rc.scope
+              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
+                oauth_scope = rc.scope
+              end
+
+              team = Team.where(token: token).first
+              team ||= Team.where(team_id: team_id, oauth_version: oauth_version).first
+              team ||= Team.where(team_id: team_id).first
+
+              if team
+                team.ping_if_active!
+
+                team.update!(
+                  oauth_version: oauth_version,
+                  oauth_scope: oauth_scope,
+                  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!(
+                  token: token,
+                  oauth_version: oauth_version,
+                  oauth_scope: oauth_scope,
+                  team_id: team_id,
+                  name: team_name,
+                  activated_user_id: user_id,
+                  activated_user_access_token: access_token,
+                  bot_user_id: bot_user_id
+                )
+              end
+
+              options = params.slice(:state)
+
+              Service.instance.create!(team, options)
+              present team, with: Presenters::TeamPresenter
+            end
           end
         end
+
+        mount Read
+        mount Create
       end
     end
   end

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

@@ -30,6 +30,7 @@ module SlackRubyBotServer
 
           use Rack::ServerPages do |config|
             config.view_path = SlackRubyBotServer::Config.view_paths
+            SlackRubyBotServer::Config.server_pages&.call(config)
           end
 
           run Middleware.new
@@ -37,7 +38,7 @@ module SlackRubyBotServer
       end
 
       def call(env)
-        Endpoints::RootEndpoint.call(env)
+        (SlackRubyBotServer::Config.api || Endpoints::RootEndpoint).call(env)
       end
     end
   end

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

@@ -10,21 +10,27 @@ module SlackRubyBotServer
           "#{base_url(opts)}/status"
         end
 
+        property :ping
         property :teams_count
         property :active_teams_count
-        property :ping
 
         def ping
           if SlackRubyBotServer::Config.mongoid?
-            team = Team.asc(:_id).first
+            team = Team.active.asc(:_id).first
           elsif SlackRubyBotServer::Config.activerecord?
-            team = Team.last
+            team = Team.active.last
           else
             raise 'Unsupported database driver.'
           end
           return unless team
 
           team.ping!
+        rescue Slack::Web::Api::Errors::SlackError => e
+          raise unless %w[account_inactive invalid_auth].include?(e.message)
+
+          Middleware.logger.warn "Status ping failed for #{team}: #{e.message}; deactivating installation."
+          Service.instance.deactivate!(team)
+          { ok: false, error: e.message }
         end
 
         def teams_count

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

@@ -8,12 +8,15 @@ module SlackRubyBotServer
     attr_accessor :view_paths
     attr_accessor :oauth_scope
     attr_accessor :oauth_version
+    attr_accessor :api
 
     def reset!
       self.logger = nil
       self.service_class = SlackRubyBotServer::Service
       self.oauth_scope = nil
       self.oauth_version = :v2
+      @server_pages = nil
+      self.api = nil
 
       self.view_paths = [
         'views',
@@ -56,6 +59,11 @@ module SlackRubyBotServer
       oauth_scope&.join(',')
     end
 
+    def server_pages(&block)
+      @server_pages = block if block
+      @server_pages
+    end
+
     def activerecord?
       database_adapter == :activerecord
     end

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

@@ -0,0 +1,5 @@
+Fabricator(:slack_ruby_bot_server_team, class_name: 'Team') do
+  token { Fabricate.sequence(:team_token) { |i| "abc-#{i}" } }
+  team_id { Fabricate.sequence(:team_id) { |i| "T#{i}" } }
+  name { Faker::Lorem.word }
+end

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

@@ -1,5 +1,3 @@
-Fabricator(:team) do
-  token { Fabricate.sequence(:team_token) { |i| "abc-#{i}" } }
-  team_id { Fabricate.sequence(:team_id) { |i| "T#{i}" } }
-  name { Faker::Lorem.word }
-end
+require_relative 'slack_ruby_bot_server_team'
+
+Fabricator(:team, from: :slack_ruby_bot_server_team) unless Fabrication.manager[:team]

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

@@ -0,0 +1,4 @@
+require 'slack-ruby-bot-server'
+require 'fabrication'
+require 'faker'
+require_relative 'fabricators/slack_ruby_bot_server_team'

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

@@ -1,4 +1,2 @@
-require 'slack-ruby-bot-server'
-require 'fabrication'
-require 'faker'
+require_relative 'rspec/fabricators'
 require_relative 'rspec/fabricators/team'

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

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '2.2.1'.freeze
+  VERSION = '2.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot-server
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
@@ -225,6 +225,8 @@ files:
 - lib/slack-ruby-bot-server/models/team/methods.rb
 - lib/slack-ruby-bot-server/models/team/mongoid.rb
 - lib/slack-ruby-bot-server/rspec.rb
+- lib/slack-ruby-bot-server/rspec/fabricators.rb
+- lib/slack-ruby-bot-server/rspec/fabricators/slack_ruby_bot_server_team.rb
 - lib/slack-ruby-bot-server/rspec/fabricators/team.rb
 - lib/slack-ruby-bot-server/service.rb
 - lib/slack-ruby-bot-server/version.rb