twibot 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.5 / 2009-04-12
+
+* Added support for regular expression routes
+* Make timeline_for option configurable, ie in config: timeline_for: :public
+* Fixed bug: Users where unlawfully rejected when their screen name started with
+             a capital letter (Wilco)
+* Fixed bug: Twibot crashed if there were no handlers registered
+
 == 0.1.4 / 2009-03-24
 
 * Removed some warnings

data/Readme.rdoc

@@ -1,6 +1,7 @@
 = Twibot
 Official URL: http://github.com/cjohansen/twibot/tree/master
 Christian Johansen (http://www.cjohansen.no)
+Twitter: @cjno
 
 == Description
 
@@ -87,6 +88,16 @@ to match incoming tweets and messages:
 You can have several "tweet" blocks (or "message" or "reply"). The first one to
 match an incoming tweet/message will handle it.
 
+As of the upcoming 0.1.5/0.2.0, Twibot also supports regular expressions as routes:
+
+  require 'twibot'
+
+  tweet /^time ([^\s]*) ([^\s]*)/ do |message, params|
+    # params is an array of matches when using regexp routes
+    time = MyTimeService.lookup(params[0], params[1])
+    client.message :post, "Time is #{time} in #{params[:city]}, #{params[:country]}"
+  end
+
 === Working with the Twitter API
 
 The DSL gives you access to your Twitter client instance through "client" (or "twitter"):
@@ -121,10 +132,10 @@ make 20.000 reqs/hour, and shouldn't be a problem so long as your intentions are
 (I think).
 
 Twibot polls like this:
-  * Poll messages if any message handlers exist
-  * Poll tweets if any tweet or reply handlers exist
-  * Sleep for +interval+ seconds
-  * Go over again
+* Poll messages if any message handlers exist
+* Poll tweets if any tweet or reply handlers exist
+* Sleep for +interval+ seconds
+* Go over again
 
 As long as Twibot finds any messages and/or tweets, the interval stays the same
 (min_interval configuration switch). If nothing was found however, the interval to
@@ -133,9 +144,10 @@ reaches max_interval, where it will stay until Twibot finds anything.
 
 == Contributors
 
- * Dan Van Derveer (bug fixes) - http://dan.van.derveer.com/
- * Ben Vandgrift (Twitter downtime error handling) - http://neovore.com/
- * Jens Ohlig (warnings)
+* Dan Van Derveer (bug fixes) - http://dan.van.derveer.com/
+* Ben Vandgrift (Twitter downtime error handling) - http://neovore.com/
+* Jens Ohlig (warnings)
+* Wilco van Duinkerken (bug fixes) - http://www.sparkboxx.com/
 
 == License
 

data/lib/twibot.rb

@@ -7,7 +7,7 @@ require File.join(File.dirname(__FILE__), 'hash')
 module Twibot
 
   # :stopdoc:
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/twibot/bot.rb

@@ -47,14 +47,16 @@ module Twibot
       messages = @twitter.messages(:received, { :count => 1 })
       @processed[:message] = messages.first.id if messages.length > 0
 
-      handle_tweets = @handlers[:tweet].length + @handlers[:reply].length > 0
+      handle_tweets = !@handlers.nil? && @handlers[:tweet].length + @handlers[:reply].length > 0
       tweets = []
+
       begin
-        tweets = handle_tweets ? @twitter.timeline_for(:me, { :count => 1 }) : []
+        tweets = handle_tweets ? @twitter.timeline_for(@config.to_hash[:timeline_for], { :count => 1 }) : []
       rescue Twitter::RESTError => e
         log.error("Failed to connect to Twitter.  It's likely down for a bit:")
-	log.error(e.to_s)
+        log.error(e.to_s)
       end
+
       @processed[:tweet] = tweets.first.id if tweets.length > 0
       @processed[:reply] = tweets.first.id if tweets.length > 0
 
@@ -94,8 +96,8 @@ module Twibot
         dispatch_messages(type, @twitter.messages(:received, options), %w{message messages})
       rescue Twitter::RESTError => e
         log.error("Failed to connect to Twitter.  It's likely down for a bit:")
-	log.error(e.to_s)
-	0
+        log.error(e.to_s)
+        0
       end
     end
 
@@ -108,13 +110,11 @@ module Twibot
       options = {}
       options[:since_id] = @processed[type] if @processed[type]
       begin
-        dispatch_messages(type, 
-      	  @twitter.timeline_for(config[:include_friends] ? :friends : :me, 
-	  options), %w{tweet tweets})
+        dispatch_messages(type, @twitter.timeline_for(@config.to_hash[:timeline_for], options), %w{tweet tweets})
       rescue Twitter::RESTError => e
         log.error("Failed to connect to Twitter.  It's likely down for a bit:")
-	log.error(e.to_s)
-	0
+        log.error(e.to_s)
+        0
       end
     end
 
@@ -130,10 +130,10 @@ module Twibot
         dispatch_messages(type, @twitter.status(:replies, options), %w{reply replies})
       rescue Twitter::RESTError => e
         log.error("Failed to connect to Twitter.  It's likely down for a bit:")
-	log.error(e.to_s)
-	0
+        log.error(e.to_s)
+        0
       end
-      
+
     end
 
     #

data/lib/twibot/config.rb

@@ -29,7 +29,8 @@ module Twibot
       :password => nil,
       :prompt => false,
       :daemonize => false,
-      :include_friends => false
+      :include_friends => false,
+      :timeline_for => :public
     }
 
     def initialize(settings = {})

