birdgrinder 0.1.2.1 → 0.1.3.0

data/bin/birdgrinder

@@ -13,14 +13,11 @@ BirdGrinder::Application.processing(ARGV) do |a|
 
   a.option(:force, "force the creation of the application")
   a.add("create PATH", "Creates a BirdGrinder instance at a specified location") do |path, options|
-    
     path = File.expand_path(path)
     if File.exists?(path) && !options[:force]
       die! "The path you tried to use, #{path}, already exists. Please try another or use the --force option"
     end
-    
     setup_generator path
-    
     folders 'tmp', 'config', 'handlers', 'test'
     template 'boot.erb', 'config/boot.rb'
     template 'setup.erb', 'config/setup.rb'
@@ -28,7 +25,6 @@ BirdGrinder::Application.processing(ARGV) do |a|
     template 'debug_handler.erb', 'handlers/debug_handler.rb'
     template 'hello_world_handler.erb', 'handlers/hello_world_handler.rb'
     template 'rakefile.erb', 'Rakefile'
-    
   end
 
 end

data/lib/bird_grinder.rb

@@ -8,7 +8,7 @@ require 'em-http'
 module BirdGrinder
   include Perennial
   
-  VERSION = [0, 1, 2, 1]
+  VERSION = [0, 1, 3, 0]
 
   def self.version(include_minor = false)
     VERSION[0, (include_minor ? 4 : 3)].join(".")
@@ -21,9 +21,10 @@ module BirdGrinder
     l.register_controller :console, 'BirdGrinder::Console'
   end
   
-  has_library :cacheable, :tweeter, :client, :base, :command_handler,
-              :console, :queue_processor, :stream_handler
+  has_library :cacheable, :tweeter, :client, :base, :command_handler, :console, :stream_handler
   
   extends_library :loader
   
+  autoload :QueueProcessor, 'bird_grinder/queue_processor'
+  
 end

data/lib/bird_grinder/command_handler.rb

@@ -59,7 +59,7 @@ module BirdGrinder
         end
       else
         logger.debug "Checking for command in direct message"
-        command, data = options.text.split(" ", 2)
+        command, data = options.text.split(/\s+/, 2)
       end
       if (command_name = extract_command_name(command)).present?
         logger.info "Processing command '#{command_name}' for #{user}"

data/lib/bird_grinder/tweeter/streaming.rb

@@ -15,6 +15,9 @@ module BirdGrinder
       
       attr_accessor  :parent
       
+      # Initializes a streaming subclient for a given tweeter
+      #
+      # @param [BirdGrinder::Tweeter] parent the parent tweeter which we use to dispatch events.
       def initialize(parent)
         @parent = parent
         logger.debug "Initializing Streaming Support"

data/lib/bird_grinder/tweeter/streaming_request.rb

@@ -3,21 +3,36 @@ require 'cgi'
 
 module BirdGrinder
   class Tweeter
+    # A request implementation for the twitter streaming api that correctly:
+    # 1) keeps connections alives
+    # 2) reacts accordingly to errors
+    # 3) handles tweets in an evented way
+    #
+    # It's built around em-http-request internally but also makes use of BirdGrinder::Tweeter
+    # and BirdGrinder::Tweeter::Streaming to provide a nice, user friendly interface.
     class StreamingRequest
       is :loggable
       
-      INITIAL_DELAYS = {:http => 10,  :network => 0.25}
-      MAX_DELAYS     = {:http => 240, :network => 16}
+      # Values / rates as suggested in the twitter api.
+      INITIAL_DELAYS   = {:http => 10,  :network => 0.25}
+      MAX_DELAYS       = {:http => 240, :network => 16}
       DELAY_CALCULATOR = {
         :http    => L { |v| v * 2 },
         :network => L { |v| v + INITIAL_DELAYS[:network] }
       }
       
+      # Creates a streaming request.
+      #
+      # @param [BirdGrinder::Tweeter] parent the tweeter parent class
+      # @param [Sybol, String] name the name of the stream type
+      # @param [Hash] options The options for this request
+      # @option options [Symbol, String] :path the path component used for the streaming api e.g. sample for filter.
+      # @options options [Object] :metadata generic data to be attached to received tweets
       def initialize(parent, name, options = {})
         logger.debug "Creating stream '#{name}' with options: #{options.inspect}"
         @parent         = parent
         @name           = name
-        @path           = options.delete(:path) || :name
+        @path           = options.delete(:path) || name
         @metadata       = options.delete(:metadata) || {}
         @options        = options
         @failure_delay  = nil
@@ -25,11 +40,12 @@ module BirdGrinder
         @failure_reason = nil
       end
       
+      # Starts the streaming connection
       def perform
         logger.debug "Preparing to start stream"
         @stream_processor = nil
         type = request_method
-        http = create_request.send(type, http_options(type))
+        http = EventMachine::HttpRequest.new(full_url).send(type, http_options(type))
         # Handle failures correctly so we can back off
         @current_request = http
         http.errback  { fail!(:network)}
@@ -37,10 +53,14 @@ module BirdGrinder
         http.stream { |c| receive_chunk(c) }
       end
       
+      # Process a failure and responds accordingly.
+      # 
+      # @param [Symbol] type the type of error, one of :http or :network
       def fail!(type)
-        logger.debug "Streaming failed with #{type}"
+        suffix = type == :http ? " (Error Code #{@current_request.response_header.status})" : ""
+        logger.debug "Streaming failed with #{type}#{suffix}"
         if @failure_count == 0 || @failure_reason != type
-          logger.debug "Instantly restarting (#{@failure_count == 0  ? "First failure" : "Different type"})"
+          logger.debug "Instantly restarting (#{@failure_count == 0  ? "First failure" : "Different type of failure"})"
           EM.next_tick { perform }
         else
           @failure_delay ||= INITIAL_DELAYS[type]
@@ -56,14 +76,16 @@ module BirdGrinder
         logger.debug "Failed #{@failure_count} times with #{@failure_reason}"
       end
       
-      def create_request
-        EventMachine::HttpRequest.new(full_url)
-      end
-      
+      # Returns the current stream processor, creating a new one if it hasn't been initialized yet.
       def stream_processor
         @stream_processor ||= StreamProcessor.new(@parent, @name, @metadata)
       end
       
+      # Processes a chunk of the incoming request, parsing it with the stream
+      # processor as well as resetting anything that is used to track failure
+      # (as a chunk implies that it's successful)
+      #
+      # @param [String] c the chunk of data to receive
       def receive_chunk(c)
         return unless @current_request.response_header.status == 200
         if !@failure_reason.nil?
@@ -74,10 +96,18 @@ module BirdGrinder
         stream_processor.receive_chunk(c)
       end
       
+      # Returns a set of options that apply to the request no matter
+      # 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}
       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)
         base = self.default_request_options
         if @options.present?
@@ -92,6 +122,7 @@ module BirdGrinder
         base
       end
       
+      # Returns the correct http method to be used for the current path.
       def request_method
         {:filter   => :post,
          :sample   => :get,
@@ -100,6 +131,7 @@ module BirdGrinder
         }.fetch(@path, :get)
       end
       
+      # Returns the full streaming api associated with this url.
       def full_url
         @full_url ||= (Streaming.streaming_base_url / Streaming.api_version.to_s / "statuses" / "#{@path}.json")
       end

data/templates/boot.erb

@@ -1,3 +1,3 @@
 require 'rubygems'
 require 'bird_grinder'
-BirdGrinder::Settings.root = Pathname.new(__FILE__).dirname.join("..").expand_path
+BirdGrinder::Settings.root = Pathname(__FILE__).dirname.join("..").expand_path

data/templates/test_helper.erb

@@ -7,7 +7,7 @@ require 'shoulda'
 require 'redgreen' if RUBY_VERSION < "1.9"
 
 require 'pathname'
-root_directory = Pathname.new(__FILE__).dirname.join("..").expand_path
+root_directory = Pathname(__FILE__).dirname.join("..").expand_path
 require root_directory.join("config", "boot")
 
 class Test::Unit::TestCase

data/test/test_helper.rb

@@ -7,7 +7,7 @@ require 'shoulda'
 require 'redgreen' if RUBY_VERSION < "1.9"
 
 require 'pathname'
-root_directory = Pathname.new(__FILE__).dirname.join("..").expand_path
+root_directory = Pathname(__FILE__).dirname.join("..").expand_path
 require root_directory.join("lib", "bird_grinder")
 
 class Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: birdgrinder
 version: !ruby/object:Gem::Version 
-  version: 0.1.2.1
+  version: 0.1.3.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-03 00:00:00 +08:00
+date: 2009-11-08 00:00:00 +08:00
 default_executable: birdgrinder
 dependencies: 
 - !ruby/object:Gem::Dependency