aws-sdk-s3 1.0.0.rc1

data/lib/aws-sdk-s3/bucket_region_cache.rb

@@ -0,0 +1,79 @@
+require 'thread'
+
+module Aws
+  module S3
+    class BucketRegionCache
+
+      def initialize
+        @regions = {}
+        @listeners = []
+        @mutex = Mutex.new
+      end
+
+      # Registers a block as a callback. This listener is called when a
+      # new bucket/region pair is added to the cache.
+      #
+      #     S3::BUCKET_REGIONS.bucket_added do |bucket_name, region_name|
+      #       # ...
+      #     end
+      #
+      # This happens when a request is made against the classic endpoint,
+      # "s3.amazonaws.com" and an error is returned requiring the request
+      # to be resent with Signature Version 4. At this point, multiple
+      # requests are made to discover the bucket region so that a v4
+      # signature can be generated.
+      #
+      # An application can register listeners here to avoid these extra
+      # requests in the future. By constructing an {S3::Client} with
+      # the proper region, a proper signature can be generated and redirects
+      # avoided.
+      # @return [void]
+      def bucket_added(&block)
+        if block
+          @mutex.synchronize { @listeners << block }
+        else
+          raise ArgumentError, 'missing required block'
+        end
+      end
+
+      # @param [String] bucket_name
+      # @return [String,nil] Returns the cached region for the named bucket.
+      #   Returns `nil` if the bucket is not in the cache.
+      # @api private
+      def [](bucket_name)
+        @mutex.synchronize { @regions[bucket_name] }
+      end
+
+      # Caches a bucket's region. Calling this method will trigger each
+      # of the {#bucket_added} listener callbacks.
+      # @param [String] bucket_name
+      # @param [String] region_name
+      # @return [void]
+      # @api private
+      def []=(bucket_name, region_name)
+        @mutex.synchronize do
+          @regions[bucket_name] = region_name
+          @listeners.each { |block| block.call(bucket_name, region_name) }
+        end
+      end
+
+      # @api private
+      def clear
+        @mutex.synchronize { @regions = {} }
+      end
+
+      # @return [Hash] Returns a hash of cached bucket names and region names.
+      def to_hash
+        @mutex.synchronize do
+          @regions.dup
+        end
+      end
+      alias to_h to_hash
+
+    end
+
+    # @api private
+    BUCKET_REGIONS = BucketRegionCache.new
+
+  end
+end

data/lib/aws-sdk-s3/bucket_request_payment.rb