data/lib/twibot/handlers.rb

@@ -50,6 +50,11 @@ module Twibot
     def pattern=(pattern)
       return if pattern.nil? || pattern == ""
 
+      if pattern.is_a?(Regexp)
+        @options[:pattern] = pattern
+        return
+      end
+
       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
@@ -70,7 +75,7 @@ module Twibot
 
       users = @options[:from] ? @options[:from] : nil
       sender = message.respond_to?(:sender) ? message.sender : message.user
-      return false if users && !users.include?(sender.screen_name) # Check allowed senders
+      return false if users && !users.include?(sender.screen_name.downcase) # Check allowed senders
       true
     end
 
@@ -82,10 +87,12 @@ module Twibot
       return unless recognize?(message)
       @params = {}
 
-      if @options[:pattern]
+      if @options[:pattern] && @options[:tokens]
         matches = message.text.match(@options[:pattern])
         @options[:tokens].each_with_index { |token, i| @params[token] = matches[i+1] }
         @params[:text] = (matches[@options[:tokens].length+1] || "").strip
+      elsif @options[:pattern] && !@options[:tokens]
+        @params = message.text.match(@options[:pattern]).to_a[1..-1] || []
       else
         @params[:text] = message.text
       end

data/test/test_bot.rb

@@ -116,6 +116,11 @@ class TestBot < Test::Unit::TestCase
     Twitter::Client.any_instance.expects(:status).with(:replies, { :since_id => 1 }).returns([])
     assert_equal 0, bot.receive_replies
   end
+
+  should "use public as default timeline method for tweet 'verb'" do
+    bot = Twibot::Bot.new(Twibot::Config.default)
+    assert_equal :public, bot.instance_eval { @config.to_hash[:timeline_for] }
+  end
 end
 
 class TestBotMacros < Test::Unit::TestCase

data/test/test_handler.rb

@@ -126,6 +126,12 @@ class TestHandler < Test::Unit::TestCase
     message = tweet "cjno", "time oslo norway"
     assert handler.recognize?(message)
   end
+  
+  should "recognize tweets from allowed users with capital screen names" do
+    handler = Twibot::Handler.new :from => [:cjno, :irbno]
+    message = tweet "Cjno", "time oslo norway"
+    assert handler.recognize?(message)
+  end
 
   should "accept options as only argument" do
     handler = Twibot::Handler.new :from => :cjno
@@ -144,7 +150,7 @@ class TestHandler < Test::Unit::TestCase
     handler.dispatch(message)
   end
 
-  should "should call constructor block from handle" do
+  should "call constructor block from handle" do
     handler = Twibot::Handler.new("time :city :country", :from => ["cjno", "irbno"]) do |message, params|
       raise "Boom!"
     end
@@ -153,4 +159,33 @@ class TestHandler < Test::Unit::TestCase
       handler.handle(nil, nil)
     end
   end
+
+  should "recognize regular expressions" do
+    handler = Twibot::Handler.new /(?:what|where) is (.*)/i
+    message = twitter_message "dude", "Where is this shit?"
+    assert handler.recognize?(message)
+
+    message = twitter_message "dude", "How is this shit?"
+    assert !handler.recognize?(message)
+  end
+
+  should "recognize regular expressions from specific users" do
+    handler = Twibot::Handler.new /(?:what|where) is (.*)/i, :from => "cjno"
+    message = twitter_message "dude", "Where is this shit?"
+    assert !handler.recognize?(message)
+
+    message = twitter_message "cjno", "Where is this shit?"
+    assert handler.recognize?(message)
+  end
+
+  should "provide parameters as arrays when matching regular expressions" do
+    handler = Twibot::Handler.new(/time ([^\s]*) ([^\s]*)/) do |message, params|
+      assert_equal "oslo", params[0]
+      assert_equal "norway", params[1]
+    end
+
+    message = twitter_message "cjno", "time oslo norway"
+    assert handler.recognize?(message)
+    handler.dispatch(message)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: twibot
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Christian Johansen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-24 00:00:00 +01:00
+date: 2009-04-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency