boty 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec2bf939ca3aff3761d4019b065287e836d6859c
-  data.tar.gz: acd79aba96e84b017fff702f11fb9f20a6cd9d97
+  metadata.gz: b15b8096419aa755624c59ba1c22e35d7c62a6e3
+  data.tar.gz: 52b507f57d34b6ed50d838c8cd96ed117e39fc98
 SHA512:
-  metadata.gz: 9c5edc1117584ea21477c080b246f89ee8653b118daf83469f78215c9961f12442bc680733f0ec51b2a01a2c02c411b58cf139d4607f8fbee9270817a1a09443
-  data.tar.gz: 41ddccf73cc09e48e89854c21941640e38498ef8ce6e7e69e3fbfac77b05ceb3f8f35b086c524820add7ecc7273f4c6b1841ad00042721213b66cd1a6ad1abcf
+  metadata.gz: 3d933754cd44b578e03335dd53977748662d2cb893c0ab28e44ec51bd39335116947b79777dca9583deeef63ce8e43bc654170b434ab4f9ac225650464a2bc14
+  data.tar.gz: 961c2bf18e65662c8eb0a3c5cdc02ed3882c52b3b6326f3acc9d31845e0c0ce0e53b5f8823a27955308b7e2fc022cb5367a889b116594f64ea8b3d48d62a7a52

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boty (0.0.7)
+    boty (0.0.9)
       eventmachine
       faye-websocket
       thor

data/README.md

@@ -131,9 +131,56 @@ Turn on this resource. And done, your bot is up and running!
 
 For now, check the `script/ping.rb` and follow it's leads.
 
+### Describing script usage
+
+A bot list all the commands and message handlers that it knows in the moment. If
+you want to give a nice description and/or a usage tip on command you can use
+the `desc` method.
+
+Given that your bot has the following script:
+
+```ruby
+desc "pug me", "Send some nice pug in the channel."
+respond(/pug me/i) do
+  # ...
+end
+```
+
+The follow text will be part of the response for a `@bot: knows` command:
+
+    pug me: Send some nice pug in the channel.
+
+You can use just the description if you want. In this case the `regex` itself
+will be used as the command name.
+
+```ruby
+desc "Send some nice pug in the channel."
+respond(/pug me/i) do
+  # ...
+end
+```
+
+    valeriano 2:25PM
+    @bot: knows
+
+    bot 2:25PM
+        knows: List all the commands known by this bot.
+    /pug me/i: Send some nice pug in the channel.
+
+We strongly recommend that you describe all of your scripts. But if you don't,
+the bot will be capable of tell you what `regexes` are binded to it:
+
+    valeriano 2:47PM
+    @jabberu: knows
+
+    jabberu 2:47PM
+                          knows: List all the commands known by this bot.
+                      /pug me/i
+    /jabberu, are you there\?/i
+
 ### Testing your own scripts
 
