streambot 0.2.2 → 0.2.3

data/lib/retweet.rb

@@ -1,6 +1,8 @@
 require 'net/http'
 require 'open-uri'
 
+# wrapper class for dealing with twitters native retweet api
+# it simply connects to twitter api via http basic auth with given credentials
 class Retweet
   
   # intitialize method aka constructor
@@ -13,12 +15,15 @@ class Retweet
   def retweet(id)
     url = URI.parse("http://api.twitter.com/1/statuses/retweet/#{id}.json")
     req = Net::HTTP::Post.new(url.path)
+    # set credentials
     req.basic_auth @auth[:username],@auth[:password]
+    # connect
     res = Net::HTTP.new(url.host, url.port).start {|http| http.request(req) }
     case res
-      when Net::HTTPSuccess, Net::HTTPRedirection
       #OK
+      when Net::HTTPSuccess, Net::HTTPRedirection
     else
+      # when connection wasn't successful print error message
       res.error!
     end
   end

data/lib/streambot.rb

@@ -2,27 +2,33 @@ require 'rubygems'
 require 'tweetstream'
 require 'retweet'
 
+# The StreamBot class that provides a start and a stop method 
 class StreamBot
   
-  # initialize method aka constructor  
-  def initialize(auth, blacklist=nil, *keywords)
+  # the initialization method aka the constructor
+  def initialize(auth, blacklist, *keywords)
     @stream = TweetStream::Client.new(auth[:username],auth[:password])
-    @retweet = Retweet.new(auth)
+    # initializing retweet
+    @retweet = Retweet.new(auth) #
+    # get string with keywords comma separated keywords 
     @keywords=keywords.join(',')
-    @blacklist=blacklist if !blacklist.nil?
+    # set blacklist array if not nil
+    @blacklist=blacklist
   end
   
-  # starts the bot
+  # start the bot
   def start
+    # starting to track the keywords via tweetstream
     @stream.track(@keywords) do |status|
-      if !@blacklist.include?(status.user)
-        #puts "#{status.text} - #{status.id}"
+      # if status.user is NOT in blacklist then retweet it
+      if !@blacklist.include?(status.user) 
+         #puts "#{status.text}"
         @retweet.retweet(status.id)
       end
     end  
   end  
   
-  # stop bot
+  # stop the bot
   def stop
     @stream.stop
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Sascha Wessel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 +02:00
+date: 2010-04-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency