simple_aws 0.0.1c → 0.0.1d

data/README.md

@@ -122,10 +122,6 @@ These are the following Amazon APIs that SimpleAWS currently handles:
 * Mechanical Turk
 * SQS (Simple Queue Service)
 * SES (Simple Email Service)
-
-Yet to be Implemented
----------------------
-
 * CloudFront
 
 Currently Out-Of-Scope

data/lib/aws/cloud_front.rb

@@ -0,0 +1,117 @@
+require 'aws/api'
+require 'aws/core/util'
+
+module AWS
+
+  ##
+  # Amazon's CloudFront
+  #
+  # http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/Welcome.html
+  #
+  # As CloudFront is much closer to a RESTful service than the other AWS APIs, all
+  # calls through this API are done through these four HTTP METHODS:
+  # GET, PUT, DELETE, and POST.
+  #
+  # The paths for all request get the version prepended on to them, you do not
+  # have to worry about that part of the path. Outside of this, in keeping with
+  # the goals of SimpleAWS, everything else should be exactly as you read it in
+  # the AWS API docs in the link above.
+  #
+  # So "GET Distribution List" is
+  #
+  #   cloud_front.get "/distribution"
+  #
+  # For requests that need extra parameters, use the :params option
+  #
+  #   cloud_front.get "/distribution", :params => {
+  #     "MaxItems" => 10
+  #   }
+  #
+  # Like :params, use :headers to add headers to the request
+  #
+  #   cloud_front.get "/distribution", :headers => {
+  #     "x-amz-security-token" => "security string"
+  #   }
+  #
+  # The details of CloudFront requests are all passed through XML bodies.
+  # To make this as simple and painless as possible, this API supports the
+  # :xml option to turn a Hash into an XML string
+  #
+  #   cloud_front.post "/distribution", :xml => {
+  #     :DistributionConfig => {
+  #       ...
+  #     }
+  #   }
+  #
+  # Do note that this XML building is very simple, does not support attributes,
+  # and will only work on Hashes, Arrays, and objects that can be easily #to_s-ed.
+  # Anything else will error out or might result in invalid request bodies.
+  #
+  # If you already have the XML string and just need to give it to the
+  # request, you can use :body to set the raw value of the request body:
+  #
+  #   cloud_front.post "/distribution", :body => raw_body_xml
+  #
+  # All responses are wrapped in an AWS::Response object.
+  ##
+  class CloudFront < API
+    endpoint "cloudfront"
+    use_https true
+    version "2010-11-01"
+
+    def initialize(key, secret)
+      super(key, secret)
+    end
+
+    [:get, :post, :put, :delete].each do |method|
+      define_method(method) do |*args|
+        self.call method, *args
+      end
+    end
+
+    def call(method, path, options = {})
+      request = AWS::Request.new method, self.uri, "/#{self.version}#{path}"
+
+      (options[:params] || {}).each do |k, v|
+        request.params[k] = v
+      end
+
+      (options[:headers] || {}).each do |k, v|
+        request.headers[k] = v
+      end
+
+      if xml = options[:xml]
+        raise ":xml must be a Hash" unless xml.is_a?(Hash)
+
+        namespace = "http://cloudfront.amazonaws.com/doc/#{self.version}"
+        request.body = AWS::Util.build_xml_from xml, namespace
+        request.headers["Content-Type"] = "text/xml"
+      else
+        request.body = options[:body]
+      end
+
+      connection = AWS::Connection.new
+      connection.call finish_and_sign_request(request)
+    end
+
+    protected
+
+    ##
+    # Build and sign the final request, as per the rules here:
+    # http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/RESTAuthentication.html
+    ##
+    def finish_and_sign_request(request)
+      request.headers["Date"] = Time.now.utc.httpdate
+      request.headers["Authorization"] =
+        "AWS #{self.access_key}:#{Base64.encode64(build_signature_for(request)).chomp}"
+
+      request
+    end
+
+    def build_signature_for(request)
+      date = request.headers["x-amz-date"] || request.headers["Date"]
+
+      OpenSSL::HMAC.digest("sha1", self.secret_key, date)
+    end
+  end
+end

data/lib/aws/core/util.rb

@@ -1,3 +1,5 @@
+require 'ox'
+
 module AWS
   ##
   # Collection of helper methods used in the library
@@ -7,7 +9,7 @@ module AWS
     ##
     # Simpler version of ActiveSupport's camelize
     ##
-    def self.camelcase(string, lower_first_char = false)
+    def camelcase(string, lower_first_char = false)
       return string if string =~ /[A-Z]/
 
       if lower_first_char
@@ -19,7 +21,7 @@ module AWS
 
 
     # AWS URI escaping, as implemented by Fog
-    def self.uri_escape(string)
+    def uri_escape(string)
       # Quick hack for already escaped string, don't escape again
       # I don't think any requests require a % in a parameter, but if
       # there is one I'll need to rethink this
@@ -30,5 +32,52 @@ module AWS
       }
     end
 
+    ##
+    # Take a hash and build a simple XML string from
+    # that Hash. This does not support properties on elements,
+    # and is meant for request bodies like what CloudFront expects.
+    #
+    # The hash body can contain symbols, strings, arrays and hashes
+    ##
+    def build_xml_from(hash, namespace = nil)
+      doc = Ox::Document.new(:version => 1.0, :standalone => true)
+
+      root_key = hash.keys.first
+      root = Ox::Element.new root_key
+      root[:xmlns] = namespace if namespace
+
+      doc << root
+
+      build_body root, hash[root_key]
+
+      %|<?xml version="1.0" encoding="UTF-8"?>#{Ox.dump doc}|
+    end
+
+    extend self
+
+    protected
+
+    def build_body(parent, hash)
+      hash.each do |key, value|
+        case value
+        when Hash
+          node = build_node(key)
+          build_body node, value
+          parent << node
+        when Array
+          value.each do |entry|
+            build_body parent, {key => entry}
+          end
+        else
+          parent << build_node(key, value)
+        end
+      end
+    end
+
+    def build_node(key, value = nil)
+      child = Ox::Element.new key
+      child << value.to_s unless value.nil?
+      child
+    end
   end
 end

data/lib/aws/s3.rb

@@ -1,5 +1,4 @@
 require 'aws/api'
-require 'aws/signing/authorization_header'
 
 module AWS
 
@@ -9,7 +8,7 @@ module AWS
   # http://docs.amazonwebservices.com/AmazonS3/latest/API/Welcome.html
   #
   # As S3 is much closer to a RESTful service than the other AWS APIs, all
-  # calls through this API are done through the four handled HTTP METHODS:
+  # calls through this API are done through these five handled HTTP METHODS:
   # GET, PUT, DELETE, POST and HEAD. When sending a request, follow exactly what
   # is described in the AWS API docs in the link above.
   #
@@ -107,8 +106,6 @@ module AWS
       connection.call finish_and_sign_request(request)
     end
 
-    include Signing::AuthorizationHeader
-
     ##
     # S3 handles region endpoints a little differently
     ##
@@ -122,6 +119,39 @@ module AWS
       @uri
     end
 
+    protected
+
+    ##
+    # Build and sign the final request, as per the rules here:
+    # http://s3.amazonaws.com/doc/s3-developer-guide/RESTAuthentication.html
+    ##
+    def finish_and_sign_request(request)
+      request.headers["Date"] = Time.now.utc.httpdate
+      request.headers["Authorization"] =
+        "AWS #{self.access_key}:#{Base64.encode64(build_signature_for(request)).chomp}"
+
+      request
+    end
+
+    def build_signature_for(request)
+      amazon_headers = request.headers.select {|k, v|
+        k =~ /^x-amz/i
+      }.map {|k, v|
+        "#{k.downcase}:#{v}".chomp
+      }
+
+      to_sign = [
+        request.method.to_s.upcase,
+        request.headers["Content-Md5"] || "",
+        request.headers["Content-Type"] || "",
+        request.headers["Date"],
+        amazon_headers,
+        request.path
+      ].flatten.join("\n")
+
+      OpenSSL::HMAC.digest("sha1", self.secret_key, to_sign)
+    end
+
   end
 
 end

data/samples/cloud_front.rb

@@ -0,0 +1,52 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'aws/cloud_front'
+
+##
+# Expects your Amazon keys to be in the environment, something like
+#
+# export AWS_KEY="KEY"
+# export AWS_SECRET="SECRET"
+##
+
+cloud_front = AWS::CloudFront.new ENV["AWS_KEY"], ENV["AWS_SECRET"]
+
+puts "First ten distribution items:", ""
+
+cloud_front.get("/distribution", :params => {"MaxItems" => 10}).distribution_summary.each do |d|
+  puts "ID: #{d.id}"
+  puts "Domain: #{d.domain_name}"
+  if d["CustomOrigin"]
+    puts "Custom Origin: #{d.custom_origin.inspect}"
+  elsif d["S3Origin"]
+    puts "S3 Origin: #{d.s3_origin.inspect}"
+  end
+  puts "Status: #{d.status}"
+  puts ""
+end
+
+# Leaving this commented out. It works, but you can't quickly
+# delete the new distribution so you'll have to clean up manually
+#
+#puts "", "Creating new test distribution", ""
+#
+#response = cloud_front.post "/distribution", :xml => {
+#  "DistributionConfig" => {
+#    "CustomOrigin" => {
+#      "DNSName" => "cnd.example.com",
+#      "HTTPPort" => 80,
+#      "OriginProtocolPolicy" => "http-only"
+#    },
+#    "CallerReference" => "simple_aws_testing_#{rand(100_000)}",
+#    "Enabled" => false
+#  }
+#}
+#
+#p response
+#
+#id = response.id
+#etag = response.headers["etag"]
+#
+#puts ""
+#puts "Created distribution with id #{id} and etag #{etag}."
+#puts "It's at domain #{response.domain_name}"

data/simple_aws.gemspec

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

data/test/aws/cloud_front_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+require 'aws/cloud_front'
+
+describe AWS::CloudFront do
+
+  before do
+    @api = AWS::CloudFront.new "key", "secret"
+  end
+
+  it "points to the endpoint" do
+    @api.uri.must_equal "https://cloudfront.amazonaws.com"
+  end
+
+  it "does not support region selection" do
+    lambda {
+      AWS::CloudFront.new "key", "secret", "us-east-1"
+    }.must_raise ArgumentError
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2010-11-01"
+  end
+
+  describe "API calls" do
+
+    [:get, :post, :put, :delete].each do |method|
+      it "supports the #{method} HTTP method" do
+        AWS::Connection.any_instance.expects(:call).with do |request|
+          request.method.must_equal method
+          true
+        end
+
+        @api.send method, "/"
+      end
+    end
+
+    it "pre-pends the version to the path for every request" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        request.path.must_equal "/2010-11-01/"
+        true
+      end
+
+      @api.get "/"
+    end
+
+    it "takes parameters" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        request.params["Parameter1"].must_equal "Value2"
+        true
+      end
+
+      @api.get "/", :params => { "Parameter1" => "Value2" }
+    end
+
+    it "takes a raw body" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        request.body.must_equal "This is a body of text"
+        true
+      end
+
+      @api.get "/", :body => "This is a body of text"
+    end
+
+    it "uses :xml to take a hash and build XML from it" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        request.headers["Content-Type"].must_equal "text/xml"
+        request.body.must_match(/amazonaws\.com\/doc\//)
+        request.body.must_match(/<InnerNode>/)
+        true
+      end
+
+      @api.get "/", :xml => {:RootNode => { :InnerNode => "Value" } }
+    end
+
+    it "complains if :xml doesn't contain a Hash" do
+      error = lambda {
+        @api.get "/", :xml => "not a hash"
+      }.must_raise RuntimeError
+
+      error.message.must_match /must be a Hash/
+    end
+
+    it "takes extra headers" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        request.headers["Header14"].must_equal "Out to Lunch"
+        true
+      end
+
+      @api.get "/", :headers => { "Header14" => "Out to Lunch" }
+    end
+
+    it "signs the given request according to Version 3 rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        request.headers["Authorization"].wont_be_nil
+        header = request.headers["Authorization"]
+        parts = header.split(":")
+
+        parts[0].must_equal "AWS key"
+        parts[1].wont_be_nil
+
+        Time.parse(request.headers["Date"]).wont_be_nil
+        true
+      end.returns
+
+      @api.get "/"
+    end
+  end
+
+end

data/test/aws/core/util_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+require 'aws/core/util'
+
+describe AWS::Util do
+
+  describe "#build_xml_from" do
+    it "takes a hash and builds XML" do
+      response = AWS::Util.build_xml_from :RootNode => { :InnerNode => "Value" }
+
+      response.must_equal <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<RootNode>
+  <InnerNode>Value</InnerNode>
+</RootNode>
+END
+    end
+
+    it "will add namespace to the root node" do
+      response = AWS::Util.build_xml_from(
+        {:RootNode => { :InnerNode => "Value" }},
+        "http://cloudfront.amazonaws.com/doc/2010-11-01/"
+      )
+
+      response.must_equal <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<RootNode xmlns="http://cloudfront.amazonaws.com/doc/2010-11-01/">
+  <InnerNode>Value</InnerNode>
+</RootNode>
+END
+    end
+
+    it "works with arrays of items" do
+      response = AWS::Util.build_xml_from(
+        {:RootNode => { :InnerNode => ["Value1", "Value2", "Value3"] }}
+      )
+
+      response.must_equal <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<RootNode>
+  <InnerNode>Value1</InnerNode>
+  <InnerNode>Value2</InnerNode>
+  <InnerNode>Value3</InnerNode>
+</RootNode>
+END
+    end
+
+    it "works at any nestedness of hashes" do
+      response = AWS::Util.build_xml_from(
+        :RootNode => {
+          :InnerNode => [
+            {:Child => "Value1"},
+            {:Child => "Value2"}
+          ]
+        }
+      )
+
+      response.must_equal <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<RootNode>
+  <InnerNode>
+    <Child>Value1</Child>
+  </InnerNode>
+  <InnerNode>
+    <Child>Value2</Child>
+  </InnerNode>
+</RootNode>
+END
+    end
+
+    it "auto-strings all leaf nodes" do
+      response = AWS::Util.build_xml_from(
+        :RootNode => { :BoolVal => true, :Number => 12, :BadBool => false }
+      )
+
+      response.must_equal <<END
+<?xml version="1.0" encoding="UTF-8"?>
+<RootNode>
+  <BoolVal>true</BoolVal>
+  <Number>12</Number>
+  <BadBool>false</BadBool>
+</RootNode>
+END
+    end
+  end
+
+end

data/test/aws/s3_test.rb

@@ -96,13 +96,20 @@ describe AWS::S3 do
       @api.get "/", :file => "This is a body of text"
     end
 
-    it "signs the request using the Authorization header" do
+    it "signs the given request according to Version 3 rules" do
       AWS::Connection.any_instance.expects(:call).with do |request|
-        request.headers["Authorization"].wont_be_nil
+        header = request.headers["Authorization"]
+        parts = header.split(":")
+
+        parts[0].must_equal "AWS key"
+        parts[1].wont_be_nil
+
+        Time.parse(request.headers["Date"]).wont_be_nil
         true
-      end
+      end.returns
 
       @api.get "/"
     end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_aws
 version: !ruby/object:Gem::Version
-  version: 0.0.1c
+  version: 0.0.1d
   prerelease: 5
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
-  requirement: &70146086124160 !ruby/object:Gem::Requirement
+  requirement: &70172190923080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146086124160
+  version_requirements: *70172190923080
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70146086123740 !ruby/object:Gem::Requirement
+  requirement: &70172190922660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146086123740
+  version_requirements: *70172190922660
 - !ruby/object:Gem::Dependency
   name: httmultiparty
-  requirement: &70146086123280 !ruby/object:Gem::Requirement
+  requirement: &70172190922220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146086123280
+  version_requirements: *70172190922220
 description: The simplest and easiest to use and maintain AWS communication library
 email:
 - jameskilton@gmail.com
@@ -60,6 +60,7 @@ files:
 - lib/aws/auto_scaling.rb
 - lib/aws/call_types/action_param.rb
 - lib/aws/cloud_formation.rb
+- lib/aws/cloud_front.rb
 - lib/aws/cloud_watch.rb
 - lib/aws/core/connection.rb
 - lib/aws/core/request.rb
@@ -76,11 +77,11 @@ files:
 - lib/aws/rds.rb
 - lib/aws/s3.rb
 - lib/aws/ses.rb
-- lib/aws/signing/authorization_header.rb
 - lib/aws/signing/version2.rb
 - lib/aws/signing/version3.rb
 - lib/aws/sns.rb
 - lib/aws/sqs.rb
+- samples/cloud_front.rb
 - samples/ec2.rb
 - samples/elb.rb
 - samples/iam.rb
@@ -92,10 +93,12 @@ files:
 - test/aws/auto_scaling_test.rb
 - test/aws/call_types/action_param_test.rb
 - test/aws/cloud_formation_test.rb
+- test/aws/cloud_front_test.rb
 - test/aws/cloud_watch_test.rb
 - test/aws/core/connection_test.rb
 - test/aws/core/request_test.rb
 - test/aws/core/response_test.rb
+- test/aws/core/util_test.rb
 - test/aws/ec2_test.rb
 - test/aws/elasti_cache_test.rb
 - test/aws/elastic_beanstalk_test.rb
@@ -107,7 +110,6 @@ files:
 - test/aws/rds_test.rb
 - test/aws/s3_test.rb
 - test/aws/ses.rb
-- test/aws/signing/authorization_header_test.rb
 - test/aws/signing/version2_test.rb
 - test/aws/signing/version3.rb
 - test/aws/sns_test.rb
@@ -142,10 +144,12 @@ test_files:
 - test/aws/auto_scaling_test.rb
 - test/aws/call_types/action_param_test.rb
 - test/aws/cloud_formation_test.rb
+- test/aws/cloud_front_test.rb
 - test/aws/cloud_watch_test.rb
 - test/aws/core/connection_test.rb
 - test/aws/core/request_test.rb
 - test/aws/core/response_test.rb
+- test/aws/core/util_test.rb
 - test/aws/ec2_test.rb
 - test/aws/elasti_cache_test.rb
 - test/aws/elastic_beanstalk_test.rb
@@ -157,7 +161,6 @@ test_files:
 - test/aws/rds_test.rb
 - test/aws/s3_test.rb
 - test/aws/ses.rb
-- test/aws/signing/authorization_header_test.rb
 - test/aws/signing/version2_test.rb
 - test/aws/signing/version3.rb
 - test/aws/sns_test.rb

data/lib/aws/signing/authorization_header.rb

@@ -1,43 +0,0 @@
-require 'openssl'
-
-module AWS
-  module Signing
-    ##
-    # Implementation of signing using the Authorization header, as used by S3 and CloudFront
-    ##
-    module AuthorizationHeader
-
-      ##
-      # Build and sign the final request, as per the rules here:
-      # http://s3.amazonaws.com/doc/s3-developer-guide/RESTAuthentication.html
-      ##
-      def finish_and_sign_request(request)
-        request.headers["Date"] = Time.now.utc.httpdate
-        request.headers["Authorization"] =
-          "AWS #{self.access_key}:#{Base64.encode64(build_signature_for(request)).chomp}"
-
-        request
-      end
-
-      def build_signature_for(request)
-        amazon_headers = request.headers.select {|k, v|
-          k =~ /^x-amz/i
-        }.map {|k, v|
-          "#{k.downcase}:#{v}".chomp
-        }
-
-        to_sign = [
-          request.method.to_s.upcase,
-          request.headers["Content-Md5"] || "",
-          request.headers["Content-Type"] || "",
-          request.headers["Date"],
-          amazon_headers,
-          request.path
-        ].flatten.join("\n")
-
-        OpenSSL::HMAC.digest("sha1", self.secret_key, to_sign)
-      end
-
-    end
-  end
-end

data/test/aws/signing/authorization_header_test.rb

@@ -1,33 +0,0 @@
-require 'test_helper'
-require 'aws/api'
-require 'aws/call_types/action_param'
-require 'aws/signing/authorization_header'
-
-describe AWS::Signing::AuthorizationHeader do
-
-  class SigningAuthHeaderTestAPI < AWS::API
-    endpoint "aptest"
-    version "2011-01-01"
-    use_https true
-
-    include AWS::CallTypes::ActionParam
-    include AWS::Signing::AuthorizationHeader
-  end
-
-  it "signs the given request according to Version 3 rules" do
-    AWS::Connection.any_instance.expects(:call).with do |request|
-      header = request.headers["Authorization"]
-      parts = header.split(":")
-
-      parts[0].must_equal "AWS key"
-      parts[1].wont_be_nil
-
-      Time.parse(request.headers["Date"]).wont_be_nil
-      true
-    end.returns
-
-    obj = SigningAuthHeaderTestAPI.new "key", "secret"
-    obj.describe_instances
-  end
-
-end