aws-sdk 1.5.8 → 1.6.0

data/lib/aws/core/rest_client.rb

@@ -0,0 +1,90 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/core/rest_client/input_handler'
+require 'aws/core/rest_client/output_handler'
+
+module AWS
+  module Core
+    module RESTClient
+
+      # @private
+      def self.extended base
+        base.send(:include, ErrorParser)
+        base.send(:define_handlers)
+      end
+
+      # @private
+      def input_handlers
+        @input_handlers ||= {}
+      end
+
+      # @private
+      def output_handlers
+        @output_handlers ||= {}
+      end
+
+      protected
+
+      # Enumerates through the operations specified in the API
+      # configuration (yaml configuration file found in lib/api_config/)
+      # and defines a request and a response handler for each operation.
+      def define_handlers
+        namespace = api_config[:namespace]
+        api_config[:operations].each_pair do |method,operation|
+          input_handlers[method] = InputHandler.new(namespace, operation)
+          output_handlers[method] = OutputHandler.new(operation)
+        end
+      end
+
+      def define_client_method method_name, operation_name
+        add_client_request_method(method_name) do
+
+          configure_request do |request, request_options|
+            handler = self.class.input_handlers[method_name]
+            handler.populate_request(request, request_options)
+          end
+
+          process_response do |response|
+            handler = self.class.output_handlers[method_name]
+            response.data = handler.extract_data(response)
+          end
+
+          simulate_response do |response|
+            handler = self.class.output_handlers[method_name]
+            response.data = handler.simulate
+          end
+
+        end
+      end
+
+      module ErrorParser
+
+        protected
+
+        def extract_error_details response
+          if
+            response.http_response.status >= 300 and
+            body = response.http_response.body and
+            error = errors_module::GRAMMAR.parse(body) and
+            error[:code]
+          then
+            [error[:code], error[:message]]
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/aws/core/rest_client/input_handler.rb

