streambot 0.2.5 → 0.3.0

data/README.rdoc

@@ -1,28 +1,37 @@
 = streambot
 
-streambot is using tweetstream (http://github.com/intridea/tweetstream) for simple access to twitter streaming api
+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
+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	
+		
 == Usage
 
 	require 'streambot'
 	
 	@auth = {:username=>'username',:password=>'password'}
 	@blacklist = ['mac_rt','apple_rt']
-	bot = StreamBot.new(@auth, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
+	bot = StreamBot::Tracker.new(@auth, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
 	bot.start
 	
-== Todo
+
+== Contribution
+=== Testing
+ 
+All Tests should inherit from StreamBot::BaseTest
 	
-All todos are listed in issue-tracker and labeled with todo (http://github.com/gr4y/streambot/issues/labels/todo) 
+=== Feature Requests / Issues
+
+If you ran into some errors? Then don't be shy and file an issue in the issue-tracker[http://github.com/gr4y/streambot/issues]
+Maybe you have a feature request then file an issue too.
 	
-== Note on Patches/Pull Requests
- 
+=== Note on Patches/Pull Requests
+
+You want to add a feature or you want to patch streambot? 
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -33,4 +42,4 @@ All todos are listed in issue-tracker and labeled with todo (http://github.com/g
 
 == Copyright
 
-Copyright (c) 2010 Sascha Wessel. See LICENSE for details.
+Copyright (c) 2010 Sascha Wessel. See LICENSE for details.

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "swessel@gr4yweb.de"
     gem.homepage = "http://github.com/gr4y/streambot"
     gem.authors = ["Sascha Wessel"]
+    gem.post_install_message = File.exist?('USAGE.rdoc') ? File.read('USAGE.rdoc') : ""
     gem.require_path = 'lib'
     gem.files = %w(Rakefile) + Dir.glob("{lib}/**/*")
     
@@ -17,6 +18,7 @@ begin
     gem.add_dependency "tweetstream",">= 1.0.4"
     gem.add_development_dependency "webmock",">= 1.0.0"
     gem.add_development_dependency "rcov",">= 0.9.8"
+    
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/lib/streambot.rb

@@ -1,36 +1,15 @@
 require 'rubygems'
+require 'open-uri'
+require 'net/http'
 require 'tweetstream'
-require 'retweet'
+require 'logger'
 
-# The StreamBot class that provides a start and a stop method 
-class StreamBot
-  
-  # the initialization method aka the constructor
-  def initialize(auth, blacklist, *keywords)
-    @stream = TweetStream::Client.new(auth[:username],auth[:password])
-    # initializing retweet
-    @retweet = Retweet.new(auth) #
-    # get string with keywords comma separated keywords 
-    @keywords=keywords.join(',')
-    # set blacklist array if not nil
-    @blacklist=blacklist
-  end
-  
-  # start the bot
-  def start
-    # starting to track the keywords via tweetstream
-    @stream.track(@keywords) do |status|
-      # if status.user is NOT in blacklist then retweet it
-      if !@blacklist.include?(status.user.screen_name) 
-         #puts "#{status.text} ##{status.id}"
-        @retweet.retweet(status.id)
-      end
-    end  
-  end  
-  
-  # stop the bot
-  def stop
-    @stream.stop
-  end
-  
-end
+require 'streambot/tracker'
+require 'streambot/retweet'
+require 'streambot/http'
+
+module StreamBot  
+  LOG = Logger.new(STDOUT)
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+end

data/lib/streambot/http.rb

@@ -0,0 +1,28 @@
+module StreamBot
+  # http communication wrapper
+  class HTTP
+    # initialize request with basic authentication and send
+    def post_with_auth(auth, url)
+      uri = URI.parse(url)
+      request = init_request(uri)
+      request.basic_auth auth[:username], auth[:password]
+      post_request(request, uri)
+    end
+
+    private
+    # send request
+    def post_request(request, url)
+      Net::HTTP.new(url.host, url.port).start do |http|
+        LOG.debug("#{http.inspect}")
+        http.request(request)
+      end
+    end
+
+    # initialize an Net::HTTP::Post Request
+    def init_request(url)
+      LOG.debug("#{self.class}#init_request(#{url})")
+      puts url.inspect
+      Net::HTTP::Post.new(url.path)
+    end
+  end
+end

data/lib/streambot/retweet.rb

@@ -0,0 +1,24 @@
+module StreamBot
+  # wrapper class for dealing with twitters native retweet api
+  class Retweet
+    # api base url   
+    $BASE_URL = "http://api.twitter.com/1/" 
+    
+    # intitialize method aka constructor
+    def initialize(auth)
+      @auth = auth
+      @http = StreamBot::HTTP.new
+    end
+    
+    # retweets the status with given id
+    def retweet(id)
+      LOG.debug("#{self.class}#retweet")
+      res = @http.post_with_auth(@auth, "#{$BASE_URL}statuses/retweet/#{id}.json")
+      case res
+        when Net::HTTPSuccess then return res
+      else 
+        res.error!
+      end
+    end
+  end
+end

data/lib/streambot/tracker.rb

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

data/test/streambot/base_test.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'test/unit'
+require 'webmock'
+require 'yaml'
+include WebMock
+
+require 'streambot'
+
+module StreamBot
+  # The base of all tests in this projet
+  #
+  #   class TestName < StreamBot::BaseTest
+  #  
+  #     def setup 
+  #       super
+  #       # implementation goes here
+  #     end
+  #   end
+  class BaseTest < Test::Unit::TestCase
+
+    # reading config.yml and assign all keys to instance
+    def read_config
+      yml_config = YAML.load_file(File.dirname(__FILE__) + "/config.yml")
+      yml_config.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # :nodoc:
+    def setup
+      self.read_config
+    end
+  end
+end

data/test/streambot/test_http.rb

@@ -0,0 +1,27 @@
+require 'streambot/base_test'
+
+module StreamBot
+  # test for http wrapper class
+  class TestHttp < StreamBot::BaseTest
+    # setup 
+    def setup
+      @http = StreamBot::HTTP.new
+      # override auth
+      @auth = {:username=>'test', :password=>'test'}
+      stub_request(:post, "http://test:test@testing.com/path/to/data").to_return(:body => @auth)
+    end
+
+    # nil all variables
+    def teardown
+      @http = nil
+    end
+
+    # test a post with basic authentication
+    def test_post
+      WebMock.disable_net_connect!
+      res = @http.post_with_auth(@auth, 'http://testing.com/path/to/data')
+      assert_not_nil(res)
+      assert_equal(@auth, res.body)
+    end
+  end
+end

data/test/streambot/test_retweet.rb

@@ -0,0 +1,30 @@
+require 'streambot/base_test'
+
+module StreamBot
+  # the test for testing retweet functionality
+  class TestRetweet < StreamBot::BaseTest
+    # setup the test 
+    def setup
+      super
+      @retweet = StreamBot::Retweet.new(@auth)
+      stub_request(:post, "http://#{@auth[:username]}:#{@auth[:password]}@api.twitter.com/1/statuses/retweet/#{@id}.json").to_return(:body => 'content')
+    end
+
+    # teardown the test
+    # nil all instance variables
+    def teardown
+      @id, @retweet = nil
+    end
+
+    # retweet 
+    def test_retweet
+      # no permission to access web!
+      WebMock.disable_net_connect!
+      # retweet the given id
+      response = @retweet.retweet(@id)
+      # assertion
+      assert_not_nil(response)
+      assert_equal('content', response.body)
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sascha Wessel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-23 00:00:00 +02:00
+date: 2010-05-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,15 +70,28 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - Rakefile
-- lib/retweet.rb
 - lib/streambot.rb
+- lib/streambot/http.rb
+- lib/streambot/retweet.rb
+- lib/streambot/tracker.rb
 - LICENSE
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/gr4y/streambot
 licenses: []
 
-post_install_message: 
+post_install_message: "\n\
+  === You are upgrading from an earlier version?\n\n\
+  Maybe you need to change your code a little bit\n\
+  \t\n\
+  === A simple example how to use streambot\n\n\
+  \trequire 'streambot'\n\n\
+  \t@auth = {:username=>'username',:password=>'password'}\n\
+  \t@blacklist = ['mac_rt','apple_rt']\n\
+  \tbot = StreamBot::Tracker.new(@auth, @blacklist, 'apple','ipad','iphone os 4','steve jobs')\n\
+  \tbot.start\n\n\
+  === streambot is an open source project\n\n\
+  the code is available on github[http://github.com/gr4y/streambot] "
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -105,6 +118,6 @@ signing_key:
 specification_version: 3
 summary: retweeting tweets with specified keywords on twitter
 test_files: 
-- test/base_test.rb
-- test/test_streambot.rb
-- test/test_retweet.rb
+- test/streambot/base_test.rb
+- test/streambot/test_retweet.rb
+- test/streambot/test_http.rb

data/lib/retweet.rb

@@ -1,29 +0,0 @@
-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
-  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)
-    # 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 then return res
-    else 
-      res.error!
-    end
-  end
-  
-end

data/test/base_test.rb

@@ -1,35 +0,0 @@
-require 'rubygems'
-require 'yaml'
-require 'test/unit'
-require 'webmock'
-
-include WebMock
-
-# The base of all tests in this projet
-# New Testcases need to look like this:
-#
-#
-# class TestName < BaseTest
-#  
-#  def setup 
-#    super
-#    # implementation goes here
-#  end
-#  
-# end
-class BaseTest < Test::Unit::TestCase
-  
-  # reading config.yml and assign all keys to instance
-  def read_config  
-    yml_config = YAML.load_file(File.dirname(__FILE__) + "/config.yml")
-    yml_config.each do |key, value| 
-      instance_variable_set("@#{key}", value)
-    end
-  end
-  
-  # :nodoc:
-  def setup
-    self.read_config
-  end
-  
-end

data/test/test_retweet.rb

@@ -1,32 +0,0 @@
-require 'retweet'
-require 'base_test'
-
-# the test for testing retweet functionality
-class TestRetweet <  BaseTest
-  
-  # setup the test 
-  def setup  
-    super
-    @id = 12355936428
-    @retweet = Retweet.new(@auth)
-    stub_request(:post, "http://#{@auth[:username]}:#{@auth[:password]}@api.twitter.com/1/statuses/retweet/#{@id}.json").to_return(:body => 'content')
-  end
-  
-  # teardown the test
-  # nil all instance variables
-  def teardown
-    @id, @retweet = nil
-  end
-  
-  # retweet 
-  def test_retweet
-    # no permission to access web!
-    WebMock.disable_net_connect!
-    # retweet the given id
-    response = @retweet.retweet(@id)
-    # assertion
-    assert_not_nil(response) 
-    assert_equal('content',response.body)    
-  end
-  
-end

data/test/test_streambot.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-
-class TestStreambot < Test::Unit::TestCase
-  
-  def test_for_truth
-    assert true
-  end
-  
-end