fog-internet-archive 0.0.1

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

@@ -0,0 +1,73 @@
+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]
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html
+
+        def put_object_acl(bucket_name, object_name, acl, options = {})
+          query = {'acl' => nil}
+          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,43 @@
+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

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

@@ -0,0 +1,45 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        # Change who pays for requests to an S3 bucket
+        #
+        # @param bucket_name [String] name of bucket to modify
+        # @param payer [String] valid values are BucketOwner or Requester
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html
+
+        def put_request_payment(bucket_name, payer)
+          data =
+<<-DATA
+<RequestPaymentConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+  <Payer>#{payer}</Payer>
+</RequestPaymentConfiguration>
+DATA
+          request({
+            :body     => data,
+            :expects  => 200,
+            :headers  => {},
+            :host     => "#{bucket_name}.#{@host}",
+            :method   => 'PUT',
+            :query    => {'requestPayment' => nil}
+          })
+        end
+      end
+
+      class Mock # :nodoc:all
+        def put_request_payment(bucket_name, payer)
+          response = Excon::Response.new
+          if bucket = self.data[:buckets][bucket_name]
+            response.status = 200
+            bucket['Payer'] = 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/sync_clock.rb

@@ -0,0 +1,24 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        # Sync clock against S3 to avoid skew errors
+        #
+        def sync_clock
+          response = begin
+            get_service
+          rescue Excon::Errors::HTTPStatusError => error
+            error.response
+          end
+          Fog::Time.now = Time.parse(response.headers['Date'])
+        end
+      end # Real
+
+      class Mock # :nodoc:all
+        def sync_clock
+          true
+        end
+      end # Mock
+    end # Storage
+  end # InternetArchive
+end # Fog

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

@@ -0,0 +1,39 @@
+module Fog
+  module Storage
+    class InternetArchive
+      class Real
+        # Upload a part for a multipart upload
+        #
+        # @param bucket_name [String] Name of bucket to add part to
+        # @param object_name [String] Name of object to add part to
+        # @param upload_id [String] Id of upload to add part to
+        # @param part_number [String] Index of part in upload
+        # @param data [File||String] Content for part
+        # @param options [Hash]
+        # @option options Content-MD5 [String] Base64 encoded 128-bit MD5 digest of message
+        #
+        # @return [Excon::Response] response
+        #   * headers [Hash]:
+        #     * ETag [String] etag of new object (will be needed to complete upload)
+        #
+        # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html
+        #
+        def upload_part(bucket_name, object_name, upload_id, part_number, data, options = {})
+          data = Fog::Storage.parse_data(data)
+          headers = options
+          headers['Content-Length'] = data[:headers]['Content-Length']
+          request({
+            :body       => data[:body],
+            :expects    => 200,
+            :idempotent => true,
+            :headers    => headers,
+            :host       => "#{bucket_name}.#{@host}",
+            :method     => 'PUT',
+            :path       => CGI.escape(object_name),
+            :query      => {'uploadId' => upload_id, 'partNumber' => part_number}
+          })
+        end
+      end # Real
+    end # Storage
+  end # InternetArchive
+end # Fog

data/lib/fog/internet_archive/signaturev4.rb

@@ -0,0 +1,71 @@
+# See http://docs.amazonwebservices.com/general/latest/gr/signature-version-4.html
+#
+module Fog
+  module InternetArchive
+    class SignatureV4
+      def initialize(ia_access_key_id, secret_key, region,service)
+        @region = region
+        @service = service
+        @ia_access_key_id  = ia_access_key_id
+        @hmac = Fog::HMAC.new('sha256', 'AWS4' + secret_key)
+      end
+
+      def sign(params, date)
+        canonical_request = <<-DATA
+#{params[:method].to_s.upcase}
+#{params[:path]}
+#{canonical_query_string(params[:query])}
+#{canonical_headers(params[:headers])}
+#{signed_headers(params[:headers])}
+#{Digest::SHA256.hexdigest(params[:body] || '')}
+DATA
+        canonical_request.chop!
+        credential_scope = "#{date.utc.strftime('%Y%m%d')}/#{@region}/#{@service}/aws4_request"
+        string_to_sign = <<-DATA
+AWS4-HMAC-SHA256
+#{date.to_iso8601_basic}
+#{credential_scope}
+#{Digest::SHA256.hexdigest(canonical_request)}
+DATA
+
+        string_to_sign.chop!
+
+        signature = derived_hmac(date).sign(string_to_sign)
+
+        "AWS4-HMAC-SHA256 Credential=#{@ia_access_key_id}/#{credential_scope}, SignedHeaders=#{signed_headers(params[:headers])}, Signature=#{signature.unpack('H*').first}"
+      end
+
+      protected
+
+      def canonical_query_string(query)
+        canonical_query_string = []
+        for key in (query || {}).keys.sort_by {|k| k.to_s}
+          component = "#{Fog::InternetArchive.escape(key.to_s)}=#{Fog::InternetArchive.escape(query[key].to_s)}"
+          canonical_query_string << component
+        end
+        canonical_query_string.join("&")
+      end
+
+      def canonical_headers(headers)
+        canonical_headers = ''
+
+        for key in headers.keys.sort_by {|k| k.to_s}
+          canonical_headers << "#{key.to_s.downcase}:#{headers[key].to_s.strip}\n"
+        end
+        canonical_headers
+      end
+
+      def signed_headers(headers)
+        headers.keys.map {|key| key.to_s}.sort.map {|key| key.downcase}.join(';')
+      end
+
+      def derived_hmac(date)
+        kDate = @hmac.sign(date.utc.strftime('%Y%m%d'))
+        kRegion = Fog::HMAC.new('sha256', kDate).sign(@region)
+        kService = Fog::HMAC.new('sha256', kRegion).sign(@service)
+        kSigning = Fog::HMAC.new('sha256', kService).sign('aws4_request')
+        Fog::HMAC.new('sha256', kSigning)
+      end
+    end
+  end
+end

data/lib/fog/internet_archive/storage.rb

@@ -0,0 +1,381 @@
+require 'fog/internet_archive/core'
+
+module Fog
+  module Storage
+    class InternetArchive < Fog::Service
+      requires :ia_access_key_id, :ia_secret_access_key
+      recognizes :endpoint, :region, :host, :path, :port, :scheme, :persistent, :ia_session_token, :ia_credentials_expire_at
+
+      secrets    :ia_secret_access_key, :hmac
+
+      model_path 'fog/internet_archive/models/storage'
+      collection  :directories
+      model       :directory
+      collection  :files
+      model       :file
+
+      request_path 'fog/internet_archive/requests/storage'
+      request :abort_multipart_upload
+      request :complete_multipart_upload
+      request :copy_object
+      request :delete_bucket
+      request :delete_bucket_cors
+      request :delete_bucket_lifecycle
+      request :delete_bucket_policy
+      request :delete_bucket_website
+      request :delete_object
+      request :delete_multiple_objects
+      request :get_bucket
+      request :get_bucket_acl
+      request :get_bucket_cors
+      request :get_bucket_lifecycle
+      request :get_bucket_location
+      request :get_bucket_logging
+      request :get_bucket_policy
+      request :get_bucket_website
+      request :get_object
+      request :get_object_acl
+      request :get_object_torrent
+      request :get_object_http_url
+      request :get_object_https_url
+      request :get_object_url
+      request :get_request_payment
+      request :get_service
+      request :head_object
+      request :initiate_multipart_upload
+      request :list_multipart_uploads
+      request :list_parts
+      request :post_object_hidden_fields
+      request :put_bucket
+      request :put_bucket_acl
+      request :put_bucket_cors
+      request :put_bucket_lifecycle
+      request :put_bucket_logging
+      request :put_bucket_policy
+      request :put_bucket_website
+      request :put_object
+      request :put_object_acl
+      request :put_object_url
+      request :put_request_payment
+      request :sync_clock
+      request :upload_part
+
+      module Utils
+        attr_accessor :region
+
+        def http_url(params, expires)
+          scheme_host_path_query(params.merge(:scheme => 'http', :port => 80), expires)
+        end
+
+        def https_url(params, expires)
+          scheme_host_path_query(params.merge(:scheme => 'https', :port => 443), expires)
+        end
+
+        def url(params, expires)
+          Fog::Logger.deprecation("Fog::Storage::InternetArchive => #url is deprecated, use #https_url instead [light_black](#{caller.first})[/]")
+          http_url(params, expires)
+        end
+
+        private
+
+        def scheme_host_path_query(params, expires)
+          params[:scheme] ||= @scheme
+          if params[:port] == 80 && params[:scheme] == 'http'
+            params.delete(:port)
+          end
+          if params[:port] == 443 && params[:scheme] == 'https'
+            params.delete(:port)
+          end
+          params[:headers] ||= {}
+          params[:headers]['Date'] = expires.to_i
+          params[:path] = Fog::InternetArchive.escape(params[:path]).gsub('%2F', '/')
+          query = []
+          params[:headers]['x-amz-security-token'] = @ia_session_token if @ia_session_token
+          if params[:query]
+            for key, value in params[:query]
+              query << "#{key}=#{Fog::InternetArchive.escape(value)}"
+            end
+          end
+          query << "AWSAccessKeyId=#{@ia_access_key_id}"
+          query << "Signature=#{Fog::InternetArchive.escape(signature(params))}"
+          query << "Expires=#{params[:headers]['Date']}"
+          query << "x-amz-security-token=#{Fog::InternetArchive.escape(@ia_session_token)}" if @ia_session_token
+          port_part = params[:port] && ":#{params[:port]}"
+          "#{params[:scheme]}://#{params[:host]}#{port_part}/#{params[:path]}?#{query.join('&')}"
+        end
+      end
+
+      class Mock
+        include Utils
+
+        def self.acls(type)
+          case type
+          when 'private'
+            {
+              "AccessControlList" => [
+                {
+                  "Permission" => "FULL_CONTROL",
+                  "Grantee" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+                }
+              ],
+              "Owner" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+            }
+          when 'public-read'
+            {
+              "AccessControlList" => [
+                {
+                  "Permission" => "FULL_CONTROL",
+                  "Grantee" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+                },
+                {
+                  "Permission" => "READ",
+                  "Grantee" => {"URI" => "http://acs.amazonaws.com/groups/global/AllUsers"}
+                }
+              ],
+              "Owner" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+            }
+          when 'public-read-write'
+            {
+              "AccessControlList" => [
+                {
+                  "Permission" => "FULL_CONTROL",
+                  "Grantee" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+                },
+                {
+                  "Permission" => "READ",
+                  "Grantee" => {"URI" => "http://acs.amazonaws.com/groups/global/AllUsers"}
+                },
+                {
+                  "Permission" => "WRITE",
+                  "Grantee" => {"URI" => "http://acs.amazonaws.com/groups/global/AllUsers"}
+                }
+              ],
+              "Owner" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+            }
+          when 'authenticated-read'
+            {
+              "AccessControlList" => [
+                {
+                  "Permission" => "FULL_CONTROL",
+                  "Grantee" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+                },
+                {
+                  "Permission" => "READ",
+                  "Grantee" => {"URI" => "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"}
+                }
+              ],
+              "Owner" => {"DisplayName" => "me", "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+            }
+          end
+        end
+
+        def self.data
+          @data ||= Hash.new do |hash, region|
+            hash[region] = Hash.new do |region_hash, key|
+              region_hash[key] = {
+                :acls => {
+                  :bucket => {},
+                  :object => {}
+                },
+                :buckets => {},
+                :cors => {
+                  :bucket => {}
+                }
+              }
+            end
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        def initialize(options={})
+          setup_credentials(options)
+          options[:region] ||= 'us-east-1'
+          @host = options[:host] || Fog::InternetArchive::API_DOMAIN_NAME
+          @scheme = options[:scheme] || 'http'
+          @region = options[:region]
+        end
+
+        def data
+          self.class.data[@region][@ia_access_key_id]
+        end
+
+        def reset_data
+          self.class.data[@region].delete(@ia_access_key_id)
+        end
+
+        def signature(params)
+          "foo"
+        end
+
+        def setup_credentials(options)
+          @ia_access_key_id = options[:ia_access_key_id]
+          @ia_secret_access_key = options[:ia_secret_access_key]
+          @ia_session_token     = options[:ia_session_token]
+          @ia_credentials_expire_at = options[:ia_credentials_expire_at]
+        end
+      end
+
+      class Real
+        include Utils
+        # include Fog::InternetArchive::CredentialFetcher::ConnectionMethods
+        # Initialize connection to S3
+        #
+        # ==== Notes
+        # options parameter must include values for :ia_access_key_id and
+        # :ia_secret_access_key in order to create a connection
+        #
+        # ==== Examples
+        #   s3 = Fog::Storage.new(
+        #     :provider => "InternetArchive",
+        #     :ia_access_key_id => your_ia_access_key_id,
+        #     :ia_secret_access_key => your_ia_secret_access_key
+        #   )
+        #
+        # ==== Parameters
+        # * options<~Hash> - config arguments for connection.  Defaults to {}.
+        #
+        # ==== Returns
+        # * S3 object with connection to aws.
+        def initialize(options={})
+
+          setup_credentials(options)
+          @connection_options     = options[:connection_options] || {}
+
+          if @endpoint = options[:endpoint]
+            endpoint = URI.parse(@endpoint)
+            @host = endpoint.host
+            @path = if endpoint.path.empty?
+              '/'
+            else
+              endpoint.path
+            end
+            @port = endpoint.port
+            @scheme = endpoint.scheme
+          else
+            options[:region] ||= 'us-east-1'
+            @region = options[:region]
+            @host = options[:host] || Fog::InternetArchive::API_DOMAIN_NAME
+            @path       = options[:path]        || '/'
+            @persistent = options.fetch(:persistent, false)
+            @port       = options[:port]        || 80
+            @scheme     = options[:scheme]      || 'http'
+          end
+          @connection = Fog::XML::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", @persistent, @connection_options)
+        end
+
+        def reload
+          @connection.reset
+        end
+
+        def signature(params)
+          string_to_sign =
+<<-DATA
+#{params[:method].to_s.upcase}
+#{params[:headers]['Content-MD5']}
+#{params[:headers]['Content-Type']}
+#{params[:headers]['Date']}
+DATA
+
+          amz_headers, canonical_amz_headers = {}, ''
+          for key, value in params[:headers]
+            if key[0..5] == 'x-amz-'
+              amz_headers[key] = value
+            end
+          end
+          amz_headers = amz_headers.sort {|x, y| x[0] <=> y[0]}
+          for key, value in amz_headers
+            canonical_amz_headers << "#{key}:#{value}\n"
+          end
+          string_to_sign << canonical_amz_headers
+
+          subdomain = params[:host].split(".#{@host}").first
+          unless subdomain =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
+            Fog::Logger.warning("fog: the specified s3 bucket name(#{subdomain}) is not a valid dns name, which will negatively impact performance.  For details see: http://docs.amazonwebservices.com/AmazonS3/latest/dev/BucketRestrictions.html")
+            params[:host] = params[:host].split("#{subdomain}.")[-1]
+            if params[:path]
+              params[:path] = "#{subdomain}/#{params[:path]}"
+            else
+              params[:path] = subdomain
+            end
+            subdomain = nil
+          end
+
+          canonical_resource  = @path.dup
+          unless subdomain.nil? || subdomain == @host
+            canonical_resource << "#{Fog::InternetArchive.escape(subdomain).downcase}/"
+          end
+          canonical_resource << params[:path].to_s
+          canonical_resource << '?'
+          for key in (params[:query] || {}).keys.sort
+            if %w{
+              acl
+              cors
+              delete
+              lifecycle
+              location
+              logging
+              notification
+              partNumber
+              policy
+              requestPayment
+              response-cache-control
+              response-content-disposition
+              response-content-encoding
+              response-content-language
+              response-content-type
+              response-expires
+              torrent
+              uploadId
+              uploads
+              versionId
+              versioning
+              versions
+              website
+            }.include?(key)
+              canonical_resource << "#{key}#{"=#{params[:query][key]}" unless params[:query][key].nil?}&"
+            end
+          end
+          canonical_resource.chop!
+          string_to_sign << canonical_resource
+
+          signed_string = @hmac.sign(string_to_sign)
+          Base64.encode64(signed_string).chomp!
+        end
+
+        private
+
+        def setup_credentials(options)
+          @ia_access_key_id     = options[:ia_access_key_id]
+          @ia_secret_access_key = options[:ia_secret_access_key]
+          @ia_session_token     = options[:ia_session_token]
+          @ia_credentials_expire_at = options[:ia_credentials_expire_at]
+
+          @hmac = Fog::HMAC.new('sha1', @ia_secret_access_key)
+        end
+
+        def request(params, &block)
+          # refresh_credentials_if_expired
+
+          params[:headers]['Date'] = Fog::Time.now.to_date_header
+          params[:headers]['x-amz-security-token'] = @ia_session_token if @ia_session_token
+          params[:headers]['Authorization'] = "AWS #{@ia_access_key_id}:#{signature(params)}"
+          # FIXME: ToHashParser should make this not needed
+          original_params = params.dup
+
+          begin
+            response = @connection.request(params, &block)
+          rescue Excon::Errors::TemporaryRedirect => error
+            uri = URI.parse(error.response.headers['location'])
+            Fog::Logger.warning("fog: followed redirect to #{uri.host}, connecting to the matching region will be more performant")
+            response = Fog::XML::Connection.new("#{@scheme}://#{uri.host}:#{@port}", false, @connection_options).request(original_params, &block)
+          end
+
+          response
+        end
+      end
+    end
+  end
+end