birdgrinder 0.1.3.1 → 0.1.4.0

data/bin/birdgrinder

@@ -26,5 +26,26 @@ BirdGrinder::Application.processing(ARGV) do |a|
     template 'hello_world_handler.erb', 'handlers/hello_world_handler.rb'
     template 'rakefile.erb', 'Rakefile'
   end
+  
+  a.add("authorize", "Gets oauth access token information making it possible to use oauth authentication") do |options|
+    puts "First, you need to create a twitter application and get a consumer key and secret."
+    puts "To do this, visit http://twitter.com/apps/new"
+    system("open", "http://twitter.com/apps/new") if yes?("Are you running OSX and wish to open this url now?")
+    consumer_key, consumer_secret = "", ""
+    consumer_key    = ask("What is your applications consumer key?", "")    while consumer_key.blank?
+    consumer_secret = ask("What is your applications consumer secret?", "") while consumer_secret.blank?
+    BirdGrinder::Settings.oauth.consumer_key    = consumer_key
+    BirdGrinder::Settings.oauth.consumer_secret = consumer_secret
+    oauth = BirdGrinder::Tweeter::OAuthAuthentication
+    rtoken = oauth.request_token
+    token, secret = rtoken.token, rtoken.secret
+    puts "To get a pin for your account, please visit: #{rtoken.authorize_url}"
+    system("open", rtoken.authorize_url) if yes?("Are you running OSX and wish to open this url now?")
+    value = ""
+    value = ask("What is the PIN twitter gave you?", "") while value.blank?
+    puts "Updating settings..."
+    oauth.retrieve_access_token!(token, secret, value)
+    puts "Done! - Your access token should now be stored"
+  end
 
 end

data/lib/bird_grinder.rb

@@ -8,7 +8,7 @@ require 'em-http'
 module BirdGrinder
   include Perennial
   
-  VERSION = [0, 1, 3, 1]
+  VERSION = [0, 1, 4, 0]
 
   def self.version(include_minor = false)
     VERSION[0, (include_minor ? 4 : 3)].join(".")

data/lib/bird_grinder/stream_handler.rb

@@ -9,7 +9,7 @@ module BirdGrinder
       # @param [Symbol] the stream name, e.g. :filter / :sample
       def tweet_from_stream(name, &blk)
         on_event(:incoming_stream) do
-          instance_eval(&blk) if options.streaming_source == name && options.stream_type == :tweet
+          instance_eval(&blk) if correct_stream?(name, :tweet)
         end
       end
       
@@ -17,7 +17,7 @@ module BirdGrinder
       # @param [Symbol] the stream name, e.g. :filter / :sample
       def delete_from_stream(name, &blk)
         on_event(:incoming_stream) do
-          instance_eval(&blk) if options.streaming_source == name && options.stream_type == :delete
+          instance_eval(&blk) if correct_stream?(name, :delete)
         end
       end
       
@@ -25,7 +25,7 @@ module BirdGrinder
       # @param [Symbol] the stream name, e.g. :filter / :sample
       def rate_limit_from_stream(name, &blk)
         on_event(:incoming_stream) do
-          instance_eval(&blk) if options.streaming_source == name && options.stream_type == :limit
+          instance_eval(&blk) if correct_stream?(name, :limit)
         end
       end
       
@@ -40,5 +40,11 @@ module BirdGrinder
       
     end 
     
+    protected
+    
+    def correct_stream?(name, type)
+      options.streaming_source == name && options.stream_type == type
+    end
+    
   end
 end

data/lib/bird_grinder/tweeter.rb

@@ -20,13 +20,14 @@ module BirdGrinder
     
     require 'bird_grinder/tweeter/streaming'
     require 'bird_grinder/tweeter/search'
+    require 'bird_grinder/tweeter/abstract_authorization'
+    require 'bird_grinder/tweeter/basic_authorization'
+    require 'bird_grinder/tweeter/oauth_authorization'
     
     VALID_FETCHES = [:direct_messages, :mentions]
     
     cattr_accessor :api_base_url
     self.api_base_url = "http://twitter.com/"
-      
-    attr_reader :auth_credentials
         
     # Initializes the tweeter with a given delegate. It will use
     # username and password from your settings file for authorization
@@ -35,7 +36,6 @@ module BirdGrinder
     # @param [Delegate] delegate the delegate class
     def initialize(delegate)
       check_auth!
-      @auth_credentials = [BirdGrinder::Settings.username, BirdGrinder::Settings.password]
       delegate_to delegate
     end
     
@@ -58,7 +58,7 @@ module BirdGrinder
       user = user.to_s.strip
       logger.info "Following '#{user}'"
       post("friendships/create.json", opts.merge(:screen_name => user)) do
-        delegate.receive_message(:outgoing_follow, {:user => user}.to_nash)
+        delegate.receive_message(:outgoing_follow, N(:user => user))
       end
     end
     
@@ -70,7 +70,7 @@ module BirdGrinder
       user = user.to_s.strip
       logger.info "Unfollowing '#{user}'"
       post("friendships/destroy.json", opts.merge(:screen_name => user)) do
