aws-sdk-v1 1.52.0

data/lib/aws/core/query_client.rb

@@ -0,0 +1,41 @@
+# Copyright 2011-2013 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
+    class QueryClient < Core::Client
+
+      protected
+
+      def self.request_builder_for api_config, operation
+        QueryRequestBuilder.new(api_config[:api_version], operation)
+      end
+
+      def self.response_parser_for api_config, operation
+        QueryResponseParser.new(operation[:outputs])
+      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
+  end
+end

data/lib/aws/core/query_error_parser.rb

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

data/lib/aws/core/query_request_builder.rb

@@ -0,0 +1,47 @@
+# Copyright 2011-2013 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
+
+    # @api 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-2013 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
+
+    # @api 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/region.rb

@@ -0,0 +1,85 @@
+# Copyright 2011-2013 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
+
+    # Represents an AWS region.  A region has a name and provides access
+    # to service interface objects.
+    #
+    #   aws = AWS.regions['us-west-1']
+    #
+    #   aws.dynamo_db.tables.map(&:name)
+    #   aws.ec2.instances.map(&:id)
+    #
+    # Regions provide helper methods for each service.
+    #
+    # @attr_reader [AutoScaling] auto_scaling
+    # @attr_reader [CloudFormation] cloud_formation
+    # @attr_reader [CloudFront] cloud_front
+    # @attr_reader [CloudSearch] cloud_search
+    # @attr_reader [CloudTrail] cloud_trail
+    # @attr_reader [CloudWatch] cloud_watch
+    # @attr_reader [DataPipeline] data_pipeline
+    # @attr_reader [DirectConnect] direct_connect
+    # @attr_reader [DynamoDB] dynamo_db
+    # @attr_reader [EC2] ec2
+    # @attr_reader [ElasticBeanstalk] elastic_beanstalk
+    # @attr_reader [ElasticTranscoder] elastic_transcoder
+    # @attr_reader [ElastiCache] elasticache
+    # @attr_reader [ELB] elb
+    # @attr_reader [EMR] emr
+    # @attr_reader [Glacier] glacier
+    # @attr_reader [IAM] iam
+    # @attr_reader [ImportExport] import_export
+    # @attr_reader [Kinesis] kinesis
+    # @attr_reader [OpsWorks] ops_works
+    # @attr_reader [RDS] rds
+    # @attr_reader [Redshift] redshift
+    # @attr_reader [Route53] route_53
+    # @attr_reader [S3] s3
+    # @attr_reader [SimpleEmailService] ses
+    # @attr_reader [SimpleDB] simple_db
+    # @attr_reader [SNS] sns
+    # @attr_reader [SQS] sqs
+    # @attr_reader [StorageGateway] storage_gateway
+    # @attr_reader [STS] sts
+    # @attr_reader [Support] support
+    # @attr_reader [SimpleWorkflow] swf
+    #
+    class Region
+
+      # @param [String] name
+      # @option options [Configuration] :config (AWS.config)
+      def initialize name, options = {}
+        @name = name
+        @config = options[:config] || AWS.config
+        @config = @config.with(:region => name)
+      end
+
+      # @return [String] The name of this region (e.g. 'us-west-1').
+      attr_reader :name
+
+      # @return [Configuration]
+      attr_reader :config
+
+      AWS::SERVICES.values.each do |svc|
+        define_method(svc.method_name) do
+          AWS.const_get(svc.class_name).new(:config => config)
+        end
+        alias_method(svc.method_alias, svc.method_name) if svc.method_alias
+      end
+
+    end
+  end
+end

data/lib/aws/core/region_collection.rb

@@ -0,0 +1,80 @@
+# Copyright 2011-2013 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 'uri'
+require 'net/http'
+require 'json'
+
+module AWS
+  module Core
+
+    # Provides a mechnasim to discover available regions.  This can useful if
+    # you want to perform an operation for a service in every region.
+    #
+    #   # call the EC2 DescribeInstances operation in each region
+    #   AWS.regions.each do |region|
+    #     resp = region.ec2.client.describe_instances
+    #   end
+    #
+    # You can also use this collection as a shortcut for creating
+    # a service interface with a given region.
+    #
+    #   s3 = AWS.regions['us-west-1'].s3
+    #
+    # This collection enumerates and returns {Region} objects.
+    #
+    # @see Region
+    class RegionCollection
+
+      include Enumerable
+
+      # @option options [Configuration] :config (AWS.config)
+      # @option options [ServiceInterface] :service (nil)
+      # @api private
+      def initialize options = {}
+        @config = options[:config] || AWS.config
+        @service = options[:service]
+      end
+
+      # @return [Configuration]
+      attr_reader :config
+
+      # @param [String] name
+      # @return [Region] Returns a {Region} with the given name.
+      def [] name
+        Region.new(name, :config => config)
+      end
+
+      # Enumerates public regions (non US Gov regions).
+      # @yieldparam [region] Region
+      def each &block
+        public_regions.each do |region_name|
+          yield(self[region_name])
+        end
+      end
+
+      private
+
+      # @return [Array<String>] Returns an array of non-gov-cloud region names.
+      def public_regions
+        return ['us-east-1'] if @service and @service.global_endpoint?
+        data = Endpoints.endpoints
+        regions = @service ?
+          data['services'][@service.endpoint_prefix] :
+          data['regions'].keys
+        regions.reject{ |r| r =~ /us-gov/ }.reject{ |r| r =~ /^cn-/ }
+      end
+
+    end
+  end
+end

