fog-aws 0.0.5

data/lib/fog/aws/requests/storage/delete_object.rb

@@ -0,0 +1,115 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        # Delete an object from S3
+        #
+        # @param bucket_name [String] Name of bucket containing object to delete
+        # @param object_name [String] Name of object to delete
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html
+
+        def delete_object(bucket_name, object_name, options = {})
+          if version_id = options.delete('versionId')
+            query = {'versionId' => version_id}
+          else
+            query = {}
+          end
+
+          headers = options
+          request({
+            :expects    => 204,
+            :headers    => headers,
+            :bucket_name => bucket_name,
+            :object_name => object_name,
+            :idempotent => true,
+            :method     => 'DELETE',
+            :query      => query
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def delete_object(bucket_name, object_name, options = {})
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            response.status = 204
+
+            version_id = options.delete('versionId')
+
+            if bucket[:versioning]
+              bucket[:objects][object_name] ||= []
+
+              if version_id
+                version = bucket[:objects][object_name].find { |object| object['VersionId'] == version_id}
+
+                # S3 special cases the 'null' value to not error out if no such version exists.
+                if version || (version_id == 'null')
+                  bucket[:objects][object_name].delete(version)
+                  bucket[:objects].delete(object_name) if bucket[:objects][object_name].empty?
+
+                  response.headers['x-amz-delete-marker'] = 'true' if version[:delete_marker]
+                  response.headers['x-amz-version-id'] = version_id
+                else
+                  response.status = 400
+                  response.body = invalid_version_id_payload(version_id)
+                  raise(Excon::Errors.status_error({:expects => 200}, response))
+                end
+              else
+                delete_marker = {
+                  :delete_marker    => true,
+                  'Key'             => object_name,
+                  'VersionId'       => bucket[:versioning] == 'Enabled' ? Fog::Mock.random_base64(32) : 'null',
+                  'Last-Modified'   => Fog::Time.now.to_date_header
+                }
+
+                # When versioning is suspended, a delete marker is placed if the last object ID is not the value 'null',
+                # otherwise the last object is replaced.
+                if bucket[:versioning] == 'Suspended' && bucket[:objects][object_name].first['VersionId'] == 'null'
+                  bucket[:objects][object_name].shift
+                end
+
+                bucket[:objects][object_name].unshift(delete_marker)
+
+                response.headers['x-amz-delete-marker'] = 'true'
+                response.headers['x-amz-version-id'] = delete_marker['VersionId']
+              end
+            else
+              if version_id && version_id != 'null'
+                response.status = 400
+                response.body = invalid_version_id_payload(version_id)
+                raise(Excon::Errors.status_error({:expects => 200}, response))
+              else
+                bucket[:objects].delete(object_name)
+
+                response.headers['x-amz-version-id'] = 'null'
+              end
+            end
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 204}, response))
+          end
+          response
+        end
+
+        private
+
+        def invalid_version_id_payload(version_id)
+          {
+            'Error' => {
+              'Code' => 'InvalidArgument',
+              'Message' => 'Invalid version id specified',
+              'ArgumentValue' => version_id,
+              'ArgumentName' => 'versionId',
+              'RequestId' => Fog::Mock.random_hex(16),
+              'HostId' => Fog::Mock.random_base64(65)
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket.rb

@@ -0,0 +1,108 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        require 'fog/aws/parsers/storage/get_bucket'
+
+        # List information about objects in an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to list object keys from
+        # @param options [Hash] config arguments for list.  Defaults to {}.
+        # @option options delimiter [String] causes keys with the same string between the prefix
+        #     value and the first occurence of delimiter to be rolled up
+        # @option options marker [String] limits object keys to only those that appear
+        #     lexicographically after its value.
+        # @option options max-keys [Integer] limits number of object keys returned
+        # @option options prefix [String] limits object keys to those beginning with its value.
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Delimeter [String] - Delimiter specified for query
+        #     * IsTruncated [Boolean] - Whether or not the listing is truncated
+        #     * Marker [String]- Marker specified for query
+        #     * MaxKeys [Integer] - Maximum number of keys specified for query
+        #     * Name [String] - Name of the bucket
+        #     * Prefix [String] - Prefix specified for query
+        #     * CommonPrefixes [Array] - Array of strings for common prefixes
+        #     * Contents [Array]:
+        #       * ETag [String] - Etag of object
+        #       * Key [String] - Name of object
+        #       * LastModified [String] - Timestamp of last modification of object
+        #       * Owner [Hash]:
+        #         * DisplayName [String] - Display name of object owner
+        #         * ID [String] - Id of object owner
+        #       * Size [Integer] - Size of object
+        #       * StorageClass [String] - Storage class of object
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html
+
+        def get_bucket(bucket_name, options = {})
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :bucket_name => bucket_name,
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::AWS::GetBucket.new,
+            :query    => options
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def get_bucket(bucket_name, options = {})
+          prefix, marker, delimiter, max_keys = \
+            options['prefix'], options['marker'], options['delimiter'], options['max-keys']
+          common_prefixes = []
+
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            contents = bucket[:objects].values.map(&:first).sort {|x,y| x['Key'] <=> y['Key']}.reject do |object|
+                (prefix    && object['Key'][0...prefix.length] != prefix) ||
+                (marker    && object['Key'] <= marker) ||
+                (delimiter && object['Key'][(prefix ? prefix.length : 0)..-1].include?(delimiter) \
+                           && common_prefixes << object['Key'].sub(/^(#{prefix}[^#{delimiter}]+.).*/, '\1')) ||
+                object.key?(:delete_marker)
+              end.map do |object|
+                data = object.reject {|key, value| !['ETag', 'Key', 'StorageClass'].include?(key)}
+                data.merge!({
+                  'LastModified' => Time.parse(object['Last-Modified']),
+                  'Owner'        => bucket['Owner'],
+                  'Size'         => object['Content-Length'].to_i
+                })
+              data
+            end
+            max_keys = max_keys || 1000
+            size = [max_keys, 1000].min
+            truncated_contents = contents[0...size]
+
+            response.status = 200
+            response.body = {
+              'CommonPrefixes'  => common_prefixes.uniq,
+              'Contents'        => truncated_contents,
+              'IsTruncated'     => truncated_contents.size != contents.size,
+              'Marker'          => marker,
+              'MaxKeys'         => max_keys,
+              'Name'            => bucket['Name'],
+              'Prefix'          => prefix
+            }
+            if max_keys && max_keys < response.body['Contents'].length
+                response.body['IsTruncated'] = true
+                response.body['Contents'] = response.body['Contents'][0...max_keys]
+            end
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket_acl.rb

@@ -0,0 +1,65 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        require 'fog/aws/parsers/storage/access_control_list'
+
+        # Get access control list for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get access control list for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * AccessControlPolicy [Hash]:
+        #       * Owner [Hash]:
+        #         * DisplayName [String] - Display name of object owner
+        #         * ID [String] - Id of object owner
+        #       * AccessControlList [Array]:
+        #         * Grant [Hash]:
+        #           * Grantee [Hash]:
+        #             * DisplayName [String] - Display name of grantee
+        #             * ID [String] - Id of grantee
+        #             or
+        #             * URI [String] - URI of group to grant access for
+        #           * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html
+
+        def get_bucket_acl(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :bucket_name => bucket_name,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Storage::AWS::AccessControlList.new,
+            :query      => {'acl' => nil}
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        require 'fog/aws/requests/storage/acl_utils'
+
+        def get_bucket_acl(bucket_name)
+          response = Excon::Response.new
+          if acl = self.data[:acls][:bucket][bucket_name]
+            response.status = 200
+            if acl.is_a?(String)
+              response.body = Fog::Storage::AWS.acl_to_hash(acl)
+            else
+              response.body = acl
+            end
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket_cors.rb

@@ -0,0 +1,61 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        require 'fog/aws/parsers/storage/cors_configuration'
+
+        # Gets the CORS configuration for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get access control list for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * CORSConfiguration [Array]:
+        #       * CORSRule [Hash]:
+        #         * AllowedHeader [String] - Which headers are allowed in a pre-flight OPTIONS request through the Access-Control-Request-Headers header.
+        #         * AllowedMethod [String] - Identifies an HTTP method that the domain/origin specified in the rule is allowed to execute.
+        #         * AllowedOrigin [String] - One or more response headers that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
+        #         * ExposeHeader [String] - 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).
+        #         * ID [String] - An optional 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.
+        #         * MaxAgeSeconds [Integer] - The time in seconds that your browser is to cache the preflight response for the specified resource.
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html
+
+        def get_bucket_cors(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :bucket_name => bucket_name,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Storage::AWS::CorsConfiguration.new,
+            :query      => {'cors' => nil}
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        require 'fog/aws/requests/storage/cors_utils'
+
+        def get_bucket_cors(bucket_name)
+          response = Excon::Response.new
+          if cors = self.data[:cors][:bucket][bucket_name]
+            response.status = 200
+            if cors.is_a?(String)
+              response.body = Fog::Storage::AWS.cors_to_hash(cors)
+            else
+              response.body = cors
+            end
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket_lifecycle.rb

@@ -0,0 +1,35 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        require 'fog/aws/parsers/storage/get_bucket_lifecycle'
+
+        # Get bucket lifecycle configuration
+        #
+        # @param bucket_name [String] name of bucket to get lifecycle configuration for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Rules - object expire rules [Array]:
+        #       * ID [String] - Unique identifier for the rule
+        #       * Prefix [String] - Prefix identifying one or more objects to which the rule applies
+        #       * Enabled [Boolean] - if rule is currently being applied
+        #       * Days [Integer] - lifetime, in days, of the objects that are subject to the rule
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html
+
+        def get_bucket_lifecycle(bucket_name)
+          request({
+                    :expects  => 200,
+                    :headers  => {},
+                    :bucket_name => bucket_name,
+                    :idempotent => true,
+                    :method   => 'GET',
+                    :parser   => Fog::Parsers::Storage::AWS::GetBucketLifecycle.new,
+                    :query    => {'lifecycle' => nil}
+                  })
+        end
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket_location.rb

@@ -0,0 +1,55 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        require 'fog/aws/parsers/storage/get_bucket_location'
+
+        # Get location constraint for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get location constraint for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * LocationConstraint [String] - Location constraint of the bucket
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html
+
+        def get_bucket_location(bucket_name)
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :bucket_name => bucket_name,
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::AWS::GetBucketLocation.new,
+            :query    => {'location' => nil},
+            :path_style => true
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def get_bucket_location(bucket_name)
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            location_constraint = case bucket['LocationConstraint']
+            when 'us-east-1'
+              nil
+            when 'eu-east-1'
+              'EU'
+            else
+              bucket['LocationConstraint']
+            end
+
+            response.status = 200
+            response.body = {'LocationConstraint' => location_constraint }
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/storage/get_bucket_logging.rb

@@ -0,0 +1,45 @@
+module Fog
+  module Storage
+    class AWS
+      class Real
+        require 'fog/aws/parsers/storage/get_bucket_logging'
+
+        # Get logging status for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get logging status for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * BucketLoggingStatus (will be empty if logging is disabled) [Hash]:
+        #       * LoggingEnabled [Hash]:
+        #         * TargetBucket [String] - bucket where logs are stored
+        #         * TargetPrefix [String] - prefix logs are stored with
+        #         * TargetGrants [Array]:
+        #           * Grant [Hash]:
+        #             * Grantee [Hash]:
+        #               * DisplayName [String] - Display name of grantee
+        #               * ID [String] - Id of grantee
+        #               or
+        #               * URI [String] - URI of group to grant access for
+        #             * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html
+
+        def get_bucket_logging(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :bucket_name => bucket_name,
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Storage::AWS::GetBucketLogging.new,
+            :query      => {'logging' => nil}
+          })
+        end
+      end
+    end
+  end
+end