openstack 1.0.9 → 1.1.0

data/README.rdoc

@@ -2,13 +2,13 @@
 
 == Description
 
-Ruby Openstack Compute, Object-Store and Block Storage bindings for the OpenStack API.
-
+Ruby Openstack Compute, Object-Store, Block Storage and Network (Quantum) bindings for the OpenStack API.
+a
 http://api.openstack.org/api-reference.html
 
 Currently supports both v1.0 and v2.0 (keystone) auth.
 
-Use OpenStack::Connection.create to get a handle to an OpenStack service - set the :service_type parameter to either 'compute' or 'object-store' (defaults to 'compute'). If the requested service is not deployed the gem will throw a OpenStack::Exception::NotImplemented (501) - e.g. :service_type is 'object-store' but swift service isn't deployed.
+Use OpenStack::Connection.create to get a handle to an OpenStack service - set the :service_type parameter to 'compute', 'object-store', 'volume' or 'network' (defaults to 'compute'). If the requested service is not deployed the gem will throw a OpenStack::Exception::NotImplemented (501) - e.g. :service_type is 'object-store' but swift service isn't deployed.
 
 The OpenStack::Connection.create class method is a factory constructor which will return the appropriate Connection object, depending on the ':service_type' parameter passed with the options hash: set to either 'compute', 'volume', or  'object-store' (defaults to 'compute') - see below for examples.
 
@@ -367,9 +367,59 @@ See the class definitions for documentation on specific methods and operations.
   => OpenStack::Exception::ItemNotFound: The resource could not be found
 
 
+== Examples for Network (Quantum):
+
+  quantum = OpenStack::Connection.create({:username => "admin",  :api_key=>"le-password", :auth_method=>"password",  :auth_url => "http://192.168.1.21:5000/v2.0/", :authtenant_name =>"admin",  :service_type=>"network"})
+
+  #Create a network:
+  >> net2 = quantum.create_network("my_net")
+  => #<OpenStack::Network::Network:0xa8aff70 @id="6b09a5b3-02d3-4996-9933-4792bd4ca11e",@name="my_net", @admin_state_up=true, @status="ACTIVE", @subnets=[], @shared=false, @tenant_id="7be215d541ea4db4a23b3a84b0882408">
+
+  #List networks:
+  >> quantum.networks
+  => [#<OpenStack::Network::Network:0xa7c8f94 @id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="net_1363343212", @admin_state_up=true, @status="ACTIVE",
+@subnets=["34ea9f1e-d71a-48bd-89b0-af2f5c051912","7780f890-8334-43a1-934c-f1ce5edc4561"], @shared=false, @tenant_id="7be215d541ea4db4a23b3a84b0882408">, #<OpenStack::Network::Network:0xa7c8ef4 @id="1cfad632-3473-4c5b-b2d3-405cc3093286", @name="net_1363344435", @admin_state_up=true, @status="ACTIVE", @subnets=["c4293c24-07d0-47dc-bead-ec8d3934b8db"], @shared=false, @tenant_id="7be215d541ea4db4a23b3a84b0882408">]
+
+  >> net1 = quantum.network("b4abfaff-9e24-4192-9219-a4a60819aba2")
+  => #<OpenStack::Network::Network:0xa7f28e4 @id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="net_1363343212", @admin_state_up=true, @status="ACTIVE", @subnets=["34ea9f1e-d71a-48bd-89b0-af2f5c051912", "7780f890-8334-43a1-934c-f1ce5edc4561"], @shared=false, @tenant_id="7be215d541ea4db4a23b3a84b0882408">
+
+  #Delete a Network:
+  >> quantum.delete_network("6b09a5b3-02d3-4996-9933-4792bd4ca11e")
+  => true
+
+  #Create a Subnet:
+  >> subnet1 = quantum.create_subnet("b4abfaff-9e24-4192-9219-a4a60819aba2","192.168.1.0/24")
+  => #<OpenStack::Network::Subnet:0xa772a2c @id="e978da1c-9c95-4e58-b4b6-4dcce4640a7f", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @ip_version=4, @cidr="192.168.1.0/24", @gateway_ip="192.168.1.1", @dns_nameservers=[], @allocation_pools=[{"start"=>"192.168.1.2", "end"=>"192.168.1.254"}], @host_routes=[], @enable_dhcp=true, @tenant_id="7be215d541ea4db4a23b3a84b0882408">
+
+  #List Subnets:
+  >> quantum.subnets
+  => [#<OpenStack::Network::Subnet:0xa850958 @id="34ea9f1e-d71a-48bd-89b0-af2f5c051912", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @ip_version=4, @cidr="123.123.0.0/16", @gateway_ip="123.123.0.1", @dns_nameservers=[], @allocation_pools=[{"start"=>"123.123.0.2", "end"=>"123.123.255.254"}], @host_routes=[], @enable_dhcp=true, @tenant_id="7be215d541ea4db4a23b3a84b0882408">, #<OpenStack::Network::Subnet:0xa850868 @id="7780f890-8334-43a1-934c-f1ce5edc4561", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @ip_version=4, @cidr="192.168.1.0/24", @gateway_ip="192.168.1.1", @dns_nameservers=[], @allocation_pools=[{"start"=>"192.168.1.2", "end"=>"192.168.1.254"}], @host_routes=[], @enable_dhcp=true, @tenant_id="7be215d541ea4db4a23b3a84b0882408">]
+
+  >> subnet1 = quantum.subnet("34ea9f1e-d71a-48bd-89b0-af2f5c051912")
+  => #<OpenStack::Network::Subnet:0xa88ec1c @id="34ea9f1e-d71a-48bd-89b0-af2f5c051912", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @ip_version=4, @cidr="123.123.0.0/16", @gateway_ip="123.123.0.1", @dns_nameservers=[], @allocation_pools=[{"start"=>"123.123.0.2", "end"=>"123.123.255.254"}], @host_routes=[], @enable_dhcp=true, @tenant_id="7be215d541ea4db4a23b3a84b0882408">
+
+  #Delete a Subnet:
+  >> quantum.delete_subnet("89136e4d-da26-4495-9384-0fd1309e274a")
+  => true
+
+  #Create a Port:
+  >> created_port = quantum.create_port(network.id, {"fixed_ips"=>[{"subnet_id"=>subnet.id}], "device_id"=>machine.id})
+  => #<OpenStack::Network::Port:0x95a833c @id="d601db9e-c936-4811-904a-bb5a27d105f3", @network_id="c4dfe90e-a7ce-41f7-b9b2-2f9773f42a6b", @name="", @admin_state_up=true, @status="ACTIVE", @mac_address="fa:16:3e:f4:e8:bc", @fixed_ips=[{"subnet_id"=>"f78bfc05-ead0-40a6-8325-a35eb2b535c3", "ip_address"=>"10.0.0.4"}], @device_id="fe4022fa-a77c-4adf-be45-6e069fb3a314", @device_owner="", @tenant_id="7be215d541ea4db4a23b3a84b0882408">
+
+  #List Ports:
+  >> quantum.ports
+  => [#<OpenStack::Network::Port:0xa73bdd8 @id="f0db2c95-9449-4eb3-8b12-c66b23c8de41", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @admin_state_up=true, @status="ACTIVE", @mac_address="fa:16:3e:7e:e0:1b", @fixed_ips=[{"subnet_id"=>"34ea9f1e-d71a-48bd-89b0-af2f5c051912", "ip_address"=>"123.123.0.2"}], @device_id="4357665c-e2fe-4bf0-8a69-b531d11add2d", @device_owner="compute:nova", @tenant_id="7be215d541ea4db4a23b3a84b0882408">, #<OpenStack::Network::Port:0xa73bcac @id="93c210cd-b086-49e1-aa12-d207aa28a981", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @admin_state_up=true, @status="ACTIVE", @mac_address="fa:16:3e:08:eb:92", @fixed_ips=[{"subnet_id"=>"34ea9f1e-d71a-48bd-89b0-af2f5c051912", "ip_address"=>"123.123.0.3"}], @device_id="5a114ba2-4f49-4655-93f9-96954632cb67", @device_owner="compute:nova", @tenant_id="7be215d541ea4db4a23b3a84b0882408">]
+
+  >> port1 = quantum.port("f0db2c95-9449-4eb3-8b12-c66b23c8de41")
+  => #<OpenStack::Network::Port:0xa70f51c @id="f0db2c95-9449-4eb3-8b12-c66b23c8de41", @network_id="b4abfaff-9e24-4192-9219-a4a60819aba2", @name="", @admin_state_up=true, @status="ACTIVE", @mac_address="fa:16:3e:7e:e0:1b", @fixed_ips=[{"subnet_id"=>"34ea9f1e-d71a-48bd-89b0-af2f5c051912", "ip_address"=>"123.123.0.2"}], @device_id="4357665c-e2fe-4bf0-8a69-b531d11add2d", @device_owner="compute:nova", @tenant_id="7be215d541ea4db4a23b3a84b0882408">
+
+  #Delete a Port:
+  >> quantum.delete_port("f0db2c95-9449-4eb3-8b12-c66b23c8de41")
+  => true
+
 == Authors
 
-By Dan Prince <dprince@redhat.com>, Naveed Massjouni <naveedm9@gmail.com>, Marios Andreou <marios@redhat.com>
+By Marios Andreou (marios@redhat.com), Dan Prince <dprince@redhat.com>, Naveed Massjouni <naveedm9@gmail.com>
 
 Initial code checkin on May 23rd 2012 - code refactored from and based on the Rackspace Cloud Servers gem
 (https://github.com/rackspace/ruby-openstack-compute) and Rackspace Cloud Files gem (https://github.com/rackspace/ruby-cloudfiles).

data/VERSION

@@ -1 +1 @@
-1.0.9
+1.1.0

data/lib/openstack.rb

@@ -46,8 +46,10 @@ module OpenStack
   require 'openstack/volume/volume'
   require 'openstack/volume/snapshot'
   require 'openstack/image/connection'
-
-
+  require 'openstack/network/connection'
+  require 'openstack/network/network'
+  require 'openstack/network/subnet'
+  require 'openstack/network/port'
   # Constants that set limits on server creation
   MAX_PERSONALITY_ITEMS = 5
   MAX_PERSONALITY_FILE_SIZE = 10240

data/lib/openstack/connection.rb

@@ -68,6 +68,8 @@ class Connection
           OpenStack::Volume::Connection.new(connection)
         when "image"
           OpenStack::Image::Connection.new(connection)
+        when "network"
+          OpenStack::Network::Connection.new(connection)
        else
           raise Exception::InvalidArgument, "Invalid :service_type parameter: #{@service_type}"
       end
@@ -430,6 +432,8 @@ class Exception
   end
   class ResourceStateConflict       < ComputeError # :nodoc:
   end
+  class QuantumError                < ComputeError # :nodoc:
+  end
 
   # Plus some others that we define here
 
@@ -467,7 +471,7 @@ class Exception
           info=val
         end
         exception_class = self.const_get(fault[0,1].capitalize+fault[1,fault.length])
-        raise exception_class.new(info["message"], response.code, response.body)
+        raise exception_class.new((info["message"] || info), response.code, response.body)
       end
     rescue JSON::ParserError => parse_error
         deal_with_faulty_error(response, parse_error)

data/lib/openstack/network/connection.rb

@@ -0,0 +1,100 @@
+module OpenStack
+module Network
+
+  class Connection
+
+    attr_accessor   :connection
+
+    def initialize(connection)
+      @connection = connection
+      OpenStack::Authentication.init(@connection)
+    end
+
+    # Returns true if the authentication was successful and returns false otherwise.
+    #
+    #   cs.authok?
+    #   => true
+    def authok?
+      @connection.authok
+    end
+
+    def list_networks
+      response = @connection.req("GET", "/networks")
+      nets_hash = JSON.parse(response.body)["networks"]
+      nets_hash.inject([]){|res, current| res << OpenStack::Network::Network.new(current); res}
+    end
+    alias :networks :list_networks
+
+    def get_network(network_id)
+      response = @connection.req("GET", "/networks/#{network_id}")
+      OpenStack::Network::Network.new(JSON.parse(response.body)["network"])
+    end
+    alias :network :get_network
+
+    def create_network(name)
+      req_body = JSON.generate({"network"=>{"name"=>name}})
+      response = @connection.req("POST", "/networks", {:data=>req_body})
+      OpenStack::Network::Network.new(JSON.parse(response.body)["network"])
+    end
+
+    def delete_network(id)
+      @connection.req("DELETE", "/networks/#{id}")
+      true
+    end
+
+    def list_subnets
+      response = @connection.req("GET", "/subnets")
+      nets_hash = JSON.parse(response.body)["subnets"]
+      nets_hash.inject([]){|res, current| res << OpenStack::Network::Subnet.new(current); res}
+    end
+    alias :subnets :list_subnets
+
+    def get_subnet(subnet_id)
+      response = @connection.req("GET", "/subnets/#{subnet_id}")
+      OpenStack::Network::Subnet.new(JSON.parse(response.body)["subnet"])
+    end
+    alias :subnet :get_subnet
+
+    def create_subnet(network_id, cidr, ip_version="4", opts={})
+      body_hash = {"subnet"=>{"network_id"=> network_id, "cidr"=>cidr, "ip_version"=>ip_version}}
+      body_hash["subnet"].merge!(opts) #fixme - validation?
+      req_body = JSON.generate(body_hash)
+      response = @connection.req("POST", "/subnets", {:data=>req_body})
+      OpenStack::Network::Subnet.new(JSON.parse(response.body)["subnet"])
+    end
+
+    def delete_subnet(id)
+      @connection.req("DELETE", "/subnets/#{id}")
+      true
+    end
+
+    def list_ports
+      response = @connection.req("GET", "/ports")
+      ports_hash = JSON.parse(response.body)["ports"]
+      ports_hash.inject([]){|res, current| res << OpenStack::Network::Port.new(current); res}
+    end
+    alias :ports :list_ports
+
+    def get_port(port_id)
+      response = @connection.req("GET", "/ports/#{port_id}")
+      OpenStack::Network::Port.new(JSON.parse(response.body)["port"])
+    end
+    alias :port :get_port
+
+    def create_port(network_id, opts={})
+      body_hash = {"port"=>{"network_id"=> network_id}}
+      body_hash["port"].merge!(opts) #fixme - validation?
+      req_body = JSON.generate(body_hash)
+      response = @connection.req("POST", "/ports", {:data=>req_body})
+      OpenStack::Network::Port.new(JSON.parse(response.body)["port"])
+    end
+
+    def delete_port(id)
+      @connection.req("DELETE", "/ports/#{id}")
+      true
+    end
+
+  end
+
+end
+end

data/lib/openstack/network/network.rb

@@ -0,0 +1,26 @@
+module OpenStack
+module Network
+  class Network
+
+  attr_reader :id
+  attr_reader :name
+  attr_reader :admin_state_up
+  attr_reader :status
+  attr_reader :subnets
+  attr_reader :shared
+  attr_reader :tenant_id
+
+  def initialize(net_info={})
+    @id = net_info["id"]
+    @name = net_info["name"]
+    @admin_state_up = net_info["admin_state_up"]
+    @status = net_info["status"]
+    @subnets = net_info["subnets"]
+    @shared = net_info["shared"]
+    @tenant_id = net_info["tenant_id"]
+  end
+
+  end
+end
+end
+

data/lib/openstack/network/port.rb

@@ -0,0 +1,32 @@
+module OpenStack
+module Network
+  class Port
+
+    attr_reader :id
+    attr_reader :network_id
+    attr_reader :name
+    attr_reader :admin_state_up
+    attr_reader :status
+    attr_reader :mac_address
+    attr_reader :fixed_ips
+    attr_reader :device_id
+    attr_reader :device_owner
+    attr_reader :tenant_id
+
+    def initialize(port_hash)
+      @id = port_hash["id"]
+      @network_id = port_hash["network_id"]
+      @name = port_hash["name"]
+      @admin_state_up = port_hash["admin_state_up"]
+      @status = port_hash["status"]
+      @mac_address = port_hash["mac_address"]
+      @fixed_ips = port_hash["fixed_ips"]
+      @device_id = port_hash["device_id"]
+      @device_owner = port_hash["device_owner"]
+      @tenant_id = port_hash["tenant_id"]
+    end
+
+
+  end
+end
+end

data/lib/openstack/network/subnet.rb

@@ -0,0 +1,33 @@
+module OpenStack
+module Network
+  class Subnet
+
+    attr_reader :id
+    attr_reader :network_id
+    attr_reader :name
+    attr_reader :ip_version
+    attr_reader :cidr
+    attr_reader :gateway_ip
+    attr_reader :dns_nameservers
+    attr_reader :allocation_pools
+    attr_reader :host_routes
+    attr_reader :enable_dhcp
+    attr_reader :tenant_id
+
+    def initialize(subnet_hash)
+      @id = subnet_hash["id"]
+      @network_id = subnet_hash["network_id"]
+      @name = subnet_hash["name"]
+      @ip_version = subnet_hash["ip_version"]
+      @cidr = subnet_hash["cidr"]
+      @gateway_ip = subnet_hash["gateway_ip"]
+      @dns_nameservers = subnet_hash["dns_nameservers"]
+      @allocation_pools = subnet_hash["allocation_pools"]
+      @host_routes = subnet_hash["host_routes"]
+      @enable_dhcp = subnet_hash["enable_dhcp"]
+      @tenant_id = subnet_hash["tenant_id"]
+    end
+
+  end
+end
+end

data/lib/openstack/swift/connection.rb

@@ -127,7 +127,7 @@ module Swift
       raise OpenStack::Exception::InvalidArgument.new("Container name cannot contain '/'") if containername.match("/")
       raise OpenStack::Exception::InvalidArgument.new("Container name is limited to 256 characters") if containername.length > 256
       path = "/#{URI.encode(containername.to_s)}"
-      @connection.req("PUT", path)
+      @connection.req("PUT", path, {:headers=>{"Content-Length"=>"0"}})
       OpenStack::Swift::Container.new(self, containername)
     end
 

data/test/authentication_test.rb

@@ -33,35 +33,21 @@ class AuthenticationTest < Test::Unit::TestCase
     end
   end
 
-  def test_service_region
+  def test_service_uri
     server = get_test_auth_server
     Net::HTTP.stubs(:new).returns(server)
     server.stubs(:started?).returns(true)
-    connection = stub(:authuser => 'good_user', :auth_method => "password",:authtenant => {:type=>"tenantName", :value=>'good_tenant'} , :authkey => 'bad_key', :auth_host => "a.b.c", :auth_port => "443", :auth_scheme => "https", :auth_path => "/v2.0", :authok= => true, :authtoken= => true, :service_host= => "", :service_path= => "", :service_path => "", :service_port= => "", :service_scheme= => "", :proxy_host => nil, :proxy_port => nil, :api_path => '/foo', :service_type => "compute", :service_name => "cloudServers", :region => "South")
+    connection = v2_auth_connection_stub
     result = OpenStack::Authentication.init(connection)
     assert_equal("compute.south.host", result.uri.host)
   end
 
-  def test_service_name
-    server = get_test_auth_server
-    Net::HTTP.stubs(:new).returns(server)
-    server.stubs(:started?).returns(true)
-    connection = stub(:authuser => 'good_user', :auth_method=>"password", :authtenant => {:type=>"tenantName", :value=>'good_tenant'}, :authkey => 'bad_key', :auth_host => "a.b.c", :auth_port => "443", :auth_scheme => "https", :auth_path => "/v2.0", :authok= => true, :authtoken= => true, :service_host= => "", :service_path= => "", :service_path => "", :service_port= => "", :service_scheme= => "", :proxy_host => nil, :proxy_port => nil, :api_path => '/foo', :service_type => "nova", :service_name => "cloudCompute", :region => "South")
-    result = OpenStack::Authentication.init(connection)
-    assert_equal("nova.south.host", result.uri.host)
-  end
+  private
 
-  def test_service_type
-    server = get_test_auth_server
-    Net::HTTP.stubs(:new).returns(server)
-    server.stubs(:started?).returns(true)
-    connection = stub(:authuser => 'good_user', :auth_method => "password", :authtenant => {:type=>"tenantName", :value=>'good_tenant'}, :authkey => 'bad_key', :auth_host => "a.b.c", :auth_port => "443", :auth_scheme => "https", :auth_path => "/v2.0", :authok= => true, :authtoken= => true, :service_host= => "", :service_path= => "", :service_path => "", :service_port= => "", :service_scheme= => "", :proxy_host => nil, :proxy_port => nil, :api_path => '/foo', :service_type => "nova", :service_name => nil, :region => "North")
-    result = OpenStack::Authentication.init(connection)
-    assert_equal("nova.north.host", result.uri.host)
+  def v2_auth_connection_stub
+    stub(:authuser => 'good_user', :auth_method => "password",:authtenant => {:type=>"tenantName", :value=>'good_tenant'} , :regions_list => {"North"=> [{:service=>"compute", :versionId=>nil}, {:service=>"nova", :versionId=>nil}], "South"=>[{:service=>"compute", :versionId=>nil}, {:service=>"nova", :versionId=>nil}] }, :authkey => 'bad_key', :auth_host => "a.b.c", :auth_port => "443", :auth_scheme => "https", :auth_path => "/v2.0", :authok= => true, :authtoken= => true, :service_host= => "", :service_path= => "", :service_path => "", :service_port= => "", :service_scheme= => "", :proxy_host => nil, :proxy_port => nil, :api_path => '/foo', :service_type => "compute", :service_name => "cloudServers", :region => "South")
   end
 
-
-  private
   def get_test_auth_server
     json_response = %{{
         "access":{

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstack
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -82,6 +82,10 @@ files:
 - lib/openstack/compute/server.rb
 - lib/openstack/connection.rb
 - lib/openstack/image/connection.rb
+- lib/openstack/network/connection.rb
+- lib/openstack/network/network.rb
+- lib/openstack/network/port.rb
+- lib/openstack/network/subnet.rb
 - lib/openstack/swift/connection.rb
 - lib/openstack/swift/container.rb
 - lib/openstack/swift/storage_object.rb
@@ -114,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: OpenStack Ruby API