scout_scout 0.0.2 → 0.0.3

data/README.rdoc

@@ -7,11 +7,11 @@ Scout your data out of Scout:
     #all your servers
     clients = scout.clients
     #one specific server - pass in hostname
-    ram_hungry = scout.client('db1.awesome.com')
+    ram_hungry = ScoutScout::Client.find('db1.awesome.com')
     #details on that server's plugins
-    ram_hungry_plugins = scout.plugins('db1.awesome.com')
-    #details about the plugin with with name 'Server Overview' on server 'db1.awesome.com'
-    data = scout.plugin_data('db1.awesome.com','Server Overview')
+    ram_hungry_plugins = ram_hungry.plugins
+    #details about a specific plugin
+    data = ram_hungry.plugin(12345)
 
 == Note on Patches/Pull Requests
  

data/lib/scout_scout.rb

@@ -1,7 +1,10 @@
 require 'hashie'
 require 'httparty'
 require 'scout_scout/version'
-require 'cgi'
+require 'scout_scout/client'
+require 'scout_scout/descriptor'
+require 'scout_scout/plugin'
+require 'scout_scout/alert'
 
 class ScoutScout
   include HTTParty
@@ -14,51 +17,20 @@ class ScoutScout
     self.class.basic_auth username, password
   end
 
-  def alerts(client_id_or_hostname = nil)
-    response = if client_id_or_hostname.nil?
-      self.class.get("/#{self.class.account}/activities.xml")
-    elsif client_id_or_hostname.is_a?(Fixnum)
-      self.class.get("/#{self.class.account}/clients/#{client_id_or_hostname}/activities.xml")
-    else
-      self.class.get("/#{self.class.account}/activities.xml?host=#{client_id_or_hostname}")
-    end
-    response['alerts'].map { |alert| Hashie::Mash.new(alert) }
+  # Recent alerts across all clients on this account
+  #
+  # @return [Array] An array of ScoutScout::Alert objects
+  def alerts
+    response = self.class.get("/#{self.class.account}/activities.xml")
+    response['alerts'].map { |alert| ScoutScout::Alert.new(alert) }
   end
 
+  # All clients on this account
+  #
+  # @return [Array] An array of ScoutScout::Client objects
   def clients
     response = self.class.get("/#{self.class.account}/clients.xml")
-    response['clients'].map { |client| Hashie::Mash.new(client) }
-  end
-
-  def client(client_id_or_hostname)
-    if client_id_or_hostname.is_a?(Fixnum)
-      response = self.class.get("/#{self.class.account}/clients/#{client_id_or_hostname}.xml")
-      Hashie::Mash.new(response['client'])
-    else
-      response = self.class.get("/#{self.class.account}/clients.xml?host=#{client_id_or_hostname}")
-      Hashie::Mash.new(response['clients'].first)
-    end
-  end
-
-  def plugins(client_id_or_hostname)
-    response = if client_id_or_hostname.is_a?(Fixnum)
-      self.class.get("/#{self.class.account}/clients/#{client_id_or_hostname}/plugins.xml")
-    else
-      self.class.get("/#{self.class.account}/plugins.xml?host=#{client_id_or_hostname}")
-    end
-    response['plugins'].map { |plugin| format_plugin(Hashie::Mash.new(plugin)) }
-  end
-
-  def plugin_data(hostname, plugin_name)
-    response = self.class.get("/#{self.class.account}/plugins/show.xml?host=#{hostname}&name=#{CGI.escape(plugin_name)}")
-    format_plugin(Hashie::Mash.new(response['plugin']))
-  end
-
-protected
-
-  def format_plugin(plugin)
-    plugin.descriptors = plugin.descriptors.descriptor
-    plugin
+    response['clients'].map { |client| ScoutScout::Client.new(client) }
   end
 
 end

data/lib/scout_scout/alert.rb

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

data/lib/scout_scout/client.rb

@@ -0,0 +1,53 @@
+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

data/lib/scout_scout/descriptor.rb

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

data/lib/scout_scout/plugin.rb

@@ -0,0 +1,16 @@
+class ScoutScout::Plugin < Hashie::Mash
+  def initialize(hash)
+    if hash['descriptors'] && hash['descriptors']['descriptor']
+      @descriptor_hash = hash['descriptors']['descriptor']
+      hash.delete('descriptors')
+    end
+    super(hash)
+  end
+
+  # All descriptors for this plugin, including their name and current
+  #
+  # @return [Array] An array of ScoutScout::Descriptor objects
+  def descriptors
+    @descriptors ||= @descriptor_hash.map { |d| ScoutScout::Descriptor.new(d) }
+  end
+end

data/lib/scout_scout/version.rb

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

data/spec/scout_scout_spec.rb

@@ -20,7 +20,11 @@ describe "ScoutScout" do
       it 'should list all clients' do
         @clients.size.should == 2
       end
+      it "should be an array ScoutScout::Client objects" do
+        @clients.first.class.should == ScoutScout::Client
+      end
       it "should include active alerts" do
+        @clients.last.active_alerts.first.class.should == ScoutScout::Alert
         @clients.last.active_alerts.first.title.should =~ /Passenger/
       end
     end
@@ -29,6 +33,15 @@ describe "ScoutScout" do
         @scout_scout.stub_get('activities.xml')
         @activities = @scout_scout.alerts
       end
+      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
+        @scout_scout.stub_get('clients/24331.xml', 'client.xml')
+        @activities.first.client.class.should == ScoutScout::Client
+        @scout_scout.stub_get('clients/13431/plugins/122761.xml', 'plugin_data.xml')
+        @activities.first.plugin.class.should == ScoutScout::Plugin
+      end
       it "should be accessable" do
         @activities.size.should == 2
         @activities.each do |activity|
@@ -42,26 +55,30 @@ describe "ScoutScout" do
       describe '' do
         before(:each) do
           @scout_scout.stub_get('clients/1234.xml', 'client.xml')
-          @client = @scout_scout.client(1234)
+          @client = ScoutScout::Client.find(1234)
         end
         it "by id" do
           @client.key.should == 'FOOBAR'
+          @client.class.should == ScoutScout::Client
         end
       end
       describe '' do
         before(:each) do
           @scout_scout.stub_get('clients.xml?host=foo.awesome.com', 'client_by_hostname.xml')
-          @client = @scout_scout.client('foo.awesome.com')
+          @client = ScoutScout::Client.find('foo.awesome.com')
         end
         it "by hostname" do
           @client.key.should == 'FOOBAR'
+          @client.class.should == ScoutScout::Client
         end
       end
     end
     describe 'alert log' do
       before(:each) do
-        @scout_scout.stub_get('clients/1234/activities.xml', 'activities.xml')
-        @activities = @scout_scout.alerts(1234)
+        @scout_scout.stub_get('clients/13431.xml', 'client.xml')
+        @client = ScoutScout::Client.find(13431)
+        @scout_scout.stub_get('clients/13431/activities.xml', 'activities.xml')
+        @activities = @client.alerts
       end
       it "should be accessable" do
         @activities.size.should == 2
@@ -69,12 +86,17 @@ describe "ScoutScout" do
           activity.title.should =~ /Passenger/
         end
       end
+      it "should be an array ScoutScout::Alert objects" do
+        @activities.first.class.should == ScoutScout::Alert
+      end
     end
     describe 'plugin' do
       describe 'list' do
         before(:each) do
-          @scout_scout.stub_get('clients/1234/plugins.xml', 'plugins.xml')
-          @plugins = @scout_scout.plugins(1234)
+          @scout_scout.stub_get('clients/13431.xml', 'client.xml')
+          @client = ScoutScout::Client.find(13431)
+          @scout_scout.stub_get('clients/13431/plugins.xml', 'plugins.xml')
+          @plugins = @client.plugins
         end
         it "should be accessable" do
           @plugins.size.should == 2
@@ -83,20 +105,29 @@ describe "ScoutScout" do
             plugin.descriptors.length.should == 11
           end
         end
+        it "should be an array ScoutScout::Plugin objects" do
+          @plugins.first.class.should == ScoutScout::Plugin
+        end
       end
       describe 'individually' do
         before(:each) do
-          @scout_scout.stub_get('plugins/show.xml?host=foo.awesome.com&name=passenger', 'plugin_data.xml')
-          @plugin_data = @scout_scout.plugin_data('foo.awesome.com','passenger')
+          @scout_scout.stub_get('clients/13431.xml', 'client.xml')
+          @client = ScoutScout::Client.find(13431)
+          @scout_scout.stub_get('clients/13431/plugins/12345.xml', 'plugin_data.xml')
+          @plugin_data = @client.plugin(12345)
         end
         it "should be accessable" do
+          @plugin_data.class.should == ScoutScout::Plugin
           @plugin_data.name.should == 'Passenger'
           @plugin_data.descriptors.length.should == 11
         end
         it "should include descriptors" do
+          @plugin_data.descriptors.first.class.should == ScoutScout::Descriptor
           @plugin_data.descriptors.first.value.should == '31'
           @plugin_data.descriptors.first.name.should == 'passenger_process_active'
         end
+        it "should be an ScoutScout::Plugin objects" do
+        end
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scout_scout
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jesse Newland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-30 00:00:00 -05:00
+date: 2010-01-31 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,10 @@ files:
 - README.rdoc
 - Rakefile
 - lib/scout_scout.rb
+- lib/scout_scout/alert.rb
+- lib/scout_scout/client.rb
+- lib/scout_scout/descriptor.rb
+- lib/scout_scout/plugin.rb
 - lib/scout_scout/version.rb
 - spec/fixtures/activities.xml
 - spec/fixtures/client.xml