deltacloud-client 0.0.2 → 0.0.3

data/bin/deltacloudc

@@ -0,0 +1,152 @@
+#!/bin/env ruby
+#
+# Copyright (C) 2009  Red Hat, Inc.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'rubygems'
+require 'optparse'
+require 'uri'
+require 'deltacloud'
+
+options = {
+  :verbose => false
+}
+
+@optparse = OptionParser.new do |opts|
+
+opts.banner = <<BANNER
+Usage:
+deltacloudc collection operation [options]
+
+URL format:
+API_URL=http://[user]:[password]@[api_url][port][/uri]
+
+Options:
+BANNER
+  opts.on( '-i', '--id ID', 'ID for operation') { |id| options[:id] = id }
+  opts.on( '-d', '--image-id ID', 'Image ID') { |id| options[:image_id] = id }
+  opts.on( '-a', '--arch ARCH', 'Architecture (x86, x86_64)') { |id| options[:architecture] = id }
+  opts.on( '-f', '--flavor_id FLAVOR', 'Flavor') { |id| options[:flavor_id] = id }
+  opts.on( '-n', '--name NAME', 'Name (for instance eg.)') { |name| options[:name] = name }
+  opts.on( '-s', '--state STATE', 'Instance state (RUNNING, STOPPED)') { |state| options[:state] = state }
+  opts.on( '-u', '--url URL', 'API url ($API_URL variable)') { |url| options[:api_url] = url }
+  opts.on( '-l', '--list', 'List collections/operations') { |id| options[:list] = true }
+  opts.on( '-h', '--help', 'Display this screen' ) { puts opts ; exit }
+  opts.on( '-v', '--version', 'Display API version' ) { options[:version]=true }
+  opts.on( '-V', '--verbose', 'Print verbose messages' ) { options[:verbose]=true }
+end
+
+def invalid_usage(error_msg='')
+  puts "ERROR: #{error_msg}"
+  exit(1)
+end
+
+@optparse.parse!
+
+# First try to get API_URL from environment
+options[:api_url] = ENV['API_URL'] if options[:api_url].nil?
+
+url = URI.parse(options[:api_url])
+api_url = "http://#{url.host}#{url.port ? ":#{url.port}" : ''}#{url.path}"
+
+options[:collection] = ARGV[0]
+options[:operation] = ARGV[1]
+
+# Connect to Deltacloud API and fetch all entry points
+client = DeltaCloud.new(url.user, url.password, api_url, { :verbose => options[:verbose] })
+collections = client.entry_points.keys
+
+# Exclude collection which don't have methods in client library yet
+collections.delete(:hardware_profiles)
+collections.delete(:instance_states)
+
+# If list parameter passed print out available collection
+# with API documentation
+if options[:list] and options[:collection].nil?
+  collections.each do |c|
+    doc = client.fetch_documentation(c.to_s)
+    puts sprintf("%-22s: %s", c.to_s[0, 22], doc[:description])
+  end
+  exit(0)
+end
+
+# If collection parameter is present and user requested list
+# print all operation defined for collection with API documentation
+if options[:list] and options[:collection]
+  doc = client.fetch_documentation(options[:collection])
+  doc[:operations].each do |c|
+    puts sprintf("%-20s: %s", c[:name][0, 20], c[:description])
+  end
+  exit(0)
+end
+
+if options[:version]
+  puts "Deltacloud API(#{client.driver_name}) 0.1"
+  exit(0)
+end
+
+# List items from collection (typically /flavors)
+# Do same if 'index' operation is set
+if options[:collection] and ( options[:operation].nil? or options[:operation].eql?('index') )
+  invalid_usage("Unknown collection: #{options[:collection]}") unless collections.include?(options[:collection].to_sym)
+  params = {}
+  params.merge!(:architecture => options[:architecture]) if options[:architecture]
+  params.merge!(:id => options[:id]) if options[:id]
+  params.merge!(:state => options[:state]) if options[:state]
+  client.send(options[:collection].to_s, params).each do |model|
+    puts model.to_plain
+  end
+  exit(0)
+end
+
+if options[:collection] and options[:operation]
+
+  invalid_usage("Unknown collection: #{options[:collection]}") unless collections.include?(options[:collection].to_sym)
+
+  params = {}
+  params.merge!(:id => options[:id]) if options[:id]
+
+  # If collection is set and requested operation is 'show' just 'singularize'
+  # collection name and print item with specified id (-i parameter)
+  if options[:operation].eql?('show')
+    puts client.send(options[:collection].gsub(/s$/, ''), options[:id] ).to_plain
+    exit(0)
+  end
+
+  # If collection is set and requested operation is create new instance,
+  # --image-id, --flavor-id and --name parameters are used
+  # Returns created instance in plain form
+  if options[:collection].eql?('instances') and options[:operation].eql?('create')
+    params.merge!(:name => options[:name]) if options[:name]
+    params.merge!(:image_id => options[:image_id]) if options[:image_id]
+    params.merge!(:flavor_id => options[:flavor_id]) if options[:flavor_id]
+    instance = client.create_instance(options[:image_id], params)
+    puts instance.to_plain
+    exit(0)
+  end
+
+  # All other operations above collections is done there:
+  if options[:collection].eql?('instances')
+    instance = client.instance(options[:id])
+    instance.send("#{options[:operation]}!".to_s)
+    instance = client.instance(options[:id])
+    puts instance.to_plain
+    exit(0)
+  end
+end
+
+# If all above passed (eg. no parameters)
+puts @optparse

data/lib/dcloud/flavor.rb

@@ -39,5 +39,11 @@ module DCloud
           @architecture = xml.text( 'architecture' )
         end
       end
+
+      def to_plain
+        sprintf("%-15s | %-6s | %10s GB | %10s GB", self.id[0, 15], self.architecture[0,6],
+          self.memory.to_s[0,10], self.storage.to_s[0,10])
+      end
+
     end
 end

data/lib/dcloud/image.rb

@@ -42,5 +42,15 @@ module DCloud
         end
       end
 
+      def to_plain
+        sprintf("%-10s | %-20s | %-6s | %-20s | %15s",
+          self.id[0,10],
+          self.name ? self.name[0, 20]: 'unknown',
+          self.architecture[0,6],
+          self.description[0,20],
+          self.owner_id[0,15]
+        )
+      end
+
     end
 end

data/lib/dcloud/instance.rb

@@ -39,6 +39,17 @@ module DCloud
         super( client, uri, xml )
       end
 
+      def to_plain
+        sprintf("%-15s | %-15s | %-15s | %10s | %32s | %32s",
+          self.id ? self.id[0,15] : '-',
+          self.name ? self.name[0,15] : 'unknown',
+          self.image.name ? self.image.name[0,15] : 'unknown',
+          self.state ? self.state.to_s[0,10] : 'unknown',
+          self.public_addresses.join(',')[0,32],
+          self.private_addresses.join(',')[0,32]
+          )
+      end
+
       def start!()
         url = action_urls['start']
         throw Exception.new( "Unable to start" ) unless url

data/lib/dcloud/realm.rb

@@ -43,5 +43,15 @@ module DCloud
           end
         end
       end
+
+      def to_plain
+        sprintf("%-10s | %-15s | %-5s | %10s GB",
+          self.id[0, 10],
+          self.name[0, 15],
+          self.state[0,5],
+          self.limit.to_s[0,10]
+        )
+      end
+
     end
 end

data/lib/dcloud/storage_snapshot.rb

@@ -27,6 +27,15 @@ module DCloud
       attribute :state
       attribute :storage_volume
 
+      def to_plain
+        sprintf("%-10s | %-15s | %-6s | %15s",
+          self.id[0,10],
+          self.storage_volume.name ? self.storage_volume.name[0, 15] : 'unknown',
+          self.state ? self.state[0,6] : 'unknown',
+          self.created ? self.created[0,15] : 'unknown'
+        )
+      end
+
       def initialize(client, uri, xml=nil)
         super( client, uri, xml )
       end

data/lib/dcloud/storage_volume.rb

@@ -32,6 +32,16 @@ module DCloud
         super( client, uri, xml )
       end
 
+      def to_plain
+        sprintf("%-10s | %15s GB | %-10s | %-10s | %-15s",
+          self.id[0,10],
+          self.capacity ? self.capacity.to_s[0,15] : 'unknown',
+          self.device ? self.device[0,10] : 'unknown',
+          self.state ? self.state[0,10] : 'unknown',
+          self.instance ? self.instance.name[0,15] : 'unknown'
+        )
+      end
+
       def load_payload(xml=nil)
         super(xml)
         unless xml.nil?

data/lib/deltacloud.rb

@@ -28,20 +28,13 @@ require 'dcloud/state'
 require 'dcloud/transition'
 require 'base64'
 
-module RestClient
-  class Response
-    def body
-      self.to_s
-    end
-  end
-end
-
 class DeltaCloud
 
   attr_accessor :logger
   attr_reader   :api_uri
   attr_reader   :entry_points
   attr_reader   :driver_name
+  attr_reader   :last_request_xml
 
   def self.driver_name(url)
     DeltaCloud.new( nil, nil, url) do |client|
@@ -49,12 +42,13 @@ class DeltaCloud
     end
   end
 
-  def initialize(name, password, api_uri, &block)
+  def initialize(name, password, api_uri, opts={}, &block)
     @logger       = Logger.new( STDERR )
     @name         = name
     @password     = password
     @api_uri      = URI.parse( api_uri )
     @entry_points = {}
+    @verbose      = opts[:verbose]
     discover_entry_points
     connect( &block )
     self
