aws-sdk-v1 1.52.0

data/lib/aws/s3/uploaded_part.rb

@@ -0,0 +1,82 @@
+# 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 a part of a multipart upload that has been uploaded
+    # to S3.
+    #
+    # @example Get the total size of the uploaded parts
+    #  upload.parts.inject(0) { |sum, part| sum + part.size }
+    class UploadedPart
+
+      include Core::Model
+
+      # @return [MultipartUpload] The upload to which this belongs.
+      attr_reader :upload
+
+      # @return [Integer] The part number.
+      attr_reader :part_number
+
+      # @api private
+      def initialize(upload, part_number, opts = {})
+        @upload = upload
+        @part_number = part_number
+        @etag = opts[:etag]
+        super
+      end
+
+      def ==(other)
+        other.kind_of?(UploadedPart) and
+          other.upload == upload and
+          other.part_number == part_number
+      end
+      alias_method :eql?, :==
+
+      # @return [Integer] The size of the part as it currently
+      #   exists in S3.
+      def size
+        get_attribute(:size)
+      end
+
+      # @return [DateTime] The time at which the part was last
+      #   modified.
+      def last_modified
+        get_attribute(:last_modified)
+      end
+
+      # @return [String] The ETag of the part.
+      def etag
+        @etag ||= get_attribute(:etag)
+        @etag
+      end
+
+      # @api private
+      private
+      def get_attribute(name)
+        (resp = client.list_parts(:bucket_name => upload.object.bucket.name,
+                                  :key => upload.object.key,
+                                  :upload_id => upload.id,
+                                  :part_number_marker => part_number-1,
+                                  :max_parts => 1) and
+         part = resp.parts.first and
+         part.part_number == part_number and
+         part.send(name)) or
+          raise "part #{part_number} of upload #{upload.id} does not exist"
+      end
+
+    end
+
+  end
+end

data/lib/aws/s3/uploaded_part_collection.rb

@@ -0,0 +1,84 @@
+# 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 the collection of parts that have been uploaded for
+    # a given multipart upload.  You can get an instance of this
+    # class by calling {MultipartUpload#parts}.
+    #
+    # @example Get the total size of the uploaded parts
+    #  upload.parts.inject(0) { |sum, part| sum + part.size }
+    class UploadedPartCollection
+
+      include Enumerable
+      include Core::Model
+      include PaginatedCollection
+
+      # @return [MultipartUpload] The upload to which the parts belong.
+      attr_reader :upload
+
+      # @api private
+      def initialize(upload, opts = {})
+        @upload = upload
+        super
+      end
+
+      # @return [UploadedPart] An object representing the part with
+      #   the given part number.
+      #
+      # @param [Integer] number The part number.
+      def [](number)
+        UploadedPart.new(upload, number)
+      end
+
+      # @api private
+      protected
+      def each_member_in_page(page, &block)
+        page.parts.each do |part_info|
+          part = UploadedPart.new(upload, part_info.part_number, :etag => part_info.etag)
+          yield(part)
+        end
+      end
+
+      # @api private
+      protected
+      def list_options(options)
+        opts = super
+        opts.merge!(:bucket_name => upload.object.bucket.name,
+                    :key => upload.object.key,
+                    :upload_id => upload.id)
+        opts
+      end
+
+      # @api private
+      protected
+      def limit_param; :max_parts; end
+
+      # @api private
+      protected
+      def list_request(options)
+        client.list_parts(options)
+      end
+
+      # @api private
+      protected
+      def pagination_markers
+        [:part_number_marker]
+      end
+
+    end
+
+  end
+end

data/lib/aws/s3/website_configuration.rb

