jabber-bot 1.2.0 → 1.3.0

data/HISTORY

@@ -1,5 +1,8 @@
 Jabber::Bot Release History
 
+Version 1.3.0 (15 May 2011)
+  * Allow multiple parameters for bot commands. (v0n)
+
 Version 1.2.0 (23 April 2011)
   * Optionally specify a startup message. (nstielau)
   * Optionally disable the misunderstood command reply. (nstielau)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Brett Stimmerman <brettstimmerman@gmail.com>
+Copyright (c) 2011 Brett Stimmerman <brettstimmerman@gmail.com>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.rdoc

@@ -6,7 +6,7 @@ Jabber::Bot makes it simple to create and command your own Jabber bot. Bots
 are created by defining commands powered by regular expressions and Ruby.
 
 *Author*::    Brett Stimmerman (mailto:brettstimmerman@gmail.com)
-*Version*::   1.2.0 (2011-04-23)
+*Version*::   1.3.0 (2011-05-15)
 *Copyright*:: Copyright (c) 2011 Brett Stimmerman. All rights reserved.
 *License*::   New BSD License (http://opensource.org/licenses/bsd-license.php)
 *Website*::   http://github.com/brettstimmerman/jabber-bot
@@ -43,8 +43,8 @@ are created by defining commands powered by regular expressions and Ruby.
   bot.add_command(
     :syntax      => 'puts <string>',
     :description => 'Write something to $stdout',
-    :regex       => /^puts\s+.+$/,
-    :alias       => [ :alias => 'p <string>', :regex => /^p\s+.+$/ ],
+    :regex       => /^puts\s+(.+)$/,
+    :alias       => [ :alias => 'p <string>', :regex => /^p\s+(.+)$/ ],
     :is_public   => true
   ) do |sender, message|
     puts "#{sender} says '#{message}'"

data/lib/jabber/bot.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009 Brett Stimmerman <brettstimmerman@gmail.com>
+# Copyright (c) 2011 Brett Stimmerman <brettstimmerman@gmail.com>
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -82,7 +82,7 @@ module Jabber
 
       @config[:is_public] ||= false
 
-      if @config[:name].nil? or @config[:name].length == 0
+      if @config[:name].nil? || @config[:name].length == 0
         @config[:name] = @config[:jabber_id].sub(/@.+$/, '')
       end
 
@@ -113,6 +113,14 @@ module Jabber
     # the builtin 'help' command, and a regular expression (+regex+) to detect
     # the presence of the command in an incoming message.
     #
+    # The command parameter(s) will be parsed from group(s) (text between
+    # parenthesis) in the +regex+. If there's none, one, or more than one
+    # occurrence, the callback block will receive respectively nil, a String,
+    # or an Array.
+    # e.g. With a command defined like this: /^cmd\s+(.+)\s+(.+)\s+(.+)$/,
+    # writing "cmd foo bar 42" will send ["foo", "bar", "42"] to the callback
+    # block.
+    #
     # The metadata Hash may optionally contain an array of command aliases. An
     # +alias+ consists of an alias +syntax+ and +regex+. Aliases allow the bot
     # to understand command shorthands. For example, the default 'help' command
@@ -126,8 +134,8 @@ module Jabber
     #
     # The specified callback block will be triggered when the bot receives a
     # message that matches the given command regex (or an alias regex). The
-    # callback block will have access to the sender and the message text (not
-    # including the command itsef), and should either return a String response
+    # callback block will have access to the sender and the parameter(s) (not
+    # including the command itself), and should either return a String response
     # or +nil+. If a callback block returns a String response, the response will
     # be delivered to the Jabber id that issued the command.
     #
@@ -138,8 +146,8 @@ module Jabber
     #   add_command(
     #     :syntax      => 'puts <string>',
     #     :description => 'Write something to $stdout',
-    #     :regex       => /^puts\s+.+$/,
-    #     :alias       => [ :syntax => 'p <string>', :regex => /^p\s+.+$/ ]
+    #     :regex       => /^puts\s+(.+)$/,
+    #     :alias       => [ :syntax => 'p <string>', :regex => /^p\s+(.+)$/ ]
     #   ) do |sender, message|
     #     puts "#{sender} says #{message}."
     #     "'#{message}' written to $stdout."
@@ -150,10 +158,10 @@ module Jabber
     #   add_command(
     #     :syntax      => 'puts! <string>',
     #     :description => 'Write something to $stdout (without response)',
-    #     :regex       => /^puts!\s+.+$/,
-    #     :alias       => [
-    #       { :syntax => 'p! <string>', :regex => /^p!\s+.+$/ },
-    #       { :syntax => '! <string>', :regex => /^!\s+/.+$/ }
+    #     :regex       => /^puts!\s+(.+)$/,
+    #     :alias       => [ 
+    #       { :syntax => 'p! <string>', :regex => /^p!\s+(.+)$/ },
+    #       { :syntax => '! <string>', :regex => /^!\s+(.+)$/ }
     #     ]
     #   ) do |sender, message|
     #     puts "#{sender} says #{message}."
@@ -312,7 +320,7 @@ module Jabber
     # Commands are sorted alphabetically by name, and are displayed according
     # to the bot's and the commands's _public_ attribute.
     def help_message(sender, command_name) #:nodoc:
-      if command_name.nil? or command_name.length == 0
+      if command_name.nil? || command_name.length == 0
         # Display help for all commands
         help_message = "I understand the following commands:\n\n"
 
@@ -320,7 +328,7 @@ module Jabber
           # Thank you, Hash.sort
           command = command[1]
 
-          if !command[:is_alias] and (command[:is_public] or master? sender)
+          if !command[:is_alias] && (command[:is_public] || master?(sender))
             command[:syntax].each { |syntax| help_message += "#{syntax}\n" }
             help_message += "  #{command[:description]}\n\n"
           end
@@ -344,28 +352,31 @@ module Jabber
 
     # Parses the given command message for the presence of a known command by
     # testing it against each known command's regex. If a known command is
-    # found, the command parameters are passed on to the callback block, minus
-    # the command trigger. If a String result is present it is delivered to the
+    # found, the command parameters are parsed from groups defined in the
+    # regex, if any. They are passed on to the callback block this way:
+    # +nil+ if there's no parameter, a String if there's just one occurrence,
+    # or an Array if there's more than one occurence.
+    # 
+    # If the callback returns a non- +nil+ value, it will be delivered to the
     # sender.
     #
     # If an unkown command is found, the bot will default to displaying the
-    # help message.  You can disable this by setting the configuration
-    # setting ':misunderstood_message' to false.
+    # help message. You can disable this by setting +:misunderstood_message+
+    # to false in the bot configuration.
     #
     # If the bot has not been made public, commands from anyone other than the
     # bot master(s) will be silently ignored.
     def parse_command(sender, message) #:nodoc:
-      is_master = master? sender
+      is_master = master?(sender)
 
-      if @config[:is_public] or is_master
+      if @config[:is_public] || is_master
         @commands[:spec].each do |command|
-          if command[:is_public] or is_master
-            unless (message.strip =~ command[:regex]).nil?
-              params = nil
+          if command[:is_public] || is_master
+            match = message.strip.match(command[:regex])
 
-              if message.include? ' '
-                params = message.sub(/^\S+\s+(.*)$/, '\1')
-              end
+            unless match.nil?
+              params = match.captures                     # Pass an array,
+              params = params.pop if params.count < 2     # a string, or nil.
 
               response = command[:callback].call(sender, params)
               deliver(sender, response) unless response.nil?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jabber-bot
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Brett Stimmerman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-23 00:00:00 Z
+date: 2011-05-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: xmpp4r-simple