RubyGems - fog-softlayer - Versions diffs - 0.0.5 → 0.0.7 - Mend

fog-softlayer 0.0.5 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (48) hide show

checksums.yaml +8 -8
data/.travis.yml +37 -0
data/CONTRIBUTING.md +30 -0
data/README.md +8 -5
data/docs/cla-corporate.md +133 -0
data/docs/cla-individual.md +84 -0
data/docs/fog-softlayer-CCLA.pdf +0 -0
data/docs/fog-softlayer-CLA.pdf +0 -0
data/examples/storage.md +107 -0
data/fog-softlayer.gemspec +1 -0
data/gemfiles/Gemfile-edge +14 -0
data/gemfiles/Gemfile-ruby-1.8.7 +14 -0
data/lib/fog/softlayer.rb +1 -0
data/lib/fog/softlayer/compute.rb +1 -1
data/lib/fog/softlayer/compute/shared.rb +1 -1
data/lib/fog/softlayer/core.rb +17 -1
data/lib/fog/softlayer/models/storage/directories.rb +40 -0
data/lib/fog/softlayer/models/storage/directory.rb +50 -0
data/lib/fog/softlayer/models/storage/file.rb +166 -0
data/lib/fog/softlayer/models/storage/files.rb +99 -0
data/lib/fog/softlayer/requests/storage/copy_object.rb +42 -0
data/lib/fog/softlayer/requests/storage/delete_container.rb +38 -0
data/lib/fog/softlayer/requests/storage/delete_multiple_objects.rb +67 -0
data/lib/fog/softlayer/requests/storage/delete_object.rb +40 -0
data/lib/fog/softlayer/requests/storage/delete_static_large_object.rb +43 -0
data/lib/fog/softlayer/requests/storage/get_container.rb +68 -0
data/lib/fog/softlayer/requests/storage/get_containers.rb +51 -0
data/lib/fog/softlayer/requests/storage/get_object.rb +45 -0
data/lib/fog/softlayer/requests/storage/get_object_https_url.rb +88 -0
data/lib/fog/softlayer/requests/storage/head_container.rb +28 -0
data/lib/fog/softlayer/requests/storage/head_containers.rb +25 -0
data/lib/fog/softlayer/requests/storage/head_object.rb +23 -0
data/lib/fog/softlayer/requests/storage/post_set_meta_temp_url_key.rb +37 -0
data/lib/fog/softlayer/requests/storage/put_container.rb +32 -0
data/lib/fog/softlayer/requests/storage/put_dynamic_obj_manifest.rb +43 -0
data/lib/fog/softlayer/requests/storage/put_object.rb +61 -0
data/lib/fog/softlayer/requests/storage/put_object_manifest.rb +16 -0
data/lib/fog/softlayer/requests/storage/put_static_obj_manifest.rb +57 -0
data/lib/fog/softlayer/storage.rb +283 -0
data/lib/fog/softlayer/version.rb +1 -1
data/tests/helper.rb +0 -29
data/tests/helpers/mock_helper.rb +4 -98
data/tests/softlayer/models/storage/directory_tests.rb +49 -0
data/tests/softlayer/models/storage/file_tests.rb +56 -0
data/tests/softlayer/requests/storage/auth_tests.rb +17 -0
data/tests/softlayer/requests/storage/container_tests.rb +52 -0
data/tests/softlayer/requests/storage/object_tests.rb +68 -0
metadata +53 -2

data/lib/fog/softlayer/requests/storage/copy_object.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def copy_object(source_container, source_object, target_container, target_object, options={})
+          response = Excon::Response.new
+          if @containers[source_container].nil? || @containers[source_container][source_object].nil? || @containers[target_container].nil?
+            response.body = '<html><h1>Not Found</h1><p>The resource could not be found.</p></html>'
+            response.status = 404
+          else # Success
+            @containers[target_container][target_object] = @containers[source_container][source_object]
+            response.body = ''
+            response.status = 201
+          end
+          response
+        end
+      end
+      class Real
+        # Copy object
+        #
+        # ==== Parameters
+        # * source_container_name<~String> - Name of source bucket
+        # * source_object_name<~String> - Name of source object
+        # * target_container_name<~String> - Name of bucket to create copy in
+        # * target_object_name<~String> - Name for new copy of object
+        # * options<~Hash> - Additional headers
+        def copy_object(source_container, source_object, target_container, target_object, options={})
+          headers = { 'X-Copy-From' => "/#{source_container}/#{source_object}" }.merge(options)
+          request({
+            :expects  => 201,
+            :headers  => headers,
+            :method   => 'PUT',
+            :path     => "#{Fog::Softlayer.escape(target_container)}/#{Fog::Softlayer.escape(target_object)}"
+          })
+        end
+      end
+    end
+  end
+end

data/lib/fog/softlayer/requests/storage/delete_container.rb ADDED Viewed

@@ -0,0 +1,38 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def delete_container(name)
+          response = Excon::Response.new
+          if @containers[name].nil? # Container doesn't exist.
+            response.body = '<html><h1>Not Found</h1><p>The resource could not be found.</p></html>'
+            response.status = 404
+          elsif @containers[name].length > 0  # Container not empty
+            response.body = '<html><h1>Conflict</h1><p>There was a conflict when trying to complete your request.</p></html>'
+            response.status = 409
+          else # Success
+            response.body = ''
+            response.status = 204
+          end
+          response
+        end
+      end
+      class Real
+        # Delete an existing container
+        #
+        # ==== Parameters
+        # * name<~String> - Name of container to delete
+        #
+        def delete_container(name)
+          request(
+            :expects  => 204,
+            :method   => 'DELETE',
+            :path     => Fog::Softlayer.escape(name)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/softlayer/requests/storage/delete_multiple_objects.rb ADDED Viewed

@@ -0,0 +1,67 @@
+module Fog
+  module Storage
+    class Softlayer
+      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/softlayer/requests/storage/delete_object.rb ADDED Viewed

@@ -0,0 +1,40 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def delete_object(container, object)
+          response = Excon::Response.new
+          if @containers[container].nil? || @containers[container][object].nil? # Container or object doesn't exist.
+            response.body = '<html><h1>Not Found</h1><p>The resource could not be found.</p></html>'
+            response.status = 404
+          else # Success
+            response.body = ''
+            response.status = 204
+          end
+          response
+        end
+      end
+      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::Softlayer.escape(container)}/#{Fog::Softlayer.escape(object)}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/softlayer/requests/storage/delete_static_large_object.rb ADDED Viewed

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

data/lib/fog/softlayer/requests/storage/get_container.rb ADDED Viewed

@@ -0,0 +1,68 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def get_container(container, options = {})
+          if @containers[container]
+            response = Excon::Response.new
+            response.body = @containers[container].map do |name, object|
+              {
+                  'hash' => object.respond_to?(:to_s) ? Digest::MD5.hexdigest(object.to_s) : 'e4d909c290d0fb1ca068ffaddf22cbd0',
+                  'last_modified' => Time.now,
+                  'bytes' => Memory.analyze(container).bytes,
+                  'content/type' => 'application/json'
+              }
+            end
+            response.status = 200
+            response
+          else
+            response = Excon::Response.new
+            response.body = '<html><h1>Not Found</h1><p>The resource could not be found.</p></html>'
+            response.status = 404
+            response.headers = {"Content-Length"=>"70", "Content-Type"=>"text/html; charset=UTF-8", "X-Trans-Id"=>"abcdefghijklmnopqrstuvwx-0123456789", "Date"=>Time.now}
+            response
+          end
+        end
+      end
+      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::Softlayer.escape(container),
+            :query    => {'format' => 'json'}.merge!(options)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/softlayer/requests/storage/get_containers.rb ADDED Viewed

@@ -0,0 +1,51 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def get_containers(options = {})
+          response = Excon::Response.new
+          response.body = _format_containers(@containers)
+          response.status = 200
+          response
+        end
+        private
+        def _format_containers(containers)
+          containers.map do |name, container|
+            meta = Memory.analyze(container)
+            {'count' => container.length, 'bytes' => meta.bytes, 'name' => name}
+          end
+        end
+      end
+      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/softlayer/requests/storage/get_object.rb ADDED Viewed

@@ -0,0 +1,45 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def get_object(container, object, &block)
+          if @containers[container] && @containers[container][object]
+            response = Excon::Response.new
+            response.body = @containers[container][object]
+            response.status = 200
+            response
+          else
+            response = Excon::Response.new
+            response.body = '<html><h1>Not Found</h1><p>The resource could not be found.</p></html>'
+            response.status = 404
+            response.headers = {"Content-Length"=>"70", "Content-Type"=>"text/html; charset=UTF-8", "X-Trans-Id"=>"abcdefghijklmnopqrstuvwx-0123456789", "Date"=>Time.now}
+            response
+          end
+        end
+      end
+      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::Softlayer.escape(container)}/#{Fog::Softlayer.escape(object)}"
+          }
+          if block_given?
+            params[:response_block] = block
+          end
+          request(params, false)
+        end
+      end
+    end
+  end
+end

data/lib/fog/softlayer/requests/storage/get_object_https_url.rb ADDED Viewed

@@ -0,0 +1,88 @@
+module Fog
+  module Storage
+    class Softlayer
+      class Mock
+        def get_object_https_url(container, object, expires, options = {})
+          "https://cluster.objectstorage.softlayer.net:443/v1/AUTH_abcdefghijklmnopqrstuvwxyz/#{container}/#{object}?temp_url_sig=1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a&temp_url_expires=1111111111111"
+        end
+      end
+      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
+        #
+        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 :temp_url_key option" if @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::Softlayer.escape(container)}/#{Fog::Softlayer.escape(object,"/")}"
+          object_path_unescaped = "#{@path}/#{Fog::Softlayer.escape(container)}/#{object}"
+          string_to_sign = "#{method}\n#{expires}\n#{object_path_unescaped}"
+          hmac = Fog::HMAC.new('sha1', @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