slack-ruby-bot 0.1.0 → 0.2.0

checksums.yaml

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

data/.gitignore

@@ -1 +1,3 @@
 .env
+pkg
+Gemfile.lock

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-07-02 14:33:13 -0400 using RuboCop version 0.32.1.
+# on 2015-07-10 08:49:06 -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
@@ -9,25 +9,21 @@
 Lint/HandleExceptions:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 1
 Metrics/AbcSize:
   Max: 21
 
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 7
-
-# Offense count: 18
+# Offense count: 24
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 130
+  Max: 142
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 17
 
-# Offense count: 14
+# Offense count: 15
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.2.0 (7/10/2015)
+
+* Sending `send_message` with nil or empty text will yield `Nothing to see here.` with a GIF instead of `no_text` - [@dblock](https://github.com/dblock).
+* Added support for operators with `operator [name]` - [@dblock](https://github.com/dblock).
+* Added support for custom commands with `command [name]` - [@dblock](https://github.com/dblock).
+
 ### 0.1.0 (6/2/2015)
 
 * Initial public release - [@dblock](https://github.com/dblock).

data/README.md

@@ -1,9 +1,10 @@
 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.
+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.
 
 ## Usage
 
@@ -36,19 +37,47 @@ end
 PongBot::App.instance.run
 ```
 
-After [registering the bot](DEPLOYMENT.md), run with `SLACK_API_KEY=... bundle exec ruby pongbot.rb`.
+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.
+
+![](screenshots/demo.gif)
+
+### A Production Bot
+
+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. See our [Writing a Production Bot](TUTORIAL.md) tutorial for more information.
 
 ### 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`.
+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-gamebot](https://github.com/dblock/slack-gamebot): A generic game bot for ping-pong, chess, etc.
 
-* [slack-mathbot](https://github.com/dblock/slack-mathbot)
+### Commands and Operators
+
+Bots are addressed by name and respond to commands and operators. By default a command class responds, case-insensitively, to its name. A class called `Phone` that inherits from `SlackRubyBot::Commands::Base` responds to `phone` and `Phone`. To respond to custom commands and to disable automatic class name matching, use the `command` keyword. The following command responds to `call` and `呼び出し` (call in Japanese).
+
+```ruby
+class Phone < SlackRubyBot::Commands::Base
+  command 'call'
+  command '呼び出し'
+end
+```
+
+Operators are 1-letter long and are similar to commands. They don't require addressing a bot nor separating an operator from its arguments. The following class responds to `=2+2`.
+
+```ruby
+class Calculator < SlackRubyBot::Commands::Base
+  operator '='
+end
+```
 
 ### Built-In Commands
 
+Slack-ruby-bot comes with several built-in commands. You can re-define built-in commands, normally, as described above.
+
 #### [bot name]
 
-Shows bot version and links.
+This is also known as the `default` command. Shows bot version and links.
 
 #### [bot name] hi
 

data/TUTORIAL.md

@@ -0,0 +1,148 @@
+## 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
+      def self.call(data, command, arguments)
+        send_message 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 togehter 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.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=...
+```
+
+### 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/.
+```
+
+### Test
+
+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.
+
+### Deploy
+
+See [DEPLOYMENT](DEPLOYMENT.md) for how to deploy your bot to production.

data/examples/minimal/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    slack-ruby-bot (0.1.0)
+    slack-ruby-bot (0.2.0)
       activesupport
       giphy (~> 2.0.2)
       hashie

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

@@ -79,5 +79,15 @@ module SlackRubyBot
       end
       logger.info "Welcome '#{SlackRubyBot.config.user}' to the '#{SlackRubyBot.config.team}' team at #{SlackRubyBot.config.url}."
     end
+
+    def reset!
+      SlackRubyBot.configure do |config|
+        config.url = nil
+        config.team = nil
+        config.user = nil
+        config.team_id = nil
+        config.user_id = nil
+      end
+    end
   end
 end

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

@@ -1,6 +1,9 @@
 module SlackRubyBot
   module Commands
     class Default < Base
+      command 'default'
+      command 'about'
+
       def self.call(data, _command, _arguments)
         send_message_with_gif data.channel, SlackRubyBot::ABOUT, 'selfie'
       end

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

@@ -1,8 +1,15 @@
 module SlackRubyBot
   module Commands
     class Base
+      class_attribute :operators
+      class_attribute :commands
+
       def self.send_message(channel, text)
-        Slack.chat_postMessage(channel: channel, text: text)
+        if text && text.length > 0
+          Slack.chat_postMessage(channel: channel, text: text)
+        else
+          send_message_with_gif channel, 'Nothing to see here.', 'nothing'
+        end
       end
 
       def self.send_message_with_gif(channel, text, keywords)
@@ -22,6 +29,28 @@ module SlackRubyBot
           Logger.new(STDOUT)
         end
       end
+
+      def self.responds_to_command?(command)
+        commands ? commands.include?(command) : command == default_command_name
+      end
+
+      def self.default_command_name
+        name && name.split(':').last.downcase
+      end
+
+      def self.responds_to_operator?(operator)
+        operators && operators.include?(operator)
+      end
+
+      def self.operator(value)
+        self.operators ||= []
+        self.operators << value.to_s
+      end
+
+      def self.command(value)
+        self.commands ||= []
+        self.commands << value.to_s
+      end
     end
   end
 end

data/lib/slack-ruby-bot/hooks/message.rb

@@ -5,36 +5,118 @@ module SlackRubyBot
 
       def message(data)
         data = Hashie::Mash.new(data)
-        bot_name, command, arguments = parse_command(data.text)
-        return unless bot_name == SlackRubyBot.config.user
-        klass = command_to_class(command || 'Default')
-        klass.call data, command, arguments
+        klass, command, arguments = text_to_class(data.text)
+        return unless klass
+        klass.call(data, command, arguments)
       end
 
       private
 
+      #
+      # Lookup a class that can execute a command or an operator.
+      #
+      # @param [String] text Free-formed text from Slack.
+      #
+      # @return [SlackRubyBot::Commands::Base] A child class of SlackRubyBot::Commands::Base.
+      #
+      def text_to_class(text)
+        return unless text
+        command, arguments = parse_command(text)
+        if command
+          [command_to_class(command) || SlackRubyBot::Commands::Unknown, command, arguments]
+        else
+          command, arguments = parse_operator(text)
+          [operator_to_class(command), command, arguments]
+        end
+      end
+
+      #
+      # Split text into a command and its arguments.
+      #
+      # @param [String] text Free-formed text from Slack, eg. `bot do something`.
+      #
+      # @return [Array] An array of command and arguments or nil.
+      #
       def parse_command(text)
         return unless text
-        text = '= ' + text[1..text.length] if text[0] == '='
         parts = text.split.reject(&:blank?)
-        if parts && parts[0] == '='
-          parts[0] = SlackRubyBot.config.user
-          parts.insert 1, 'calculate'
+        return unless parts && parts.any?
+        # command is [bot] <command> (argument1, ...)
+        bot_or_operator = parts.first.downcase
+        return unless SlackRubyBot.config.user == bot_or_operator
+        command = parts[1].try(:downcase) || 'default'
+        arguments = parts[2..parts.length]
+        [command, arguments]
+      end
+
+      #
+      # Split text into an operator and its arguments.
+      #
+      # @param [String] text Free-formed text from Slack, eg. =2+2.
+      #
+      # @return [Array] An array and arguments or nil.
+      #
+      def parse_operator(text)
+        return unless text && text.length > 0
+        [text[0], text[1..text.length].split.reject(&:blank?)]
+      end
+
+      #
+      # All commands.
+      #
+      # @return [Array] Descendants of SlackRubyBot::Commands::Base.
+      #
+      def command_classes
+        SlackRubyBot::Commands::Base.descendants
+      end
+
+      #
+      # All non-built-in, ie. custom commands.
+      #
+      # @return [Array] Non-built-in descendants of SlackRubyBot::Commands::Base.
+      #
+      def child_command_classes
+        command_classes.reject do |k|
+          k.name && k.name.starts_with?('SlackRubyBot::Commands::')
         end
-        [parts.first.downcase, parts[1].try(:downcase), parts[2..parts.length]] if parts && parts.any?
       end
 
-      def command_classes(include_slack_ruby_bot = false)
-        klasses = SlackRubyBot::Commands::Base.descendants
-        klasses.reject! { |k| k.name.starts_with? 'SlackRubyBot::Commands::' } unless include_slack_ruby_bot
-        klasses
+      #
+      # All built-in commands.
+      #
+      # @return [Array] Built-in descendants of SlackRubyBot::Commands::Base.
+      #
+      def built_in_command_classes
+        command_classes.select do |k|
+          k.name && k.name.starts_with?('SlackRubyBot::Commands::')
+        end
       end
 
+      #
+      # Converts a command to a class.
+      #
+      # @param [String] command Command tet.
+      #
+      # @return [SlackRubyBot::Commands::Base] A command implementation.
+      #
       def command_to_class(command)
         # prioritize implementations to built-in classes
-        klass = command_classes.detect { |d| d.name.ends_with? "::#{command.titleize}" }
-        klass ||= command_classes(true).detect { |d| d.name.ends_with? "::#{command.titleize}" }
-        klass || SlackRubyBot::Commands::Unknown
+        klass = child_command_classes.detect { |d| d.responds_to_command?(command) }
+        klass ||= built_in_command_classes.detect { |d| d.responds_to_command?(command) }
+        klass
+      end
+
+      #
+      # Converts an operator to a class.
+      #
+      # @param [String] operator Operator text.
+      #
+      # @return [<type>] An operator implementation.
+      #
+      def operator_to_class(operator)
+        command_classes.detect do |k|
+          k.responds_to_operator?(operator)
+        end
       end
     end
   end

data/lib/slack-ruby-bot/rspec/support/fixtures/slack/auth_test.yml

@@ -52,52 +52,6 @@ http_interactions:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"ok":true,"url":"https:\/\/rubybot.slack.com\/","team":"team","user":"user","team_id":"TDEADBEEF","user_id":"UBAADFOOD"}'
+      string: '{"ok":true,"url":"https:\/\/rubybot.slack.com\/","team":"team_name","user":"user_name","team_id":"TDEADBEEF","user_id":"UBAADFOOD"}'
     http_version:
   recorded_at: Tue, 28 Apr 2015 12:55:22 GMT
-- request:
-    method: post
-    uri: https://slack.com/api/rtm.start
-    body:
-      encoding: UTF-8
-      string: token=token
-    headers:
-      Accept:
-      - application/json; charset=utf-8
-      User-Agent:
-      - Slack Ruby Gem 1.1.1
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Origin:
-      - '*'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Tue, 28 Apr 2015 21:41:33 GMT
-      Server:
-      - Apache
-      Strict-Transport-Security:
-      - max-age=31536000; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      X-Content-Type-Options:
-      - nosniff
-      X-Xss-Protection:
-      - '0'
-      Content-Length:
-      - '55'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: '{"ok":false,"error":"invalid_auth"}'
-    http_version:
-  recorded_at: Tue, 28 Apr 2015 21:41:33 GMT
-recorded_with: VCR 2.9.3

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb

@@ -15,10 +15,13 @@ shared_examples 'a slack ruby bot' do
       before do
         subject.send(:auth!)
       end
+      after do
+        subject.send(:reset!)
+      end
       it 'succeeds auth' do
         expect(subject.config.url).to eq 'https://rubybot.slack.com/'
-        expect(subject.config.team).to eq 'team'
-        expect(subject.config.user).to eq 'user'
+        expect(subject.config.team).to eq 'team_name'
+        expect(subject.config.user).to eq 'user_name'
         expect(subject.config.team_id).to eq 'TDEADBEEF'
         expect(subject.config.user_id).to eq 'UBAADFOOD'
       end

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb

@@ -4,7 +4,6 @@ RSpec::Matchers.define :respond_with_error do |expected|
   match do |actual|
     channel, user, message = parse(actual)
     app = SlackRubyBot::App.new
-    SlackRubyBot.config.user = 'rubybot'
     allow(Giphy).to receive(:random)
     begin
       expect do

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb

@@ -3,7 +3,6 @@ require 'rspec/expectations'
 RSpec::Matchers.define :respond_with_slack_message do |expected|
   match do |actual|
     channel, user, message = parse(actual)
-    SlackRubyBot.config.user ||= 'rubybot'
     allow(Giphy).to receive(:random)
     expect(SlackRubyBot::Commands::Base).to receive(:send_message).with(channel, expected)
     app.send(:message, text: message, channel: channel, user: user)

data/lib/slack-ruby-bot/rspec/support/slack_ruby_bot_configure.rb

@@ -1,4 +1,8 @@
-SlackRubyBot.configure do |config|
-  config.token = 'testtoken'
-  config.user = 'rubybot'
+RSpec.configure do |config|
+  config.before :each do
+    SlackRubyBot.configure do |c|
+      c.token = 'testtoken'
+      c.user = 'rubybot'
+    end
+  end
 end

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/slack-ruby-bot.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'slack-api', '~> 1.1.6'
   s.add_dependency 'activesupport'
   s.add_dependency 'giphy', '~> 2.0.2'
+  s.add_dependency 'websocket-driver', '~> 0.5.4'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rack-test'

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

@@ -4,13 +4,10 @@ describe SlackRubyBot::Commands::Default do
   def app
     SlackRubyBot::App.new
   end
-  before do
-    app.config.user = 'rubybot'
+  it 'lowercase' do
+    expect(message: SlackRubyBot.config.user).to respond_with_slack_message(SlackRubyBot::ABOUT)
   end
-  it 'rubybot' do
-    expect(message: 'rubybot').to respond_with_slack_message(SlackRubyBot::ABOUT)
-  end
-  it 'Rubybot' do
-    expect(message: 'Rubybot').to respond_with_slack_message(SlackRubyBot::ABOUT)
+  it 'upcase' do
+    expect(message: SlackRubyBot.config.user.upcase).to respond_with_slack_message(SlackRubyBot::ABOUT)
   end
 end

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'sayhi'
+      command 'saybye'
+
+      def self.call(data, command, arguments)
+        send_message data.channel, "#{command}: #{arguments}"
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'supports multiple commands' do
+    expect(message: "#{SlackRubyBot.config.user} sayhi arg1 arg2").to respond_with_slack_message('sayhi: ["arg1", "arg2"]')
+    expect(message: "#{SlackRubyBot.config.user} saybye arg1 arg2").to respond_with_slack_message('saybye: ["arg1", "arg2"]')
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'test'
+
+      def self.call(data, _command, _arguments)
+        send_message data.channel, nil
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'sends default text' do
+    allow(Giphy).to receive(:random)
+    expect(SlackRubyBot::Commands::Base).to receive(:send_message_with_gif).with('channel', 'Nothing to see here.', 'nothing')
+    app.send(:message, text: "#{SlackRubyBot.config.user} test", channel: 'channel', user: 'user')
+  end
+end

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

@@ -4,10 +4,7 @@ describe SlackRubyBot::Commands::Help do
   def app
     SlackRubyBot::App.new
   end
-  before do
-    app.config.user = 'rubybot'
-  end
   it 'help' do
-    expect(message: 'rubybot help').to respond_with_slack_message('See https://github.com/dblock/slack-ruby-bot, please.')
+    expect(message: "#{SlackRubyBot.config.user} help").to respond_with_slack_message('See https://github.com/dblock/slack-ruby-bot, please.')
   end
 end

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

@@ -4,10 +4,7 @@ describe SlackRubyBot::Commands::Hi do
   def app
     SlackRubyBot::App.new
   end
-  before do
-    app.config.user = 'rubybot'
-  end
   it 'says hi' do
-    expect(message: 'rubybot hi').to respond_with_slack_message('Hi <@user>!')
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message('Hi <@user>!')
   end
 end

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

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      operator '='
+      operator '-'
+
+      def self.call(data, command, arguments)
+        send_message data.channel, "#{command}: #{arguments}"
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'supports operators' do
+    expect(message: '=2+2').to respond_with_slack_message('=: ["2+2"]')
+  end
+end

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

@@ -1,14 +1,11 @@
 require 'spec_helper'
 
-describe SlackRubyBot::Commands::Unknown, vcr: { cassette_name: 'user_info' } do
+describe SlackRubyBot::Commands::Unknown do
   def app
     SlackRubyBot::App.new
   end
-  before do
-    app.config.user = 'rubybot'
-  end
   it 'invalid command' do
-    expect(message: 'rubybot foobar').to respond_with_slack_message("Sorry <@user>, I don't understand that command!")
+    expect(message: "#{SlackRubyBot.config.user} foobar").to respond_with_slack_message("Sorry <@user>, I don't understand that command!")
   end
   it 'does not respond to sad face' do
     expect(SlackRubyBot::Commands::Base).to_not receive(:send_message)

data/spec/slack-ruby-bot/rspec/respond_with_error_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe RSpec do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'raise'
+
+      def self.call(_data, command, _arguments)
+        fail ArgumentError, command
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'respond_with_error' do
+    expect(message: "#{SlackRubyBot.config.user} raise").to respond_with_error('raise')
+  end
+end

metadata

@@ -1,139 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-10 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-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.6
 - !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
@@ -156,19 +170,19 @@ 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
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
+- TUTORIAL.md
 - examples/minimal/Gemfile
 - examples/minimal/Gemfile.lock
 - examples/minimal/pongbot.rb
@@ -187,13 +201,11 @@ files:
 - lib/slack-ruby-bot/commands/hi.rb
 - lib/slack-ruby-bot/commands/unknown.rb
 - lib/slack-ruby-bot/config.rb
-- lib/slack-ruby-bot/fixtures/slack/auth_test.yml
 - lib/slack-ruby-bot/hooks.rb
 - lib/slack-ruby-bot/hooks/base.rb
 - lib/slack-ruby-bot/hooks/hello.rb
 - lib/slack-ruby-bot/hooks/message.rb
 - lib/slack-ruby-bot/rspec.rb
-- lib/slack-ruby-bot/rspec/fixtures/slack/auth_test.yml
 - lib/slack-ruby-bot/rspec/support/fixtures/slack/auth_test.yml
 - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb
 - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb
@@ -203,13 +215,18 @@ files:
 - lib/slack-ruby-bot/rspec/support/vcr.rb
 - lib/slack-ruby-bot/version.rb
 - lib/slack_ruby_bot.rb
+- screenshots/demo.gif
 - screenshots/register-bot.png
 - slack-ruby-bot.gemspec
 - spec/slack-ruby-bot/app_spec.rb
 - spec/slack-ruby-bot/commands/about_spec.rb
+- spec/slack-ruby-bot/commands/commands_spec.rb
+- spec/slack-ruby-bot/commands/empty_text_spec.rb
 - spec/slack-ruby-bot/commands/help_spec.rb
 - spec/slack-ruby-bot/commands/hi_spec.rb
+- spec/slack-ruby-bot/commands/operators_spec.rb
 - spec/slack-ruby-bot/commands/unknown_spec.rb
+- spec/slack-ruby-bot/rspec/respond_with_error_spec.rb
 - spec/slack-ruby-bot/version_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/dblock/slack-ruby-bot
@@ -222,25 +239,29 @@ 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: Generic bot framework written in Ruby.
 test_files:
 - spec/slack-ruby-bot/app_spec.rb
 - spec/slack-ruby-bot/commands/about_spec.rb
+- spec/slack-ruby-bot/commands/commands_spec.rb
+- spec/slack-ruby-bot/commands/empty_text_spec.rb
 - spec/slack-ruby-bot/commands/help_spec.rb
 - spec/slack-ruby-bot/commands/hi_spec.rb
+- spec/slack-ruby-bot/commands/operators_spec.rb
 - spec/slack-ruby-bot/commands/unknown_spec.rb
+- spec/slack-ruby-bot/rspec/respond_with_error_spec.rb
 - spec/slack-ruby-bot/version_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,107 +0,0 @@
-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/lib/slack-ruby-bot/fixtures/slack/auth_test.yml

@@ -1,48 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/auth.test
-    body:
-      encoding: UTF-8
-      string: token=test
-    headers:
-      Accept:
-      - application/json; charset=utf-8
-      User-Agent:
-      - Slack Ruby Gem 1.1.6
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Origin:
-      - "*"
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Thu, 02 Jul 2015 17:55:20 GMT
-      Server:
-      - Apache
-      Strict-Transport-Security:
-      - max-age=31536000; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      X-Content-Type-Options:
-      - nosniff
-      X-Xss-Protection:
-      - '0'
-      Content-Length:
-      - '55'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: '{"ok":false,"error":"invalid_auth"}'
-    http_version: 
-  recorded_at: Thu, 02 Jul 2015 17:55:48 GMT
-recorded_with: VCR 2.9.3

data/lib/slack-ruby-bot/rspec/fixtures/slack/auth_test.yml

@@ -1,48 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/auth.test
-    body:
-      encoding: UTF-8
-      string: token=test
-    headers:
-      Accept:
-      - application/json; charset=utf-8
-      User-Agent:
-      - Slack Ruby Gem 1.1.6
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Origin:
-      - "*"
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Thu, 02 Jul 2015 17:48:15 GMT
-      Server:
-      - Apache
-      Strict-Transport-Security:
-      - max-age=31536000; includeSubDomains; preload
-      Vary:
-      - Accept-Encoding
-      X-Content-Type-Options:
-      - nosniff
-      X-Xss-Protection:
-      - '0'
-      Content-Length:
-      - '55'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: '{"ok":false,"error":"invalid_auth"}'
-    http_version: 
-  recorded_at: Thu, 02 Jul 2015 17:48:42 GMT
-recorded_with: VCR 2.9.3