fog-internet-archive 0.0.1

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

@@ -0,0 +1,30 @@
+module Fog
+  module Storage
+    class InternetArchive
+      module GetObjectHttpsUrl
+        def get_object_https_url(bucket_name, object_name, expires, options = {})
+          get_object_url(bucket_name, object_name, expires, options.merge(:scheme => 'https'))
+        end
+      end
+
+      class Real
+        # Get an expiring object https url from S3
+        #
+        # @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 GetObjectHttpsUrl
+      end
+
+      class Mock # :nodoc:all
+        include GetObjectHttpsUrl
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        # Get torrent for an S3 object
+        #
+        # @param bucket_name [String] name of bucket containing object
+        # @param object_name [String] name of object to get torrent for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * AccessControlPolicy [Hash:
+        #       * Owner [Hash]:
+        #         * DisplayName [String] - Display name of object owner
+        #         * ID [String] - Id of object owner
+        #       * AccessControlList [Array]:
+        #         * Grant [Hash]:
+        #           * Grantee [Hash]:
+        #             * DisplayName [String] - Display name of grantee
+        #             * ID [String] - Id of grantee
+        #           * Permission [String] - Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html
+
+        def get_object_torrent(bucket_name, object_name)
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          unless object_name
+            raise ArgumentError.new('object_name is required')
+          end
+          request({
+            :expects    => 200,
+            :headers    => {},
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'GET',
+            :path       => CGI.escape(object_name),
+            :query      => {'torrent' => nil}
+          })
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Fog
+  module Storage
+    class InternetArchive
+      module GetObjectUrl
+        def get_object_url(bucket_name, object_name, expires, options = {})
+          unless bucket_name
+            raise ArgumentError.new('bucket_name is required')
+          end
+          unless object_name
+            raise ArgumentError.new('object_name is required')
+          end
+          host, path = if bucket_name =~ Fog::InternetArchive::COMPLIANT_BUCKET_NAMES
+            ["#{bucket_name}.#{@host}", object_name]
+          else
+            [@host, "#{bucket_name}/#{object_name}"]
+          end
+          scheme_host_path_query({
+            :scheme   => options[:scheme],
+            :headers  => {},
+            :host     => host,
+            :port     => @port,
+            :method   => 'GET',
+            :path     => path,
+            :query    => options[:query]
+          }, expires)
+        end
+      end
+
+      class Real
+        # Get an expiring object url from S3
+        #
+        # @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 GetObjectUrl
+      end
+
+      class Mock # :nodoc:all
+        include GetObjectUrl
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        require 'fog/internet_archive/parsers/storage/get_request_payment'
+
+        # Get configured payer for an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to get payer for
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Payer [String] - Specifies who pays for download and requests
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html
+
+        def get_request_payment(bucket_name)
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::InternetArchive::GetRequestPayment.new,
+            :query    => {'requestPayment' => nil}
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def get_request_payment(bucket_name)
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            response.status = 200
+            response.body = { 'Payer' => bucket['Payer'] }
+          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/get_service.rb

@@ -0,0 +1,50 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        require 'fog/internet_archive/parsers/storage/get_service'
+
+        # List information about S3 buckets for authorized user
+        #
+        # @return [Excon::Response] response:
+        #   * body [Hash]:
+        #     * Buckets [Hash]:
+        #       * Name [String] - Name of bucket
+        #       * CreationTime [Time] - Timestamp of bucket creation
+        #     * Owner [Hash]:
+        #       * DisplayName [String] - Display name of bucket owner
+        #       * ID [String] - Id of bucket owner
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html
+        #
+        def get_service
+          request({
+            :expects  => 200,
+            :headers  => {},
+            :host     => @host,
+            :idempotent => true,
+            :method   => 'GET',
+            :parser   => Fog::Parsers::Storage::InternetArchive::GetService.new
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def get_service
+          response = Excon::Response.new
+          response.headers['Status'] = 200
+          buckets = self.data[:buckets].values.map do |bucket|
+            bucket.reject do |key, value|
+              !['CreationDate', 'Name'].include?(key)
+            end
+          end
+          response.body = {
+            'Buckets' => buckets,
+            'Owner'   => { 'DisplayName' => 'owner', 'ID' => 'some_id'}
+          }
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        # Get headers for 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 [String] If-Match Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
+        # @option options [Time]   If-Modified-Since Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
+        # @option options [String] If-None-Match Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
+        # @option options [Time]   If-Unmodified-Since Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
+        # @option options [String] Range Range of object to download
+        #
+        # @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/RESTObjectHEAD.html
+        #
+        def head_object(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
+          headers = {}
+          headers['If-Modified-Since'] = Fog::Time.at(options['If-Modified-Since'].to_i).to_date_header if options['If-Modified-Since']
+          headers['If-Unmodified-Since'] = Fog::Time.at(options['If-Unmodified-Since'].to_i).to_date_header if options['If-Modified-Since']
+          headers.merge!(options)
+          request({
+            :expects    => 200,
+            :headers    => headers,
+            :host       => "#{bucket_name}.#{@host}",
+            :idempotent => true,
+            :method     => 'HEAD',
+            :path       => CGI.escape(object_name)
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def head_object(bucket_name, object_name, options = {})
+          response = get_object(bucket_name, object_name, options)
+          response.body = nil
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+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,52 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        require 'fog/internet_archive/parsers/storage/list_multipart_uploads'
+
+        # List multipart uploads for a bucket
+        #
+        # @param [String] bucket_name Name of bucket to list multipart uploads for
+        # @param [Hash] options config arguments for list.  Defaults to {}.
+        # @option options [String] key-marker limits parts to only those that appear lexicographically after this key.
+        # @option options [Integer] max-uploads limits number of uploads returned
+        # @option options [String] upload-id-marker 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,53 @@
+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,36 @@
+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}.#{Fog::InternetArchive::API_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