README.md in slack-ruby-bot-server-1.0.0 vs README.md in slack-ruby-bot-server-1.1.0
- old
+ new
@@ -5,61 +5,65 @@
[](https://travis-ci.org/slack-ruby/slack-ruby-bot-server)
[](https://codeclimate.com/github/slack-ruby/slack-ruby-bot-server)
Build a complete Slack bot service with Slack button integration, in Ruby.
-# Table of Contents
+## 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)
+ - [Storage](#storage)
+ - [MongoDB](#mongodb)
+ - [ActiveRecord](#activerecord)
+ - [OAuth Version and Scopes](#oauth-version-and-scopes)
+ - [Slack App](#slack-app)
+ - [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?
+## 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.
-### Stable Release
+## Stable Release
-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.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
-### Make Your Own
+## Make Your Own
-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 a [slack-ruby-bot-events-sample](https://github.com/slack-ruby/slack-ruby-bot-server-events-sample) app to bootstrap your project.
+## Usage
+
### Storage
A database is required to store teams.
-### MongoDB
+#### MongoDB
Use MongoDB with [Mongoid](https://github.com/mongodb/mongoid) as ODM. Configure the database connection in `mongoid.yml`. Add the `mongoid` gem in your Gemfile.
```
gem 'mongoid'
gem 'kaminari-mongoid'
gem 'mongoid-scroll'
gem 'slack-ruby-bot-server'
```
-### ActiveRecord
+#### 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.
```
gem 'pg'
@@ -67,32 +71,50 @@
gem 'slack-ruby-bot-server'
gem 'otr-activerecord'
gem 'cursor_pagination'
```
-### Usage
+### OAuth Version and Scopes
-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).
+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_version = :v2
+ config.oauth_scope = ['channels:read', 'chat:write']
+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.
+
+### Slack App
+
+Create a new Slack App [here](https://api.slack.com/applications/new).
+
-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.
-Configure your app's [OAuth scopes](https://api.slack.com/legacy/oauth-scopes) as needed by your application.
+Run `bundle install` and `foreman start` to boot the app.
-```ruby
-SlackRubyBotServer.configure do |config|
- config.oauth_scope = ['channels:read', 'chat:write:user']
-end
```
+$ foreman start
+07:44:47 web.1 | started with pid 59258
+07:44:50 web.1 | * Listening on tcp://0.0.0.0:5000
+```
-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.
+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.
-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.
+```
+$ 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
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
@@ -166,11 +188,11 @@
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=<%= 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
instance.on :creating do |team, error, options|
raise "Unauthorized response" unless options[:state] == auth
@@ -250,28 +272,28 @@
### 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). 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
+## Sample Bots Using Slack Ruby Bot Server
-#### Slack Bots with Granular Permissions
+### Slack Bots with Granular Permissions
* [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
-#### Legacy Slack Bots
+### Legacy Slack Bots
* [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 & License
Copyright [Daniel Doubrovkine](http://code.dblock.org) and Contributors, 2015-2020
[MIT License](LICENSE)