aws-sdk 1.8.5 → 1.9.0

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

@@ -19,7 +19,7 @@ module AWS
     module Options
 
       # Given a hash of serialization rules, a JSONSerializer can convert
-      # a hash of request options into a JSON document.  The request options 
+      # a hash of request options into a JSON document.  The request options
       # are validated before returning JSON.
       class JSONSerializer
 

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

@@ -18,10 +18,10 @@ module AWS
       # Given a hash of validation rules, a validator validate request
       # options.  Validations support:
       #
-      # * rejecting unknown options
-      # * ensuring presence of required options
-      # * validating expected option types (e.g. hash, array, string,
-      #   integer, etc).
+      #   * rejecting unknown options
+      #   * ensuring presence of required options
+      #   * validating expected option types (e.g. hash, array, string,
+      #     integer, etc).
       #
       # After validating, a hash of request options is returned with
       # with normalized values (with converted types).

data/lib/aws/core/page_result.rb

@@ -20,16 +20,16 @@ module AWS
       attr_reader :collection
 
       # @return [Integer] Returns the maximum number of results per page.
-      #   The final page in a collection may return fewer than +:per_page+
-      #   items (e.g. +:per_page+ is 10 and there are only 7 items).
+      #   The final page in a collection may return fewer than `:per_page`
+      #   items (e.g. `:per_page` is 10 and there are only 7 items).
       attr_reader :per_page
 
       # @return [String] An opaque token that can be passed the #page method
       #   of the collection that returned this page of results.  This next
-      #   token behaves as a pseudo offset.  If +next_token+ is +nil+ then
+      #   token behaves as a pseudo offset.  If `next_token` is `nil` then
       #   there are no more results for the collection.
       attr_reader :next_token
-      
+
       # @param [Collection] collection The collection that was used to
       #   request this page of results.  The collection should respond to
       #   #page and accept a :next_token option.
@@ -38,11 +38,11 @@ module AWS
       #   page of results.
       #
       # @param [Integer] per_page The number of requested items for this
-      #   page of results.  If the count of items is smaller than +per_page+
+      #   page of results.  If the count of items is smaller than `per_page`
       #   then this is the last page of results.
       #
       # @param [String] next_token (nil) A token that can be passed to the
-      #   
+      #
       def initialize collection, items, per_page, next_token
         @collection = collection
         @per_page = per_page
@@ -60,12 +60,12 @@ module AWS
         collection.page(:per_page => per_page, :next_token => next_token)
       end
 
-      # @return [Boolean] Returns +true+ if this is the last page of results.
+      # @return [Boolean] Returns `true` if this is the last page of results.
       def last_page?
         next_token.nil?
       end
 
-      # @return [Boolean] Returns +true+ if there are more pages of results.
+      # @return [Boolean] Returns `true` if there are more pages of results.
       def more?
         !!next_token
       end

data/lib/aws/core/policy.rb

@@ -20,14 +20,14 @@ module AWS
 
     # Represents an access policy for AWS operations and resources.  For example:
     #
-    #   policy = Policy.new do |policy|
-    #     policy.allow(:actions => ['s3:PutObject'],
-    #                  :resources => "arn:aws:s3:::mybucket/mykey/*",
-    #                  :principals => :any
+    #     policy = Policy.new
+    #     policy.allow(
+    #       :actions => ['s3:PutObject'],
+    #       :resources => "arn:aws:s3:::mybucket/mykey/*",
+    #       :principals => :any
     #     ).where(:acl).is("public-read")
-    #   end
     #
-    #   policy.to_json               # => '{ "Version":"2008-10-17", ...'
+    #     policy.to_json # => '{ "Version":"2008-10-17", ...'
     #
     # @see #initialize More ways to construct a policy.
     # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/AccessPolicyLanguage_UseCases_s3_a.html Example policies (in JSON).
@@ -52,7 +52,8 @@ module AWS
       # * With hash arguments:
       #
       #     Policy.new(:statements => [
-      #       { :effect => :allow,
+      #       {
+      #         :effect => :allow,
       #         :actions => :all,
       #         :principals => ["abc123"],
       #         :resources => "mybucket/mykey"
@@ -66,13 +67,11 @@ module AWS
       # * With a block:
       #
       #     Policy.new do |policy|
-      #
       #       policy.allow(
       #         :actions => ['s3:PutObject'],
       #         :resources => "arn:aws:s3:::mybucket/mykey/*",
       #         :principals => :any
       #       ).where(:acl).is("public-read")
-      #
       #     end
       #
       def initialize(opts = {})
@@ -123,8 +122,8 @@ module AWS
       # Returns a hash representation of the policy. The following
       # statements are equivalent:
       #
-      #   policy.to_h.to_json
-      #   policy.to_json
+      #     policy.to_h.to_json
+      #     policy.to_json
       #
       # @return [Hash]
       def to_h
@@ -151,15 +150,15 @@ module AWS
       # Convenient syntax for expressing operators in statement
       # condition blocks.  For example, the following:
       #
-      #   policy.allow.where(:s3_prefix).not("forbidden").
-      #     where(:current_time).lte(Date.today+1)
+      #     policy.allow.where(:s3_prefix).not("forbidden").
+      #       where(:current_time).lte(Date.today+1)
       #
       # is equivalent to:
       #
-      #   conditions = Policy::ConditionBlock.new
-      #   conditions.add(:not, :s3_prefix, "forbidden")
-      #   conditions.add(:lte, :current_time, Date.today+1)
-      #   policy.allow(:conditions => conditions)
+      #     conditions = Policy::ConditionBlock.new
+      #     conditions.add(:not, :s3_prefix, "forbidden")
+      #     conditions.add(:lte, :current_time, Date.today+1)
+      #     policy.allow(:conditions => conditions)
       #
       # @see ConditionBlock#add
       class OperatorBuilder
@@ -192,7 +191,7 @@ module AWS
 
         # Adds a condition for the given key.  For example:
         #
-        #   policy.allow(...).where(:current_time).lte(Date.today + 1)
+        #     policy.allow(...).where(:current_time).lte(Date.today + 1)
         #
         # @return [OperatorBuilder]
         def where(key, operator = nil, *values)
@@ -209,10 +208,11 @@ module AWS
       # Convenience method for constructing a new statement with the
       # "Allow" effect and adding it to the policy.  For example:
       #
-      #     policy.allow(:actions => [:put_object],
-      #                  :principals => :any,
-      #                  :resources => "mybucket/mykey/*").
-      #       where(:acl).is("public-read")
+      #     policy.allow(
+      #       :actions => [:put_object],
+      #       :principals => :any,
+      #       :resources => "mybucket/mykey/*").
+      #     where(:acl).is("public-read")
       #
       # @option (see Statement#initialize)
       # @see Statement#initialize
@@ -226,11 +226,11 @@ module AWS
       # Convenience method for constructing a new statement with the
       # "Deny" effect and adding it to the policy.  For example:
       #
-      #   policy.deny(
-      #     :actions => [:put_object],
-      #     :principals => :any,
-      #     :resources => "mybucket/mykey/*"
-      #   ).where(:acl).is("public-read")
+      #     policy.deny(
+      #       :actions => [:put_object],
+      #       :principals => :any,
+      #       :resources => "mybucket/mykey/*"
+      #     ).where(:acl).is("public-read")
       #
       # @param (see Statement#initialize)
       # @see Statement#initialize
@@ -244,12 +244,12 @@ module AWS
       # Represents the condition block of a policy.  In JSON,
       # condition blocks look like this:
       #
-      #   { "StringLike": { "s3:prefix": ["photos/*", "photos.html"] } }
+      #     { "StringLike": { "s3:prefix": ["photos/*", "photos.html"] } }
       #
       # ConditionBlock lets you specify conditions like the above
       # example using the add method, for example:
       #
-      #   conditions.add(:like, :s3_prefix, "photos/*", "photos.html")
+      #     conditions.add(:like, :s3_prefix, "photos/*", "photos.html")
       #
       # See the add method documentation for more details about how
       # to specify keys and operators.
@@ -322,22 +322,22 @@ module AWS
         # The following list shows which operators are accepted as
         # symbols and how they are represented in the JSON policy:
         #
-        # * +:is+ (StringEquals, NumericEquals, DateEquals, or Bool)
-        # * +:like+ (StringLike)
-        # * +:not_like+ (StringNotLike)
-        # * +:not+ (StringNotEquals, NumericNotEquals, or DateNotEquals)
-        # * +:greater_than+, +:gt+ (NumericGreaterThan or DateGreaterThan)
-        # * +:greater_than_equals+, +:gte+
+        # * `:is` (StringEquals, NumericEquals, DateEquals, or Bool)
+        # * `:like` (StringLike)
+        # * `:not_like` (StringNotLike)
+        # * `:not` (StringNotEquals, NumericNotEquals, or DateNotEquals)
+        # * `:greater_than`, `:gt` (NumericGreaterThan or DateGreaterThan)
+        # * `:greater_than_equals`, `:gte`
         #   (NumericGreaterThanEquals or DateGreaterThanEquals)
-        # * +:less_than+, +:lt+ (NumericLessThan or DateLessThan)
-        # * +:less_than_equals+, +:lte+
+        # * `:less_than`, `:lt` (NumericLessThan or DateLessThan)
+        # * `:less_than_equals`, `:lte`
         #   (NumericLessThanEquals or DateLessThanEquals)
-        # * +:is_ip_address+ (IpAddress)
-        # * +:not_ip_address+ (NotIpAddress)
-        # * +:is_arn+ (ArnEquals)
-        # * +:not_arn+ (ArnNotEquals)
-        # * +:is_arn_like+ (ArnLike)
-        # * +:not_arn_like+ (ArnNotLike)
+        # * `:is_ip_address` (IpAddress)
+        # * `:not_ip_address` (NotIpAddress)
+        # * `:is_arn` (ArnEquals)
+        # * `:not_arn` (ArnNotEquals)
+        # * `:is_arn_like` (ArnLike)
+        # * `:not_arn_like` (ArnNotLike)
         #
         # @param [Symbol or String] operator The operator used to
         #   compare the key with the value.  See above for valid
@@ -348,8 +348,8 @@ module AWS
         #   default, the key is assumed to be in the "aws"
         #   namespace, but if you prefix the symbol name with "s3_"
         #   it will be sent in the "s3" namespace.  For example,
-        #   +:s3_prefix+ is sent as "s3:prefix" while
-        #   +:secure_transport+ is sent as "aws:SecureTransport".
+        #   `:s3_prefix` is sent as "s3:prefix" while
+        #   `:secure_transport` is sent as "aws:SecureTransport".
         #   See
         #   http://docs.amazonwebservices.com/AmazonS3/latest/dev/UsingResOpsConditions.html
         #   for a list of the available keys for each action in S3.
@@ -731,12 +731,12 @@ module AWS
         #   Symbols are expected to match methods of S3::Client.
         # @option opts :excluded_actions Action or actions which are
         #   explicitly not affected by this statement.  As with
-        #   +:actions+, these may be symbols or strings.
+        #   `:actions`, these may be symbols or strings.
         # @option opts [String or array of strings] :resources The
         #   resource(s) affected by the statement.  These can be
-        #   expressed as ARNs (e.g. +arn:aws:s3:::mybucket/mykey+)
-        #   or you may omit the +arn:aws:s3:::+ prefix and just give
-        #   the path as +bucket_name/key+.  You may use the wildcard
+        #   expressed as ARNs (e.g. `arn:aws:s3:::mybucket/mykey`)
+        #   or you may omit the `arn:aws:s3:::` prefix and just give
+        #   the path as `bucket_name/key`.  You may use the wildcard
         #   character "*" to match zero or more characters in the
         #   resource name.
         # @option opts [ConditionBlock or Hash] :conditions

data/lib/aws/core/region.rb

@@ -0,0 +1,72 @@
+# 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)
+    #
+    # @attr_reader [AutoScaling] auto_scaling
+    # @attr_reader [CloudFormation] cloud_formation
+    # @attr_reader [CloudFront] cloud_front
+    # @attr_reader [CloudSearch] cloud_search
+    # @attr_reader [CloudWatch] cloud_watch
+    # @attr_reader [DynamoDB] dynamo_db
+    # @attr_reader [DataPipeline] data_pipeline
+    # @attr_reader [EC2] ec2
+    # @attr_reader [ElastiCache] elasticache
+    # @attr_reader [ElasticBeanstalk] elastic_beanstalk
+    # @attr_reader [ElasticTranscoder] elastic_transcoder
+    # @attr_reader [ELB] elb
+    # @attr_reader [EMR] emr
+    # @attr_reader [Glacier] glacier
+    # @attr_reader [IAM] iam
+    # @attr_reader [ImportExport] import_export
+    # @attr_reader [OpsWorks] ops_works
+    # @attr_reader [RDS] rds
+    # @attr_reader [Redshift] redshift
+    # @attr_reader [Route53] route_53
+    # @attr_reader [S3] s3
+    # @attr_reader [SimpleDB] simple_db
+    # @attr_reader [SimpleEmailService] simple_email_service
+    # @attr_reader [SimpleWorkflow] simple_workflow
+    # @attr_reader [SNS] sns
+    # @attr_reader [SQS] sqs
+    # @attr_reader [StorageGateway] storage_gateway
+    # @attr_reader [STS] sts
+    #
+    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
+
+    end
+  end
+end

data/lib/aws/core/region_collection.rb

@@ -0,0 +1,106 @@
+# 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)
+      # @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 = self.class.data
+        regions = @service ?
+          data['services'][@service.endpoint_prefix] :
+          data['regions'].keys
+        regions.reject{|r| r =~ /us-gov/ }
+      end
+
+      class << self
+
+        # @return [nil]
+        # @private
+        def clear!
+          @data = nil
+        end
+
+        # @return [Hash] Returns a hash of region metadata.
+        # @private
+        def data
+          @data ||= load_data
+        end
+
+        private
+
+        # @return [Hash]
+        def load_data
+          #return JSON.parse(File.read(File.join(AWS::ROOT, 'endpoints.json')))
+          host = 'aws-sdk-configurations.amazonwebservices.com'
+          path = '/endpoints.json'
+          JSON.parse(Net::HTTP.get(host, path))
+        end
+
+      end
+
+    end
+  end
+end