fog 1.9.0 → 1.10.0

data/lib/fog/internet_archive/requests/storage/abort_multipart_upload.rb

@@ -0,0 +1,28 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        # 
+        # Abort a multipart upload
+        #
+        # @param [String] bucket_name Name of bucket to abort multipart upload on
+        # @param [String] object_name Name of object to abort multipart upload on
+        # @param [String] upload_id Id of upload to add part to
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html
+        #
+        def abort_multipart_upload(bucket_name, object_name, upload_id)
+          request({
+            :expects    => 204,
+            :headers    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'DELETE',
+            :path       => CGI.escape(object_name),
+            :query      => {'uploadId' => upload_id}
+          })
+        end
+
+      end # Real
+    end # Storage
+  end # InternetArchive
+end # Fog

data/lib/fog/internet_archive/requests/storage/acl_utils.rb

@@ -0,0 +1,62 @@
+module Fog
+  module Storage
+    class InternetArchive
+
+      require 'fog/internet_archive/parsers/storage/access_control_list'
+
+      private
+        def self.hash_to_acl(acl)
+          data =  "<AccessControlPolicy>\n"
+
+          if acl['Owner'] && (acl['Owner']['ID'] || acl['Owner']['DisplayName'])
+            data << "  <Owner>\n"
+            data << "    <ID>#{acl['Owner']['ID']}</ID>\n" if acl['Owner']['ID']
+            data << "    <DisplayName>#{acl['Owner']['DisplayName']}</DisplayName>\n" if acl['Owner']['DisplayName']
+            data << "  </Owner>\n"
+          end
+
+          grants = [acl['AccessControlList']].flatten.compact
+
+          data << "  <AccessControlList>\n" if grants.any?
+          grants.each do |grant|
+            data << "    <Grant>\n"
+            grantee = grant['Grantee']
+            type = case
+            when grantee.has_key?('ID')
+              'CanonicalUser'
+            when grantee.has_key?('EmailAddress')
+              'AmazonCustomerByEmail'
+            when grantee.has_key?('URI')
+              'Group'
+            end
+
+            data << "      <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"#{type}\">\n"
+            case type
+            when 'CanonicalUser'
+              data << "        <ID>#{grantee['ID']}</ID>\n" if grantee['ID']
+              data << "        <DisplayName>#{grantee['DisplayName']}</DisplayName>\n" if grantee['DisplayName']
+            when 'AmazonCustomerByEmail'
+              data << "        <EmailAddress>#{grantee['EmailAddress']}</EmailAddress>\n" if grantee['EmailAddress']
+            when 'Group'
+              data << "        <URI>#{grantee['URI']}</URI>\n" if grantee['URI']
+            end
+            data << "      </Grantee>\n"
+            data << "      <Permission>#{grant['Permission']}</Permission>\n"
+            data << "    </Grant>\n"
+          end
+          data << "  </AccessControlList>\n" if grants.any?
+
+          data << "</AccessControlPolicy>"
+
+          data
+        end
+
+        def self.acl_to_hash(acl_xml)
+          parser = Fog::Parsers::Storage::InternetArchive::AccessControlList.new
+          Nokogiri::XML::SAX::Parser.new(parser).parse(acl_xml)
+          parser.response
+        end
+
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/complete_multipart_upload.rb

@@ -0,0 +1,48 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/complete_multipart_upload'
+
+        # Complete a multipart upload
+        #
+        # @param [String] bucket_name Name of bucket to complete multipart upload for
+        # @param [String] object_name Name of object to complete multipart upload for
+        # @param [String] upload_id Id of upload to add part to
+        # @param [Array<String>] parts Array of etags as Strings for parts
+        #
+        # @return [Excon::Response]
+        #   * headers [Hash]:
+        #     * Bucket [String] - bucket of new object
+        #     * ETag [String] - etag of new object (will be needed to complete upload)
+        #     * Key [String] - key of new object
+        #     * Location [String] - location of new object
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html
+        #
+        def complete_multipart_upload(bucket_name, object_name, upload_id, parts)
+          data = "<CompleteMultipartUpload>"
+          parts.each_with_index do |part, index|
+            data << "<Part>"
+            data << "<PartNumber>#{index + 1}</PartNumber>"
+            data << "<ETag>#{part}</ETag>"
+            data << "</Part>"
+          end
+          data << "</CompleteMultipartUpload>"
+          request({
+            :body       => data,
+            :expects    => 200,
+            :headers    => { 'Content-Length' => data.length },
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'POST',
+            :parser     => Fog::Parsers::Storage::InternetArchive::CompleteMultipartUpload.new,
+            :path       => CGI.escape(object_name),
+            :query      => {'uploadId' => upload_id}
+          })
+        end
+
+      end # Real
+    end # Storage
+  end # InternetArchive
+end # Fog

data/lib/fog/internet_archive/requests/storage/copy_object.rb

@@ -0,0 +1,81 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/copy_object'
+
+        # Copy an object from one S3 bucket to another
+        #
+        # @param source_bucket_name [String] Name of source bucket
+        # @param source_object_name [String] Name of source object
+        # @param target_bucket_name [String] Name of bucket to create copy in
+        # @param target_object_name [String] Name for new copy of object
+        # 
+        # @param options [Hash]:
+        # @option options [String] x-amz-metadata-directive Specifies whether to copy metadata from source or replace with data in request.  Must be in ['COPY', 'REPLACE']
+        # @option options [String] x-amz-copy_source-if-match Copies object if its etag matches this value
+        # @option options [Time] x-amz-copy_source-if-modified_since Copies object it it has been modified since this time
+        # @option options [String] x-amz-copy_source-if-none-match Copies object if its etag does not match this value
+        # @option options [Time] x-amz-copy_source-if-unmodified-since Copies object it it has not been modified since this time
+        # @option options [String] x-amz-storage-class Default is 'STANDARD', set to 'REDUCED_REDUNDANCY' for non-critical, reproducable data
+        #
+        # 
+        # @return [Excon::Response]
+        #   * body [Hash]:
+        #     * ETag [String] - etag of new object
+        #     * LastModified [Time] - date object was last modified
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html
+        # 
+        def copy_object(source_bucket_name, source_object_name, target_bucket_name, target_object_name, options = {})
+          headers = { 'x-amz-copy-source' => "/#{source_bucket_name}/#{CGI.escape(source_object_name)}" }.merge!(options)
+          request({
+            :expects  => 200,
+            :headers  => headers,
+            :host     => "#{target_bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :parser   => Fog::Parsers::Storage::InternetArchive::CopyObject.new,
+            :path     => CGI.escape(target_object_name)
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def copy_object(source_bucket_name, source_object_name, target_bucket_name, target_object_name, options = {})
+          response = Excon::Response.new
+          source_bucket = self.data[:buckets][source_bucket_name]
+          source_object = source_bucket && source_bucket[:objects][source_object_name] && source_bucket[:objects][source_object_name].first
+          target_bucket = self.data[:buckets][target_bucket_name]
+
+          acl = options['x-amz-acl'] || 'private'
+          if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+            raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+          else
+            self.data[:acls][:object][target_bucket_name] ||= {}
+            self.data[:acls][:object][target_bucket_name][target_object_name] = self.class.acls(acl)
+          end
+
+          if source_object && target_bucket
+            response.status = 200
+            target_object = source_object.dup
+            target_object.merge!({'Key' => target_object_name})
+            target_bucket[:objects][target_object_name] = [target_object]
+            response.body = {
+              'ETag'          => target_object['ETag'],
+              'LastModified'  => Time.parse(target_object['Last-Modified'])
+            }
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+
+          response
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/cors_utils.rb

@@ -0,0 +1,41 @@
+module Fog
+  module Storage
+    class InternetArchive
+
+      require 'fog/internet_archive/parsers/storage/cors_configuration'
+
+      private
+
+        def self.hash_to_cors(cors)
+          data =  "<CORSConfiguration>\n"
+
+          [cors['CORSConfiguration']].flatten.compact.each do |rule|
+            data << "  <CORSRule>\n"
+
+            ['ID', 'MaxAgeSeconds'].each do |key|
+              data << "    <#{key}>#{rule[key]}</#{key}>\n" if rule[key]
+            end
+
+            ['AllowedOrigin', 'AllowedMethod', 'AllowedHeader', 'ExposeHeader'].each do |key|
+              [rule[key]].flatten.compact.each do |value|
+                data << "    <#{key}>#{value}</#{key}>\n"
+              end
+            end
+
+            data << "  </CORSRule>\n"
+          end
+
+          data << "</CORSConfiguration>"
+
+          data
+        end
+
+        def self.cors_to_hash(cors_xml)
+          parser = Fog::Parsers::Storage::InternetArchive::CorsConfiguration.new
+          Nokogiri::XML::SAX::Parser.new(parser).parse(cors_xml)
+          parser.response
+        end
+
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/delete_bucket.rb

@@ -0,0 +1,47 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Delete an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to delete
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html
+
+        def delete_bucket(bucket_name)
+          request({
+            :expects  => 204,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'DELETE'
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def delete_bucket(bucket_name)
+          response = Excon::Response.new
+          if self.data[:buckets][bucket_name].nil?
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 204}, response))
+          elsif self.data[:buckets][bucket_name] && !self.data[:buckets][bucket_name][:objects].empty?
+            response.status = 409
+            raise(Excon::Errors.status_error({:expects => 204}, response))
+          else
+            self.data[:buckets].delete(bucket_name)
+            response.status = 204
+          end
+          response
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/delete_bucket_cors.rb

@@ -0,0 +1,29 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Deletes the cors configuration information set for the bucket.
+        #
+        # @param bucket_name [String] name of bucket to delete cors rules from
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html
+
+        def delete_bucket_cors(bucket_name)
+          request({
+            :expects  => 204,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'DELETE',
+            :query    => {'cors' => nil}
+          })
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/delete_bucket_lifecycle.rb

@@ -0,0 +1,27 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Delete lifecycle configuration for a bucket
+        #
+        # @param bucket_name [String] name of bucket to delete lifecycle configuration from
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html
+
+        def delete_bucket_lifecycle(bucket_name)
+          request({
+                    :expects  => 204,
+                    :headers  => {},
+                    :host     => "#{bucket_name}.#{@host}",
+                    :method   => 'DELETE',
+                    :query    => {'lifecycle' => nil}
+                  })
+        end
+      end
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/delete_bucket_policy.rb

@@ -0,0 +1,29 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Delete policy for a bucket
+        #
+        # @param bucket_name [String] name of bucket to delete policy from
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
+        # 
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html
+
+        def delete_bucket_policy(bucket_name)
+          request({
+            :expects  => 204,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'DELETE',
+            :query    => {'policy' => nil}
+          })
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/delete_bucket_website.rb

@@ -0,0 +1,29 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Delete website configuration for a bucket
+        #
+        # @param bucket_name [String] name of bucket to delete website configuration from
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] - 204
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html
+
+        def delete_bucket_website(bucket_name)
+          request({
+            :expects  => 204,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'DELETE',
+            :query    => {'website' => nil}
+          })
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/internet_archive/requests/storage/delete_multiple_objects.rb

@@ -0,0 +1,167 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/delete_multiple_objects'
+
+        # Delete multiple objects from S3
+        # @note For versioned deletes, options should include a version_ids hash, which
+        #     maps from filename to an array of versions.
+        #     The semantics are that for each (object_name, version) tuple, the
+        #     caller must insert the object_name and an associated version (if
+        #     desired), so for n versions, the object must be inserted n times.
+        #
+        # @param bucket_name [String] Name of bucket containing object to delete
+        # @param object_names [Array]  Array of object names to delete
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * DeleteResult [Array]:
+        #       * Deleted [Hash]:
+        #         * Key [String] - Name of the object that was deleted
+        #         * VersionId [String] - ID for the versioned onject in case of a versioned delete
+        #         * DeleteMarker [Boolean] - Indicates if the request accessed a delete marker
+        #         * DeleteMarkerVersionId [String] - Version ID of the delete marker accessed
+        #       * Error [Hash]:
+        #         * Key [String] - Name of the object that failed to be deleted
+        #         * VersionId [String] - ID of the versioned object that was attempted to be deleted
+        #         * Code [String] - Status code for the result of the failed delete
+        #         * Message [String] - Error description
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html
+        
+        def delete_multiple_objects(bucket_name, object_names, options = {})
+          data = "<Delete>"
+          data << "<Quiet>true</Quiet>" if options.delete(:quiet)
+          version_ids = options.delete('versionId')
+          object_names.each do |object_name|
+            data << "<Object>"
+            data << "<Key>#{CGI.escapeHTML(object_name)}</Key>"
+            object_version = version_ids.nil? ? nil : version_ids[object_name]
+            if object_version
+              data << "<VersionId>#{CGI.escapeHTML(object_version)}</VersionId>"
+            end
+            data << "</Object>"
+          end
+          data << "</Delete>"
+
+          headers = options
+          headers['Content-Length'] = data.length
+          headers['Content-MD5'] = Base64.encode64(Digest::MD5.digest(data)).
+                                   gsub("\n", '')
+
+          request({
+            :body       => data,
+            :expects    => 200,
+            :headers    => headers,
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'POST',
+            :parser     => Fog::Parsers::Storage::InternetArchive::DeleteMultipleObjects.new,
+            :query      => {'delete' => nil}
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def delete_multiple_objects(bucket_name, object_names, options = {})
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            response.status = 200
+            response.body = { 'DeleteResult' => [] }
+            version_ids = options.delete('versionId')
+            object_names.each do |object_name|
+              object_version = version_ids.nil? ? nil : version_ids[object_name]
+              response.body['DeleteResult'] << delete_object_helper(bucket,
+                                                                object_name,
+                                                                object_version)
+            end
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+
+        private
+
+        def delete_object_helper(bucket, object_name, version_id)
+          response = { 'Deleted' => {} }
+          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['Deleted'] = { 'Key' => object_name,
+                                        'VersionId' => version_id,
+                                        'DeleteMarker' => 'true',
+                                        'DeleteMarkerVersionId' => version_id
+                                      }
+              else
+                response = delete_error_body(object_name,
+                                             version_id,
+                                             'InvalidVersion',
+                                             'Invalid version ID specified')
+              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['Deleted'] = { 'Key' => object_name,
+                                      'VersionId' => delete_marker['VersionId'],
+                                      'DeleteMarkerVersionId' =>
+                                          delete_marker['VersionId'],
+                                      'DeleteMarker' => 'true',
+                                    }
+            end
+          else
+            if version_id && version_id != 'null'
+              response = delete_error_body(object_name,
+                                           version_id,
+                                           'InvalidVersion',
+                                           'Invalid version ID specified')
+              response = invalid_version_id_payload(version_id)
+            else
+              bucket[:objects].delete(object_name)
+              response['Deleted'] = { 'Key' => object_name }
+            end
+          end
+          response
+        end
+
+        def delete_error_body(key, version_id, message, code)
+          {
+            'Error' => {
+              'Code'      => code,
+              'Message'   => message,
+              'VersionId' => version_id,
+              'Key'       => key,
+            }
+          }
+        end
+
+      end
+    end
+  end
+end
+