slack-ruby-bot-server 0.11.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34d650b165e330149dfc1e8a0045660f9e2dbb3440d504c188496d90f5c25ac6
-  data.tar.gz: b29fdf9948bdccddc4bd5a08a0b0cbb701fb0aab40f03ed836d9fd438a67e9fc
+  metadata.gz: 3999b9e5a783666fcf1cebfe6d07d50e0228d7a1e3c17ca52217c7677705a1c2
+  data.tar.gz: 6294712aae7ca330fa3c13764e369084ed7f097772e22b54e5a8c1964ec2e130
 SHA512:
-  metadata.gz: a45158dd0b039e8d4fa70b565303c989f171594d021b60d8e00eb174ecc9c3073c535ba01f7a707e5b763a40db8e14b0cb4bc2adf397b7bdcc1fee25a72d7741
-  data.tar.gz: 3c6eeca00c91392fc41168688593052f51ad1b342427f13ab250f6b56f8fcb9924d751c11c1ed38571033479cbe975e371563e960cdb7d603eed6011d8cc4314
+  metadata.gz: 17c1e6474f1a45c964d67210d96669dc4bbb5910c3571d1720916f9a13b469741d08462e6feb57185a9745ffb373164f68c88f91bbf71691313215a23264a0a5
+  data.tar.gz: 43c5fde5d25f993be6da99758303026ff2870b26e50435cda7bc10218ae0fea1c7a9ab321d946f62485fc59f37da845ee425804327b1a5c7a4c2575d1f9ccfd3

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [dblock]

data/.rubocop.yml

@@ -1,7 +1,7 @@
 Metrics:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 500
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,34 +1,66 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-03-23 14:16:02 -0400 using RuboCop version 0.58.2.
+# on 2020-11-15 11:38:22 -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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
+# SupportedStyles: squiggly, active_support, powerpack, unindent
+Layout/HeredocIndentation:
   Exclude:
     - 'lib/slack-ruby-bot-server/info.rb'
-    - 'sample_apps/sample_app_activerecord/commands/help.rb'
-    - 'sample_apps/sample_app_mongoid/commands/help.rb'
 
-# Offense count: 3
-# Configuration parameters: Blacklist.
-# Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+# Offense count: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'spec/slack-ruby-bot-server/service_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/slack-ruby-bot-server.rb'
+
+# Offense count: 1
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
   Exclude:
     - 'lib/slack-ruby-bot-server/info.rb'
-    - 'sample_apps/sample_app_activerecord/commands/help.rb'
-    - 'sample_apps/sample_app_mongoid/commands/help.rb'
+
+# Offense count: 3
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/slack-ruby-bot-server/models/team/activerecord.rb'
+    - 'lib/slack-ruby-bot-server/models/team/mongoid.rb'
+    - 'lib/slack-ruby-bot-server/service.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: module_function, extend_self
+# Configuration parameters: EnforcedStyle, Autocorrect.
+# SupportedStyles: module_function, extend_self, forbidden
 Style/ModuleFunction:
   Exclude:
     - 'lib/slack-ruby-bot-server/config.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/slack-ruby-bot-server/service.rb'

data/.travis.yml

@@ -4,24 +4,26 @@ cache: bundler
 
 matrix:
   include:
-    - rvm: 2.3.1
+    - rvm: 2.6.2
       script:
         - bundle exec danger
-    - rvm: 2.3.1
+      services:
+        - xvfb
+    - rvm: 2.6.2
       env: DATABASE_ADAPTER=activerecord
       services:
+        - xvfb
         - postgresql
-    - rvm: 2.3.1
+    - rvm: 2.6.2
       env: DATABASE_ADAPTER=mongoid
       services:
+        - xvfb
         - mongodb
 
 addons:
   firefox: 54.0
 
 before_install:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
   - 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
@@ -29,4 +31,3 @@ before_install:
 
 script:
   - bundle exec rake
-  - BUNDLE_GEMFILE=Gemfile && cd sample_apps/sample_app_$DATABASE_ADAPTER && bundle && bundle exec rake

data/CHANGELOG.md

@@ -1,20 +1,47 @@
 ### Changelog
 
+#### 1.0.0 (2020/11/15)
+
+* [#129](https://github.com/slack-ruby/slack-ruby-bot-server/pull/129): Extracted RealTime components into [slack-ruby-bot-server-rtm](https://github.com/slack-ruby/slack-ruby-bot-server-rtm) - [@dblock](https://github.com/dblock).
+
+#### 0.12.3 (2020/11/14)
+
+* [#123](https://github.com/slack-ruby/slack-ruby-bot-server/pull/123): Reactivate a team that was disabled from Slack - [@dblock](https://github.com/dblock).
+* [#127](https://github.com/slack-ruby/slack-ruby-bot-server/pull/127): Added a Rails bot example link - [@CrazyOptimist](https://github.com/CrazyOptimist).
+
+#### 0.12.2 (2020/7/26)
+
+* [#120](https://github.com/slack-ruby/slack-ruby-bot-server/pull/120): Removed GIFs - [@dblock](https://github.com/dblock).
+* [#121](https://github.com/slack-ruby/slack-ruby-bot-server/pull/121): Added TOC - [@dblock](https://github.com/dblock).
+
+#### 0.12.1 (2020/5/16)
+
+* [#118](https://github.com/slack-ruby/slack-ruby-bot-server/pull/118): Do not fail to start on errors in `Team#purge!` - [@dblock](https://github.com/dblock).
+
+#### 0.12.0 (2020/4/26)
+
+* [#113](https://github.com/slack-ruby/slack-ruby-bot-server/pull/113): Added support for intervals with `.every` - [@dblock](https://github.com/dblock).
+* [#112](https://github.com/slack-ruby/slack-ruby-bot-server/pull/112): Added support for multiple `.on` events as an argument - [@dblock](https://github.com/dblock).
+* [#111](https://github.com/slack-ruby/slack-ruby-bot-server/pull/111): Removed dependency on Virtus - [@dblock](https://github.com/dblock).
+* [#110](https://github.com/slack-ruby/slack-ruby-bot-server/pull/110): Fixed ActiveRecord sample app - [@CeeBeeUK](https://github.com/CeeBeeUK).
+* [#114](https://github.com/slack-ruby/slack-ruby-bot-server/pull/114): Used `require_relative` to prevent local collisions - [@dblock](https://github.com/dblock).
+* [#115](https://github.com/slack-ruby/slack-ruby-bot-server/pull/115): Added `Config#view_paths` to be used by Rack middleware - [@dblock](https://github.com/dblock).
+
 #### 0.11.1 (2019/5/17)
 
-* [#104](https://github.com/slack-ruby/slack-ruby-bot-server/pull/104): Lock async-websocket at a compatible 0.8.0 version - [@dblock](https://github.com/dblock).
+* [#104](https://github.com/slack-ruby/slack-ruby-bot-server/pull/104): Locked async-websocket at a compatible 0.8.0 version - [@dblock](https://github.com/dblock).
 
 #### 0.11.0 (2019/4/12)
 
 * [#101](https://github.com/slack-ruby/slack-ruby-bot-server/pull/101): Removed legacy migrations, including `SLACK_API_TOKEN`, team `name`, `team_id` and `active` - [@dblock](https://github.com/dblock).
 * [#98](https://github.com/slack-ruby/slack-ruby-bot-server/pull/98): Removed `unicorn` from gem dependencies - [@dblock](https://github.com/dblock).
-* [#90](https://github.com/slack-ruby/slack-ruby-bot-server/pull/90): Update ActiveRecord sample app to support ENV variables in `postgresql.yml` - [@ashkan18](https://github.com/ashkan18).
+* [#90](https://github.com/slack-ruby/slack-ruby-bot-server/pull/90): Updated ActiveRecord sample app to support ENV variables in `postgresql.yml` - [@ashkan18](https://github.com/ashkan18).
 
 #### 0.10.0 (2019/3/23)
 
 * [#97](https://github.com/slack-ruby/slack-ruby-bot-server/pull/97): Added `Config#service_class` to override the `SlackRubyBotServer::Service.instance` singleton - [@dblock](https://github.com/dblock).
 * [#96](https://github.com/slack-ruby/slack-ruby-bot-server/pull/96): Added `Team#bot_user_id`, `activated_user_id` and `activated_user_access_token` - [@dblock](https://github.com/dblock).
-* [#95](https://github.com/slack-ruby/slack-ruby-bot-server/pull/95): Expose the optional `state` parameter that is returned from the Add to Slack button - [@aok-solutions](https://github.com/aok-solutions).
+* [#95](https://github.com/slack-ruby/slack-ruby-bot-server/pull/95): Exposed the optional `state` parameter that is returned from the Add to Slack button - [@aok-solutions](https://github.com/aok-solutions).
 
 #### 0.9.0 (2019/2/25)
 
@@ -22,31 +49,31 @@
 
 #### 0.8.3 (2019/1/17)
 
-* [#88](https://github.com/slack-ruby/slack-ruby-bot-server/issues/88): Fix: compatibility with Grape 1.2.x - [@dblock](https://github.com/dblock).
+* [#88](https://github.com/slack-ruby/slack-ruby-bot-server/issues/88): Fixed compatibility with Grape 1.2.x - [@dblock](https://github.com/dblock).
 
 #### 0.8.2 (2018/10/11)
 
-* [#80](https://github.com/slack-ruby/slack-ruby-bot-server/pull/80): Fix: closed stream when closing connection in ping worker - [@dblock](https://github.com/dblock).
+* [#80](https://github.com/slack-ruby/slack-ruby-bot-server/pull/80): Fixed closed stream when closing connection in ping worker - [@dblock](https://github.com/dblock).
 
 #### 0.8.1 (2018/9/20)
 
-* [#79](https://github.com/slack-ruby/slack-ruby-bot-server/pull/79): Fix: ping worker terminates on a failed restart - [@dblock](https://github.com/dblock).
+* [#79](https://github.com/slack-ruby/slack-ruby-bot-server/pull/79): Fixed ping worker terminates on a failed restart - [@dblock](https://github.com/dblock).
 
 #### 0.8.0 (2018/9/8)
 
-* [#75](https://github.com/slack-ruby/slack-ruby-bot-server/pull/75): Default to `async-websocket` instead of `celluloid-io` - [@dblock](https://github.com/dblock).
-* [#76](https://github.com/slack-ruby/slack-ruby-bot-server/pull/76): Adjust wait time on restart on Slack::Web::Api::Errors::TooManyRequestsError - [@dblock](https://github.com/dblock).
+* [#75](https://github.com/slack-ruby/slack-ruby-bot-server/pull/75): Defaulted to `async-websocket` instead of `celluloid-io` - [@dblock](https://github.com/dblock).
+* [#76](https://github.com/slack-ruby/slack-ruby-bot-server/pull/76): Adjusted wait time on restart on Slack::Web::Api::Errors::TooManyRequestsError - [@dblock](https://github.com/dblock).
 
 #### 0.7.0 (2018/8/22)
 
-* [#60](https://github.com/slack-ruby/slack-ruby-bot-server/pull/60): Log caught Standard::Error backtrace at debug-level - [@alexagranov](https://github.com/alexagranov).
+* [#60](https://github.com/slack-ruby/slack-ruby-bot-server/pull/60): Logged caught Standard::Error backtrace at debug-level - [@alexagranov](https://github.com/alexagranov).
 * [#65](https://github.com/slack-ruby/slack-ruby-bot-server/pull/65): Updated Capybara and selenium-webdriver - [@dblock](https://github.com/dblock).
 * [#67](https://github.com/slack-ruby/slack-ruby-bot-server/pull/67): Only load the OTR::ActiveRecord::ConnectionManagement middleware when the OTR module is included. This module isn't needed when using Rails - [@darbyfrey](https://github.com/darbyfrey).
 * [#74](https://github.com/slack-ruby/slack-ruby-bot-server/pull/74): Added ping worker, will restart offline bots - [@dblock](https://github.com/dblock).
 
 #### 0.6.1 (2017/3/29)
 
-* [#54](https://github.com/slack-ruby/slack-ruby-bot-server/pull/54): Removing one more Mongoid dependency when rescuing from _invoke - [@alexagranov](https://github.com/alexagranov).
+* [#54](https://github.com/slack-ruby/slack-ruby-bot-server/pull/54): Removed one more Mongoid dependency when rescuing from _invoke - [@alexagranov](https://github.com/alexagranov).
 * [#53](https://github.com/slack-ruby/slack-ruby-bot-server/pull/53): No need for `otr-activerecord` if using activerecord under Rails - [@alexagranov](https://github.com/alexagranov).
 
 #### 0.6.0 (2017/3/12)
@@ -57,17 +84,17 @@
 
 #### 0.5.0 (2017/2/9)
 
-* [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fix: `cannot load kaminari/grape` - [@dblock](https://github.com/dblock).
-* [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fix: `undefined method '[]' for nil:NilClass` in APIs - [@dblock](https://github.com/dblock).
-* [#28](https://github.com/slack-ruby/slack-ruby-bot-server/pull/28): Use slack-ruby-danger gem - [@dblock](https://github.com/dblock).
-* [#31](https://github.com/slack-ruby/slack-ruby-bot-server/pull/31): Adds MONGODB_URI as environment variable for MongoDB - [@corprew](https://github.com/corprew).
+* [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fixed `cannot load kaminari/grape` - [@dblock](https://github.com/dblock).
+* [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fixed `undefined method '[]' for nil:NilClass` in APIs - [@dblock](https://github.com/dblock).
+* [#28](https://github.com/slack-ruby/slack-ruby-bot-server/pull/28): Used `slack-ruby-danger` gem - [@dblock](https://github.com/dblock).
+* [#31](https://github.com/slack-ruby/slack-ruby-bot-server/pull/31): Added `MONGODB_URI` as environment variable for MongoDB - [@corprew](https://github.com/corprew).
 
 #### 0.4.0 (2016/8/29)
 
 * [#25](https://github.com/slack-ruby/slack-ruby-bot-server/pull/25): Added [danger](http://danger.systems), PR linting - [@dblock](https://github.com/dblock).
 * The `reset` and `resetting` callbacks have been removed - [@dblock](https://github.com/dblock).
 * Callbacks receive `team` and `error`, but no longer `server` - [@dblock](https://github.com/dblock).
-* [#23](https://github.com/slack-ruby/slack-ruby-bot-server/issues/23): Fix: server-side removal of bot doesn't deactivate it - [@dblock](https://github.com/dblock).
+* [#23](https://github.com/slack-ruby/slack-ruby-bot-server/issues/23): Fixed server-side removal of bot doesn't deactivate it - [@dblock](https://github.com/dblock).
 
 #### 0.3.1 (2016/7/10)
 
@@ -91,13 +118,13 @@
 
 * Initial public release - [@dblock](https://github.com/dblock).
 * Renamed slack-bot-server to slack-ruby-bot-server - [@dblock](https://github.com/dblock).
-* [#11](https://github.com/slack-ruby/slack-ruby-bot-server/pull/11): Turn project into gem - [@tmsrjs](https://github.com/tmsrjs).
-* Use `celluloid-io` instead of `faye-websocket`, upgrade to slack-ruby-bot 0.8.0 - [@dblock](https://github.com/dblock).
+* [#11](https://github.com/slack-ruby/slack-ruby-bot-server/pull/11): Turned project into gem - [@tmsrjs](https://github.com/tmsrjs).
+* Used `celluloid-io` instead of `faye-websocket`, upgrade to slack-ruby-bot 0.8.0 - [@dblock](https://github.com/dblock).
 * Fixed `SlackRubyBotServer#reset` - [@dblock](https://github.com/dblock).
-* Use Grape 0.15.x - [@dblock](https://github.com/dblock).
+* Used Grape 0.15.x - [@dblock](https://github.com/dblock).
 * Removed OOB GC - [@dblock](https://github.com/dblock).
-* Use Unicorn instead of Puma - [@dblock](https://github.com/dblock).
-* Fix: wait for EventMachine reactor to start - [@dblock](https://github.com/dblock).
-* Use an OOB GC - [@dblock](https://github.com/dblock).
-* Defer start, much faster - [@dblock](https://github.com/dblock).
+* Used Unicorn instead of Puma - [@dblock](https://github.com/dblock).
+* Fixed wait for EventMachine reactor to start - [@dblock](https://github.com/dblock).
+* Used an OOB GC - [@dblock](https://github.com/dblock).
+* Deferred start, much faster - [@dblock](https://github.com/dblock).
 * Backported changes from slack-metabot and slack-shellbot - [@dblock](https://github.com/dblock).

data/DEBUGGING.md

@@ -3,23 +3,3 @@
 ### Locally
 
 You can debug your instance of slack-ruby-bot-server with a built-in `script/console`.
-
-### Silence Mongoid Logger
-
-If Mongoid logging is annoying you.
-
-```ruby
-Mongoid.logger.level = Logger::INFO
-Mongo::Logger.logger.level = Logger::INFO
-```
-
-### Heroku
-
-```
-heroku run script/console --app=...
-
-Running `script/console` attached to terminal... up, run.7593
-
-2.2.1 > Team.count
-=> 3
-```

data/Dangerfile

@@ -1 +1,2 @@
 danger.import_dangerfile(gem: 'slack-ruby-danger')
+toc.check!

data/Gemfile

@@ -11,7 +11,7 @@ when 'activerecord' then
   gem 'otr-activerecord', '~> 1.2.1'
   gem 'cursor_pagination' # rubocop:disable Bundler/OrderedGems
   gem 'pg'
-when nil then
+when nil
   warn "Missing ENV['DATABASE_ADAPTER']."
 else
   warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
@@ -31,12 +31,13 @@ group :development, :test do
   gem 'rack-test'
   gem 'rake'
   gem 'rspec'
-  gem 'rubocop', '0.58.2'
+  gem 'rubocop', '0.81.0'
   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
 end

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 Daniel Doubrovkine & Contributors
+Copyright (c) 2015-2020 Daniel Doubrovkine & Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,31 +7,44 @@ Slack Ruby Bot Server
 
 Build a complete Slack bot service with Slack button integration, in Ruby.
 
-If you are not familiar with Slack bots or Slack API concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html).
-
-A good [open-source demo](https://github.com/dblock/slack-strava) of a service built on top of this library is [Strava integration with Slack](https://slava.playplay.io).
+# Table of Contents
+
+- [What is this?](#what-is-this)
+- [Stable Release](#stable-release)
+- [Make Your Own](#make-your-own)
+- [Storage](#storage)
+- [MongoDB](#mongodb)
+- [ActiveRecord](#activerecord)
+- [Usage](#usage)
+- [API](#api)
+  - [App](#app)
+  - [Service Manager](#service-manager)
+    - [Lifecycle Callbacks](#lifecycle-callbacks)
+    - [Service Timers](#service-timers)
+    - [Extensions](#extensions)
+  - [Service Class](#service-class)
+- [HTML Templates](#html-templates)
+- [Access Tokens](#access-tokens)
+- [Sample Bots Using Slack Ruby Bot Server](#sample-bots-using-slack-ruby-bot-server)
+  - [Slack Bots with Granular Permissions](#slack-bots-with-granular-permissions)
+  - [Legacy Slack Bots](#legacy-slack-bots)
+- [Copyright & License](#copyright--license)
 
 ### What is this?
 
-A library that contains a [Grape](http://github.com/ruby-grape/grape) API serving a [Slack Ruby Bot](https://github.com/slack-ruby/slack-ruby-bot) to multiple teams. This gem combines a web server, a RESTful API and multiple instances of [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot). It integrates with the [Slack Platform API](https://medium.com/slack-developer-blog/launch-platform-114754258b91#.od3y71dyo). 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 Class 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, 0.11.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
-
-### Try Me
-
-A demo version of the [sample app with mongoid](sample_apps/sample_app_mongoid) is running on Heroku at [slack-ruby-bot-server.herokuapp.com](https://slack-ruby-bot-server.herokuapp.com). Use the _Add to Slack_ button. The bot will join your team as _@slackbotserver_.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, v1.0.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
-![](images/slackbutton.gif)
+### Make Your Own
 
-Once a bot is registered, you can invite to a channel with `/invite @slackbotserver` interact with it. DM "hi" to it, or say "@slackbotserver hi".
+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.
 
-![](images/slackbotserver.gif)
+### Storage
 
-### Run Your Own
-
-You can use one of the [sample applications](sample_apps) to bootstrap your project and start adding slack command handlers on top of this code. A database is required to store teams.
+A database is required to store teams.
 
 ### MongoDB
 
@@ -44,8 +57,6 @@ gem 'mongoid-scroll'
 gem 'slack-ruby-bot-server'
 ```
 
-See the [sample app using Mongoid](sample_apps/sample_app_mongoid) for more information.
-
 ### 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.
@@ -58,23 +69,31 @@ gem 'otr-activerecord'
 gem 'cursor_pagination'
 ```
 
-See the [sample app using ActiveRecord](sample_apps/sample_app_activerecord) for more information.
-
 ### Usage
 
-Start with one of the samples above, which contain a couple of custom commands, necessary dependencies and tests, then [create a new application](https://api.slack.com/applications/new) on Slack.
+Start with the [slack-ruby-bot-events-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-sample) sample, which contain a couple of custom commands, necessary dependencies and tests, then [create a new Slack App](https://api.slack.com/applications/new).
 
-![](images/new.png)
+![](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 `http://localhost:9292`.
+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.
 
 Within your application, edit your `.env` file and add `SLACK_CLIENT_ID=...` and `SLACK_CLIENT_SECRET=...` in it.
 
+Configure your app's [OAuth 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']
+end
+```
+
+The "Add to Slack" button uses the standard OAuth code grant flow as described in the [Slack docs](https://api.slack.com/docs/oauth#flow). Once clicked, the user is taken through the authorization process at Slack's site. Upon successful completion, a callback containing a temporary code is sent to the redirect URL you specified. The endpoint at that URL contains code that persists the bot token each time a Slack client is instantiated for the specific team.
+
 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.
 
 ### API
 
-This library implements an app, [SlackRubyBotServer::App](lib/slack-ruby-bot-server/app.rb), a service manager, [SlackRubyBotServer::Service](lib/slack-ruby-bot-server/service.rb) that creates multiple instances of a bot server class, [SlackRubyBotServer::Server](lib/slack-ruby-bot-server/server.rb), one per team.
+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.
 
 #### App
 
@@ -104,11 +123,17 @@ MyApp.instance.prepare!
 
 #### Service Manager
 
+##### Lifecycle Callbacks
+
 You can introduce custom behavior into the service lifecycle via callbacks. This can be useful when new team has been registered via the API or a team has been deactivated from Slack.
 
 ```ruby
 instance = SlackRubyBotServer::Service.instance
 
+instance.on :started, :stopped do |team|
+  # team has been started or stopped
+end
+
 instance.on :created do |team, error, options|
   # a new team has been registered
 end
@@ -138,13 +163,12 @@ The following callbacks are supported. All callbacks receive a `team`, except `e
 | deactivating   | a team is being deactivated                                      |
 | deactivated    | a team has been deactivated                                      |
 
-
 The [Add to Slack button](https://api.slack.com/docs/slack-button) also allows for an optional `state` parameter that will be returned on completion of the request. The `creating` and `created` callbacks include an options hash where this value can be accessed (to check for forgery attacks for instance).
 ```ruby
 auth = OpenSSL::HMAC.hexdigest("SHA256", "key", "data")
 ```
 ```html
-<a href="https://slack.com/oauth/authorize?scope=bot&client_id=<%= ENV['SLACK_CLIENT_ID'] %>&state=#{auth)"> ... </a>
+<a href="https://slack.com/oauth/authorize?scope=<%= SlackRubyBotServer::Config.oauth_scope_s %>&client_id=<%= ENV['SLACK_CLIENT_ID'] %>&state=#{auth)"> ... </a>
 ```
 ```ruby
 instance = SlackRubyBotServer::Service.instance
@@ -153,30 +177,46 @@ instance.on :creating do |team, error, options|
 end
 ```
 
-A number of extensions use service manager callbacks to implement useful functionality.
+##### Service Timers
 
-* [slack-ruby-bot-server-mailchimp](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp): Subscribes new bot users to a Mailchimp mailing list.
+You can introduce custom behavior into the service lifecycle on a timer. For example, check whether a team's trial has expired, or periodically cleanup data.
 
-#### Server Class
-
-You can override the server class to handle additional events, and configure the service to use it.
+Note that unlike callbacks, timers are global for the entire service.
 
 ```ruby
-class MyServer < SlackRubyBotServer::Server
-  on :hello do |client, data|
-    # connected to Slack
-  end
+instance = SlackRubyBotServer::Service.instance
 
-  on :channel_joined do |client, data|
-    # the bot joined a channel in data.channel['id']
+instance.every :hour do
+  Team.each do |team|
+    begin
+      # do something with every team once an hour
+    rescue StandardError
+    end
   end
 end
 
-SlackRubyBotServer.configure do |config|
-  config.server_class = MyServer
+instance.every :minute do
+  # called every minute
+end
+
+instance.every :second do
+  # called every second
+end
+
+instance.every 30 do
+  # called every 30 seconds
 end
 ```
 
+##### Extensions
+
+A number of extensions use service manager callbacks and service timers to implement useful functionality.
+
+* [slack-ruby-bot-server-events](https://github.com/slack-ruby/slack-ruby-bot-server-events): Easily handle Slack slash commands, interactive buttons and events.
+* [slack-ruby-bot-server-mailchimp](https://github.com/slack-ruby/slack-ruby-bot-server-mailchimp): Subscribes new bot users to a Mailchimp mailing list.
+* [slack-ruby-bot-server-stripe](https://github.com/slack-ruby/slack-ruby-bot-server-stripe): Enables paid bots with trial periods and commerce through Stripe.
+* [slack-ruby-bot-server-rtm](https://github.com/slack-ruby/slack-ruby-bot-server-rtm): Create RTM Slack bots.
+
 #### Service Class
 
 You can override the service class to handle additional methods.
@@ -196,28 +236,42 @@ SlackRubyBotServer::Service.instance # MyService
 SlackRubyBotServer::Service.instance.url # https://www.example.com
 ```
 
+### HTML Templates
+
+This library provides a [default HTML template and JS scripts](public) that implement the "Add to Slack" button workflow. Customize your pages by adding a `public` directory in your application and starting with a [index.html.erb](public/index.html.erb) template. The application's `views` and `public` folders are [loaded by default](lib/slack-ruby-bot-server/api/middleware.rb#L32).
+
+You can add to or override template paths as follows.
+
+```ruby
+SlackRubyBotServer.configure do |config|
+  config.view_paths << File.expand_path(File.join(__dir__, 'public'))
+end
+```
+
 ### Access Tokens
 
-By default the implementation of [Team](lib/slack-ruby-bot-server/models/team) stores a `bot_access_token` as `token` that grants a certain amount of privileges to the bot user as described in [Slack OAuth Docs](https://api.slack.com/docs/oauth) along with `activated_user_access_token` that represents the token of the installing user. You may not want a bot user at all, or may require different auth scopes, such as `users.profile:read` to access user profile information via `Slack::Web::Client#users_profile_get`. To change required scopes make the following changes.
+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). 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.
+
+### Sample Bots Using Slack Ruby Bot Server
 
-1) Configure your app to require additional scopes in Slack API under _OAuth_, _Permissions_
-2) Change the _Add to Slack_ buttons to require the additional scope, eg. `https://slack.com/oauth/authorize?scope=bot,users.profile:read&client_id=...`
-3) The access token with the requested scopes will be stored as `activated_user_access_token`.
+#### Slack Bots with Granular Permissions
 
-You can see a sample implementation in [slack-sup#3a497b](https://github.com/dblock/slack-sup/commit/3a497b436d25d3a7738562655cda64b180ae0096).
+* [slack-ruby-bot-server-events-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-sample), a generic sample
+* [slack-rails-bot-starter](https://github.com/CrazyOptimist/slack-rails-bot-starter), an all-in-one Rails starter kit
 
-### Examples Using Slack Ruby Bot Server
+#### Legacy Slack Bots
 
-* [slack-sup](https://github.com/dblock/slack-sup), free service at [sup.playplay.io](https://sup.playplay.io)
-* [slack-gamebot](https://github.com/dblock/slack-gamebot), free service at [www.playplay.io](https://www.playplay.io)
-* [slack-market](https://github.com/dblock/slack-market), free service at [market.playplay.io](https://market.playplay.io)
-* [slack-shellbot](https://github.com/slack-ruby/slack-shellbot), free service at [shell.playplay.io](https://shell.playplay.io)
-* [slack-api-explorer](https://github.com/slack-ruby/slack-api-explorer), free service at [api-explorer.playplay.io](https://shell.playplay.io)
-* [slack-strava](https://github.com/dblock/slack-strava), free service at [slava.playplay.io](https://slava.playplay.io)
-* [slack-arena](https://github.com/dblock/slack-arena), free service at [arena.playplay.io](https://arena.playplay.io)
+* [slack-ruby-bot-server-sample](https://github.com/slack-ruby/slack-ruby-bot-server-sample), a generic sample
+* [slack-sup](https://github.com/dblock/slack-sup), see [sup.playplay.io](https://sup.playplay.io)
+* [slack-gamebot](https://github.com/dblock/slack-gamebot), see [www.playplay.io](https://www.playplay.io)
+* [slack-market](https://github.com/dblock/slack-market), see [market.playplay.io](https://market.playplay.io)
+* [slack-shellbot](https://github.com/slack-ruby/slack-shellbot), see [shell.playplay.io](https://shell.playplay.io)
+* [slack-api-explorer](https://github.com/slack-ruby/slack-api-explorer), see [api-explorer.playplay.io](https://shell.playplay.io)
+* [slack-strava](https://github.com/dblock/slack-strava), see [slava.playplay.io](https://slava.playplay.io)
+* [slack-arena](https://github.com/dblock/slack-arena), see [arena.playplay.io](https://arena.playplay.io)
 
 ### Copyright & License
 
-Copyright [Daniel Doubrovkine](http://code.dblock.org) and Contributors, 2015-2019
+Copyright [Daniel Doubrovkine](http://code.dblock.org) and Contributors, 2015-2020
 
 [MIT License](LICENSE)