jabbot 0.2.0 → 0.3.1

data/README.md

@@ -1,8 +1,5 @@
 # Jabbot
 
-Official URL: http://github.com/badboy/jabbot/tree/master
-Jan-Erik Rediger (badboy\_) (http://badboy.pytalhost.de)
-
 ## Description
 
 Jabbot is a Ruby micro-framework for creating Jabber/MUC bots,
@@ -15,6 +12,10 @@ http://github.com/cjohansen/twibot/tree/master
 A big thank you to Christian Johansen, who wrote the code for Twibot.
 Jabbot is heavily based on his code.
 
+If your curious if this code is stable enough:
+I have a bot instance running on my server for quite some time now
+and it works great :)
+
 ## Usage
 
 ### Simple example
@@ -25,8 +26,8 @@ Jabbot is heavily based on his code.
     end
 
     # Respond to query if they come from the right crowd
-    # post "message" => "user" is just some syntax sugar
-    # post "message", "user" will work to
+    # query "message" => "user" is just some syntax sugar
+    # query "message", "user" will work to
     query :from => [:cjno, :irbno] do |message, params|
       post "#{message.user} I agree" => message.user
     end
@@ -65,11 +66,10 @@ You can also configure with Ruby:
 
 If you don't specify login and/or password in any of these ways, Jabbot will fail
 Nick is automatically set to "jabbot" unless something different is defined
-If you want you can set the Jabber Resource:
+If you want you can set the XMPP Resource:
 
     configure do |conf|
       conf.resource ="mybot_resource"
-
     end
 
 Default is "jabbot".
@@ -77,7 +77,7 @@ Default is "jabbot".
 ### "Routes"
 
 Like Sinatra, and other web app frameworks, Jabbot supports "routes":
-patterns to match incoming tweets and messages:
+patterns to match incoming messages:
 
     message "time :country :city" do |message, params|
       time = MyTimeService.lookup(params[:country], params[:city])
@@ -95,6 +95,14 @@ Jabbot also supports regular expressions as routes:
       post "Time is #{time} in #{params[:city]}, #{params[:country]}"
     end
 
+If all you need is exact word matching you can say so:
+
+    message :exact => "pattern" do |message, params|
+      ...
+    end
+
+Internally this pattern is translated to `/\Apattern\Z/`, so you can use regex literals.
+
 ## Requirements
 
 xmpp4r. You'll need atleast 0.4.

data/lib/jabbot.rb

@@ -10,10 +10,10 @@ require 'jabbot/bot.rb'
 require 'jabbot/config.rb'
 require 'jabbot/handlers.rb'
 require 'jabbot/macros.rb'
-require 'jabbot/message.rb'
-require 'jabbot/version.rb'
 
 module Jabbot
