Class: Fog::Storage::Rackspace::Real

Inherits:
Rackspace::Service show all
Includes:
Common
Defined in:
lib/fog/rackspace/storage.rb,
lib/fog/rackspace/requests/storage/get_object.rb,
lib/fog/rackspace/requests/storage/put_object.rb,
lib/fog/rackspace/requests/storage/copy_object.rb,
lib/fog/rackspace/requests/storage/head_object.rb,
lib/fog/rackspace/requests/storage/put_container.rb,
lib/fog/rackspace/requests/storage/delete_object.rb,
lib/fog/rackspace/requests/storage/get_container.rb,
lib/fog/rackspace/requests/storage/get_containers.rb,
lib/fog/rackspace/requests/storage/head_container.rb,
lib/fog/rackspace/requests/storage/extract_archive.rb,
lib/fog/rackspace/requests/storage/head_containers.rb,
lib/fog/rackspace/requests/storage/delete_container.rb,
lib/fog/rackspace/requests/storage/put_object_manifest.rb,
lib/fog/rackspace/requests/storage/get_object_http_url.rb,
lib/fog/rackspace/requests/storage/get_object_https_url.rb,
lib/fog/rackspace/requests/storage/delete_multiple_objects.rb,
lib/fog/rackspace/requests/storage/put_static_obj_manifest.rb,
lib/fog/rackspace/requests/storage/put_dynamic_obj_manifest.rb,
lib/fog/rackspace/requests/storage/post_set_meta_temp_url_key.rb,
lib/fog/rackspace/requests/storage/delete_static_large_object.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Common

#account, #apply_options, #authenticate, #cdn, #endpoint_uri, #get_object_http_url, #get_object_https_url, #put_object_manifest, #region, #request_id_header, #service_name, #service_net?

Methods inherited from Rackspace::Service

#authenticate, #endpoint_uri, #region, #request_without_retry, #service_name, #service_net?

Constructor Details

#initialize(options = {}) ⇒ Real

Returns a new instance of Real



422
423
424
425
426
427
428
429
# File 'lib/fog/rackspace/storage.rb', line 422

def initialize(options={})
  apply_options(options)

  authenticate
  @persistent = options[:persistent] || false
  Excon.defaults[:ssl_verify_peer] = false if service_net?
  @connection = Fog::Core::Connection.new(endpoint_uri.to_s, @persistent, @connection_options)
end

Instance Attribute Details

#rackspace_cdn_sslObject (readonly)

Returns the value of attribute rackspace_cdn_ssl



420
421
422
# File 'lib/fog/rackspace/storage.rb', line 420

def rackspace_cdn_ssl
  @rackspace_cdn_ssl
end

Instance Method Details

#copy_object(source_container_name, source_object_name, target_container_name, target_object_name, options = {}) ⇒ Object

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

Raises:



17
18
19
20
21
22
23
24
25
# File 'lib/fog/rackspace/requests/storage/copy_object.rb', line 17

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::Rackspace.escape(target_container_name)}/#{Fog::Rackspace.escape(target_object_name)}"
  })
end

#delete_container(name) ⇒ Object

Delete an existing container

Parameters

  • name<~String> - Name of container to delete

Raises:



13
14
15
16
17
18
19
# File 'lib/fog/rackspace/requests/storage/delete_container.rb', line 13

def delete_container(name)
  request(
    :expects  => 204,
    :method   => 'DELETE',
    :path     => Fog::Rackspace.escape(name)
  )
end

#delete_multiple_objects(container, object_names, options = {}) ⇒ Excon::Response

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.

Examples:

Delete objects from a container

object_names = ['object', 'another/object']
conn.delete_multiple_objects('my_container', object_names)

Delete objects from multiple containers

object_names = ['container_a/object', 'container_b/object']
conn.delete_multiple_objects(nil, object_names)

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)

Parameters:

  • container (String, nil)

    Name of container.

  • object_names (Array<String>)

    Object names to be deleted.

  • options (Hash) (defaults to: {})

    Additional request headers.

Returns:

  • (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”.

Raises:

See Also:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/fog/rackspace/requests/storage/delete_multiple_objects.rb', line 53

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_object(container, object) ⇒ Object

Delete an existing object

Parameters

  • container<~String> - Name of container to delete

  • object<~String> - Name of object to delete

Raises:



14
15
16
17
18
19
20
# File 'lib/fog/rackspace/requests/storage/delete_object.rb', line 14

def delete_object(container, object)
  request(
    :expects  => 204,
    :method   => 'DELETE',
    :path     => "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}"
  )
end

#delete_static_large_object(container, object, options = {}) ⇒ Excon::Response

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.

Parameters:

  • container (String)

    Name of container.

  • object (String)

    Name of the SLO manifest object.

  • options (Hash) (defaults to: {})

    Additional request headers.

Returns:

  • (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.

Raises:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/fog/rackspace/requests/storage/delete_static_large_object.rb', line 32

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::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}",
    :query    => { 'multipart-manifest' => 'delete' }
  }, false)
  response.body = Fog::JSON.decode(response.body)
  response
end

#extract_archive(container, data, archive_format) ⇒ Object

Raises:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/fog/rackspace/requests/storage/extract_archive.rb', line 18

def extract_archive(container, data, archive_format)
  data = Fog::Storage.parse_data(data)
  headers = data[:headers]
  headers["Content-Type"] = ""
  params = { :body => data[:body], :query => {"extract-archive" => archive_format} }

  params.merge!(
    :expects    => 200,
    :idempotent => true,
    :headers    => headers,
    :method     => 'PUT',
    :path       => "#{Fog::Rackspace.escape(container.to_s)}"
  )

  request(params)
end

#get_container(container, options = {}) ⇒ Object

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

Raises:



34
35
36
37
38
39
40
41
42
# File 'lib/fog/rackspace/requests/storage/get_container.rb', line 34

def get_container(container, options = {})
  options = options.reject {|key, value| value.nil?}
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => Fog::Rackspace.escape(container),
    :query    => {'format' => 'json'}.merge!(options)
  )
end

#get_containers(options = {}) ⇒ Object

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

Raises:



23
24
25
26
27
28
29
30
31
# File 'lib/fog/rackspace/requests/storage/get_containers.rb', line 23

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_object(container, object, &block) ⇒ Object

Get details for object

Parameters

  • container<~String> - Name of container to look in

  • object<~String> - Name of object to look for

Raises:



14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'lib/fog/rackspace/requests/storage/get_object.rb', line 14

def get_object(container, object, &block)
  params = {
    :expects  => 200,
    :method   => 'GET',
    :path     => "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}"
  }

  if block_given?
    params[:response_block] = block
  end

  request(params, false)
end

#head_container(container) ⇒ Object

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

Raises:



19
20
21
22
23
24
25
26
# File 'lib/fog/rackspace/requests/storage/head_container.rb', line 19

def head_container(container)
  request(
    :expects  => 204,
    :method   => 'HEAD',
    :path     => Fog::Rackspace.escape(container),
    :query    => {'format' => 'json'}
  )
end

#head_containersObject

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

Raises:



16
17
18
19
20
21
22
23
# File 'lib/fog/rackspace/requests/storage/head_containers.rb', line 16

def head_containers
  request(
    :expects  => 204,
    :method   => 'HEAD',
    :path     => '',
    :query    => {'format' => 'json'}
  )
end

#head_object(container, object) ⇒ Object

Get headers for object

Parameters

  • container<~String> - Name of container to look in

  • object<~String> - Name of object to look for

Raises:



14
15
16
17
18
19
20
# File 'lib/fog/rackspace/requests/storage/head_object.rb', line 14

def head_object(container, object)
  request({
    :expects  => 200,
    :method   => 'HEAD',
    :path     => "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}"
  }, false)
end

#post_set_meta_temp_url_key(key) ⇒ Object

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 :rackspace_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

docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Account_Metadata-d1a4460.html

Raises:



26
27
28
29
30
31
32
# File 'lib/fog/rackspace/requests/storage/post_set_meta_temp_url_key.rb', line 26

def post_set_meta_temp_url_key(key)
  request(
    :expects  => [201, 202, 204],
    :method   => 'POST',
    :headers  => {'X-Account-Meta-Temp-Url-Key' => key}
  )
end

#put_container(name, options = {}) ⇒ Object

Create a new container

Parameters

  • name<~String> - Name for container, should be < 256 bytes and must not contain '/'

Raises:



13
14
15
16
17
18
19
20
# File 'lib/fog/rackspace/requests/storage/put_container.rb', line 13

def put_container(name, options={})
  request(
    :expects  => [201, 202],
    :method   => 'PUT',
    :headers => options,
    :path     => Fog::Rackspace.escape(name)
  )
end

#put_dynamic_obj_manifest(container, object, options = {}) ⇒ Object

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 Rackspace.escape).

Parameters:

  • container (String)

    Name for container where object will be stored. Should be < 256 bytes and must not contain '/'

  • object (String)

    Name for manifest object.

  • options (Hash) (defaults to: {})

    Config headers for object.

Options Hash (options):

  • 'X-Object-Manifest' (String) — default: "container/object"

    “<container>/<prefix>” for segment objects.

Raises:

See Also:



29
30
31
32
33
34
35
36
37
38
# File 'lib/fog/rackspace/requests/storage/put_dynamic_obj_manifest.rb', line 29

def put_dynamic_obj_manifest(container, object, options = {})
  path = "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}"
  headers = {'X-Object-Manifest' => path}.merge(options)
  request(
    :expects  => 201,
    :headers  => headers,
    :method   => 'PUT',
    :path     => path
  )
end

#put_object(container, object, data, options = {}, &block) ⇒ Object

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.

Parameters

  • 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

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/fog/rackspace/requests/storage/put_object.rb', line 21

def put_object(container, object, data, options = {}, &block)
  data = Fog::Storage.parse_data(data)
  headers = data[:headers].merge!(options)

  params = block_given? ? { :request_block => block } : { :body => data[:body] }

  params.merge!(
    :expects    => 201,
    :idempotent => !params[:request_block],
    :headers    => headers,
    :method     => 'PUT',
    :path       => "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}"
  )

  request(params)
end

#put_static_obj_manifest(container, object, segments, options = {}) ⇒ Object

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.

Examples:

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)

Parameters:

  • container (String)

    Name for container where object will be stored. Should be < 256 bytes and must not contain '/'

  • object (String)

    Name for manifest object.

  • segments (Array<Hash>)

    Segment data for the object.

  • options (Hash) (defaults to: {})

    Config headers for object.

Raises:

See Also:



43
44
45
46
47
48
49
50
51
52
# File 'lib/fog/rackspace/requests/storage/put_static_obj_manifest.rb', line 43

def put_static_obj_manifest(container, object, segments, options = {})
  request(
    :expects  => 201,
    :method   => 'PUT',
    :headers  => options,
    :body     => Fog::JSON.encode(segments),
    :path     => "#{Fog::Rackspace.escape(container)}/#{Fog::Rackspace.escape(object)}",
    :query    => { 'multipart-manifest' => 'put' }
  )
end

#reloadObject

Resets presistent service connections



439
440
441
# File 'lib/fog/rackspace/storage.rb', line 439

def reload
  @connection.reset
end

#request(params, parse_json = true) ⇒ Object



443
444
445
446
447
448
449
450
451
452
453
# File 'lib/fog/rackspace/storage.rb', line 443

def request(params, parse_json = true)
  super
rescue Excon::Errors::NotFound => error
  raise NotFound.slurp(error, self)
rescue Excon::Errors::BadRequest => error
  raise BadRequest.slurp(error, self)
rescue Excon::Errors::InternalServerError => error
  raise InternalServerError.slurp(error, self)
rescue Excon::Errors::HTTPStatusError => error
  raise ServiceError.slurp(error, self)
end

#ssl?Boolean

Using SSL?

Returns:

  • (Boolean)

    return true if service is returning SSL-Secured URLs in public_url methods

See Also:



434
435
436
# File 'lib/fog/rackspace/storage.rb', line 434

def ssl?
  !!rackspace_cdn_ssl
end