streambot 0.3.0 → 0.4.0

data/README.rdoc

@@ -12,12 +12,39 @@ to get streambot installed, you simply need to run
 == Usage
 
 	require 'streambot'
-	
-	@auth = {:username=>'username',:password=>'password'}
+
+	@params = {"auth_type" => "oauth",
+	    "oauth" => {"key" => "consumer key", "secret" => "consumer secret"},
+	    "http" => {"username" => "username", "password" => "password"}
+	}
 	@blacklist = ['mac_rt','apple_rt']
-	bot = StreamBot::Tracker.new(@auth, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
+	bot = StreamBot::Tracker.new(@params, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
 	bot.start
-	
+
+=== 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. 
+
+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.
+
+==== auth_type
+The auth type is the authentication mechanism you want to use for retweeting.
+*oauth* or *http*
+
+==== oauth
+*Warning!* You need to register an application of the type desktop application on http://dev.twitter.com first!
+
+*key*:: The consumer key Twitter provides you
+*secret*:: The consumer secret Twitter provides you
+
+==== http
+*username*:: Your login username
+*password*:: Your login password
+
+I wrote this stuff into my config.yml and load the params with 
+
+	require 'yaml'
+	@params = YAML.load_file('config.yml')
 
 == Contribution
 === Testing
@@ -42,4 +69,4 @@ You want to add a feature or you want to patch streambot?
 
 == Copyright
 
-Copyright (c) 2010 Sascha Wessel. See LICENSE for details.
+Copyright (c) 2010 Sascha Wessel. See LICENSE for details.

data/Rakefile

@@ -16,8 +16,10 @@ begin
     
     # Dependency for dealing with twitter streaming API
     gem.add_dependency "tweetstream",">= 1.0.4"
+    gem.add_dependency "oauth",">= 0.4.0"
     gem.add_development_dependency "webmock",">= 1.0.0"
     gem.add_development_dependency "rcov",">= 0.9.8"
+    gem.add_development_dependency "reek",">= 1.2.8"
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -46,7 +48,7 @@ rescue LoadError
 end
 
 task :build_gem => [:test,:rdoc,:build]
-task :default => [:check_dependencies,:rcov,:build_gem]
+task :default => [:check_dependencies,:rcov,:reek,:build_gem]
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
@@ -56,3 +58,9 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+  t.verbose = true
+end

data/lib/streambot.rb

@@ -1,12 +1,16 @@
 require 'rubygems'
 require 'open-uri'
 require 'net/http'
+require 'oauth'
 require 'tweetstream'
 require 'logger'
+require 'yaml'
 
 require 'streambot/tracker'
 require 'streambot/retweet'
+require 'streambot/handler'
 require 'streambot/http'
+require 'streambot/oauth'
 
 module StreamBot  
   LOG = Logger.new(STDOUT)

data/lib/streambot/handler.rb

@@ -0,0 +1,16 @@
+module StreamBot
+  # :nodoc:
+  class Handler
+    # parse an response 
+    def parse_response(object)
+      LOG.debug("response is #{object}")
+      case object
+        when ::Net::HTTPUnauthorized
+          ::File.delete(ACCESS_TOKEN)
+          raise 'user revoked oauth connection'
+        when ::Net::HTTPOK then
+          object.body
+      end
+    end
+  end
+end

data/lib/streambot/http.rb

@@ -1,28 +1,58 @@
 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)
+  class HTTP < StreamBot::Handler
+    BASE_URL = "http://api.twitter.com"
+    # intialize http communication wrapper
+    def initialize(auth)
+      @auth = auth
+    end
+
+    # post data to twitter api
+    #
+    #   path takes the path like
+    #     '/statuses/update.format'
+    #
+    #   the body contains all data you send to twitter
+    #     {:status => "a new status"}
+    #
+    def post(path, body)
+      LOG.debug("post #{body} to \"#{path}\"")
+      request = init_request(path, :post)
+      request.body = body if !body.nil?
+      do_request(request)
+    end
+
+    # get data from twitter api
+    #
+    #   path takes the path like
+    #     '/statuses/user_timeline.format'
+    #
+    def get(path)
+      LOG.debug("get data form \"#{path}\"")
+      request = init_request(path, :get)
+      do_request(request)
     end
 
     private
-    # send request
-    def post_request(request, url)
-      Net::HTTP.new(url.host, url.port).start do |http|
-        LOG.debug("#{http.inspect}")
+    def do_request(request)
+      request.basic_auth @auth['username'], @auth['password']
+      response = Net::HTTP.new(@uri.host, @uri.port).start do |http|
         http.request(request)
       end
+      parse_response(response)
     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)
+    # initialize an Net::HTTP::GET or Net::HTTP::POST request
+    # depends on type param
+    def init_request(path, type)
+      @url = "#{BASE_URL}#{path}"
+      @uri = URI.parse(@url)
+      case type
+        when :post then
+          Net::HTTP::Post.new(@uri.path)
+        when :get then
+          Net::HTTP::Get.new(@uri.path)
+      end
     end
   end
 end

data/lib/streambot/oauth.rb

@@ -0,0 +1,76 @@
+module StreamBot
+  # oauth communication wrapper
+  class OAuth < StreamBot::Handler
+    TWITTER_OAUTH_SPEC = {
+            :site => 'http://api.twitter.com',
+            :request_token_pat1h => '/oauth/request_token',
+            :access_token_path => '/oauth/access_token',
+            :authorize_path => '/oauth/authorize'
+    }
+
+    ACCESS_TOKEN = 'access_token.yml'
+
+    # :nodoc:
+    def initialize(auth)
+      @auth = auth      
+      @oauth_consumer = ::OAuth::Consumer.new(@auth['key'], @auth['secret'], TWITTER_OAUTH_SPEC)
+      get_access_token
+    end
+
+    # post data to twitter api
+    #
+    #   url takes the path like
+    #     '/statuses/update.format'
+    #
+    #   the body contains all data you send to twitter
+    #     {:status => "a new status"}
+    #
+    def post(path, body)
+      LOG.debug("post #{body} to \"#{path}\"")
+      response = @access_token.post(path, body)
+      parse_response(response)
+    end
+
+    # get data from twitter api
+    #
+    #   path takes the path like
+    #     '/statuses/user_timeline.format'
+    #
+    def get(path)
+      LOG.debug("get data form \"#{path}\"")
+      response = @access_token.get(path)
+      parse_response(response)
+    end
+
+    private
+    # get the request token from oauth consumer
+    def get_request_token
+      @oauth_consumer.get_request_token
+    end
+
+    # get the access token
+    def get_access_token
+      # get saved access token
+      if ::File.exists?(ACCESS_TOKEN)
+        @access_token = ::YAML.load_file(ACCESS_TOKEN)
+      end
+      # if access token is nil,
+      # then get a new initial token
+      if @access_token.nil?
+        get_initial_token
+        ::File.open(ACCESS_TOKEN, 'w') do |out|
+          YAML.dump(@access_token, out)
+        end
+      end
+    end
+
+    # get the initial access token
+    def get_initial_token
+      @request_token = get_request_token
+      puts "Place \"#{@request_token.authorize_url}\" in your browser"
+      print "Enter the number they give you: "
+      pin = STDIN.readline.chomp
+      @access_token = @request_token.get_access_token(:oauth_verifier => pin)
+    end
+  end
+end

data/lib/streambot/retweet.rb

@@ -1,24 +1,19 @@
 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
+    def initialize(params)
+      auth_type = params['auth_type']
+      auth_params = params[auth_type]
+      case auth_type
+        when "oauth" then @handler = StreamBot::OAuth.new(auth_params)
+        when "http" then @handler = StreamBot::HTTP.new(auth_params)
+      end
     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
+      @handler.post("/statuses/retweet/#{id}.json",nil)
     end
   end
 end

data/lib/streambot/tracker.rb

@@ -2,11 +2,12 @@ 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])
+    def initialize(params, blacklist, *keywords)
+      LOG.debug("Tracker#initialize")
+      http_auth = params['http']
+      @stream = TweetStream::Client.new(http_auth['username'],http_auth['password'])
       # initializing retweet
-      @retweet = StreamBot::Retweet.new(auth) #
+      @retweet = StreamBot::Retweet.new(params)
       # get string with keywords comma separated keywords 
       @keywords=keywords.join(',')
       # set blacklist array if not nil
@@ -15,13 +16,13 @@ module StreamBot
     
     # start the bot
     def start
-      LOG.debug("#{self.class}#start")
+      LOG.debug("Tracker#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}")
+          LOG.debug("Tracker#start - retweet ##{status.id} from @#{username}")
           @retweet.retweet(status.id)
         end
       end  

data/test/streambot/test_http.rb

@@ -5,23 +5,24 @@ module StreamBot
   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)
+      super
+      WebMock.disable_net_connect!
+      @http = StreamBot::HTTP.new(@params['http'])
+      stub_request(:post, "http://#{@params['http']['username']}:#{@params['http']['password']}@api.twitter.com/path/to/data").to_return(:body => "response")
+    end
+
+    # test a post with basic authentication
+    def test_post
+      res = @http.post('/path/to/data',nil)
+      assert_not_nil(res)
+      assert_equal("response", res)
     end
 
     # nil all variables
     def teardown
       @http = nil
+      WebMock.allow_net_connect!
     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_oauth.rb

@@ -0,0 +1,31 @@
+require 'streambot/base_test'
+
+module StreamBot
+  # test for http wrapper class
+  class TestOAuth < StreamBot::BaseTest
+    # setup
+    def setup
+      super
+      WebMock.allow_net_connect!
+      @oauth = StreamBot::OAuth.new(@params['oauth'])
+      stub_request(:post,"http://api.twitter.com/statuses/update.json").to_return(:body=>"response")
+    end
+
+    def test_verify_credentials
+      json = @oauth.get('/account/verify_credentials.json')
+      assert_not_nil(json)
+    end
+
+    def test_post
+      WebMock.disable_net_connect!
+      json = @oauth.post('/statuses/update.json',{:status => 'test'})
+      assert_not_nil(json)
+      assert_equal("response",json)
+    end
+
+    # nil all variables
+    def teardown
+      @oauth = nil
+    end
+  end
+end

data/test/streambot/test_retweet.rb

@@ -6,17 +6,15 @@ module StreamBot
     # 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')
+      @retweet = StreamBot::Retweet.new(@params)
+      if @params['auth_type'] == "oauth"
+        stub_request(:post, "http://api.twitter.com/statuses/retweet/12355936428.json").to_return(:body => "response")
+      elsif @params['auth_type'] == "http"
+        stub_request(:post, "http://#{@params['http']['username']}:#{@params['http']['password']}@api.twitter.com/statuses/retweet/12355936428.json").to_return(:body => "response")
+      end
     end
 
-    # teardown the test
-    # nil all instance variables
-    def teardown
-      @id, @retweet = nil
-    end
-
-    # retweet 
+    # retweet
     def test_retweet
       # no permission to access web!
       WebMock.disable_net_connect!
@@ -24,7 +22,13 @@ module StreamBot
       response = @retweet.retweet(@id)
       # assertion
       assert_not_nil(response)
-      assert_equal('content', response.body)
+      assert_equal("response", response)
+    end
+
+    # teardown the test
+    # nil all instance variables
+    def teardown
+      @id, @retweet = nil
     end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: streambot
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sascha Wessel
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 +02:00
+date: 2010-06-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: tweetstream
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 1
         - 0
@@ -32,33 +35,69 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: oauth
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 43
         segments: 
         - 0
         - 9
         - 8
         version: 0.9.8
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id005
 description: a simple gem that tracks several keywords via twitter streaming api and re-publish it on twitter
 email: swessel@gr4yweb.de
 executables: []
@@ -71,53 +110,56 @@ extra_rdoc_files:
 files: 
 - Rakefile
 - lib/streambot.rb
+- lib/streambot/handler.rb
 - lib/streambot/http.rb
+- lib/streambot/oauth.rb
 - lib/streambot/retweet.rb
 - lib/streambot/tracker.rb
 - LICENSE
 - README.rdoc
+- test/streambot/base_test.rb
+- test/streambot/test_oauth.rb
+- test/streambot/test_retweet.rb
+- test/streambot/test_http.rb
 has_rdoc: true
 homepage: http://github.com/gr4y/streambot
 licenses: []
 
-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] "
+post_install_message: "=== You are upgrading from an earlier version?\n\n\
+  Then you maybe need to change your code.\n\
+  In version 0.4.0 oauth was introduced and I recommend you to read the README\n\n\
+  code is available on github[http://github.com/gr4y/streambot] "
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   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"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: retweeting tweets with specified keywords on twitter
 test_files: 
 - test/streambot/base_test.rb
+- test/streambot/test_oauth.rb
 - test/streambot/test_retweet.rb
 - test/streambot/test_http.rb