@@ -94,7 +88,7 @@ class DeltaCloud
 
   def flavor(id)
     request( entry_points[:flavors], :get, {:id=>id } ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( '/flavor' ).each do |flavor|
         uri = flavor.attributes['href']
         return DCloud::Flavor.new( self, uri, flavor )
@@ -110,7 +104,7 @@ class DeltaCloud
 
   def fetch_resource(type, uri)
     request( uri ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       if ( doc.root && ( doc.root.name == type.to_s.gsub( /_/, '-' ) ) )
         return doc.root
       end
@@ -118,10 +112,42 @@ class DeltaCloud
     nil
   end
 
+  def fetch_documentation(collection, operation=nil)
+    response = @http["docs/#{collection}#{operation ? "/#{operation}" : ''}"].get(:accept => "application/xml")
+    doc = REXML::Document.new( response.to_s )
+    if operation.nil?
+      docs = {
+        :name => doc.get_elements('docs/collection').first.attributes['name'],
+        :description => doc.get_elements('docs/collection/description').first.text,
+        :operations => []
+      }
+      doc.get_elements('docs/collection/operations/operation').each do |operation|
+        p = {}
+        p[:name] = operation.attributes['name']
+        p[:description] = operation.get_elements('description').first.text
+        p[:parameters] = []
+        operation.get_elements('parameter').each do |param|
+          p[:parameters] << param.attributes['name']
+        end
+        docs[:operations] << p
+      end
+    else
+      docs = {
+        :name => doc.get_elements('docs/operation').attributes['name'],
+        :description => doc.get_elements('docs/operation/description').first.text,
+        :parameters => []
+      }
+      doc.get_elements('docs/operation/parameter').each do |param|
+        docs[:parameters] << param.attributes['name']
+      end
+    end
+    docs
+  end
+
   def instance_states
     states = []
     request( entry_points[:instance_states] ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'states/state' ).each do |state_elem|
         state = DCloud::State.new( state_elem.attributes['name'] )
         state_elem.get_elements( 'transition' ).each do |transition_elem|
@@ -144,7 +170,7 @@ class DeltaCloud
   def realms(opts={})
     realms = []
     request( entry_points[:realms], :get, opts ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'realms/realm' ).each do |realm|
         uri = realm.attributes['href']
         realms << DCloud::Realm.new( self, uri, realm )
@@ -155,7 +181,7 @@ class DeltaCloud
 
   def realm(id)
     request( entry_points[:realms], :get, {:id=>id } ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'realm' ).each do |realm|
         uri = realm.attributes['href']
         return DCloud::Realm.new( self, uri, realm )
@@ -174,7 +200,7 @@ class DeltaCloud
     images = []
     request_path = entry_points[:images]
     request( request_path, :get, opts ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'images/image' ).each do |image|
         uri = image.attributes['href']
         images << DCloud::Image.new( self, uri, image )
@@ -185,7 +211,7 @@ class DeltaCloud
 
   def image(id)
     request( entry_points[:images], :get, {:id=>id } ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'image' ).each do |instance|
         uri = instance.attributes['href']
         return DCloud::Image.new( self, uri, instance )
@@ -194,10 +220,10 @@ class DeltaCloud
     nil
   end
 
-  def instances
+  def instances(opts={})
     instances = []
-    request( entry_points[:instances] ) do |response|
-      doc = REXML::Document.new( response.body )
+    request( entry_points[:instances], :get, opts ) do |response|
+      doc = REXML::Document.new( response )
       doc.get_elements( 'instances/instance' ).each do |instance|
         uri = instance.attributes['href']
         instances << DCloud::Instance.new( self, uri, instance )
@@ -208,7 +234,7 @@ class DeltaCloud
 
   def instance(id)
     request( entry_points[:instances], :get, {:id=>id } ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'instance' ).each do |instance|
         uri = instance.attributes['href']
         return DCloud::Instance.new( self, uri, instance )
@@ -242,17 +268,17 @@ class DeltaCloud
 
     params[:image_id] = image_id
     request( entry_points[:instances], :post, {}, params ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       instance = doc.root
       uri = instance.attributes['href']
       return DCloud::Instance.new( self, uri, instance )
     end
   end
 
-  def storage_volumes
+  def storage_volumes(opts={})
     storage_volumes = []
     request( entry_points[:storage_volumes] ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'storage-volumes/storage-volume' ).each do |instance|
         uri = instance.attributes['href']
         storage_volumes << DCloud::StorageVolume.new( self, uri, instance )
@@ -263,7 +289,7 @@ class DeltaCloud
 
   def storage_volume(id)
     request( entry_points[:storage_volumes], :get, {:id=>id } ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'storage-volume' ).each do |storage_volume|
         uri = storage_volume.attributes['href']
         return DCloud::StorageVolume.new( self, uri, storage_volume )
@@ -278,10 +304,10 @@ class DeltaCloud
     nil
   end
 
-  def storage_snapshots()
+  def storage_snapshots(opts={})
     storage_snapshots = []
     request( entry_points[:storage_snapshots] ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'storage-snapshots/storage-snapshot' ).each do |instance|
         uri = instance.attributes['href']
         storage_snapshots << DCloud::StorageSnapshot.new( self, uri, instance )
@@ -292,7 +318,7 @@ class DeltaCloud
 
   def storage_snapshot(id)
     request( entry_points[:storage_snapshots], :get, {:id=>id } ) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       doc.get_elements( 'storage-snapshot' ).each do |storage_snapshot|
         uri = storage_snapshot.attributes['href']
         return DCloud::StorageSnapshot.new( self, uri, storage_snapshot )
@@ -319,7 +345,7 @@ class DeltaCloud
 
   def discover_entry_points
     request(api_uri.to_s) do |response|
-      doc = REXML::Document.new( response.body )
+      doc = REXML::Document.new( response )
       @driver_name = doc.root.attributes['driver']
       doc.get_elements( 'api/link' ).each do |link|
         rel = link.attributes['rel']
@@ -345,11 +371,19 @@ class DeltaCloud
       :authorization => "Basic "+Base64.encode64("#{@name}:#{@password}"),
       :accept => "application/xml"
     }
-    logger << "Request [#{method.to_s.upcase}] #{request_path}]\n"
+
+    logger << "Request [#{method.to_s.upcase}] #{request_path}]\n"  if @verbose
+
     if method.eql?(:get)
-      RestClient.send(method, request_path, headers, &block)
+      RestClient.send(method, request_path, headers) do |response|
+        @last_request_xml = response
+        yield response.to_s
+      end
     else
-      RestClient.send(method, request_path, form_data, headers, &block)
+      RestClient.send(method, request_path, form_data, headers) do |response|
+        @last_request_xml = response
+        yield response.to_s
+      end
     end
   end
 

data/specs/instances_spec.rb

@@ -81,8 +81,8 @@ describe "instances" do
     DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
       instance = client.create_instance( 'img1', :name=>'TestInstance' )
       instance.should_not be_nil
-      instance.uri.should eql( API_URL + '/instances/inst3' )
-      instance.id.should eql( 'inst3' )
+      instance.uri.should match( %r{#{API_URL}/instances/inst[0-9]+} )
+      instance.id.should match( /inst[0-9]+/ )
       instance.name.should eql( 'TestInstance' )
       instance.image.id.should eql( 'img1' )
       instance.flavor.id.should eql( 'm1-large' )
@@ -94,8 +94,8 @@ describe "instances" do
     DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
       instance = client.create_instance( 'img1', :realm=>'eu' )
       instance.should_not be_nil
-      instance.uri.should eql( API_URL + '/instances/inst3' )
-      instance.id.should eql( 'inst3' )
+      instance.uri.should match( %r{#{API_URL}/instances/inst[0-9]+} )
+      instance.id.should match( /inst[0-9]+/ )
       instance.image.id.should eql( 'img1' )
       instance.flavor.id.should eql( 'm1-large' )
       instance.realm.id.should eql( 'eu' )
@@ -106,8 +106,8 @@ describe "instances" do
     DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
       instance = client.create_instance( 'img1', :flavor=>'m1-xlarge' )
       instance.should_not be_nil
-      instance.uri.should eql( API_URL + '/instances/inst3' )
-      instance.id.should eql( 'inst3' )
+      instance.uri.should match( %r{#{API_URL}/instances/inst[0-9]+} )
+      instance.id.should match( /inst[0-9]+/ )
       instance.image.id.should eql( 'img1' )
       instance.flavor.id.should eql( 'm1-xlarge' )
       instance.realm.id.should eql( 'us' )
@@ -118,8 +118,8 @@ describe "instances" do
     DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
       instance = client.create_instance( 'img1', :realm=>'eu', :flavor=>'m1-xlarge' )
       instance.should_not be_nil
-      instance.uri.should eql( API_URL + '/instances/inst3' )
-      instance.id.should eql( 'inst3' )
+      instance.uri.should match( %r{#{API_URL}/instances/inst[0-9]+} )
+      instance.id.should match( /inst[0-9]+/ )
       instance.image.id.should eql( 'img1' )
       instance.flavor.id.should eql( 'm1-xlarge' )
       instance.realm.id.should eql( 'eu' )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: deltacloud-client
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Red Hat, Inc.
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 -05:00
-default_executable: 
+date: 2010-03-04 00:00:00 -05:00
+default_executable: deltacloudc
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -22,10 +22,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.3.1
     version: 
-description: Deltacloud REST Client
+description: Deltacloud REST Client for API
 email: deltacloud-users@lists.fedorahosted.org
-executables: []
-
+executables: 
+- deltacloudc
 extensions: []
 
 extra_rdoc_files: 
@@ -44,6 +44,7 @@ files:
 - lib/dcloud/transition.rb
 - lib/deltacloud.rb
 - init.rb
+- bin/deltacloudc
 - COPYING
 has_rdoc: true
 homepage: http://www.deltacloud.org