scout_scout 0.0.3 → 0.0.4

data/README.rdoc

@@ -1,28 +1,52 @@
 = scout_scout
 
-Scout your data out of Scout:
-
-    require 'scout_scout'
-    scout = ScoutScout.new('youraccountname', 'your@awesome.com', 'sekret')
-    #all your servers
-    clients = scout.clients
-    #one specific server - pass in hostname
-    ram_hungry = ScoutScout::Client.find('db1.awesome.com')
-    #details on that server's plugins
-    ram_hungry_plugins = ram_hungry.plugins
-    #details about a specific plugin
-    data = ram_hungry.plugin(12345)
+A library for extracting data out of Scout[http//:scoutapp.com], a hosted monitoring service. This is experimental and likely to change. 
+
+  require 'scout_scout'
+  scout = ScoutScout.new('youraccountname', 'your@awesome.com', 'sekret')
+
+  #all your servers
+  servers = scout.servers
+
+  #one specific server - pass in hostname
+  ram_hungry = ScoutScout::Server.first('db1.awesome.com')
+
+  #all servers that match the hostname.
+  # see mysql regex formatting: http://dev.mysql.com/doc/refman/5.0/en/regexp.html
+  app_servers = ScoutScout::Server.all(:host => 'db[0-9]*.awesome.com')
+
+  #details on that server's plugins
+  ram_hungry_plugins = ram_hungry.plugins
+
+  #details about a specific plugin
+  data = ram_hungry.plugin(12345)
+
+  #all available descriptors
+  descriptors = ScoutScout::Descriptor.all
+  
+  # all descriptors on servers that match the provided host
+  descriptors = ScoutScout::Descriptor.all(:host => 'awesome.com')
+
+  #cluster metrics
+  ScoutScout::Cluster.average('mem_used')
+
+== Metrics
+
+The library allows you to extract aggregate metrics across all and/or
+selected servers in your account. See <tt>Cluster#average</tt> for
+information and examples.
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2010 Jesse Newland. See LICENSE for details.
+Copyright (c) 2010 Jesse Newland, Derek Haynes. See LICENSE for details.

data/Rakefile

@@ -49,3 +49,8 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r scout_scout.rb"
+end

data/lib/scout_scout.rb

@@ -1,23 +1,29 @@
 require 'hashie'
 require 'httparty'
+require 'cgi'
 require 'scout_scout/version'
-require 'scout_scout/client'
+require 'scout_scout/server'
 require 'scout_scout/descriptor'
 require 'scout_scout/plugin'
 require 'scout_scout/alert'
+require 'scout_scout/cluster.rb'
+require 'scout_scout/metric.rb'
 
 class ScoutScout
   include HTTParty
   base_uri 'https://scoutapp.com'
   format :xml
   mattr_inheritable :account
+  
+  class Error < RuntimeError
+  end
 
   def initialize(scout_account_name, username, password)
     self.class.account = scout_account_name
     self.class.basic_auth username, password
   end
 
-  # Recent alerts across all clients on this account
+  # Recent alerts across all servers on this account
   #
   # @return [Array] An array of ScoutScout::Alert objects
   def alerts
@@ -25,12 +31,25 @@ class ScoutScout
     response['alerts'].map { |alert| ScoutScout::Alert.new(alert) }
   end
 
-  # All clients on this account
+  # All servers on this account
   #
-  # @return [Array] An array of ScoutScout::Client objects
-  def clients
+  # @return [Array] An array of ScoutScout::Server objects
+  def servers
     response = self.class.get("/#{self.class.account}/clients.xml")
-    response['clients'].map { |client| ScoutScout::Client.new(client) }
+    response['clients'].map { |client| ScoutScout::Server.new(client) }
+  end
+  
+  class << self
+    alias_method :http_get, :get
+  end
+  
+  # Checks for errors via the HTTP status code. If an error is found, a 
+  # ScoutScout::Error is raised. Otherwise, the response.
+  # 
+  # @return HTTParty::Response
+  def self.get(uri)
+    response = http_get(uri)
+    response.code.to_s =~ /^(4|5)/ ? raise( ScoutScout::Error,response.message) : response
   end
 
 end

data/lib/scout_scout/alert.rb

@@ -1,15 +1,17 @@
 class ScoutScout::Alert < Hashie::Mash
-  # The Scout client that generated this alert
+  attr_writer :server
+
+  # The Scout server that generated this alert
   #
-  # @return [ScoutScout::Client]
-  def client
-    @client ||= ScoutScout::Client.find(client_id)
+  # @return [ScoutScout::Server]
+  def server
+    @server ||= ScoutScout::Server.first(client_id)
   end
 
   # The Scout plugin that generated this alert
   #
   # @return [ScoutScout::Plugin]
   def plugin
-    client.plugin(plugin_id)
+    server.plugin(plugin_id)
   end
 end

data/lib/scout_scout/cluster.rb

@@ -0,0 +1,66 @@
+class ScoutScout::Cluster < Hashie::Mash
+  # Find the average value of a descriptor by name (ex: 'last_minute'). If the descriptor couldn't be found AND/OR
+  # hasn't reported since +options[:start]+, a ScoutScout::Error is raised.
+  #
+  # Options:
+  #
+  # * <tt>:host</tt>: Only selects descriptors from servers w/hostnames matching this pattern.
+  #   Use a MySQL-formatted Regex. http://dev.mysql.com/doc/refman/5.0/en/regexp.html
+  # * <tt>:start</tt>: The start time for grabbing metrics. Default is 1 hour ago. Times will be converted to UTC.
+  # * <tt>:end</tt>: The end time for grabbing metrics. Default is NOW. Times will be converted to UTC.
+  # * <tt>:per_server</tt>: Whether the result should be returned per-server or an aggregate of the entire cluster.
+  #   Default is false. Note that total is not necessary equal to the value on each server * num of servers.
+  # Examples:
+  #
+  # How much memory are my servers using?
+  # ScoutScout::Cluster.average('mem_used')
+  #
+  # What is the average per-server load on my servers?
+  # ScoutScout::Cluster.average('cpu_last_minute', :per_server => true)
+  #
+  # How much disk space is available on our db servers?
+  # ScoutScout::Cluster.average('disk_avail',:host => "db[0-9]*.awesomeapp.com")
+  #
+  # How much memory did my servers use yesterday?
+  # ScoutScout::Cluster.average('mem_used', :start => Time.now-(24*60*60)*2, :end => Time.now-(24*60*60)*2)
+  #
+  # @return [ScoutScout::Metric]
+  def self.average(descriptor,options = {})
+    calculate('AVG',descriptor,options)
+  end
+
+  # Find the maximum value of a descriptor by name (ex: 'last_minute').
+  #
+  # See +average+ for options and examples.
+  #
+  # @return [ScoutScout::Metric]
+  def self.maximum(descriptor,options = {})
+    calculate('MAX',descriptor,options)
+  end
+
+  # Find the minimum value of a descriptor by name (ex: 'last_minute').
+  #
+  # See +average+ for options and examples.
+  #
+  # @return [ScoutScout::Metric]
+  def self.minimum(descriptor,options = {})
+    calculate('MIN',descriptor,options)
+  end
+
+  def self.calculate(function,descriptor,options = {})
+    consolidate = options[:per_server] ? 'AVG' : 'SUM'
+    start_time,end_time=format_times(options)
+    response = ScoutScout.get("/#{ScoutScout.account}/data/value?descriptor=#{CGI.escape(descriptor)}&function=#{function}&consolidate=#{consolidate}&host=#{options[:host]}&start=#{start_time}&end=#{end_time}")
+
+    if response['data']
+      ScoutScout::Metric.new(response['data'])
+    else
+      raise ScoutScout::Error, response['error']
+    end
+  end
+
+  # API expects times in epoch.
+  def self.format_times(options)
+    options.values_at(:start,:end).map { |t| t ? t.to_i : nil }
+  end
+end

data/lib/scout_scout/descriptor.rb

@@ -1,2 +1,40 @@
 class ScoutScout::Descriptor < Hashie::Mash
+  attr_accessor :server, :plugin
+
+  # Search for descriptors by matching name and hostname.
+  #
+  # Options:
+  #
+  # - :descriptor => The descriptor name to match
+  # - :host => The host name to match
+  #
+  # @return [Array] An array of ScoutScout::Descriptor objects
+  def self.all(options = {})
+    response = ScoutScout.get("/#{ScoutScout.account}/descriptors.xml?descriptor=#{CGI.escape(options[:descriptor] || String.new)}&host=#{options[:host]}")
+    response['ar_descriptors'] ? response['ar_descriptors'].map { |descriptor| ScoutScout::Descriptor.new(descriptor) } : Array.new
+  end
+
+  # @return [ScoutScout::Metric]
+  def average(opts = {})
+    ScoutScout::Cluster.average(name, options_for_relationship(opts))
+  end
+
+  # @return [ScoutScout::Metric]
+  def maximum(opts = {})
+    ScoutScout::Cluster.maximum(name, options_for_relationship(opts))
+  end
+
+  # @return [ScoutScout::Metric]
+  def maximum(opts = {})
+    ScoutScout::Cluster.maximum(name, options_for_relationship(opts))
+  end
+
+protected
+
+  def options_for_relationship(opts = {})
+    relationship_options = {}
+    relationship_options[:host] = server.hostname if server
+    opts.merge(relationship_options)
+  end
+
 end

data/lib/scout_scout/metric.rb

@@ -0,0 +1,2 @@
+class ScoutScout::Metric < Hashie::Mash
+end

data/lib/scout_scout/plugin.rb

@@ -1,4 +1,6 @@
 class ScoutScout::Plugin < Hashie::Mash
+  attr_accessor :server
+
   def initialize(hash)
     if hash['descriptors'] && hash['descriptors']['descriptor']
       @descriptor_hash = hash['descriptors']['descriptor']
@@ -11,6 +13,15 @@ class ScoutScout::Plugin < Hashie::Mash
   #
   # @return [Array] An array of ScoutScout::Descriptor objects
   def descriptors
-    @descriptors ||= @descriptor_hash.map { |d| ScoutScout::Descriptor.new(d) }
+    @descriptors ||= @descriptor_hash.map { |d| decorate_with_server_and_plugin(ScoutScout::Descriptor.new(d)) }
   end
+
+protected
+
+  def decorate_with_server_and_plugin(hashie)
+    hashie.server = self.server
+    hashie.plugin = self
+    hashie
+  end
+
 end

data/lib/scout_scout/server.rb

@@ -0,0 +1,81 @@
+class ScoutScout::Server < Hashie::Mash
+  def initialize(hash)
+    if hash['active_alerts']
+      @alert_hash = hash['active_alerts']
+      hash.delete('active_alerts')
+    end
+    super(hash)
+  end
+
+  # Search for a server by id or matching hostname
+  #
+  # @return [ScoutScout::Server]
+  def self.first(server_id_or_hostname)
+    if server_id_or_hostname.is_a?(Fixnum)
+      response = ScoutScout.get("/#{ScoutScout.account}/clients/#{server_id_or_hostname}.xml")
+      ScoutScout::Server.new(response['client'])
+    else
+      response = ScoutScout.get("/#{ScoutScout.account}/clients.xml?host=#{server_id_or_hostname}")
+      raise ScoutScout::Error, 'Not Found' if response['clients'].nil?
+      ScoutScout::Server.new(response['clients'].first)
+    end
+  end
+
+  # Search for servers by matching hostname via :host.
+  #
+  # Example: ScoutScout::Server.all(:host => 'soawesome.org')
+  #
+  # @return [Array] An array of ScoutScout::Server objects
+  def self.all(options)
+    hostname = options[:host]
+    raise ScoutScout::Error, "Please specify a host via :host" if hostname.nil?
+    response = ScoutScout.get("/#{ScoutScout.account}/clients.xml?host=#{hostname}")
+    response['clients'] ? response['clients'].map { |client| ScoutScout::Server.new(client) } : Array.new
+  end
+
+  # Active alerts for this server
+  #
+  # @return [Array] An array of ScoutScout::Alert objects
+  def active_alerts
+    @active_alerts ||= @alert_hash.map { |a| decorate_with_server(ScoutScout::Alert.new(a)) }
+  end
+
+  # Recent alerts for this server
+  #
+  # @return [Array] An array of ScoutScout::Alert objects
+  def alerts
+    response = ScoutScout.get("/#{ScoutScout.account}/clients/#{self.id}/activities.xml")
+    response['alerts'].map { |alert| decorate_with_server(ScoutScout::Alert.new(alert)) }
+  end
+
+  # Details about all plugins for this server
+  #
+  # @return [Array] An array of ScoutScout::Plugin objects
+  def plugins
+    response = ScoutScout.get("/#{ScoutScout.account}/clients/#{self.id}/plugins.xml")
+    response['plugins'].map { |plugin| decorate_with_server(ScoutScout::Plugin.new(plugin)) }
+  end
+
+  # Details about a specific plugin
+  #
+  # @return [ScoutScout::Plugin]
+  def plugin(id)
+    response = ScoutScout.get("/#{ScoutScout.account}/clients/#{self.id}/plugins/#{id}.xml")
+    decorate_with_server(ScoutScout::Plugin.new(response['plugin']))
+  end
+
+  # All descriptors for this server
+  #
+  # @return [Array] An array of ScoutScout::Descriptor objects
+  def descriptors
+    ScoutScout::Descriptor.all(:host => hostname).map { |d| decorate_with_server(d) }
+  end
+
+protected
+
+  def decorate_with_server(hashie)
+    hashie.server = self
+    hashie
+  end
+
+end

data/lib/scout_scout/version.rb

@@ -1,3 +1,3 @@
 class ScoutScout
-  VERSION = '0.0.3'
-end
+  VERSION = '0.0.4'
+end

data/spec/fixtures/client.xml

@@ -16,6 +16,7 @@
   <send-checkup-email type="boolean" nil="true"></send-checkup-email>
   <send-checkup-sms type="boolean" nil="true"></send-checkup-sms>
   <take-snapshots type="boolean">false</take-snapshots>
+  <hostname>foobar.com</hostname>
   <version>3.2.6</version>
 <active-alerts type="array"/>
 </client>

data/spec/fixtures/clients.xml

@@ -17,6 +17,7 @@
       <send-checkup-email type="boolean" nil="true"></send-checkup-email>
       <send-checkup-sms type="boolean" nil="true"></send-checkup-sms>
       <take-snapshots type="boolean">false</take-snapshots>
+      <hostname>foobar.com</hostname>
       <version>3.2.6</version>
   <active-alerts type="array"/>
     </client>
@@ -37,6 +38,7 @@
       <send-checkup-email type="boolean" nil="true"></send-checkup-email>
       <send-checkup-sms type="boolean" nil="true"></send-checkup-sms>
       <take-snapshots type="boolean">false</take-snapshots>
+      <hostname>foo2.com</hostname>
       <version>5.0.3</version>
   <active-alerts type="array">
       <alert>

data/spec/fixtures/data.xml

@@ -0,0 +1,5 @@
+<data>
+  <value>31.10</value>
+  <label>Cpu last minute</label>
+  <units></units>
+</data>

data/spec/fixtures/descriptors.xml

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ar-descriptors type="array">
+  <ar-descriptor>
+    <name>Passenger/apache_private_total</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/cpu_last_fifteen_minutes</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/cpu_last_five_minutes</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/cpu_last_minute</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/disk_avail</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/disk_capacity</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/disk_size</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/disk_used</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth0_in</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth0_in_packets</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth0_out</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth0_out_packets</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth1_in</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth1_in_packets</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth1_out</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Network Throughput/eth1_out_packets</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/mem_swap_percent</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/mem_swap_total</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/mem_swap_used</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/mem_total</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/mem_used</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Server Overview/mem_used_percent</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/nginx_processes</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_max_pool_size</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_private_total</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_process_active</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_process_current</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_process_inactive</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_queue_depth</name>
+  </ar-descriptor>
+  <ar-descriptor>
+    <name>Passenger/passenger_vmsize_total</name>
+  </ar-descriptor>
+</ar-descriptors>

data/spec/scout_scout_spec.rb

@@ -7,25 +7,25 @@ describe "ScoutScout" do
   it "should provide a version constant" do
     ScoutScout::VERSION.should be_instance_of(String)
   end
-  it "should set the client and basic auth parameters when initialized" do
+  it "should set the server and basic auth parameters when initialized" do
     @scout_scout.class.account.should == 'account'
     @scout_scout.class.default_options[:basic_auth].should == { :username => 'username', :password => 'password' }
   end
   describe "global" do
-    describe "client list" do
+    describe "server list" do
       before(:each) do
         @scout_scout.stub_get('clients.xml')
-        @clients = @scout_scout.clients
+        @servers = @scout_scout.servers
       end
-      it 'should list all clients' do
-        @clients.size.should == 2
+      it 'should list all servers' do
+        @servers.size.should == 2
       end
-      it "should be an array ScoutScout::Client objects" do
-        @clients.first.class.should == ScoutScout::Client
+      it "should be an array ScoutScout::Server objects" do
+        @servers.first.class.should == ScoutScout::Server
       end
       it "should include active alerts" do
-        @clients.last.active_alerts.first.class.should == ScoutScout::Alert
-        @clients.last.active_alerts.first.title.should =~ /Passenger/
+        @servers.last.active_alerts.first.class.should == ScoutScout::Alert
+        @servers.last.active_alerts.first.title.should =~ /Passenger/
       end
     end
     describe 'alert log' do
@@ -36,9 +36,9 @@ describe "ScoutScout" do
       it "should be an array ScoutScout::Alert objects" do
         @activities.first.class.should == ScoutScout::Alert
       end
-      it "should be associated with it's plugin and client" do
+      it "should be associated with it's plugin and server" do
         @scout_scout.stub_get('clients/24331.xml', 'client.xml')
-        @activities.first.client.class.should == ScoutScout::Client
+        @activities.first.server.class.should == ScoutScout::Server
         @scout_scout.stub_get('clients/13431/plugins/122761.xml', 'plugin_data.xml')
         @activities.first.plugin.class.should == ScoutScout::Plugin
       end
@@ -49,36 +49,60 @@ describe "ScoutScout" do
         end
       end
     end
+    describe 'descriptors' do
+      before(:each) do
+        @scout_scout.stub_get('descriptors.xml?descriptor=&host=&','descriptors.xml')
+        @descriptors = ScoutScout::Descriptor.all
+      end
+      it "should be an array ScoutScout::Descriptor objects" do
+        @descriptors.first.class.should == ScoutScout::Descriptor
+      end
+      it "should be accessable" do
+        @descriptors.size.should == 30
+      end
+    end
+    describe 'descriptor metrics' do
+      before(:each) do
+        @scout_scout.stub_get('data/value?descriptor=cpu_last_minute&function=AVG&consolidate=SUM&host=&start=&end=&','data.xml')
+        @metric = ScoutScout::Cluster.average('cpu_last_minute')
+      end
+      it "should be a ScoutScout::Metric object" do
+        @metric.class.should == ScoutScout::Metric
+      end
+      it "should contain the value" do
+        @metric.value.should == '31.10'
+      end
+    end
   end
-  describe 'individual clients' do
+  describe 'individual servers' do
     describe 'should be accessable' do
       describe '' do
         before(:each) do
           @scout_scout.stub_get('clients/1234.xml', 'client.xml')
-          @client = ScoutScout::Client.find(1234)
+          @server = ScoutScout::Server.first(1234)
         end
         it "by id" do
-          @client.key.should == 'FOOBAR'
-          @client.class.should == ScoutScout::Client
+          @server.key.should == 'FOOBAR'
+          @server.class.should == ScoutScout::Server
         end
       end
       describe '' do
         before(:each) do
           @scout_scout.stub_get('clients.xml?host=foo.awesome.com', 'client_by_hostname.xml')
-          @client = ScoutScout::Client.find('foo.awesome.com')
+          @server = ScoutScout::Server.first('foo.awesome.com')
         end
         it "by hostname" do
-          @client.key.should == 'FOOBAR'
-          @client.class.should == ScoutScout::Client
+          @server.key.should == 'FOOBAR'
+          @server.class.should == ScoutScout::Server
         end
       end
     end
     describe 'alert log' do
       before(:each) do
         @scout_scout.stub_get('clients/13431.xml', 'client.xml')
-        @client = ScoutScout::Client.find(13431)
+        @server = ScoutScout::Server.first(13431)
         @scout_scout.stub_get('clients/13431/activities.xml', 'activities.xml')
-        @activities = @client.alerts
+        @activities = @server.alerts
       end
       it "should be accessable" do
         @activities.size.should == 2
@@ -94,9 +118,9 @@ describe "ScoutScout" do
       describe 'list' do
         before(:each) do
           @scout_scout.stub_get('clients/13431.xml', 'client.xml')
-          @client = ScoutScout::Client.find(13431)
+          @server = ScoutScout::Server.first(13431)
           @scout_scout.stub_get('clients/13431/plugins.xml', 'plugins.xml')
-          @plugins = @client.plugins
+          @plugins = @server.plugins
         end
         it "should be accessable" do
           @plugins.size.should == 2
@@ -112,9 +136,9 @@ describe "ScoutScout" do
       describe 'individually' do
         before(:each) do
           @scout_scout.stub_get('clients/13431.xml', 'client.xml')
-          @client = ScoutScout::Client.find(13431)
+          @server = ScoutScout::Server.first(13431)
           @scout_scout.stub_get('clients/13431/plugins/12345.xml', 'plugin_data.xml')
-          @plugin_data = @client.plugin(12345)
+          @plugin_data = @server.plugin(12345)
         end
         it "should be accessable" do
           @plugin_data.class.should == ScoutScout::Plugin
@@ -131,5 +155,35 @@ describe "ScoutScout" do
       end
 
     end
+    describe 'descriptor list' do
+      before(:each) do
+        @scout_scout.stub_get('clients/13431.xml', 'client.xml')
+        @server = ScoutScout::Server.first(13431)
+        @scout_scout.stub_get('descriptors.xml?descriptor=&host=foobar.com&', 'descriptors.xml')
+        @descriptors = @server.descriptors
+      end
+      it "should be accessable" do
+        @descriptors.size.should == 30
+      end
+      it "should be an array ScoutScout::Descriptor objects" do
+        @descriptors.first.class.should == ScoutScout::Descriptor
+      end
+    end
+    describe 'descriptor metrics' do
+      before(:each) do
+        @scout_scout.stub_get('clients/13431.xml', 'client.xml')
+        @server = ScoutScout::Server.first(13431)
+        @scout_scout.stub_get('clients/13431/plugins.xml', 'plugins.xml')
+        @plugins = @server.plugins
+        @scout_scout.stub_get('data/value?descriptor=passenger_process_active&function=AVG&consolidate=SUM&host=foobar.com&start=&end=&','data.xml')
+        @metric = @plugins.first.descriptors.first.average
+      end
+      it "should be a ScoutScout::Metric object" do
+        @metric.class.should == ScoutScout::Metric
+      end
+      it "should contain the value" do
+        @metric.value.should == '31.10'
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scout_scout
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jesse Newland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-31 00:00:00 -05:00
+date: 2010-02-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,14 +69,18 @@ files:
 - Rakefile
 - lib/scout_scout.rb
 - lib/scout_scout/alert.rb
-- lib/scout_scout/client.rb
+- lib/scout_scout/cluster.rb
 - lib/scout_scout/descriptor.rb
+- lib/scout_scout/metric.rb
 - lib/scout_scout/plugin.rb
+- lib/scout_scout/server.rb
 - lib/scout_scout/version.rb
 - spec/fixtures/activities.xml
 - spec/fixtures/client.xml
 - spec/fixtures/client_by_hostname.xml
 - spec/fixtures/clients.xml
+- spec/fixtures/data.xml
+- spec/fixtures/descriptors.xml
 - spec/fixtures/plugin_data.xml
 - spec/fixtures/plugins.xml
 - spec/scout_scout_spec.rb

data/lib/scout_scout/client.rb

@@ -1,53 +0,0 @@
-class ScoutScout::Client < Hashie::Mash
-  def initialize(hash)
-    if hash['active_alerts']
-      @alert_hash = hash['active_alerts']
-      hash.delete('active_alerts')
-    end
-    super(hash)
-  end
-
-  # Search for a client by id or hostname
-  #
-  # @return [ScoutScout::Client]
-  def self.find(client_id_or_hostname)
-    if client_id_or_hostname.is_a?(Fixnum)
-      response = ScoutScout.get("/#{ScoutScout.account}/clients/#{client_id_or_hostname}.xml")
-      ScoutScout::Client.new(response['client'])
-    else
-      response = ScoutScout.get("/#{ScoutScout.account}/clients.xml?host=#{client_id_or_hostname}")
-      ScoutScout::Client.new(response['clients'].first)
-    end
-  end
-
-  # Active alerts for this client
-  #
-  # @return [Array] An array of ScoutScout::Alert objects
-  def active_alerts
-    @active_alerts ||= @alert_hash.map { |a| ScoutScout::Alert.new(a) }
-  end
-
-  # Recent alerts for this client
-  #
-  # @return [Array] An array of ScoutScout::Alert objects
-  def alerts
-    response = ScoutScout.get("/#{ScoutScout.account}/clients/#{self.id}/activities.xml")
-    response['alerts'].map { |alert| ScoutScout::Alert.new(alert) }
-  end
-
-  # Details about all plugins for this client
-  #
-  # @return [Array] An array of ScoutScout::Plugin objects
-  def plugins
-    response = ScoutScout.get("/#{ScoutScout.account}/clients/#{self.id}/plugins.xml")
-    response['plugins'].map { |plugin| ScoutScout::Plugin.new(plugin) }
-  end
-
-  # Details about a specific plugin
-  #
-  # @return [ScoutScout::Plugin]
-  def plugin(id)
-    response = ScoutScout.get("/#{ScoutScout.account}/clients/#{self.id}/plugins/#{id}.xml")
-    ScoutScout::Plugin.new(response['plugin'])
-  end
-end