- **todo: document**`
+ **todo: document**
 
 For now, check the `spec/script/ping_spec.rb` and follow it's leads.
 

data/bin/bot

@@ -3,7 +3,8 @@ require "./lib/boty"
 
 session = Boty::Session.new
 session.start do |bot|
-  bot.message(/are you there\?/i) do |message|
+  bot.desc "Responds when someone asks for the #{bot.name} presence."
+  bot.message(/#{bot.name}, are you there\?/i) do |message|
     next if message.from? self
     say "Ohay <@#{message.user}>! I'm here, that's for sure."
   end

data/lib/boty/action.rb

@@ -0,0 +1,35 @@
+module Boty
+  class Action
+    attr_reader :regex, :desc, :action
+
+    class Description
+      attr_reader :command, :description
+      attr_writer :regex
+
+      def initialize(command, description: nil, regex: nil)
+        if description.nil?
+          @description = command
+        else
+          @command, @description = command, description
+        end
+
+        @regex = regex
+      end
+
+      def command
+        return @command if @command
+
+        match = /\?(i?)-(mx|mix):(.*)\)/.match @regex.to_s
+        "/#{match[3]}/#{match[1]}"
+      end
+    end
+
+    def initialize(regex, desc, &action)
+      desc = Hash(desc)
+      description = Description.new(desc[:command],
+                                    description: desc[:description],
+                                    regex: regex)
+      @regex, @desc, @action = regex, description, action
+    end
+  end
+end

data/lib/boty/bot.rb

@@ -7,6 +7,7 @@ module Boty
       @raw_info, @id, @name = bot_info, bot_info["id"], bot_info["name"]
       @events = {}
       load_default_scripts
+      on :message, &method(:message_handler)
     end
 
     def event(data)
@@ -23,23 +24,13 @@ module Boty
     end
 
     def message(regex, &block)
-      on :message do |data|
-        yield_message_if_matches(data, block) do
-          regex.match data["text"]
-        end
-      end
+      @handlers ||= []
+      @handlers << create_action(regex, &block)
     end
 
     def respond(regex, &block)
-      on :message do |data|
-        # ignores if the mentions was sent by the bot itself, avoid infinite
-        # loops.
-        next if message_from_bot_itself? data
-        logger.debug { "message wasn't from bot itself, so continuing..." }
-        yield_message_if_matches(data, block) do
-          has_mention?(data) && regex.match(data["text"])
-        end
-      end
+      @commands ||= []
+      @commands << create_action(regex, &block)
     end
 
     def say(message, api_parameters = {})
@@ -49,16 +40,27 @@ module Boty
       logger.debug { "post response: #{post_response}" }
     end
 
+    def desc(command, description = nil)
+      @current_desc = { command: command, description: description }
+    end
+
+    def know_how
+      descriptions = (Array(@commands) + Array(@handlers)).compact.map(&:desc)
+      descriptions.inject({}) { |hsh, desc|
+        hsh.merge!(desc.command => desc.description)
+      }
+    end
+
     private
 
-    def load_default_scripts
-      # TODO: guarantee that we not load the same file twice
-      Dir["script/**/*.rb"].each do |file|
-        instance_eval File.read(file), file, 1
-      end
+    def scripts_to_load
       default_scripts_path = File.expand_path("../../../script", __FILE__)
-      # also loads the default scripts:
-      Dir["#{default_scripts_path}/**/*.rb"].each do |file|
+      paths = Dir["script/**/*.rb"] + Dir["#{default_scripts_path}/**/*.rb"]
+      paths.map { |file| File.expand_path file }.uniq
+    end
+
+    def load_default_scripts
+      scripts_to_load.each do |file|
         instance_eval File.read(file), file, 1
       end
     end
@@ -73,22 +75,34 @@ module Boty
       type
     end
 
-    def has_mention?(data)
-      /<@#{name}>|<@#{id}>/ =~ data["text"]
+    def create_action(regex, &block)
+      Boty::Action.new(regex, @current_desc, &block).tap {
+        @current_desc = nil
+      }
     end
 
     def message_from_bot_itself?(data)
-      data["user"] == self.id
+      data["user"] == self.id || data["user"] == self.name
+    end
+
+    def has_valid_mention?(data)
+      return false if message_from_bot_itself? data
+      !!(/(<@#{id}|#{name}>)/ =~ data["text"])
+    end
+
+    def execute_command(command, message)
+      @_message = message
+      instance_exec @_message, &command.action
+      @_message = nil
     end
 
-    def yield_message_if_matches(data, message_block)
-      match = yield
-      if match
-        # Store the current message in the bot context so it can be used to
-        # infer channel to respond, and so on.
-        @_message = Message.new data, match: match
-        instance_exec @_message, &message_block
-        @_message = nil
+    def message_handler(data)
+      actions = has_valid_mention?(data) ? @commands : @handlers
+
+      Array(actions).each do |command|
+        next unless match = command.regex.match(data["text"])
+        #command.execute(self, match) #=> or something like that...
+        execute_command command, Message.new(data, match: match)
       end
     end
   end

data/lib/boty/session.rb

@@ -13,7 +13,11 @@ module Boty
 
         stablish_connection do |ws|
           ws.on :message do |event|
-            on_message event, bot
+            begin
+              on_message event, bot
+            rescue StandardError => e
+              logger.error "Message #{event} could not be processed. #{e.message}"
+            end
           end
         end
       end

data/lib/boty/version.rb

@@ -1,3 +1,3 @@
 module Boty
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

data/lib/boty.rb

@@ -34,4 +34,5 @@ require "boty/version"
 require "boty/slack"
 require "boty/session"
 require "boty/message"
+require "boty/action"
 require "boty/bot"

data/script/knows.rb

@@ -0,0 +1,10 @@
+desc "knows", "list all the commands known by this bot."
+respond(/knows/i) do
+  message = know_how.inject("") { |_message, command|
+
+    _message << command.first
+    _message << ": #{command.last}" if command.last
+    _message << "\n"
+  }
+  say message
+end

data/script/pug.rb

@@ -1,8 +1,10 @@
+desc "Send some nice pug in the channel."
 respond(/pug me/i) do
   response = JSON.parse Net::HTTP.get(URI "http://pugme.herokuapp.com/random")
   say "<#{response["pug"]}>"
 end
 
+desc "pug bomb X", "Send X pugs in the channel."
 respond(/pug bomb( (\d+))?/i) do |message|
   count = message.match[2] || 5
   response = JSON.parse Net::HTTP.get(URI "http://pugme.herokuapp.com/bomb?count=#{count}")

data/template/project/bot.tt

@@ -3,6 +3,7 @@ require "./<%= bot_name %>"
 
 session = Boty::Session.new
 session.start do |bot|
+  desc "Responds when the bot name (<%= bot_name %>) is mentioned in a message."
   bot.message(/<%= bot_name %>/i) do |message|
     next if message.from? self
     say "Ohay <@#{message.user}>! I'm here, that's for sure."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boty
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Ricardo Valeriano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -174,6 +174,7 @@ files:
 - boty.gemspec
 - exe/boty
 - lib/boty.rb
+- lib/boty/action.rb
 - lib/boty/bot.rb
 - lib/boty/cli.rb
 - lib/boty/dsl.rb
@@ -187,6 +188,7 @@ files:
 - lib/boty/version.rb
 - lib/tasks/.keep
 - log/.keep
+- script/knows.rb
 - script/pug.rb
 - template/project/%bot_name%.rb
 - template/project/.env.local.tt