fog 1.24.0 → 1.25.0

data/lib/fog/rackspace.rb

@@ -10,3 +10,4 @@ require 'fog/rackspace/load_balancers'
 require 'fog/rackspace/monitoring'
 require 'fog/rackspace/queues'
 require 'fog/rackspace/storage'
+require 'fog/rackspace/networking'

data/lib/fog/rackspace/core.rb

@@ -97,6 +97,7 @@ module Fog
     service(:databases,        'Databases')
     service(:monitoring,       'Monitoring')
     service(:queues,           'Queues')
+    service(:networking,       'Networking')
 
     def self.authenticate(options, connection_options = {})
       rackspace_auth_url = options[:rackspace_auth_url]

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

@@ -0,0 +1,315 @@
+#Networking (neutron)
+
+This document explains how to get started using Networking with Fog. It assumes you have read the [Getting Started with Fog and the Rackspace Open Cloud](getting_started.md) document.
+
+## Starting irb console
+
+Start by executing the following command:
+
+	irb
+
+Once `irb` has launched you need to require the Fog library.
+
+If using Ruby 1.8.x execute:
+
+	require 'rubygems'
+	require 'fog'
+
+If using Ruby 1.9.x execute:
+
+	require 'fog'
+
+## Create Service
+
+Next, create a connection to Rackspace's Networking API:
+
+Using a US-based account:
+
+	service = Fog::Rackspace::Networking.new({
+  		:rackspace_username  => RACKSPACE_USER_NAME, # Your Rackspace Username
+  		:rackspace_api_key	 => RACKSPACE_API,       # Your Rackspace API key
+		:rackspace_region	 => :ord,                # Defaults to :dfw
+	})
+
+Using a UK-based account:
+
+	service = Fog::Compute.new({
+		: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,
+	})
+
+To learn more about obtaining cloud credentials refer to the [Getting Started with Fog and the Rackspace Open Cloud](getting_started.md) document.
+
+By default `Fog::Rackspace::Networking` will authenticate against the US authentication endpoint and connect to the DFW region. 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 Cloud Servers 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 :cloudServersOpenStack
+
+### 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 [Networking API](http://docs.rackspace.com/networks/api/v2/cn-gettingstarted/content/ch_overview.html). It provides the most efficient interface to the Rackspace Networking
+
+To see a list of requests supported by the service:
+
+	service.requests
+
+This returns:
+
+	[:list_networks, :get_network, :create_network, :delete_network, :list_virtual_interfaces, :create_virtual_interface, :delete_virtual_interface]
+
+#### Example Request
+
+To request a list of flavors:
+
+	response = service.list_networks
+
+This returns in the following `Excon::Response`:
+
+	<Excon::Response:0x0000010231acd8 @data={:body=>{"networks"=>[{"cidr"=>"192.168.0.0/24", "id"=>"08df79ae-b714-425c-ba25-91b0a8a78b9e", "label"=>"something"}, {"cidr"=>"192.168.0.0/24", "id"=>"eb3ed4b8-21d4-478e-9ae4-a35c0cc0437c", "label"=>"something"}, {"id"=>"00000000-0000-0000-0000-000000000000", "label"=>"public"}, {"id"=>"11111111-1111-1111-1111-111111111111", "label"=>"private"}]}, :headers=>{"Content-Type"=>"application/json", "Via"=>"1.1 Repose (Repose/2.12)", "Content-Length"=>"341", "Date"=>"Thu, 23 Oct 2014 20:53:41 GMT", "x-compute-request-id"=>"req-d34ab53c-45ed-433f-8a9d-b3341896b7e5", "Server"=>"Jetty(8.0.y.z-SNAPSHOT)"}, :status=>200, :remote_ip=>"162.209.116.128", :local_port=>60153, :local_address=>"192.168.1.65"}, @body="{\"networks\": [{\"cidr\": \"192.168.0.0/24\", \"id\": \"08df79ae-b714-425c-ba25-91b0a8a78b9e\", \"label\": \"something\"}, {\"cidr\": \"192.168.0.0/24\", \"id\": \"eb3ed4b8-21d4-478e-9ae4-a35c0cc0437c\", \"label\": \"something\"}, {\"id\": \"00000000-0000-0000-0000-000000000000\", \"label\": \"public\"}, {\"id\": \"11111111-1111-1111-1111-111111111111\", \"label\": \"private\"}]}", @headers={"Content-Type"=>"application/json", "Via"=>"1.1 Repose (Repose/2.12)", "Content-Length"=>"341", "Date"=>"Thu, 23 Oct 2014 20:53:41 GMT", "x-compute-request-id"=>"req-d34ab53c-45ed-433f-8a9d-b3341896b7e5", "Server"=>"Jetty(8.0.y.z-SNAPSHOT)"}, @status=200, @remote_ip="162.209.116.128", @local_port=60153, @local_address="192.168.1.65">
+
+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 will return:
+
+	{"networks"=>[{"cidr"=>"192.168.0.0/24", "id"=>"08df79ae-b714-425c-ba25-91b0a8a78b9e", "label"=>"something"}, {"cidr"=>"192.168.0.0/24", "id"=>"eb3ed4b8-21d4-478e-9ae4-a35c0cc0437c", "label"=>"something"}, {"id"=>"00000000-0000-0000-0000-000000000000", "label"=>"public"}, {"id"=>"11111111-1111-1111-1111-111111111111", "label"=>"private"}]}
+
+To learn more about Networking request methods refer to [rdoc](http://www.rubydoc.info/gems/fog/Fog/Rackspace/Networking/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.
+
+## List Networks
+
+To retrieve a list of available networks:
+
+	service.networks
+
+This returns a collection of `Fog::Rackspace::Networking::Network` models:
+
+ 	<Fog::Rackspace::Networking::Networks
+    [
+      <Fog::Rackspace::Networking::Network
+        id="08df79ae-b714-425c-ba25-91b0a8a78b9e",
+        label="something",
+        cidr="192.168.0.0/24"
+      >,
+      <Fog::Rackspace::Networking::Network
+        id="eb3ed4b8-21d4-478e-9ae4-a35c0cc0437c",
+        label="something",
+        cidr="192.168.0.0/24"
+      >,
+      <Fog::Rackspace::Networking::Network
+        id="00000000-0000-0000-0000-000000000000",
+        label="public",
+        cidr=nil
+      >,
+      <Fog::Rackspace::Networking::Network
+        id="11111111-1111-1111-1111-111111111111",
+        label="private",
+        cidr=nil
+      >
+    ]
+  >
+
+## Create Network
+
+Create a network:
+
+ 	service.networks.create(label: "new_network", cidr: "192.168.0.0/24")
+
+
+## Get Network
+
+To retrieve individual network:
+
+	service.networks.get "8a3a9f96-b997-46fd-b7a8-a9e740796ffd"
+
+This returns an `Fog::Rackspace::Networking::Network` instance:
+
+    <Fog::Rackspace::Networking::Network
+    id="08df79ae-b714-425c-ba25-91b0a8a78b9e",
+    label="new_network",
+    cidr="192.168.0.0/24"
+  >
+
+## Delete Network
+
+To delete a network:
+
+    network.destroy
+
+**Note**: The network is not immediately destroyed, but it does occur shortly there after.
+
+## List Virtual Interfaces
+
+To retrieve a list of available virtual interfaces:
+
+	service.virtual_interfaces.all(server: <server obj, or server id>)
+
+This returns a collection of `Fog::Rackspace::Networking::VirtualInterface` models:
+
+ 	<Fog::Rackspace::Networking::VirtualInterfaces
+    [
+      <Fog::Rackspace::Networking::VirtualInterface
+        id="f063815f-e576-450e-92bd-ff3aeeeb11e0",
+        mac_address="BC:76:4E:20:A9:16",
+        ip_addresses=[{"network_id"=>"11111111-1111-1111-1111-111111111111", "network_label"=>"private", "address"=>"10.176.12.249"}]
+      >,
+      <Fog::Rackspace::Networking::VirtualInterface
+        id="f8196e20-788b-4447-80a5-32ca8fc9622f",
+        mac_address="BC:76:4E:20:A8:56",
+        ip_addresses=[{"network_id"=>"08df79ae-b714-425c-ba25-91b0a8a78b9e", "network_label"=>"new_network", "address"=>"192.168.0.1"}]
+      >
+    ]
+  >
+
+## Create Virtual Interface
+
+Create a virtual interface:
+
+ 	service.virtual_interfaces.create(network: <network_id>, server: <server_id>)
+
+## Delete Virtual Interface
+
+To delete a virtual interface:
+
+ 	vis = service.virtual_interfaces.all(server: <server obj, or server id>)
+ 	vis.first.destroy
+
+**Note**: The virtual interface is not immediately destroyed, but it does occur shortly there after.
+
+## Examples
+
+Example code using Networking can be found [here](https://github.com/fog/fog/tree/master/lib/fog/rackspace/examples).
+
+## Additional Resources
+
+* [fog.io](http://fog.io/)
+* [Fog rdoc](http://rubydoc.info/gems/fog/)
+* [Fog Github repo](https://github.com/fog/fog)
+* [Fog Github Issues](https://github.com/fog/fog/issues)
+* [Excon Github repo](https://github.com/geemus/excon)
+* [Rackspace Networking API](http://docs.rackspace.com/networking/api/v2/cs-devguide/content/ch_preface.html)
+
+## Support and Feedback
+
+Your feedback is appreciated! If you have specific issues with the **fog** SDK, you should file an [issue via Github](https://github.com/fog/fog/issues).
+
+For general feedback and support requests, send an email to: <sdk-support@rackspace.com>.
+

data/lib/fog/rackspace/mock_data.rb

@@ -39,7 +39,7 @@ module Fog
               "OS-DCF:diskConfig" => "AUTO",
               "created" => "2012-02-28T19:38:57Z",
               "id" => image_id,
-              "name" => "Ubuntu",
+              "name" => image_name,
               "links" => [
                 {
                   "href" => "https://dfw.servers.api.rackspacecloud.com/v2/010101/images/#{image_id}",
@@ -77,7 +77,6 @@ module Fog
               },
               "minDisk"  => 10,
               "minRam"   => 256,
-              "name"     => image_name,
               "progress" => 100,
               "status"   => "ACTIVE",
               "updated"  => "2012-02-28T19:39:05Z"

data/lib/fog/rackspace/models/dns/zones.rb

@@ -47,7 +47,8 @@ module Fog
           data = service.list_domain_details(zone_id).body
           new(data)
         rescue Fog::DNS::Rackspace::NotFound
-          nil
+          # if we can't find it by id, go back and find it via domain
+          find{|z| z.domain == zone_id}
         #Accessing a valid (but other customer's) id returns a 503 error
         rescue Fog::Rackspace::Errors::ServiceUnavailable
           nil

data/lib/fog/rackspace/models/load_balancers/node.rb

@@ -10,6 +10,7 @@ module Fog
         attribute :status
         attribute :weight
         attribute :port
+        attribute :type
         attribute :condition
 
         def destroy
@@ -38,6 +39,9 @@ module Fog
           unless weight.nil?
             options[:weight] = weight
           end
+          unless type.nil?
+            options[:type] = type
+          end
           data = service.create_node(load_balancer.id, address, port, condition, options)
           merge_attributes(data.body['nodes'][0])
         end
@@ -50,6 +54,9 @@ module Fog
           unless weight.nil?
             options[:weight] = weight
           end
+          unless type.nil?
+            options[:type] = type
+          end
           service.update_node(load_balancer.id, identity, options)
         end
       end

data/lib/fog/rackspace/models/networking/network.rb

@@ -0,0 +1,27 @@
+module Fog
+  module Rackspace
+    class Networking
+      class Network < Fog::Model
+        identity :id
+
+        attribute :label
+        attribute :cidr
+
+        def save
+          requires :label, :cidr
+
+          data = service.create_network(label, cidr)
+          merge_attributes(data.body['network'])
+          true
+        end
+
+        def destroy
+          requires :identity
+
+          service.delete_network(identity)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/networking/networks.rb

@@ -0,0 +1,23 @@
+require 'fog/rackspace/models/compute_v2/network'
+
+module Fog
+  module Rackspace
+    class Networking
+      class Networks < Fog::Collection
+        model Fog::Rackspace::Networking::Network
+
+        def all
+          data = service.list_networks.body['networks']
+          load(data)
+        end
+
+        def get(id)
+          data = service.get_network(id).body['network']
+          new(data)
+        rescue Fog::Rackspace::Networking::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/rackspace/models/networking/virtual_interface.rb

@@ -0,0 +1,85 @@
+require 'fog/core/collection'
+require 'fog/rackspace/models/networking/virtual_interface'
+
+module Fog
+  module Rackspace
+    class Networking
+      class VirtualInterface < Fog::Model
+        # @!attribute [r] id
+        # @return [String] The virtual interface id
+        identity :id
+
+        # @!attribute [r] mac_address
+        # @return [String] The Media Access Control (MAC) address for the virtual interface.
+        #   A MAC address is a unique identifier assigned to network interfaces for communications on the physical network segment.
+        attribute :mac_address
+
+        # @!attribute [r] ip_addresses
+        # @return [Array<Hash>] returns an array of hashes containing information about allocated ip addresses and their associated networks
+        # @example
+        # [
+        #   {
+        #       "address": "2001:4800:7810:0512:d87b:9cbc:ff04:850c",
+        #       "network_id": "ba122b32-dbcc-4c21-836e-b701996baeb3",
+        #       "network_label": "public"
+        #   },
+        #   {
+        #       "address": "64.49.226.149",
+        #       "network_id": "ba122b32-dbcc-4c21-836e-b701996baeb3",
+        #       "network_label": "public"
+        #   }
+        # ]
+        attribute :ip_addresses
+
+        # Saves the virtual interface.
+        # This method can only create a virtual interface. Attempting to update interface will result an exception
+        # @return [Boolean] true if virtual interface has been saved
+        def save(attributes = {})
+          if persisted?
+            raise Fog::Errors::Error.new("This virtual interface has already been created and it cannot be updated")
+          else
+            create
+          end
+          true
+        end
+
+        # Creates Virtual interface for server
+        # * requires attributes: :network
+        # @return [Boolean] returns true if virtual network interface is being created
+        # @raise [Fog::Rackspace::Networking::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Networking::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Networking::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Networking::ServiceError]
+        # @example To create a virtual interface;
+        # my_server.virtual_interfaces.create :network => my_network
+        # @see http://docs.rackspace.com/servers/api/v2/cn-devguide/content/api_create_virtual_interface.html
+        def create
+          data = service.create_virtual_interface(server_id, network_id)
+          merge_attributes(data.body['virtual_interfaces'].first)
+        end
+
+        # Destroy the virtual interface
+        # @return [Boolean] returns true if virtual interface has been destroyed
+        # @raise [Fog::Rackspace::Networking::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Networking::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Networking::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Networking::ServiceError]
+        # @see http://docs.rackspace.com/servers/api/v2/cn-devguide/content/delete_virt_interface_api.html
+        def destroy
+          service.delete_virtual_interface(server_id, id)
+          true
+        end
+
+        private
+
+        def server_id
+           attributes[:server].is_a?(Fog::Compute::RackspaceV2::Server) ? attributes[:server].id : attributes[:server]
+        end
+
+        def network_id
+          attributes[:network].is_a?(Network) ? attributes[:network].id : attributes[:network]
+        end
+      end
+    end
+  end
+end