@@ -0,0 +1,128 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module S3
+    class BucketRequestPayment
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(bucket_name, options = {})
+      #   @param [String] bucket_name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :bucket_name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @bucket_name = extract_bucket_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def bucket_name
+        @bucket_name
+      end
+
+      # Specifies who pays for the download and request fees.
+      # @return [String]
+      def payer
+        data.payer
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {BucketRequestPayment}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     bucket_request_payment.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_bucket_request_payment(bucket: @bucket_name)
+        @data = resp.data
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::GetBucketRequestPaymentOutput]
+      #   Returns the data for this {BucketRequestPayment}. Calls
+      #   {Client#get_bucket_request_payment} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   bucket_request_payment.put({
+      #     content_md5: "ContentMD5",
+      #     request_payment_configuration: { # required
+      #       payer: "Requester", # required, accepts Requester, BucketOwner
+      #     },
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :content_md5
+      # @option options [required, Types::RequestPaymentConfiguration] :request_payment_configuration
+      # @return [EmptyStructure]
+      def put(options = {})
+        options = options.merge(bucket: @bucket_name)
+        resp = @client.put_bucket_request_payment(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Bucket]
+      def bucket
+        Bucket.new(
+          name: @bucket_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { bucket_name: @bucket_name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_bucket_name(args, options)
+        value = args[0] || options.delete(:bucket_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :bucket_name"
+        else
+          msg = "expected :bucket_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

data/lib/aws-sdk-s3/bucket_tagging.rb

@@ -0,0 +1,143 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module S3
+    class BucketTagging
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(bucket_name, options = {})
+      #   @param [String] bucket_name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :bucket_name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @bucket_name = extract_bucket_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def bucket_name
+        @bucket_name
+      end
+
+      # @return [Array<Types::Tag>]
+      def tag_set
+        data.tag_set
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {BucketTagging}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     bucket_tagging.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_bucket_tagging(bucket: @bucket_name)
+        @data = resp.data
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::GetBucketTaggingOutput]
+      #   Returns the data for this {BucketTagging}. Calls
+      #   {Client#get_bucket_tagging} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   bucket_tagging.delete()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(bucket: @bucket_name)
+        resp = @client.delete_bucket_tagging(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   bucket_tagging.put({
+      #     content_md5: "ContentMD5",
+      #     tagging: { # required
+      #       tag_set: [ # required
+      #         {
+      #           key: "ObjectKey", # required
+      #           value: "Value", # required
+      #         },
+      #       ],
+      #     },
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :content_md5
+      # @option options [required, Types::Tagging] :tagging
+      # @return [EmptyStructure]
+      def put(options = {})
+        options = options.merge(bucket: @bucket_name)
+        resp = @client.put_bucket_tagging(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Bucket]
+      def bucket
+        Bucket.new(
+          name: @bucket_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { bucket_name: @bucket_name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_bucket_name(args, options)
+        value = args[0] || options.delete(:bucket_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :bucket_name"
+        else
+          msg = "expected :bucket_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

data/lib/aws-sdk-s3/bucket_versioning.rb

@@ -0,0 +1,188 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module S3
+    class BucketVersioning
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(bucket_name, options = {})
+      #   @param [String] bucket_name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :bucket_name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @bucket_name = extract_bucket_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def bucket_name
+        @bucket_name
+      end
+
+      # The versioning state of the bucket.
+      # @return [String]
+      def status
+        data.status
+      end
+
+      # Specifies whether MFA delete is enabled in the bucket versioning
+      # configuration. This element is only returned if the bucket has been
+      # configured with MFA delete. If the bucket has never been so
+      # configured, this element is not returned.
+      # @return [String]
+      def mfa_delete
+        data.mfa_delete
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {BucketVersioning}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     bucket_versioning.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_bucket_versioning(bucket: @bucket_name)
+        @data = resp.data
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::GetBucketVersioningOutput]
+      #   Returns the data for this {BucketVersioning}. Calls
+      #   {Client#get_bucket_versioning} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   bucket_versioning.enable({
+      #     content_md5: "ContentMD5",
+      #     mfa: "MFA",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :content_md5
+      # @option options [String] :mfa
+      #   The concatenation of the authentication device's serial number, a
+      #   space, and the value that is displayed on your authentication device.
+      # @return [EmptyStructure]
+      def enable(options = {})
+        options = Aws::Util.deep_merge(options,
+          bucket: @bucket_name,
+          versioning_configuration: {
+            status: "Enabled"
+          }
+        )
+        resp = @client.put_bucket_versioning(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   bucket_versioning.put({
+      #     content_md5: "ContentMD5",
+      #     mfa: "MFA",
+      #     versioning_configuration: { # required
+      #       mfa_delete: "Enabled", # accepts Enabled, Disabled
+      #       status: "Enabled", # accepts Enabled, Suspended
+      #     },
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :content_md5
+      # @option options [String] :mfa
+      #   The concatenation of the authentication device's serial number, a
+      #   space, and the value that is displayed on your authentication device.
+      # @option options [required, Types::VersioningConfiguration] :versioning_configuration
+      # @return [EmptyStructure]
+      def put(options = {})
+        options = options.merge(bucket: @bucket_name)
+        resp = @client.put_bucket_versioning(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   bucket_versioning.suspend({
+      #     content_md5: "ContentMD5",
+      #     mfa: "MFA",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :content_md5
+      # @option options [String] :mfa
+      #   The concatenation of the authentication device's serial number, a
+      #   space, and the value that is displayed on your authentication device.
+      # @return [EmptyStructure]
+      def suspend(options = {})
+        options = Aws::Util.deep_merge(options,
+          bucket: @bucket_name,
+          versioning_configuration: {
+            status: "Suspended"
+          }
+        )
+        resp = @client.put_bucket_versioning(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Bucket]
+      def bucket
+        Bucket.new(
+          name: @bucket_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { bucket_name: @bucket_name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_bucket_name(args, options)
+        value = args[0] || options.delete(:bucket_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :bucket_name"
+        else
+          msg = "expected :bucket_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end