@@ -0,0 +1,145 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'builder'
+
+module AWS
+  module Core
+    module RESTClient
+
+      # Given a hash of request options, a REST::RequestHandler can
+      # populate a Core::Http::Request object.
+      class InputHandler
+
+        # @param [String] namespace
+        # @param [Hash] configuration
+        # @option operation [required,Hash] :http REST traits.
+        # @option operation [required,Hash] :inputs Rules for serializing
+        #   request options.
+        # @private
+        def initialize namespace, configuration
+          @namespace = namespace
+          @operation_name = configuration[:name]
+          @http = configuration[:http]
+          @rules = configuration[:inputs]
+        end
+
+        # @return [String]
+        attr_reader :namespace
+
+        # @return [String]
+        attr_reader :operation_name
+
+        # @return [Hash] A hash of http rules.
+        attr_reader :http
+
+        # @return [Hash] A hash of rules for where to place request options
+        #   in the HTTP request (e.g. uri, querystring, header, body, etc).
+        #   Also contains type information for each request option.
+        attr_reader :rules
+
+        # Populates an http request object with params in the uri, headers,
+        # and body.
+        # @param [Http::Request] request
+        # @param [Hash] request_options A hash of options to send with
+        #   the request.
+        # @raise [ArgumentError] Raises ArgumentError when any of the
+        #   request options are invalid (wrong type, missing, unknown, etc).
+        # @return [Http::Request]
+        def populate_request request, request_options
+
+          params = Options::Validator.new(rules).validate!(request_options)
+
+          request.http_method = http[:verb]
+          request.uri = extract_uri(params)
+          extract_headers(params).each_pair do |header_name, header_value|
+            request.headers[header_name] = header_value
+          end
+          request.body = build_body(params)
+          request
+
+        end
+
+        protected
+
+        # @param [Hash] params
+        # @return [String]
+        def extract_uri params
+
+          path, querystring = http[:uri].split(/\?/)
+
+          uri = path.gsub(/:\w+/) do |param_name|
+            unless param = params.delete(param_name[1..-1].to_sym)
+              msg = "missing required uri argument :#{param_name[1..-1]}"
+              raise ArgumentError, msg
+            end
+            UriEscape.escape(param)
+          end
+
+          querystring_parts = []
+          querystring.to_s.split(/&/).each do |part|
+            param_name = part.match(/:(\w+)/)[1]
+            if param = params.delete(param_name.to_sym)
+              param = UriEscape.escape(param)
+              querystring_parts << part.sub(/:#{param_name}/, param)
+            end
+          end
+
+          unless querystring_parts.empty?
+            uri << "?#{querystring_parts.join('&')}"
+          end
+
+          uri
+
+        end
+
+        # @param [Hash] params
+        # @return [Hash]
+        def extract_headers params
+          headers = {}
+          (http[:request_headers] || {}).each_pair do |param_name,header_name|
+            if param_value = params.delete(param_name)
+              headers[header_name] = param_value
+            end
+          end
+          headers
+        end
+
+        # @param [Hash] params
+        # @return [String,nil]
+        def build_body params
+          if params.empty?
+            nil
+          else
+            if
+              payload = http[:request_payload] and
+              rules[payload][:type] != :hash
+            then
+              params[payload]
+            else
+              params_to_xml(params)
+            end
+          end
+        end
+
+        # @param [Hash] params
+        # @return [String] Returns xml.
+        def params_to_xml params
+          Options::XMLSerializer.new(namespace, operation_name, rules).serialize(params)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/aws/core/rest_client/output_handler.rb

@@ -0,0 +1,43 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  module Core
+    module RESTClient
+
+      # Given a hash of request options, a REST::RequestHandler can
+      # populate a Core::Http::Request object.
+      class OutputHandler
+
+        # @param [Hash] operation
+        # @option operation [required,Hash] :http REST traits.
+        # @option operation [required,Hash] :outputs XML parsing rules.
+        # @private
+        def initialize operation
+          @http = operation[:http]
+          @parser = XML::Parser.new(operation[:outputs])
+        end
+
+        # Given a response object, this method extract and returns a
+        # hash of response data.
+        # @param [Response] response
+        # @return [Hash]
+        def extract_data response 
+          @parser.parse(response.http_response.body)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/aws/core/signature/version_2.rb

@@ -16,10 +16,6 @@ module AWS
     module Signature
       module Version2
 
-        def self.included base
-          base.send(:include, Signer)
-        end
-
         def add_authorization! credentials
           add_param('AWSAccessKeyId', credentials.access_key_id)
           if token = credentials.session_token
@@ -27,14 +23,18 @@ module AWS
           end
           add_param('SignatureVersion', '2')
           add_param('SignatureMethod', 'HmacSHA256')
-          add_param('Signature', sign(credentials.secret_access_key, string_to_sign))
+          add_param('Signature', signature(credentials))
         end
 
         protected
 
+        def signature credentials
+          Signer.sign(credentials.secret_access_key, string_to_sign)
+        end
+
         def string_to_sign
 
-          host = 
+          host =
             case port
             when 80, 443 then self.host
             else "#{self.host}:#{port}"
@@ -42,7 +42,7 @@ module AWS
 
           [
             http_method,
-            host,
+            host.to_s.downcase,
             path,
             params.sort.collect { |p| p.encoded }.join('&'),
           ].join("\n")

data/lib/aws/core/signature/version_3.rb

@@ -37,11 +37,15 @@ module AWS
             "AWSAccessKeyId=#{credentials.access_key_id},"+
             "Algorithm=HmacSHA256,"+
             "SignedHeaders=#{headers_to_sign.join(';')},"+
-            "Signature=#{sign(credentials.secret_access_key, string_to_sign)}"
+            "Signature=#{signature(credentials)}"
         end
 
         protected
 
+        def signature credentials
+          Signer.sign(credentials.secret_access_key, string_to_sign)  
+        end
+
         def string_to_sign
           OpenSSL::Digest::SHA256.digest([
             http_method,

data/lib/aws/core/signature/version_3_https.rb

@@ -0,0 +1,51 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'time'
+
+module AWS
+  module Core
+    module Signature
+      module Version3HTTPS
+
+        def self.included base
+          base.send(:include, Signer)
+        end
+
+        def add_authorization! credentials
+
+          self.access_key_id = credentials.access_key_id
+
+          parts = []
+          parts << "AWS3-HTTPS AWSAccessKeyId=#{access_key_id}"
+          parts << "Algorithm=HmacSHA256"
+          parts << "Signature=#{signature(credentials)}"
+          headers['x-amzn-authorization'] = parts.join(',')
+
+        end
+
+        protected
+
+        def signature credentials
+          Signer.sign(credentials.secret_access_key, string_to_sign)
+        end
+
+        def string_to_sign
+          headers['date'] ||= Time.now.rfc822
+        end
+
+      end
+    end
+  end
+end
+

data/lib/aws/core/signature/version_4.rb

@@ -73,12 +73,12 @@ module AWS
   
         def canonical_request
           parts = []
-          parts << action_name
-          parts << canonical_uri
-          parts << canonical_querystring
+          parts << http_method
+          parts << path
+          parts << querystring
           parts << canonical_headers + "\n"
           parts << signed_headers
-          parts << hex16(hash(payload))
+          parts << hex16(hash(body || ''))
           parts.join("\n")
         end
   
@@ -87,22 +87,6 @@ module AWS
           raise NotImplementedError
         end
   
-        def action_name
-          http_method.to_s.upcase
-        end
-  
-        def canonical_uri
-          path
-        end
-  
-        def payload
-          body || ''
-        end
-  
-        def canonical_querystring
-          http_method.to_s.upcase == 'GET' ? url_encoded_params : ''
-        end
-  
         def signed_headers
           to_sign = headers.keys.map{|k| k.to_s.downcase }
           to_sign.delete('authorization')
@@ -112,8 +96,7 @@ module AWS
         def canonical_headers
           headers = []
           self.headers.each_pair do |k,v|
-            header = [k.to_s.downcase, v]
-            headers << header unless header.first == 'authorization'
+            headers << [k,v] unless k == 'authorization'
           end
           headers = headers.sort_by(&:first)
           headers.map{|k,v| "#{k}:#{canonical_header_values(v)}" }.join("\n")

data/lib/aws/core/signer.rb

@@ -15,7 +15,7 @@ require 'base64'
 
 module AWS
   module Core
-    
+
     # This module provides a {#sign} method that accepts a secret
     # and a string to sign.
     module Signer