openstack-compute 1.1.0.pre0 → 1.1.0

data/README.rdoc

@@ -2,7 +2,9 @@
 
 == Description
 
-Ruby Openstack Compute binding.
+Ruby Openstack Compute binding for the v1.0 OSAPI.
+
+Currently supports both v1.0 and v2.0 (keystone) auth.
 
 == Examples
 
@@ -10,7 +12,7 @@ See the class definitions for documentation on specific methods and operations.
 
   require 'openstack/compute'
 
-  cs = OpenStack::Compute::Connection.new(:username => USERNAME, :api_key => API_KEY, :api_url => API_URL)	
+  cs = OpenStack::Compute::Connection.new(:username => USERNAME, :api_key => API_KEY, :auth_url => API_URL)	
 
   # Get a listing of all current servers
   >> cs.servers
@@ -44,7 +46,7 @@ See the class definitions for documentation on specific methods and operations.
   => #<OpenStack::Compute::Flavor:0x101469130 @disk=20, @name="512 server", @id=2, @ram=512>
   >> flavor.name
   => "512 server"
-  >> newserver = cs.create_server(:name => "New Server", :imageId => image.id, :flavorId => flavor.id)
+  >> newserver = cs.create_server(:name => "New Server", :imageRef => image.id, :flavorRef => flavor.id)
   => #<OpenStack::Compute::Server:0x101433f08 ....
   >> newserver.status
   => "BUILD"

data/VERSION

@@ -1 +1 @@
-1.1.0.pre0
+1.1.0

data/lib/openstack/compute.rb

@@ -9,7 +9,7 @@
 # To begin reviewing the available methods and examples, view the README.rdoc file, or begin by looking at documentation for the OpenStack::Compute::Connection class.
 #
 # Example:
-# OpenStack::Compute::Connection.new(:username => USERNAME, :api_key => API_KEY, :api_url => API_URL) method.
+# OpenStack::Compute::Connection.new(:username => USERNAME, :api_key => API_KEY, :auth_url => API_URL) method.
 module OpenStack
 module Compute
 

data/lib/openstack/compute/authentication.rb

@@ -1,19 +1,70 @@
 module OpenStack
 module Compute
+
   class Authentication
+
+    # Performs an authentication to the OpenStack auth server.
+    # If it succeeds, it sets the svrmgmthost, svrmgtpath, svrmgmtport,
+    # svrmgmtscheme, authtoken, and authok variables on the connection.
+    # If it fails, it raises an exception.
+    def self.init(conn)
+      if conn.auth_path =~ /.*v2.0\/?$/
+        AuthV20.new(conn)
+      else
+        AuthV10.new(conn)
+      end
+    end
+
+  end
+
+  private
+  class AuthV20
+    
+    def initialize(connection)
+      begin
+        server = Net::HTTP::Proxy(connection.proxy_host, connection.proxy_port).new(connection.auth_host, connection.auth_port)
+        if connection.auth_scheme == "https"
+          server.use_ssl = true
+          server.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        server.start
+      rescue
+        raise OpenStack::Compute::Exception::Connection, "Unable to connect to #{server}"
+      end
+
+      auth_data = JSON.generate({ "passwordCredentials" => { "username" => connection.authuser, "password" => connection.authkey }})
+      response = server.post(connection.auth_path.chomp("/")+"/tokens", auth_data, {'Content-Type' => 'application/json'})
+      if (response.code =~ /^20./)
+        resp_data=JSON.parse(response.body)
+        connection.authtoken = resp_data['auth']['token']['id']
+        if resp_data['auth']['serviceCatalog'] and resp_data['auth']['serviceCatalog'][connection.service_name] and resp_data['auth']['serviceCatalog'][connection.service_name][0] then
+          uri = URI.parse(resp_data['auth']['serviceCatalog'][connection.service_name][0]['publicURL'])
+          connection.svrmgmthost = uri.host
+          connection.svrmgmtpath = uri.path
+          # Force the path into the v1.1 URL space
+          connection.svrmgmtpath.sub!(/\/.*\/?/, '/v1.1/')
+          connection.svrmgmtpath += connection.authtenant
+          connection.svrmgmtport = uri.port
+          connection.svrmgmtscheme = uri.scheme
+          connection.authok = true
+        else
+          connection.authok = false
+        end
+      else
+        connection.authtoken = false
+        raise OpenStack::Compute::Exception::Authentication, "Authentication failed with response code #{response.code}"
+      end
+      server.finish
+    end
+  end
+
+  class AuthV10
     
-    # Performs an authentication to the OpenStack authorization servers.  Opens a new HTTP connection to the API server,
-    # sends the credentials, and looks for a successful authentication.  If it succeeds, it sets the svrmgmthost,
-    # svrmgtpath, svrmgmtport, svrmgmtscheme, authtoken, and authok variables on the connection.  If it fails, it raises
-    # an exception.
-    #
-    # Should probably never be called directly.
     def initialize(connection)
-      path = connection.api_path
       hdrhash = { "X-Auth-User" => connection.authuser, "X-Auth-Key" => connection.authkey }
       begin
-        server = Net::HTTP::Proxy(connection.proxy_host, connection.proxy_port).new(connection.api_host, connection.api_port)
-        if connection.api_scheme == "https"
+        server = Net::HTTP::Proxy(connection.proxy_host, connection.proxy_port).new(connection.auth_host, connection.auth_port)
+        if connection.auth_scheme == "https"
           server.use_ssl = true
           server.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
@@ -21,14 +72,17 @@ module Compute
       rescue
         raise OpenStack::Compute::Exception::Connection, "Unable to connect to #{server}"
       end
-      response = server.get(path,hdrhash)
+      response = server.get(connection.auth_path, hdrhash)
       if (response.code =~ /^20./)
         connection.authtoken = response["x-auth-token"]
-        connection.svrmgmthost = URI.parse(response["x-server-management-url"]).host
-        connection.svrmgmtpath = URI.parse(response["x-server-management-url"]).path
-        # Force the path into the v1.0 URL space
-        connection.svrmgmtport = URI.parse(response["x-server-management-url"]).port
-        connection.svrmgmtscheme = URI.parse(response["x-server-management-url"]).scheme
+        uri = URI.parse(response["x-server-management-url"])
+        connection.svrmgmthost = uri.host
+        connection.svrmgmtpath = uri.path
+        # Force the path into the v1.1 URL space
+        connection.svrmgmtpath.sub!(/\/.*\/?/, '/v1.1/')
+        connection.svrmgmtpath += connection.authtenant
+        connection.svrmgmtport = uri.port
+        connection.svrmgmtscheme = uri.scheme
         connection.authok = true
       else
         connection.authtoken = false
@@ -37,5 +91,6 @@ module Compute
       server.finish
     end
   end
+
 end
 end

data/lib/openstack/compute/connection.rb

@@ -3,6 +3,7 @@ module Compute
   class Connection
     
     attr_reader   :authuser
+    attr_reader   :authtenant
     attr_reader   :authkey
     attr_accessor :authtoken
     attr_accessor :authok
@@ -10,10 +11,11 @@ module Compute
     attr_accessor :svrmgmtpath
     attr_accessor :svrmgmtport
     attr_accessor :svrmgmtscheme
-    attr_reader   :api_host
-    attr_reader   :api_port
-    attr_reader   :api_scheme
-    attr_reader   :api_path
+    attr_reader   :auth_host
+    attr_reader   :auth_port
+    attr_reader   :auth_scheme
+    attr_reader   :auth_path
+    attr_accessor :service_name
     attr_reader   :proxy_host
     attr_reader   :proxy_port
     
@@ -22,37 +24,40 @@ module Compute
     # The constructor takes a hash of options, including:
     #
     #   :username - Your Openstack username *required*
+    #   :tenant - Your Openstack tenant *required*. Defaults to username.
     #   :api_key - Your Openstack API key *required*
-    #   :api_url - The url of the Openstack Compute API server.
+    #   :auth_url - Configurable auth_url endpoint.
+    #   :service_name - (Optional for v2.0 auth only). The name of the compute service to use. Defaults to 'nova'.
     #   :retry_auth - Whether to retry if your auth token expires (defaults to true)
     #   :proxy_host - If you need to connect through a proxy, supply the hostname here
     #   :proxy_port - If you need to connect through a proxy, supply the port here
     #
-    #   cf = OpenStack::Compute::Connection.new(:username => 'USERNAME', :api_key => 'API_KEY', :api_url => 'API_URL')
+    #   cs = OpenStack::Compute::Connection.new(:username => 'USERNAME', :api_key => 'API_KEY', :auth_url => 'AUTH_URL')
     def initialize(options = {:retry_auth => true}) 
       @authuser = options[:username] || (raise Exception::MissingArgument, "Must supply a :username")
       @authkey = options[:api_key] || (raise Exception::MissingArgument, "Must supply an :api_key")
-      @api_url = options[:api_url] || (raise Exception::MissingArgument, "Must supply an :api_url")
+      @auth_url = options[:auth_url] || (raise Exception::MissingArgument, "Must supply an :auth_url")
+      @authtenant = options[:authtenant] || @authuser
+      @service_name = options[:service_name] || "nova"
       @is_debug = options[:is_debug]
 
-      api_uri=nil
+      auth_uri=nil
       begin
-        api_uri=URI.parse(@api_url)
+        auth_uri=URI.parse(@auth_url)
       rescue Exception => e
-        raise Exception::InvalidArgument, "Invalid :api_url parameter: #{e.message}"
+        raise Exception::InvalidArgument, "Invalid :auth_url parameter: #{e.message}"
       end
-      raise Exception::InvalidArgument, "Invalid :api_url parameter." if api_uri.nil? or api_uri.host.nil?
-      @api_host = api_uri.host
-      @api_port = api_uri.port
-      @api_scheme = api_uri.scheme
-      @api_path = api_uri.path.sub(/\/$/, '')
-
+      raise Exception::InvalidArgument, "Invalid :auth_url parameter." if auth_uri.nil? or auth_uri.host.nil?
+      @auth_host = auth_uri.host
+      @auth_port = auth_uri.port
+      @auth_scheme = auth_uri.scheme
+      @auth_path = auth_uri.path
       @retry_auth = options[:retry_auth]
       @proxy_host = options[:proxy_host]
       @proxy_port = options[:proxy_port]
       @authok = false
       @http = {}
-      OpenStack::Compute::Authentication.new(self)
+      OpenStack::Compute::Authentication.init(self)
     end
     
     # Returns true if the authentication was successful and returns false otherwise.
@@ -88,7 +93,7 @@ module Compute
       retry
     rescue OpenStack::Compute::Exception::ExpiredAuthToken
       raise OpenStack::Compute::Exception::Connection, "Authentication token expired and you have requested not to retry" if @retry_auth == false
-      OpenStack::Compute::Authentication.new(self)
+      OpenStack::Compute::Authentication.init(self)
       retry
     end
 
@@ -145,11 +150,11 @@ module Compute
     #
     # You can also provide :limit and :offset parameters to handle pagination.
     #   >> cs.list_servers_detail
-    #   => [{:name=>"MyServer", :addresses=>{:public=>["67.23.42.37"], :private=>["10.176.241.237"]}, :metadata=>{"MyData" => "Valid"}, :imageId=>10, :progress=>100, :hostId=>"36143b12e9e48998c2aef79b50e144d2", :flavorId=>1, :id=>110917, :status=>"ACTIVE"}]
+    #   => [{:name=>"MyServer", :addresses=>{:public=>["67.23.42.37"], :private=>["10.176.241.237"]}, :metadata=>{"MyData" => "Valid"}, :imageRef=>10, :progress=>100, :hostId=>"36143b12e9e48998c2aef79b50e144d2", :flavorRef=>1, :id=>110917, :status=>"ACTIVE"}]
     #
     #   >> cs.list_servers_detail(:limit => 2, :offset => 3)
-    #   => [{:status=>"ACTIVE", :imageId=>10, :progress=>100, :metadata=>{}, :addresses=>{:public=>["x.x.x.x"], :private=>["x.x.x.x"]}, :name=>"demo-standingcloud-lts", :id=>168867, :flavorId=>1, :hostId=>"xxxxxx"}, 
-    #       {:status=>"ACTIVE", :imageId=>8, :progress=>100, :metadata=>{}, :addresses=>{:public=>["x.x.x.x"], :private=>["x.x.x.x"]}, :name=>"demo-aicache1", :id=>187853, :flavorId=>3, :hostId=>"xxxxxx"}]
+    #   => [{:status=>"ACTIVE", :imageRef=>10, :progress=>100, :metadata=>{}, :addresses=>{:public=>["x.x.x.x"], :private=>["x.x.x.x"]}, :name=>"demo-standingcloud-lts", :id=>168867, :flavorRef=>1, :hostId=>"xxxxxx"}, 
+    #       {:status=>"ACTIVE", :imageRef=>8, :progress=>100, :metadata=>{}, :addresses=>{:public=>["x.x.x.x"], :private=>["x.x.x.x"]}, :name=>"demo-aicache1", :id=>187853, :flavorRef=>3, :hostId=>"xxxxxx"}]
     def list_servers_detail(options = {})
       path = OpenStack::Compute.paginate(options).empty? ? "#{svrmgmtpath}/servers/detail" : "#{svrmgmtpath}/servers/detail?#{OpenStack::Compute.paginate(options)}"
       response = csreq("GET",svrmgmthost,path,svrmgmtport,svrmgmtscheme)
@@ -206,7 +211,7 @@ module Compute
     end
     
     # Returns an array of hashes listing available server images that you have access too, including stock OpenStack Compute images and 
-    # any that you have created.  The "id" key in the hash can be used where imageId is required.
+    # any that you have created.  The "id" key in the hash can be used where imageRef is required.
     #
     # You can also provide :limit and :offset parameters to handle pagination.
     #
@@ -235,7 +240,7 @@ module Compute
     end
     alias :image :get_image
     
-    # Returns an array of hashes listing all available server flavors.  The :id key in the hash can be used when flavorId is required.
+    # Returns an array of hashes listing all available server flavors.  The :id key in the hash can be used when flavorRef is required.
     #
     # You can also provide :limit and :offset parameters to handle pagination.
     #

data/lib/openstack/compute/image.rb

@@ -6,10 +6,12 @@ module Compute
 
     attr_reader :id
     attr_reader :name
-    attr_reader :serverId
+    attr_reader :server
     attr_reader :updated
     attr_reader :created
     attr_reader :status
+    attr_reader :minDisk
+    attr_reader :minRam
     attr_reader :progress
     attr_reader :metadata
     
@@ -41,12 +43,14 @@ module Compute
       data = JSON.parse(response.body)['image']
       @id = data['id']
       @name = data['name']
-      @serverId = data['serverId']
+      @server = data['server']
       if data['updated'] then
          @updated = DateTime.parse(data['updated'])
       end
       @created = DateTime.parse(data['created'])
       @status = data['status']
+      @minDisk = data['minDisk']
+      @minRam = data['minRam']
       @progress = data['progress']
       return true
     end

data/lib/openstack/compute/server.rb

@@ -10,8 +10,8 @@ module Compute
     attr_reader   :progress
     attr_reader   :addresses
     attr_reader   :hostId
-    attr_reader   :imageId
-    attr_reader   :flavorId
+    attr_reader   :image
+    attr_reader   :flavor
     attr_reader   :metadata
     attr_accessor :adminPass
     
@@ -54,32 +54,12 @@ module Compute
       @addresses = OpenStack::Compute.symbolize_keys(data["addresses"])
       @metadata  = OpenStack::Compute::ServerMetadata.new(@connection, @id)
       @hostId    = data["hostId"]
-      @imageId   = data["image"]["id"]
-      @flavorId  = data["flavor"]["id"]
+      @image   = data["image"]
+      @flavor  = data["flavor"]
       true
     end
     alias :refresh :populate
     
-    # Returns a new OpenStack::Compute::Flavor object for the flavor assigned to this server.
-    #
-    #   >> flavor = server.flavor
-    #   => #<OpenStack::Compute::Flavor:0x1014aac20 @name="256 server", @disk=10, @id=1, @ram=256>
-    #   >> flavor.name
-    #   => "256 server"
-    def flavor
-      OpenStack::Compute::Flavor.new(@connection, self.flavorId)
-    end
-    
-    # Returns a new OpenStack::Compute::Image object for the image assigned to this server.
-    #
-    #   >> image = server.image
-    #   => #<OpenStack::Compute::Image:0x10149a960 ...>
-    #   >> image.name
-    #   => "Ubuntu 8.04.2 LTS (hardy)"
-    def image
-      OpenStack::Compute::Image.new(@connection, self.imageId)
-    end
-    
     # Sends an API request to reboot this server.  Takes an optional argument for the type of reboot, which can be "SOFT" (graceful shutdown)
     # or "HARD" (power cycle).  The hard reboot is also triggered by server.reboot!, so that may be a better way to call it.
     #
@@ -144,7 +124,7 @@ module Compute
     #
     # This method expects a hash of the form:
     # {
-    #   :imageId => "https://foo.com/v1.1/images/2",
+    #   :imageRef => "https://foo.com/v1.1/images/2",
     #   :name => "newName",
     #   :metadata => { :values => { :foo : "bar" } },
     #   :personality => [
@@ -187,15 +167,15 @@ module Compute
       OpenStack::Compute::Image.new(@connection,JSON.parse(response.body)['image']['id'])
     end
     
-    # Resizes the server to the size contained in the server flavor found at ID flavorId.  The server name, ID number, and IP addresses 
+    # Resizes the server to the size contained in the server flavor found at ID flavorRef.  The server name, ID number, and IP addresses 
     # will remain the same.  After the resize is done, the server.status will be set to "VERIFY_RESIZE" until the resize is confirmed or reverted.
     #
     # Refreshes the OpenStack::Compute::Server object, and returns true if the API call succeeds.
     # 
     #   >> server.resize!(1)
     #   => true
-    def resize!(flavorId)
-      data = JSON.generate(:resize => {:flavorId => flavorId})
+    def resize!(flavorRef)
+      data = JSON.generate(:resize => {:flavorRef => flavorRef})
       response = @connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
       OpenStack::Compute::Exception.raise_exception(response) unless response.code.match(/^20.$/)
       self.populate

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: openstack-compute
 version: !ruby/object:Gem::Version 
-  hash: -1876988165
-  prerelease: true
+  hash: 19
+  prerelease: false
   segments: 
   - 1
   - 1
   - 0
-  - pre0
-  version: 1.1.0.pre0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Dan Prince
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-13 00:00:00 -04:00
+date: 2011-10-14 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,14 +73,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: