aws-sdk-v1 1.52.0

data/lib/aws/s3/client/xml.rb

@@ -0,0 +1,266 @@
+# 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
+    class Client < Core::Client
+
+      # @api private
+      module XML
+
+        BaseGrammar = Core::XML::Grammar.new({}, :inflect_rename => true)
+
+        ListBuckets = BaseGrammar.customize do
+          element "Buckets" do
+            list "Bucket"
+          end
+        end
+
+        GetBucketAcl = GetObjectAcl = BaseGrammar.customize do
+          element "AccessControlList" do
+            ignore
+            element "Grant" do
+              rename :grants
+              list
+              element "Grantee" do
+                element "ID" do
+                  rename :canonical_user_id
+                end
+              end
+              element "Permission" do
+                symbol_value
+              end
+            end
+          end
+        end
+
+        ListObjects = BaseGrammar.customize do
+
+          element("Name") { rename :bucket_name }
+          element("MaxKeys") { integer_value }
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("Delimiter") { force }
+
+          element("Contents") do
+            list
+            element("Owner") do
+              element("ID") { }
+              element("DisplayName") { }
+            end
+            element("Key") { }
+            element("Size") { }
+            element("StorageClass") { }
+            element("ETag") { rename :etag }
+
+            element("LastModified") { time_value }
+          end
+
+          element "CommonPrefixes" do
+            collect_values
+          end
+
+        end
+
+        GetBucketLogging = BaseGrammar.customize do
+          element("LoggingEnabled") do
+            element("TargetBucket") { }
+            element("TargetPrefix") { }
+            element("TargetGrants") do
+              list "Grant"
+              element("Grant") do
+                element("Grantee") do
+                  element("EmailAddress") { }
+                  element("ID") { }
+                  element("URI") { }
+                end
+                element("Permission") { }
+              end
+            end
+          end
+        end
+
+        GetBucketVersioning = BaseGrammar.customize do
+          default_value :status, :unversioned
+          element("Status") do
+            symbol_value
+          end
+        end
+
+        ListObjectVersions = BaseGrammar.customize do
+
+          element("MaxKeys") { integer_value }
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("NextKeyMarker") { force }
+          element("NextVersionIdMarker") { force }
+
+          %w(DeleteMarker Version).each do |element_name|
+            element(element_name) do
+              collect_values
+              rename(:versions)
+              element("IsLatest") { rename :latest; boolean_value }
+              element("LastModified") { datetime_value }
+              element("ETag") { rename :etag }
+              element("Size") { integer_value }
+              element("StorageClass") { symbol_value }
+            end
+          end
+
+          element "DeleteMarker" do
+            default_value(:delete_marker, true)
+            default_value(:version, false)
+          end
+
+          element "Version" do
+            default_value(:delete_marker, false)
+            default_value(:version, true)
+          end
+
+          element "CommonPrefixes" do
+            collect_values
+          end
+
+        end
+
+        InitiateMultipartUpload = BaseGrammar.customize do
+          element("UploadId") { force }
+        end
+
+        ListMultipartUploads = BaseGrammar.customize do
+
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("MaxUploads") { integer_value }
+          element("NextKeyMarker") { force }
+          element("NextUploadIdMarker") { force }
+          element("Upload") do
+            collect_values
+            rename :uploads
+            element("StorageClass") { symbol_value }
+            element("Initiated") { datetime_value }
+          end
+
+          element "CommonPrefixes" do
+            collect_values
+          end
+
+        end
+
+        DeleteObjects = BaseGrammar.customize do
+          element("Deleted") do
+            element("DeleteMarker") { boolean_value }
+            list
+          end
+          element("Error") { list; rename(:errors) }
+        end
+
+        CompleteMultipartUpload = BaseGrammar.customize
+
+        ListParts = BaseGrammar.customize do
+          element("StorageClass") { symbol_value }
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("MaxParts") { integer_value }
+          element("PartNumberMarker") { integer_value }
+          element("NextPartNumberMarker") { integer_value }
+          element("Part") do
+            collect_values
+            rename :parts
+            element("PartNumber") { integer_value }
+            element("LastModified") { datetime_value }
+            element("Size") { integer_value }
+          end
+        end
+
+        GetBucketLifecycleConfiguration = BaseGrammar.customize do
+          element("Rule") do
+            list
+            rename(:rules)
+            element("Expiration") do
+              element("Days") { integer_value }
+              element("Date") { datetime_value }
+            end
+            element("Transition") do
+              element("StorageClass") { }
+              element("Days") { integer_value }
+              element("Date") { datetime_value }
+            end
+            element("NoncurrentVersionTransition") do
+              element("NoncurrentDays") { integer_value }
+              element("StorageClass") { string_value }
+            end
+            element("NoncurrentVersionDays") do
+              element("NoncurrentDays") { integer_value }
+            end
+          end
+        end
+
+        GetBucketCors = BaseGrammar.customize do
+          element "CORSRule" do
+            list
+            rename :rules
+            element "AllowedMethod" do
+              list
+              rename :allowed_methods
+            end
+            element "AllowedOrigin" do
+              list
+              rename :allowed_origins
+            end
+            element "AllowedHeader" do
+              list
+              rename :allowed_headers
+            end
+            element "MaxAgeSeconds" do
+              integer
+            end
+            element "ExposeHeader" do
+              list
+              rename :expose_headers
+            end
+          end
+        end
+
+        GetBucketTagging = BaseGrammar.customize do
+          element "TagSet" do
+            ignore
+            element "Tag" do
+              map_entry("Key", "Value")
+              rename :tags
+            end
+          end
+        end
+
+        GetBucketWebsite = BaseGrammar.customize do
+          element "IndexDocument" do
+            element "Suffix"
+          end
+          element "ErrorDocument" do
+            element "Key"
+          end
+          element "RoutingRules" do
+            list("RoutingRule")
+          end
+        end
+
+        CopyPart = BaseGrammar.customize do
+          element "ETag" do
+            rename :etag
+          end
+          element "LastModified" do
+            datetime_value
+            rename :last_modified
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws/s3/config.rb