@@ -0,0 +1,102 @@
+# 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 'base64'
+
+module AWS
+  class S3
+    class WebsiteConfiguration
+
+      # @option options [Hash] :redirect_all_requests_to
+      #   Describes the redirect behavior for every request to this
+      #   bucket's website endpoint. If this element is present, no
+      #   other options are are allowed.
+      #   * `:host_name` - (*required*, String)
+      #     Name of the host where requests will be redirected.
+      #   * `:protocol` - (String)
+      #     Protocol to use (http, https) when redirecting requests. The
+      #     default is the protocol that is used in the original request.
+      # @option options [Hash] :index_document
+      #   * `:suffix` - (*required*, String) - A suffix that is appended to
+      #     a request that is for a directory on the website endpoint
+      #     (e.g. if the suffix is index.html and you make a request to
+      #     samplebucket/images/ the data that is returned will be for
+      #     the object with the key name images/index.html).
+      #     The suffix must not be empty and must not include a
+      #     slash character.
+      # @option options [Hash] :error_document
+      #   * `:key` - (*required*, String) - The object key name to use
+      #     when a 4XX class error occurs.
+      # @option options [Array<Hash>] :routing_rules
+      #   * `:redirect` - (*required*, Hash)
+      #     * `:host_name` - (String)
+      #     * `:protocol` - (String)
+      #     * `:replace_key_prefix_with` - (String)
+      #     * `:replace_key_with` - (String)
+      #     * `:http_redirect_code` - (String)
+      #   * `:condition` - (Hash)
+      #     * `:key_prefix_equals` - (String)
+      #     * `:http_error_code_returned_equals` - (String)
+      def initialize options = {}
+        @options = deep_copy(options)
+        if @options.empty?
+          @options[:index_document] = { :suffix => 'index.html' }
+          @options[:error_document] = { :key => 'error.html' }
+        end
+      end
+
+      # @return [Hash]
+      attr_reader :options
+
+      alias_method :to_hash, :options
+
+      # This method exists for backwards compatability.
+      # @return [String,nil]
+      # @api private
+      def index_document_suffix
+        (@options[:index_document] || {})[:suffix]
+      end
+
+      # This method exists for backwards compatability.
+      # @api private
+      def index_document_suffix= suffix
+        @options.delete(:redirect_all_requests_to)
+        @options[:index_document] ||= {}
+        @options[:index_document][:suffix] = suffix
+      end
+
+      # This method exists for backwards compatability.
+      # @return [String,nil]
+      # @api private
+      def error_document_key
+        (@options[:error_document] || {})[:key]
+      end
+
+      # This method exists for backwards compatability.
+      # @api private
+      def error_document_key= key
+        @options.delete(:redirect_all_requests_to)
+        @options[:error_document] ||= {}
+        @options[:error_document][:key] = key
+      end
+
+      private
+
+      def deep_copy hash
+        Marshal.load(Marshal.dump(hash))
+      end
+
+    end
+  end
+end

data/lib/aws/simple_db.rb

@@ -0,0 +1,218 @@
+# 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/simple_db/config'
+
+module AWS
+
+  # This class is the starting point for working with Amazon SimpleDB.
+  #
+  # To use Amazon SimpleDB you must first
+  # [sign up here](http://aws.amazon.com/simpledb/).
+  #
+  # For more information about Amazon SimpleDB:
+  #
+  # * [Amazon SimpleDB](http://aws.amazon.com/simpledb/)
+  # * [Amazon SimpleDB Documentation](http://aws.amazon.com/documentation/simpledb/)
+  #
+  # # 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 SimpleDB interface:
+  #
+  #     sdb = AWS::SimpleDB.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # # Understanding the SimpleDB Interface
+  #
+  # SimpleDB stores data in a hierarchy of:
+  #
+  # Domains > Items > Attributes
+  #
+  # These are modeled with the following classes:
+  #
+  # * {DomainCollection}
+  # * {Domain}
+  # * {ItemCollection}
+  # * {Item}
+  # * {AttributeCollection}
+  # * {Attribute}
+  #
+  # The collection classes listed above make it easy to enumerate,
+  # the objects they represent.  They also make it easy to perform
+  # bulk operations on all objects in that collection.
+  #
+  # # Domains
+  #
+  # Domains are like database tables.  A domain must exist before you can
+  # write to it.  To create a domain:
+  #
+  #     sdb = SimpleDB.new
+  #     domain = sdb.domains.create('mydomain')
+  #
+  # For more information about working with domains see {DomainCollection}
+  # and {Domain}.
+  #
+  # # Items & Attributes
+  #
+  # Items exist in SimpleDB when they have attributes.  You can delete an
+  # item by removing all of its attributes.  You create an item by adding
+  # an attribute to it.
+  #
+  # The following example illustrates how you can reference an item that
+  # does not exist yet:
+  #
+  #     sdb = SimpleDB.new
+  #
+  #     # this domain is empty, it has no items
+  #     domain = sdb.domains.create('newdomain')
+  #     domain.items.collect(&:name)
+  #     #=> []
+  #
+  #     # this item doesn't exist yet, so it has no attributes
+  #     item = domain.items['newitem']
+  #     item.attributes.collect(&:name)
+  #     #=> []
+  #
+  #     # the item has no attributes
+  #     tags = item.attributes['tags']
+  #     tags.values
+  #     #=> []
+  #
+  # To create the item in SimpleDB you just need to add an attribute.
+  #
+  #     tags.add %w(first new)
+  #
+  #     domain.items.collect(&:name)
+  #     #=> ['newitem']
+  #
+  #     item.attributes.collect(&:name)
+  #     #=> ['tags']
+  #
+  #     tags.values
+  #     #=> ['first', 'new']
+  #
+  # For more information about working with items and attributes, see:
+  #
+  # * {ItemCollection}
+  # * {Item}
+  # * {AttributeCollection}
+  # * {Attribute}
+  #
+  # # Lazy Execution
+  #
+  # Requests are not made until necessary.  This means you can drill down
+  # all the way to an attribute, by name, without making any requests
+  # to SimpleDB.
+  #
+  #     # makes no request to SimpleDB
+  #     sdb = SimpleDB.new
+  #     colors = sdb.domains['mydomain'].items['car'].attributes['colors']
+  #
+  #     # one request to get the values for 'colors'
+  #     puts colors.values
+  #
+  #     # one request to add blue and green
+  #     colors.add 'blue', 'green'
+  #
+  #     # one request to delete the colors attribute
+  #     colors.delete
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level SimpleDB client object
+  class SimpleDB
+
+    autoload :Attribute, 'aws/simple_db/attribute'
+    autoload :AttributeCollection, 'aws/simple_db/attribute_collection'
+    autoload :Client, 'aws/simple_db/client'
+    autoload :ConsistentReadOption, 'aws/simple_db/consistent_read_option'
+    autoload :DeleteAttributes, 'aws/simple_db/delete_attributes'
+    autoload :Domain, 'aws/simple_db/domain'
+    autoload :DomainCollection, 'aws/simple_db/domain_collection'
+    autoload :DomainMetadata, 'aws/simple_db/domain_metadata'
+    autoload :Errors, 'aws/simple_db/errors'
+    autoload :ExpectConditionOption, 'aws/simple_db/expect_condition_option'
+    autoload :Item, 'aws/simple_db/item'
+    autoload :ItemCollection, 'aws/simple_db/item_collection'
+    autoload :ItemData, 'aws/simple_db/item_data'
+    autoload :PutAttributes, 'aws/simple_db/put_attributes'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'sdb'
+
+    # Returns a collection object that represents the domains in your
+    # account.
+    #
+    # @return [DomainCollection] Returns a collection representing all your
+    #   domains.
+    def domains
+      DomainCollection.new(:config => config)
+    end
+
+    # Call this method with a block.  Code executed inside the block
+    # make consistent reads until the block ends.
+    #
+    #     AWS::SimpleDB.consistent_reads do
+    #       # ...
+    #     end
+    #
+    # ### Other Modes
+    #
+    # You can also use this same function to disable consistent reads inside
+    # a block.  This is useful if you have consistent reads enabled by
+    # default:
+    #
+    #     AWS::SimpleDB.consistent_reads(false) do
+    #       # ...
+    #     end
+    #
+    # @param [Boolean] state (true) When true, all SimpleDB read operations
+    #   will be consistent reads inside the block.  When false, all
+    #   reads operations will not be consistent reads.  The previous state
+    #   will be restored after the block executes.
+    # @return Returns the final block value.
+    def self.consistent_reads state = true, &block
+      begin
+        prev_state = Thread.current['_simple_db_consistent_reads_']
+        Thread.current['_simple_db_consistent_reads_'] = state
+        yield
+      ensure
+        Thread.current['_simple_db_consistent_reads_'] = prev_state
+      end
+    end
+
+    # @return [Boolean] Returns true if we are inside an AWS::SimpleDB
+    #   #consistent_reads method block.
+    # @api private
+    def self.in_consistent_reads_block?
+      !Thread.current['_simple_db_consistent_reads_'].nil?
+    end
+
+    # @return [Boolean] Returns true if the consistent_reads block has
+    #   a true state, false otherwise.
+    # @api private
+    def self.consistent_reads_state
+      Thread.current['_simple_db_consistent_reads_']
+    end
+
+  end
+end