streambot 0.4.0 → 0.5.0.beta3

data/README.rdoc

@@ -6,9 +6,17 @@ streambot is using tweetstream[http://github.com/intridea/tweetstream] for simpl
 
 the streambot gem is available on rubygems.org[http://rubygems.org/gems/streambot]
 to get streambot installed, you simply need to run
-	
-	gem install streambot	
-		
+
+=== stable release
+
+	gem install streambot
+
+=== beta release
+
+if you are insane and want to try out the actual beta release then run
+
+	gem install streambot --pre
+
 == Usage
 
 	require 'streambot'
@@ -21,11 +29,15 @@ to get streambot installed, you simply need to run
 	bot = StreamBot::Tracker.new(@params, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
 	bot.start
 
+=== Documentation
+
+The full rdoc is available on rdoc.info[http://rdoc.info/projects/gr4y/streambot]
+
 === Configuration
 
-Twitter is shutting down http basic authentication with June 30th 2010. But only for the REST API. The Streaming API which the tracker is using still works with http basic authentication only. 
+Twitter is shutting down http basic authentication with August 16th 2010. But only for the REST API. The Streaming API which the tracker is using still works with http basic authentication only.
 
-So we still need the http basic authentication credentials for tracking the keywords after June 30th, but only for tracking and not for retweeting. So I introduced a new way of configuration, the params attribute that you need to pass into Tracker. Actually I don't know what happens when twitter is shutting down the http basic authentication.
+So we still need the http basic authentication credentials for tracking the keywords after August 16th, but only for tracking and not for retweeting. So I introduced a new way of configuration, the params attribute that you need to pass into Tracker. Actually I don't know what happens when twitter is shutting down the http basic authentication.
 
 ==== auth_type
 The auth type is the authentication mechanism you want to use for retweeting.
@@ -41,6 +53,12 @@ The auth type is the authentication mechanism you want to use for retweeting.
 *username*:: Your login username
 *password*:: Your login password
 
+==== filters
+
+*key*:: this should just hold an description of your filter
+*type*:: USER, CONTENT or LANGUAGE
+*value*:: a string, thats the content that should be filtered
+
 I wrote this stuff into my config.yml and load the params with 
 
 	require 'yaml'

data/Rakefile

@@ -48,6 +48,7 @@ rescue LoadError
 end
 
 task :build_gem => [:test,:rdoc,:build]
+task :install_gem => [:build_gem,:install]
 task :default => [:check_dependencies,:rcov,:reek,:build_gem]
 
 require 'rake/rdoctask'

data/lib/streambot/callbacks.rb

@@ -0,0 +1,29 @@
+module StreamBot
+  module Callbacks    
+    def callback(name)
+      register_callback(name)
+    end
+
+    def callbacks(* names)
+      names.each do |name|
+        register_callback(name)
+      end
+    end
+
+    def is_registered?(name)      
+      @callbacks.include?(name)
+    end
+
+    def register_callback(name)
+      class_eval <<-EOF
+          def #{name} (*args,&block)
+            if block
+              @#{name} = block
+            elsif @#{name}
+              @#{name}.call(*args)
+            end
+          end
+      EOF
+    end
+  end
+end

data/lib/streambot/tracker.rb

@@ -1,36 +1,75 @@
 module StreamBot
-  # The Tracker class that provides a start and a stop method 
+  # The Tracker class that provides a start and a stop method
+  # This class has serveral callback methods
   class Tracker
+    extend StreamBot::Callbacks
+    callbacks :before_start, :before_match, :match_filter, :before_retweet
     # the initialization method aka the constructor
-    def initialize(params, blacklist, *keywords)
+    def initialize(params, blacklist, * keywords)
       LOG.debug("Tracker#initialize")
       http_auth = params['http']
-      @stream = TweetStream::Client.new(http_auth['username'],http_auth['password'])
+      @stream = TweetStream::Client.new(http_auth['username'], http_auth['password'])
+      @stream.on_error do |message|
+        LOG.error "#{message}"
+        @stream.stop
+      end
       # initializing retweet
       @retweet = StreamBot::Retweet.new(params)
       # get string with keywords comma separated keywords 
       @keywords=keywords.join(',')
       # set blacklist array if not nil
       @blacklist=blacklist
+      if !@blacklist.nil?
+        warn "blacklisting is deprecated and will be removed with streambot 0.6.0"
+      end
+      @filters = params['filters']
     end
-    
+
     # start the bot
     def start
+      before_start
       LOG.debug("Tracker#start")
       # starting to track the keywords via tweetstream
       @stream.track(@keywords) do |status|
+        # make status an instance variable for callbacks
+        @status = status
         username = status.user.screen_name
-        # if status.user is NOT in blacklist then retweet it
-        if !@blacklist.include?(username)
-          LOG.debug("Tracker#start - retweet ##{status.id} from @#{username}")
-          @retweet.retweet(status.id)
+        # if status.user is NOT in blacklist or filters don't match then retweet it
+        before_match
+        matched = false
+        if (@blacklist.nil? || !@blacklist.include?(username)) && !@filters.nil?
+          @filters.each do |key, value|
+            matched = match?(status, value)
+            if matched
+              match_filter
+              LOG.debug("Tracker#start - filter #{key} matched!")
+            end
+          end
+          if !matched
+            before_retweet
+            LOG.debug("Tracker#start - retweet ##{status.id} from @#{username}")
+            @retweet.retweet(status.id)
+          end
         end
-      end  
-    end  
-    
+      end
+    end
+
+    # returns true if an filter is matching
+    def match?(status, filter)
+      @type = filter["type"]
+      @value = filter["value"]
+      if @type == "USER" then
+        status.user.screen_name.eql?(@value)
+      elsif @type == "CONTENT" then
+        status.text.include?(@value)
+      elsif @type == "LANGUAGE" then
+        status.user.lang.eql?(@value)
+      end
+    end
+
     # stop the bot
     def stop
       @stream.stop
     end
   end
-end
+end

data/lib/streambot.rb

@@ -6,11 +6,12 @@ require 'tweetstream'
 require 'logger'
 require 'yaml'
 
-require 'streambot/tracker'
+require 'streambot/callbacks'
 require 'streambot/retweet'
 require 'streambot/handler'
 require 'streambot/http'
 require 'streambot/oauth'
+require 'streambot/tracker'
 
 module StreamBot  
   LOG = Logger.new(STDOUT)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: streambot
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
+  prerelease: true
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  - beta3
+  version: 0.5.0.beta3
 platform: ruby
 authors: 
 - Sascha Wessel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-06 00:00:00 +02:00
+date: 2010-08-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +26,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
         - 0
@@ -42,7 +41,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 0
         - 4
@@ -58,7 +56,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
@@ -74,7 +71,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
         segments: 
         - 0
         - 9
@@ -90,7 +86,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 1
         - 2
@@ -110,6 +105,7 @@ extra_rdoc_files:
 files: 
 - Rakefile
 - lib/streambot.rb
+- lib/streambot/callbacks.rb
 - lib/streambot/handler.rb
 - lib/streambot/http.rb
 - lib/streambot/oauth.rb
@@ -138,19 +134,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: