iron_response 0.0.2 → 0.0.3

data/README.md

@@ -2,7 +2,7 @@
 
 # iron_response
 
-Provides a response object for IronWorkers.
+Glues together IronWorker and AWS S3 to provide a response object to remote worker scripts. This allows you to write massively concurrent Ruby programs without worrying about threads.
 
 ```ruby
 require "iron_response"
@@ -50,6 +50,8 @@ end
 
 For many use cases, this is fine. But what if I want to know the result of `do_something`? A simple way to get the result would be for your worker to POST the final result somewhere, then have the client it. This gem simply abstracts that process away, allowing the developer to avoid boilerplate and to keep worker code elegant.
 
+On top of all this, another benefit to using this gem is that it makes it much easier to test workers.
+
 Under the hood, `iron_response` uses some functional and meta-programming to capture the final expression of a worker file, convert it to JSON, and then POST it to Amazon S3. When all the workers in an `IronResponse::Batch` have finished, the gem retrieves the file and converts the JSON string back to Ruby.
 
 This process means there a few important implications:
@@ -57,8 +59,6 @@ This process means there a few important implications:
 - Response objects "sent" from workers should be JSON-parseable. This means sticking to basic Ruby objects and data structures such as `String`, `Fixnum`, `Hash`, and `Array`.
 - Though these objects must be parseable, they can be fairly large. Though I haven't figured out exactly what the limit is, you really are only constrained by IronWorkers RAM and HD limits, and the bandwidth between the client (your computer/server), IronWorker servers, and S3. In an ideal setup, all three of these components are inside of Amazon's cloud, allowing you to get very fast throughput.
 
-One final gotcha: I haven't yet implemented a clean way to use the `iron_worker_ng` gem to declare dependencies. This should be done soon, though.
-
 ## Usage
 
 This gem requires a basic understanding of how to use [IronWorker with Ruby](https://github.com/iron-io/iron_worker_ruby_ng).
@@ -140,6 +140,15 @@ batch.params_array       = Array ("a".."z").map {|i| {letter: i}}
 results                  = batch.run!
 ```
 
+If your worker code requires any gems, you can use [`iron_worker_ng`](https://github.com/iron-io/iron_worker_ruby_ng)'s API:
+
+```ruby
+batch.code.merge_gem("nokogiri", "< 1.6.0") # decreases remote build time
+batch.code.merge_gem("ecfs")
+batch.code.full_remote_build(true)
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/iron_response/version.rb

@@ -1,3 +1,3 @@
 module IronResponse
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/iron_response.rb

@@ -73,10 +73,21 @@ module IronResponse
       JSON.parse(response)
     end
 
+    def code
+      @code ||= IronWorkerNG::Code::Ruby.new(exec: @worker).tap do |c|
+        c.name = worker_name
+        c.merge_gem("iron_response")
+        c.runtime = "ruby"
+      end
+
+      @code
+    end
+
+    def patch_code!
+      @client.codes.patch(code)
+    end
+
     def create_code!
-      code = IronWorkerNG::Code::Ruby.new(exec: @worker)
-      code.name(worker_name)
-      code.gem("iron_response")
       @client.codes.create(code)
     end
   end

data/test/gem_dependency_test.rb

@@ -0,0 +1,35 @@
+require "test_helper"
+
+class GemDependencyTest < MiniTest::Unit::TestCase
+  def test_synopsis
+
+    config = Configuration.keys
+    batch = IronResponse::Batch.new
+    
+    batch.auto_update_worker = true
+    
+    batch.config[:iron_io]   = config[:iron_io]
+    batch.config[:aws_s3]    = config[:aws_s3]
+    batch.worker             = "test/workers/fcc_filings_counter.rb"
+
+    batch.code.merge_gem("nokogiri", "< 1.6.0") # keeps the build times low
+    batch.code.merge_gem("ecfs")
+    batch.code.full_remote_build(true)
+
+    batch.params_array       = [
+                                "12-375", "12-268",
+                                "12-238", "12-353", 
+                                "13-150", "13-5", 
+                                "10-71"
+                                ].map { |i| {docket_number: i} } 
+    
+    results                  = batch.run!
+
+    total = results.map {|r| r["length"]}.inject(:+)
+
+    p "There are #{total} total filings in these dockets."
+
+    assert_equal Array, results.class
+    assert_equal batch.params_array.length, results.length
+  end
+end

data/test/workers/fcc_filings_counter.rb

@@ -0,0 +1,12 @@
+require "iron_response"
+require "ecfs"
+
+IronResponse::Responder.new(binding) do
+  filings = ECFS::Filing.query.tap do |q|
+    q.docket_number = params[:docket_number]
+  end.get
+
+  {
+    length: filings.length
+  }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_response
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iron_worker_ng
@@ -107,8 +107,10 @@ files:
 - lib/iron_response.rb
 - lib/iron_response/version.rb
 - test/configuration.rb.example
+- test/gem_dependency_test.rb
 - test/synopsis_test.rb
 - test/test_helper.rb
+- test/workers/fcc_filings_counter.rb
 - test/workers/is_prime.rb
 homepage: ''
 licenses: []
@@ -136,7 +138,9 @@ specification_version: 3
 summary: Provides a response object for IronWorker tasks.
 test_files:
 - test/configuration.rb.example
+- test/gem_dependency_test.rb
 - test/synopsis_test.rb
 - test/test_helper.rb
+- test/workers/fcc_filings_counter.rb
 - test/workers/is_prime.rb
 has_rdoc: