right_aws_api 0.2.0 → 0.2.2

data/lib/cloud/aws/s3/wrappers/default.rb

@@ -61,11 +61,11 @@ module RightScale
 
 
               base.query_api_pattern 'DeleteBucketPolicy', :delete, '{:Bucket}',
-                :params => { 'policy' => nil }
+                :params => { 'policy' => '' }
 
 
               base.query_api_pattern 'DeleteBucketWebsite', :delete, '{:Bucket}',
-                :params => { 'website' => nil }
+                :params => { 'website' => '' }
 
 
               base.query_api_pattern 'ListObjects', :get, '{:Bucket}'
@@ -73,130 +73,131 @@ module RightScale
 
 
               base.query_api_pattern 'GetBucketAcl', :get, '{:Bucket}',
-                :params => { 'acl'=> nil }
+                :params => { 'acl'=> '' }
 
 
               base.query_api_pattern 'GetBucketPolicy',  :get, '{:Bucket}',
-                :params => { 'policy'=> nil }
+                :params => { 'policy'=> '' }
 
 
               base.query_api_pattern 'GetBucketLocation',  :get, '{:Bucket}',
-                :params => { 'location'=> nil }
+                :params => { 'location'=> '' }
 
 
               base.query_api_pattern 'GetBucketLogging',  :get, '{:Bucket}',
-                :params => { 'logging'=> nil }
+                :params => { 'logging'=> '' }
 
 
               base.query_api_pattern 'GetBucketNotification', :get, '{:Bucket}',
-                :params => { 'notification'=> nil }
+                :params => { 'notification'=> '' }
 
 
               base.query_api_pattern 'GetBucketVersions',  :get, '{:Bucket}',
-                :params => { 'versions'=> nil }
+                :params => { 'versions'=> '' }
 
 
               base.query_api_pattern 'GetBucketRequestPayment', :get, '{:Bucket}',
-                :params => { 'requestPayment'=> nil }
+                :params => { 'requestPayment'=> '' }
 
 
               base.query_api_pattern 'GetBucketVersioning', :get, '{:Bucket}',
-                :params => { 'versioning'=> nil }
+                :params => { 'versioning'=> '' }
 
 
               base.query_api_pattern 'GetBucketWebsite', :get, '{:Bucket}',
-                :params => { 'website'=> nil }
+                :params => { 'website'=> '' }
 
 
               base.query_api_pattern 'ListMultipartUploads',  :get, '{:Bucket}',
-                :params => { 'uploads'=> nil }
+                :params => { 'uploads'=> '' }
 
 
-              base.query_api_pattern 'PutBucket', :put, '{:Bucket}'
+              base.query_api_pattern 'PutBucket', :put, '{:Bucket}',
+                :headers => { 'content-type' => 'application/xml' }
 
 
               base.query_api_pattern 'PutBucketAcl', :put, '{:Bucket}',
-                :params  => { 'acl' => nil },
+                :params  => { 'acl' => '' },
                 :body    => { 'AccessControlPolicy' => :AccessControlPolicy },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'PutBucketPolicy', :put, '{:Bucket}',
-                :params  => { 'policy' => nil },
+                :params  => { 'policy' => '' },
                 :body    => Utils::MUST_BE_SET,
                 :headers => { 'content-type' => 'application/json' }
 
 
               base.query_api_pattern 'PutBucketLogging', :put, '{:Bucket}',
-                :params  => { 'logging' => nil },
+                :params  => { 'logging' => '' },
                 :body    => { 'BucketLoggingStatus' => :BucketLoggingStatus },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'PutBucketNotification', :put, '{:Bucket}',
-                :params  => { 'notification' => nil },
+                :params  => { 'notification' => '' },
                 :body    => { 'NotificationConfiguration' => :NotificationConfiguration },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'PutBucketRequestPayment', :put, '{:Bucket}',
-                :params => { 'requestPayment' => nil },
+                :params => { 'requestPayment' => '' },
                 :body   => { 'RequestPaymentConfiguration' => :RequestPaymentConfiguration },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'PutBucketVersioning', :put, '{:Bucket}',
-                :params  => { 'versioning' => nil },
+                :params  => { 'versioning' => '' },
                 :body    => { 'VersioningConfiguration' => :VersioningConfiguration },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'PutBucketWebsite', :put, '{:Bucket}',
-                :params  => { 'website' => nil },
+                :params  => { 'website' => '' },
                 :body    => { 'WebsiteConfiguration' => :WebsiteConfiguration },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'GetBucketCors', :get, '{:Bucket}',
-                :params => { 'cors'=> nil }
+                :params => { 'cors'=> '' }
 
 
               base.query_api_pattern 'DeleteBucketCors',  :delete, '{:Bucket}',
-                :params => { 'cors'=> nil }
+                :params => { 'cors'=> '' }
 
 
               base.query_api_pattern 'PutBucketCors',  :put, '{:Bucket}',
-                :params  => { 'cors'=> nil },
+                :params  => { 'cors'=> '' },
                 :body    => { 'CORSConfiguration' => { 'CORSRule' => :CORSRule } },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'GetBucketTagging', :get, '{:Bucket}',
-                :params => { 'tagging' => nil }
+                :params => { 'tagging' => '' }
 
 
               base.query_api_pattern 'PutBucketTagging', :put, '{:Bucket}',
-                :params  => { 'tagging' => nil },
+                :params  => { 'tagging' => '' },
                 :body    => { 'Tagging' => { 'TagSet' => { 'Tag' => :TagSet } } },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'DeleteBucketTagging', :delete, '{:Bucket}',
-                :params => { 'tagging' => nil }
+                :params => { 'tagging' => '' }
 
 
               base.query_api_pattern 'GetBucketLifecycle', :get, '{:Bucket}',
-                :params => { 'lifecycle' => nil }
+                :params => { 'lifecycle' => '' }
 
 
               base.query_api_pattern 'PutBucketLifecycle', :put, '{:Bucket}',
-                :params  => { 'lifecycle' => nil },
+                :params  => { 'lifecycle' => '' },
                 :body    => { 'LifecycleConfiguration' => { 'Rule' => :Rule } },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'DeleteBucketLifecycle', :delete, '{:Bucket}',
-                :params => { 'lifecycle' => nil }
+                :params => { 'lifecycle' => '' }
 
 
               #-----------------
@@ -208,7 +209,8 @@ module RightScale
 
 
               base.query_api_pattern 'DeleteMultipleObjects', :post, '{:Bucket}',
-                :params => { 'delete' => nil },
+              :headers => { 'content-type' => 'application/xml'},
+              :params => { 'delete' => '' },
               :body   => { 'Delete' => {
                              'Quiet'             => :Quiet,
                              'Object[{:Object}]' => {
@@ -236,11 +238,11 @@ module RightScale
 
 
               base.query_api_pattern 'GetObjectAcl', :get, '{:Bucket}/{:Object}',
-                :params => { 'acl' => nil }
+                :params => { 'acl' => '' }
 
 
               base.query_api_pattern 'GetObjectTorrent', :get, '{:Bucket}/{:Object}',
-                :params => { 'torrent'=> nil }
+                :params => { 'torrent'=> '' }
 
 
               base.query_api_pattern 'HeadObject', :head, '{:Bucket}/{:Object}'
@@ -255,13 +257,13 @@ module RightScale
 
 
               base.query_api_pattern 'PutObjectAcl', :put, '{:Bucket}/{:Object}',
-                :params  => { 'acl'=> nil },
+                :params  => { 'acl'=> '' },
                 :body    => { 'AccessControlPolicy' => :AccessControlPolicy },
                 :headers => { 'content-type' => 'application/xml'}
 
 
               base.query_api_pattern 'PutObjectCannedAcl', :put, '{:Bucket}/{:Object}',
-                :params  => { 'acl' => nil },
+                :params  => { 'acl' => '' },
                 :headers => { 'x-amz-acl' => :Acl, 'content-type' => 'application/xml'}
 
 
@@ -278,7 +280,7 @@ module RightScale
 
 
               base.query_api_pattern 'InitiateMultipartUpload', :post, '{:Bucket}/{:Object}',
-                :params => { 'uploads' => nil }
+                :params => { 'uploads' => '' }
 
 
               base.query_api_pattern 'UploadPart', :post, '{:Bucket}/{:Object}',

data/lib/cloud/aws/sqs/manager.rb

@@ -22,7 +22,7 @@
 #++
 
 require "cloud/aws/base/helpers/utils"
-require "cloud/aws/base/routines/request_signer"
+require "cloud/aws/sqs/routines/request_signer"
 require "cloud/aws/base/parsers/response_error"
 
 module RightScale
@@ -206,7 +206,7 @@ module RightScale
 
           set_routine CloudApi::RetryManager
           set_routine CloudApi::RequestInitializer
-          set_routine AWS::RequestSigner
+          set_routine AWS::SQS::RequestSigner
           set_routine CloudApi::RequestGenerator
           set_routine CloudApi::RequestAnalyzer
           set_routine CloudApi::ConnectionProxy

data/lib/cloud/aws/sqs/routines/request_signer.rb

@@ -0,0 +1,62 @@
+#--
+# Copyright (c) 2013 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module RightScale
+  module CloudApi
+    module AWS
+      module SQS
+        # SQS Request signer
+        class RequestSigner < CloudApi::Routine
+
+          # RequestSigner error
+          class Error < CloudApi::Error
+          end
+
+          # Authenticates an SQS request
+          #
+          # @return [void]
+          #
+          # @example
+          #  no example
+          #
+          def process
+            # Compile a final request path
+            @data[:request][:path] = Utils::join_urn(@data[:connection][:uri].path, @data[:request][:relative_path])
+
+            # Swap query params and body
+            @data[:request][:params]['Version'] ||= @data[:options][:api_version]
+            #@data[:request][:body]   = Utils::params_to_urn(@data[:request][:params]){ |value| Utils::AWS::amz_escape(value) }
+            #@data[:request][:params] = {}
+
+            Utils::AWS::sign_v4_signature(
+              @data[:credentials][:aws_access_key_id],
+              @data[:credentials][:aws_secret_access_key],
+              @data[:connection][:uri].host,
+              @data[:request]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/right_aws_api_version.rb

@@ -33,7 +33,7 @@ module RightScale
       # Gem version namespace
       module VERSION
         # Current version
-        STRING = '0.2.0'
+        STRING = '0.2.2'
       end
     end
   end

data/right_aws_api.gemspec

@@ -35,10 +35,11 @@ Gem::Specification.new do |spec|
   spec.require_path     = 'lib'
   spec.required_ruby_version = '>= 1.8.7'
 
-  spec.add_dependency 'right_cloud_api_base', '>= 0.1.0'
+  spec.add_dependency 'right_cloud_api_base', '>= 0.2.1'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'timecop'
 
   spec.description = <<-EOF
 == DESCRIPTION:

data/spec/cloud/aws/base/helpers/utils_spec.rb

@@ -0,0 +1,298 @@
+require_relative '../../../../../lib/right_aws_api'
+
+require 'rspec'
+require 'timecop'
+
+describe RightScale::CloudApi::Utils::AWS do
+  subject do
+    RightScale::CloudApi::Utils::AWS
+  end
+
+  context "signature v4" do
+
+    context "sign_v4_get_service_and_region" do
+      context "weird unknown host" do
+        it "fails" do
+          expect{
+            subject.sign_v4_get_service_and_region('foo.bar.com')
+          }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "host with no service" do
+        it "fails" do
+          expect{
+            subject.sign_v4_get_service_and_region('foo.amazonaws.com')
+          }.to raise_error(ArgumentError,/service/)
+        end
+      end
+
+      context "S3" do
+        it "works" do
+          expect(
+            subject.sign_v4_get_service_and_region('s3.amazonaws.com')
+          ).to eq ['s3', 'us-east-1']
+
+          expect(
+            subject.sign_v4_get_service_and_region('xxx.s3.amazonaws.com')
+          ).to eq ['s3', 'us-east-1']
+
+          expect(
+            subject.sign_v4_get_service_and_region('s3-external-1.amazonaws.com')
+          ).to eq ['s3', 'us-east-1']
+
+          expect(
+            subject.sign_v4_get_service_and_region('s3-region-1.amazonaws.com')
+          ).to eq ['s3', 'region-1']
+
+          expect(
+            subject.sign_v4_get_service_and_region('xxx.s3-region-1.amazonaws.com')
+          ).to eq ['s3', 'region-1']
+
+          expect(
+            subject.sign_v4_get_service_and_region('s3.region-1.amazonaws.com')
+          ).to eq ['s3', 'region-1']
+
+          expect(
+            subject.sign_v4_get_service_and_region('xxx.s3.region-1.amazonaws.com')
+          ).to eq ['s3', 'region-1']
+        end
+      end
+
+
+      context "any other service with standard endpoint" do
+        it "works" do
+          expect(
+            subject.sign_v4_get_service_and_region('ec2.region-1.amazonaws.com')
+          ).to eq ['ec2', 'region-1']
+        end
+      end
+    end
+
+
+    context "sign_v4_get_canonical_verb" do
+      it "uppercases the given verb" do
+        expect( subject.sign_v4_get_canonical_verb(:delete) ).to eq 'DELETE'
+      end
+    end
+
+
+    context "sign_v4_get_canonical_path" do
+      it "does nothing to the given path" do
+        expect( subject.sign_v4_get_canonical_path('foo/bar') ).to eq 'foo/bar'
+      end
+    end
+
+
+    context "sign_v4_get_canonical_headers" do
+      it "works" do
+        headers = {
+          'foo' => 'x',
+          'bar' => 'y,z'
+        }
+        expect(
+          subject.sign_v4_get_canonical_headers(headers)
+        ).to eq "bar:y,z\nfoo:x"
+      end
+    end
+
+
+    context "sign_v4_get_signed_headers" do
+      it "works" do
+        headers = {
+          'foo' => 'x',
+          'bar' => 'y,z'
+        }
+        expect(
+          subject.sign_v4_get_signed_headers(headers)
+        ).to eq "bar;foo"
+      end
+    end
+
+
+    context "sign_v4_headers" do
+      it "builds credential params" do
+        request = {
+          :headers => RightScale::CloudApi::HTTPHeaders.new,
+          :params  => { 'A' => 'B' },
+          :body    => "banana"
+        }
+        expect(
+          subject.sign_v4_headers(
+            request,
+            "ec2.region-1.amazonaws.com",
+            "20141103T150750Z"
+          )
+        ).to eq "b493d48364afe44d11c0165cf470a4164d1e2609911ef998be868d46ade3de4e"
+
+        expect(request).to eq(
+          {
+            :body    => "banana",
+            :params  => { 'A' => 'B' },
+            :headers => {
+              "content-length"       => [6],
+              "content-type"         => ["application/x-www-form-urlencoded; charset=utf-8"],
+              "content-md5"          => ["crMCvyl6Iop1cwEj7+98QQ=="],
+              "x-amz-content-sha256" => ["b493d48364afe44d11c0165cf470a4164d1e2609911ef998be868d46ade3de4e"],
+              "x-amz-date"           => ["20141103T150750Z"],
+              "x-amz-expires"        => [3600]
+            }
+          }
+        )
+      end
+    end
+
+
+    context "sign_v4_query_params" do
+      it "builds credential params" do
+        request = { :params => {} }
+        expect(
+          subject.sign_v4_query_params(
+            request,
+            "AWS4-HMAC-SHA256",
+            "20141103T150750Z",
+            "host;content-type",
+            "aws_access_key",
+            "20141103/region-1/ec2/aws4_request"
+          )
+        ).to eq "UNSIGNED-PAYLOAD"
+
+        expect(request).to eq(
+          {
+            :params => {
+              "X-Amz-Date"          => "20141103T150750Z",
+              "X-Amz-Expires"       => 3600,
+              "X-Amz-Algorithm"     => "AWS4-HMAC-SHA256",
+              "X-Amz-SignedHeaders" => "host;content-type",
+              "X-Amz-Credential"    => "aws_access_key/20141103/region-1/ec2/aws4_request"
+            }
+          }
+        )
+      end
+    end
+
+
+    context "sign_v4_get_canonical_string" do
+      it "joins things properly" do
+        expect(
+          subject.sign_v4_get_canonical_string(
+            'verb',
+            'path',
+            'query_string',
+            'headers',
+            'signed_headers',
+            'payload'
+          )
+        ).to eq "verb\npath\nquery_string\nheaders\n\nsigned_headers\npayload"
+      end
+    end
+
+
+    context "sign_v4_get_string_to_sign" do
+      it "joins things properly" do
+        expect(
+          subject.sign_v4_get_string_to_sign('algorithm', 'current_time', 'creds_scope', 'canonical_string')
+        ).to eq "algorithm\ncurrent_time\ncreds_scope\ne32453154e605024921ee9c5eb4ee7eba458cbd2b387c9ac74e729f9fd7cb81b"
+      end
+    end
+
+
+    context "sign_v4_get_signature_key" do
+      it "works" do
+        expect(
+          subject.sign_v4_get_signature_key('key', 'string_to_sign', 'date', 'region', 'service')
+        ).to eq "0eb6bf1678c804d70bdda801326b3b70080ff19f2cb381e28231b2dcdd445b7c"
+      end
+    end
+
+
+    context "hex_encode" do
+      it "works" do
+        expect(
+          subject.hex_encode('HelloWorld!')
+        ).to eq "48656c6c6f576f726c6421"
+      end
+    end
+
+
+    context "sign_v4_signature" do
+      context "signature in headers" do
+        it 'works' do
+          request = {
+            :verb    => :post,
+            :path    => '/foo/bar',
+            :headers => RightScale::CloudApi::HTTPHeaders.new,
+            :params  => { 'A' => 'B' },
+            :body    => "banana"
+          }
+          Timecop.freeze(Time.local(2014)) do
+            subject.sign_v4_signature(
+              'aws_access_key',
+              'aws_secret_access_key',
+              'ec2.us-region-1.amazonaws.com',
+              request,
+            )
+          end
+          expect(request).to eq(
+            {
+              :body    => "banana",
+              :headers => {
+                "content-length"       => [6],
+                "content-type"         => ["application/x-www-form-urlencoded; charset=utf-8"],
+                "content-md5"          => ["crMCvyl6Iop1cwEj7+98QQ=="],
+                "x-amz-content-sha256" => ["b493d48364afe44d11c0165cf470a4164d1e2609911ef998be868d46ade3de4e"],
+                "x-amz-date"           => ["20140101T080000Z"],
+                "x-amz-expires"        => [3600],
+                "host"                 => ["ec2.us-region-1.amazonaws.com"],
+                "authorization"        => ["AWS4-HMAC-SHA256 Credential=aws_access_key/20140101/us-region-1/ec2/aws4_request, SignedHeaders=content-length;content-md5;content-type;host;x-amz-content-sha256;x-amz-date;x-amz-expires, Signature=c7814d3865b530322742b73670475ac5adb0c1bd4ab39ecf9b80d672283fc177"]
+              },
+              :params  => {"A" => "B"},
+              :path    => "/foo/bar?A=B",
+              :verb    => :post
+            }
+          )
+        end
+      end
+
+
+      context "signature in query params" do
+        it 'works' do
+          request = {
+            :verb    => :post,
+            :path    => '/foo/bar',
+            :headers => RightScale::CloudApi::HTTPHeaders.new,
+            :params  => { 'A' => 'B' },
+            :body    => "banana"
+          }
+          Timecop.freeze(Time.local(2014)) do
+            subject.sign_v4_signature(
+              'aws_access_key',
+              'aws_secret_access_key',
+              'ec2.us-region-1.amazonaws.com',
+              request,
+              :query_params
+            )
+          end
+          expect(request).to eq(
+            {
+              :body    => "banana",
+              :headers => {"host"=>["ec2.us-region-1.amazonaws.com"]},
+              :params  => {
+                "A"                   => "B",
+                "X-Amz-Date"          => "20140101T080000Z",
+                "X-Amz-Expires"       => 3600,
+                "X-Amz-Algorithm"     => "AWS4-HMAC-SHA256",
+                "X-Amz-SignedHeaders" => "host",
+                "X-Amz-Credential"    => "aws_access_key/20140101/us-region-1/ec2/aws4_request"
+              },
+              :path    => "/foo/bar?A=B&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=aws_access_key%2F20140101%2Fus-region-1%2Fec2%2Faws4_request&X-Amz-Date=20140101T080000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0fcac655717af1f947fc0942cc2a2e98fddfe71cf669b0a344235bb83684c9cf",
+              :verb    => :post
+            }
+          )
+        end
+      end
+
+    end
+
+  end
+end