slack-ruby-bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 579866b4a7f11a4724bba648eff1b7f47b062b6b
+  data.tar.gz: f14a5617e66ee1b851ec2f9f083f874023fa7b80
+SHA512:
+  metadata.gz: 8571d406cb61c2b7ea7bd66a06cd6eeb7897be28c480e34441fc2530774cd4f053ca6d58b8261c42f3487e8e93a4eaecf3b27bdf7abc7c98b775e8a93450da63
+  data.tar.gz: 12dd65f281d52c45f5af250aad0db8536cb878bd5f26c7e156cd4dbd4403d75371f2eefdd13f1d716107b9c95697e6b6209d30343f4ee3203439d619e71ea110

data/.gitignore

@@ -0,0 +1 @@
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,41 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-07-02 14:33:13 -0400 using RuboCop version 0.32.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/HandleExceptions:
+  Enabled: false
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 18
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 130
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 17
+
+# Offense count: 14
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.1.6
+

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 0.1.0 (6/2/2015)
+
+* Initial public release - [@dblock](https://github.com/dblock).
+

data/CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# Contributing to SlackRubyBot
+
+This project is work of [many contributors](https://github.com/dblock/slack-ruby-bot/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/slack-ruby-bot/pulls), [propose features and discuss issues](https://github.com/dblock/slack-ruby-bot/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) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-bot.git
+cd slack-ruby-bot
+git remote add upstream https://github.com/dblock/slack-ruby-bot.git
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Run SlackRubyBot in Development
+
+Create a private slack group for yourself.
+
+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.
+
+Run `SLACK_API_TOKEN=<your API token> foreman start`.
+
+You can also create a `.env` file with `SLACK_API_TOKEN=<your API token>` and just run `foreman start`.
+
+## 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
+```
+
+## 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 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/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/DEPLOYMENT.md

@@ -0,0 +1,25 @@
+## Installation
+
+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.
+
+### Environment
+
+#### SLACK_API_TOKEN
+
+Set SLACK_API_TOKEN from the Bot integration settings on Slack.
+
+```
+heroku config:add SLACK_API_TOKEN=...
+```
+
+#### GIPHY_API_KEY
+
+The bot replies with animated GIFs. While it's currently not necessary, you may need to set GIPHY_API_KEY in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details.
+
+### Heroku Idling
+
+Heroku free tier applications will idle. Either pay 7$ a month for the hobby dyno or use [UptimeRobot](http://uptimerobot.com) or similar to prevent your instance from sleeping or pay for a production dyno.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    slack-ruby-bot (0.1.0)
+      activesupport
+      giphy (~> 2.0.2)
+      hashie
+      slack-api (~> 1.1.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    eventmachine (1.0.7)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    faraday_middleware-parse_oj (0.3.0)
+      faraday (~> 0.9.0)
+      faraday_middleware (~> 0.9.1)
+      oj (~> 2.0)
+    faye-websocket (0.9.2)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    giphy (2.0.2)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      faraday_middleware-parse_oj (~> 0.3)
+      launchy (~> 2.4)
+    hashie (3.4.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    minitest (5.7.0)
+    multi_json (1.11.1)
+    multipart-post (2.0.0)
+    oj (2.12.9)
+    parser (2.3.0.pre.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    safe_yaml (1.0.4)
+    slack-api (1.1.6)
+      faraday (>= 0.7, < 0.10)
+      faraday_middleware (~> 0.8)
+      faye-websocket (~> 0.9.2)
+      multi_json (~> 1.0, >= 1.0.3)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    websocket-driver (0.5.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test
+  rake
+  rspec
+  rubocop (= 0.32.1)
+  slack-ruby-bot!
+  vcr
+  webmock

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015 Daniel Doubrovkine, Artsy and 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 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,69 @@
+Slack-Ruby-Bot
+==============
+
+[![Build Status](https://travis-ci.org/dblock/slack-ruby-bot.png)](https://travis-ci.org/dblock/slack-ruby-bot)
+
+A generic Slack bot framework written in Ruby. This library does all the heavy lifting so you can focus on implementing slack bot commands.
+
+## Usage
+
+### A Minimal Bot
+
+#### Gemfile
+
+```ruby
+source 'http://rubygems.org'
+
+gem 'slack-ruby-bot'
+```
+
+#### pongbot.rb
+
+```ruby
+require 'slack-ruby-bot'
+
+module PongBot
+  class App < SlackRubyBot::App
+  end
+
+  class Ping < SlackRubyBot::Commands::Base
+    def self.call(data, command, arguments)
+      send_message data.channel, 'pong'
+    end
+  end
+end
+
+PongBot::App.instance.run
+```
+
+After [registering the bot](DEPLOYMENT.md), run with `SLACK_API_KEY=... bundle exec ruby pongbot.rb`.
+
+### More Involved Examples
+
+A Slack bot is commonly a combination of a vanilla web server and a websocket application that talks to the Slack RealTime API. The web server is optional, but most people will run their Slack bots on Heroku in which case a web server is required to prevent Heroku from shutting the bot down. It also makes it convenient to develop and test using `foreman`.
+
+* [slack-mathbot](https://github.com/dblock/slack-mathbot)
+
+### Built-In Commands
+
+#### [bot name]
+
+Shows bot version and links.
+
+#### [bot name] hi
+
+Politely says 'hi' back.
+
+#### [bot name] help
+
+Get help.
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2015, Daniel Doubrovkine, Artsy and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE.md).

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/examples/minimal/Gemfile

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

data/examples/minimal/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: ../..
+  specs:
+    slack-ruby-bot (0.1.0)
+      activesupport
+      giphy (~> 2.0.2)
+      hashie
+      slack-api (~> 1.1.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    eventmachine (1.0.7)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    faraday_middleware-parse_oj (0.3.0)
+      faraday (~> 0.9.0)
+      faraday_middleware (~> 0.9.1)
+      oj (~> 2.0)
+    faye-websocket (0.9.2)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    giphy (2.0.2)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      faraday_middleware-parse_oj (~> 0.3)
+      launchy (~> 2.4)
+    hashie (3.4.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    minitest (5.7.0)
+    multi_json (1.11.1)
+    multipart-post (2.0.0)
+    oj (2.12.9)
+    slack-api (1.1.6)
+      faraday (>= 0.7, < 0.10)
+      faraday_middleware (~> 0.8)
+      faye-websocket (~> 0.9.2)
+      multi_json (~> 1.0, >= 1.0.3)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.5.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  slack-ruby-bot!

data/examples/minimal/pongbot.rb

@@ -0,0 +1,14 @@
+require 'slack-ruby-bot'
+
+module PongBot
+  class App < SlackRubyBot::App
+  end
+
+  class Ping < SlackRubyBot::Commands::Base
+    def self.call(data, _command, _arguments)
+      send_message data.channel, 'pong'
+    end
+  end
+end
+
+PongBot::App.instance.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,3 @@
+Giphy::Configuration.configure do |config|
+  config.api_key = ENV['GIPHY_API_KEY'] || 'dc6zaTOxFJmzC' # from https://github.com/Giphy/GiphyAPI
+end

data/lib/initializers/slack/request.rb

@@ -0,0 +1,13 @@
+module Slack
+  module Request
+    private
+
+    alias_method :_request, :request
+
+    def request(method, path, options)
+      response = _request(method, path, options)
+      fail response['error'] unless response['ok'] if response.is_a?(Hash)
+      response
+    end
+  end
+end

data/lib/slack-ruby-bot/about.rb

@@ -0,0 +1,7 @@
+module SlackRubyBot
+  ABOUT = <<-ABOUT
+    #{SlackRubyBot::VERSION}
+    https://github.com/dblock/slack-ruby-bot
+    https://twitter.com/dblockdotorg
+  ABOUT
+end

data/lib/slack-ruby-bot/app.rb

@@ -0,0 +1,83 @@
+module SlackRubyBot
+  class App
+    cattr_accessor :hooks
+
+    include SlackRubyBot::Hooks::Hello
+    include SlackRubyBot::Hooks::Message
+
+    def initialize
+      SlackRubyBot.configure do |config|
+        config.token = ENV['SLACK_API_TOKEN'] || fail("Missing ENV['SLACK_API_TOKEN'].")
+      end
+      Slack.configure do |config|
+        config.token = SlackRubyBot.config.token
+      end
+    end
+
+    def config
+      SlackRubyBot.config
+    end
+
+    def self.instance
+      @instance ||= SlackRubyBot::App.new
+    end
+
+    def run
+      auth!
+      start!
+    end
+
+    def stop!
+      client.stop
+    end
+
+    private
+
+    def logger
+      @logger ||= begin
+        $stdout.sync = true
+        Logger.new(STDOUT)
+      end
+    end
+
+    def start!
+      loop do
+        client.start
+        @client = nil
+      end
+    end
+
+    def client
+      @client ||= begin
+        client = Slack.realtime
+        hooks.each do |hook|
+          client.on hook do |data|
+            begin
+              send hook, data
+            rescue StandardError => e
+              logger.error e
+              begin
+                Slack.chat_postMessage(channel: data['channel'], text: e.message) if data.key?('channel')
+              rescue
+                # ignore
+              end
+            end
+          end
+        end
+        client
+      end
+    end
+
+    def auth!
+      auth = Slack.auth_test
+      SlackRubyBot.configure do |config|
+        config.url = auth['url']
+        config.team = auth['team']
+        config.user = auth['user']
+        config.team_id = auth['team_id']
+        config.user_id = auth['user_id']
+      end
+      logger.info "Welcome '#{SlackRubyBot.config.user}' to the '#{SlackRubyBot.config.team}' team at #{SlackRubyBot.config.url}."
+    end
+  end
+end