slack-ruby-bot-bhe 0.5.5.3

data/RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing Slack-Ruby-Bot
+
+There're no particular rules about when to release slack-ruby-bot. 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) for all supported platforms.
+
+Increment the version, modify [lib/slack-ruby-bot/version.rb](lib/slack-ruby-bot/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.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/slack-ruby-bot/version.rb
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+slack-ruby-bot 0.2.2 built to pkg/slack-ruby-bot-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed slack-ruby-bot 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/version.rb](lib/slack-ruby-bot/version.rb).
+
+Comit your changes.
+
+```
+git add CHANGELOG.md lib/slack-ruby-bot/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+unless ENV['RACK_ENV'] == 'production'
+  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]
+end

data/TUTORIAL.md

@@ -0,0 +1,205 @@
+## Production Bot Tutorial
+
+In this tutorial we'll implement [slack-mathbot](https://github.com/dblock/slack-mathbot).
+
+### Introduction
+
+A typical production Slack bot is a combination of a vanilla web server and a websocket application that talks to the [Slack Real Time Messaging API](https://api.slack.com/rtm). The web server is optional, but most people will run their Slack bots on [Heroku](https://dashboard.heroku.com) in which case a web server is required to prevent Heroku from shutting the bot down. It also makes it convenient to develop a bot and test using `foreman`.
+
+### Getting Started
+
+#### Gemfile
+
+Create a `Gemfile` that uses [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot), [sinatra](https://github.com/sinatra/sinatra) (a web framework) and [puma](https://github.com/puma/puma) (a web server). For development we'll also use [foreman](https://github.com/theforeman/foreman) and write tests with [rspec](https://github.com/rspec/rspec).
+
+```ruby
+source 'http://rubygems.org'
+
+gem 'slack-ruby-bot'
+gem 'puma'
+gem 'sinatra'
+
+group :development, :test do
+  gem 'rake'
+  gem 'foreman'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rack-test'
+end
+```
+
+Run `bundle install` to get all the gems.
+
+#### Application
+
+Create a folder called `slack-mathbot` and inside of it create `app.rb`.
+
+```ruby
+module SlackMathbot
+  class App < SlackRubyBot::App
+  end
+end
+```
+
+#### Commands
+
+Create a folder called `slack-mathbot/commands` and inside of it create `calculate.rb`. For now this calculator will always return 4.
+
+```ruby
+module SlackMathbot
+  module Commands
+    class Calculate < SlackRubyBot::Commands::Base
+      command 'calculate' do |client, data, _match|
+        send_message client, data.channel, '4'
+      end
+    end
+  end
+end
+```
+
+#### Require Everything
+
+Create a `slack-mathbot.rb` at the root and require the above files.
+
+```ruby
+require 'slack-ruby-bot'
+require 'slack-mathbot/commands/calculate'
+require 'slack-mathbot/app'
+```
+
+#### Web Server
+
+We will need to keep the bot alive on Heroku, so create `web.rb`.
+
+```ruby
+require 'sinatra/base'
+
+module SlackMathbot
+  class Web < Sinatra::Base
+    get '/' do
+      'Math is good for you.'
+    end
+  end
+end
+```
+
+#### Config.ru
+
+Tie all the pieces together in `config.ru` which creates a thread for the bot and runs the web server on the main thread.
+
+```ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'slack-mathbot'
+require 'web'
+
+Thread.abort_on_exception = true
+
+Thread.new do
+  begin
+    SlackMathbot::App.instance.run
+  rescue Exception => e
+    STDERR.puts "ERROR: #{e}"
+    STDERR.puts e.backtrace
+    raise e
+  end
+end
+
+run SlackMathbot::Web
+```
+
+### Create a Bot User
+
+In Slack administration create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
+
+![](screenshots/register-bot.png)
+
+On the next screen, note the API token.
+
+#### .env
+
+Create a `.env` file with the API token from above and make sure to add it to `.gitignore`.
+
+```
+SLACK_API_TOKEN=...
+```
+
+### Procfile
+
+Create a `Procfile` which `foreman` will use when you run the `foreman start` command below.
+
+```
+web: bundle exec puma -p $PORT
+```
+
+### Run the Bot
+
+Run `foreman start`. Your bot should be running.
+
+```
+14:32:32 web.1  | Puma starting in single mode...
+14:32:32 web.1  | * Version 2.11.3 (ruby 2.1.6-p336), codename: Intrepid Squirrel
+14:32:32 web.1  | * Min threads: 0, max threads: 16
+14:32:32 web.1  | * Environment: development
+14:32:35 web.1  | * Listening on tcp://0.0.0.0:5000
+14:32:35 web.1  | Use Ctrl-C to stop
+14:32:36 web.1  | I, [2015-07-10T14:32:36.216663 #98948]  INFO -- : Welcome 'mathbot' to the 'xyz' team at https://xyz.slack.com/.
+14:32:36 web.1  | I, [2015-07-10T14:32:36.766955 #98948]  INFO -- : Successfully connected to https://xyz.slack.com/.
+```
+
+### Try
+
+Invite the bot to a channel via `/invite [bot name]` and send it a `calculate` command with `[bot name] calculate 2+2`. It will respond with `4` from the code above.
+
+### Write Tests
+
+#### Spec Helper
+
+Create `spec/spec_helper.rb` that includes the bot files and shared RSpec support from slack-ruby-bot.
+
+```ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+
+require 'slack-ruby-bot/rspec'
+require 'slack-mathbot'
+```
+
+#### Test the Bot Application
+
+Create a test for the bot application itself in `spec/slack-mathbot/app_spec.rb`.
+
+```ruby
+require 'spec_helper'
+
+describe SlackMathbot::App do
+  def app
+    SlackMathbot::App.new
+  end
+  it_behaves_like 'a slack ruby bot'
+end
+```
+
+#### Test a Command
+
+Create a test for the `calculate` command in `spec/slack-mathbot/commands/calculate_spec.rb`. The bot is addressed by its user name.
+
+```ruby
+require 'spec_helper'
+
+describe SlackMathbot::Commands::Calculate do
+  def app
+    SlackMathbot::App.new
+  end
+  it 'returns 4' do
+    expect(message: "#{SlackRubyBot.config.user} calculate 2+2", channel: 'channel').to respond_with_slack_message('4')
+  end
+end
+```
+
+See [lib/slack-ruby-bot/rspec/support/slack-ruby-bot](lib/slack-ruby-bot/rspec/support/slack-ruby-bot) for other shared RSpec behaviors.
+
+### Deploy
+
+See [DEPLOYMENT](DEPLOYMENT.md) for how to deploy your bot to production.

data/UPGRADING.md

@@ -0,0 +1,64 @@
+Upgrading SlackRubyBot
+======================
+
+### Upgrading to >= 0.4.0
+
+This version uses [slack-ruby-client](https://github.com/dblock/slack-ruby-client) instead of [slack-ruby-gem](https://github.com/aki017/slack-ruby-gem).
+
+The command interface now takes a `client` parameter, which is the RealTime Messaging API instance. Add the new parameter to all `call` calls in classes that inherit from `SlackRubyBot::Commands::Base`.
+
+Before:
+
+```ruby
+def self.call(data, match)
+  ...
+end
+```
+
+After:
+
+```ruby
+def self.call(client, data, match)
+  ...
+end
+```
+
+This also applies to `command`, `operator` and `match` blocks.
+
+Before:
+
+```ruby
+command 'ping' do |data, match|
+  ...
+end
+```
+
+After:
+
+```ruby
+command 'ping' do |client, data, match|
+  ...
+end
+```
+
+You can now send messages directly via the RealTime Messaging API.
+
+```ruby
+client.message text: 'text', channel: 'channel'
+```
+
+Otherwise you must now pass the `client` parameter to `send_message` and `send_message_with_gif`.
+
+```ruby
+def self.call(client, data, match)
+  send_message client, data.channel, 'hello'
+end
+```
+
+```ruby
+def self.call(client, data, match)
+  send_message_with_gif client, data.channel, 'hello', 'hi'
+end
+```
+
+

data/examples/minimal/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-bot', path: '../..'

data/examples/minimal/Procfile

@@ -0,0 +1 @@
+console: bundle exec ruby pongbot.rb

data/examples/minimal/pongbot.rb

@@ -0,0 +1,9 @@
+require 'slack-ruby-bot'
+
+class Bot < SlackRubyBot::Bot
+  command 'ping' do |client, data, _match|
+    client.message text: 'pong', channel: data.channel
+  end
+end
+
+Bot.run

data/examples/weather/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-bot', path: '../..'

data/examples/weather/Procfile

@@ -0,0 +1 @@
+console: bundle exec ruby weatherbot.rb

data/examples/weather/weatherbot.rb

@@ -0,0 +1,9 @@
+require 'slack-ruby-bot'
+
+class WeatherBot < SlackRubyBot::Bot
+  match(/^How is the weather in (?<location>\w*)\?$/i) do |client, data, match|
+    send_message client, data.channel, "The weather in #{match[:location]} is nice."
+  end
+end
+
+WeatherBot.run

data/lib/config/application.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'boot'
+
+Bundler.require :default, ENV['RACK_ENV']
+
+Dir[File.expand_path('../../initializers', __FILE__) + '/**/*.rb'].each do |file|
+  require file
+end
+
+require File.expand_path('../application', __FILE__)
+
+require 'slack_ruby_bot'

data/lib/config/boot.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'logger'
+require 'active_support'
+require 'active_support/core_ext'
+require 'hashie'
+require 'slack'
+require 'giphy'

data/lib/config/environment.rb

@@ -0,0 +1,3 @@
+ENV['RACK_ENV'] ||= 'development'
+
+require File.expand_path('../application', __FILE__)

data/lib/initializers/giphy.rb

@@ -0,0 +1,5 @@
+require 'giphy'
+
+Giphy::Configuration.configure do |config|
+  config.api_key = ENV['GIPHY_API_KEY'] || 'dc6zaTOxFJmzC' # from https://github.com/Giphy/GiphyAPI
+end

data/lib/slack-ruby-bot.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../config/environment', __FILE__)
+
+require 'slack-ruby-bot/version'
+require 'slack-ruby-bot/about'
+require 'slack-ruby-bot/config'
+require 'slack-ruby-bot/hooks'
+
+module SlackRubyBot
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end
+
+require 'slack-ruby-client'
+require 'slack-ruby-bot/commands'
+require 'slack-ruby-bot/client'
+require 'slack-ruby-bot/server'
+require 'slack-ruby-bot/app'
+require 'slack-ruby-bot/bot'