fog 1.18.0 → 1.19.0

data/lib/fog/openstack/requests/volume/list_volume_types.rb

@@ -0,0 +1,41 @@
+module Fog
+  module Volume
+    class OpenStack
+      class Real
+        def list_volume_types(options={})
+          request(
+            :expects  => 200,
+            :method   => 'GET',
+            :path     => 'types',
+            :query    => options
+          )
+        end
+      end
+
+      class Mock
+        def list_volume_types(options={})
+          response = Excon::Response.new
+          response.status = 200
+          self.data[:volume_types] ||= [
+            {
+              "id" => "1",
+              "name" => "type 1",
+              "extra_specs" => {
+                "volume_backend_name" => "type 1 backend name"
+              }
+            },
+            {
+              "id" => "2",
+              "name" => "type 2",
+              "extra_specs" => {
+                "volume_backend_name" => "type 2 backend name"
+              }
+            }
+          ]
+          response.body = { 'volume_types' => self.data[:volume_types] }
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/openstack/storage.rb

@@ -26,6 +26,7 @@ module Fog
       request :get_container
       request :get_containers
       request :get_object
+      request :get_object_http_url
       request :get_object_https_url
       request :head_container
       request :head_containers
@@ -35,6 +36,7 @@ module Fog
       request :put_object_manifest
       request :put_dynamic_obj_manifest
       request :put_static_obj_manifest
+      request :post_set_meta_temp_url_key
 
       class Mock
 

data/lib/fog/openstack/volume.rb

@@ -9,13 +9,15 @@ module Fog
                  :openstack_service_type, :openstack_service_name, :openstack_tenant,
                  :openstack_api_key, :openstack_username,
                  :current_user, :current_tenant,
-                 :openstack_endpoint_type
+                 :openstack_endpoint_type, :openstack_region
 
       model_path 'fog/openstack/models/volume'
 
       model       :volume
       collection  :volumes
 
+      model       :volume_type
+      collection  :volume_types
 
       request_path 'fog/openstack/requests/volume'
 
@@ -25,6 +27,9 @@ module Fog
       request :get_volume_details
       request :delete_volume
 
+      request :list_volume_types
+      request :get_volume_type_details
+
       request :create_volume_snapshot
       request :list_snapshots
       request :get_snapshot_details
@@ -56,7 +61,6 @@ module Fog
         end
 
         def initialize(options={})
-          require 'multi_json'
           @openstack_username = options[:openstack_username]
           @openstack_tenant   = options[:openstack_tenant]
           @openstack_auth_uri = URI.parse(options[:openstack_auth_url])
@@ -103,8 +107,6 @@ module Fog
         attr_reader :current_tenant
 
         def initialize(options={})
-          require 'multi_json'
-
           @openstack_auth_token = options[:openstack_auth_token]
 
           unless @openstack_auth_token
@@ -123,6 +125,7 @@ module Fog
           @openstack_must_reauthenticate  = false
           @openstack_service_type         = options[:openstack_service_type] || ['volume']
           @openstack_service_name         = options[:openstack_service_name]
+          @openstack_region               = options[:openstack_region]
 
           @openstack_endpoint_type        = options[:openstack_endpoint_type] || 'adminURL'
           @connection_options = options[:connection_options] || {}
@@ -176,7 +179,7 @@ module Fog
             end
           end
           unless response.body.empty?
-            response.body = MultiJson.decode(response.body)
+            response.body = Fog::JSON.decode(response.body)
           end
           response
         end
