# File lib/fog/openstack/storage.rb, line 76 def initialize(options={}) @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] || {} @openstack_temp_url_key = options[:openstack_temp_url_key] authenticate @persistent = options[:persistent] || false @connection = Fog::Core::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options) end
Change the current account while re-using the auth token.
This is usefull when you have an admin role and you’re able to HEAD other user accounts, set quotas, list files, etc.
For example:
# List current user account details service = Fog::Storage[:openstack] service.request :method => 'HEAD'
Would return something like:
Account: AUTH_1234 Date: Tue, 05 Mar 2013 16:50:52 GMT X-Account-Bytes-Used: 0 (0.00 Bytes) X-Account-Container-Count: 0 X-Account-Object-Count: 0
Now let’s change the account
service.change_account('AUTH_3333') service.request :method => 'HEAD'
Would return something like:
Account: AUTH_3333 Date: Tue, 05 Mar 2013 16:51:53 GMT X-Account-Bytes-Used: 23423433 X-Account-Container-Count: 2 X-Account-Object-Count: 10
If we wan’t to go back to our original admin account:
service.reset_account_name
# File lib/fog/openstack/storage.rb, line 134 def change_account(account) @original_path ||= @path version_string = @path.split('/')[1] @path = "/#{version_string}/#{account}" end
Copy object
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
# File lib/fog/openstack/requests/storage/copy_object.rb, line 13 def copy_object(source_container_name, source_object_name, target_container_name, target_object_name, options={}) headers = { 'X-Copy-From' => "/#{source_container_name}/#{source_object_name}" }.merge(options) request({ :expects => 201, :headers => headers, :method => 'PUT', :path => "#{Fog::OpenStack.escape(target_container_name)}/#{Fog::OpenStack.escape(target_object_name)}" }) end
creates a temporary url
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
response<~Excon::Response>:
body<~String> - url for object
docs.rackspace.com/files/api/v1/cf-devguide/content/Create_TempURL-d1a444.html
# File lib/fog/openstack/requests/storage/get_object_https_url.rb, line 35 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 # POST not allowed allowed_methods = %{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 => URI.encode_www_form( :temp_url_sig => sig, :temp_url_expires => expires ) } URI::Generic.build(temp_url_options).to_s end
Delete an existing container
name<~String> - Name of container to delete
# File lib/fog/openstack/requests/storage/delete_container.rb, line 10 def delete_container(name) request( :expects => 204, :method => 'DELETE', :path => Fog::OpenStack.escape(name) ) end
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".
# File lib/fog/openstack/requests/storage/delete_multiple_objects.rb, line 45 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
Delete an existing object
container<~String> - Name of container to delete
object<~String> - Name of object to delete
# File lib/fog/openstack/requests/storage/delete_object.rb, line 11 def delete_object(container, object) request( :expects => 204, :method => 'DELETE', :path => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}" ) end
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 docs.openstack.org/api/openstack-object-storage/1.0/content/static-large-objects.html
# File lib/fog/openstack/requests/storage/delete_static_large_object.rb, line 26 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
Get details for container and total bytes stored
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
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
# File lib/fog/openstack/requests/storage/get_container.rb, line 30 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
List existing storage containers
options<~Hash>:
‘limit’<~Integer> - Upper limit to number of results returned
‘marker’<~String> - Only return objects with name greater than this value
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
# File lib/fog/openstack/requests/storage/get_containers.rb, line 19 def get_containers(options = {}) options = options.reject {|key, value| value.nil?} request( :expects => [200, 204], :method => 'GET', :path => '', :query => {'format' => 'json'}.merge!(options) ) end
Get details for object
container<~String> - Name of container to look in
object<~String> - Name of object to look for
# File lib/fog/openstack/requests/storage/get_object.rb, line 11 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
Get an expiring object http url
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
response<~Excon::Response>:
body<~String> - url for object
# File lib/fog/openstack/requests/storage/get_object_http_url.rb, line 15 def get_object_http_url(container, object, expires, options = {}) create_temp_url(container, object, expires, "GET", options.merge(:scheme => "http")) end
Get an expiring object https url from Cloud Files
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
response<~Excon::Response>:
body<~String> - url for object
# File lib/fog/openstack/requests/storage/get_object_https_url.rb, line 15 def get_object_https_url(container, object, expires, options = {}) create_temp_url(container, object, expires, "GET", options.merge(:scheme => "https")) end
List number of objects and total bytes stored
container<~String> - Name of container to retrieve info for
response<~Excon::Response>:
headers<~Hash>:
‘X-Container-Object-Count’<~String> - Count of containers
‘X-Container-Bytes-Used’<~String> - Bytes used
# File lib/fog/openstack/requests/storage/head_container.rb, line 15 def head_container(container) request( :expects => 204, :method => 'HEAD', :path => Fog::OpenStack.escape(container), :query => {'format' => 'json'} ) end
List number of containers and total bytes stored
response<~Excon::Response>:
headers<~Hash>:
‘X-Account-Container-Count’<~String> - Count of containers
‘X-Account-Bytes-Used’<~String> - Bytes used
# File lib/fog/openstack/requests/storage/head_containers.rb, line 12 def head_containers request( :expects => 204, :method => 'HEAD', :path => '', :query => {'format' => 'json'} ) end
Get headers for object
container<~String> - Name of container to look in
object<~String> - Name of object to look for
# File lib/fog/openstack/requests/storage/head_object.rb, line 11 def head_object(container, object) request({ :expects => 200, :method => 'HEAD', :path => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}" }, false) end
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.
key<~String> - The new Temp URL Key
response<~Excon::Response>
docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Account_Metadata-d1a4460.html
# File lib/fog/openstack/requests/storage/post_set_meta_temp_url_key.rb, line 23 def post_set_meta_temp_url_key(key) request( :expects => [201, 202, 204], :method => 'POST', :headers => {'X-Account-Meta-Temp-Url-Key' => key} ) end
Create a new container
name<~String> - Name for container, should be < 256 bytes and must not contain ‘/’
# File lib/fog/openstack/requests/storage/put_container.rb, line 10 def put_container(name) request( :expects => [201, 202], :method => 'PUT', :path => Fog::OpenStack.escape(name) ) end
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 docs.openstack.org/api/openstack-object-storage/1.0/content/dynamic-large-object-creation.html
# File lib/fog/openstack/requests/storage/put_dynamic_obj_manifest.rb, line 28 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
Create a new object
When passed a block, it will make a chunked request, calling the block for chunks until it returns an empty string. In this case the data parameter is ignored.
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 {}.
block<~Proc> - chunker
# File lib/fog/openstack/requests/storage/put_object.rb, line 18 def put_object(container, object, data, options = {}, &block) if block_given? params = { :request_block => block } headers = options else data = Fog::Storage.parse_data(data) headers = data[:headers].merge!(options) params = { :body => data[:body] } end params.merge!( :expects => 201, :idempotent => !params[:request_block], :headers => headers, :method => 'PUT', :path => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}" ) request(params) end
Create a new dynamic large object manifest
This is an alias for {put_dynamic_obj_manifest} for backward compatibility.
# File lib/fog/openstack/requests/storage/put_object_manifest.rb, line 8 def put_object_manifest(container, object, options = {}) put_dynamic_obj_manifest(container, object, options) end
Create a new static large object manifest.
A static large object is similar to a dynamic large object. Whereas a GET for a dynamic large object manifest will stream segments based on the manifest’s X-Object-Manifest object name prefix, a static large object manifest streams segments which are defined by the user within the manifest. Information about each segment is provided in segments as an Array of Hash objects, ordered in the sequence which the segments should be streamed.
When the SLO manifest is received, each segment’s etag and size_bytes will be verified. The etag for each segment is returned in the response to {put_object}, but may also be calculated. e.g. +Digest::MD5.hexdigest(segment_data)+
The maximum number of segments for a static large object is 1000, and all segments (except the last) must be at least 1 MiB in size. Unlike a dynamic large object, segments are not required to be in the same container.
@example
segments = [ { :path => 'segments_container/first_segment', :etag => 'md5 for first_segment', :size_bytes => 'byte size of first_segment' }, { :path => 'segments_container/second_segment', :etag => 'md5 for second_segment', :size_bytes => 'byte size of second_segment' } ] put_static_obj_manifest('my_container', 'my_large_object', segments)
@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 segments [Array<Hash>] Segment data for the object. @param options [Hash] Config headers for object.
@raise [Fog::Storage::OpenStack::NotFound] HTTP 404 @raise [Excon::Errors::BadRequest] HTTP 400 @raise [Excon::Errors::Unauthorized] HTTP 401 @raise [Excon::Errors::HTTPStatusError]
@see docs.openstack.org/api/openstack-object-storage/1.0/content/static-large-objects.html
# File lib/fog/openstack/requests/storage/put_static_obj_manifest.rb, line 42 def put_static_obj_manifest(container, object, segments, options = {}) request( :expects => 201, :method => 'PUT', :headers => options, :body => Fog::JSON.encode(segments), :path => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}", :query => { 'multipart-manifest' => 'put' } ) end
# File lib/fog/openstack/storage.rb, line 94 def reload @connection.reset end
# File lib/fog/openstack/storage.rb, line 144 def request(params, parse_json = true) begin response = @connection.request(params.merge({ :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'X-Auth-Token' => @auth_token }.merge!(params[:headers] || {}), :path => "#{@path}/#{params[:path]}", })) 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.get_header('Content-Type') =~ %{application/json} response.body = Fog::JSON.decode(response.body) end response end
Generated with the Darkfish Rdoc Generator 2.