@@ -0,0 +1,48 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'S3', 's3', 's3'
+
+  add_option :s3_force_path_style, false, :boolean => true
+
+  add_option :s3_multipart_threshold, 16 * 1024 * 1024
+
+  add_option :s3_multipart_min_part_size, 5 * 1024 * 1024
+
+  add_option :s3_multipart_max_parts, 10000
+
+  add_option :s3_server_side_encryption, nil
+
+  add_option :s3_encryption_key, nil
+
+  add_option :s3_encryption_materials_location, :metadata
+
+  add_option :s3_encryption_matdesc, '{}'
+
+  add_option :s3_storage_class, 'STANDARD'
+
+  add_option :s3_signature_version do |config, value|
+    if config.s3_region.match(/^cn-/)
+      :v4
+    elsif value
+      value
+    elsif config.s3 && config.s3[:signature_version]
+      config.s3[:signature_version]
+    else
+      :v3
+    end
+  end
+
+end

data/lib/aws/s3/cors_rule.rb

@@ -0,0 +1,108 @@
+# 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 single CORS rule for an S3 {Bucket}.
+    #
+    # @example
+    #
+    #   rule = bucket.cors.first
+    #   rule.allowed_methods #=> ['GET', 'HEAD']
+    #   rule.allowed_origins #=> ['*']
+    #
+    # @see CORSRuleCollection
+    class CORSRule
+
+      # @param [Hash] options A hash of the rule details.
+      #
+      # @option options [String] :id A unique identifier for the rule. The ID
+      #   value can be up to 255 characters long. The IDs help you find
+      #   a rule in the configuration.
+      #
+      # @option options [required,Array<String>] :allowed_methods A list of HTTP
+      #   methods that you want to allow the origin to execute.
+      #   Each rule must identify at least one method.
+      #
+      # @option options [required,Array<String>] :allowed_origins A list of
+      #   origins you want to allow cross-domain requests from. This can
+      #   contain at most one * wild character.
+      #
+      # @option options [Array<String>] :allowed_headers A list of headers
+      #   allowed in a pre-flight OPTIONS request via the
+      #   Access-Control-Request-Headers header. Each header name
+      #   specified in the Access-Control-Request-Headers header must
+      #   have a corresponding entry in the rule.
+      #
+      #   Amazon S3 will send only the allowed headers in a response
+      #   that were requested. This can contain at most one '*' wild
+      #   character.
+      #
+      # @option options [Array<String>] :max_age_seconds The time in
+      #   seconds that your browser is to cache the pre-flight response for
+      #   the specified resource.
+      #
+      # @option options [Array<String>] :expose_headers One or more headers in
+      #    the response that you want customers to be able to access
+      #    from their applications (for example, from a JavaScript
+      #    XMLHttpRequest object).
+      #
+      def initialize options = {}
+        @id = options[:id]
+        @allowed_methods = options[:allowed_methods] || []
+        @allowed_origins = options[:allowed_origins] || []
+        @allowed_headers = options[:allowed_headers] || []
+        @max_age_seconds = options[:max_age_seconds]
+        @expose_headers = options[:expose_headers] || []
+      end
+
+      # @return [String,nil] A user supplied unique identifier for this role.
+      #   Set this when you set or add roles via {CORSRuleCollection}.
+      attr_reader :id
+
+      # @return [Array<String>] A list of HTTP methods (GET, POST, etc) this
+      #   role authorizes.
+      attr_reader :allowed_methods
+
+      # @return [Array<String>] The list of origins allowed to make
+      #   cross-domain requests to the bucket.
+      attr_reader :allowed_origins
+
+      # @return [Array<String>] A list of headers allowed in the pre-flight
+      #   OPTIONS request.
+      attr_reader :allowed_headers
+
+      # @return [Integer,nil] The time in seconds the browser may cache the
+      #   pre-flight response.
+      attr_reader :max_age_seconds
+
+      # @return [Array<String>] The headers that may be accessed cross-domain.
+      attr_reader :expose_headers
+
+      # @return [Hash]
+      def to_h
+        h = {}
+        h[:id] = id if id
+        h[:allowed_methods] = allowed_methods
+        h[:allowed_origins] = allowed_origins
+        h[:allowed_headers] = allowed_headers unless allowed_headers.empty?
+        h[:max_age_seconds] = max_age_seconds if max_age_seconds
+        h[:expose_headers] = expose_headers unless expose_headers.empty?
+        h
+      end
+
+    end
+
+  end
+end

