streambot 1.0.0.rc3 → 1.0.0.rc4

data/README.rdoc

@@ -53,9 +53,51 @@ I wrote this stuff into my config.yml and load the params with
 	require 'yaml'
 	@params = YAML.load_file('config.yml')
 
-= Callbacks
+= Events / Callbacks
 
-*on_error*:: this callback is fired when an error occures
+To receive something from an event, you need to call the receive method on the event and pass a block into this method
+
+	tracker.event_name.receive do |params|
+		# ...
+	end
+
+== on_error
+
+is fired when an error occures
+
+	tracker.on_error.receive do |message, trace|
+		# print the error message and the stacktrace to STDOUT
+		puts message
+		puts trace
+		# and stop the tracker
+		tracker.stop
+	end
+
+== on_match
+
+is fired wenn an filter matched on an status
+
+	tracker.on_match.receive do |status, filter_path, filter_value|
+		puts "filter matched on #{filter_path} with #{filter_value} in status ##{status['id']}"
+	end
+
+== before_retweet
+
+is fired before the tracker retweets a status
+
+	tracker.before_retweet.receive do |status|
+		# print the status to STDOUT
+		puts status
+	end
+
+== after_retweet
+
+is fired after the tracker has retweeted a status
+
+	tracker.after_retweet.receive do |status|
+		# save the status with active record
+		Retweet.new(status)
+	end
 
 = Filters
 
@@ -77,16 +119,6 @@ You can even filter all tweets of users with an evil background color.
 
 	"user/profile_background_color": "666666"
 
-= Example
-
-	@params = YAML.load_file('config.yml')
-	@client = StreamBot::Tracker.new(@params)
-	
-	@client.on_error do |msg, stacktrace|
-		puts msg
-		puts stacktrace
-	end
-
 = Contribution
 == Testing
 

data/VERSION

@@ -1 +1 @@
-1.0.0.rc3
+1.0.0.rc4

data/lib/streambot/event.rb

@@ -4,16 +4,19 @@ module StreamBot
     attr_reader :name
 
     def initialize(name)
+      LOG.debug "initialize: #{name}"
       @name = name
     end
 
-    def handle(method=nil, & block)
-      @handler = method if method
-      @handler = block if block
+    def receive(method=nil, & block)
+      LOG.debug "receive: #{self.name}" 
+      @handler = method if !method.nil?
+      @handler = block if !block.nil?
     end
 
     def trigger(* args)
-      @handler.call(* args) if !@handler.nil?
+      LOG.debug "trigger: #{self.name}"
+      @handler.call(*args) if !@handler.nil?
     end
   end
 end

data/lib/streambot/event_handler.rb

@@ -12,20 +12,24 @@ module StreamBot
         event(name)
       end
     end
-
+    
     private
     # the real event registration
     def register_event(name)
       class_eval do
-        variable =:"@#{name}"
-        define_method(name) do
-          event = instance_variable_get(variable)
-          if event == nil
-            event = StreamBot::Event.new(name)
-            instance_variable_set(variable, event)
-          end
-          event
+        define_event_method(name);
+      end
+    end
+    
+    def define_event_method(name)
+      variable =:"@#{name}"
+      define_method(name) do
+        event = instance_variable_get(variable)
+        if event == nil
+          event = StreamBot::Event.new(name)
+          instance_variable_set(variable, event)
         end
+        event
       end
     end
   end

data/lib/streambot/retweet.rb

@@ -8,6 +8,7 @@ module StreamBot
 
     # retweets the status with given id
     def retweet(id)
+      LOG.info "retweet status ##{id}"
       @handler.post("/statuses/retweet/#{id}.json", nil)
     end
   end

data/lib/streambot/tracker.rb

@@ -4,7 +4,7 @@ module StreamBot
   # This class has serveral callback methods
   class Tracker
     extend StreamBot::EventHandler
-    events :on_error, :on_match
+    events :on_error, :on_match, :before_retweet, :after_retweet
     attr_accessor :auth, :params
 
     # initializes the tracker
@@ -24,10 +24,11 @@ module StreamBot
         if retweet?(status)
           # one thread per retweet, 
           # cause it's much, much faster
+          before_retweet.trigger(status)
           @thread = Thread.new do
             @retweet.retweet(status["id"])
           end
-          @thread.join
+          after_retweet.trigger(status)
         end
       end
     end
@@ -64,11 +65,10 @@ module StreamBot
         filters.each_pair do |path, value|
           array = []
           array << value
-          array.flatten.each do |aValue|
-            path_value = ArrayPath.get_path(status, path)
-            if path_value.eql?(aValue) || path_value.include?(aValue)
-              LOG.info "filter matched on #{path} with #{aValue} in status ##{status['id']}"
-              on_match.trigger(status)
+          array.flatten.each do |filter_value|
+            path_value = StreamBot::ArrayPath.get_path(status, path)
+            if path_value.eql?(filter_value) || path_value.include?(filter_value)
+              on_match.trigger(status, path, filter_value)
               retweet = false
             end
           end

data/spec/tracker_spec.rb

@@ -5,10 +5,10 @@ describe StreamBot::Tracker do
   before :all do
     params = YAML.load_file('spec/params.yml')
     @tracker = StreamBot::Tracker.new(params)
-    @tracker.on_error do |msg, trace|
+    @tracker.on_error.receive do |msg, trace|
       puts "#{msg}: #{trace}"
     end
-    @tracker.on_match do |status, filter_path, filter_value|
+    @tracker.on_match.receive do |status, filter_path, filter_value|
       puts "filter matched on #{filter_path} with #{filter_value} in status ##{status['id']}"
     end
   end
@@ -23,7 +23,7 @@ describe StreamBot::Tracker do
   
   describe "wait" do 
     it "should sleep for 60 seconds" do 
-      sleep 10
+      sleep 60
     end
   end
   

metadata

@@ -2,7 +2,7 @@
 name: streambot
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors: 
 - Sascha Wessel
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +01:00
+date: 2011-02-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency