aws-sdk-v1 1.52.0

data/lib/aws/route_53/resource_record_set_collection.rb

@@ -0,0 +1,110 @@
+# 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 'time'
+
+module AWS
+  class Route53
+
+    # # Create new resource record set
+    #
+    #     rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
+    #     rrset = rrsets.create('foo.example.com.', 'A', :ttl => 300, :resource_records => [{:value => '127.0.0.1'}])
+    #
+    # # Find existing resource record set
+    #
+    #     rrsets = AWS::Route53::HostedZone.new(hosted_zone_id).rrsets
+    #     rrset = rrsets['foo.example.com.', 'A']
+    #
+    class ResourceRecordSetCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # @api private
+      def initialize hosted_zone_id, options = {}
+        @hosted_zone_id = hosted_zone_id
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @return [String]
+      attr_reader :hosted_zone_id
+
+      # Find resource record set by its name, type and identifier.
+      # @param [String] name
+      # @param [String] type
+      # @param [String] set_identifier
+      # @return [ResourceRecordSet]
+      def [] name, type, set_identifier = nil
+        ResourceRecordSet.new(name, type, :set_identifier => set_identifier, :hosted_zone_id => hosted_zone_id, :config => config)
+      end
+
+      # Create new resource record set.
+      # @param [String] name
+      # @param [String] type
+      # @param [Hash] options
+      # @return [ResourceRecordSet]
+      def create name, type, options = {}
+        batch = ChangeBatch.new(hosted_zone_id, :comment => options[:comment], :config => config)
+        batch << CreateRequest.new(name, type, options)
+
+        change_info = batch.call()
+        if change_info
+          ResourceRecordSet.new(name,
+                                type,
+                                :set_identifier => options[:set_identifier],
+                                :change_info => change_info,
+                                :hosted_zone_id => hosted_zone_id,
+                                :config => config)
+        end
+      end
+
+      private
+
+      def _each_item next_token, limit, options = {}, &block
+
+        options = @filters.merge(options)
+
+        options[:start_record_name] = next_token[:next_record_name] if next_token and next_token[:next_record_name]
+        options[:start_record_type] = next_token[:next_record_type] if next_token and next_token[:next_record_type]
+        options[:start_record_identifier] = next_token[:next_record_identifier] if next_token and next_token[:next_record_identifier]
+        options[:maxitems] = limit if limit
+
+        options[:hosted_zone_id] = hosted_zone_id
+
+        resp = client.list_resource_record_sets(options)
+        resp.data[:resource_record_sets].each do |details|
+          rrset = ResourceRecordSet.new_from(
+            :list_resource_record_sets,
+            details,
+            details[:name],
+            details[:type],
+            :set_identifier => details[:set_identifier],
+            :hosted_zone_id => hosted_zone_id, :config => config)
+
+          yield(rrset)
+
+        end
+
+        if resp.data[:is_truncated]
+          {
+            :next_record_name => resp.data[:next_record_name],
+            :next_record_type => resp.data[:next_record_type],
+            :next_record_identifier => resp.data[:next_record_identifier],
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/s3.rb

@@ -0,0 +1,156 @@
+# 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 'aws/core'
+require 'aws/s3/config'
+
+module AWS
+
+  # Provides an expressive, object-oriented interface to Amazon S3.
+  #
+  # To use Amazon S3 you must first
+  # [sign up here](http://aws.amazon.com/s3/).
+  #
+  # For more information about Amazon S3, see:
+  #
+  # * [Amazon S3](http://aws.amazon.com/s3/)
+  # * [Amazon S3 Documentation](http://aws.amazon.com/documentation/s3/)
+  #
+  # # Credentials
+  #
+  # You can setup default credentials for all AWS services via
+  # AWS.config:
+  #
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # Or you can set them directly on the S3 interface:
+  #
+  #     s3 = AWS::S3.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # # Buckets
+  #
+  # Before you can upload files to S3, you need to create a bucket.
+  #
+  #     s3 = AWS::S3.new
+  #     bucket = s3.buckets.create('my-bucket')
+  #
+  # If a bucket already exists, you can get a reference to the bucket.
+  #
+  #     bucket = s3.buckets['my-bucket'] # no request made
+  #
+  # You can also enumerate all buckets in your account.
+  #
+  #     s3.buckets.each do |bucket|
+  #       puts bucket.name
+  #     end
+  #
+  # See {BucketCollection} and {Bucket} for more information on working
+  # with buckets.
+  #
+  # # Objects
+  #
+  # Buckets contain objects.  Each object in a bucket has a unique key.
+  #
+  # ## Getting an Object
+  #
+  # If the object already exists, you can get a reference to the object.
+  #
+  #     # makes no request, returns an AWS::S3::S3Object
+  #     obj = bucket.objects['key']
+  #
+  # ## Reading and Writing an Object
+  #
+  # The example above returns an {S3Object}.  You call {S3Object#write} and
+  # {S3Object#read} to upload to and download from S3 respectively.
+  #
+  #     # streaming upload a file to S3
+  #     obj.write(Pathname.new('/path/to/file.txt'))
+  #
+  #     # streaming download from S3 to a file on disk
+  #     File.open('file.txt', 'wb') do |file|
+  #       obj.read do |chunk|
+  #          file.write(chunk)
+  #       end
+  #     end
+  #
+  # ## Enumerating Objects
+  #
+  # You can enumerate objects in your buckets.
+  #
+  #     # enumerate ALL objects in the bucket (even if the bucket contains
+  #     # more than 1k objects)
+  #     bucket.objects.each do |obj|
+  #       puts obj.key
+  #     end
+  #
+  #     # enumerate at most 20 objects with the given prefix
+  #     bucket.objects.with_prefix('photos/').each(:limit => 20) do |photo|
+  #       puts photo.key
+  #     end
+  #
+  # See {ObjectCollection} and {S3Object} for more information on working
+  # with objects.
+  #
+  class S3
+
+    autoload :AccessControlList, 'aws/s3/access_control_list'
+    autoload :ACLObject, 'aws/s3/acl_object'
+    autoload :ACLOptions, 'aws/s3/acl_options'
+    autoload :Bucket, 'aws/s3/bucket'
+    autoload :BucketCollection, 'aws/s3/bucket_collection'
+    autoload :BucketTagCollection, 'aws/s3/bucket_tag_collection'
+    autoload :BucketLifecycleConfiguration, 'aws/s3/bucket_lifecycle_configuration'
+    autoload :BucketVersionCollection, 'aws/s3/bucket_version_collection'
+    autoload :Client, 'aws/s3/client'
+    autoload :CORSRule, 'aws/s3/cors_rule'
+    autoload :CORSRuleCollection, 'aws/s3/cors_rule_collection'
+    autoload :DataOptions, 'aws/s3/data_options'
+    autoload :EncryptionUtils, 'aws/s3/encryption_utils'
+    autoload :CipherIO, 'aws/s3/cipher_io'
+    autoload :Errors, 'aws/s3/errors'
+    autoload :MultipartUpload, 'aws/s3/multipart_upload'
+    autoload :MultipartUploadCollection, 'aws/s3/multipart_upload_collection'
+    autoload :ObjectCollection, 'aws/s3/object_collection'
+    autoload :ObjectMetadata, 'aws/s3/object_metadata'
+    autoload :ObjectUploadCollection, 'aws/s3/object_upload_collection'
+    autoload :ObjectVersion, 'aws/s3/object_version'
+    autoload :ObjectVersionCollection, 'aws/s3/object_version_collection'
+    autoload :PaginatedCollection, 'aws/s3/paginated_collection'
+    autoload :Policy, 'aws/s3/policy'
+    autoload :PrefixAndDelimiterCollection, 'aws/s3/prefix_and_delimiter_collection'
+    autoload :PrefixedCollection, 'aws/s3/prefixed_collection'
+    autoload :PresignedPost, 'aws/s3/presigned_post'
+    autoload :PresignV4, 'aws/s3/presign_v4'
+    autoload :Request, 'aws/s3/request'
+    autoload :S3Object, 'aws/s3/s3_object'
+    autoload :Tree, 'aws/s3/tree'
+    autoload :UploadedPart, 'aws/s3/uploaded_part'
+    autoload :UploadedPartCollection, 'aws/s3/uploaded_part_collection'
+    autoload :WebsiteConfiguration, 'aws/s3/website_configuration'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 's3'
+
+    # @return [BucketCollection] Returns a collection that represents all
+    #  buckets in the account.
+    def buckets
+      BucketCollection.new(:config => @config)
+    end
+
+  end
+end

data/lib/aws/s3/access_control_list.rb

@@ -0,0 +1,265 @@
+# 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
+  class S3
+
+    # Represents an access control list for S3 objects and buckets.  For example:
+    #
+    #     acl = AccessControlList.new
+    #     acl.grant(:full_control).
+    #       to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
+    #     acl.to_xml                   # => '<AccessControlPolicy>...'
+    #
+    # You can also construct an AccessControlList from a hash:
+    #
+    #     AccessControlList.new(
+    #       :owner => { :id => "8a6925ce4adf588a4f21c32aa379004fef" },
+    #       :grants => [{
+    #         :grantee => { :canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef" },
+    #         :permission => :full_control,
+    #       }]
+    #     )
+    #
+    # @see ACLObject
+    #
+    # @attr [AccessControlList::Owner] owner The owner of the access
+    #   control list.  You can set this as a hash, for example:
+    #    acl.owner = { :id => '8a6925ce4adf588a4f21c32aa379004fef' }
+    #   This attribute is required when setting an ACL.
+    #
+    # @attr [list of AccessControlList::Grant] grants The list of
+    #   grants.  You can set this as a list of hashes, for example:
+    #
+    #       acl.grants = [{
+    #         :grantee => { :canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef" },
+    #         :permission => :full_control,
+    #       }]
+    class AccessControlList
+
+      # Represents an ACL owner.  In the default ACL, this is the
+      # bucket owner.
+      #
+      # @attr [String] id The canonical user ID of the ACL owner.
+      #   This attribute is required when setting an ACL.
+      #
+      # @attr [String] display_name The display name of the ACL
+      #   owner.  This value is ignored when setting an ACL.
+      class Owner
+        include ACLObject
+
+        string_attr "ID", :required => true
+        string_attr "DisplayName"
+      end
+
+      # Represents a user who is granted some kind of permission
+      # through a Grant.  There are three ways to specify a grantee:
+      #
+      # * You can specify the canonical user ID, for example.  When
+      #   you read an ACL from S3, all grantees will be identified
+      #   this way, and the display_name attribute will also be provided.
+      #
+      #       Grantee.new(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
+      #
+      # * You can specify the e-mail address of an AWS customer, for example:
+      #
+      #       Grantee.new(:amazon_customer_email => 'foo@example.com')
+      #
+      # * You can specify a group URI, for example:
+      #
+      #        Grantee.new(:group_uri => 'http://acs.amazonaws.com/groups/global/AllUsers')
+      #
+      #   For more details about group URIs, see:
+      #   http://docs.amazonwebservices.com/AmazonS3/latest/dev/ACLOverview.html
+      #
+      # When constructing a grantee, you must provide a value for
+      # exactly one of the following attributes:
+      #
+      # * `amazon_customer_email`
+      # * `canonical_user_id`
+      # * `group_uri`
+      #
+      # @attr [String] amazon_customer_email The e-mail address of
+      #   an AWS customer.
+      #
+      # @attr [String] canonical_user_id The canonical user ID of an
+      #   AWS customer.
+      #
+      # @attr [String] group_uri A URI that identifies a particular
+      #   group of users.
+      #
+      # @attr [String] display_name The display name associated with
+      #   the grantee.  This is provided by S3 when reading an ACL.
+      class Grantee
+        include ACLObject
+
+        SIGNAL_ATTRIBUTES = [
+          :amazon_customer_email,
+          :canonical_user_id,
+          :group_uri,
+          :uri,
+        ]
+
+        string_attr "EmailAddress", :method_name => "amazon_customer_email"
+        string_attr "ID", :method_name => "canonical_user_id"
+        string_attr "URI", :method_name => "group_uri"
+        string_attr "URI", :method_name => "uri"
+        string_attr "DisplayName"
+
+        # (see ACLObject#validate!)
+        def validate!
+          attr = signal_attribute
+          raise "missing amazon_customer_email, canonical_user_id, "+
+            "or group_uri" unless attr
+          raise "display_name is invalid with #{attr}" if
+            attr != :canonical_user_id and display_name
+        end
+
+        # @api private
+        def stag
+          if attr = signal_attribute
+            super + " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"" +
+              " xsi:type=\"#{type_for_attr(attr)}\""
+          else
+            super
+          end
+        end
+
+        # @api private
+        def signal_attribute
+          SIGNAL_ATTRIBUTES.find { |att| send(att) }
+        end
+
+        # @api private
+        def type_for_attr(attr)
+          {
+            :amazon_customer_email => "AmazonCustomerByEmail",
+            :canonical_user_id => "CanonicalUser",
+            :group_uri => "Group",
+            :uri => "Group",
+          }[attr]
+        end
+
+      end
+
+      # Represents the permission being granted in a Grant object.
+      # Typically you will not need to construct an instance of this
+      # class directly.
+      # @see Grant#permission
+      class Permission
+        include ACLObject
+
+        # The permission expressed as a symbol following Ruby
+        # conventions.  For example, S3's FULL_CONTROL permission
+        # will be returned as `:full_control`.
+        attr_reader :name
+
+        # @api private
+        def initialize(name)
+          raise "expected string or symbol" unless
+            name.respond_to?(:to_str) or name.respond_to?(:to_sym)
+          @name = name.to_sym
+        end
+
+        def body_xml
+          name.to_s.upcase
+        end
+
+      end
+
+      # Represents a single grant in an ACL.  Both `grantee` and
+      # `permission` are required for each grant when setting an
+      # ACL.
+      #
+      # See
+      # http://docs.amazonwebservices.com/AmazonS3/latest/dev/ACLOverview.html
+      # for more information on how grantees and permissions are
+      # interpreted by S3.
+      #
+      # @attr [Grantee] grantee The user or users who are granted
+      #   access according to this grant.  You can specify this as a
+      #   hash:
+      #
+      #       grant.grantee = { :amazon_customer_email => "foo@example.com" }
+      #
+      # @attr [Permission or Symbol] permission The type of
+      #   permission that is granted by this grant.  Valid values are:
+      #   * `:read`
+      #   * `:write`
+      #   * `:read_acp`
+      #   * `:write_acp`
+      #   * `:full_control`
+      class Grant
+
+        include ACLObject
+
+        object_attr Grantee, :required => true
+        object_attr Permission, :required => true, :cast => Symbol
+
+      end
+
+      include ACLObject
+
+      # @api private
+      def stag
+        super()+" xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\""
+      end
+
+      # @api private
+      def element_name
+        "AccessControlPolicy"
+      end
+
+      class GrantBuilder
+
+        # @api private
+        def initialize(acl, grant)
+          @acl = acl
+          @grant = grant
+        end
+
+        # Specifies the grantee.
+        #
+        # @param [Grantee or Hash] grantee A Grantee object or hash;
+        #   for example:
+        #
+        #       acl.grant(:full_control).to(:amazon_customer_email => "foo@example.com")
+        def to(grantee)
+          @grant.grantee = grantee
+          @acl.grants << @grant
+        end
+
+      end
+
+      # Convenience method for constructing a new grant and adding
+      # it to the ACL.
+      #
+      # @example
+      #
+      #   acl.grants.size # => 0
+      #   acl.grant(:full_control).to(:canonical_user_id => "8a6925ce4adf588a4f21c32aa379004fef")
+      #   acl.grants.size # => 1
+      #
+      # @return [GrantBuilder]
+      def grant(permission)
+        GrantBuilder.new(self, Grant.new(:permission => permission))
+      end
+
+      object_attr Owner, :required => true
+      object_list_attr("AccessControlList", Grant,
+                       :required => true, :method_name => :grants)
+
+    end
+
+  end
+end