aws-sdk-core 2.2.37 → 2.3.0

data/lib/aws-sdk-core.rb

@@ -115,6 +115,7 @@ module Aws
   autoload :Pager, 'aws-sdk-core/pager'
   autoload :ParamConverter, 'aws-sdk-core/param_converter'
   autoload :ParamValidator, 'aws-sdk-core/param_validator'
+  autoload :Partitions, 'aws-sdk-core/partitions'
   autoload :RefreshingCredentials, 'aws-sdk-core/refreshing_credentials'
   autoload :Service, 'aws-sdk-core/service'
   autoload :SharedCredentials, 'aws-sdk-core/shared_credentials'
@@ -169,6 +170,7 @@ module Aws
     autoload :RequestSigner, 'aws-sdk-core/plugins/request_signer'
     autoload :RetryErrors, 'aws-sdk-core/plugins/retry_errors'
     autoload :Route53IdFix, 'aws-sdk-core/plugins/route_53_id_fix'
+    autoload :S3Accelerate, 'aws-sdk-core/plugins/s3_accelerate'
     autoload :S3BucketDns, 'aws-sdk-core/plugins/s3_bucket_dns'
     autoload :S3Expect100Continue, 'aws-sdk-core/plugins/s3_expect_100_continue'
     autoload :S3GetBucketLocationFix, 'aws-sdk-core/plugins/s3_get_bucket_location_fix'
@@ -279,6 +281,59 @@ module Aws
       end
     end
 
+    # Return the partition with the given name. A partition describes
+    # the services and regions available in that partition.
+    #
+    #     aws = Aws.partition('aws')
+    #
+    #     puts "Regions available in the aws partition:\n"
+    #     aws.regions.each do |region|
+    #       puts region.name
+    #     end
+    #
+    #     puts "Services available in the aws partition:\n"
+    #     aws.services.each do |services|
+    #       puts services.name
+    #     end
+    #
+    # See {Partitions} for more information and examples.
+    #
+    # @param [String] partition_name The name of the partition to return.
+    #   Valid names include "aws", "aws-cn", and "aws-us-gov".
+    #
+    # @return [Partitions::Partition]
+    #
+    # @raise [ArgumentError] Raises an `ArgumentError` if a partition is
+    #   not found with the given name. The error message contains a list
+    #   of valid partition names.
+    def partition(partition_name)
+      Partitions.default_list.partition(partition_name)
+    end
+
+    # Return an array of partitions. A partition describes
+    # the services and regions available in that partition.
+    #
+    #     Aws.partitions.each do |partition|
+    #
+    #       puts "Regions available in #{partition.name}:\n"
+    #       partition.regions.each do |region|
+    #         puts region.name
+    #       end
+    #
+    #       puts "Services available in #{partition.name}:\n"
+    #       partition.services.each do |service|
+    #         puts service.name
+    #       end
+    #     end
+    #
+    # See {Partitions} for more information and examples.
+    #
+    # @return [Array<Partitions::Partition>] Returns an array of all
+    #   known partitions.
+    def partitions
+      Partitions.default_list.partitions
+    end
+
     # The SDK ships with a ca certificate bundle to use when verifying SSL
     # peer certificates. By default, this cert bundle is *NOT* used. The
     # SDK will rely on the default cert available to OpenSSL. This ensures

data/lib/aws-sdk-core/api/customizations.rb

@@ -145,9 +145,30 @@ module Aws
 
       api('s3') do |api|
         api['metadata'].delete('signatureVersion')
+        if ENV['DOCSTRINGS']
+          api['shapes']['AccelerateBoolean'] = { 'type' => 'boolean' }
+          api['operations'].each do |operation_name, operation|
+            next if %w(CreateBucket ListBuckets DeleteBucket).include?(operation_name)
+            if input_ref = operation['input']
+              input_shape = api['shapes'][input_ref['shape']]
+              input_shape['members']['UseAccelerateEndpoint'] = {
+                'shape' => 'AccelerateBoolean'
+              }
+            end
+          end
+        end
+      end
+
+      doc('s3') do |docs|
+        if ENV['DOCSTRINGS']
+          docs['shapes']['AccelerateBoolean'] = {}
+          docs['shapes']['AccelerateBoolean']['refs'] = {}
+          docs['shapes']['AccelerateBoolean']['base'] = 'When <tt>true</tt>, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.'
+        end
       end
 
       plugins('s3', add: %w(
+        Aws::Plugins::S3Accelerate
         Aws::Plugins::S3BucketDns
         Aws::Plugins::S3Expect100Continue
         Aws::Plugins::S3Http200Errors

data/lib/aws-sdk-core/api/docs/param_formatter.rb

@@ -44,7 +44,7 @@ module Aws
             end
           when ListShape then list(ref, i, visited)
           when MapShape then map(ref, i, visited)
-          when BooleanShape then "true"
+          when BooleanShape then "false"
           when IntegerShape then '1'
           when FloatShape then '1.0'
           when StringShape then string(ref)

data/lib/aws-sdk-core/endpoint_provider.rb

@@ -2,32 +2,91 @@ module Aws
   # @api private
   class EndpointProvider
 
-    # @api private
-    PATH = File.join(File.dirname(__FILE__), '..', '..', 'endpoints.json')
+    def initialize(rules)
+      @rules = rules
+    end
 
-    # @api private
-    RULES = Json.load_file(PATH)['endpoints']
+    def resolve(region, service)
+      "https://" + endpoint_for(region, service)
+    end
 
-    class << self
+    def signing_region(region, service)
+      get_partition(region).
+        fetch("services", {}).
+        fetch(service, {}).
+        fetch("endpoints", {}).
+        fetch(region, {}).
+        fetch("credentialScope", {}).
+        fetch("region", region)
+    end
 
-      def resolve(region, service)
-        keys(region, service).each do |key|
-          if match = RULES[key]
-            return expand(match['endpoint'], region.to_s, service.to_s)
-          end
-        end
+    private
+
+    def endpoint_for(region, service)
+      partition = get_partition(region)
+      endpoint = default_endpoint(partition, service, region)
+      service_cfg = partition.fetch("services", {}).fetch(service, {})
+
+      # Check for service-level default endpoint.
+      endpoint = service_cfg.fetch("defaults", {}).fetch("hostname", endpoint)
+
+      # Check for global endpoint.
+      if service_cfg["isRegionalized"] == false
+        region = service_cfg.fetch("partitionEndpoint", region)
       end
 
-      private
+      # Check for service/region level endpoint.
+      endpoint = service_cfg.fetch("endpoints", {}).
+        fetch(region, {}).fetch("hostname", endpoint)
+
+      endpoint
+    end
+
+    def default_endpoint(partition, service, region)
+      hostname_template = partition["defaults"]["hostname"]
+      hostname_template.
+        sub('{region}', region).
+        sub('{service}', service).
+        sub('{dnsSuffix}', partition["dnsSuffix"])
+    end
+
+    def get_partition(region)
+      partition_containing_region(region) ||
+      partition_matching_region(region) ||
+      default_partition
+    end
 
-      def keys(region, service)
-        ["#{region}/#{service}", "#{region}/*", "*/#{service}", "*/*"]
+    def partition_containing_region(region)
+      @rules['partitions'].find do |p|
+        p['regions'].key?(region)
       end
+    end
 
-      def expand(pattern, region, service)
-        'https://' + pattern.sub('{region}', region).sub('{service}', service)
+    def partition_matching_region(region)
+      @rules['partitions'].find do |p|
+        region.match(p["regionRegex"]) ||
+        p['services'].values.find { |svc| svc['endpoints'].key?(region) }
       end
+    end
 
+    def default_partition
+      @rules['partitions'].find { |p| p["partition"] == "aws" } ||
+      @rules['partitions'].first
     end
+
+    class << self
+
+      def resolve(region, service)
+        DEFAULT_PROVIDER.resolve(region, service)
+      end
+
+      def signing_region(region, service)
+        DEFAULT_PROVIDER.signing_region(region, service)
+      end
+
+    end
+
+    DEFAULT_PROVIDER = EndpointProvider.new(Partitions.defaults)
+
   end
 end

data/lib/aws-sdk-core/partitions.rb

@@ -0,0 +1,174 @@
+module Aws
+
+  # A {Partition} is a group of AWS {Region} and {Service} objects. You
+  # can use a partition to determine what services are available in a region,
+  # or what regions a service is available in.
+  #
+  # ## Partitions
+  #
+  # **AWS accounts are scoped to a single partition**. You can get a partition
+  # by name. Valid partition names include:
+  #
+  # * `"aws"` - Public AWS partition
+  # * `"aws-cn"` - AWS China
+  # * `"aws-us-gov"` - AWS GovCloud
+  #
+  # To get a partition by name:
+  #
+  #     aws = Aws.partition('aws')
+  #
+  # You can also enumerate all partitions:
+  #
+  #     Aws.partitions.each do |partition|
+  #       puts partition.name
+  #     end
+  #
+  # ## Regions
+  #
+  # A {Partition} is divided up into one or more regions. For example, the
+  # "aws" partition contains, "us-east-1", "us-west-1", etc. You can get
+  # a region by name. Calling {Partition#region} will return an instance
+  # of {Region}.
+  #
+  #     region = Aws.partition('aws').region('us-east-1')
+  #     region.name
+  #     #=> "us-east-1"
+  #
+  # You can also enumerate all regions within a partition:
+  #
+  #     Aws.partition('aws').regions.each do |region|
+  #       puts region.name
+  #     end
+  #
+  # Each {Region} object has a name, description and a list of services
+  # available to that region:
+  #
+  #     us_west_2 = Aws.partition('aws').region('us-west-2')
+  #
+  #     us_west_2.name #=> "us-west-2"
+  #     us_west_2.description #=> "US West (Oregon)"
+  #     us_west_2.partition_name "aws"
+  #     us_west_2.services #=> #<Set: {"APIGateway", "AutoScaling", ... }
+  #
+  # To know if a service is available within a region, you can call `#include?`
+  # on the set of service names:
+  #
+  #     region.services.include?('DynamoDB') #=> true/false
+  #
+  # The service name should be the service's module name as used by
+  # the AWS SDK for Ruby. To find the complete list of supported
+  # service names, see {Partition#services}.
+  #
+  # Its also possible to enumerate every service for every region in
+  # every partition.
+  #
+  #     Aws.partitions.each do |partition|
+  #       partition.regions.each do |region|
+  #         region.services.each do |service_name|
+  #           puts "#{partition.name} -> #{region.name} -> #{service_name}"
+  #         end
+  #       end
+  #     end
+  #
+  # ## Services
+  #
+  # A {Partition} has a list of services available. You can get a
+  # single {Service} by name:
+  #
+  #     Aws.partition('aws').service('DynamoDB')
+  #
+  # You can also enumerate all services in a partition:
+  #
+  #     Aws.partition('aws').services.each do |service|
+  #       puts service.name
+  #     end
+  #
+  # Each {Service} object has a name, and information about regions
+  # that service is available in.
+  #
+  #     service.name #=> "DynamoDB"
+  #     service.partition_name #=> "aws"
+  #     service.regions #=> #<Set: {"us-east-1", "us-west-1", ... }
+  #
+  # Some services have multiple regions, and others have a single partition
+  # wide region. For example, {Aws::IAM} has a single region in the "aws"
+  # partition. The {Service#regionalized?} method indicates when this is
+  # the case.
+  #
+  #     iam = Aws.partition('aws').service('IAM')
+  #
+  #     iam.regionalized? #=> false
+  #     service.partition_region #=> "us-east-1"
+  #
+  # Its also possible to enumerate every region for every service in
+  # every partition.
+  #
+  #     Aws.partitions.each do |partition|
+  #       partition.services.each do |service|
+  #         service.regions.each do |region_name|
+  #           puts "#{partition.name} -> #{region_name} -> #{service.name}"
+  #         end
+  #       end
+  #     end
+  #
+  # ## Service Names
+  #
+  # {Service} names are those used by the the AWS SDK for Ruby. They
+  # correspond to the service's module.
+  #
+  module Partitions
+
+    autoload :Partition, 'aws-sdk-core/partitions/partition'
+    autoload :PartitionList, 'aws-sdk-core/partitions/partition_list'
+    autoload :Region, 'aws-sdk-core/partitions/region'
+    autoload :Service, 'aws-sdk-core/partitions/service'
+
+    class << self
+
+      # @param [Hash] new_partitions
+      # @api private
+      def add(new_partitions)
+        new_partitions['partitions'].each do |partition|
+          default_list.add_partition(Partition.build(partition))
+          defaults['partitions'] << partition
+        end
+      end
+
+      # @api private
+      def clear
+        default_list.clear
+        defaults['partitions'].clear
+      end
+
+      # @return [Hash]
+      # @api private
+      def defaults
+        @defaults ||= begin
+          path = File.join(File.dirname(__FILE__), '..', '..', 'endpoints.json')
+          Aws::Json.load_file(path)
+        end
+      end
+
+      # @return [PartitionList]
+      # @api priviate
+      def default_list
+        @default_list ||= PartitionList.build(defaults)
+      end
+
+      # @return [Hash<String,String>] Returns a map of service module names
+      #   to their id as used in the endpoints.json document.
+      # @api private
+      def service_ids
+        @service_ids ||= begin
+          services = "#{File.dirname(__FILE__)}/../../service-models.json"
+          services = Aws::Json.load_file(services)
+          services.inject({}) do |ids, (name, svc)|
+            ids[name] = svc['endpoint'] #if svc['endpoint']
+            ids
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-core/partitions/partition.rb

@@ -0,0 +1,95 @@
+module Aws
+  module Partitions
+    class Partition
+
+      # @option options [required, String] :name
+      # @option options [required, Hash<String,Region>] :regions
+      # @option options [required, Hash<String,Service>] :services
+      # @api private
+      def initialize(options = {})
+        @name = options[:name]
+        @regions = options[:regions]
+        @services = options[:services]
+      end
+
+      # @return [String] The partition name, e.g. "aws", "aws-cn", "aws-us-gov".
+      attr_reader :name
+
+      # @param [String] region_name The name of the region, e.g. "us-east-1".
+      # @return [Region]
+      # @raise [ArgumentError] Raises `ArgumentError` for unknown region name.
+      def region(region_name)
+        if @regions.key?(region_name)
+          @regions[region_name]
+        else
+          msg = "invalid region name #{region_name.inspect}; valid region "
+          msg << "names include %s" % [@regions.keys.join(', ')]
+          raise ArgumentError, msg
+        end
+      end
+
+      # @return [Array<Region>]
+      def regions
+        @regions.values
+      end
+
+      # @param [String] service_name The service module name.
+      # @return [Service]
+      # @raise [ArgumentError] Raises `ArgumentError` for unknown service name.
+      def service(service_name)
+        if @services.key?(service_name)
+          @services[service_name]
+        else
+          msg = "invalid service name #{service_name.inspect}; valid service "
+          msg << "names include %s" % [@services.keys.join(', ')]
+          raise ArgumentError, msg
+        end
+      end
+
+      # @return [Array<Service>]
+      def services
+        @services.values
+      end
+
+      class << self
+
+        # @api private
+        def build(partition)
+          Partition.new(
+            name: partition['partition'],
+            regions: build_regions(partition),
+            services: build_services(partition),
+          )
+        end
+
+        private
+
+        # @param [Hash] partition
+        # @return [Hash<String,Region>]
+        def build_regions(partition)
+          partition['regions'].inject({}) do |regions, (region_name, region)|
+            unless region_name == "#{partition['partition']}-global"
+              regions[region_name] = Region.build(region_name, region, partition)
+            end
+            regions
+          end
+        end
+
+        # @param [Hash] partition
+        # @return [Hash<String,Service>]
+        def build_services(partition)
+          Partitions.service_ids.inject({}) do |services, (svc_name, svc_id)|
+            if partition['services'].key?(svc_id)
+              svc_data = partition['services'][svc_id]
+              services[svc_name] = Service.build(svc_name, svc_data, partition)
+            else
+              services[svc_name] = Service.build(svc_name, {'endpoints' => {}}, partition)
+            end
+            services
+          end
+        end
+
+      end
+    end
+  end
+end