fog 1.9.0 → 1.10.0

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

@@ -0,0 +1,47 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/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    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'GET',
+            :parser     => Fog::Parsers::Storage::InternetArchive::GetBucketLogging.new,
+            :query      => {'logging' => nil}
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,162 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/get_bucket_object_versions'
+
+        # List information about object versions in an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to list object keys from
+        # @param options [Hash] config arguments for list
+        # @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 key-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.
+        # @option options version-id-marker [String] limits object versions to only those that appear lexicographically after its value
+        #
+        # @return [Excon::Response] 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
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html
+
+        def get_bucket_object_versions(bucket_name, options = {})
+          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::Storage::InternetArchive::GetBucketObjectVersions.new,
+            :query    => {'versions' => nil}.merge!(options)          })
+        end
+
+      end
+
+      class Mock
+        def get_bucket_object_versions(bucket_name, options = {})
+          delimiter, key_marker, max_keys, prefix, version_id_marker = \
+            options['delimiter'], options['key-marker'], options['max-keys'],options['prefix'],options['version-id-marker']
+
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+
+          response = Excon::Response.new
+
+          # Invalid arguments.
+          if version_id_marker && !key_marker
+            response.status = 400
+            response.body = {
+              'Error' => {
+                'Code' => 'InvalidArgument',
+                'Message' => 'A version-id marker cannot be specified without a key marker.',
+                'ArgumentValue' => version_id_marker,
+                'RequestId' => Fog::Mock.random_hex(16),
+                'HostId' => Fog::Mock.random_base64(65)
+              }
+            }
+
+          # Valid case.
+          # TODO: (nirvdrum 12/15/11) It's not clear to me how to actually use version-id-marker, so I didn't implement it below.
+          elsif bucket = self.data[:buckets][bucket_name]
+            # We need to order results by S3 key, but since our data store is key => [versions], we want to ensure the integrity
+            # of the versions as well.  So, sort the keys, then fetch the versions, and then combine them all as a sorted list by
+            # flattening the results.
+            contents = bucket[:objects].keys.sort.collect { |key| bucket[:objects][key] }.flatten.reject do |object|
+                (prefix      && object['Key'][0...prefix.length] != prefix) ||
+                (key_marker  && object['Key'] <= key_marker) ||
+                (delimiter   && object['Key'][(prefix ? prefix.length : 0)..-1].include?(delimiter) \
+                             && common_prefixes << object['Key'].sub(/^(#{prefix}[^#{delimiter}]+.).*/, '\1'))
+              end.map do |object|
+                if object.has_key?(:delete_marker)
+                  tag_name = 'DeleteMarker'
+                  extracted_attrs = ['Key', 'VersionId']
+                else
+                  tag_name = 'Version'
+                  extracted_attrs = ['ETag', 'Key', 'StorageClass', 'VersionId']
+                end
+
+                data = {}
+                data[tag_name] = object.reject { |key, value| !extracted_attrs.include?(key) }
+                data[tag_name].merge!({
+                  'LastModified' => Time.parse(object['Last-Modified']),
+                  'Owner'        => bucket['Owner'],
+                  'IsLatest'     => object == bucket[:objects][object['Key']].first
+                })
+
+                data[tag_name]['Size'] = object['Content-Length'].to_i if tag_name == 'Version'
+              data
+            end
+
+            max_keys = max_keys || 1000
+            size = [max_keys, 1000].min
+            truncated_contents = contents[0...size]
+
+            response.status = 200
+            response.body = {
+              'Versions'        => truncated_contents,
+              'IsTruncated'     => truncated_contents.size != contents.size,
+              'KeyMarker'       => key_marker,
+              'VersionIdMarker' => version_id_marker,
+              'MaxKeys'         => max_keys,
+              'Name'            => bucket['Name'],
+              'Prefix'          => prefix
+            }
+            if max_keys && max_keys < response.body['Versions'].length
+                response.body['IsTruncated'] = true
+                response.body['Versions'] = response.body['Versions'][0...max_keys]
+            end
+
+          # Missing bucket case.
+          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/get_bucket_policy.rb

@@ -0,0 +1,34 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Get bucket policy for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get policy for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash] - policy document
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html
+
+        def get_bucket_policy(bucket_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          response = request({
+            :expects    => 200,
+            :headers    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'GET',
+            :query      => {'policy' => nil}
+          })
+          response.body = Fog::JSON.decode(response.body) unless response.body.nil?
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/get_bucket_versioning'
+
+        # Get versioning status for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get versioning status for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * VersioningConfiguration [Hash]:
+        #       * Status [String] - Versioning status in ['Enabled', 'Suspended', nil]
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html
+
+        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::Storage::InternetArchive::GetBucketVersioning.new,
+            :query      => {'versioning' => nil}
+          })
+        end
+      end
+
+      class Mock
+        def get_bucket_versioning(bucket_name)
+          response = Excon::Response.new
+          bucket = self.data[:buckets][bucket_name]
+
+          if bucket
+            response.status = 200
+
+            if bucket[:versioning]
+              response.body = { 'VersioningConfiguration' => { 'Status' => bucket[:versioning] } }
+            else
+              response.body = { 'VersioningConfiguration' => {} }
+            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/get_bucket_website.rb

@@ -0,0 +1,40 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        require 'fog/internet_archive/parsers/storage/get_bucket_website'
+
+        # Get website configuration for an S3 bucket
+        #
+        # 
+        # @param bucket_name [String] name of bucket to get website configuration for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * IndexDocument [Hash]:
+        #       * Suffix [String] - Suffix appended when directory is requested
+        #     * ErrorDocument [Hash]:
+        #       * Key [String] - Object key to return for 4XX class errors
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html
+
+        def get_bucket_website(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::Storage::InternetArchive::GetBucketWebsite.new,
+            :query      => {'website' => nil}
+          })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+
+        # Get an object from S3
+        #
+        # @param bucket_name [String] Name of bucket to read from
+        # @param object_name [String] Name of object to read
+        # @param options [Hash]
+        # @option options If-Match [String] Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
+        # @option options If-Modified-Since [Time] Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
+        # @option options If-None-Match [String] Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
+        # @option options If-Unmodified-Since [Time] Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
+        # @option options Range [String] Range of object to download
+        # @option options versionId [String] specify a particular version to retrieve
+        #
+        # @return [Excon::Response] response:
+        #   * body [String]- Contents of object
+        #   * headers [Hash]:
+        #     * Content-Length [String] - Size of object contents
+        #     * Content-Type [String] - MIME type of object
+        #     * ETag [String] - Etag of object
+        #     * Last-Modified [String] - Last modified timestamp for object
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html
+
+        def get_object(bucket_name, object_name, options = {}, &block)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          unless object_name
+            raise ArgumentError.new('object_name is required')
+          end
+
+          params = { :headers => {} }
+          if version_id = options.delete('versionId')
+            params[:query] = {'versionId' => version_id}
+          end
+          params[:headers].merge!(options)
+          if options['If-Modified-Since']
+            params[:headers]['If-Modified-Since'] = Fog::Time.at(options['If-Modified-Since'].to_i).to_date_header
+          end
+          if options['If-Unmodified-Since']
+            params[:headers]['If-Unmodified-Since'] = Fog::Time.at(options['If-Unmodified-Since'].to_i).to_date_header
+          end
+
+          if block_given?
+            params[:response_block] = Proc.new
+          end
+
+          request(params.merge!({
+            :expects  => [ 200, 206 ],
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :path     => CGI.escape(object_name),
+          }))
+        end
+
+      end
+
+      class Mock # :nodoc:all
+
+        def get_object(bucket_name, object_name, options = {}, &block)
+          version_id = options.delete('versionId')
+
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+
+          unless object_name
+            raise ArgumentError.new('object_name is required')
+          end
+
+          response = Excon::Response.new
+          if (bucket = self.data[:buckets][bucket_name])
+            object = nil
+            if bucket[:objects].has_key?(object_name)
+              object = version_id ? bucket[:objects][object_name].find { |object| object['VersionId'] == version_id} : bucket[:objects][object_name].first
+            end
+
+            if (object && !object[:delete_marker])
+              if options['If-Match'] && options['If-Match'] != object['ETag']
+                response.status = 412
+              elsif options['If-Modified-Since'] && options['If-Modified-Since'] > Time.parse(object['Last-Modified'])
+                response.status = 304
+              elsif options['If-None-Match'] && options['If-None-Match'] == object['ETag']
+                response.status = 304
+              elsif options['If-Unmodified-Since'] && options['If-Unmodified-Since'] < Time.parse(object['Last-Modified'])
+                response.status = 412
+              else
+                response.status = 200
+                for key, value in object
+                  case key
+                  when 'Cache-Control', 'Content-Disposition', 'Content-Encoding', 'Content-Length', 'Content-MD5', 'Content-Type', 'ETag', 'Expires', 'Last-Modified', /^x-amz-meta-/
+                    response.headers[key] = value
+                  end
+                end
+
+                response.headers['x-amz-version-id'] = object['VersionId'] if bucket[:versioning]
+
+                body = object[:body]
+                if options['Range']
+                  # since AWS S3 itself does not support multiple range headers, we will use only the first
+                  ranges = byte_ranges(options['Range'], body.size)
+                  unless ranges.nil? || ranges.empty?
+                    response.status = 206
+                    body = body[ranges.first]
+                  end
+                end
+
+                unless block_given?
+                  response.body = body
+                else
+                  data = StringIO.new(body)
+                  remaining = data.length
+                  while remaining > 0
+                    chunk = data.read([remaining, Excon::CHUNK_SIZE].min)
+                    block.call(chunk)
+                    remaining -= Excon::CHUNK_SIZE
+                  end
+                end
+              end
+            elsif version_id && !object
+              response.status = 400
+              response.body = {
+                '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)
+                }
+              }
+
+              raise(Excon::Errors.status_error({:expects => 200}, response))
+            else
+              response.status = 404
+              response.body = "...<Code>NoSuchKey<\/Code>..."
+              raise(Excon::Errors.status_error({:expects => 200}, response))
+            end
+          else
+            response.status = 404
+            response.body = "...<Code>NoSuchBucket</Code>..."
+            raise(Excon::Errors.status_error({:expects => 200}, response))
+          end
+          response
+        end
+
+        private
+
+        # === Borrowed from rack
+        # Parses the "Range:" header, if present, into an array of Range objects.
+        # Returns nil if the header is missing or syntactically invalid.
+        # Returns an empty array if none of the ranges are satisfiable.
+        def byte_ranges(http_range, size)
+          # See <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35>
+          return nil unless http_range
+          ranges = []
+          http_range.split(/,\s*/).each do |range_spec|
+            matches = range_spec.match(/bytes=(\d*)-(\d*)/)
+            return nil  unless matches
+            r0,r1 = matches[1], matches[2]
+            if r0.empty?
+              return nil  if r1.empty?
+              # suffix-byte-range-spec, represents trailing suffix of file
+              r0 = [size - r1.to_i, 0].max
+              r1 = size - 1
+            else
+              r0 = r0.to_i
+              if r1.empty?
+                r1 = size - 1
+              else
+                r1 = r1.to_i
+                return nil  if r1 < r0  # backwards range is syntactically invalid
+                r1 = size-1  if r1 >= size
+              end
+            end
+            ranges << (r0..r1)  if r0 <= r1
+          end
+          ranges
+        end
+      end
+    end
+  end
+end