parallizer 0.0.3 → 0.0.4

data/Gemfile

@@ -5,8 +5,8 @@ source "http://rubygems.org"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
-gem "bundler", ">= 1.1.5"
-gem "jeweler", ">= 1.8.4"
+gem "bundler"
+gem "jeweler"
 
 gem "work_queue", ">= 0"
 

data/Gemfile.lock

@@ -33,8 +33,8 @@ PLATFORMS
 
 DEPENDENCIES
   always_execute (= 0.0.2)
-  bundler (>= 1.1.5)
-  jeweler (>= 1.8.4)
+  bundler
+  jeweler
   minitest (= 2.12.1)
   minitest-extra-assertions (= 0.1.0)
   minitest-reporters (= 0.7.0)

data/README.md

@@ -1,10 +1,129 @@
-# Parallizer - Execute your service layer in parallel.
+# Parallizer - Execute your service layer in parallel
+
+Parallizer executes service methods in parallel, stores the method results, then creates a proxy with those results for your service. Your application then uses the short-lived service proxy (think of a single request for a web application) and executes your methods without again calling the underlying implementation. For applications that make considerable use of web service calls, Parallizer can give you a considerable performance boost.
+
+## Installation
+
+    gem install parallizer
 
 ## Examples
 
+### Parallizing a service object
+
+Here's an example service.
+
+```ruby
+require 'net/http'
+
+class SearchService
+  def search_result_for_foo
+    Net::HTTP.get('www.google.com', '/?q=foo')
+  end
+  
+  def search_result_for_bar
+    Net::HTTP.get('www.google.com', '/?q=foo')
+  end
+end
+
+$search_service = SearchService.new
+```
+
+Now create a Parallizer for that service and add all of the methods you intend to call. Then execute the service methods in parallel and return a service proxy that has the stored results of the method calls.
+
+```ruby
+require 'parallizer'
+
+parallizer = Parallizer.new($search_service)
+parallizer.add.search_result_for_foo
+parallizer.add.search_result_for_bar
+search_service = parallizer.execute
+```
+
+Now use that service proxy in your application logic.
+
+```ruby
+puts search_service.search_result_for_foo
+puts search_service.search_result_for_bar
+```
+
+Additional calls in your application logic will not result in an additional call to the underlying service.
+
+```ruby
+# Called twice, but no extra service call. (Be careful not to mutate the returned object!)
+puts search_service.search_result_for_foo
+puts search_service.search_result_for_foo
+```
+
+If there are additional methods on your service that were not parallized, you can still call them.
+
+```ruby
+puts search_service.search_result_for_foobar # does a Net::HTTP.get call
+```
+
+### Parallizing methods with parameters
+
+Parallizing also works on service methods with parameters.
+
+```ruby
+require 'net/http'
+require 'cgi'
+
+class SearchService
+  def search_result(search_term)
+    Net::HTTP.get('www.google.com', "/?q=#{CGI.escape(search_term)}")
+  end
+end
+
+$search_service = SearchService.new
+```
+
+The parallel execution and proxy creation.
+
+```ruby
+require 'parallizer'
+
+parallizer = Parallizer.new($search_service)
+parallizer.add.search_result('foo')
+parallizer.add.search_result('bar')
+search_service = parallizer.execute
+```
+
+Using the service proxy in your application logic.
+
+```ruby
+puts search_service.search_result('foo') # returns stored value
+puts search_service.search_result('bar') # returns stored value
+puts search_service.search_result('foobar') # does a Net::HTTP.get call
+```
+
+
+### Parallizing class methods
+
+You can even parallize class methods.
+
+```ruby
+require 'net/http'
+require 'parallizer'
+
+parallizer = Parallizer.new(Net::HTTP)
+parallizer.add.get('www.google.com', '/?q=foo')
+parallizer.add.get('www.google.com', '/?q=bar')
+http_service = parallizer.execute
+```
+
+Use the service proxy.
+
+```ruby
+# use your service proxy
+http_service.get('www.google.com', '/?q=foo') # returns stored value
+http_service.get('www.google.com', '/?q=bar') # returns stored value
+http_service.get('www.google.com', '/?q=foobar') # does a Net::HTTP.get call
+```
+
+
 # Credits
 
-Always Execute is maintained by [Michael Pearce](http://github.com/michaelgpearce) and is funded by [BookRenter.com](http://www.bookrenter.com "BookRenter.com").
+[Parallizer](https://github.com/michaelgpearce/parallizer) is maintained by [Michael Pearce](http://github.com/michaelgpearce) and is funded by [BookRenter.com](http://www.bookrenter.com "BookRenter.com").
 
 ![BookRenter.com Logo](http://assets0.bookrenter.com/images/header/bookrenter_logo.gif "BookRenter.com")
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/parallizer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "parallizer"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Pearce"]
-  s.date = "2012-07-29"
+  s.date = "2012-07-30"
   s.description = "Execute your service layer in parallel."
   s.email = "michael.pearce@bookrenter.com"
   s.extra_rdoc_files = [
@@ -42,21 +42,21 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<bundler>, [">= 1.1.5"])
-      s.add_runtime_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_runtime_dependency(%q<bundler>, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
       s.add_runtime_dependency(%q<work_queue>, [">= 0"])
       s.add_runtime_dependency(%q<work_queue>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<bundler>, [">= 1.1.5"])
-      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<work_queue>, [">= 0"])
       s.add_dependency(%q<work_queue>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<bundler>, [">= 1.1.5"])
-    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<work_queue>, [">= 0"])
     s.add_dependency(%q<work_queue>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallizer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-29 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: work_queue
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -990104623543114705
+      hash: -1557478882810554134
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: