jabber-bot 1.1.1 → 1.2.0

data/HISTORY

@@ -1,5 +1,9 @@
 Jabber::Bot Release History
 
+Version 1.2.0 (23 April 2011)
+  * Optionally specify a startup message. (nstielau)
+  * Optionally disable the misunderstood command reply. (nstielau)
+
 Version 1.1.1 (26 May 2007)
   * Minor change to the listener thread that should improve CPU usage.
 

data/LICENSE

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

data/{README → README.rdoc}

@@ -1,30 +1,31 @@
 = Jabber::Bot
 
-Easily create powerful Jabber bots to do your bidding.
+Easily create simple regex powered Jabber bots.
 
-Jabber::Bot makes it simple to create and command your own Jabber bot with
-little fuss. By adding custom commands powered by regular expressions to your
-bot's repertoire, you and your new bot will be able to accomplish nearly
-anything.
+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.1.1
-Copyright:: Copyright (c) 2007 Brett Stimmerman. All rights reserved.
-License::   New BSD License (http://opensource.org/licenses/bsd-license.php)
-Website::   http://socket7.net/software/jabber-bot
+*Author*::    Brett Stimmerman (mailto:brettstimmerman@gmail.com)
+*Version*::   1.2.0 (2011-04-23)
+*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
 
-== Dependencies
+== Requires
 
-- Ruby[http://www.ruby-lang.org] 1.8.4+
-- xmpp4r-simple[http://xmpp4r-simple.rubyforge.org/] 0.8.7+
+* RubyGems
+* Jabber::Simple 0.8.7+
 
-== Basic Usage
+== Usage
 
-  # Create a public Jabber::Bot to do your bidding
+  require 'rubygems'
+  require 'jabber/bot'
+
+  # Create a public Jabber::Bot
   config = {
-    :name      => 'SampleBot'
+    :name      => 'SampleBot',
     :jabber_id => 'bot@example.com',
-    :password  => 'password',
+    :password  => 'secret',
     :master    => 'master@example.com',
     :is_public => true
   }
@@ -46,9 +47,9 @@ Website::   http://socket7.net/software/jabber-bot
     :alias       => [ :alias => 'p <string>', :regex => /^p\s+.+$/ ],
     :is_public   => true
   ) do |sender, message|
-    puts "#{sender} says '#{message'"
+    puts "#{sender} says '#{message}'"
     "'#{message}' written to $stdout"
   end
 
   # Bring your new bot to life
-  bot.connect
+  bot.connect

data/lib/jabber/bot.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2007 Brett Stimmerman <brettstimmerman@gmail.com>
+# Copyright (c) 2009 Brett Stimmerman <brettstimmerman@gmail.com>
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -31,22 +31,9 @@ require 'xmpp4r-simple'
 
 module Jabber
 
-  # = Jabber::Bot
-  #
-  # Jabber::Bot makes it simple to create and command a Jabber bot with little
-  # fuss. By adding custom commands powered by regular expressions to your bot's
-  # repertoire, you and your new bot will be able to accomplish nearly anything.
-  #
-  # Author::    Brett Stimmerman (mailto:brettstimmerman@gmail.com)
-  # Version::   1.1.1
-  # Copyright:: Copyright (c) 2007 Brett Stimmerman. All rights reserved.
-  # License::   New BSD License (http://opensource.org/licenses/bsd-license.php)
-  # Website::   http://socket7.net/software/jabber-bot
-  #
   class Bot
 
-    # Direct access to the underlying
-    # Jabber::Simple[http://xmpp4r-simple.rubyforge.org/] object.
+    # Direct access to the underlying Jabber::Simple object.
     attr_reader :jabber
 
     # Creates a new Jabber::Bot object with the specified +config+ Hash, which
@@ -71,7 +58,7 @@ module Jabber
     #   # A minimally confiugured private bot with a single master.
     #   bot = Jabber::Bot.new(
     #     :jabber_id => 'bot@example.com',
-    #     :password  => 'password',
+    #     :password  => 'secret',
     #     :master    => 'master@example.com'
     #   )
     #
@@ -82,7 +69,7 @@ module Jabber
     #   bot = Jabber::Bot.new(
     #     :name      => 'PublicBot',
     #     :jabber_id => 'bot@example.com',
-    #     :password  => 'password',
+    #     :password  => 'secret',
     #     :master    => masters,
     #     :is_public => true,
     #     :presence  => :chat,
@@ -105,6 +92,10 @@ module Jabber
 
       @commands = { :spec => [], :meta => {} }
 
+      # Default to asking about unknown commands.
+      @config[:misunderstood_message] = @config[:misunderstood_message].nil? ? true : @config[:misunderstood_message]
+
+      # Add the help command
       add_command(
         :syntax      => 'help [<command>]',
         :description => 'Display help for the given command, or all commands' +
@@ -136,7 +127,7 @@ 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 
+    # including the command itsef), 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.
     #
@@ -160,7 +151,7 @@ module Jabber
     #     :syntax      => 'puts! <string>',
     #     :description => 'Write something to $stdout (without response)',
     #     :regex       => /^puts!\s+.+$/,
-    #     :alias       => [ 
+    #     :alias       => [
     #       { :syntax => 'p! <string>', :regex => /^p!\s+.+$/ },
     #       { :syntax => '! <string>', :regex => /^!\s+/.+$/ }
     #     ]
@@ -193,12 +184,14 @@ module Jabber
     end
 
     # Connect the bot, making it available to accept commands.
+    # You can specify a custom startup message with the ':startup_message'
+    # configuration setting.
     def connect
       @jabber = Jabber::Simple.new(@config[:jabber_id], @config[:password])
 
       presence(@config[:presence], @config[:status], @config[:priority])
 
-      deliver(@config[:master], "#{@config[:name]} reporting for duty.")
+      deliver(@config[:master], (@config[:startup_message] || "NAME reporting for duty.").gsub("NAME", @config[:name]))
 
       start_listener_thread
     end
@@ -355,6 +348,10 @@ module Jabber
     # the command trigger. If a String result is present it is 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.
+    #
     # 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:
@@ -372,15 +369,17 @@ module Jabber
 
               response = command[:callback].call(sender, params)
               deliver(sender, response) unless response.nil?
-              
+
               return
             end
           end
         end
 
-        response = "I don't understand '#{message.strip}' Try saying 'help' " +
-            "to see what commands I understand."
-        deliver(sender, response)
+        if @config[:misunderstood_message]
+          response = "I don't understand '#{message.strip}' Try saying 'help' " +
+              "to see what commands I understand."
+          deliver(sender, response)
+        end
       end
     end
 

metadata

@@ -1,64 +1,91 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: jabber-bot
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
-date: 2007-05-26 00:00:00 -07:00
-summary: Jabber::Bot makes it simple to create and command your own Jabber bot with little fuss. By adding custom commands powered by regular expressions to your bot's repertoire, you and your new bot will be able to accomplish nearly anything.
-require_paths: 
-- lib
-email: brettstimmerman@gmail.com
-homepage: http://socket7.net/software/jabber-bot
-rubyforge_project: jabber-bot
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.4
-  version: 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Brett Stimmerman
-files: 
-- lib/jabber
-- lib/jabber/bot.rb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: brettstimmerman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
 - LICENSE
-- README
 - HISTORY
-test_files: []
+files: 
+- HISTORY
+- LICENSE
+- README.rdoc
+- lib/jabber/bot.rb
+homepage: http://github.com/brettstimmerman/jabber-bot
+licenses: []
 
+post_install_message: 
 rdoc_options: 
 - --title
 - Jabber::Bot Documentation
 - --main
-- README
+- README.rdoc
 - --line-numbers
-extra_rdoc_files: 
-- README
-- LICENSE
-- HISTORY
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 63
+      segments: 
+      - 1
+      - 8
+      - 4
+      version: 1.8.4
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: xmpp4r-simple
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.8.7
-    version: 
+rubyforge_project: jabber-bot
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Easily create simple regex powered Jabber bots.
+test_files: []
+