fog-brightbox 0.3.0 → 0.4.0

data/lib/fog/brightbox/requests/storage/delete_multiple_objects.rb

@@ -0,0 +1,67 @@
+module Fog
+  module Storage
+    class Brightbox
+      class Real
+
+        # Deletes multiple objects or containers with a single request.
+        #
+        # To delete objects from a single container, +container+ may be provided
+        # and +object_names+ should be an Array of object names within the container.
+        #
+        # To delete objects from multiple containers or delete containers,
+        # +container+ should be +nil+ and all +object_names+ should be prefixed with a container name.
+        #
+        # Containers must be empty when deleted. +object_names+ are processed in the order given,
+        # so objects within a container should be listed first to empty the container.
+        #
+        # Up to 10,000 objects may be deleted in a single request.
+        # The server will respond with +200 OK+ for all requests.
+        # +response.body+ must be inspected for actual results.
+        #
+        # @example Delete objects from a container
+        #   object_names = ['object', 'another/object']
+        #   conn.delete_multiple_objects('my_container', object_names)
+        #
+        # @example Delete objects from multiple containers
+        #   object_names = ['container_a/object', 'container_b/object']
+        #   conn.delete_multiple_objects(nil, object_names)
+        #
+        # @example Delete a container and all it's objects
+        #   object_names = ['my_container/object_a', 'my_container/object_b', 'my_container']
+        #   conn.delete_multiple_objects(nil, object_names)
+        #
+        # @param container [String,nil] Name of container.
+        # @param object_names [Array<String>] Object names to be deleted.
+        # @param options [Hash] Additional request headers.
+        #
+        # @return [Excon::Response]
+        #   * body [Hash] - Results of the operation.
+        #     * "Number Not Found" [Integer] - Number of missing objects or containers.
+        #     * "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 objects or containers deleted.
+        #     * "Response Body" [String] - Response body for "Response Status".
+        def delete_multiple_objects(container, object_names, options = {})
+          body = object_names.map do |name|
+            object_name = container ? "#{ container }/#{ name }" : name
+            URI.encode(object_name)
+          end.join("\n")
+
+          response = request({
+            :expects  => 200,
+            :method   => 'DELETE',
+            :headers  => options.merge('Content-Type' => 'text/plain',
+                                       'Accept' => 'application/json'),
+            :body     => body,
+            :query    => { 'bulk-delete' => true }
+          }, false)
+          response.body = Fog::JSON.decode(response.body)
+          response
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Fog
+  module Storage
+    class Brightbox
+      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::Storage::Brightbox.escape(container)}/#{Fog::Storage::Brightbox.escape(object)}"
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/storage/delete_static_large_object.rb

@@ -0,0 +1,43 @@
+module Fog
+  module Storage
+    class Brightbox
+      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.brightbox.org/api/brightbox-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::Storage::Brightbox.escape(container)}/#{Fog::Storage::Brightbox.escape(object)}",
+            :query    => { 'multipart-manifest' => 'delete' }
+          }, false)
+          response.body = Fog::JSON.decode(response.body)
+          response
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fog
+  module Storage
+    class Brightbox
+      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::Storage::Brightbox.escape(container),
+            :query    => {'format' => 'json'}.merge!(options)
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Fog
+  module Storage
+    class Brightbox
+      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/brightbox/requests/storage/get_object.rb

@@ -0,0 +1,29 @@
+module Fog
+  module Storage
+    class Brightbox
+      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::Storage::Brightbox.escape(container)}/#{Fog::Storage::Brightbox.escape(object)}"
+          }
+
+          if block_given?
+            params[:response_block] = block
+          end
+
+          request(params, false)
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/storage/get_object_http_url.rb

@@ -0,0 +1,21 @@
+module Fog
+  module Storage
+    class Brightbox
+      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", options.merge(:scheme => "http"))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+module Fog
+  module Storage
+    class Brightbox
+
+      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", 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)
+        # * scheme<~String> - The scheme to use (http, https)
+        # * options<~Hash> - An optional options hash
+        #
+        # ==== 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 :brightbox_temp_url_key option" if @brightbox_temp_url_key.nil?
+
+          scheme = options[:scheme] || @scheme
+
+          # 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::Storage::Brightbox.escape(container)}/#{Fog::Storage::Brightbox.escape(object,"/")}"
+          object_path_unescaped = "#{@path}/#{Fog::Storage::Brightbox.escape(container)}/#{object}"
+          string_to_sign = "#{method}\n#{expires}\n#{object_path_unescaped}"
+
+          hmac = Fog::HMAC.new('sha1', @brightbox_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 => URI.encode_www_form(
+              :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/brightbox/requests/storage/head_container.rb

@@ -0,0 +1,28 @@
+module Fog
+  module Storage
+    class Brightbox
+      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::Storage::Brightbox.escape(container),
+            :query    => {'format' => 'json'}
+          )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fog
+  module Storage
+    class Brightbox
+      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/brightbox/requests/storage/head_object.rb

@@ -0,0 +1,23 @@
+module Fog
+  module Storage
+    class Brightbox
+      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::Storage::Brightbox.escape(container)}/#{Fog::Storage::Brightbox.escape(object)}"
+          }, false)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Fog
+  module Storage
+    class Brightbox
+
+      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 :brightbox_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