aws-sdk 1.6.3 → 1.6.4

data/lib/aws/core/options/xml_serializer.rb

@@ -53,9 +53,9 @@ module AWS
           xml = []
           builder = Builder::XmlMarkup.new(:target => xml, :indent => 2)
           builder.tag!("#{operation_name}Request", :xmlns => namespace) do
-            request_options.each_pair do |opt_name, opt_value|
-              to_xml(builder, opt_name, rules[opt_name], opt_value)
-            end
+
+            hash_members_xml(request_options, rules, builder)
+
           end
           xml.join
         end
@@ -78,12 +78,7 @@ module AWS
           when Hash
 
             builder.tag!(xml_name) do
-              xml_ordered_members(rules[:members]).each do |member_name|
-                if value.key?(member_name)
-                  member_value = value[member_name]
-                  to_xml(builder, member_name, rules[:members][member_name], member_value)
-                end
-              end
+              hash_members_xml(value, rules[:members], builder)
             end
 
           when Array
@@ -97,6 +92,15 @@ module AWS
 
         end
 
+        def hash_members_xml hash, rules, builder
+          xml_ordered_members(rules).each do |member_name|
+            if hash.key?(member_name)
+              value = hash[member_name]
+              to_xml(builder, member_name, rules[member_name], value)
+            end
+          end
+        end
+
         def xml_ordered_members members
           members.inject([]) do |list,(member_name, member)|
             list << [member[:position] || 0, member_name]

data/lib/aws/core/query_client.rb

@@ -11,120 +11,29 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-#me 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
-
-    # When a client class extends this module, its API configuration
-    # is parsed.  For each operation in the API configuration, one
-    # client method is added.
-    #
-    # Clients extending Query all have in common their method
-    # of serializing request (input) paramters and parsing response
-    # (output) XML.
-    #
-    module QueryClient
-
-      # @private
-      def self.extended base
-        base.send(:include, ErrorParser)
-        base.send(:define_parsers)
-      end
-
-      # @return [Hash<Symbol,OptionGrammar>] Returns a hash option
-      #   parsers.  Hash keys are client method names and hash
-      #   values are {OptionGrammar} objects.
-      # @private
-      def option_parsers
-        @option_parsers ||= {}
-      end
-
-      # @return [Hash<Symbol,XML::Parser>] Returns a hash of xml
-      #   parsers.  Hash keys are client method names and hash
-      #   values are {XML::Parser} objects.
-      # @private
-      def xml_parsers
-        @xml_parsers ||= {}
-      end
+    class QueryClient < Core::Client
 
       protected
 
-      # Enumerates through the operations specified in the API
-      # configuration (yaml configuration file found in lib/api_config/)
-      # and defines one request method per operation.
-      def define_parsers
-        api_config[:operations].each do |op|
-
-          method_name = op[:method]
-
-          option_parsers[method_name] = OptionGrammar.customize(op[:inputs])
-          xml_parsers[method_name] = XML::Parser.new(op[:outputs])
-
-        end
+      def self.request_builder_for api_config, operation
+        QueryRequestBuilder.new(api_config[:api_version], operation)
       end
 
-      def define_client_method method_name, operation_name
-        add_client_request_method(method_name) do
-
-          configure_request do |request, options|
-
-            now = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
-
-            request.headers['Content-Type'] =
-              "application/x-www-form-urlencoded; charset=utf-8"
-
-            request.add_param 'Timestamp', now
-            request.add_param 'Version', self.class::API_VERSION
-            request.add_param 'Action', operation_name
-
-            parser = self.class.option_parsers[method_name]
-            parser.request_params(options).each do |param|
-              request.add_param(param)
-            end
-            request.body = request.url_encoded_params
-
-          end
-
-          process_response do |response|
-            parser = self.class.xml_parsers[method_name]
-            response.data = parser.parse(response.http_response.body)
-          end
-
-          simulate_response do |response|
-            parser = self.class.xml_parsers[method_name]
-            response.data = parser.simulate
-          end
-
-        end
+      def self.response_parser_for api_config, operation
+        QueryResponseParser.new(operation[:outputs])
       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
+      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

data/lib/aws/core/query_error_parser.rb

@@ -0,0 +1,24 @@
+# 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
+
+    # @private
+    module QueryErrorParser
+
+
+    end
+
+  end
+end

data/lib/aws/core/query_request_builder.rb

@@ -0,0 +1,47 @@
+# 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
+
+    # @private
+    class QueryRequestBuilder
+
+      def initialize api_version, operation
+        @api_version = api_version
+        @operation_name = operation[:name]
+        @grammar = OptionGrammar.customize(operation[:inputs])
+      end
+
+      def populate_request request, options
+
+          now = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+          request.headers['Content-Type'] =
+            "application/x-www-form-urlencoded; charset=utf-8"
+
+          request.add_param 'Timestamp', now
+          request.add_param 'Version', @api_version
+          request.add_param 'Action', @operation_name
+
+          @grammar.request_params(options).each do |param|
+            request.add_param(param)
+          end
+          request.body = request.url_encoded_params
+
+      end
+
+    end
+
+  end
+end

data/lib/aws/core/query_response_parser.rb

@@ -0,0 +1,35 @@
+# 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
+
+    # @private
+    class QueryResponseParser
+
+      def initialize parsing_rules
+        @parser = XML::Parser.new(parsing_rules)
+      end
+
+      def extract_data response
+        @parser.parse(response.http_response.body)
+      end
+
+      def simulate
+        @parser.simulate
+      end
+
+    end
+
+  end
+end

data/lib/aws/core/rest_client.rb

@@ -11,78 +11,29 @@
 # 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
+    class RESTClient < Core::Client
 
       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
+      def self.request_builder_for api_config, operation
+        RESTRequestBuilder.new(api_config[:namespace], operation)
       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
+      def self.response_parser_for api_config, operation
+        RESTResponseParser.new(operation)
       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
+      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

data/lib/aws/core/rest_error_parser.rb

@@ -0,0 +1,24 @@
+# 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
+
+    # @private
+    module RESTErrorParser
+
+
+    end
+
+  end
+end

data/lib/aws/core/rest_request_builder.rb

@@ -0,0 +1,124 @@
+# 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
+
+    # Given a hash of request options, a REST::RequestHandler can
+    # populate a Core::Http::Request object.
+    class RESTRequestBuilder
+
+      # @private
+      def initialize namespace, operation
+
+        @http = operation[:http]
+
+        @rules = operation[:inputs]
+
+        @validator = Options::Validator.new(@rules)
+
+        @xml_serializer = Options::XMLSerializer.new(
+          namespace, operation[:name], @rules)
+
+      end
+
+      # 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 = @validator.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
+            @xml_serializer.serialize(params)
+          end
+        end
+      end
+
+    end
+
+  end
+end