fog 1.9.0 → 1.10.0

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

@@ -0,0 +1,81 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Change logging status for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param logging_status [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]
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html
+
+        def put_bucket_logging(bucket_name, logging_status)
+          if logging_status['LoggingEnabled'].empty?
+            data =
+<<-DATA
+<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
+DATA
+          else
+            data =
+<<-DATA
+<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01">
+  <LoggingEnabled>
+    <TargetBucket>#{logging_status['LoggingEnabled']['TargetBucket']}</TargetBucket>
+    <TargetPrefix>#{logging_status['LoggingEnabled']['TargetBucket']}</TargetPrefix>
+    <TargetGrants>
+DATA
+
+            acl['AccessControlList'].each do |grant|
+              data << "      <Grant>"
+              type = case grant['Grantee'].keys.sort
+              when ['DisplayName', 'ID']
+                'CanonicalUser'
+              when ['EmailAddress']
+                'AmazonCustomerByEmail'
+              when ['URI']
+                'Group'
+              end
+              data << "        <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"#{type}\">"
+              for key, value in grant['Grantee']
+                data << "          <#{key}>#{value}</#{key}>"
+              end
+              data << "        </Grantee>"
+              data << "        <Permission>#{grant['Permission']}</Permission>"
+              data << "      </Grant>"
+            end
+
+            data <<
+<<-DATA
+    </TargetGrants>
+  </LoggingEnabled>
+</BucketLoggingStatus>
+DATA
+          end
+
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'logging' => nil}
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Change bucket policy for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param policy [Hash] policy document
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html
+
+        def put_bucket_policy(bucket_name, policy)
+          request({
+            :body     => Fog::JSON.encode(policy),
+            :expects  => 204,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'policy' => nil}
+          })
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,75 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Change versioning status for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param status [String] Status to change to in ['Enabled', 'Suspended']
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html
+
+        def put_bucket_versioning(bucket_name, status)
+          data =
+<<-DATA
+<VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+  <Status>#{status}</Status>
+</VersioningConfiguration>
+DATA
+
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'versioning' => nil}
+          })
+        end
+      end
+
+      class Mock
+        def put_bucket_versioning(bucket_name, status)
+          response = Excon::Response.new
+          bucket = self.data[:buckets][bucket_name]
+
+          if bucket
+            if ['Enabled', 'Suspended'].include?(status)
+              bucket[:versioning] = status
+
+              response.status = 200
+            else
+              response.status = 400
+              response.body = {
+                'Error' => {
+                  'Code' => 'MalformedXML',
+                  'Message' => 'The XML you provided was not well-formed or did not validate against our published schema',
+                  'RequestId' => Fog::Mock.random_hex(16),
+                  'HostId' => Fog::Mock.random_base64(65)
+                }
+              }
+
+              raise(Excon::Errors.status_error({:expects => 200}, response))
+            end
+          else
+            response.status = 404
+            response.body = {
+              'Error' => {
+                'Code' => 'NoSuchBucket',
+                'Message' => 'The specified bucket does not exist',
+                'BucketName' => bucket_name,
+                'RequestId' => Fog::Mock.random_hex(16),
+                'HostId' => Fog::Mock.random_base64(65)
+              }
+            }
+
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Change website configuration for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param suffix [String] suffix to append to requests for the bucket
+        # @param options [Hash]
+        # @option options key [String] key to use for 4XX class errors
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html
+
+        def put_bucket_website(bucket_name, suffix, options = {})
+          data =
+<<-DATA
+<WebsiteConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+    <IndexDocument>
+        <Suffix>#{suffix}</Suffix>
+    </IndexDocument>
+DATA
+
+          if options[:key]
+            data <<
+<<-DATA
+<ErrorDocument>
+    <Key>#{options[:key]}</Key>
+</ErrorDocument>
+DATA
+          end
+
+          data << '</WebsiteConfiguration>'
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'website' => nil}
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def put_bucket_website(bucket_name, suffix, options = {})
+          response = Excon::Response.new
+          if self.data[:buckets][bucket_name]
+            response.status = 200
+          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/put_object.rb

@@ -0,0 +1,113 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Create an object in an S3 bucket
+        #
+        # @param bucket_name [String] Name of bucket to create object in
+        # @param object_name [String] Name of object to create
+        # @param data [File||String] File or String to create object from
+        # @param options [Hash]
+        # @option options Cache-Control [String] Caching behaviour
+        # @option options Content-Disposition [String] Presentational information for the object
+        # @option options Content-Encoding [String] Encoding of object data
+        # @option options Content-Length [String] Size of object in bytes (defaults to object.read.length)
+        # @option options Content-MD5 [String] Base64 encoded 128-bit MD5 digest of message
+        # @option options Content-Type [String] Standard MIME type describing contents (defaults to MIME::Types.of.first)
+        # @option options Expires [String] Cache expiry
+        # @option options x-amz-acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        # @option options x-amz-storage-class [String] Default is 'STANDARD', set to 'REDUCED_REDUNDANCY' for non-critical, reproducable data
+        # @option options 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:
+        #   * headers [Hash]:
+        #     * ETag [String] etag of new object
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html
+        
+        def put_object(bucket_name, object_name, data, options = {})
+          data = Fog::Storage.parse_data(data)
+          headers = data[:headers].merge!(options)
+          request({
+            :body       => data[:body],
+            :expects    => 200,
+            :headers    => headers,
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'PUT',
+            :path       => CGI.escape(object_name)
+          })
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def put_object(bucket_name, object_name, data, 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][:object][bucket_name] ||= {}
+            self.data[:acls][:object][bucket_name][object_name] = self.class.acls(acl)
+          end
+
+          data = Fog::Storage.parse_data(data)
+          unless data[:body].is_a?(String)
+            data[:body] = data[:body].read
+          end
+          response = Excon::Response.new
+          if (bucket = self.data[:buckets][bucket_name])
+            response.status = 200
+            object = {
+              :body             => data[:body],
+              'Content-Type'    => options['Content-Type'] || data[:headers]['Content-Type'],
+              'ETag'            => Digest::MD5.hexdigest(data[:body]),
+              'Key'             => object_name,
+              'Last-Modified'   => Fog::Time.now.to_date_header,
+              'Content-Length'  => options['Content-Length'] || data[:headers]['Content-Length'],
+              'StorageClass'    => options['x-amz-storage-class'] || 'STANDARD',
+              'VersionId'       => bucket[:versioning] == 'Enabled' ? Fog::Mock.random_base64(32) : 'null'
+            }
+
+            for key, value in options
+              case key
+              when 'Cache-Control', 'Content-Disposition', 'Content-Encoding', 'Content-MD5', 'Expires', /^x-amz-meta-/
+                object[key] = value
+              end
+            end
+
+            if bucket[:versioning]
+              bucket[:objects][object_name] ||= []
+
+              # When versioning is suspended, putting an object will create a new 'null' version if the latest version
+              # is a value other than 'null', otherwise it will replace the latest version.
+              if bucket[:versioning] == 'Suspended' && bucket[:objects][object_name].first['VersionId'] == 'null'
+                bucket[:objects][object_name].shift
+              end
+
+              bucket[:objects][object_name].unshift(object)
+            else
+              bucket[:objects][object_name] = [object]
+            end
+
+            response.headers = {
+              'Content-Length'   => object['Content-Length'],
+              'Content-Type'     => object['Content-Type'],
+              'ETag'             => object['ETag'],
+              'Last-Modified'    => object['Last-Modified'],
+            }
+
+            response.headers['x-amz-version-id'] = object['VersionId'] if object['VersionId'] != 'null'
+          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/put_object_acl.rb

@@ -0,0 +1,80 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/requests/storage/acl_utils'
+
+        # Change access control list for an S3 object
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param object_name [String] name of object to get access control list for
+        # @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]
+        # @param acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        # @param options [Hash]
+        # @option options versionId [String] specify a particular version to retrieve
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html
+
+        def put_object_acl(bucket_name, object_name, acl, options = {})
+          query = {'acl' => nil}
+          if version_id = options.delete('versionId')
+            query['versionId'] = version_id
+          end
+          
+          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',
+            :path       => CGI.escape(object_name),
+            :query    => query
+          })
+        end
+      end
+      
+      class Mock
+        def put_object_acl(bucket_name, object_name, acl, options = {})
+          if acl.is_a?(Hash)
+            self.data[:acls][:object][bucket_name][object_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][:object][bucket_name][object_name] = acl
+          end        
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Fog
+  module Storage
+    class InternetArchive
+      module PutObjectUrl
+
+        def put_object_url(bucket_name, object_name, expires, headers = {}, options = {})
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          unless object_name
+            raise ArgumentError.new('object_name is required')
+          end
+          scheme_host_path_query({
+            :scheme   => options[:scheme],
+            :headers  => headers,
+            :host     => @host,
+            :port     => @port,
+            :method   => 'PUT',
+            :path     => "#{bucket_name}/#{object_name}"
+          }, expires)
+        end
+      end
+
+      class Real
+
+        # Get an expiring object url from S3 for putting an object
+        #
+        # @param bucket_name [String] Name of bucket containing object
+        # @param object_name [String] Name of object to get expiring url for
+        # @param expires [Time] An expiry time for this url
+        #
+        # @return [Excon::Response] response:
+        #   * body [String] url for object
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html
+
+        include PutObjectUrl
+
+      end
+
+      class Mock # :nodoc:all
+
+        include PutObjectUrl
+
+      end
+    end
+  end
+end