openstack 1.0.0 → 1.0.1

data/README.rdoc

@@ -8,6 +8,40 @@ 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')
 
+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' or 'object-store' (defaults to 'compute') - see below for examples.
+
+Other parameters for the create method:
+
+* :auth_url - the OpenStack service provider specific authentication url endpoint.
+* :auth_method - the type of authentication to be used with the above auth_url - either 'password' (username/password, 'key' (ec2 style key/private key)  or 'rax-kskey'.
+* :authtenant_name OR :authtenant_id - one of these MUST be specified when talking to a v2 authentication endpoint (keystone) - depending on whether you use tenant name (or tenant ID). Passing only :authtenant will result in that parameter being used as tenant name.
+* :username - the username or public key (depending on auth_method)
+* :api_key - the password or private key (denending on auth_method).
+
+=== Try it out:
+
+  sudo gem install openstack
+    [sudo] password for herp:
+    Successfully installed openstack-1.0.0
+
+  [herp@name lib]$ irb -rubygems
+  irb(main):001:0> require 'openstack'
+    => true
+
+  irb(main):002:0> os = OpenStack::Connection.create({:username => "herp@derp.net", :api_key=>"1234abcd", :auth_method=>"password", :auth_url => "https://regionerer-g.go-bar.identity.dacloudfoo.herpy:13327/v2.0/", :authtenant_name =>"herp@derp.net-default-tenant", :service_type=>"compute"})
+
+    => #<OpenStack::Compute::Connection:0xb7339070 @connection=#<OpenStack::Connection:0xb73392dc @service_scheme="https", @auth_host="regionerer-g.go-bar.identity.dacloudfoo.herpy", @http={}, @service_name=nil, @authuser="herp@derp.net", @proxy_port=nil, @auth_path="/v2.0/", @authtenant={:type=>"tenantName", :value=>"herp@derp.net-default-tenant"}, @service_port=443, @authkey="1235abcd", @authok=true, @service_type="compute", @auth_method="password", @auth_scheme="https", @service_host="az-2.region-a.geo-1.dacloudfoo.herpy", @is_debug=nil, @proxy_host=nil, @service_path="/v1.1/482195756462871", @auth_port=35357, @auth_url="https://regionerer-g.go-bar.identity.dacloudfoo.herpy:13327/v2.0/", @region=nil, @authtoken="Auth_543254fdsasabd546543a3", @retry_auth=nil>>
+
+  irb(main):003:0> os.servers
+    => []
+
+  irb(main):004:0> os = OpenStack::Connection.create({:username => "AWHFDADHJ32EL6V23GFK", :api_key=>"jd823jFDJEY2/82jfhYteG52AKJAUEY184JHRfeR", :auth_method=> "key", :auth_url => "https://regionerer-g.go-bar.identity.dacloudfoo.herpy:13327/v2.0/", :authtenant_id =>"482195756462871", :service_type=>"object-store"})
+
+    => #<OpenStack::Swift::Connection:0xb72ff2a8 @connection=#<OpenStack::Connection:0xb72ff460 @service_scheme="https", @auth_host="regionerer-g.go-bar.identity.dacloudfoo.herpy", @http={}, @service_name=nil, @authuser="AWHFDADHJ32EL6V23GFK", @proxy_port=nil, @auth_path="/v2.0/", @authtenant={:type=>"tenantId", :value=>"482195756462871"}, @service_port=443, @authkey="jd823jFDJEY2/82jfhYteG52AKJAUEY184JHRfeR", @authok=true, @service_type="object-store", @auth_method="key", @auth_scheme="https", @service_host="region-a.geo-1.objects.dacloudfoo.herpy", @is_debug=nil, @proxy_host=nil, @service_path="/v1.0/482195756462871", @auth_port=35357, @auth_url="https://regionerer-g.go-bar.identity.dacloudfoo.herpy:13327/v2.0/", @region=nil, @authtoken="Auth_543254fdsasabd546543a3", @retry_auth=nil>>
+
+  irb(main):006:0> os.containers
+    => ["herpy_Foo_container", "derpy_bar_bucket"]
+
 == Examples
 
 == For Compute:
@@ -59,10 +93,56 @@ See the class definitions for documentation on specific methods and operations.
   >> newserver.progress
   => 12
 
+  # Create a new server and specify the keyname to be used (some provider support the Keys extension):
+  >> server = os.create_server({:imageRef=>14075, :flavorRef=>100, :key_name=>"my_default_key", :name=>"marios_server"})
+  => #<OpenStack::Compute::Server:0x101433f08 ....
+  >> server.key_name
+  => "my_default_key"
+
   # Delete the new server
   >> newserver.delete!
   => true
 
+=== Compute API extensions.
+
+  # Get info on extensions offered by the given OpenStack provider:
+  >> os.api_extensions
+  => { :os-keypairs     =>  { :links=>[], :updated=>"2011-08-08T00:00:00+00:00", :description=>"Keypair Support",
+                              :namespace=>"http://docs.openstack.org/ext/keypairs/api/v1.1", :name=>"Keypairs",
+                              :alias=>"os-keypairs" },
+       :os-floating_ips =>  { :links=>[], :updated=>"2011-06-16T00:00:00+00:00", :description=>"Floating IPs support",
+                              :namespace=>"http://docs.openstack.org/ext/floating_ips/api/v1.1", :name=>"Floating_ips", :alias=>"os-floating-ips"},
+        ... }
+
+  # Get list of keypairs for current tenant/account:
+  >> os.keypairs
+  => { :key_one => {  :fingerprint  =>  "3f:12:4d:d1:54:f1:f4:3f:fe:a8:12:ec:1a:fb:35:b2",
+                      :public_key   =>  "ssh-rsa AAAAB3Nza923kJ  ...
+                      :name         =>  "key_one"},
+       :key_two =>  { ... },
+      ... }
+
+  # Create new keypair:
+  >> os.create_keypair({:name=>"test_key"})
+  => {  :name         =>  "test_key",
+        :fingerprint  =>  "f1:f3:a2:d3:ca:75:da:f1:06:f4:f7:dc:cc:7d:e1:ca",
+        :user_id      =>  "dev_41247879706381",$
+        :public_key   =>  "ssh-rsa AAAAB3NzaC1y    ...
+        :private_key  =>  "-----BEGIN RSA PRIVATE KEY-----\nMIICXwIBA ... -----END RSA PRIVATE KEY-----\n"
+     }
+
+  # Import keypair:
+  >> os.create_keypair({:name=>"test_key_imported", :public_key=>"sh-rsa AAAAB3Nza923kJ  ..."})
+  => {  :name         =>  "test_key_imported",
+        :fingerprint  =>  "f1:f3:a2:d3:ca:75:da:f1:06:f4:f7:dc:cc:7d:e1:ca",
+        :user_id      =>  "dev_41247879706381",$
+        :public_key   =>  "ssh-rsa AAAAB3Nza ...
+     }
+
+  # Delete Keypair:
+  >> os.delete_keypair("test_key_imported")
+  => true
+
 == Examples for Object-Store:
 
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/openstack/compute/connection.rb

@@ -202,6 +202,117 @@ module Compute
       OpenStack.symbolize_keys(JSON.parse(response.body)['limits'])
     end
 
+# ==============================
+#  API EXTENSIONS
+#
+#  http://nova.openstack.org/api_ext/index.html
+#  http://api.openstack.org/ (grep 'Compute API Extensions')
+#
+
+
+    #query the openstack provider for any implemented extensions to the compute API
+    #returns a hash with openstack service provider's returned details
+    #about the implemented extensions, e.g.:
+    #
+    # { :os-floating_ips =>  { :links=>[],
+    #                       :updated=>"2011-06-16T00:00:00+00:00",
+    #                       :description=>"Floating IPs support",
+    #                       :namespace=>"http://docs.openstack.org/ext/floating_ips/api/v1.1",
+    #                       :name=>"Floating_ips", :alias=>"os-floating-ips"},
+    #   :os-keypairs     =>  { :links=>[],
+    #                       :updated=>"2011-08-08T00:00:00+00:00",
+    #                       :description=>"Keypair Support",
+    #                       :namespace=>"http://docs.openstack.org/ext/keypairs/api/v1.1",
+    #                       :name=>"Keypairs",
+    #                       :alias=>"os-keypairs"}
+    # }
+    #
+    def api_extensions
+      response = @connection.req("GET", "/extensions")
+      OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
+      res = OpenStack.symbolize_keys(JSON.parse(response.body))
+      res[:extensions].inject({}){|result, c| result[c[:alias].to_sym] = c  ; result}
+    end
+
+    # Retrieve a list of key pairs associated with the current authenticated account
+    # Will return a hash:
+    #  { :key_one => {  :fingerprint  =>  "3f:12:4d:d1:54:f1:f4:3f:fe:a8:12:ec:1a:fb:35:b2",
+    #                   :public_key   =>  "ssh-rsa AAAAB3Nza923kJU123AADAQABAAAAg928JUwydszi029kIJudfOzQ7o160Ll1ItybDzYYcCAJ/N02loIKJU17264520bmXZFSsaZf2ErX3nSBNI3K+2zQzu832jkhkfdsa7GHH5hvNOxO7u800894312JKLJLHP/R91fdsajHKKJADSAgQ== nova@nv-zz2232-api0002\n",
+    #                   :name         =>  "key_one"},
+    #
+    #    :key_two =>  { :fingerprint  =>  "6b:32:dd:d2:51:c1:f2:3a:fb:a2:52:3a:1a:bb:25:1b",
+    #                   :public_key   =>  "ssh-rsa AKIJUuw71645kJU123AADAQABAAAAg928019oiUJY12765IJudfOzQ7o160Ll1ItybDzYYcCAJ/N80438012480321jhkhKJlfdsazu832jkhkfdsa7GHH5fdasfdsajlj2999789799987989894312JKLJLHP/R91fdsajHKKJADSAgQ== nova@bv-fdsa32-api0002\n",
+    #                   :name         =>  "key_two"}
+    #  }
+    #
+    # Raises OpenStack::Exception::NotImplemented if the current provider doesn't
+    # offer the os-keypairs extension
+    #
+    def keypairs
+      begin
+        response = @connection.req("GET", "/os-keypairs")
+        res = OpenStack.symbolize_keys(JSON.parse(response.body))
+        res[:keypairs].inject({}){|result, c| result[c[:keypair][:name].to_sym] = c[:keypair] ; result }
+      rescue OpenStack::Exception::ItemNotFound => not_found
+        msg = "The os-keypairs extension is not implemented for the provider you are talking to "+
+              "- #{@connection.http.keys.first}"
+        raise OpenStack::Exception::NotImplemented.new(msg, 501, "#{not_found.message}")
+      end
+    end
+
+    # Create a new keypair for use with launching servers. Raises
+    # a OpenStack::Exception::NotImplemented if os-keypairs extension
+    # is not implemented (or not advertised) by the OpenStack provider.
+    #
+    # The 'name' parameter MUST be supplied, otherwise a
+    # OpenStack::Exception::MissingArgument will be raised.
+    #
+    # Optionally requests can specify a 'public_key' parameter,
+    # with the full public ssh key (String) to be used to create the keypair
+    # (i.e. import a existing key).
+    #
+    # Returns a hash with details of the new key; the :private_key attribute
+    # must be saved must be saved by caller (not retrievable thereafter).
+    # NOTE: when the optional :public_key parameter is given, the response
+    # will obviously NOT contain the :private_key attribute.
+    #
+    # >> os.create_keypair({:name=>"test_key"})
+    # => {  :name         =>  "test_key",
+    #       :fingerprint  =>  "f1:f3:a2:d3:ca:75:da:f1:06:f4:f7:dc:cc:7d:e1:ca",
+    #       :user_id      =>  "dev_41247879706381",
+    #       :public_key   =>  "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDgGhDH3z9uMAvPV8ziE9BCEjHCPXGufy5bOgY5mY5jOSfdmKspdbl0z/LimHVKRDNX6HoL5qRg5V/tGH/NYP5sX2zF/XRKz16lfBxiUL1EONXA9fsTEBR3FGp8NcA7hW2+YiUxWafms4If3NFqttTQ11XqTU8JCMvms4D81lhbiQ== nova@use03147k5-eth0\n",
+    #       :private_key  =>  "-----BEGIN RSA PRIVATE KEY-----\nMIICXwIBAAKBgQDgGhDH3z9uMAvPV8ziE9BCEjHCPXGufy5bOgY5mY5jOSfdmKsp\ndbl0z/LimHVKRDNX6HoL5qRg5V/tGH/NYP5sX2zF/XRKz16lfBxiUL1EONXA9fsT\nEBR3FGp8NcA7hW2+YiUxWafms4If3NFqttTQ11XqTU8JCMvms4D81lhbiQIDAQAB\nAoGBAJ1akAfXwNEc2V4IV2sy4FtULS4nOKh+0szpjC9rm+gd3Nki9qQQ7lyQGwpy\nZID2LFsAeJnco/UJefaf6jUKcvnS7tlxMuQB8DBlepiDqnnec0EiEAVmmt9GWlYZ\nJgfGWqDzI1WtouDCIsOhx1Vq7Foue6pgOnibktg2kfYnH9IRAkEA9tKzhlr9rFui\nbVDkiRJK3VTIhKyk4davDjqPJFLJ+4+77wRW164sGxwReD7HtW6qVtJd1MFvqLDO\nqJJEsqDvXQJBAOhvGaWiAPSuP+/z6GE6VXB1pADQFTYIp2DXUa5DcStTGe7hGF1b\nDeAxpDNBbLO3YKYqi2L9vJcIsp5PkHlEVh0CQQCVLIkWBb5VQliryv0knuqiVFCQ\nZyuL1s2cQuYqZOLwaFGERtIZrom3pMImM4NN82F98cyF/pb2lE2CckyUzVF9AkEA\nqhwFjS9Pu8N7j8XWoLHsre2rJd0kaPNUbI+pe/xn6ula5XVgO5LUSOyL2+daAv2G\ngpZIhR5m07LN5wccGWRmEQJBALZRenXaSyX2R2C9ag9r2gaU8/h+aU9he5kjXIt8\n+B8wvpvfOkpOAVCQEMxtsDkEixUtI98YKZP60uw+Xzh40YU=\n-----END RSA PRIVATE KEY-----\n"
+    #   }
+    #
+    # Will raise an OpenStack::Exception::BadRequest if an invalid public_key is provided:
+    # >> os.create_keypair({:name=>"marios_keypair_test_invalid", :public_key=>"derp"})
+    # => OpenStack::Exception::BadRequest: Unexpected error while running command.
+    #    Stdout: '/tmp/tmp4kI12a/import.pub is not a public key file.\n'
+    #
+    def create_keypair(options)
+      raise OpenStack::Exception::NotImplemented.new("os-keypairs not implemented by #{@connection.http.keys.first}", 501, "NOT IMPLEMENTED") unless api_extensions[:"os-keypairs"]
+      raise OpenStack::Exception::MissingArgument, "Keypair name must be supplied" unless (options[:name])
+      data = JSON.generate(:keypair => options)
+      response = @connection.req("POST", "/os-keypairs", {:data=>data})
+      res = OpenStack.symbolize_keys(JSON.parse(response.body))
+      res[:keypair]
+    end
+
+    # Delete an existing keypair. Raises OpenStack::Exception::NotImplemented
+    # if os-keypairs extension is not implemented (or not advertised) by the OpenStack provider.
+    #
+    # Returns true if succesful.
+    # >> os.delete_keypair("marios_keypair")
+    # => true
+    #
+    # Will raise OpenStack::Exception::ItemNotFound if specified keypair doesn't exist
+    #
+    def delete_keypair(keypair_name)
+      raise OpenStack::Exception::NotImplemented.new("os-keypairs not implemented by #{@connection.http.keys.first}", 501, "NOT IMPLEMENTED") unless api_extensions[:"os-keypairs"]
+      @connection.req("DELETE", "/os-keypairs/#{keypair_name}")
+      true
+    end
+
   end
 end
 end

data/lib/openstack/compute/server.rb

@@ -16,6 +16,7 @@ module Compute
     attr_reader   :flavor
     attr_reader   :metadata
     attr_accessor :adminPass
+    attr_reader   :key_name
 
     # This class is the representation of a single Server object.  The constructor finds the server identified by the specified
     # ID number, accesses the API via the populate method to get information about that server, and returns the object.
@@ -61,6 +62,7 @@ module Compute
       @hostId    = data["hostId"]
       @image   = data["image"]
       @flavor  = data["flavor"]
+      @key_name = data["key_name"] # if provider uses the keys API extension for accessing servers
       true
     end
     alias :refresh :populate

data/lib/openstack/connection.rb

@@ -37,9 +37,11 @@ class Connection
     #
     #   options hash:
     #
-    #   :username - Your OpenStack username *required*
-    #   :tenant - Your OpenStack tenant *required*. Defaults to username.
-    #   :api_key - Your OpenStack API key *required*
+    #   :auth_method - Type of authentication - 'password', 'key', 'rax-kskey' - defaults to 'password'
+    #   :username - Your OpenStack username or public key, depending on auth_method. *required*
+    #   :authtenant_name OR :authtenant_id - Your OpenStack tenant name or id *required*. Defaults to username.
+    #     passing :authtenant will default to using that parameter as tenant name.
+    #   :api_key - Your OpenStack API key *required* (either private key or password, depending on auth_method)
     #   :auth_url - Configurable auth_url endpoint.
     #   :service_name - (Optional for v2.0 auth only). The optional name of the compute service to use.
     #   :service_type - (Optional for v2.0 auth only). Defaults to "compute"
@@ -72,7 +74,7 @@ class Connection
       @authuser = options[:username] || (raise Exception::MissingArgument, "Must supply a :username")
       @authkey = options[:api_key] || (raise Exception::MissingArgument, "Must supply an :api_key")
       @auth_url = options[:auth_url] || (raise Exception::MissingArgument, "Must supply an :auth_url")
-      @authtenant = options[:authtenant] || @authuser
+      @authtenant = (options[:authtenant_id])? {:type => "tenantId", :value=>options[:authtenant_id]} : {:type=>"tenantName", :value=>(options[:authtenant_name] || options[:authtenant] || @authuser)}
       @auth_method = options[:auth_method] || "password"
       @service_name = options[:service_name] || nil
       @service_type = options[:service_type] || "compute"
@@ -106,7 +108,7 @@ class Connection
         chunked = OpenStack::Swift::ChunkedConnectionWrapper.new(data, 65535)
         request.body_stream = chunked
       else
-        headers['Content-Length'] = (body.respond_to?(:lstat))? body.lstat.size.to_s : ((body.respond_to?(:size))? body.size.to_s : "0")
+        headers['Content-Length'] = (data.respond_to?(:lstat))? data.lstat.size.to_s : ((data.respond_to?(:size))? data.size.to_s : "0")
         hdrhash = headerprep(headers)
         request = Net::HTTP::Put.new(path,hdrhash)
         request.body = data
@@ -260,12 +262,15 @@ class AuthV20
 
     @uri = String.new
 
-    if connection.auth_method == "password"
-      auth_data = JSON.generate({ "auth" =>  { "passwordCredentials" => { "username" => connection.authuser, "password" => connection.authkey }, "tenantName" => connection.authtenant}})
-    elsif connection.auth_method == "rax-kskey"
-      auth_data = JSON.generate({"auth" => {"RAX-KSKEY:apiKeyCredentials" => {"username" => connection.authuser, "apiKey" => connection.authkey}}})
-    else
-      raise Exception::InvalidArgument, "Unrecognized auth method #{connection.auth_method}"
+    case connection.auth_method
+      when "password"
+        auth_data = JSON.generate({ "auth" =>  { "passwordCredentials" => { "username" => connection.authuser, "password" => connection.authkey }, connection.authtenant[:type] => connection.authtenant[:value]}})
+      when "rax-kskey"
+        auth_data = JSON.generate({"auth" => {"RAX-KSKEY:apiKeyCredentials" => {"username" => connection.authuser, "apiKey" => connection.authkey}}})
+      when "key"
+        auth_data = JSON.generate({"auth" => { "apiAccessKeyCredentials" => {"accessKey" => connection.authuser, "secretKey" => connection.authkey}, connection.authtenant[:type] => connection.authtenant[:value]}})
+      else
+        raise Exception::InvalidArgument, "Unrecognized auth method #{connection.auth_method}"
     end
 
     response = server.post(connection.auth_path.chomp("/")+"/tokens", auth_data, {'Content-Type' => 'application/json'})

data/lib/openstack/swift/storage_object.rb

@@ -46,7 +46,7 @@ module Swift
     # cont.create_object("my_new_object", {}, "object data")
     #
     def self.create(container, objectname, headers={}, data=nil)
-      provided_headers = (headers[:metadata] || {}).inject({}){|res, (k,v)| ((k.match /^X-Object-Meta-/i) ? res[k]=v : res["X-Object-Meta-#{k}"]=v) ;res}
+      provided_headers = (headers[:metadata] || {}).inject({}){|res, (k,v)| ((k.to_s.match /^X-Object-Meta-/i) ? res[k.to_s]=v : res["X-Object-Meta-#{k.to_s}"]=v) ;res}
       provided_headers["content-type"] = headers[:content_type] unless headers[:content_type].nil?
       provided_headers["ETag"] = headers[:etag] unless headers[:etag].nil?
       provided_headers["X-Object-Manifest"] = headers[:manifest] unless headers[:manifest].nil?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: openstack
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Dan Prince
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-23 00:00:00 Z
+date: 2012-06-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -58,7 +58,7 @@ files:
 - lib/openstack/swift/connection.rb
 - lib/openstack/swift/container.rb
 - lib/openstack/swift/storage_object.rb
-homepage: https://launchpad.net/ruby-openstack-compute
+homepage: https://github.com/ruby-openstack/ruby-openstack
 licenses: []
 
 post_install_message: