fog 0.0.93 → 0.0.94

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

@@ -0,0 +1,53 @@
+module Fog
+  module AWS
+    module S3
+      class Real
+
+        # Get logging status for an S3 bucket
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to get logging status for
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * 'BucketLoggingStatus'<~Hash>: (will be empty if logging is disabled)
+        #       * '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]
+        #
+        def get_bucket_logging(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::AWS::S3::GetBucketLogging.new,
+            :query      => 'logging'
+          })
+        end
+
+      end
+
+      class Mock
+
+        def get_bucket_logging(bucket_name)
+          raise MockNotImplemented.new("Contributions welcome!")
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/s3/get_bucket_object_versions.rb

@@ -0,0 +1,83 @@
+module Fog
+  module AWS
+    module S3
+      class Real
+
+        # List information about object versions in an S3 bucket
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to list object keys from
+        # * options<~Hash> - config arguments for list.  Defaults to {}.
+        #   * 'delimiter'<~String> - causes keys with the same string between the prefix
+        #     value and the first occurence of delimiter to be rolled up
+        #   * 'key-marker'<~String> - limits object keys to only those that appear
+        #     lexicographically after its value.
+        #   * 'max-keys'<~Integer> - limits number of object keys returned
+        #   * 'prefix'<~String> - limits object keys to those beginning with its value.
+        #   * 'version-id-marker'<~String> - limits object versions to only those that
+        #     appear lexicographically after its value
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * 'Delimeter'<~String> - Delimiter specified for query
+        #     * 'KeyMarker'<~String> - Key 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
+        #     * 'VersionIdMarker'<~String> - Version id marker specified for query
+        #     * 'IsTruncated'<~Boolean> - Whether or not this is the totality of the bucket
+        #     * 'Versions'<~Array>:
+        #         * 'DeleteMarker'<~Hash>:
+        #           * 'IsLatest'<~Boolean> - Whether or not this is the latest version
+        #           * '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
+        #           * 'VersionId'<~String> - The id of this version
+        #       or
+        #         * 'Version'<~Hash>:
+        #           * 'ETag'<~String>: Etag of object
+        #           * 'IsLatest'<~Boolean> - Whether or not this is the latest version
+        #           * '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
+        #           * 'VersionId'<~String> - The id of this version
+        #
+        def get_bucket_object_versions(bucket_name, options = {})
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          query = ''
+          for key, value in options
+            query << "#{key}=#{CGI.escape(value.to_s).gsub(/\+/, '%20')}&"
+          end
+          query.chop!
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::AWS::S3::GetBucketObjectVersions.new,
+            :query    => query
+          })
+        end
+
+      end
+
+      class Mock
+
+        def get_bucket_object_versions(bucket_name, options = {})
+          raise MockNotImplemented.new("Contributions welcome!")
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/s3/get_bucket_versioning.rb

@@ -0,0 +1,43 @@
+module Fog
+  module AWS
+    module S3
+      class Real
+
+        # Get versioning status for an S3 bucket
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to get versioning status for
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * 'VersioningConfiguration'<~Hash>
+        #         * Status<~String>: Versioning status in ['Enabled', 'Suspended', nil]
+        #
+        def get_bucket_versioning(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::AWS::S3::GetBucketVersioning.new,
+            :query      => 'versioning'
+          })
+        end
+
+      end
+
+      class Mock
+
+        def get_bucket_versioning(bucket_name)
+          raise MockNotImplemented.new("Contributions welcome!")
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/s3/get_object.rb

@@ -14,6 +14,8 @@ module Fog
         #   * 'If-None-Match'<~String> - Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
         #   * 'If-Unmodified-Since'<~Time> - Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
         #   * 'Range'<~String> - Range of object to download
+        #   * 'versionId'<~String> - specify a particular version to retrieve
+        #
         # ==== Returns
         # * response<~Excon::Response>:
         #   * body<~String> - Contents of object
@@ -22,6 +24,7 @@ module Fog
         #     * 'Content-Type'<~String> - MIME type of object
         #     * 'ETag'<~String> - Etag of object
         #     * 'Last-Modified'<~String> - Last modified timestamp for object
+        #
         def get_object(bucket_name, object_name, options = {}, &block)
           unless bucket_name
             raise ArgumentError.new('bucket_name is required')
@@ -29,6 +32,7 @@ module Fog
           unless object_name
             raise ArgumentError.new('object_name is required')
           end
+          version_id = options.delete('versionId')
           headers = {}
           headers['If-Modified-Since'] = options['If-Modified-Since'].utc.strftime("%a, %d %b %Y %H:%M:%S +0000") if options['If-Modified-Since']
           headers['If-Unmodified-Since'] = options['If-Unmodified-Since'].utc.strftime("%a, %d %b %Y %H:%M:%S +0000") if options['If-Modified-Since']
@@ -39,7 +43,8 @@ module Fog
             :host     => "#{bucket_name}.#{@host}",
             :idempotent => true,
             :method   => 'GET',
-            :path     => CGI.escape(object_name)
+            :path     => CGI.escape(object_name),
+            :query    => CGI.escape(version_id)
           }, &block)
         end
 

data/lib/fog/aws/requests/s3/get_object_acl.rb

@@ -8,6 +8,8 @@ module Fog
         # ==== Parameters
         # * bucket_name<~String> - name of bucket containing object
         # * object_name<~String> - name of object to get access control list for
+        # * options<~Hash>:
+        #   * 'versionId'<~String> - specify a particular version to retrieve
         #
         # ==== Returns
         # * response<~Excon::Response>:
@@ -25,13 +27,17 @@ module Fog
         #              * 'URI'<~String> - URI of group to grant access for
         #           * 'Permission'<~String> - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
         #
-        def get_object_acl(bucket_name, object_name)
+        def get_object_acl(bucket_name, object_name, options = {})
           unless bucket_name
             raise ArgumentError.new('bucket_name is required')
           end
           unless object_name
             raise ArgumentError.new('object_name is required')
           end
+          query = 'acl'
+          if version_id = options.delete('versionId')
+            query << "&#{CGI.escape(version_id)}"
+          end
           request({
             :expects    => 200,
             :headers    => {},
@@ -40,7 +46,7 @@ module Fog
             :method     => 'GET',
             :parser     => Fog::Parsers::AWS::S3::AccessControlList.new,
             :path       => CGI.escape(object_name),
-            :query      => 'acl'
+            :query      => query
           })
         end
 

data/lib/fog/aws/requests/s3/head_object.rb

@@ -14,6 +14,7 @@ module Fog
         #   * 'If-None-Match'<~String> - Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
         #   * 'If-Unmodified-Since'<~Time> - Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
         #   * 'Range'<~String> - Range of object to download
+        #   * 'versionId'<~String> - specify a particular version to retrieve
         #
         # ==== Returns
         # * response<~Excon::Response>:
@@ -24,6 +25,7 @@ module Fog
         #     * 'ETag'<~String> - Etag of object
         #     * 'Last-Modified'<~String> - Last modified timestamp for object
         def head_object(bucket_name, object_name, options={})
+          version_id = options.delete('versionId')
           headers = {}
           headers['If-Modified-Since'] = options['If-Modified-Since'].utc.strftime("%a, %d %b %Y %H:%M:%S +0000") if options['If-Modified-Since']
           headers['If-Unmodified-Since'] = options['If-Unmodified-Since'].utc.strftime("%a, %d %b %Y %H:%M:%S +0000") if options['If-Modified-Since']
@@ -33,7 +35,8 @@ module Fog
             :headers  => headers,
             :host     => "#{bucket_name}.#{@host}",
             :method   => 'HEAD',
-            :path     => CGI.escape(object_name)
+            :path     => CGI.escape(object_name),
+            :query    => CGI.escape(version_id)
           })
         end
 

data/lib/fog/aws/requests/s3/put_bucket_acl.rb

@@ -50,7 +50,7 @@ DATA
             data << "    </Grant>"
           end
 
-data <<
+          data <<
 <<-DATA
   </AccessControlList>
 </AccessControlPolicy>

data/lib/fog/aws/requests/s3/put_bucket_logging.rb

@@ -0,0 +1,87 @@
+module Fog
+  module AWS
+    module S3
+      class Real
+
+        # Change logging status for an S3 bucket
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to modify
+        # * 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]
+        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'
+          })
+        end
+
+      end
+
+      class Mock
+
+        def put_bucket_logging(bucket_name, logging_status)
+          raise MockNotImplemented.new("Contributions welcome!")
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/aws/requests/s3/put_bucket_versioning.rb

@@ -0,0 +1,40 @@
+module Fog
+  module AWS
+    module S3
+      class Real
+
+        # Change versioning status for an S3 bucket
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to modify
+        # * status<~String> - Status to change to in ['Enabled', 'Suspended']
+        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'
+          })
+        end
+
+      end
+
+      class Mock
+
+        def put_bucket_versioning(bucket_name, status)
+          raise MockNotImplemented.new("Contributions welcome!")
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/aws/s3.rb

@@ -13,6 +13,9 @@ module Fog
           require 'fog/aws/parsers/s3/copy_object'
           require 'fog/aws/parsers/s3/get_bucket'
           require 'fog/aws/parsers/s3/get_bucket_location'
+          require 'fog/aws/parsers/s3/get_bucket_logging'
+          require 'fog/aws/parsers/s3/get_bucket_object_versions'
+          require 'fog/aws/parsers/s3/get_bucket_versioning'
           require 'fog/aws/parsers/s3/get_request_payment'
           require 'fog/aws/parsers/s3/get_service'
           require 'fog/aws/requests/s3/copy_object'
@@ -21,6 +24,9 @@ module Fog
           require 'fog/aws/requests/s3/get_bucket'
           require 'fog/aws/requests/s3/get_bucket_acl'
           require 'fog/aws/requests/s3/get_bucket_location'
+          require 'fog/aws/requests/s3/get_bucket_logging'
+          require 'fog/aws/requests/s3/get_bucket_object_versions'
+          require 'fog/aws/requests/s3/get_bucket_versioning'
           require 'fog/aws/requests/s3/get_object'
           require 'fog/aws/requests/s3/get_object_acl'
           require 'fog/aws/requests/s3/get_object_torrent'
@@ -30,6 +36,8 @@ module Fog
           require 'fog/aws/requests/s3/head_object'
           require 'fog/aws/requests/s3/put_bucket'
           require 'fog/aws/requests/s3/put_bucket_acl'
+          require 'fog/aws/requests/s3/put_bucket_logging'
+          require 'fog/aws/requests/s3/put_bucket_versioning'
           require 'fog/aws/requests/s3/put_object'
           require 'fog/aws/requests/s3/put_request_payment'
           @required = true
@@ -195,7 +203,7 @@ DATA
             canonical_resource << "#{CGI.escape(subdomain).downcase}/"
           end
           canonical_resource << "#{params[:path]}"
-          if ['acl', 'location', 'logging', 'requestPayment', 'torrent'].include?(params[:query])
+          if params[:query]
             canonical_resource << "?#{params[:query]}"
           end
           string_to_sign << "#{canonical_resource}"