@@ -186,6 +189,7 @@ module Fog
         def authenticate
           if !@openstack_management_url || @openstack_must_reauthenticate
             options = {
+              :openstack_region   => @openstack_region,
               :openstack_tenant   => @openstack_tenant,
               :openstack_api_key  => @openstack_api_key,
               :openstack_username => @openstack_username,

data/lib/fog/rackspace/compute.rb

@@ -240,10 +240,7 @@ module Fog
 
          def endpoint_uri(service_endpoint_url=nil)
            return @uri if @uri
-
-           @uri = super(@rackspace_endpoint || service_endpoint_url, :rackspace_compute_v1_url)
-           @uri.host = "snet-#{@uri.host}" if service_net?
-           @uri
+           super(@rackspace_endpoint || service_endpoint_url, :rackspace_compute_v1_url)
          end
 
          private

data/lib/fog/rackspace/compute_v2.rb

@@ -1,3 +1,4 @@
+require 'fog/rackspace'
 require 'fog/compute'
 
 module Fog

data/lib/fog/rackspace/docs/auto_scale.md

@@ -1,6 +1,6 @@
 #Auto Scale (AutoScale)
 
-This document explains how to get started using auto scale with Fog. It assumes you have read the [Getting Started with Fog and the Rackspace Open Cloud](getting_started.md) document.
+This document explains how to get started using Auto Scale with Fog. It assumes you have read the [Getting Started with Fog and the Rackspace Open Cloud](getting_started.md) document.
 
 ## Basic Concepts
 
@@ -15,7 +15,7 @@ Auto Scale functions by linking three services:
 
 ## Workflow
 
-A scaling group is monitored by Rackspace Cloud Monitoring. When Monitoring triggers an alarm for high utilization within the Autoscaling group, a webhook is triggered. The webhook calls the auto scale service, which consults a policy in accordance with the webhook. The policy determines how many additional Cloud Servers should be added or removed in accordance with the alarm.
+A scaling group is monitored by Rackspace Cloud Monitoring. When Monitoring triggers an alarm for high utilization within the Autoscaling group, a webhook is triggered. The webhook calls the Auto Scale service, which consults a policy in accordance with the webhook. The policy determines how many additional Cloud Servers should be added or removed in accordance with the alarm.
 
 Alarms may trigger scaling up or scaling down. Scale-down events always remove the oldest server in the group.
 
@@ -43,7 +43,7 @@ If using Ruby 1.9.x execute:
 
 ## Create Service
 
-Next, create a connection to auto scale:
+Next, create a connection to Auto Scale:
 
 Using a US-based account:
 
@@ -68,7 +68,7 @@ To learn more about obtaining cloud credentials refer to the [Getting Started wi
 
 By default `Fog::Rackspace::AutoScale` will authenticate against the US authentication endpoint. You can specify alternative authentication endpoints using the key `:rackspace_auth_url`. Please refer to [Alternate Authentication Endpoints](http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/Endpoints-d1e180.html) for a list of alternative Rackspace authentication endpoints.
 
-Alternative regions are specified using the key `:rackspace_region `. A list of regions available for auto scale can be found by executing the following:
+Alternative regions are specified using the key `:rackspace_region `. A list of regions available for Auto Scale can be found by executing the following:
 
 	identity_service = Fog::Identity({
 		:provider            => 'Rackspace',                     # Rackspace Fog provider
@@ -142,7 +142,7 @@ This returns:
 
 #### Example Request
 
-To request a list of volume types:
+To request a list of Auto Scale groups:
 
 	response = service.list_groups
 
@@ -165,7 +165,7 @@ returns:
 	{"groups_links"=>[], "groups"=>[{"paused"=>false, "desiredCapacity"=>0, "links"=>[{"href"=>"https://ord.autoscale.api.rackspacecloud.com/v1.0/555/groups/b45e6107-26ca-4a93-869d-46bf20005df3/", "rel"=>"self"}], "active"=>[], "pendingCapacity"=>0, "activeCapacity"=>0, "id"=>"b45e6107-26ca-4a93-869d-46bf20005df3", "name"=>"fog-scailing-group"}]}
 
 
-To learn more about auto scale request methods refer to [rdoc](http://rubydoc.info/gems/fog/Fog/Rackspace/AutoScale/Real). To learn more about Excon refer to [Excon GitHub repo](https://github.com/geemus/excon).
+To learn more about Auto Scale request methods refer to [rdoc](http://rubydoc.info/gems/fog/Fog/Rackspace/AutoScale/Real). To learn more about Excon refer to [Excon GitHub repo](https://github.com/geemus/excon).
 
 ### Model Layer
 
@@ -369,7 +369,7 @@ Available options on `group_config` include  `:max_entities`, `:name`, `:cooldow
     group_config.max_entities = 16
     group_config.save
 
-**Note**: If you pass any metadata values in this call, it must be the full set of metadata for the Scaling Group, since the underlying API call **overwrites** any existing metadata.
+**Note**: If you pass any metadata values in this call, it must be the full set of metadata for the scaling group, since the underlying API call **overwrites** any existing metadata.
 
 ### Deleting a Scaling Group
 
@@ -400,7 +400,7 @@ To retrieve the launch config:
 
     launch_config = group.launch_config
 
-The launch configuration contains two attributes `:type` and `:args`. The only launch type currently available for auto scale is `:launch_server`. The `args` attribute contains a hash with the launch server configuration options as follows:
+The launch configuration contains two attributes `:type` and `:args`. The only launch type currently available for Auto Scale is `:launch_server`. The `args` attribute contains a hash with the launch server configuration options as follows:
 
     {"server"=>{
         "name"=>"autoscale_server",
@@ -436,7 +436,7 @@ To add a policy to a scaling group use the following:
 Parameter | Required | Default | Notes
 ---- | ---- | ---- | ----
 **:name** | yes |  |
-**:type** | yes | | This can be "webhook", "schedule" or "cloud_monitoring"
+**:type** | yes | | This can be "webhook", "schedule" or "cloud monitoring"
 **:cooldown** | yes |  | Period in seconds after a policy execution in which further events are ignored. This is separate from the overall cooldown for the scaling group.
 **:change** | no | | Can be positive or negative, which makes this a scale-up or scale-down policy, respectively. If this value is specified you can not specify `:change_percent`.
 **:change_percent** | no | | The percentage change to the autoscale group's number of units. If this value is specified you can not specify `:change`.

data/lib/fog/rackspace/docs/getting_started.md

@@ -71,6 +71,7 @@ These services can be explored in further depth in the following documents:
 * [Cloud Files™ (storage)](storage.md)
 * [Cloud Block Storage (block_storage)](block_storage.md)
 * [Auto Scale (auto_scale)](auto_scale.md)
+* [Queues](queues.md)
 
 **Note**: The compute service provides an interface to the First Geneneration Cloud Servers™ (compute). This service is deprecated. Users are encouraged to use Next Geneneration Cloud Servers™ (compute_v2).
 

data/lib/fog/rackspace/docs/queues.md

@@ -0,0 +1,312 @@
+#Cloud Queues (queues)
+
+This document explains how to get started using queues with Fog. It assumes you have read the [Getting Started with Fog and the Rackspace Open Cloud](getting_started.md) document.
+
+## Basic Concepts
+
+Cloud Queues is an open source, scalable, and highly available message and notifications service, based on the OpenStack Marconi project. Users of this service can create and manage a producer-consumer or a publisher-subscriber model. Unlimited queues and messages give users the flexibility they need to create powerful web applications in the cloud.
+
+It consists of a few basic components: queues, messages, claims, and statistics. In the producer-consumer model, users create queues in which producers, or servers, can post messages. Workers, or consumers, can then claim those messages and delete them after they complete the actions associated with the messages. A single claim can contain multiple messages, and administrators can query claims for status.
+
+In the publisher-subscriber model, messages are posted to a queue as in the producer-consumer model, but messages are never claimed. Instead, subscribers, or watchers, send GET requests to pull all messages that have been posted since their last request. In this model, a message remains in the queue, unclaimed, until the message's time to live (TTL) has expired.
+
+In both of these models, administrators can get queue statistics that display the most recent and oldest messages, the number of unclaimed messages, and more.
+
+## Starting irb console
+
+Start by executing the following command:
+
+	irb
+
+Once `irb` has launched you need to require the Fog library as follows:
+
+	require 'fog'
+
+## Create Service
+
+Next, create a connection to queue service:
+
+Using a US-based account:
+
+	service = Fog::Rackspace::Queues(
+		:rackspace_username  => RACKSPACE_USER_NAME,   # Your Rackspace Username
+		:rackspace_api_key   => RACKSPACE_API,         # Your Rackspace API key
+		:rackspace_region    => :ord,                  # Your desired region
+		:rackspace_queues_client_id => CLIENT_ID,      # Your client ID
+		:connection_options  => {}                     # Optional connection options
+	)
+
+Using a UK-based account:
+
+	service = Fog::Rackspace::Queues(
+		:rackspace_username  => RACKSPACE_USER_NAME,        # Your Rackspace Username
+		:rackspace_api_key   => RACKSPACE_API,              # Your Rackspace API key
+		:rackspace_auth_url  => Fog::Rackspace::UK_AUTH_ENDPOINT,
+		:rackspace_region    => :lon,                       # Your desired region
+		:rackspace_queues_client_id =>  CLIENT_ID',         # Your client ID
+		:connection_options  => {}                          # Optional connection options
+	)
+
+To learn more about obtaining cloud credentials refer to the [Getting Started with Fog and the Rackspace Open Cloud](getting_started.md) document.
+
+### Authentication Endpoint
+
+By default `Fog::Rackspace::Queues` will authenticate against the US authentication endpoint. You can specify alternative authentication endpoints using the key `:rackspace_auth_url`. Please refer to [Alternate Authentication Endpoints](http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/Endpoints-d1e180.html) for a list of alternative Rackspace authentication endpoints.
+
+### Regions
+
+Alternative regions are specified using the key `:rackspace_region `. A list of regions available for cloud queues can be found by executing the following:
+
+	identity_service = Fog::Identity({
+		:provider            => 'Rackspace',                     # Rackspace Fog provider
+		:rackspace_username  => RACKSPACE_USER_NAME,             # Your Rackspace Username
+		:rackspace_api_key   => RACKSPACE_API,                   # Your Rackspace API key
+		:rackspace_auth_url  => Fog::Rackspace::UK_AUTH_ENDPOINT # Not specified for US Cloud
+	})
+
+	identity_service.service_catalog.display_service_regions :queues
+
+### Private Cloud
+
+Rackspace Private Cloud installations can skip specifying a region and directly specify their custom service endpoints using the key `:rackspace_queues_url`.
+
+**Note**: A`Fog::Rackspace::Queues` instance is needed for the desired region.
+
+### Client ID
+
+The Rackspace Queue service requires that every client define a client id to help identify messages and claims specific to the client. This client id should take the form of a UUID and can be generated using fog as follows:
+
+    Fog::UUID.uuid
+
+If the client id is omitted fog will generate one for you.
+
+### Optional Connection Parameters
+
+Fog supports passing additional connection parameters to its underlying HTTP library (Excon) using the `:connection_options` parameter.
+
+<table>
+	<tr>
+		<th>Key</th>
+		<th>Description</th>
+	</tr>
+	<tr>
+		<td>:connect_timeout</td>
+		<td>Connection timeout (default: 60 seconds)</td>
+	</tr>
+	<tr>
+		<td>:read_timeout</td>
+		<td>Read timeout for connection (default: 60 seconds)</td>	</tr>
+	<tr>
+		<td>:write_timeout</td>
+		<td>Write timeout for connection (default: 60 seconds)</td>
+	</tr>
+	<tr>
+		<td>:proxy</td>
+		<td>Proxy for HTTP and HTTPS connections</td>
+	</tr>
+	<tr>
+		<td>:ssl_ca_path</td>
+		<td>Path to SSL certificate authorities</td>
+	</tr>
+	<tr>
+		<td>:ssl_ca_file</td>
+		<td>SSL certificate authority file</td>
+	</tr>
+	<tr>
+		<td>:ssl_verify_peer</td>
+		<td>SSL verify peer (default: true)</td>
+	</tr>
+</table>
+
+
+## Fog Abstractions
+
+Fog provides both a **model** and **request** abstraction. The request abstraction provides the most efficient interface and the model abstraction wraps the request abstraction to provide a convenient `ActiveModel`-like interface.
+
+### Request Layer
+
+The request abstraction maps directly to the [Queue API](http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/overview.html). It provides the most efficient interface to the Rackspace Open Cloud.
+
+To see a list of requests supported by the service:
+
+	service.requests
+
+This returns:
+
+	    :list_queues, :get_queue, :create_queue, :delete_queue, :get_queue_stats, :list_messages, :get_message, :create_message, :delete_message, :create_claim, :get_claim, :update_claim, :delete_claim
+
+
+#### Example Request
+
+To request a list of queues:
+
+	response = service.list_queues
+
+This returns in the following `Excon::Response`:
+
+	#<Excon::Response:0x007feddda06e00 @data={:body=>{"queues"=>[{"href"=>"/v1/queues/demo-queue", "name"=>"demo-queue"}], "links"=>[{"href"=>"/v1/queues?marker=demo-queue", "rel"=>"next"}]}, :headers=>{"Content-Length"=>"119", "Content-Type"=>"application/json; charset=utf-8", "Content-Location"=>"/v1/queues", "X-Project-ID"=>"5551212"}, :status=>200, :remote_ip=>"10.10.0.1"}, @body="{\"queues\": [{\"href\": \"/v1/queues/demo-queue\", \"name\": \"demo-queue\"}], \"links\": [{\"href\": \"/v1/queues?marker=demo-queue\", \"rel\": \"next\"}]}", @headers={"Content-Length"=>"119", "Content-Type"=>"application/json; charset=utf-8", "Content-Location"=>"/v1/queues", "X-Project-ID"=>"5551212"}, @status=200, @remote_ip="10.10.0.1">
+
+To view the status of the response:
+
+	response.status
+
+**Note**: Fog is aware of valid HTTP response statuses for each request type. If an unexpected HTTP response status occurs, Fog will raise an exception.
+
+To view response body:
+
+	response.body
+
+This returns:
+
+	{"queues"=>[{"href"=>"/v1/queues/demo-queue", "name"=>"demo-queue"}], "links"=>[{"href"=>"/v1/queues?marker=demo-queue", "rel"=>"next"}]}
+
+
+To learn more about queue request methods refer to [rdoc](http://rubydoc.info/gems/fog/Fog/Rackspace/Queues/Real). To learn more about Excon refer to [Excon GitHub repo](https://github.com/geemus/excon).
+
+### Model Layer
+
+Fog models behave in a manner similar to `ActiveModel`. Models will generally respond to `create`, `save`,  `persisted?`, `destroy`, `reload` and `attributes` methods. Additionally, fog will automatically create attribute accessors.
+
+Here is a summary of common model methods:
+
+<table>
+	<tr>
+		<th>Method</th>
+		<th>Description</th>
+	</tr>
+	<tr>
+		<td>create</td>
+		<td>
+			Accepts hash of attributes and creates object.<br>
+			Note: creation is a non-blocking call and you will be required to wait for a valid state before using resulting object.
+		</td>
+	</tr>
+	<tr>
+		<td>save</td>
+		<td>Saves object.<br>
+		Note: not all objects support updating object.</td>
+	</tr>
+	<tr>
+		<td>persisted?</td>
+		<td>Returns true if the object has been persisted.</td>
+	</tr>
+	<tr>
+		<td>destroy</td>
+		<td>
+			Destroys object.<br>
+			Note: this is a non-blocking call and object deletion might not be instantaneous.
+		</td>
+	<tr>
+		<td>reload</td>
+		<td>Updates object with latest state from service.</td>
+	<tr>
+		<td>ready?</td>
+		<td>Returns true if object is in a ready state and able to perform actions. This method will raise an exception if object is in an error state.</td>
+	</tr>
+	<tr>
+		<td>attributes</td>
+		<td>Returns a hash containing the list of model attributes and values.</td>
+	</tr>
+		<td>identity</td>
+		<td>
+			Returns the identity of the object.<br>
+			Note: This might not always be equal to object.id.
+		</td>
+	</tr>
+	<tr>
+		<td>wait_for</td>
+		<td>This method periodically reloads model and then yields to specified block until block returns true or a timeout occurs.</td>
+	</tr>
+</table>
+
+The remainder of this document details the model abstraction.
+
+## Create Queue
+
+Queues require a unique name. If you try to create a queue with a name that already exists, fog will throw a `Fog::Rackspace::Queues::ServiceError` exception with a 204 status code.
+
+To create a queue named demo-queue
+
+    begin
+      queue = service.queues.create :name => 'demo-queue'
+    rescue Fog::Rackspace::Queues::ServiceError => e
+      if e.status_code == 204
+        # duplicate queue exists
+      end
+    end
+
+## Posting a Message to a Queue
+
+Messages can be any type of data, as long as they do not exceed 256 KB in length. Typical message bodies range from simple values, to a chunk of XML, or a list of JSON values. Fog handles the JSON-encoding required to post the message.
+
+You can post a message a message to your queue as follows:
+
+    queue.messages.create :body => 'The laces were out!', :ttl => 360
+
+You must supply both a body and a value for `ttl`. The value of `ttl` must be between 60 and 1209600 seconds (one minute to 14 days).
+
+## Listing Messages in a Queue
+
+To list messages:
+
+    queue.messages
+
+You can change the behavior by setting the follow attributes on the messages collection:
+
+Parameter | Default | Effect
+---- | ---- | ----
+**echo** | `true` | When `true`, your own messages are included.
+**include_claimed** | `false` | By default, only unclaimed messages are returned. Pass this as `true` to get all messages, claimed or not.
+**marker** | `nil` | Used for pagination.
+**limit** | `10` | The maximum number of messages to return. Note that you may receive fewer than the specified limit if there aren't that many available messages in the queue.
+
+For example, to include claimed messages:
+
+    queue.messages.include_claimed = true
+    queue.messages
+
+## Claiming Messages in a Queue
+
+Claiming messages is how workers processing a queue mark messages as being handled by that worker, avoiding having two workers process the same message.
+
+Messages can be claimed and processed as follows:
+
+    claims = queue.claims.create :ttl => 300, :grace => 100, :limit => 10
+
+The parameters for this call are described in the following table:
+
+Parameter | Default | Notes
+---- | ---- | ----
+**ttl** |  | The ttl attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours).
+**grace** |  | The grace attribute specifies the message grace period in seconds. The value of the grace period must be between 60 and 43200 seconds (12 hours). To deal with workers that have stopped responding (for up to 1209600 seconds or 14 days, including claim lifetime), the server extends the lifetime of claimed messages to be at least as long as the lifetime of the claim itself, plus the specified grace period. If a claimed message would normally live longer than the grace period, its expiration is not adjusted.
+**limit** | 10 | The number of messages to claim. The maximum number of messages you may claim at once is 20.
+
+If the claim is successful it will return a `Fog::Rackspace::Queues::Claims` object; if there are not any available messages it will return `false`.
+
+To iterate through the claimed messages:
+
+    claim.messages.each do |message|
+      # process message here
+      message.destroy
+    end
+
+**Note:** You will want to call the `destroy` method on the message after processing to insure it is not processed more than once.
+
+## Renewing a Claim
+
+Once a claim has been made, if the TTL and grace period expire, the claim is automatically released and the messages are made available for others to claim. If you have a long-running process and want to ensure that this does not happen in the middle of the process, you should update the claim with one or both of a TTL or grace period. Updating resets the age of the claim, restarting the TTL for the claim. To update a claim, call:
+
+    claim.ttl = 360
+    claim.grace = 360
+    claim.save
+
+## Refreshing a Claim
+
+If you have a `Fog::Rackspace::Queues::claims` object, keep in mind that it is not a live window into the status of the claim; rather, it is a snapshot of the claim at the time the object was created. To refresh it with the latest information, call its `reload` method. This refreshes all of its attributes with the most current status of the claim.
+
+
+## Releasing a Claim
+
+If you have a claim on several messages and must abandon processing of those messages for any reason, you should release the claim so that those messages can be processed by other workers as soon as possible, instead of waiting for the claim's TTL to expire. When you release a claim, the claimed messages are immediately made available in the queue for other workers to claim. To release a claim, call:
+
+    claim.destroy