simple_aws 1.2.0 → 1.2.1

data/.travis.yml

@@ -3,6 +3,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - rbx
-  - ruby-head
   - ree
   - jruby

data/README.md

@@ -1,26 +1,24 @@
-SimpleAWS [![Travis CI Build Status](https://secure.travis-ci.org/jameskilton/simple_aws.png)](http://travis-ci.org/jameskilton/simple_aws)
+SimpleAWS [![Travis CI Build Status](https://secure.travis-ci.org/jasonroelofs/simple_aws.png)](http://travis-ci.org/jasonroelofs/simple_aws)
 =========
 
 A thin, simple, forward compatible Ruby wrapper around the various Amazon Web Service APIs.
 
-What? Why?!
+Why?
 -----------
 
-Do we really need another Ruby library to talk to Amazon Web Services? Aren't there enough libraries out there that could just use some more help to make them better? What about [fog](http://fog.io), or [aws-sdk](http://rubygems.org/gems/aws-sdk), or [aws](http://rubygems.org/gems/aws), or [right_aws](http://rubygems.org/gems/right_aws)?
-
-While there are a number of well used libraries, I feel they have all fallen prey to the same two problems: they are far too complex for what they are and they all lack forward compatibility.
+I've used almost all of the various major AWS Ruby libraries out there at one point or another, and ever one of them has left me wanting. Each time I pick a different AWS library, I end up in the same situation: the library itself is too complex with tons of abstraction, and when Amazon updates their API, it's a lot of work to update the library to include those new changes. What if there was a library that didn't suffer from either of these issues?
 
 ### Complexity
 
-Every Ruby AWS library in use today is simply too complex. Each one I've tried to use has ended up hurting my productivity as I often found myself diving into the library's code to figure out how to call the API method in question. Instead of just working with Amazon's API, I end up fighting the library, constantly having to re-learn whatever abstraction said library is trying to provide. Every library mentioned either hard-codes parameter lists, has it's own mapping from hash keys to AWS parameters, or wraps up an Object API around everything, leading to confusion and more lost productivity when that abstraction leaks. Software is supposed to be simple to use; it's supposed to make your life easier. I've yet to find an AWS library that does this.
+Every Ruby AWS library I've used is simply too complex and has ended up hurting my productivity. I often found myself diving into the library's code to figure out how to call a given AWS API. Instead of just working with Amazon's API, I end up fighting the library, constantly having to re-learn whatever abstraction said library is trying to provide. They all either hard-code parameters, have their own mapping from hash keys to AWS parameters, or wrap up an Object API around everything, leading to confusion and more lost productivity when that abstraction leaks (which all abstractions do). Software is supposed to be simple to use; it's supposed to make your life easier. I've yet to find an AWS library that does this.
 
 ### Forward Compatibility
 
-Outside of the pervasive complexity of these libraries, what finally drove me to create this library is the complete lack of forward compatibility in all of them. Any time I wanted to use a new parameter, new action, or new API, I would need to jump into the library itself to implement the missing pieces. In normal OSS fashion, this is of course to be lauded, contributing back to libraries is what makes software better. However, in the case of API wrappers, this very quickly becomes a frustration.
+Outside of the pervasive complexity of these libraries, what finally drove me to create this library is the complete lack of forward compatibility in all of them. Any time I wanted to use a new parameter, new action, or new API, I would need to jump into the library itself to implement the missing pieces. In normal OSS fashion, this is of course to be lauded, as contributing back to libraries is what makes software better. However, in the case of API wrappers, this very quickly becomes a frustration.
 
-Amazon constantly updates AWS APIs, adding parameters and actions, and at times entire new APIs. An AWS library should work *with* the API in question, not fight against it. The only thing a hard-coded parameter list does is add confusion. When you have to figure out how AWS parameters map to library parameters, or hash keys, your productivity drops. When you have to figure out how an object is calling an AWS library, and how you're supposed to use that object, your productivity drops. Likewise when you finally realize that the library does not currently support the action, parameter, or API you're trying to use at the time, your productivity is now at a complete stop.
+Amazon constantly updates their APIs, adding parameters and actions, and at times entire new APIs. An AWS library should work *with* the API in question, not fight against it. The only thing a hard-coded parameter list does is add confusion. When you have to figure out how AWS parameters map to library parameters, or hash keys, your productivity drops. When you have to figure out how an object is calling an AWS library, and how you're supposed to use that object, your productivity drops. Likewise when you finally realize that the library does not currently support the action, parameter, or API you're trying to use at the time, your productivity is now at a complete stop.
 
-SimpleAWS simply says no, no more leaky abstractions and confusing APIs. Just use the names of the API methods and parameters as defined in Amazon's documentation! If a new parameter is added to the API you're using, just use it. The name SimpleAWS isn't a wish or hope, it is the core philosophy. This library focuses on being a very thin communication layer between your Ruby code and Amazon's AWS APIs. Let SimpleAWS handle the messy communication details so your code can do what it needs to do letting you be more productive.
+SimpleAWS simply says no, no more leaky abstractions and confusing APIs. Just use the names of the API methods and parameters as defined in Amazon's documentation! If a new parameter is added to the API you're using, just use it. The name SimpleAWS isn't a wish or hope, it is the core philosophy. SimpleAWS focuses on being a very thin communication layer between your Ruby code and the AWS APIs. Let SimpleAWS handle the messy communication details so your code can do what it needs to do.
 
 
 Surely SimpleAWS isn't just `curl`?
@@ -44,9 +42,9 @@ ec2 = SimpleAWS::EC2.new key, secret
 ec2.DescribeInstances
 ```
 
-### Parameters
+### Parameters and Headers
 
-Adding parameters to your method calls follows similar rules, with some Quality of Life improvements. The following three are equivalent:
+Parameters and Headers to actions are sent as defined in the official AWS documentation. They must be strings that exactly match the parameters and headers as defined for each action. For example, the "InstanceId" parameter of EC2's "DescribeInstances" action must be named "InstanceId", not :instance_id. That said, there are some Quality of Life improvements to parameter handling. The following three are equivalent:
 
 #### Just Call It
 
@@ -148,15 +146,14 @@ SimpleAWS is built to work under all major Ruby versions:
 * 1.9.2
 * 1.9.3
 * ree
-* HEAD
 * jruby
 * rubinius
 
 ### Misc Info
 
-Author: Jason Roelofs - [Github](https://github.com/jameskilton) [@jameskilton](http://twitter.com/jameskilton)
+Author: Jason Roelofs - [Github](https://github.com/jasonroelofs) [@jasonroelofs](http://twitter.com/jasonroelofs)
 
-Source: https://github.com/jameskilton/simple_aws
+Source: https://github.com/jasonroelofs/simple_aws
 
-Issues: https://github.com/jameskilton/simple_aws/issues
+Issues: https://github.com/jasonroelofs/simple_aws/issues
 

data/lib/simple_aws/api.rb

@@ -56,7 +56,7 @@ module SimpleAWS
 
     end
 
-    attr_reader :access_key, :secret_key, :region, :version
+    attr_reader :access_key, :secret_key, :region, :version, :debug_to
 
     ##
     # Construct a new access object for the API in question.
@@ -75,6 +75,14 @@ module SimpleAWS
       @version = self.class.instance_variable_get("@version")
     end
 
+    ##
+    # Flag this API to render debugging information to an IO location.
+    # Default is $stdout
+    ##
+    def debug!(location = $stdout)
+      @debug_to = location
+    end
+
     ##
     # Get the full host name for the current API
     #

data/lib/simple_aws/call_types/action_param.rb

@@ -42,7 +42,7 @@ module SimpleAWS
       protected
 
       def send_request(request)
-        connection = SimpleAWS::Connection.new
+        connection = SimpleAWS::Connection.new self
         connection.call finish_and_sign_request(request)
       end
 

data/lib/simple_aws/cloud_front.rb

@@ -151,7 +151,7 @@ module SimpleAWS
         request.body = options[:body]
       end
 
-      connection = SimpleAWS::Connection.new
+      connection = SimpleAWS::Connection.new self
       connection.call finish_and_sign_request(request)
     end
 

data/lib/simple_aws/core/connection.rb

@@ -58,6 +58,10 @@ module SimpleAWS
   ##
   class Connection
 
+    def initialize(api)
+      @api = api
+    end
+
     ##
     # Send an SimpleAWS::Request to AWS proper, returning an SimpleAWS::Response.
     # Will raise if the request has an error
@@ -68,7 +72,8 @@ module SimpleAWS
           request.uri,
           :query => request.params,
           :headers => request.headers,
-          :body => request.body
+          :body => request.body,
+          :debug_output => @api.debug_to
         )
       )
     end

data/lib/simple_aws/core/request.rb

@@ -1,3 +1,6 @@
+require 'date'
+require 'time'
+
 module SimpleAWS
 
   ##
@@ -57,6 +60,10 @@ module SimpleAWS
           process_array key, value
         when Hash
           process_hash key, value
+        when Time
+          super(key, value.iso8601)
+        when Date
+          super(key, value.strftime("%Y-%m-%d"))
         else
           super
         end

data/lib/simple_aws/core/response.rb

@@ -239,7 +239,7 @@ module SimpleAWS
     protected
 
     def parse_and_throw_error_from(http_response)
-      if http_response.parsed_response
+      if has_parsed_response? http_response
         error = parse_error_from http_response.parsed_response
       else
         error = { "Message" => http_response.response }
@@ -252,6 +252,11 @@ module SimpleAWS
       )
     end
 
+    def has_parsed_response?(response)
+      !response.parsed_response.nil? &&
+        response.parsed_response != ""
+    end
+
     def parse_error_from(body)
       if body.has_key? "ErrorResponse"
         body["ErrorResponse"]["Error"]

data/lib/simple_aws/dynamo_db.rb

@@ -1,5 +1,4 @@
 require 'simple_aws/api'
-require 'simple_aws/signing/version3'
 require 'simple_aws/sts'
 require 'multi_json'
 
@@ -80,7 +79,7 @@ module SimpleAWS
         "Algorithm=HmacSHA256," +
         "Signature=#{build_signature_for(request)}"
 
-      connection = SimpleAWS::Connection.new
+      connection = SimpleAWS::Connection.new self
       connection.call request
     end
 

data/lib/simple_aws/iam.rb

@@ -20,6 +20,10 @@ module SimpleAWS
     use_https true
     version "2010-05-08"
 
+    def initialize(key, secret)
+      super(key, secret)
+    end
+
     include CallTypes::ActionParam
     include Signing::Version2
   end

data/lib/simple_aws/s3.rb

@@ -128,6 +128,20 @@ module SimpleAWS
       call :get, path, options
     end
 
+    ##
+    # Send a request using HTTP POST
+    #
+    # @param path [String] The path of the resource at hand
+    # @param options [Hash] Options as defined above
+    #
+    # @return [SimpleAWS::Response] The results of the request
+    #
+    # @raise [SimpleAWS::UnsuccessfulResponse, SimpleAWS::UnknownErrorResponse] on response errors
+    ##
+    def post(path, options = {})
+      call :post, path, options
+    end
+
     ##
     # Send a request using HTTP PUT
     #
@@ -184,7 +198,7 @@ module SimpleAWS
     def call(method, path, options = {})
       request = self.build_request method, path, options
 
-      connection = SimpleAWS::Connection.new
+      connection = SimpleAWS::Connection.new self
       connection.call finish_and_sign_request(request)
     end
 
@@ -234,10 +248,15 @@ module SimpleAWS
 
       request.body = options[:body]
 
-      if request.body.respond_to?(:read)
-        request.headers["Content-Type"] ||= "application/octet-stream"
-        request.headers["Content-Length"] = File.size(request.body).to_s
-        request.headers["Expect"] = "100-continue"
+      if request.body
+        request.headers["Content-Length"] = calculate_size_of(request.body).to_s
+
+        if request.body.respond_to?(:read)
+          request.headers["Content-Type"] ||= "application/octet-stream"
+          request.headers["Expect"] = "100-continue"
+        end
+
+        request.headers["Content-Type"] ||= "application/x-www-form-urlencoded"
       end
 
       request
@@ -255,6 +274,10 @@ module SimpleAWS
 
     protected
 
+    def calculate_size_of(body)
+      body.respond_to?(:size) ? body.size : File.size(body)
+    end
+
     ##
     # Build and sign the final request, as per the rules here:
     # http://docs.amazonwebservices.com/AmazonS3/latest/dev/RESTAuthentication.html

data/samples/s3.rb

@@ -22,6 +22,7 @@ def bad_usage
 end
 
 s3 = SimpleAWS::S3.new ENV["AWS_KEY"], ENV["AWS_SECRET"]
+s3.debug!
 
 bucket_name = ARGV[0]
 file_name = ARGV[1]
@@ -36,8 +37,16 @@ puts "", "First 10 files in #{bucket_name}:", ""
 
 bad_usage unless bucket_name
 
-s3.get("/", :bucket => bucket_name, :params => {"max-keys" => 10}).contents.each do |entry|
-  puts entry.key
+s3.get("/", :bucket => bucket_name, :params => {"max-keys" => 10}).tap do |response|
+  # Amazon doesn't include Contents if there are no files
+  # Amazon also includes just one entry if there's only one file to be found,
+  # where as if there's > 1 then SimpleAWS will be given a proper array.
+  # Gotta love XML!
+  if response["Contents"]
+    [response.contents].flatten.each do |entry|
+      puts entry.key
+    end
+  end
 end
 
 puts "", "Uploading #{file_name} to #{bucket_name}:", ""

data/simple_aws.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "simple_aws"
-  s.version  = "1.2.0"
+  s.version  = "1.2.1"
   s.platform = Gem::Platform::RUBY
   s.authors  = ["Jason Roelofs"]
   s.email    = ["jasongroelofs@gmail.com"]

data/test/simple_aws/api_test.rb

@@ -49,6 +49,20 @@ describe SimpleAWS::API do
     end
   end
 
+  describe "#debug" do
+    it "allows turning on debugging for the api instance" do
+      obj = TestAPI.new "access_key", "secret_key"
+      obj.debug!
+      obj.debug_to.must_equal $stdout
+    end
+
+    it "allows changing the output location of the debugging output" do
+      obj = TestAPI.new "access_key", "secret_key"
+      obj.debug! $stderr
+      obj.debug_to.must_equal $stderr
+    end
+  end
+
   describe "#region" do
     it "uses default region if none given on constructor" do
       TestAPI.default_region "us-west-1"

data/test/simple_aws/core/connection_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'simple_aws/api'
 require 'simple_aws/core/request'
 require 'simple_aws/core/response'
 require 'simple_aws/core/connection'
@@ -8,7 +9,8 @@ describe SimpleAWS::Connection do
   describe "#call" do
 
     before do
-      @connection = SimpleAWS::Connection.new
+      @api = SimpleAWS::API.new "access", "secret"
+      @connection = SimpleAWS::Connection.new @api
       @http_response = stub_everything(:success? => true, :parsed_response => {"value" => {}})
     end
 
@@ -68,5 +70,17 @@ describe SimpleAWS::Connection do
       @connection.call request
     end
 
+    it "forwards debugging settings from the API to the backend" do
+      @api.debug!
+
+      request = SimpleAWS::Request.new(:get, "host.com", "/")
+
+      SimpleAWS::HTTP.expects(:get).with {|uri, options|
+        options[:debug_output].must_equal $stdout
+      }.returns(@http_response)
+
+      @connection.call request
+    end
   end
+
 end

data/test/simple_aws/core/request_test.rb

@@ -104,4 +104,20 @@ describe SimpleAWS::Request do
       })
     end
   end
+
+  describe "date / time objects" do
+    it "converts date objects to ISO8601 format" do
+      @request.params["Date"] = Date.parse("2012-02-14")
+      @request.params.must_equal({
+        "Date" => "2012-02-14"
+      })
+    end
+
+    it "converts time objects to ISO8601 format" do
+      @request.params["Time"] = Time.utc(2012, 04, 16, 10, 30, 25)
+      @request.params.must_equal({
+        "Time" => "2012-04-16T10:30:25Z"
+      })
+    end
+  end
 end

data/test/simple_aws/core/response_test.rb

@@ -142,6 +142,19 @@ describe SimpleAWS::Response do
       error.code.must_equal 404
       error.message.must_equal " (404): This is a response ok?"
     end
+
+    it "handles errors that have an empty parsed_response" do
+      @http_response.stubs(:code).returns(500)
+      @http_response.stubs(:parsed_response).returns("")
+      @http_response.stubs(:response).returns("Not valid")
+
+      error = lambda {
+        response = SimpleAWS::Response.new @http_response
+      }.must_raise SimpleAWS::UnsuccessfulResponse
+
+      error.code.must_equal 500
+      error.message.must_equal " (500): Not valid"
+    end
   end
 
   describe "successful response parsing and mapping" do

data/test/simple_aws/iam_test.rb

@@ -15,6 +15,12 @@ describe SimpleAWS::IAM do
     @api.version.must_equal "2010-05-08"
   end
 
+  it "does not support region selection" do
+    lambda {
+      SimpleAWS::IAM.new "key", "secret", "us-east-1"
+    }.must_raise ArgumentError
+  end
+
   describe "API calls" do
 
     it "builds and signs calls with ActionParam rules" do

data/test/simple_aws/s3_test.rb

@@ -58,7 +58,7 @@ describe SimpleAWS::S3 do
 
   describe "API calls" do
 
-    [:get, :put, :delete, :head].each do |method|
+    [:get, :post, :put, :delete, :head].each do |method|
       it "supports the #{method} HTTP method" do
         SimpleAWS::Connection.any_instance.expects(:call).with do |request|
           request.method.must_equal method
@@ -141,6 +141,17 @@ describe SimpleAWS::S3 do
       @api.get "/", :body => file
     end
 
+    it "calculates size of body that isn't a File (responds to read)" do
+      raw_body = StringIO.new "raw data"
+
+      SimpleAWS::Connection.any_instance.expects(:call).with do |request|
+        request.headers["Content-Length"].must_equal "8"
+        true
+      end
+
+      @api.get "/", :body => raw_body
+    end
+
     it "uses previously set content type if given" do
       SimpleAWS::Connection.any_instance.expects(:call).with do |request|
         request.headers["Content-Type"].must_equal(
@@ -153,6 +164,15 @@ describe SimpleAWS::S3 do
         :headers => {"Content-Type" => "application/pdf"}
     end
 
+    it "sets the default content-type on post / put if none explicitly given" do
+      SimpleAWS::Connection.any_instance.expects(:call).with do |request|
+        request.headers["Content-Type"].must_equal "application/x-www-form-urlencoded"
+        true
+      end
+
+      @api.put "/", :body => "some random body"
+    end
+
     it "signs the given request according to Version 3 rules" do
       SimpleAWS::Connection.any_instance.expects(:call).with do |request|
         header = request.headers["Authorization"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_aws
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.18
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: The simplest and easiest to use AWS communication library