slack-ruby-bot-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52146ba5ac001bb30aab89a2b3d954f9618dabf4
+  data.tar.gz: de8a3515657c2c89f04e72752562020da77073c2
+SHA512:
+  metadata.gz: 893a31c1826f733d2e8f02ed26d6b48ada8c71919b98778cc3b2c89502be774039014469307fb5e88539e53108f50b641cf00cd7ed910adc171522305486e347
+  data.tar.gz: d9df13508a1b9b1e18b1eb55cee4f0338eeda5a13b0a0b5048245681537a368a09329ab1a35c4ca7bf3fb1aae0c3bef7ac8fe52d5724937e08627fc7b000b227

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+.rvmrc
+.irbrc
+.bundle
+log
+.env
+*.swp
+Gemfile.lock
+.ruby-version
+pkg

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,45 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-06-01 15:51:05 -0400 using RuboCop version 0.35.1.
+# 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: 1
+Lint/RescueException:
+  Exclude:
+    - 'lib/slack-ruby-bot-server/app.rb'
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 32
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 67
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 163
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 25
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Exclude:
+    - 'lib/slack-ruby-bot-server.rb'

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 2.2.4
+language: ruby
+cache: bundler
+services:
+  - mongodb
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+### Changelog
+
+#### 0.1.0 (1/6/2016)
+
+* Initial public release - [@dblock](https://github.com/dblock).
+* 2016/6/1: Renamed slack-bot-server to slack-ruby-bot-server - [@dblock](https://github.com/dblock).
+* 2016/5/30: [#11](https://github.com/dblock/slack-ruby-bot-server/pull/11) Turn project into gem - [@tmsrjs](https://github.com/tmsrjs).
+* 2016/5/5: Use `celluloid-io` instead of `faye-websocket`, upgrade to slack-ruby-bot 0.8.0 - [@dblock](https://github.com/dblock).
+* 2016/4/18: Fixed `SlackRubyBotServer#reset` - [@dblock](https://github.com/dblock).
+* 2016/4/18: Use Grape 0.15.x - [@dblock](https://github.com/dblock).
+* 2016/4/18: Removed OOB GC - [@dblock](https://github.com/dblock).
+* 2016/2/11: Use Unicorn instead of Puma - [@dblock](https://github.com/dblock).
+* 2016/2/11: Fix: wait for EventMachine reactor to start - [@dblock](https://github.com/dblock).
+* 2016/2/11: Use an OOB GC - [@dblock](https://github.com/dblock).
+* 2016/2/9: Defer start, much faster - [@dblock](https://github.com/dblock).
+* 2016/1/10: Backported changes from slack-metabot and slack-shellbot - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to SlackRubyBotServer
+
+This project is work of [many contributors](https://github.com/dblock/slack-ruby-bot-server/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/slack-ruby-bot-server/pulls), [propose features and discuss issues](https://github.com/dblock/slack-ruby-bot-server/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+## Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/slack-ruby-bot-server) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-bot-server.git
+cd slack-ruby-bot-server
+git remote add upstream https://github.com/dblock/slack-ruby-bot-server.git
+```
+
+## Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
+Add to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+## Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
+Run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+## Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+## Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
+Make it look like every other line, including your name and link to your Github account.
+
+## Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+## Push
+
+```
+git push origin my-feature-branch
+```
+
+## Make a Pull Request
+
+Go to https://github.com/contributor/slack-ruby-bot-server and select your feature branch.
+Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+## Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+## Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/slack-ruby-bot-server/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+## Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+## Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/DEBUGGING.md

@@ -0,0 +1,25 @@
+## Debugging
+
+### 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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'rack' do
+  watch('Gemfile.lock')
+  watch(%r{^(config|app|api)/.*})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Daniel Doubrovkine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+Slack Ruby Bot Server
+=====================
+
+[![Build Status](https://travis-ci.org/dblock/slack-ruby-bot-server.svg?branch=master)](https://travis-ci.org/dblock/slack-ruby-bot-server)
+[![Code Climate](https://codeclimate.com/github/dblock/slack-ruby-bot-server.svg)](https://codeclimate.com/github/dblock/slack-ruby-bot-server)
+
+An opinionated boilerplate and demo for 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 demo of a service built on top of this is [playplay.io](http://playplay.io).
+
+### Try Me
+
+A demo version of this app 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_.
+
+![](images/slackbutton.gif)
+
+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".
+
+![](images/slackbotserver.gif)
+
+### What is this?
+
+A [Grape](http://github.com/ruby-grape/grape) API serving a [Slack Ruby Bot](https://github.com/dblock/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/dblock/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.
+
+### Run Your Own
+
+You can use the [sample application](sample_app) to bootstrap your project and start adding slack command handlers on top of this code.
+
+Install [MongoDB](https://www.mongodb.org/downloads), required to store teams.
+
+[Create a New Application](https://api.slack.com/applications/new) on Slack.
+
+![](images/new.png)
+
+Follow the instructions, note the app's client ID and secret, give the bot a default name, etc. The redirect URL should be the location of your app, for testing purposes use `http://localhost:9292`. Edit your `.env` file and add `SLACK_CLIENT_ID=...` and `SLACK_CLIENT_SECRET=...` in it. Run `bundle install` and `foreman start`. Navigate to [localhost:9292](http://localhost:9292). Register using the Slack button.
+
+If you deploy to Heroku set `SLACK_CLIENT_ID` and `SLACK_CLIENT_SECRET` via `heroku config:add SLACK_CLIENT_ID=... SLACK_CLIENT_SECRET=...`.
+
+### Examples Using Slack Ruby Bot Server
+
+* [slack-gamebot](https://github.com/dblock/slack-gamebot), free service at [playplay.io](http://playplay.io)
+* [slack-shellbot](https://github.com/dblock/slack-shellbot), free service at [shell.playplay.io](http://shell.playplay.io)
+* [api-explorer](https://github.com/dblock/slack-api-explorer), free service at [api-explorer.playplay.io](http://api-explorer.playplay.io)
+* [slack-market](https://github.com/dblock/slack-market), free service at [market.playplay.io](http://market.playplay.io)
+
+### Copyright & License
+
+Copyright [Daniel Doubrovkine](http://code.dblock.org), 2015-2016
+
+[MIT License](LICENSE)

data/RELEASING.md

@@ -0,0 +1,69 @@
+# Releasing Slack-Ruby-Bot-Server
+
+There're no hard rules about when to release slack-ruby-bot-server. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/slack-ruby-bot-server) for all supported platforms.
+
+Increment the version, modify [lib/slack-ruby-bot-server/version.rb](lib/slack-ruby-bot-server/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.2.1` to `0.2.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.2.2 (7/10/2015)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Remove the "Stable Release" section in README that warns users that they are reading the documentation for an unreleased version.
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md lib/slack-ruby-bot-server/version.rb
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+slack-ruby-bot-server 0.2.2 built to pkg/slack-ruby-bot-server-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed slack-ruby-bot-server 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/slack-ruby-bot-server/version.rb](lib/slack-ruby-bot-server/version.rb).
+
+Comit your changes.
+
+```
+git add CHANGELOG.md lib/slack-ruby-bot-server/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]
+
+import 'tasks/db.rake'

data/app.json

@@ -0,0 +1,9 @@
+{
+	"name": "Slack Bot Server",
+	"description": "A Slack bot server.",
+	"respository": "https://github.com/dblock/slack-ruby-bot-server",
+	"keywords": ["slack", "bots"],
+	"addons": [
+		"mongolab"
+	]
+}

data/config/initializers/bson/object_id.rb

@@ -0,0 +1,12 @@
+# see https://groups.google.com/forum/#!msg/mongoid/MaXFVw7D_4s/T3sl6Flg428J
+module BSON
+  class ObjectId
+    def as_json(_options = {})
+      to_s
+    end
+
+    def to_bson_key(encoded = ''.force_encoding(BINARY))
+      to_s.to_bson_key(encoded)
+    end
+  end
+end