streambot 0.2.1 → 0.2.2

data/README.rdoc

@@ -1,22 +1,25 @@
 = streambot
 
-streambot is using (http://github.com/intridea/tweetstream) for simple access to twitter streaming api
-streambot is still far away from production usage
+streambot is using tweetstream (http://github.com/intridea/tweetstream) for simple access to twitter streaming api
 
 == Installation
 
+the streambot gem is available on rubygems.org - http://rubygems.org/gems/streambot
+
 	gem install streambot
 	
 == Usage
 
 	require 'streambot'
 	
-	bot = StreamBot.new({:username=>'username',:password=>'password'},'apple','ipad','iphone os 4','steve jobs')
+	@auth = {:username=>'username',:password=>'password'}
+	@blacklist = ['mac_rt','apple_rt']
+	bot = StreamBot.new(@auth, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
 	bot.start
 	
 == Todo
 	
-* oauth authentication
+All todos are listed in issue-tracker and labeled with todo (http://github.com/gr4y/streambot/issues/labels/todo) 
 	
 == Note on Patches/Pull Requests
  

data/lib/retweet.rb

@@ -3,11 +3,13 @@ require 'open-uri'
 
 class Retweet
   
+  # intitialize method aka constructor
   def initialize(auth)
     return if auth.nil?
     @auth = auth 
   end
   
+  # retweets the status with given id
   def retweet(id)
     url = URI.parse("http://api.twitter.com/1/statuses/retweet/#{id}.json")
     req = Net::HTTP::Post.new(url.path)

data/lib/streambot.rb

@@ -4,19 +4,25 @@ require 'retweet'
 
 class StreamBot
   
-  def initialize(auth, *keywords)
+  # initialize method aka constructor  
+  def initialize(auth, blacklist=nil, *keywords)
     @stream = TweetStream::Client.new(auth[:username],auth[:password])
     @retweet = Retweet.new(auth)
     @keywords=keywords.join(',')
+    @blacklist=blacklist if !blacklist.nil?
   end
   
+  # starts the bot
   def start
     @stream.track(@keywords) do |status|
-      puts "#{status.text} - #{status.id}"
-      @retweet.retweet(status.id)
+      if !@blacklist.include?(status.user)
+        #puts "#{status.text} - #{status.id}"
+        @retweet.retweet(status.id)
+      end
     end  
   end  
   
+  # stop bot
   def stop
     @stream.stop
   end

metadata

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