-        delegate.receive_message(:outgoing_unfollow, {:user => user}.to_nash)
+        delegate.receive_message(:outgoing_unfollow, N(:user => user))
       end
     end
     
@@ -95,8 +95,8 @@ module BirdGrinder
       text = text.to_s.strip
       user = user.to_s.strip
       logger.debug "DM'ing #{user}: #{text}"
-      post("direct_messages/new.json", opts.merge(:user => user, :text => text)) do
-        delegate.receive_message(:outgoing_direct_message, {:user => user, :text => text}.to_nash)
+      post("direct_messages/new.json", opts.merge(:user => user, :text => text)) do |json|
+        delegate.receive_message(:outgoing_direct_message, status_to_args(json, :direct_message))
       end
     end
     
@@ -182,13 +182,18 @@ module BirdGrinder
         end
       else
         logger.info "Getting all followers for #{id}"
-        get_followers(id, opts.merge(:cursor => -1), {
+        get_followers(id, opts.merge(:cursor => -1), N({
           :user_id => id,
           :all     => true,
           :ids     => []
-        }.to_nash)
+        }))
       end
     end
+    
+    # @todo Use correct authorization method
+    def authorization_method
+      @authorization_method ||= (OAuthAuthorization.enabled? ? OAuthAuthorization : BasicAuthorization).new
+    end
         
     protected
     
@@ -214,10 +219,9 @@ module BirdGrinder
     end
     
     def get(path, params = {}, &blk)
-      http = request(path).get({
-        :head => {'Authorization' => @auth_credentials},
-        :query => params.stringify_keys
-      })
+      req = request(path)
+      http = req.get(:query => params)
+      authorization_method.add_header_to(http)
       add_response_callback(http, blk)
       http
     end
@@ -225,13 +229,12 @@ module BirdGrinder
     def post(path, params = {}, &blk)
       real_params = {}
       params.each_pair { |k,v| real_params[CGI.escape(k.to_s)] = CGI.escape(v) }
