fog-openstack 0.1.10 → 0.1.11

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

@@ -1,21 +0,0 @@
-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/delete_static_large_object.rb

@@ -1,41 +0,0 @@
-module Fog
-  module Storage
-    class OpenStack
-      class Real
-        # Delete a static large object.
-        #
-        # Deletes the SLO manifest +object+ and all segments that it references.
-        # The server will respond with +200 OK+ for all requests.
-        # +response.body+ must be inspected for actual results.
-        #
-        # @param container [String] Name of container.
-        # @param object [String] Name of the SLO manifest object.
-        # @param options [Hash] Additional request headers.
-        #
-        # @return [Excon::Response]
-        #   * body [Hash] - Results of the operation.
-        #     * "Number Not Found" [Integer] - Number of missing segments.
-        #     * "Response Status" [String] - Response code for the subrequest of the last failed operation.
-        #     * "Errors" [Array<object_name, response_status>]
-        #       * object_name [String] - Object that generated an error when the delete was attempted.
-        #       * response_status [String] - Response status from the subrequest for object_name.
-        #     * "Number Deleted" [Integer] - Number of segments deleted.
-        #     * "Response Body" [String] - Response body for Response Status.
-        #
-        # @see http://docs.openstack.org/api/openstack-object-storage/1.0/content/static-large-objects.html
-        def delete_static_large_object(container, object, options = {})
-          response = request({
-            :expects  => 200,
-            :method   => 'DELETE',
-            :headers  => options.merge('Content-Type' => 'text/plain',
-                                       'Accept' => 'application/json'),
-            :path     => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}",
-            :query    => { 'multipart-manifest' => 'delete' }
-          }, false)
-          response.body = Fog::JSON.decode(response.body)
-          response
-        end
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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 = {
-            :expects  => 200,
-            :method   => 'GET',
-            :path     => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
-          }
-
-          if block_given?
-            params[:response_block] = block
-          end
-
-          request(params, false)
-        end
-      end
-    end
-  end
-end

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

@@ -1,81 +0,0 @@
-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
-        def get_object_https_url(container, object, expires, options = {})
-          create_temp_url(container, object, expires, "GET", {:port => 443}.merge(options).merge(:scheme => "https"))
-        end
-
-        # creates a temporary url
-        #
-        # ==== 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
-        # * method<~String> - The method to use for accessing the object (GET, PUT, HEAD)
-        # * options<~Hash> - An optional options hash
-        #   * 'scheme'<~String> - The scheme to use (http, https)
-        #   * 'host'<~String> - The host to use
-        #   * 'port'<~Integer> - The port to use
-        #
-        # ==== 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 create_temp_url(container, object, expires, method, options = {})
-          raise ArgumentError, "Insufficient parameters specified." unless (container && object && expires && method)
-          raise ArgumentError, "Storage must be instantiated with the :openstack_temp_url_key option" if @openstack_temp_url_key.nil?
-
-          scheme = options[:scheme] || @scheme
-          host = options[:host] || @host
-          port = options[:port] || @port
-
-          # POST not allowed
-          allowed_methods = %w{GET PUT HEAD}
-          unless allowed_methods.include?(method)
-            raise ArgumentError.new("Invalid method '#{method}' specified. Valid methods are: #{allowed_methods.join(', ')}")
-          end
-
-          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', @openstack_temp_url_key)
-          sig  = sig_to_hex(hmac.sign(string_to_sign))
-
-          temp_url_options = {
-            :scheme => scheme,
-            :host => host,
-            :port => port,
-            :path => object_path_escaped,
-            :query => "temp_url_sig=#{sig}&temp_url_expires=#{expires}"
-          }
-          URI::Generic.build(temp_url_options).to_s
-        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

@@ -1,26 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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  => 200..299,
-            :method   => 'HEAD',
-            :path     => '',
-            :query    => {'format' => 'json'}
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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 :openstack_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/public_url.rb

@@ -1,28 +0,0 @@
-module Fog
-  module Storage
-    class OpenStack
-      class Real
-
-        # Get public_url for an object
-        #
-        # ==== Parameters
-        # * container<~String> - Name of container to look in
-        # * object<~String> - Name of object to look for
-        #
-        def public_url(container=nil, object=nil)
-          return nil if container.nil?
-          u = "#{url}/#{Fog::OpenStack.escape(container)}"
-          u << "/#{Fog::OpenStack.escape(object)}" unless object.nil?
-          u
-        end
-
-        private
-
-        def url
-          "#{@scheme}://#{@host}:#{@port}#{@path}"
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-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, options={})
-          headers = options[:headers] || {}
-          headers['X-Container-Read'] = '.r:*' if options[:public]
-          headers['X-Remove-Container-Read'] = 'x' if options[:public] == false
-          request(
-            :expects  => [201, 202],
-            :method   => 'PUT',
-            :path     => Fog::OpenStack.escape(name),
-            :headers  => headers
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-module Fog
-  module Storage
-    class OpenStack
-      class Real
-        # Create a new dynamic large object manifest
-        #
-        # Creates an object with a +X-Object-Manifest+ header that specifies the common prefix ("<container>/<prefix>")
-        # for all uploaded segments. Retrieving the manifest object streams all segments matching this prefix.
-        # Segments must sort in the order they should be concatenated. Note that any future objects stored in the container
-        # along with the segments that match the prefix will be included when retrieving the manifest object.
-        #
-        # All segments must be stored in the same container, but may be in a different container than the manifest object.
-        # The default +X-Object-Manifest+ header is set to "+container+/+object+", but may be overridden in +options+
-        # to specify the prefix and/or the container where segments were stored.
-        # If overridden, names should be CGI escaped (excluding spaces) if needed (see {Fog::OpenStack.escape}).
-        #
-        # @param container [String] Name for container where +object+ will be stored. Should be < 256 bytes and must not contain '/'
-        # @param object [String] Name for manifest object.
-        # @param options [Hash] Config headers for +object+.
-        # @option options [String] 'X-Object-Manifest' ("container/object") "<container>/<prefix>" for segment objects.
-        #
-        # @raise [Fog::Storage::OpenStack::NotFound] HTTP 404
-        # @raise [Excon::Errors::BadRequest] HTTP 400
-        # @raise [Excon::Errors::Unauthorized] HTTP 401
-        # @raise [Excon::Errors::HTTPStatusError]
-        #
-        # @see http://docs.openstack.org/api/openstack-object-storage/1.0/content/dynamic-large-object-creation.html
-        def put_dynamic_obj_manifest(container, object, options = {})
-          path = "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
-          headers = {'X-Object-Manifest' => path}.merge(options)
-          request(
-            :expects  => 201,
-            :headers  => headers,
-            :method   => 'PUT',
-            :path     => path
-          )
-        end
-      end
-    end
-  end
-end