fog-openstack 0.3.1 → 0.3.2

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

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

@@ -0,0 +1,41 @@
+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/storage/openstack/requests/get_container.rb

@@ -0,0 +1,42 @@
+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/storage/openstack/requests/get_containers.rb

@@ -0,0 +1,31 @@
+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/storage/openstack/requests/get_object.rb

@@ -0,0 +1,27 @@
+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/storage/openstack/requests/get_object_http_url.rb

@@ -0,0 +1,21 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Get an expiring object http 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
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~String> - url for object
+        def get_object_http_url(container, object, expires, options = {})
+          create_temp_url(container, object, expires, "GET", {:port => 80}.merge(options).merge(:scheme => "http"))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+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] || @openstack_management_uri.scheme
+          host = options[:host] || @openstack_management_uri.host
+          port = options[:port] || @openstack_management_uri.port
+
+          # POST not allowed
+          allowed_methods = %w(GET PUT HEAD)
+          unless allowed_methods.include?(method)
+            raise ArgumentError, "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.to_s)
+          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 do |c|
+            c.to_s(16)
+          end.map do |h|
+            h.size == 1 ? "0#{h}" : h
+          end.join
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+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/storage/openstack/requests/head_containers.rb

@@ -0,0 +1,23 @@
+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/storage/openstack/requests/head_object.rb

@@ -0,0 +1,21 @@
+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/storage/openstack/requests/post_object.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Update object metadata
+        #
+        # ==== Parameters
+        # * container<~String> - Name for container, should be < 256 bytes and must not contain '/'
+        # * object<~String> - Name for object
+        # * headers<~Hash> - metadata headers for object. Defaults to {}.
+        #
+        def post_object(container, object, headers = {})
+
+          params = {
+            :expects    => 202,
+            :headers    => headers,
+            :method     => 'POST',
+            :path       => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          }
+
+          request(params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+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/storage/openstack/requests/public_url.rb

@@ -0,0 +1,35 @@
+module Fog
+  module Storage
+    class OpenStack
+      module PublicUrl
+        # 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
+          "#{@openstack_management_uri.scheme}://#{@openstack_management_uri.host}:"\
+          "#{@openstack_management_uri.port}#{@path}"
+        end
+      end
+
+      class Real
+        include PublicUrl
+      end
+
+      class Mock
+        include PublicUrl
+      end
+    end
+  end
+end