-      http = request(path).post({
-        :head => {
-          'Authorization' => @auth_credentials,
-          'Content-Type'  => 'application/x-www-form-urlencoded'
-        },
+      req = request(path)
+      http = req.post({
+        :head => {'Content-Type'  => 'application/x-www-form-urlencoded'},
         :body => real_params
       })
+      authorization_method.add_header_to(http)
       add_response_callback(http, blk)
       http
     end
@@ -276,9 +279,8 @@ module BirdGrinder
     end
     
     def check_auth!
-      if BirdGrinder::Settings["username"].blank? || BirdGrinder::Settings["username"].blank?
-        raise BirdGrinder::MissingAuthDetails, "Missing twitter username or password."
-      end
+      return if BirdGrinder::Settings.username? && BirdGrinder::Settings.password?
+      raise BirdGrinder::MissingAuthDetails, "Missing twitter username or password."
     end
     
   end

data/lib/bird_grinder/tweeter/abstract_authorization.rb

@@ -0,0 +1,19 @@
+module BirdGrinder
+  class Tweeter
+    class AbstractAuthorization
+      
+      is :loggable
+      
+      def add_header_to(http)
+        headers = (http.options[:head] ||= {})
+        headers['Authorization'] = self.header_for(http)
+      end
+      
+      def header_for(http)
+        raise NotImplementedError
+      end
+      
+    end
+  end
+end
+  

data/lib/bird_grinder/tweeter/basic_authorization.rb

@@ -0,0 +1,23 @@
+module BirdGrinder
+  class Tweeter
+    class BasicAuthorization < AbstractAuthorization
+      
+      def initialize
+        @basic_auth_credentials = [BirdGrinder::Settings.username, BirdGrinder::Settings.password]
+      end
+      
+      attr_reader :basic_auth_credentials
+      
+      # Authenticats a given request using Basic authorization.
+      def header_for(http)
+        @basic_auth_credentials
+      end
+      
+      protected
+      
+      def generate_header!
+      end
+      
+    end
+  end
+end

data/lib/bird_grinder/tweeter/oauth_authorization.rb

@@ -0,0 +1,54 @@
+require 'oauth'
+require 'em-http-oauth-request'
+
+module BirdGrinder
+  class Tweeter
+    class OAuthAuthorization< AbstractAuthorization
+      
+      # Authenticates a given request.
+      def header_for(request)
+        OAuth::Client::Helper.new(request, {
+          :token    => self.class.oauth_access_token,
+          :consumer => self.class.oauth_consumer
+        }).header
+      end
+      
+      def self.enabled?
+        oauth = BirdGrinder::Settings.oauth
+        oauth.present? && [:consumer_key, :consumer_secret, :access_token_token, :access_token_secret].all? { |k| oauth[k].present? }
+      end
+      
+      # From the twitter gem, with modification
+      def self.retrieve_access_token!(raw_request_token, request_secret, pin)
+        request_token = OAuth::RequestToken.new(self.oauth_consumer, raw_request_token, request_secret)
+        access_token  = request_token.get_access_token(:oauth_verifier => pin)
+        original_settings = BirdGrinder::Settings.oauth.to_hash
+        original_settings.merge! :access_token_token => access_token.token,
+                                 :access_token_secret => access_token.secret
+        BirdGrinder::Settings.update! :oauth => original_settings.stringify_keys
+      end
+      
+      def self.request_token
+        @request_token ||= self.oauth_consumer.get_request_token
+      end
+      
+      protected
+      
+      def self.oauth_consumer
+        @oauth_consumer ||= begin
+          settings = BirdGrinder::Settings.oauth
+          site = Tweeter.api_base_url.gsub(/\/$/, '')
+          OAuth::Consumer.new(settings.consumer_key, settings.consumer_secret, :site => site)
+        end
+      end
+      
+      def self.oauth_access_token
+        @oauth_access_token ||= begin
+          settings = BirdGrinder::Settings.oauth
+          OAuth::AccessToken.new(self.oauth_consumer, settings.access_token_token, settings.access_token_secret)
+        end
+      end
+      
+    end
+  end
+end

data/lib/bird_grinder/tweeter/streaming.rb

@@ -40,19 +40,20 @@ module BirdGrinder
       # Start processing the filter stream with a given follow
       # argument.
       #
-      # @param [Array] args what to follow, joined with ","
+      # @param [Array] args what to follow, joined with "," followed by opts
       def follow(*args)
         opts = args.extract_options!
-        opts[:follow] = args.join(",")
+        opts[:follow] = args.flatten.join(",")
         opts[:path] = :filter
         stream(:follow, opts)
       end
       
       # Starts tracking a specific query.
       # 
-      # @param [Hash] opts extra options for the query
-      def track(query, opts = {})
-        opts[:track] = query
+      # @param [Array] args what to track, joined with "," followed by opts
+      def track(*args)
+        opts = args.extract_options!
+        opts[:track] = args.flatten.join(",")
         opts[:path] = :filter
         stream(:track, opts)
       end

data/lib/bird_grinder/tweeter/streaming_request.rb

@@ -45,7 +45,8 @@ module BirdGrinder
         logger.debug "Preparing to start stream"
         @stream_processor = nil
         type = request_method
-        http = EventMachine::HttpRequest.new(full_url).send(type, http_options(type))
+        http = EventMachine::HttpRequest.new(full_url).send(type, http_options(type, request))
+        authorization_method.add_header_to(http)
         # Handle failures correctly so we can back off
         @current_request = http
         http.errback  { fail!(:network)}
@@ -100,21 +101,22 @@ module BirdGrinder
       # what method is used to send the request. It's important that
       # this is used for credentials as well as making sure there is
       # no timeout on the connection
-      def default_request_options
-        {:head => {'Authorization' => @parent.auth_credentials}, :timeout => 0}
+      def default_request_options(r)
+        {:timeout => 0, :head => {}}
       end
       
       # Returns normalized http options for the current request, built
       # on top of default_request_options and a few other details.
       #
       # @param [Symbol] type the type of request - :post or :get
-      def http_options(type)
+      # @param [EventMachine::HttpRequest] the request itself
+      def http_options(type, request)
         base = self.default_request_options
         if @options.present?
           if type == :get
             base[:query] = @options
           else
-            base[:head].merge! 'Content-Type'  => "application/x-www-form-urlencoded"
+            base[:head]['Content-Type'] = "application/x-www-form-urlencoded"
             base[:body] = body = {}
             @options.each_pair { |k,v| body[CGI.escape(k.to_s)] = CGI.escape(v) }
           end
@@ -136,6 +138,10 @@ module BirdGrinder
         @full_url ||= (Streaming.streaming_base_url / Streaming.api_version.to_s / "statuses" / "#{@path}.json")
       end
       
+      def authorization_method
+        @authorization_method ||= BasicAuthorization.new
+      end
+      
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: birdgrinder
 version: !ruby/object:Gem::Version 
-  version: 0.1.3.1
+  version: 0.1.4.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-08 00:00:00 +08:00
+date: 2009-12-29 00:00:00 +08:00
 default_executable: birdgrinder
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.8
     version: 
+- !ruby/object:Gem::Dependency 
+  name: moneta
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-oauth-request
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
 description: 
 email: sutto@sutto.net
 executables: 
@@ -71,6 +91,9 @@ files:
 - lib/bird_grinder/loader.rb
 - lib/bird_grinder/queue_processor.rb
 - lib/bird_grinder/stream_handler.rb
+- lib/bird_grinder/tweeter/abstract_authorization.rb
+- lib/bird_grinder/tweeter/basic_authorization.rb
+- lib/bird_grinder/tweeter/oauth_authorization.rb
 - lib/bird_grinder/tweeter/search.rb
 - lib/bird_grinder/tweeter/stream_processor.rb
 - lib/bird_grinder/tweeter/streaming.rb