data/lib/aws/s3/cors_rule_collection.rb

@@ -0,0 +1,194 @@
+# 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
+
+    # Manages the CORS rules for a single bucket.
+    #
+    # ## Getting Rules
+    #
+    # To get the CORS rules for a bucket, use the {Bucket#cors} method.  This
+    # returns a CORSRuleCollection for the bucket.  The collection is
+    # enumerable.
+    #
+    #     # enumerating all rules for a buck
+    #     bucket.cors.each do |rule|
+    #       # rule is a CORSRule object
+    #     end
+    #
+    # ## Setting Rules
+    #
+    # You can set the rules for a bucket (replacing all existing rules) using
+    # the {#set} method.
+    #
+    #     # accepts a list of one or more rules
+    #     bucket.rules.set(rule1, rule2)
+    #
+    #     # rules can be an array of rules
+    #     bucket.rules.set(rules)
+    #
+    #     # passing an empty list or array removes all rules
+    #     bucket.rules.set([])
+    #     bucket.rules.clear # does the same thing
+    #
+    # Each rule can be a Hash, a {CORSRule} or another {CORSRuleCollection}.
+    # See {Client#put_bucket_cors} for a list of keys for a rule hash.
+    #
+    # ## Adding Rules
+    #
+    # Adding rules is the same as setting rules.  Rules you add will be
+    # appended to the end of the existing list of rules.
+    #
+    #     # add one or more rules
+    #     bucket.rules.add(rules)
+    #
+    # ## Deleting Rules
+    #
+    # To remove a rule, use the {#delete_if} method.
+    #
+    #     # delete rules that allow access from any domain
+    #     bucket.cors.delete_if{|rule| rule.allowed_origins.include?('*')
+    class CORSRuleCollection
+
+      include Core::Collection::Simple
+
+      # @param [Bucket] bucket
+      # @param [Hash] options
+      def initialize bucket, options = {}
+        @bucket = bucket
+        super
+      end
+
+      # @return [Bucket]
+      attr_reader :bucket
+
+      # Replaces the CORS rules attached to this bucket.  You can pass
+      # one or more rules as an array or a list.
+      #
+      #     # replace all exisitng rules with a single rule
+      #     bucket.cors.set(
+      #       :allowed_methods => %w(GET),
+      #       :allowed_origins => %w(http://*.mydomain.com),
+      #       :max_age_seconds => 3600)
+      #
+      # If you pass an empty array, all of the rules will be removed from
+      # the bucket.
+      #
+      #      # these two lines are equivilent
+      #      bucket.cors.clear
+      #      bucket.cors.set([])
+      #
+      # @param [Hash,CORSRule,CORSRuleCollection] rules A list or array
+      #   of one or more rules to set.  Each rule may be a Hash, a CORSRule
+      #   or a CORSRuleCollection.
+      #
+      # @return [nil]
+      #
+      def set *rules
+
+        raise ArgumentError, 'expected one or more rules' if rules.empty?
+
+        if rules == [[]]
+          self.clear
+        else
+          rules = rule_hashes(rules)
+          client.put_bucket_cors(:bucket_name => bucket.name, :rules => rules)
+        end
+
+        nil
+
+      end
+
+      # Add one or more CORS rules to this bucket.
+      #
+      #     # adding a single rule as a hash
+      #     bucket.cors.add(
+      #       :allowed_methods => %w(GET HEAD),
+      #       :allowed_origins => %w(*),
+      #       :max_age_seconds => 3600)
+      #
+      # You can add multiple rules in a single call:
+      #
+      #     # each rule may be a hash, CORSRule or a CORSRuleCollection,
+      #     bucket.cors.add(rules)
+      #
+      #     # alternatively you can pass a list of rules
+      #     bucket.cors.add(rule1, rule2, ...)
+      #
+      # @param (see #set)
+      # @return (see #set)
+      def add *rules
+        self.set(self, *rules)
+      end
+      alias_method :create, :add
+
+      # Deletes every rule for which the block evaluates to `true`.
+      #
+      # @example Remove all rules that are open to the 'world'
+      #
+      #   bucket.cors.delete_if{|rule| rule.allowed_origins.include?('*') }
+      #
+      # @yield [rule]
+      # @yieldparam [CORSRule] rule
+      # @yieldreturn [Boolean] Return `true` for each rule you want to delete.
+      # @return (see #set)
+      def delete_if &block
+        rules = []
+        self.each do |rule|
+          rules << rule unless yield(rule)
+        end
+        self.set(rules)
+      end
+
+      # Removes all CORS rules attached to this bucket.
+      #
+      # @example
+      #
+      #   bucket.cors.count #=> 3
+      #   bucket.cors.clear
+      #   bucket.cors.count #=> 0
+      #
+      # @return [nil]
+      def clear
+        client.delete_bucket_cors(:bucket_name => bucket.name)
+        nil
+      end
+
+      protected
+
+      def _each_item options
+        resp = client.get_bucket_cors(options.merge(:bucket_name => bucket.name))
+        resp.data[:rules].each do |rule|
+          yield(CORSRule.new(rule))
+        end
+      rescue AWS::S3::Errors::NoSuchCORSConfiguration
+        # no cors rules exist for this bucket, nothing to yield
+      end
+
+      def rule_hashes rule
+        case rule
+        when Hash then rule
+        when CORSRule then rule.to_h
+        when CORSRuleCollection then rule.map(&:to_h)
+        when Array then rule.map{|r| rule_hashes(r) }.flatten
+        else
+          msg = "Expected one or more CORSRule, CORSRuleCollection or hash"
+          msg << ", got #{rule.class.name}"
+          raise ArgumentError, msg
+        end
+      end
+
+    end
+  end
+end