fog 1.19.0 → 1.20.0

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

@@ -1,6 +1,7 @@
 module Fog
   module Storage
     class Rackspace
+
       class Real
 
         # Get headers for object
@@ -21,6 +22,31 @@ module Fog
         end
 
       end
+
+      class Mock
+        def head_object(container, object)
+          c = mock_container! container
+          o = c.mock_object! object
+
+          headers = o.to_headers
+
+          hashes, length = [], 0
+          o.each_part do |part|
+            hashes << part.hash
+            length += part.bytes_used
+          end
+
+          headers['Etag'] = "\"#{Digest::MD5.hexdigest(hashes.join)}\""
+          headers['Content-Length'] = length.to_s
+          headers['X-Static-Large-Object'] = "True" if o.static_manifest?
+
+          response = Excon::Response.new
+          response.status = 200
+          response.headers = headers
+          response
+        end
+      end
+
     end
   end
 end

data/lib/fog/rackspace/requests/storage/post_set_meta_temp_url_key.rb

@@ -35,6 +35,16 @@ module Fog
 
       end
 
+      class Mock
+        def post_set_meta_temp_url_key(key)
+          account_meta['X-Account-Meta-Temp-Url-Key'] = key
+
+          response = Excon::Response.new
+          response.status = 204
+          response
+        end
+      end
+
     end
   end
 end

data/lib/fog/rackspace/requests/storage/put_container.rb

@@ -1,6 +1,7 @@
 module Fog
   module Storage
     class Rackspace
+
       class Real
 
         # Create a new container
@@ -21,6 +22,21 @@ module Fog
         end
 
       end
+
+      class Mock
+        def put_container(name, options={})
+          existed = ! mock_container(name).nil?
+          container = add_container(name)
+          options.keys.each do |k|
+            container.meta[k] = options[k].to_s if k =~ /^X-Container-Meta/
+          end
+
+          response = Excon::Response.new
+          response.status = existed ? 202 : 201
+          response
+        end
+      end
+
     end
   end
 end

data/lib/fog/rackspace/requests/storage/put_dynamic_obj_manifest.rb

@@ -1,6 +1,7 @@
 module Fog
   module Storage
     class Rackspace
+
       class Real
 
         # Create a new dynamic large object manifest
@@ -39,6 +40,28 @@ module Fog
         end
 
       end
+
+      class Mock
+        def put_dynamic_obj_manifest(container, object, options = {})
+          path = "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}"
+
+          # Escape the X-Object-Manifest header to match.
+          explicit_manifest = options['X-Object-Manifest']
+          if explicit_manifest
+            parts = explicit_manifest.split('/', 2)
+            explicit_manifest = parts.map { |p| Fog::Rackspace.escape p }.join('/')
+          end
+
+          c = mock_container! container
+          o = c.add_object object, ''
+          o.meta['X-Object-Manifest'] = explicit_manifest || path
+
+          response = Excon::Response.new
+          response.status = 201
+          response
+        end
+      end
+
     end
   end
 end

data/lib/fog/rackspace/requests/storage/put_object.rb

@@ -1,6 +1,7 @@
 module Fog
   module Storage
     class Rackspace
+
       class Real
 
         # Create a new object
@@ -36,6 +37,44 @@ module Fog
           request(params)
         end
       end
+
+      class Mock
+        HeaderOptions = %w{
+          Content-Type Access-Control-Allow-Origin Origin Content-Disposition
+          Etag Content-Encoding
+        }.freeze
+
+        def put_object(container, object, data, options = {}, &block)
+          c = mock_container! container
+
+          if block_given?
+            data = ""
+            loop do
+              chunk = yield
+              break if chunk.empty?
+              data << chunk
+            end
+          end
+
+          o = c.add_object object, data
+          options.keys.each do |k|
+            o.meta[k] = options[k].to_s if k =~ /^X-Object-Meta/
+            o.meta[k] = options[k] if HeaderOptions.include? k
+          end
+
+          # Validate the provided Etag
+          etag = o.meta['Etag']
+          if etag && etag != o.hash
+            c.remove_object object
+            raise Fog::Storage::Rackspace::ServiceError.new
+          end
+
+          response = Excon::Response.new
+          response.status = 201
+          response
+        end
+      end
+
     end
   end
 end

data/lib/fog/rackspace/requests/storage/put_object_manifest.rb

@@ -1,16 +1,24 @@
 module Fog
   module Storage
     class Rackspace
-      class Real
 
+      module Common
         # Create a new dynamic large object manifest
         #
         # This is an alias for {#put_dynamic_obj_manifest} for backward compatibility.
         def put_object_manifest(container, object, options = {})
           put_dynamic_obj_manifest(container, object, options)
         end
+      end
+
+      class Real
+        include Common
+      end
 
+      class Mock
+        include Common
       end
+
     end
   end
 end

data/lib/fog/rackspace/requests/storage/put_static_obj_manifest.rb

@@ -1,6 +1,7 @@
 module Fog
   module Storage
     class Rackspace
+
       class Real
 
         # Create a new static large object manifest.
@@ -53,6 +54,53 @@ module Fog
         end
 
       end
+
+      class Mock
+        def put_static_obj_manifest(container, object, segments, options = {})
+          c = mock_container! container
+
+          # Verify paths.
+          errors = []
+          segments.each do |segment|
+            cname, oname = segment[:path].split('/', 2)
+            target_container = mock_container(cname)
+
+            raise Fog::Storage::Rackspace::NotFound.new unless target_container
+
+            target_object = target_container.mock_object oname
+            unless target_object
+              errors << [segment[:path], '404 Not Found']
+              next
+            end
+
+            unless target_object.hash == segment[:etag]
+              errors << [segment[:path], 'Etag Mismatch']
+            end
+
+            unless target_object.bytes_used == segment[:size_bytes]
+              errors << [segment[:path], 'Size Mismatch']
+            end
+          end
+
+          unless errors.empty?
+            response = Excon::Response.new
+            response.status = 400
+            response.body = Fog::JSON.encode({ 'Errors' => errors })
+
+            error = Excon::Errors.status_error({}, response)
+            raise Fog::Storage::Rackspace::BadRequest.slurp(error)
+          end
+
+          data = Fog::JSON.encode(segments)
+          o = c.add_object object, data
+          o.static_manifest = true
+
+          response = Excon::Response.new
+          response.status = 201
+          response
+        end
+      end
+
     end
   end
 end

data/lib/fog/rackspace/storage.rb

@@ -1,4 +1,4 @@
-require 'fog/rackspace'
+require 'fog/rackspace/core'
 require 'fog/storage'
 
 module Fog
@@ -41,8 +41,23 @@ module Fog
       request :put_dynamic_obj_manifest
       request :put_static_obj_manifest
       request :post_set_meta_temp_url_key
+      request :extract_archive
 
-      module Utils
+      module Common
+        def apply_options(options)
+          @rackspace_api_key = options[:rackspace_api_key]
+          @rackspace_username = options[:rackspace_username]
+          @rackspace_cdn_ssl = options[:rackspace_cdn_ssl]
+          @rackspace_auth_url = options[:rackspace_auth_url]
+          @rackspace_servicenet = options[:rackspace_servicenet]
+          @rackspace_auth_token = options[:rackspace_auth_token]
+          @rackspace_storage_url = options[:rackspace_storage_url]
+          @rackspace_cdn_url = options[:rackspace_cdn_url]
+          @rackspace_region = options[:rackspace_region] || :dfw
+          @rackspace_temp_url_key = options[:rackspace_temp_url_key]
+          @rackspace_must_reauthenticate = false
+          @connection_options = options[:connection_options] || {}
+        end
 
         def cdn
           @cdn ||= Fog::CDN.new(
@@ -59,10 +74,249 @@ module Fog
           end
         end
 
+        def service_net?
+          @rackspace_servicenet == true
+        end
+
+        def authenticate
+          if @rackspace_must_reauthenticate || @rackspace_auth_token.nil?
+            options = {
+              :rackspace_api_key  => @rackspace_api_key,
+              :rackspace_username => @rackspace_username,
+              :rackspace_auth_url => @rackspace_auth_url,
+              :connection_options => @connection_options
+            }
+            super(options)
+          else
+            @auth_token = @rackspace_auth_token
+            @uri = URI.parse(@rackspace_storage_url)
+          end
+        end
+
+        def service_name
+          :cloudFiles
+        end
+
+        def request_id_header
+          "X-Trans-Id"
+        end
+
+        def region
+          @rackspace_region
+        end
+
+        def endpoint_uri(service_endpoint_url=nil)
+          return @uri if @uri
+          super(@rackspace_storage_url || service_endpoint_url, :rackspace_storage_url)
+        end
+
+        # Return Account Details
+        # @return [Fog::Storage::Rackspace::Account] account details object
+        def account
+          account = Fog::Storage::Rackspace::Account.new(:service => self)
+          account.reload
+        end
       end
 
       class Mock < Fog::Rackspace::Service
-        include Utils
+        include Common
+
+        # An in-memory container for use with Rackspace storage mocks. Includes
+        # many `objects` mapped by (escaped) object name. Tracks container
+        # metadata.
+        class MockContainer
+          attr_reader :objects, :meta, :service
+
+          # Create a new container. Generally, you should call
+          # {Fog::Rackspace::Storage#add_container} instead.
+          def initialize(service)
+            @service = service
+            @objects, @meta = {}, {}
+          end
+
+          # Determine if this container contains any MockObjects or not.
+          #
+          # @return [Boolean]
+          def empty?
+            @objects.empty?
+          end
+
+          # Total sizes of all objects added to this container.
+          #
+          # @return [Integer] The number of bytes occupied by each contained
+          #   object.
+          def bytes_used
+            @objects.values.map { |o| o.bytes_used }.inject(0) { |a, b| a + b }
+          end
+
+          # Render the HTTP headers that would be associated with this
+          # container.
+          #
+          # @return [Hash<String, String>] Any metadata supplied to this
+          #   container, plus additional headers indicating the container's
+          #   size.
+          def to_headers
+            @meta.merge({
+              'X-Container-Object-Count' => @objects.size,
+              'X-Container-Bytes-Used' => bytes_used
+            })
+          end
+
+          # Access a MockObject within this container by (unescaped) name.
+          #
+          # @return [MockObject, nil] Return the MockObject at this name if
+          #   one exists; otherwise, `nil`.
+          def mock_object(name)
+            @objects[Fog::Rackspace.escape(name)]
+          end
+
+          # Access a MockObject with a specific name, raising a
+          # `Fog::Storage::Rackspace::NotFound` exception if none are present.
+          #
+          # @param name [String] (Unescaped) object name.
+          # @return [MockObject] The object within this container with the
+          #   specified name.
+          def mock_object!(name)
+            mock_object(name) or raise Fog::Storage::Rackspace::NotFound.new
+          end
+
+          # Add a new MockObject to this container. An existing object with
+          # the same name will be overwritten.
+          #
+          # @param name [String] The object's name, unescaped.
+          # @param data [String, #read] The contents of the object.
+          def add_object(name, data)
+            @objects[Fog::Rackspace.escape(name)] = MockObject.new(data, service)
+          end
+
+          # Remove a MockObject from the container by name. No effect if the
+          # object is not present beforehand.
+          #
+          # @param name [String] The (unescaped) object name to remove.
+          def remove_object(name)
+            @objects.delete Fog::Rackspace.escape(name)
+          end
+        end
+
+        # An in-memory Swift object.
+        class MockObject
+          attr_reader :hash, :bytes_used, :content_type, :last_modified
+          attr_reader :body, :meta, :service
+          attr_accessor :static_manifest
+
+          # Construct a new object. Generally, you should call
+          # {MockContainer#add_object} instead of instantiating these directly.
+          def initialize(data, service)
+            data = Fog::Storage.parse_data(data)
+            @service = service
+
+            @bytes_used = data[:headers]['Content-Length']
+            @content_type = data[:headers]['Content-Type']
+            if data[:body].respond_to? :read
+              @body = data[:body].read
+            else
+              @body = data[:body]
+            end
+            @last_modified = Time.now.utc
+            @hash = Digest::MD5.hexdigest(@body)
+            @meta = {}
+            @static_manifest = false
+          end
+
+          # Determine if this object was created as a static large object
+          # manifest.
+          #
+          # @return [Boolean]
+          def static_manifest?
+            @static_manifest
+          end
+
+          # Determine if this object has the metadata header that marks it as a
+          # dynamic large object manifest.
+          #
+          # @return [Boolean]
+          def dynamic_manifest?
+            ! large_object_prefix.nil?
+          end
+
+          # Iterate through each MockObject that contains a part of the data for
+          # this logical object. In the normal case, this will only yield the
+          # receiver directly. For dynamic and static large object manifests,
+          # however, this call will yield each MockObject that contains a part
+          # of the whole, in sequence.
+          #
+          # Manifests that refer to containers or objects that don't exist will
+          # skip those sections and log a warning, instead.
+          #
+          # @yield [MockObject] Each object that holds a part of this logical
+          #   object.
+          def each_part
+            case
+            when dynamic_manifest?
+              # Concatenate the contents and sizes of each matching object.
+              # Note that cname and oprefix are already escaped.
+              cname, oprefix = large_object_prefix.split('/', 2)
+
+              target_container = service.data[cname]
+              if target_container
+                all = target_container.objects.keys
+                matching = all.select { |name| name.start_with? oprefix }
+                keys = matching.sort
+
+                keys.each do |name|
+                  yield target_container.objects[name]
+                end
+              else
+                Fog::Logger.warning "Invalid container in dynamic object manifest: #{cname}"
+                yield self
+              end
+            when static_manifest?
+              Fog::JSON.decode(body).each do |segment|
+                cname, oname = segment['path'].split('/', 2)
+
+                cont = service.mock_container cname
+                unless cont
+                  Fog::Logger.warning "Invalid container in static object manifest: #{cname}"
+                  next
+                end
+
+                obj = cont.mock_object oname
+                unless obj
+                  Fog::Logger.warning "Invalid object in static object manifest: #{oname}"
+                  next
+                end
+
+                yield obj
+              end
+            else
+              yield self
+            end
+          end
+
+          # Access the object name prefix that controls which other objects
+          # comprise a dynamic large object.
+          #
+          # @return [String, nil] The object name prefix, or `nil` if none is
+          #   present.
+          def large_object_prefix
+            @meta['X-Object-Manifest']
+          end
+
+          # Construct the fake HTTP headers that should be returned on requests
+          # targetting this object. Includes computed `Content-Type`,
+          # `Content-Length`, `Last-Modified` and `ETag` headers in addition to
+          # whatever metadata has been associated with this object manually.
+          #
+          # @return [Hash<String, String>] Header values stored in a Hash.
+          def to_headers
+            {
+              'Content-Type' => @content_type,
+              'Content-Length' => @bytes_used,
+              'Last-Modified' => @last_modified.strftime('%a, %b %d %Y %H:%M:%S %Z'),
+              'ETag' => @hash
+            }.merge(@meta)
+          end
+        end
 
         def self.data
           @data ||= Hash.new do |hash, key|
@@ -70,56 +324,98 @@ module Fog
           end
         end
 
+        # Access or create account-wide metadata.
+        #
+        # @return [Hash<String,String>] A metadata hash pre-populated with
+        #   a (fake) temp URL key.
+        def self.account_meta
+          @account_meta ||= Hash.new do |hash, key|
+            hash[key] = {
+              'X-Account-Meta-Temp-Url-Key' => Fog::Mock.random_hex(32)
+            }
+          end
+        end
+
         def self.reset
           @data = nil
+          @account_meta = nil
         end
 
         def initialize(options={})
-          @rackspace_api_key = options[:rackspace_api_key]
-          @rackspace_username = options[:rackspace_username]
-          @rackspace_cdn_ssl = options[:rackspace_cdn_ssl]
+          apply_options(options)
+          authenticate
+          endpoint_uri
         end
 
         def data
           self.class.data[@rackspace_username]
         end
 
+        def account_meta
+          self.class.account_meta[@rackspace_username]
+        end
+
         def reset_data
           self.class.data.delete(@rackspace_username)
         end
 
-        def service_name
-          :cloudFiles
+        # Access a MockContainer with the specified name, if one exists.
+        #
+        # @param cname [String] The (unescaped) container name.
+        # @return [MockContainer, nil] The named MockContainer, or `nil` if
+        #   none exist.
+        def mock_container(cname)
+          data[Fog::Rackspace.escape(cname)]
         end
 
-        def region
-          @rackspace_region
+        # Access a MockContainer with the specified name, raising a
+        # {Fog::Storage::Rackspace::NotFound} exception if none exist.
+        #
+        # @param cname [String] The (unescaped) container name.
+        # @throws [Fog::Storage::Rackspace::NotFound] If no container with the
+        #   given name exists.
+        # @return [MockContainer] The existing MockContainer.
+        def mock_container!(cname)
+          mock_container(cname) or raise Fog::Storage::Rackspace::NotFound.new
+        end
+
+        # Create and add a new, empty MockContainer with the given name. An
+        # existing container with the same name will be replaced.
+        #
+        # @param cname [String] The (unescaped) container name.
+        # @return [MockContainer] The container that was added.
+        def add_container(cname)
+          data[Fog::Rackspace.escape(cname)] = MockContainer.new(self)
+        end
+
+        # Remove a MockContainer with the specified name. No-op if the
+        # container does not exist.
+        #
+        # @param cname [String] The (unescaped) container name.
+        def remove_container(cname)
+          data.delete Fog::Rackspace.escape(cname)
         end
 
         def ssl?
           !!@rackspace_cdn_ssl
         end
 
+        private
+
+        def authenticate_v1(options)
+          uuid = Fog::Rackspace::MockData.uuid
+          endpoint_uri "https://storage101.#{region}1.clouddrive.com/v1/MockCloudFS_#{uuid}"
+          @auth_token = Fog::Mock.random_hex(32)
+        end
       end
 
       class Real < Fog::Rackspace::Service
-        include Utils
+        include Common
 
         attr_reader :rackspace_cdn_ssl
 
         def initialize(options={})
-          @rackspace_api_key = options[:rackspace_api_key]
-          @rackspace_username = options[:rackspace_username]
-          @rackspace_cdn_ssl = options[:rackspace_cdn_ssl]
-          @rackspace_auth_url = options[:rackspace_auth_url]
-          @rackspace_servicenet = options[:rackspace_servicenet]
-          @rackspace_auth_token = options[:rackspace_auth_token]
-          @rackspace_storage_url = options[:rackspace_storage_url]
-          @rackspace_cdn_url = options[:rackspace_cdn_url]
-          @rackspace_region = options[:rackspace_region] || :dfw
-          @rackspace_temp_url_key = options[:rackspace_temp_url_key]
-          @rackspace_must_reauthenticate = false
-          @connection_options     = options[:connection_options] || {}
+          apply_options(options)
 
           authenticate
           @persistent = options[:persistent] || false
@@ -127,13 +423,6 @@ module Fog
           @connection = Fog::Connection.new(endpoint_uri.to_s, @persistent, @connection_options)
         end
 
-        # Return Account Details
-        # @return [Fog::Storage::Rackspace::Account] account details object
-        def account
-          account = Fog::Storage::Rackspace::Account.new(:service => self)
-          account.reload
-        end
-
         # Using SSL?
         # @return [Boolean] return true if service is returning SSL-Secured URLs in public_url methods
         # @see Directory#public_url
@@ -158,42 +447,6 @@ module Fog
           raise ServiceError.slurp(error, self)
         end
 
-        def service_net?
-          @rackspace_servicenet == true
-        end
-
-        def authenticate
-          if @rackspace_must_reauthenticate || @rackspace_auth_token.nil?
-            options = {
-              :rackspace_api_key  => @rackspace_api_key,
-              :rackspace_username => @rackspace_username,
-              :rackspace_auth_url => @rackspace_auth_url,
-              :connection_options => @connection_options
-            }
-            super(options)
-          else
-            @auth_token = @rackspace_auth_token
-            @uri = URI.parse(@rackspace_storage_url)
-          end
-        end
-
-        def service_name
-          :cloudFiles
-        end
-
-        def request_id_header
-          "X-Trans-Id"
-        end
-
-        def region
-          @rackspace_region
-        end
-
-        def endpoint_uri(service_endpoint_url=nil)
-          return @uri if @uri
-          super(@rackspace_storage_url || service_endpoint_url, :rackspace_storage_url)
-        end
-
         private
 
         def authenticate_v1(options)
@@ -201,8 +454,8 @@ module Fog
           endpoint_uri credentials['X-Storage-Url']
           @auth_token = credentials['X-Auth-Token']
         end
-
       end
+
     end
   end
 end