+  VERSION = '0.3.1'
+
   @@app_file = lambda do
     ignore = [
       /lib\/twibot.*\.rb/, # Library

data/lib/jabbot/bot.rb

@@ -41,7 +41,6 @@ module Jabbot
     # connect to Jabber and join channel
     #
     def connect
-      #Jabber::debug = true
       @jid = Jabber::JID.new(login)
       @mucjid = Jabber::JID.new("#{channel}@#{server}")
 
@@ -60,6 +59,13 @@ module Jabbot
       end
 
       @client = Jabber::Client.new(@jid)
+      @client.on_exception do |*args|
+        $stderr.puts "got an intern EXCEPTION, args where:"
+        $stderr.puts args.inspect
+        $stderr.puts "exiting..."
+
+        exit
+      end
       @connected = true
       begin
         @client.connect
@@ -68,7 +74,7 @@ module Jabbot
         muc_handlers.call(@muc)
         @muc.join(@mucjid)
        rescue => errmsg
-        STDERR.write "#{errmsg.class}\n#{errmsg}, #{errmsg.backtrace.join("\n")}"
+        $stderr.write "#{errmsg.class}\n#{errmsg}, #{errmsg.backtrace.join("\n")}"
         exit 1
       end
     end
@@ -79,10 +85,14 @@ module Jabbot
     def run!
       puts "Jabbot #{Jabbot::VERSION} imposing as #{login} on #{channel}@#{server}"
 
-      trap(:INT) do
+      onclose_block = proc {
+        close
         puts "\nAnd it's a wrap. See ya soon!"
         exit
-      end
+      }
+
+      Kernel.trap(:INT, onclose_block)
+      Kernel.trap(:QUIT, onclose_block)
 
       debug! if config[:debug]
       connect

data/lib/jabbot/handlers.rb

@@ -9,7 +9,7 @@ module Jabbot
     end
 
     def dispatch(type, message)
-      handlers[type].each { |handler| handler.dispatch(message) }
+      handlers[type].each {|handler| handler.dispatch(message) }
     end
 
     def handlers
@@ -34,12 +34,16 @@ module Jabbot
   class Handler
     def initialize(pattern = nil, options = {}, &blk)
       if pattern.is_a?(Hash)
-        options = pattern
-        pattern = nil
+        if pattern.keys.first == :exact
+          pattern = /\A#{pattern[:exact]}\Z/
+        else
+          options = pattern
+          pattern = nil
+        end
       end
 
       @options = options
-      @options[:from].collect! { |s| s.to_s } if @options[:from] && @options[:from].is_a?(Array)
+      @options[:from].collect! {|s| s.to_s } if @options[:from] && @options[:from].is_a?(Array)
       @options[:from] = [@options[:from].to_s] if @options[:from] && [String, Symbol].include?(@options[:from].class)
       @handler = nil
       @handler = block_given? ? blk : nil
@@ -50,21 +54,17 @@ module Jabbot
     # Parse pattern string and set options
     #
     def pattern=(pattern)
-      return if pattern.nil? || pattern == ""
-
-      if pattern == :all
-        return
-      end
+      return if pattern.nil? || pattern == '' || pattern == :all
 
       if pattern.is_a?(Regexp)
         @options[:pattern] = pattern
         return
       end
 
-      words = pattern.split.collect { |s| s.strip }          # Get all words in pattern
+      words = pattern.split.collect {|s| s.strip }            # Get all words in pattern
       @options[:tokens] = words.inject([]) do |sum, token|   # Find all tokens, ie :symbol :like :names
         next sum unless token =~ /^:.*/                      # Don't process regular words
-        sym = token.sub(":", "").to_sym                      # Turn token string into symbol, ie ":token" => :token
+        sym = token.sub(':', '').to_sym                      # Turn token string into symbol, ie ":token" => :token
         regex = @options[sym] || '[^\s]+'                    # Fetch regex if configured, else use any character but space matching
         pattern.sub!(/(^|\s)#{token}(\s|$)/, '\1(' + regex.to_s + ')\2') # Make sure regex captures named switch
         sum << sym

data/test/test_handler.rb

@@ -186,4 +186,16 @@ context "Handler" do
     assert handler.recognize?(message)
     handler.dispatch(message)
   end
+
+  test "recognize matching messages with :exact pattern" do
+    handler = Jabbot::Handler.new :exact => "!pattern"
+    message = mock_message "dude", "!pattern"
+    assert handler.recognize?(message)
+  end
+
+  test "not recognize non-matching message with :exact patterns" do
+    handler = Jabbot::Handler.new :exact => "!pattern"
+    message = mock_message "dude", "   !pattern    "
+    assert !handler.recognize?(message)
+  end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: jabbot
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors: 
 - badboy
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-03 00:00:00 +02:00
+date: 2011-04-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,9 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
         version: "0.4"
   type: :runtime
   version_requirements: *id001
@@ -39,10 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 10
-        - 1
         version: 2.10.1
   type: :development
   version_requirements: *id002
@@ -64,8 +53,6 @@ files:
 - lib/jabbot/config.rb
 - lib/jabbot/handlers.rb
 - lib/jabbot/bot.rb
-- lib/jabbot/version.rb
-- lib/jabbot/message.rb
 - test/test_config.rb
 - test/test_macros.rb
 - test/test_bot.rb
@@ -86,21 +73,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple framework for creating Jabber/MUC bots, inspired by Sinatra and Twibot

data/lib/jabbot/message.rb

@@ -1,7 +0,0 @@
-module Jabbot
-  Message = Struct.new(:user, :text, :time) do
-    def to_s
-      "#{user}: #{text}"
-    end
-  end
-end

data/lib/jabbot/version.rb

@@ -1,3 +0,0 @@
-module Jabbot
-  VERSION = '0.2.0'
-end