data/lib/aws/core/resource.rb

@@ -0,0 +1,413 @@
+
+# Copyright 2011-2013 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
+
+    # @api private
+    class Resource
+
+      include Model
+      include Cacheable
+
+      # @api private
+      class NotFound < StandardError; end
+
+      # @api private
+      def initialize *args
+
+        super
+
+        # cache static attributes passed into options
+
+        options = args.last.is_a?(Hash) ? args.last : {}
+        options.each_pair do |opt_name,opt_value|
+          if
+            self.class.attributes.has_key?(opt_name) and
+            self.class.attributes[opt_name].static?
+          then
+            static_attributes[opt_name] = opt_value
+          end
+        end
+
+      end
+
+      # @return [String] Returns a simple string representation of this resource.
+      def inspect
+
+        identifiers = []
+        resource_identifiers.each do |key, value|
+          if attr = self.class.attributes.values.find{|a| a.from == key }
+            identifiers << "#{attr.name}:#{value}"
+          else
+            identifiers << "#{key}:#{value}"
+          end
+        end
+
+        "<#{self::class} #{identifiers.join(' ')}>"
+
+      end
+
+      # @return [Boolean] Returns true if the objects references the same
+      #   AWS resource.
+      def eql? other
+        other.kind_of?(self.class) and
+        other.resource_identifiers == resource_identifiers
+      end
+      alias_method :==, :eql?
+
+      # @api private
+      protected
+      def get_resource attr_name
+        raise NotImplementedError
+      end
+
+      # @api private
+      protected
+      def update_resource attr, value
+        raise NotImplementedError
+      end
+
+      # Overide this method is subclasses of Resource.  This method should
+      # return an array of identifying key/value pairs.
+      #
+      #     # @api private
+      #     protected
+      #     def resource_identifiers
+      #       [[:user_name, name]]
+      #     end
+      #
+      # @api private
+      protected
+      def resource_identifiers
+        raise NotImplementedError
+      end
+
+      # @protected
+      protected
+      def resource_options(additional = {})
+        Hash[resource_identifiers].merge(additional)
+      end
+
+      # @api private
+      protected
+      def local_cache_key
+        resource_identifiers.collect{|name,value| value.to_s }.join(":")
+      end
+
+      # @api private
+      protected
+      def static_attributes
+        @static_attributes ||= {}
+      end
+
+      # @api private
+      protected
+      def ruby_name
+        @ruby_name ||= Inflection.ruby_name(self.class.name)
+      end
+
+      # @api private
+      public
+      def attributes_from_response resp
+
+        # check each provider for this request type to see if it
+        # can find the resource and some of its attributes
+        attributes = []
+        self.class.attribute_providers_for(resp.request_type).each do |provider|
+          attributes << provider.attributes_from_response(self, resp)
+        end
+
+        # drop out those that returned no attributesj
+        attributes.compact!
+
+        # stop here if nothing was found for this resource
+        return nil if attributes.empty?
+
+        # merge the attributes together into a single hash
+        attributes = attributes.inject({}) {|hash,attribs| hash.merge(attribs) }
+
+        # cache static attributes
+        attributes.each_pair do |attr_name,value|
+          if self.class.attributes[attr_name].static?
+            static_attributes[attr_name] = value
+          end
+        end
+
+        attributes
+
+      end
+
+      # @api private
+      protected
+      def cache_static_attributes request_type, resp_obj
+        self.class.attribute_providers_for(request_type).each do |provider|
+          attributes = provider.attributes_from_response_object(resp_obj)
+          attributes.each_pair do |attr_name,value|
+            if self.class.attributes[attr_name].static?
+              static_attributes[attr_name] = value
+            end
+          end
+        end
+      end
+
+      class << self
+
+        # @api private
+        def define_attribute_type type_name
+          class_eval <<-METHODS
+
+            def self.#{type_name}_attributes
+              @#{type_name}_attributes ||= {}
+            end
+
+            def self.#{type_name}_attribute name, options = {}, &block
+              attr = attribute(name, options, &block)
+              #{type_name}_attributes[attr.name] = attr
+            end
+
+          METHODS
+        end
+
+        # @api private
+        def new_from request_type, resp_obj, *args
+          resource = new(*args)
+          resource.send(:cache_static_attributes, request_type, resp_obj)
+          resource
+        end
+
+        # @api private
+        def attributes
+          @attributes ||= Hash.new do |hash,attr_name|
+            raise "uknown attribute #{attr_name}"
+          end
+        end
+
+        # @api private
+        def attribute_providers
+          @attribute_providers ||= []
+        end
+
+        # @api private
+        def attribute_providers_for request_type
+          attribute_providers.select do |provider|
+            provider.request_types.include?(request_type)
+          end
+        end
+
+        # @api private
+        protected
+        def attribute name, options = {}, &block
+          attr = Attribute.new(name, options)
+          attr.instance_eval(&block) if block_given?
+          define_attribute_getter(attr)
+          define_attribute_setter(attr) if attr.mutable?
+          alias_method(options[:alias], name) if options[:alias]
+          attributes[attr.name] = attr
+        end
+
+        # @api private
+        protected
+        def mutable_attribute name, options = {}, &block
+          attribute(name, options.merge(:mutable => true), &block)
+        end
+
+        # @api private
+        protected
+        def define_attribute_getter attribute
+          define_method(attribute.name) do
+
+            return static_attributes[attribute.name] if
+              static_attributes.has_key?(attribute.name)
+
+            begin
+              retrieve_attribute(attribute) { get_resource(attribute) }
+            rescue Cacheable::NoData => e
+              name = ruby_name.tr("_", " ")
+              raise NotFound, "unable to find the #{name}"
+            end
+
+          end
+        end
+
+        # @api private
+        protected
+        def define_attribute_setter attribute
+          setter = attribute.name.to_s.sub(/\?/, '') + '='
+          define_method(setter) do |value|
+            translated_value = attribute.translate_input_value(value)
+            update_resource(attribute, translated_value)
+            if attribute.static?
+              static_attributes[attribute.name] = translated_value
+            end
+            value
+          end
+        end
+
+        # @api private
+        protected
+        def populates_from *request_types, &block
+          provider = provider(*request_types)
+          provider.find(&block)
+          provider.provides(*attributes.keys)
+          provider
+        end
+
+        # @api private
+        protected
+        def provider *request_types, &block
+          provider = AttributeProvider.new(self, request_types)
+          if block_given?
+            yield(provider)
+          end
+          attribute_providers << provider
+          provider
+        end
+
+      end
+
+      # @api private
+      class Attribute
+
+        def initialize name, options = {}
+          @name = name
+          @options = options
+          @request_types = []
+        end
+
+        attr_reader :name
+
+        attr_reader :request_types
+
+        def from
+          @from ||= (@options[:from] || name)
+        end
+
+        def set_as
+          @set_as ||= (@options[:set_as] || @options[:from] || name)
+        end
+
+        def mutable?
+          @options[:mutable] == true
+        end
+
+        def static?
+          @options[:static] == true
+        end
+
+        def translates_input &block
+          @input_translator = block
+        end
+
+        def translates_output options = {}, &block
+          @translates_nil = options[:nil]
+          @output_translator = block
+        end
+
+        def translate_input_value value
+          @input_translator ? @input_translator.call(value) : value
+        end
+
+        def translate_output_value value
+
+          # by default nil values are not translated
+          return nil if value.nil? and @translates_nil != true
+
+          case
+          when @options[:to_sym]    then value.tr('-','_').downcase.to_sym
+          when @options[:timestamp] then Time.at(value.to_i)
+          when @output_translator   then @output_translator.call(value)
+          else value
+          end
+
+        end
+
+      end
+
+      # @api private
+      class AttributeProvider
+
+        def initialize klass, request_types
+          @klass = klass
+          @id = klass.attribute_providers.length
+          @request_types = request_types
+          @provides = {}
+        end
+
+        attr_reader :request_types
+
+        def find &block
+          @klass.send(:define_method, finder_method, &block)
+        end
+
+        def finder_method
+          "_find_in_#{request_types.join('_or_')}_response_#{@id}"
+        end
+
+        # Indicates that all of the the named attributes can be retrieved
+        # from an appropriate response object.
+        #
+        # @overload provides(*attr_names, options = {})
+        #   @param [Symbol] attr_names A list of attributes provided
+        #   @param [Hash] options
+        #   @option options [Boolean] :value_wrapped (false) If true, then
+        #     the value returned by the response object will also receive
+        #     the message :value before it is translated and returned.
+        #   @option options [Symbol] :from Defaults to the method named
+        #     by the attribute.  This is useful when you have two providers
+        #     for the same attribute but their response object name
+        #     them differently.
+        def provides *attr_names
+          options = attr_names.last.is_a?(Hash) ? attr_names.pop : {}
+          attr_names.each do |attr_name|
+            attr = @klass.attributes[attr_name]
+            attr.request_types.push(*request_types)
+            @provides[attr_name] = options
+          end
+        end
+
+        def attributes_from_response resource, response
+          if response_object = resource.send(finder_method, response)
+            attributes_from_response_object(response_object)
+          else
+            nil
+          end
+        end
+
+        def attributes_from_response_object resp_obj
+
+          @provides.inject({}) do |attributes,(attr_name,options)|
+
+            attr = @klass.attributes[attr_name]
+
+            methods = [options[:from] || attr.from].flatten
+
+            v = resp_obj
+            methods.each do |method|
+              v = v.key?(method) ? v[method] : v[method.to_s]
+              break if v.nil?
+            end
+            v = v[:value] if v and options[:value_wrapped]
+            v = attr.translate_output_value(v)
+
+            attributes.merge(attr_name => v)
+
+          end
+
+        end
+
+      end
+    end
+  end
+end