floormanager 0.2.0 → 0.2.1

data/README.rdoc

@@ -19,7 +19,7 @@ See the examples for more advanced usage.
 
 == TODO
 
-* Write the tests and examples
+* Write the tests
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/examples/twitter.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+require 'floormanager'
+
+# = Example Twitter client with robust concurrent search. 
+#
+# Will handle rate limiting and errors gracefully, optionally
+# retrying for a number of times before failing.
+#
+# == Usage:
+# 
+#  twitter = Twitter.new(:concurrency => 10, :retries => 5, :retry_delay => 10)
+#  results = twitter.concurrent_search(['ruby', 'httparty', 'floormanager'])
+#  results.each do |search_string, tweets|
+#    unless tweets.failed?
+#      puts tweets.inspect
+#    end
+#  end
+
+class Twitter
+	include HTTParty
+	
+	def initialize(options={})
+		@concurrency = options[:concurrency] || 20
+		@retries     = options[:retries]     || 0
+		@retry_delay = options[:retry_delay] || 2.0
+	end
+	attr_accessor :concurrency, :retries, :retry_delay
+
+	base_uri       'http://search.twitter.com'
+	default_params :rpp => '100'
+	format         :json
+
+	def concurrent_search(query_strings)
+		queue   = FloorManager::Queue.new(query_strings)
+		workers = FloorManager::Workers.new(queue)
+		workers.perform(:threads => @concurrency) do |query_string|
+			retries = 0
+			begin
+				results = self.class.get('/search.json', :query => {:q => "\"#{query_string}\""})
+				# Handle rate limiting
+				if results.code == 420                          
+					if result.headers['retry-after']
+						retry_delay = result.headers['retry-after'].first.to_i
+					else
+						retry_delay = 60
+					end
+					workers.halt(retry_delay) # Halt all workers for the retry delay
+					retry
+				else
+					results['results']
+				end
+			rescue Exception => error
+				if retries < @retries         # If at first you don't succeed, try and try again
+					retries += 1 
+					sleep(@retry_delay) and retry
+				end
+				workers.failed(error)         # Return a failed result after 5 tries
+			end
+		end
+	end
+end

data/floormanager.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{floormanager}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Inge J\303\270rgensen"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "examples/twitter.rb",
      "floormanager.gemspec",
      "lib/floormanager.rb",
      "lib/floormanager/queue.rb",
@@ -40,7 +41,8 @@ Gem::Specification.new do |s|
   s.summary = %q{Handle threaded workers like a champ}
   s.test_files = [
     "spec/floormanager_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "examples/twitter.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/floormanager/result.rb

@@ -1,22 +1,16 @@
 module FloorManager
 	class Result < FloorManager::BasicObject
 		attr_accessor :result, :state
-		attr_reader :delegate
 
-		def initialize(delegate, result, state=States::SUCCESS)
-			@delegate = delegate
+		def initialize(result, state=States::SUCCESS)
 			@result = result
 			@state = state
 		end
 		
 		def method_missing(name, *args, &block)
-			@delegate.send(name, *args, &block)
+			@result.send(name, *args, &block)
 		end
 		
-		def state
-			@state
-		end
-	
 		def failed?
 			@state == States::FAILED
 		end

data/lib/floormanager/workers.rb

@@ -15,7 +15,7 @@ module FloorManager
 					until queue.done?
 						if item = checkout
 							result = yield(item)
-							result = Result.new(result, result, (result.state rescue States::SUCCESS))
+							result = Result.new(result, (result.state rescue States::SUCCESS))
 							checkin(item, result, result.state)
 						else
 							Thread.pass
@@ -28,11 +28,11 @@ module FloorManager
 		end
 
 		def checkout
-			@mutex.synchronize{@queue.checkout}
+			synchronize{@queue.checkout}
 		end
 
 		def checkin(*args)
-			@mutex.synchronize{@queue.checkin(*args)}
+			synchronize{@queue.checkin(*args)}
 		end
 
 		def synchronize
@@ -40,15 +40,19 @@ module FloorManager
 		end
 		alias :exclusively :synchronize
 		
+		def halt(time)
+			synchronize{sleep(time)}
+		end
+		
 		def result(result, state=States::SUCCESS)
-			Result.new(result, result, state)
+			Result.new(result, state)
 		end
 		
 		def success(result)
 			result(result, States::SUCCESS)
 		end
 
-		def fail(result)
+		def failed(result=nil)
 			result(result, States::FAILED)
 		end
 	end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Inge J\xC3\xB8rgensen"
@@ -47,6 +47,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/twitter.rb
 - floormanager.gemspec
 - lib/floormanager.rb
 - lib/floormanager/queue.rb
@@ -89,3 +90,4 @@ summary: Handle threaded workers like a champ
 test_files: 
 - spec/floormanager_spec.rb
 - spec/spec_helper.rb
+- examples/twitter.rb