slack-ruby-bot 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eba2b910b92cbe628a3fb697a08dd62d0af70e5b
-  data.tar.gz: 470fb9481c91e1203ca4ef6ed320f86d3edfbb9d
+  metadata.gz: d913551cd5d7c5dd77eca6b408afc4f429db43dc
+  data.tar.gz: 5e96cb15043a4cf9cd39a661182ba0a1320872a6
 SHA512:
-  metadata.gz: 5147a284b8b37f26417bddb8dc96c8a656e3426b108592b06d0815afb42725ba894dee61a72cc8d56526f0c184b76df160ed64f40fb20a8c0004f8377b9ef288
-  data.tar.gz: 96dc0cce71969ab11ef68f30f970876859d21c8a7aedf09222139bb80d6159c215a6218a1999fea8d4708423078af54137a2826e88051c2394e1574e9e2f58fe
+  metadata.gz: e01fadbae26b2a4bb53794dbe587b635b72ec30dc1b1d18cab3a71adbf061446084890ad9851c9814336ed09c6f48589fa76a82498010ce5f00ebb21dacb3034
+  data.tar.gz: 19df60970882c526023310c6b33aae3f7c8236f71aa59aae0ec741290bc0fb6ffb27a2ddef1bd757483a49ad73109661cc3ddf620531b806a67157d9829b8bf7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.5.5 (1/4/2016)
+
+* Added `SlackRubyBot::Bot` DSL sugar - [@dblock](https://github.com/dblock).
+
 ### 0.5.4 (1/3/2016)
 
 * Enable setting `send_gifs` per instance of `SlackRubyBot::Server` - [@dblock](https://github.com/dblock).

data/README.md

@@ -17,7 +17,7 @@ A generic Slack bot framework written in Ruby on top of [slack-ruby-client](http
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot, 0.5.4.
+You're reading the documentation for the **stable** release of slack-ruby-bot, 0.5.5.
 
 ## Usage
 
@@ -36,18 +36,13 @@ gem 'slack-ruby-bot'
 ```ruby
 require 'slack-ruby-bot'
 
-module PongBot
-  class App < SlackRubyBot::App
-  end
-
-  class Ping < SlackRubyBot::Commands::Base
-    command 'ping' do |client, data, _match|
-      client.message text: 'pong', channel: data.channel
-    end
+class PongBot < SlackRubyBot::Bot
+  command 'ping' do |client, data, match|
+    client.message text: 'pong', channel: data.channel
   end
 end
 
-PongBot::App.instance.run
+PongBot.run
 ```
 
 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.
@@ -70,38 +65,13 @@ The following examples of bots based on slack-ruby-bot are listed in growing ord
 
 ### Commands and Operators
 
-Bots are addressed by name, they 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` and calls the `call` method when implemented.
-
-```ruby
-class Phone < SlackRubyBot::Commands::Base
-  command 'call'
-
-  def self.call(client, data, _match)
-    send_message client, data.channel, 'called'
-  end
-end
-```
-
-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 '呼び出し'
-
-  def self.call(client, data, _match)
-    send_message client, data.channel, 'called'
-  end
-end
-```
+Bots are addressed by name, they respond to commands and operators.
 
 You can combine multiple commands and use a block to implement them.
 
 ```ruby
-class Phone < SlackRubyBot::Commands::Base
-  command 'call', '呼び出し' do |client, data, _match|
-    send_message client, data.channel, 'called'
-  end
+command 'call', '呼び出し' do |client, data, match|
+  send_message client, data.channel, 'called'
 end
 ```
 
@@ -110,10 +80,8 @@ Command match data includes `match['bot']`, `match['command']` and `match['expre
 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 '=' do |_data, _match|
-    # implementation detail
-  end
+operator '=' do |data, match|
+  # implementation detail
 end
 ```
 
@@ -146,7 +114,7 @@ Bots also will respond to a direct message, with or without the bot name in the
 Commands and operators are generic versions of bot routes. You can respond to just about anything by defining a custom route.
 
 ```ruby
-class Weather < SlackRubyBot::Commands::Base
+class Weather < SlackRubyBot::Bot
   match /^How is the weather in (?<location>\w*)\?$/ do |client, data, match|
     send_message client, data.channel, "The weather in #{match[:location]} is nice."
   end
@@ -155,7 +123,34 @@ end
 
 ![](screenshots/weather.gif)
 
-### SlackRubyBot::Commands::Base Functions
+### SlackRubyBot::Commands::Base
+
+The `SlackRubyBot::Bot` class is just sugare deriving from `SlackRubyBot::Commands::Base`. You can divide the bot implementation into subclasses of `SlackRubyBot::Commands::Base` manually. 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` and calls the `call` method when implemented.
+
+```ruby
+class Phone < SlackRubyBot::Commands::Base
+  command 'call'
+
+  def self.call(client, data, match)
+    send_message client, data.channel, 'called'
+  end
+end
+```
+
+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 '呼び出し'
+
+  def self.call(client, data, match)
+    send_message client, data.channel, 'called'
+  end
+end
+```
+
+Other available functions include the following.
 
 #### send_message(client, channel, text)
 

data/examples/minimal/pongbot.rb

@@ -1,14 +1,9 @@
 require 'slack-ruby-bot'
 
-module PongBot
-  class App < SlackRubyBot::App
-  end
-
-  class Ping < SlackRubyBot::Commands::Base
-    def self.call(client, data, _match)
-      client.message text: 'pong', channel: data.channel
-    end
+class Bot < SlackRubyBot::Bot
+  command 'ping' do |client, data, _match|
+    client.message text: 'pong', channel: data.channel
   end
 end
 
-PongBot::App.instance.run
+Bot.run

data/examples/weather/weatherbot.rb

@@ -1,14 +1,9 @@
 require 'slack-ruby-bot'
 
-module WeatherBot
-  class App < SlackRubyBot::App
-  end
-
-  class Weather < SlackRubyBot::Commands::Base
-    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
+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::App.instance.run
+WeatherBot.run

data/lib/slack-ruby-bot.rb

@@ -22,3 +22,4 @@ 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'

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

@@ -0,0 +1,7 @@
+module SlackRubyBot
+  class Bot < SlackRubyBot::Commands::Base
+    def self.run
+      SlackRubyBot::App.instance.run
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 end

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Bot do
+  let! :command do
+    Class.new(SlackRubyBot::Bot) do
+      command 'bot_spec' do |client, data, match|
+        send_message client, data.channel, match['expression']
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  let(:client) { app.send(:client) }
+  it 'sends a message' do
+    expect(SlackRubyBot::Commands::Base).to receive(:send_client_message).with(client, channel: 'channel', text: 'message')
+    app.send(:message, client, text: "#{SlackRubyBot.config.user} bot_spec message", channel: 'channel', user: 'user')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -198,6 +198,7 @@ files:
 - lib/slack-ruby-bot.rb
 - lib/slack-ruby-bot/about.rb
 - lib/slack-ruby-bot/app.rb
+- lib/slack-ruby-bot/bot.rb
 - lib/slack-ruby-bot/client.rb
 - lib/slack-ruby-bot/commands.rb
 - lib/slack-ruby-bot/commands/about.rb
@@ -232,6 +233,7 @@ 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/bot_spec.rb
 - spec/slack-ruby-bot/commands/commands_precedence_spec.rb
 - spec/slack-ruby-bot/commands/commands_regexp_escape_spec.rb
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb
@@ -284,6 +286,7 @@ 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/bot_spec.rb
 - spec/slack-ruby-bot/commands/commands_precedence_spec.rb
 - spec/slack-ruby-bot/commands/commands_regexp_escape_spec.rb
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb