elasticity 0.3 → 0.3.5

data/README.mediawiki

@@ -1,10 +1,12 @@
 Elasticity provides programmatic access to Amazon's Elastic Map Reduce service.
 
-There are five API actions in the [http://docs.amazonwebservices.com/ElasticMapReduce/latest/DeveloperGuide/index.html EMR API], described below.  Please see the Amazon guide for details on these operations because the default values aren't obvious (e.g. the meaning of DescribeJobFlows without parameters).
+There are five API actions in the [http://docs.amazonwebservices.com/ElasticMapReduce/latest/DeveloperGuide/index.html EMR API], described below.  Please see the Amazon guide for details on these operations because the default values aren't obvious (e.g. the meaning of <code>DescribeJobFlows</code> without parameters).
 
-Alternatively, you may opt for "direct" access to the API where you specify the params and Elasticity takes care of the signing for you.  Direct access is described below the API catalog.
+Each Elasticity call provides some level of wrapping to save you the trouble of having to parse XML and deal with common status codes.
 
-'''NOTE''': The AWS plumbing (especially signing/authentication) was used from [http://www.rightscale.com/ RightScale's] amazing [https://github.com/rightscale/right_aws right_aws gem] which works extraordinarily well!
+Alternatively, you may opt for "direct" access to the API where you specify the params and Elasticity takes care of the signing for you, responding with the XML from Amazon.  Direct access is described below the API catalog.
+
+'''CREDITS''': AWS signing was used from [http://www.rightscale.com/ RightScale's] amazing [https://github.com/rightscale/right_aws right_aws gem] which works extraordinarily well!  If you need access to any AWS service (EC2, S3, etc.), have a look.
 
 == AddInstanceGroups ==
 
@@ -16,6 +18,8 @@ Alternatively, you may opt for "direct" access to the API where you specify the
 
 == DescribeJobFlows ==
 
+DescribeJobFlows returns detailed information as to the state of all jobs.  Currently this is wrapped in an <code>Elasticity::JobFlow</code> that contains the <code>name</code>, <code>jobflow_id</code> and <code>state</code>.  
+
 <pre>
   > emr = Elasticity::EMR.new(ENV["aws_access_key_id"], ENV["aws_secret_key"])
   > jobflows = emr.describe_jobflows
@@ -33,11 +37,11 @@ Alternatively, you may opt for "direct" access to the API where you specify the
 
 == TerminateJobFlows ==
 
-When the job flow '''exists''', you will receive no output.  This is because Amazon does not return anything other than a 200 when you terminate a job flow :)  You'll want to continually poll with DescribeJobFlows to see when the job was actually terminated.
+When the job flow '''exists''', you will receive no output.  This is because Amazon does not return anything other than a 200 when you terminate a job flow :)  You'll want to continuously poll with DescribeJobFlows to see when the job was actually terminated.
 
 <pre>
   > emr = Elasticity::EMR.new(ENV["aws_access_key_id"], ENV["aws_secret_key"])
-  > emr.terminate_jobflows("no-flow")
+  > emr.terminate_jobflows("j-BOWBV7884XD0")
   >
 </pre>
 
@@ -49,16 +53,26 @@ When the job flow '''doesn't exist''':
   ArgumentError: Job flow 'no-flow' does not exist.
 </pre>
 
-= Direct Access =
+= Direct Response Access =
+
+If you're fine with Elasticity's invocation wrapping and would prefer to get at the resulting XML rather than the wrapped response, throw a block our way and we'll yield the result.  This still saves you the trouble of having to create the params and sign the request yet gives you direct access to the response XML for your parsing pleasure.
+
+<pre>
+  > emr = Elasticity::EMR.new(ENV["aws_access_key_id"], ENV["aws_secret_key"])
+  > emr.describe_jobflows{|xml| puts xml[0..77]}
+  <DescribeJobFlowsResponse xmlns="http://elasticmapreduce.amazonaws.com/doc/200
+</pre>
+
+= Direct Request/Response Access =
 
-If you're chomping at the bit to get at some EMR functionality that isn't wrapped (or isn't wrapped in a way you prefer :) feel free to access the AWS EMR API directly by using <code>EMR.direct()</code>.  You can find the allowed values in Amazon's EMR API [http://docs.amazonwebservices.com/ElasticMapReduce/latest/DeveloperGuide/index.html developer documentation].
+If you're chomping at the bit to initiate some EMR functionality that isn't wrapped (or isn't wrapped in a way you prefer :) feel free to access the AWS EMR API directly by using <code>EMR.direct()</code>.  You can find the allowed values in Amazon's EMR API [http://docs.amazonwebservices.com/ElasticMapReduce/latest/DeveloperGuide/index.html developer documentation].
 
 <pre>
   > emr = Elasticity::EMR.new(ENV["aws_access_key_id"], ENV["aws_secret_key"])
   > params = {"Operation" => "DescribeJobFlows"}
   > result_xml = emr.direct(params)
-  > result_xml[0..42]
-  <DescribeJobFlowsResponse xmlns=\"http://ela"
+  > result_xml[0..78]
+  <DescribeJobFlowsResponse xmlns="http://elasticmapreduce.amazonaws.com/doc/2009
 </pre>
 
 <!-- __NOTOC__ -->

data/lib/elasticity/emr.rb

@@ -11,6 +11,7 @@ module Elasticity
       aws_result = @aws_request.aws_emr_request({"Operation" => "DescribeJobFlows"})
       xml_doc = Nokogiri::XML(aws_result)
       xml_doc.remove_namespaces!
+      yield aws_result if block_given?
       JobFlow.from_members_nodeset(xml_doc.xpath("/DescribeJobFlowsResponse/DescribeJobFlowsResult/JobFlows/member"))
     end
 
@@ -20,10 +21,11 @@ module Elasticity
     # flow does not exist.
     def terminate_jobflows(jobflow_id)
       begin
-        @aws_request.aws_emr_request({
+        aws_result = @aws_request.aws_emr_request({
           "Operation" => "TerminateJobFlows",
           "JobFlowIds.member.1" => jobflow_id
         })
+        yield aws_result if block_given?
       rescue RestClient::BadRequest
         raise ArgumentError, "Job flow '#{jobflow_id}' does not exist."
       end

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.3"
+  VERSION = "0.3.5"
 end

data/spec/lib/elasticity/emr_spec.rb

@@ -40,6 +40,7 @@ describe Elasticity::EMR do
           </DescribeJobFlowsResponse>
         JOBFLOWS
       end
+
       it "should return the names of all running job flows" do
         aws_request = Elasticity::AwsRequest.new("aws_access_key_id", "aws_secret_key")
         aws_request.should_receive(:aws_emr_request).with({"Operation" => "DescribeJobFlows"}).and_return(@describe_jobflows_xml)
@@ -48,6 +49,20 @@ describe Elasticity::EMR do
         jobflows = emr.describe_jobflows
         jobflows.map(&:name).should == ["Pig Job", "Hive Job"]
       end
+
+      context "when a block is provided" do
+        it "should yield the XML result" do
+          aws_request = Elasticity::AwsRequest.new("aws_access_key_id", "aws_secret_key")
+          aws_request.should_receive(:aws_emr_request).with({"Operation" => "DescribeJobFlows"}).and_return(@describe_jobflows_xml)
+          Elasticity::AwsRequest.should_receive(:new).and_return(aws_request)
+          emr = Elasticity::EMR.new("aws_access_key_id", "aws_secret_key")
+          xml_result = nil
+          emr.describe_jobflows do |xml|
+            xml_result = xml
+          end
+          xml_result.should == @describe_jobflows_xml
+        end
+      end
     end
 
   end
@@ -86,6 +101,22 @@ describe Elasticity::EMR do
           emr = Elasticity::EMR.new("aws_access_key_id", "aws_secret_key")
           emr.terminate_jobflows("j-1")
         end
+        context "when a block is given" do
+          it "should yield the XML result" do
+            aws_request = Elasticity::AwsRequest.new("aws_access_key_id", "aws_secret_key")
+            aws_request.should_receive(:aws_emr_request).with({
+              "Operation" => "TerminateJobFlows",
+              "JobFlowIds.member.1" => "j-1"
+            }).and_return(@terminate_jobflows_xml)
+            Elasticity::AwsRequest.should_receive(:new).and_return(aws_request)
+            emr = Elasticity::EMR.new("aws_access_key_id", "aws_secret_key")
+            xml_result = nil
+            emr.terminate_jobflows("j-1") do |xml|
+              xml_result = xml
+            end
+            xml_result.should == @terminate_jobflows_xml
+          end
+        end
       end
 
       context "when the jobflow does not exist" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: elasticity
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 3
-  version: "0.3"
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Robert Slifka
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-10 00:00:00 -07:00
+date: 2011-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency