fog 1.9.0 → 1.10.0

data/lib/fog/openstack/requests/storage/delete_object.rb

@@ -0,0 +1,23 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Delete an existing object
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to delete
+        # * object<~String> - Name of object to delete
+        #
+        def delete_object(container, object)
+          request(
+            :expects  => 204,
+            :method   => 'DELETE',
+            :path     => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/openstack/requests/storage/get_container.rb

@@ -0,0 +1,44 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Get details for container and total bytes stored
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to retrieve info for
+        # * options<~String>:
+        #   * 'limit'<~String> - Maximum number of objects to return
+        #   * 'marker'<~String> - Only return objects whose name is greater than marker
+        #   * 'prefix'<~String> - Limits results to those starting with prefix
+        #   * 'path'<~String> - Return objects nested in the pseudo path
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * headers<~Hash>:
+        #     * 'X-Account-Container-Count'<~String> - Count of containers
+        #     * 'X-Account-Bytes-Used'<~String> - Bytes used
+        #   * body<~Array>:
+        #     * 'bytes'<~Integer> - Number of bytes used by container
+        #     * 'count'<~Integer> - Number of items in container
+        #     * 'name'<~String> - Name of container
+        #     * item<~Hash>:
+        #       * 'bytes'<~String> - Size of object
+        #       * 'content_type'<~String> Content-Type of object
+        #       * 'hash'<~String> - Hash of object (etag?)
+        #       * 'last_modified'<~String> - Last modified timestamp
+        #       * 'name'<~String> - Name of object
+        def get_container(container, options = {})
+          options = options.reject {|key, value| value.nil?}
+          request(
+            :expects  => 200,
+            :method   => 'GET',
+            :path     => Fog::OpenStack.escape(container),
+            :query    => {'format' => 'json'}.merge!(options)
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/openstack/requests/storage/get_containers.rb

@@ -0,0 +1,33 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # List existing storage containers
+        #
+        # ==== Parameters
+        # * options<~Hash>:
+        #   * 'limit'<~Integer> - Upper limit to number of results returned
+        #   * 'marker'<~String> - Only return objects with name greater than this value
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Array>:
+        #     * container<~Hash>:
+        #       * 'bytes'<~Integer>: - Number of bytes used by container
+        #       * 'count'<~Integer>: - Number of items in container
+        #       * 'name'<~String>: - Name of container
+        def get_containers(options = {})
+          options = options.reject {|key, value| value.nil?}
+          request(
+            :expects  => [200, 204],
+            :method   => 'GET',
+            :path     => '',
+            :query    => {'format' => 'json'}.merge!(options)
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Get details for object
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to look in
+        # * object<~String> - Name of object to look for
+        #
+        def get_object(container, object, &block)
+          params = {}
+
+          if block_given?
+            params[:response_block] = Proc.new
+          end
+
+          request(params.merge!({
+            :expects  => 200,
+            :method   => 'GET',
+            :path     => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          }), false)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Fog
+  module Storage
+    class OpenStack
+
+      class Real
+
+        # Get an expiring object https url from Cloud Files
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container containing object
+        # * object<~String> - Name of object to get expiring url for
+        # * expires<~Time> - An expiry time for this url
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~String> - url for object
+        #
+        # ==== See Also
+        # http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_TempURL-d1a444.html
+        def get_object_https_url(container, object, expires, options = {})
+          if @rackspace_temp_url_key.nil?
+            raise ArgumentError, "Storage must my instantiated with the :rackspace_temp_url_key option"
+          end
+
+          method         = 'GET'
+          expires        = expires.to_i
+          object_path_escaped   = "#{@path}/#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object,"/")}"
+          object_path_unescaped = "#{@path}/#{Fog::OpenStack.escape(container)}/#{object}"
+          string_to_sign = "#{method}\n#{expires}\n#{object_path_unescaped}"
+
+          hmac = Fog::HMAC.new('sha1', @rackspace_temp_url_key)
+          sig  = sig_to_hex(hmac.sign(string_to_sign))
+
+          "https://#{@host}#{object_path_escaped}?temp_url_sig=#{sig}&temp_url_expires=#{expires}"
+        end
+
+        private
+
+        def sig_to_hex(str)
+          str.unpack("C*").map { |c|
+            c.to_s(16)
+          }.map { |h|
+            h.size == 1 ? "0#{h}" : h
+          }.join
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/openstack/requests/storage/head_container.rb

@@ -0,0 +1,28 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # List number of objects and total bytes stored
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to retrieve info for
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * headers<~Hash>:
+        #     * 'X-Container-Object-Count'<~String> - Count of containers
+        #     * 'X-Container-Bytes-Used'<~String>   - Bytes used
+        def head_container(container)
+          request(
+            :expects  => 204,
+            :method   => 'HEAD',
+            :path     => Fog::OpenStack.escape(container),
+            :query    => {'format' => 'json'}
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/openstack/requests/storage/head_containers.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # List number of containers and total bytes stored
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * headers<~Hash>:
+        #     * 'X-Account-Container-Count'<~String> - Count of containers
+        #     * 'X-Account-Bytes-Used'<~String> - Bytes used
+        def head_containers
+          request(
+            :expects  => 204,
+            :method   => 'HEAD',
+            :path     => '',
+            :query    => {'format' => 'json'}
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Get headers for object
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to look in
+        # * object<~String> - Name of object to look for
+        #
+        def head_object(container, object)
+          request({
+            :expects  => 200,
+            :method   => 'HEAD',
+            :path     => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          }, false)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Fog
+  module Storage
+    class OpenStack
+
+      class Real
+
+        # Set the account wide Temp URL Key. This is a secret key that's
+        # used to generate signed expiring URLs.
+        #
+        # Once the key has been set with this request you should create new
+        # Storage objects with the :rackspace_temp_url_key option then use
+        # the get_object_https_url method to generate expiring URLs.
+        #
+        # *** CAUTION *** changing this secret key will invalidate any expiring
+        # URLS generated with old keys.
+        #
+        # ==== Parameters
+        # * key<~String> - The new Temp URL Key
+        #
+        # ==== Returns
+        # * response<~Excon::Response>
+        #
+        # ==== See Also
+        # http://docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Account_Metadata-d1a4460.html
+        def post_set_meta_temp_url_key(key)
+          request(
+            :expects  => [201, 202, 204],
+            :method   => 'POST',
+            :headers  => {'X-Account-Meta-Temp-Url-Key' => key}
+          )
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Create a new container
+        #
+        # ==== Parameters
+        # * name<~String> - Name for container, should be < 256 bytes and must not contain '/'
+        #
+        def put_container(name)
+          request(
+            :expects  => [201, 202],
+            :method   => 'PUT',
+            :path     => Fog::OpenStack.escape(name)
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Create a new object
+        #
+        # ==== Parameters
+        # * container<~String> - Name for container, should be < 256 bytes and must not contain '/'
+        # * object<~String> - Name for object
+        # * data<~String|File> - data to upload
+        # * options<~Hash> - config headers for object. Defaults to {}.
+        #
+        def put_object(container, object, data, options = {})
+          data = Fog::Storage.parse_data(data)
+          headers = data[:headers].merge!(options)
+          request(
+            :body       => data[:body],
+            :expects    => 201,
+            :idempotent => true,
+            :headers    => headers,
+            :method     => 'PUT',
+            :path       => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+
+        # Create a new object
+        #
+        # ==== Parameters
+        # * container<~String> - Name for container, should be < 256 bytes and must not contain '/'
+        # * object<~String> - Name for object
+        #
+        def put_object_manifest(container, object)
+          path = "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          request(
+            :expects  => 201,
+            :headers  => {'X-Object-Manifest' => path},
+            :method   => 'PUT',
+            :path     => path
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/openstack/storage.rb

@@ -0,0 +1,159 @@
+require 'fog/openstack'
+require 'fog/storage'
+
+module Fog
+  module Storage
+    class OpenStack < Fog::Service
+
+      requires   :openstack_auth_url, :openstack_username,
+                 :openstack_api_key
+      recognizes :persistent, :openstack_service_name,
+                 :openstack_service_type, :openstack_tenant,
+                 :openstack_region
+
+      model_path 'fog/openstack/models/storage'
+      model       :directory
+      collection  :directories
+      model       :file
+      collection  :files
+
+      request_path 'fog/openstack/requests/storage'
+      request :copy_object
+      request :delete_container
+      request :delete_object
+      request :get_container
+      request :get_containers
+      request :get_object
+      request :get_object_https_url
+      request :head_container
+      request :head_containers
+      request :head_object
+      request :put_container
+      request :put_object
+      request :put_object_manifest
+
+      class Mock
+
+        def self.data
+          @data ||= Hash.new do |hash, key|
+            hash[key] = {}
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        def initialize(options={})
+          require 'mime/types'
+          @openstack_api_key = options[:openstack_api_key]
+          @openstack_username = options[:openstack_username]
+        end
+
+        def data
+          self.class.data[@openstack_username]
+        end
+
+        def reset_data
+          self.class.data.delete(@openstack_username)
+        end
+
+      end
+
+      class Real
+
+        def initialize(options={})
+          require 'mime/types'
+          @openstack_api_key = options[:openstack_api_key]
+          @openstack_username = options[:openstack_username]
+          @openstack_auth_url = options[:openstack_auth_url]
+          @openstack_auth_token = options[:openstack_auth_token]
+          @openstack_storage_url = options[:openstack_storage_url]
+          @openstack_must_reauthenticate = false
+          @openstack_service_type = options[:openstack_service_type] || 'object-store'
+          @openstack_service_name = options[:openstack_service_name]
+          @openstack_region       = options[:openstack_region]
+          @openstack_tenant       = options[:openstack_tenant]
+          @connection_options     = options[:connection_options] || {}
+          authenticate
+          @persistent = options[:persistent] || false
+          @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
+        end
+
+        def reload
+          @connection.reset
+        end
+
+        def request(params, parse_json = true, &block)
+          begin
+            response = @connection.request(params.merge({
+              :headers  => {
+                'Content-Type' => 'application/json',
+                'X-Auth-Token' => @auth_token
+              }.merge!(params[:headers] || {}),
+              :host     => @host,
+              :path     => "#{@path}/#{params[:path]}",
+            }), &block)
+          rescue Excon::Errors::Unauthorized => error
+            if error.response.body != 'Bad username or password' # token expiration
+              @openstack_must_reauthenticate = true
+              authenticate
+              retry
+            else # bad credentials
+              raise error
+            end
+          rescue Excon::Errors::HTTPStatusError => error
+            raise case error
+            when Excon::Errors::NotFound
+              Fog::Storage::OpenStack::NotFound.slurp(error)
+            else
+              error
+            end
+          end
+          if !response.body.empty? && parse_json && response.headers['Content-Type'] =~ %r{application/json}
+            response.body = Fog::JSON.decode(response.body)
+          end
+          response
+        end
+
+        private
+        
+        def authenticate
+          if !@openstack_management_url || @openstack_must_reauthenticate
+            options = {
+              :openstack_api_key  => @openstack_api_key,
+              :openstack_username => @openstack_username,
+              :openstack_auth_uri => URI.parse(@openstack_auth_url),
+              :openstack_service_type => @openstack_service_type,
+              :openstack_service_name => @openstack_service_name,
+              :openstack_region => @openstack_region,
+              :openstack_tenant => @openstack_tenant,
+              :openstack_endpoint_type => 'publicURL'
+            }
+
+            credentials = Fog::OpenStack.authenticate_v2(options, @connection_options)
+
+            @current_user = credentials[:user]
+            @current_tenant = credentials[:tenant]
+
+            @openstack_must_reauthenticate = false
+            @auth_token = credentials[:token]
+            @openstack_management_url = credentials[:server_management_url]
+            uri = URI.parse(@openstack_management_url)
+          else
+            @auth_token = @openstack_auth_token
+            uri = URI.parse(@openstack_management_url)
+          end
+
+          @host   = uri.host
+          @path   = uri.path
+          @path.sub!(/\/$/, '')
+          @port   = uri.port
+          @scheme = uri.scheme
+          true
+        end
+
+      end
+    end
+  end
+end