fog 1.9.0 → 1.10.0

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

@@ -0,0 +1,44 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/initiate_multipart_upload'
+
+        # Initiate a multipart upload to an S3 bucket
+        #
+        # @param bucket_name [String] Name of bucket to create object in
+        # @param object_name [String] Name of object to create
+        # @param options [Hash]: 
+        # @option options [String] Cache-Control Caching behaviour
+        # @option options [String] Content-Disposition Presentational information for the object
+        # @option options [String] Content-Encoding Encoding of object data
+        # @option options [String] Content-MD5 Base64 encoded 128-bit MD5 digest of message (defaults to Base64 encoded MD5 of object.read)
+        # @option options [String] Content-Type Standard MIME type describing contents (defaults to MIME::Types.of.first)
+        # @option options [String] x-amz-acl Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        # @option options [String] x-amz-meta-#{name} Headers to be returned with object, note total size of request without body must be less than 8 KB.
+        #
+        # @return [Excon::Response] response: 
+        #   * body [Hash]: 
+        #     * Bucket [String] - Bucket where upload was initiated
+        #     * Key [String] - Object key where the upload was initiated
+        #     * UploadId [String] - Id for initiated multipart upload
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html
+        #
+        def initiate_multipart_upload(bucket_name, object_name, options = {})
+          request({
+            :expects    => 200,
+            :headers    => options,
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'POST',
+            :parser     => Fog::Parsers::Storage::InternetArchive::InitiateMultipartUpload.new,
+            :path       => CGI.escape(object_name),
+            :query      => {'uploads' => nil}
+          })
+        end
+
+      end # Real
+    end # Storage
+  end # InternetArchive
+end # Fog

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

@@ -0,0 +1,55 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/list_multipart_uploads'
+
+        # List multipart uploads for a bucket
+        #
+        # @param bucket_name [String] Name of bucket to list multipart uploads for
+        # @param upload_id [String] upload id to list objects for
+        # @param options [Hash] config arguments for list.  Defaults to {}.
+        # @option options key-marker[String] limits parts to only those that appear lexicographically after this key.
+        # @option options max-uploads [Integer] limits number of uploads returned
+        # @option options upload-id-marker [String] limits uploads to only those that appear lexicographically after this upload id.
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Bucket [string] Bucket where the multipart upload was initiated
+        #     * IsTruncated [Boolean] Whether or not the listing is truncated
+        #     * KeyMarker [String] first key in list, only upload ids after this lexographically will appear
+        #     * MaxUploads [Integer] Maximum results to return
+        #     * NextKeyMarker [String] last key in list, for further pagination
+        #     * NextUploadIdMarker [String] last key in list, for further pagination
+        #     * Upload [Hash]:
+        #       * Initiated [Time] Time when upload was initiated
+        #       * Initiator [Hash]:
+        #         * DisplayName [String] Display name of upload initiator
+        #         * ID [String] Id of upload initiator
+        #       * Key [String] Key where multipart upload was initiated
+        #       * Owner [Hash]:
+        #         * DisplayName [String] Display name of upload owner
+        #         * ID [String] Id of upload owner
+        #       * StorageClass [String] Storage class of object
+        #       * UploadId [String] upload id of upload containing part
+        #     * UploadIdMarker [String] first key in list, only upload ids after this lexographically will appear
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html
+        #
+        def list_multipart_uploads(bucket_name, options = {})
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::InternetArchive::ListMultipartUploads.new,
+            :query    => options.merge!({'uploads' => nil})
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/list_parts'
+
+        # List parts for a multipart upload
+        #
+        # @param bucket_name [String] Name of bucket to list parts for
+        # @param object_name [String] Name of object to list parts for
+        # @param upload_id [String] upload id to list objects for
+        # @param options [Hash] config arguments for list.  Defaults to {}.
+        # @option options max-parts [Integer] limits number of parts returned
+        # @option options part-number-marker [String] limits parts to only those that appear lexicographically after this part number.
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Bucket [string] Bucket where the multipart upload was initiated
+        #     * Initiator [Hash]:
+        #       * DisplayName [String] Display name of upload initiator
+        #       * ID [String] Id of upload initiator
+        #     * IsTruncated [Boolean] Whether or not the listing is truncated
+        #     * Key [String] Key where multipart upload was initiated
+        #     * MaxParts [String] maximum number of replies alllowed in response
+        #     * NextPartNumberMarker [String] last item in list, for further pagination
+        #     * Part [Array]:
+        #       * ETag [String] ETag of part
+        #       * LastModified [Timestamp] Last modified for part
+        #       * PartNumber [String] Part number for part
+        #       * Size [Integer] Size of part
+        #     * PartNumberMarker [String] Part number after which listing begins
+        #     * StorageClass [String] Storage class of object
+        #     * UploadId [String] upload id of upload containing part
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html
+        #
+        def list_parts(bucket_name, object_name, upload_id, options = {})
+          options['uploadId'] = upload_id
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::InternetArchive::ListParts.new,
+            :path     => CGI.escape(object_name),
+            :query    => options.merge!({'uploadId' => upload_id})
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Get a hash of hidden fields for form uploading to S3, in the form {:field_name => :field_value}
+        # Form should look like: <form action="http://#{bucket_name}.s3.#{Fog::InternetArchive::DOMAIN_NAME}/" method="post" enctype="multipart/form-data">
+        # These hidden fields should then appear, followed by a field named 'file' which is either a textarea or file input.
+        #
+        # @param options Hash:
+        # @option options acl [String] access control list, in ['private', 'public-read', 'public-read-write', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control']
+        # @option options Cache-Control [String] same as REST header
+        # @option options Content-Type [String] same as REST header
+        # @option options Content-Disposition [String] same as REST header
+        # @option options Content-Encoding [String] same as REST header
+        # @option options Expires same as REST header
+        # @option options key key for object, set to '${filename}' to use filename provided by user
+        # @option options policy security policy for upload
+        # @option options success_action_redirect url to redirct to upon success
+        # @option options success_action_status status code to return on success, in [200, 201, 204]
+        # @option options x-amz-security token devpay security token
+        # @option options x-amz-meta... meta data tags
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/HTTPPOSTForms.html
+        # 
+        def post_object_hidden_fields(options = {})
+          if options['policy']
+            options['policy'] = Base64.encode64(Fog::JSON.encode(options['policy'])).gsub("\n", "")
+            options['AWSAccessKeyId'] = @ia_access_key_id
+            options['Signature'] = Base64.encode64(@hmac.sign(options['policy'])).gsub("\n", "")
+          end
+          options
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Create an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to create
+        # @option options [Hash] config arguments for bucket.  Defaults to {}.
+        # @option options LocationConstraint [Symbol] sets the location for the bucket
+        # @option options x-amz-acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        #
+        # @return [Excon::Response] response:
+        #   * status [Integer] 200
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html
+        # 
+        def put_bucket(bucket_name, options = {})
+          if location_constraint = options.delete('LocationConstraint')
+            data =
+<<-DATA
+  <CreateBucketConfiguration>
+    <LocationConstraint>#{location_constraint}</LocationConstraint>
+  </CreateBucketConfiguration>
+DATA
+          else
+            data = nil
+          end
+          request({
+            :expects    => 200,
+            :body       => data,
+            :headers    => options,
+            :idempotent => true,
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'PUT'
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def put_bucket(bucket_name, options = {})
+          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][:bucket][bucket_name] = self.class.acls(acl)
+          end
+
+          response = Excon::Response.new
+          response.status = 200
+          bucket = {
+            :objects        => {},
+            'Name'          => bucket_name,
+            'CreationDate'  => Time.now,
+            'Owner'         => { 'DisplayName' => 'owner', 'ID' => 'some_id'},
+            'Payer'         => 'BucketOwner'
+          }
+          if options['LocationConstraint']
+            bucket['LocationConstraint'] = options['LocationConstraint']
+          else
+            bucket['LocationConstraint'] = nil
+          end
+          unless self.data[:buckets][bucket_name]
+            self.data[:buckets][bucket_name] = bucket
+          end
+          response
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/requests/storage/acl_utils'
+
+        # Change access control list for an S3 bucket
+        # 
+        # @param bucket_name [String] name of bucket to modify
+        # @param acl [Hash]
+        #   * Owner [Hash]:
+        #     * ID [String]: id of owner
+        #     * DisplayName [String]: display name of owner
+        #   * AccessControlList [Array]:
+        #     * Grantee [Hash]:
+        #       * DisplayName [String] Display name of grantee
+        #       * ID [String] Id of grantee
+        #       or
+        #       * EmailAddress [String] Email address of grantee
+        #       or
+        #       * URI [String] URI of group to grant access for
+        #     * Permission [String] Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        # * acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html
+
+        def put_bucket_acl(bucket_name, acl)
+          data = ""
+          headers = {}
+          
+          if acl.is_a?(Hash)
+            data = Fog::Storage::InternetArchive.hash_to_acl(acl)
+          else
+            if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+              raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+            end
+            headers['x-amz-acl'] = acl
+          end
+
+          headers['Content-MD5'] = Base64.encode64(Digest::MD5.digest(data)).strip
+          headers['Content-Type'] = 'application/json'
+          headers['Date'] = Fog::Time.now.to_date_header
+
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => headers,
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'acl' => nil}
+          })
+        end
+      end
+        
+      class Mock
+        def put_bucket_acl(bucket_name, acl)
+          if acl.is_a?(Hash)
+            self.data[:acls][:bucket][bucket_name] = Fog::Storage::InternetArchive.hash_to_acl(acl)
+          else
+            if !['private', 'public-read', 'public-read-write', 'authenticated-read'].include?(acl)
+              raise Excon::Errors::BadRequest.new('invalid x-amz-acl')
+            end
+            self.data[:acls][:bucket][bucket_name] = acl
+          end        
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/requests/storage/cors_utils'
+
+        # Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param cors [Hash]
+        #   * CORSConfiguration [Array]:
+        #     * ID [String]: A unique identifier for the rule.
+        #     * AllowedMethod [String]: An HTTP method that you want to allow the origin to execute.
+        #     * AllowedOrigin [String]: An origin that you want to allow cross-domain requests from.
+        #     * AllowedHeader [String]: Specifies which headers are allowed in a pre-flight OPTIONS request via the Access-Control-Request-Headers header.
+        #     * MaxAgeSeconds [String]: The time in seconds that your browser is to cache the preflight response for the specified resource.
+        #     * ExposeHeader [String]: One or more headers in the response that you want customers to be able to access from their applications.
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html
+
+        def put_bucket_cors(bucket_name, cors)
+          data = Fog::Storage::InternetArchive.hash_to_cors(cors)
+
+          headers = {}
+          headers['Content-MD5'] = Base64.encode64(Digest::MD5.digest(data)).strip
+          headers['Content-Type'] = 'application/json'
+          headers['Date'] = Fog::Time.now.to_date_header
+
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => headers,
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'cors' => nil}
+          })
+        end
+      end
+
+      class Mock
+        def put_bucket_cors(bucket_name, cors)
+          self.data[:cors][:bucket][bucket_name] = Fog::Storage::InternetArchive.hash_to_cors(cors)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Change lifecycle configuration for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to set lifecycle configuration for
+        # * lifecycle [Hash]:
+        #   * Rules [Array] object expire rules
+        #     * 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
+        #     * Expiration [Hash] Container for the object expiration rule. 
+        #       * Days [Integer] lifetime, in days, of the objects that are subject to the rule
+        #       * Date [Date] Indicates when the specific rule take effect.
+        #         The date value must conform to the ISO 8601 format. The time is always midnight UTC. 
+        #     * Transition [Hash] Container for the transition rule that describes when objects transition 
+        #       to the Glacier storage class
+        #       * Days [Integer] lifetime, in days, of the objects that are subject to the rule
+        #       * Date [Date] Indicates when the specific rule take effect.
+        #         The date value must conform to the ISO 8601 format. The time is always midnight UTC. 
+        #       * StorageClass [String] Indicates the Amazon S3 storage class to which you want the object
+        #         to transition to. 
+        #
+        # 
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html
+        # 
+        def put_bucket_lifecycle(bucket_name, lifecycle)
+          builder = Nokogiri::XML::Builder.new do
+            LifecycleConfiguration {
+              lifecycle['Rules'].each do |rule|
+                Rule {
+                  ID rule['ID']
+                  Prefix rule['Prefix'] 
+                  Status rule['Enabled'] ? 'Enabled' : 'Disabled'
+                  unless (rule['Expiration'] or rule['Transition'])
+                    Expiration { Days rule['Days'] }
+                  else
+                    if rule['Expiration']
+                      if rule['Expiration']['Days']
+                        Expiration { Days rule['Expiration']['Days'] }
+                      elsif rule['Expiration']['Date']
+                        Expiration { Date rule['Expiration']['Date'].is_a?(Time) ? rule['Expiration']['Date'].utc.iso8601 : Time.parse(rule['Expiration']['Date']).utc.iso8601 }
+                      end
+                    end
+                    if rule['Transition']
+                      Transition {
+                        if rule['Transition']['Days']
+                          Days rule['Transition']['Days']
+                        elsif rule['Transition']['Date']
+                          Date rule['Transition']['Date'].is_a?(Time) ? time.utc.iso8601 : Time.parse(time).utc.iso8601
+                        end
+                        StorageClass rule['Transition']['StorageClass'].nil? ? 'GLACIER' : rule['Transition']['StorageClass']
+                      }
+                    end
+                  end
+                }
+              end
+            }
+          end
+          body = builder.to_xml
+          body.gsub! /<([^<>]+)\/>/, '<\1></\1>'
+          request({
+                    :body     => body,
+                    :expects  => 200,
+                    :headers  => {'Content-MD5' => Base64.encode64(Digest::MD5.digest(body)).chomp!,
+                      'Content-Type' => 'application/xml'},
+                    :host     => "#{bucket_name}.#{@host}",
+                    :method   => 'PUT',
+                    :query    => {'lifecycle' => nil}
+                  })
+        end
+      end
+    end
+  end
+end