rightstuff 0.0.4 → 0.0.5

data/README.rdoc

@@ -11,10 +11,17 @@ Here is a typical example:
  servers = rs.servers
  servers.each{ |server| puts server.private_ip_address }
 
+ server_arrays = rs.server_arrays
+ servers.each{ |array| puts("Array #{array.nickname} is running #{array.active_instances_count || 0} instances.") }
+
+ active_array = server_arrays.detect{|array| array.active_instances_count.to_i > 0}
+ array_instances = active_array.instances
+ puts("Array #{active_array.nickname}'s private IP address[es]: #{array_instances.map(&:private_ip_address) * ', '}")
+
 Rightstuff::Credentials assumes you have a YAMl file called ~/.rightstuff
 It should be of the form:
- --- 
- :main: 
+ ---
+ :main:
    :credentials:
      :username: myusername
      :password: mypass
@@ -36,6 +43,11 @@ It should be of the form:
 * http://github.com/rightscale/right_aws
 * http://github.com/moneypools/right_api
 
+= Contributors
+
+* joeyates
+* kwerle
+
 = TODO
 
 * Cache connections

data/Rakefile

@@ -5,32 +5,7 @@ require 'rake/rdoctask'
 $:.unshift( File.dirname( __FILE__ ) + '/lib' )
 require 'rightstuff'
 
-ADMIN_FILES          = FileList[ 'COPYING', 'Rakefile', 'README.rdoc' ]
-SOURCE_FILES         = FileList[ 'lib/**/*.rb' ]
-RDOC_FILES           = FileList[ 'COPYING', 'README.rdoc' ] + SOURCE_FILES
-RDOC_OPTS            = [ '--quiet', '--main', 'README.rdoc', '--inline-source' ]
-DESCRIPTION          = 'Another Ruby Interface for RightScale, providing an OO interface for RightScale accounts'
-
-spec = Gem::Specification.new do |s|
-  s.name             = 'rightstuff'
-  s.summary          = 'Another Ruby Interface for RightScale'
-  s.description      = DESCRIPTION
-  s.version          = Rightstuff::VERSION::STRING
-
-  s.homepage         = 'http://github.com/joeyates/rightstuff'
-  s.author           = 'Joe Yates'
-  s.email            = 'joe.g.yates@gmail.com'
-
-  s.files            = ADMIN_FILES +
-                       SOURCE_FILES
-  s.require_paths    = [ 'lib' ]
-  s.add_dependency( 'nokogiri', '>= 1.4.3.1' )
-
-  s.has_rdoc         = true
-  s.rdoc_options     += RDOC_OPTS
-  s.extra_rdoc_files = RDOC_FILES
-  s.rubyforge_project = 'nowarning'
-end
+spec = eval(File.read("rightstuff.gemspec"))
 
 Rake::GemPackageTask.new( spec ) do |pkg|
 end

data/lib/rightstuff.rb

@@ -1,167 +1,18 @@
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'yaml'
-require 'net/https'
-require 'uri'
-require 'nokogiri'
+require 'rightstuff/credentials'
+require 'rightstuff/client'
+require 'rightstuff/base'
+require 'rightstuff/server'
+require 'rightstuff/server_array'
+require 'rightstuff/array_instance'
 
 module Rightstuff
 
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
  
     STRING = [ MAJOR, MINOR, TINY ].join('.')
   end
 
-  # Rightstuff::Credentials imposes no restrictions on the structure of the data
-  # It only requires that:
-  # 1. the user has a file called ~/.credentials,
-  # 2. the the file does not have any permissions for other users,
-  # 3. the file contails YAML::load-able data.
-  module Credentials
-
-    def rightscale_data
-      return @rightscale_data if @rightscale_data
-      raise "Missing credentials file '#{ rightscale_data_path }'" if ! File.exist?( rightscale_data_path )
-      check_permissions
-      @rightscale_data = YAML.load_file( rightscale_data_path )
-    end
-
-    private
-
-    def rightscale_data_path
-      File.expand_path( '~/.rightstuff' )
-    end
-
-    def check_permissions
-      mode = File::Stat.new( rightscale_data_path ).mode
-      if mode & 0066 != 0
-        raise "Permissions on '#{ rightscale_data_path }' too open (currently 0%o), should be 0600" % ( mode & 0666 )
-      end
-    end
-
-  end
-
-  class Base
-
-    def self.load_collection( client, doc )
-      doc.xpath( self.collection_xpath ).collect do | item |
-        self.new( client, item )
-      end
-    end
-
-    def self.extract_attributes( parent )
-      elements = parent.children.collect do | node |
-        node.class == Nokogiri::XML::Element ? node : nil
-      end
-      elements.compact!
-      elements.reduce( {} ) do | memo, element |
-        name = element.name
-        name.gsub!( /-/, '_' )
-        memo[ name.intern ] = element.children[ 0 ].to_s
-        memo
-      end
-    end
-
-    def initialize( client, item )
-      @client     = client
-      @attributes = Base.extract_attributes( item )
-    end
-
-    def method_missing( name, *args, &block )
-      return @attributes[ name ]
-    end
-
-  end
-
-  class Server < Base
-
-    attr_reader :attributes
-
-    def initialize( client, item )
-      @settings = nil
-      @inputs   = nil
-      super
-    end
-
-    def self.collection_xpath
-      '/servers/server'
-    end
-
-    def method_missing( name , *args, &block )
-      result = super
-      return result unless result.nil?
-      return nil    unless @attributes[ :state ] == 'operational'
-      settings unless @settings
-      return @attributes[ name ]
-    end
-
-    def id
-      @attributes[ :href ].split( '/' ).last
-    end
-
-    def inputs
-      return @inputs if @inputs
-      # Add inputs to instance data
-      # @client.get( @attributes[ 'href' ] )
-    end
-
-    def settings
-      return @settings if @settings
-      doc      = @client.get_rest( 'servers/' + id + '/settings' )
-      xml      = Nokogiri::XML( doc )
-      @settings = Base.extract_attributes( xml.children )
-      @attributes.merge!( settings )
-    end
-
-  end
-
-  class Client
-
-    def initialize( options = {} )
-      @username = options[ :username ] or raise 'no username supplied'
-      @password = options[ :password ] or raise 'no password supplied'
-      @account  = options[ :account ]  or raise 'no account id supplied'
-      @account = @account.to_s
-
-      @base_url               = 'https://my.rightscale.com/api/acct'
-      url                     = URI.parse( @base_url )
-      @connection             = Net::HTTP.new( url.host, url.port )
-      @connection.use_ssl     = true
-      @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    end
-
-    def get_rest( rest )
-      get( account_url( rest ) )
-    end
-
-    def get( address )
-      url     = URI.parse( address )
-      request = Net::HTTP::Get.new( url.request_uri )
-      request.add_field( 'X-API-VERSION', '1.0' )
-      request.basic_auth @username, @password
-
-      response = @connection.request( request )
-
-      case response.code
-      when '200'
-        return response.body
-      else
-        raise "Request '#{ address }' failed with response code #{ response.code }\n#{ response.body }"
-      end
-    end
-
-    def servers
-      return @servers if @servers
-      body     = Nokogiri::XML( get_rest( 'servers' ) )
-      @servers = Server.load_collection( self, body )
-    end
-
-    def account_url( rest )
-      @base_url + '/' + @account + '/' + rest
-    end
-
-  end
-
 end

data/lib/rightstuff/array_instance.rb

@@ -0,0 +1,35 @@
+module Rightstuff
+  # http://support.rightscale.com/15-References/RightScale_API_Reference_Guide/02-Management/09-Server_Arrays
+  class ArrayInstance < Base
+
+    attr_reader :attributes
+
+    def initialize( client, item )
+      @inputs   = nil
+      super
+    end
+
+    def self.collection_xpath
+      '/instances/instance'
+    end
+
+    def method_missing( name , *args, &block )
+      result = super
+      return result unless result.nil?
+      return nil    if @attributes[ :state ] == 'stopped'
+      return @attributes[ name ]
+    end
+
+    def id
+      @attributes[ :href ].split( '/' ).last
+    end
+
+    def inputs
+      return @inputs if @inputs
+      # Add inputs to instance data
+      # @client.get( @attributes[ 'href' ] )
+    end
+
+  end
+
+end

data/lib/rightstuff/base.rb

@@ -0,0 +1,38 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'nokogiri'
+
+module Rightstuff
+
+  class Base
+
+    def self.load_collection( client, doc )
+      doc.xpath( self.collection_xpath ).collect do | item |
+        self.new( client, item )
+      end
+    end
+
+    def self.extract_attributes( parent )
+      elements = parent.children.collect do | node |
+        node.class == Nokogiri::XML::Element ? node : nil
+      end
+      elements.compact!
+      elements.reduce( {} ) do | memo, element |
+        name = element.name
+        name.gsub!( /-/, '_' )
+        memo[ name.intern ] = element.children[ 0 ].to_s
+        memo
+      end
+    end
+
+    def initialize( client, item )
+      @client     = client
+      @attributes = Base.extract_attributes( item )
+    end
+
+    def method_missing( name, *args, &block )
+      return @attributes[ name ]
+    end
+
+  end
+
+end

data/lib/rightstuff/client.rb

@@ -0,0 +1,63 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'nokogiri'
+require 'net/https'
+require 'uri'
+
+module Rightstuff
+
+  class Client
+
+    def initialize( options = {} )
+      @username = options[ :username ] or raise 'no username supplied'
+      @password = options[ :password ] or raise 'no password supplied'
+      @account  = options[ :account ]  or raise 'no account id supplied'
+      @account  = @account.to_s
+
+      @base_url               = 'https://my.rightscale.com/api/acct'
+      url                     = URI.parse( @base_url )
+      @connection             = Net::HTTP.new( url.host, url.port )
+      @connection.use_ssl     = true
+      @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    def get_rest( rest )
+      get( account_url( rest ) )
+    end
+
+    def servers
+      return @servers if @servers
+      body     = Nokogiri::XML( get_rest( 'servers' ) )
+      @servers = Rightstuff::Server.load_collection( self, body )
+    end
+
+    def server_arrays
+      return @server_arrays if @server_arrays
+      body     = Nokogiri::XML( get_rest( 'server_arrays' ) )
+      @server_arrays = Rightstuff::ServerArray.load_collection( self, body )
+    end
+
+    private
+
+    def get( address )
+      url     = URI.parse( address )
+      request = Net::HTTP::Get.new( url.request_uri )
+      request.add_field( 'X-API-VERSION', '1.0' )
+      request.basic_auth( @username, @password )
+
+      response = @connection.request( request )
+
+      case response.code
+      when '200'
+        return response.body
+      else
+        raise "Request '#{ address }' failed with response code #{ response.code }\n#{ response.body }"
+      end
+    end
+
+    def account_url( rest )
+      @base_url + '/' + @account + '/' + rest
+    end
+
+  end
+
+end

data/lib/rightstuff/credentials.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+
+module Rightstuff
+
+  # Rightstuff::Credentials imposes no restrictions on the structure of the data
+  # It only requires that:
+  # 1. the user has a file called ~/.credentials,
+  # 2. the the file does not have any permissions for other users,
+  # 3. the file contails YAML::load-able data.
+  module Credentials
+
+    def rightscale_data
+      return @rightscale_data if @rightscale_data
+      raise "Missing credentials file '#{ rightscale_data_path }'" if ! File.exist?( rightscale_data_path )
+      check_permissions
+      @rightscale_data = YAML.load_file( rightscale_data_path )
+    end
+
+    private
+
+    def rightscale_data_path
+      File.expand_path( '~/.rightstuff' )
+    end
+
+    def check_permissions
+      mode = File::Stat.new( rightscale_data_path ).mode
+      if mode & 0066 != 0
+        raise "Permissions on '#{ rightscale_data_path }' too open (currently 0%o), should be 0600" % ( mode & 0666 )
+      end
+    end
+
+  end
+
+end

data/lib/rightstuff/server.rb

@@ -0,0 +1,45 @@
+module Rightstuff
+
+  class Server < Base
+
+    attr_reader :attributes
+
+    def initialize( client, item )
+      @settings = nil
+      @inputs   = nil
+      super
+    end
+
+    def self.collection_xpath
+      '/servers/server'
+    end
+
+    def method_missing( name , *args, &block )
+      result = super
+      return result unless result.nil?
+      return nil    unless @attributes[ :state ] == 'operational'
+      settings unless @settings
+      return @attributes[ name ]
+    end
+
+    def id
+      @attributes[ :href ].split( '/' ).last
+    end
+
+    def inputs
+      return @inputs if @inputs
+      # Add inputs to instance data
+      # @client.get( @attributes[ 'href' ] )
+    end
+
+    def settings
+      return @settings if @settings
+      doc       = @client.get_rest( 'servers/' + id + '/settings' )
+      xml       = Nokogiri::XML( doc )
+      @settings = Base.extract_attributes( xml.children )
+      @attributes.merge!( @settings )
+    end
+
+  end
+
+end

data/lib/rightstuff/server_array.rb

@@ -0,0 +1,41 @@
+module Rightstuff
+  # http://support.rightscale.com/15-References/RightScale_API_Reference_Guide/02-Management/09-Server_Arrays
+  class ServerArray < Base
+
+    attr_reader :attributes
+
+    def initialize( client, item )
+      @inputs    = nil
+      @instances = nil
+      super
+    end
+
+    def self.collection_xpath
+      '/server-arrays/server-array'
+    end
+
+    def method_missing( name , *args, &block )
+      result = super
+      return result unless result.nil?
+      return nil    if @attributes[ :state ] == 'stopped'
+      return @attributes[ name ]
+    end
+
+    def id
+      @attributes[ :href ].split( '/' ).last
+    end
+
+    def inputs
+      return @inputs if @inputs
+      # Add inputs to instance data
+      # @client.get( @attributes[ 'href' ] )
+    end
+
+    def instances
+      return @instances if @instances
+      body     = Nokogiri::XML( @client.get_rest( "server_arrays/#{id}/instances" ) )
+      @instances = Rightstuff::ArrayInstance.load_collection( @client, body )
+    end
+  end
+
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rightstuff
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Joe Yates
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 +01:00
+date: 2010-10-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 113
         segments: 
         - 1
         - 4
@@ -44,11 +42,23 @@ extensions: []
 extra_rdoc_files: 
 - COPYING
 - README.rdoc
+- lib/rightstuff/client.rb
+- lib/rightstuff/array_instance.rb
+- lib/rightstuff/server.rb
+- lib/rightstuff/base.rb
+- lib/rightstuff/server_array.rb
+- lib/rightstuff/credentials.rb
 - lib/rightstuff.rb
 files: 
 - COPYING
 - Rakefile
 - README.rdoc
+- lib/rightstuff/client.rb
+- lib/rightstuff/array_instance.rb
+- lib/rightstuff/server.rb
+- lib/rightstuff/base.rb
+- lib/rightstuff/server_array.rb
+- lib/rightstuff/credentials.rb
 - lib/rightstuff.rb
 has_rdoc: true
 homepage: http://github.com/joeyates/rightstuff
@@ -67,7 +77,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -76,7 +85,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"