slack-ruby-bot 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3365b0c48f85bc8a707d27d21ff1e955754e5bcf
-  data.tar.gz: ef53963a3d19a9f70ebfee939121e1dbb6c49a93
+  metadata.gz: 27ef75b4d9ac822b0386b61c6cb4f868e50ab886
+  data.tar.gz: 0935126c87fc8d94e6f0040bd5036d4aebbab722
 SHA512:
-  metadata.gz: 4fe517f5e5a0a51cf1c1d5d2355b5fe21e58c6f8f0059bc62e2cccdfb932a0b1e8b6d1b177874920e59f502bbc495c447ab106df130b15a09c6d2ea9bb1a17b4
-  data.tar.gz: 08a92f29fc40b4d64d9fc8898eaf8bdf7c6f527ee0d488ae8be76fcb691567097f1412f8094c6876b4022e4a3259b1d6aa0a9f61536a1ec13ab0b2684f502a17
+  metadata.gz: be49d4c6780e9c79189b9b8912ab11e4ef480c60aacb43a88b51c4dcfb3dbaedf427a20ec377ec9489c7fa93f995ac49c87560d25100fced8e219c26c5e0c02d
+  data.tar.gz: f5b292868182f92738cf452310edcab0ddbcb5ac3e4d2f9b1a331e171f56a6d0cca33c3c875d77d6ea01fd124d08159ebd7b531a66c1d24ebc6ef1a8a8449455

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.4.2 (8/20/2015)
+
+* [#12](https://github.com/dblock/slack-ruby-bot/issues/12): Added support for bot aliases - [@dblock](https://githubcom/dblock).
+
 ### 0.4.1 (7/25/2015)
 
 * Use a real client in `respond_with_slack_message` expectaions - [@dblock](https://githubcom/dblock).
@@ -9,7 +13,7 @@
 
 ### 0.3.1 (7/21/2015)
 
-* [#8](https://github.com/dblock/slack-ruby-bot/issues/8): Fix: `undefined method `strip!' for nil:NilClass` on nil message - [@dblock](https://github.com/dblock).
+* [#8](https://github.com/dblock/slack-ruby-bot/issues/8): Fix: `undefined method 'strip!' for nil:NilClass` on nil message - [@dblock](https://github.com/dblock).
 
 ### 0.3.0 (7/19/2015)
 

data/DEPLOYMENT.md

@@ -20,6 +20,14 @@ heroku config:add SLACK_API_TOKEN=...
 
 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.
 
+#### SLACK_RUBY_BOT_ALIASES
+
+Optional names for this bot.
+
+```
+heroku config:add SLACK_RUBY_BOT_ALIASES=:pong: table-tennis ping-pong
+```
+
 ### 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/README.md

@@ -4,7 +4,7 @@ Slack-Ruby-Bot
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-bot.svg)](http://badge.fury.io/rb/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, without introducing unnecessary requirements or limitations. It's a Slack bot boilerplate.
+A generic Slack bot framework written in Ruby on top of [slack-ruby-client](https://github.com/dblock/slack-ruby-client). This library does all the heavy lifting, such as message parsing, so you can focus on implementing slack bot commands. It also attempts to itroduce the bare minimum number of requirements or any sorts of limitations. It's a Slack bot boilerplate.
 
 ## Usage
 
@@ -37,7 +37,7 @@ end
 PongBot::App.instance.run
 ```
 
-After [registering the bot](DEPLOYMENT.md), run with `SLACK_API_KEY=... bundle exec ruby pongbot.rb`. Have the bot join a channel and send it a ping.
+After [registering the bot](DEPLOYMENT.md), run with `SLACK_API_TOKEN=... bundle exec ruby pongbot.rb`. Have the bot join a channel and send it a ping.
 
 ![](screenshots/demo.gif)
 
@@ -50,6 +50,7 @@ A typical production Slack bot is a combination of a vanilla web server and a we
 The following examples of production-grade bots based on slack-ruby-bot are listed in growing order of complexity.
 
 * [slack-mathbot](https://github.com/dblock/slack-mathbot): Slack integration with math.
+* [slack-google-bot](https://github.com/dblock/slack-google-bot): A Slack bot that searches Google, including CSE.
 * [slack-aws](https://github.com/dblock/slack-aws): Slack integration with Amazon Web Services.
 * [slack-gamebot](https://github.com/dblock/slack-gamebot): A generic game bot for ping-pong, chess, etc.
 
@@ -104,6 +105,24 @@ end
 
 Operator match data includes `match['operator']` and `match['expression']`. The `bot` match always checks against the `SlackRubyBot::Config.user` setting.
 
+### Bot Aliases
+
+A bot will always respond to its name, but you can specify multiple aliases via the `SLACK_RUBY_BOT_ALIASES` environment variable or via an explicit configuration.
+
+```
+SLACK_RUBY_BOT_ALIASES=:pp: table-tennis
+```
+
+```ruby
+SlackRubyBot.configure do |config|
+  config.aliases = [':pong:', 'pongbot']
+end
+```
+
+This is particularly fun with emoji.
+
+![](screenshots/alias.gif)
+
 ### Generic Routing
 
 Commands and operators are generic versions of bot routes. You can respond to just about anything by defining a custom route.
@@ -162,6 +181,6 @@ See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING
 
 ## Copyright and License
 
-Copyright (c) 2015, Daniel Doubrovkine, Artsy and [Contributors](CHANGELOG.md).
+Copyright (c) 2015, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).

data/examples/minimal/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    slack-ruby-bot (0.3.2)
+    slack-ruby-bot (0.4.2)
       activesupport
       giphy (~> 2.0.2)
       hashie
@@ -18,7 +18,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.8)
-    eventmachine (1.0.7)
+    eventmachine (1.0.8)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.9.2)
@@ -40,10 +40,10 @@ GEM
     json (1.8.3)
     launchy (2.4.3)
       addressable (~> 2.3)
-    minitest (5.7.0)
+    minitest (5.8.0)
     multipart-post (2.0.0)
-    oj (2.12.10)
-    slack-ruby-client (0.1.0)
+    oj (2.12.12)
+    slack-ruby-client (0.2.1)
       eventmachine
       faraday
       faraday_middleware
@@ -60,3 +60,6 @@ PLATFORMS
 
 DEPENDENCIES
   slack-ruby-bot!
+
+BUNDLED WITH
+   1.10.6

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

@@ -8,6 +8,7 @@ module SlackRubyBot
     def initialize
       SlackRubyBot.configure do |config|
         config.token = ENV['SLACK_API_TOKEN'] || fail("Missing ENV['SLACK_API_TOKEN'].")
+        config.aliases = ENV['SLACK_RUBY_BOT_ALIASES'].split(' ') if ENV['SLACK_RUBY_BOT_ALIASES']
       end
       Slack.configure do |config|
         config.token = SlackRubyBot.config.token

data/lib/slack-ruby-bot/commands/base.rb

@@ -41,8 +41,8 @@ module SlackRubyBot
 
       def self.command(*values, &block)
         values.each do |value|
-          match Regexp.new("^(?<bot>\\w*)[\\s]+(?<command>#{value})$", Regexp::IGNORECASE), &block
-          match Regexp.new("^(?<bot>\\w*)[\\s]+(?<command>#{value})[\\s]+(?<expression>.*)$", Regexp::IGNORECASE), &block
+          match Regexp.new("^(?<bot>[\\w[:punct:]]*)[\\s]+(?<command>#{value})$", Regexp::IGNORECASE), &block
+          match Regexp.new("^(?<bot>[\\w[:punct:]]*)[\\s]+(?<command>#{value})[\\s]+(?<expression>.*)$", Regexp::IGNORECASE), &block
         end
       end
 
@@ -53,7 +53,7 @@ module SlackRubyBot
         routes.each_pair do |route, method|
           match = route.match(expression)
           next unless match
-          next if match.names.include?('bot') && match['bot'].downcase != SlackRubyBot.config.user
+          next if match.names.include?('bot') && !SlackRubyBot.config.name?(match['bot'])
           called = true
           if method
             method.call(client, data, match)

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

@@ -4,10 +4,18 @@ module SlackRubyBot
 
     attr_accessor :token
     attr_accessor :url
+    attr_accessor :aliases
     attr_accessor :user
     attr_accessor :user_id
     attr_accessor :team
     attr_accessor :team_id
-    attr_accessor :secret
+
+    def names
+      [user, aliases].compact.flatten
+    end
+
+    def name?(name)
+      name && names.include?(name.downcase)
+    end
   end
 end

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/spec/slack-ruby-bot/commands/aliases_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SlackRubyBot do
+  def app
+    SlackRubyBot::App.new
+  end
+  before do
+    ENV['SLACK_RUBY_BOT_ALIASES'] = ':emoji: alias'
+  end
+  after do
+    ENV.delete('SLACK_RUBY_BOT_ALIASES')
+  end
+  it 'responds to emoji' do
+    expect(message: ':emoji: hi').to respond_with_slack_message('Hi <@user>!')
+  end
+  it 'responds to an alias' do
+    expect(message: 'alias hi').to respond_with_slack_message('Hi <@user>!')
+  end
+end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-26 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: giphy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -170,11 +170,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DEPLOYMENT.md
@@ -218,12 +218,14 @@ files:
 - lib/slack-ruby-bot/rspec/support/vcr.rb
 - lib/slack-ruby-bot/version.rb
 - lib/slack_ruby_bot.rb
+- screenshots/aliases.gif
 - screenshots/demo.gif
 - screenshots/register-bot.png
 - screenshots/weather.gif
 - slack-ruby-bot.gemspec
 - spec/slack-ruby-bot/app_spec.rb
 - spec/slack-ruby-bot/commands/about_spec.rb
+- spec/slack-ruby-bot/commands/aliases_spec.rb
 - spec/slack-ruby-bot/commands/commands_precedence_spec.rb
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb
 - spec/slack-ruby-bot/commands/commands_spec.rb
@@ -249,23 +251,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: The easiest way to write a Slack bot in Ruby.
 test_files:
 - spec/slack-ruby-bot/app_spec.rb
 - spec/slack-ruby-bot/commands/about_spec.rb
+- spec/slack-ruby-bot/commands/aliases_spec.rb
 - spec/slack-ruby-bot/commands/commands_precedence_spec.rb
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb
 - spec/slack-ruby-bot/commands/commands_spec.rb