scout_api 0.9.0 → 0.9.1

data/CHANGELOG

@@ -1,3 +1,8 @@
 == 0.9.0
 
-Initial release.
+Initial release.
+
+== 0.9.1
+
+* Fixed Ruby 1.9.2 issue accessing Server#key
+* Documentation updates

data/README.rdoc

@@ -45,15 +45,16 @@ a group of metrics, and aggregated metrics. For example:
   Scout::Metric.average(1)
 
   # maximum rate of insert queries over the previous 24 hours
-  Scout::Server.first(:name => "DB Server").metrics.maximum('inserts',:start => Time.now.utc-(24*3600)*2,:end => Time.now.utc-(24*3600))
+  Scout::Server.first(:name => "DB Server").metrics.maximum(:name => 'inserts', 
+  :start => Time.now.utc-(24*3600)*2,:end => Time.now.utc-(24*3600) )
 
   # average memory used across all servers in the 'web servers' group
-  Scout::Group.first(:name => 'web servers').metrics.average('mem_used')
-  Scout::Group.first(:name => 'web servers').metrics.average('mem_used', :format => 'sparkline').to_sparkline
-  Scout::Group.first(:name => 'web servers').metrics.average('mem_used').to_a
+  Scout::Group.first(:name => 'web servers').metrics.average(:name => 'Memory Used')
+  Scout::Group.first(:name => 'web servers').metrics.average(:name => 'Memory Used').to_sparkline
+  Scout::Group.first(:name => 'web servers').metrics.average(:name => 'Memory Used').to_a
 
   # total throughput across web servers
-  Scout::Group.first(:name => 'web servers').metrics.average('request_rate', :aggregate => true)
+  Scout::Group.first(:name => 'web servers').metrics.average(:name => 'request_rate', :aggregate => true)
 
 == Server Management
 

data/lib/scout_api/account.rb

@@ -19,15 +19,6 @@ class Scout::Account
     response['alerts'] ? response['alerts'].map { |alert| Scout::Alert.new(alert) } : Array.new
   end
 
-  # All servers on this account
-  #
-  # @return [Array] An array of Scout::Server objects
-  def servers
-    warn "Scout#servers is deprecated. Use Scout::Server.all() instead."
-    response = self.class.get("/clients.xml")
-    response['clients'] ? response['clients'].map { |client| Scout::Server.new(client) } : Array.new
-  end
-
   def people
     response = self.class.get("/account_memberships")
     doc = Nokogiri::HTML(response.body)

data/lib/scout_api/group.rb

@@ -7,14 +7,14 @@ class Scout::Group < Hashie::Mash
   # Examples:
   # 
   # * <tt>Scout::Group.metrics => All metrics associated with this group.</tt>
-  # * <tt>Scout::Group.metrics.all(:name => 'mem_used') => Metrics with name =~ 'mem_used' across all servers in this group.</tt>
-  # * <tt>Scout::Group.metrics.average(:name => 'mem_used') => Average value of metrics with name =~ 'mem_used' across all servers in the group.</tt> 
-  # * <tt>Scout::Group.metrics.maximum(:name => 'mem_used')</tt>
-  # * <tt>Scout::Group.metrics.minimum(:name => 'mem_used')</tt>
+  # * <tt>Scout::Group.metrics.all(:name => 'Memory Used') => Metrics with name =~ 'Memory Used' across all servers in this group.</tt>
+  # * <tt>Scout::Group.metrics.average(:name => 'Memory Used') => Average value of metrics with name =~ 'Memory Used' across all servers in the group.</tt> 
+  # * <tt>Scout::Group.metrics.maximum(:name => 'Memory Used')</tt>
+  # * <tt>Scout::Group.metrics.minimum(:name => 'Memory Used')</tt>
   # * <tt>Scout::Group.metrics.average(:name => 'request_rate', :aggregate => true) => Sum metrics, then take average</tt>
   # * <tt>Scout::Group.metrics.average(:name => 'request_rate', :start => Time.now.utc-5*3600, :end => Time.now.utc-2*3600) => Retrieve data starting @ 5 hours ago ending at 2 hours ago</tt>
-  # * <tt>Scout::Group.metrics.average(:name => 'mem_used').to_array => An array of time series values over the past hour.</tt> 
-  # * <tt>Scout::Group.metrics.average(:name => 'mem_used').to_sparkline => A Url to a Google Sparkline Chart.</tt> 
+  # * <tt>Scout::Group.metrics.average(:name => 'Memory Used').to_array => An array of time series values over the past hour.</tt> 
+  # * <tt>Scout::Group.metrics.average(:name => 'Memory Used').to_sparkline => A Url to a Google Sparkline Chart.</tt> 
   attr_reader :metrics
 
   def initialize(hash) #:nodoc:

data/lib/scout_api/metric.rb

@@ -86,7 +86,7 @@ class Scout::Metric < Hashie::Mash
   #   Scout::Metric.average('request_rate', :aggregate => true)
   #
   #   # How much average memory did my servers use yesterday?
-  #   # Scout::Metric.average('mem_used', :start => Time.now-(24*60*60)*2, :end => Time.now-(24*60*60))
+  #   # Scout::Metric.average('Memory Used', :start => Time.now-(24*60*60)*2, :end => Time.now-(24*60*60))
   #
   # @return [Hash]
   def self.average(id_or_name,options = {})

data/lib/scout_api/plugin.rb

@@ -7,14 +7,14 @@ class Scout::Plugin < Hashie::Mash
   # Examples:
   # 
   # * <tt>Scout::Plugin.metrics => All metrics associated with this plugin.</tt>
-  # * <tt>Scout::Plugin.metrics.all(:name => 'mem_used') => Metrics with name =~ 'mem_used' on this plugin.</tt>
-  # * <tt>Scout::Plugin.metrics.average(:name => 'mem_used') => Average value of metrics with name =~ 'mem_used' on this plugin.</tt> 
-  # * <tt>Scout::Plugin.metrics.maximum(:name => 'mem_used')</tt>
-  # * <tt>Scout::Plugin.metrics.minimum(:name => 'mem_used')</tt>
+  # * <tt>Scout::Plugin.metrics.all(:name => 'Memory Used') => Metrics with name =~ 'Memory Used' on this plugin.</tt>
+  # * <tt>Scout::Plugin.metrics.average(:name => 'Memory Used') => Average value of metrics with name =~ 'Memory Used' on this plugin.</tt> 
+  # * <tt>Scout::Plugin.metrics.maximum(:name => 'Memory Used')</tt>
+  # * <tt>Scout::Plugin.metrics.minimum(:name => 'Memory Used')</tt>
   # * <tt>Scout::Plugin.metrics.average(:name => 'request_rate', :aggregate => true) => Sum metrics, then take average</tt>
   # * <tt>Scout::Plugin.metrics.average(:name => 'request_rate', :start => Time.now.utc-5*3600, :end => Time.now.utc-2*3600) => Retrieve data starting @ 5 hours ago ending at 2 hours ago</tt>
-  # * <tt>Scout::Plugin.metrics.average(:name => 'mem_used').to_array => An array of time series values over the past hour.</tt> 
-  # * <tt>Scout::Plugin.metrics.average(:name => 'mem_used').to_sparkline => A Url to a Google Sparkline Chart.</tt>
+  # * <tt>Scout::Plugin.metrics.average(:name => 'Memory Used').to_array => An array of time series values over the past hour.</tt> 
+  # * <tt>Scout::Plugin.metrics.average(:name => 'Memory Used').to_sparkline => A Url to a Google Sparkline Chart.</tt>
   attr_reader :metrics
   
   attr_reader :descriptor_hash #:nodoc:

data/lib/scout_api/server.rb

@@ -5,14 +5,14 @@ class Scout::Server < Hashie::Mash
   # Examples:
   # 
   # * <tt>Scout::Server.metrics => All metrics associated with this server.</tt>
-  # * <tt>Scout::Server.metrics.all(:name => 'mem_used') => Metrics with name =~ 'mem_used' on this server.</tt>
-  # * <tt>Scout::Server.metrics.average(:name => 'mem_used') => Average value of metrics with name =~ 'mem_used' on this server.</tt> 
-  # * <tt>Scout::Server.metrics.maximum(:name => 'mem_used')</tt>
-  # * <tt>Scout::Server.metrics.minimum(:name => 'mem_used')</tt>
+  # * <tt>Scout::Server.metrics.all(:name => 'Memory Used') => Metrics with name =~ 'Memory Used' on this server.</tt>
+  # * <tt>Scout::Server.metrics.average(:name => 'Memory Used') => Average value of metrics with name =~ 'Memory Used' on this server.</tt> 
+  # * <tt>Scout::Server.metrics.maximum(:name => 'Memory Used')</tt>
+  # * <tt>Scout::Server.metrics.minimum(:name => 'Memory Used')</tt>
   # * <tt>Scout::Server.metrics.average(:name => 'request_rate', :aggregate => true) => Sum metrics, then take average</tt>
   # * <tt>Scout::Server.metrics.average(:name => 'request_rate', :start => Time.now.utc-5*3600, :end => Time.now.utc-2*3600) => Retrieve data starting @ 5 hours ago ending at 2 hours ago</tt>
-  # * <tt>Scout::Server.metrics.average(:name => 'mem_used').to_array => An array of time series values over the past hour.</tt> 
-  # * <tt>Scout::Server.metrics.average(:name => 'mem_used').to_sparkline => A Url to a Google Sparkline Chart.</tt>
+  # * <tt>Scout::Server.metrics.average(:name => 'Memory Used').to_array => An array of time series values over the past hour.</tt> 
+  # * <tt>Scout::Server.metrics.average(:name => 'Memory Used').to_sparkline => A Url to a Google Sparkline Chart.</tt>
   attr_reader :metrics
   
   def initialize(hash) #:nodoc:
@@ -23,6 +23,11 @@ class Scout::Server < Hashie::Mash
     @metrics = Scout::MetricProxy.new(self)
     super(hash)
   end
+  
+  # Ruby 1.9.2 Hash#key is a method. This overrides so +key+ returns Server#key.
+  def key #:nodoc:
+    self[:key]
+  end
 
   # Finds the first server that meets the given conditions. Possible parameter formats:
   # 

data/lib/scout_api/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/scout_api.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scout_api}
+  s.version = "0.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jesse Newland", "Derek Haynes"]
+  s.date = %q{2011-05-04}
+  s.description = %q{A library for interacting with Scout (http://scoutapp.com), a hosted server monitoring service. Query for metric data, manage servers, and more.}
+  s.email = %q{support@scoutapp.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "lib/scout_api.rb",
+    "lib/scout_api/account.rb",
+    "lib/scout_api/alert.rb",
+    "lib/scout_api/group.rb",
+    "lib/scout_api/metric.rb",
+    "lib/scout_api/metric_calculation.rb",
+    "lib/scout_api/metric_proxy.rb",
+    "lib/scout_api/person.rb",
+    "lib/scout_api/plugin.rb",
+    "lib/scout_api/server.rb",
+    "lib/scout_api/trigger.rb",
+    "lib/scout_api/version.rb",
+    "scout_api.gemspec",
+    "test/alert_test.rb",
+    "test/fixtures/activities.xml",
+    "test/fixtures/client.xml",
+    "test/fixtures/client_by_hostname.xml",
+    "test/fixtures/clients.xml",
+    "test/fixtures/data.xml",
+    "test/fixtures/descriptors.xml",
+    "test/fixtures/plugin_data.xml",
+    "test/fixtures/plugins.xml",
+    "test/fixtures/triggers.xml",
+    "test/global_test.rb",
+    "test/metric_proxy_test.rb",
+    "test/metric_test.rb",
+    "test/plugin_test.rb",
+    "test/server_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{https://scoutapp.com/info/api}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{API wrapper for scoutapp.com}
+  s.test_files = [
+    "test/alert_test.rb",
+    "test/global_test.rb",
+    "test/metric_proxy_test.rb",
+    "test/metric_test.rb",
+    "test/plugin_test.rb",
+    "test/server_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, ["~> 0.1.8"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.5.0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0"])
+    else
+      s.add_dependency(%q<hashie>, ["~> 0.1.8"])
+      s.add_dependency(%q<httparty>, ["~> 0.5.0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0"])
+    end
+  else
+    s.add_dependency(%q<hashie>, ["~> 0.1.8"])
+    s.add_dependency(%q<httparty>, ["~> 0.5.0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scout_api
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 57
   prerelease: 
   segments: 
   - 0
   - 9
-  - 0
-  version: 0.9.0
+  - 1
+  version: 0.9.1
 platform: ruby
 authors: 
 - Jesse Newland
@@ -124,7 +124,7 @@ files:
 - lib/scout_api/server.rb
 - lib/scout_api/trigger.rb
 - lib/scout_api/version.rb
-- scout_scout.gemspec
+- scout_api.gemspec
 - test/alert_test.rb
 - test/fixtures/activities.xml
 - test/fixtures/client.xml

data/scout_scout.gemspec

@@ -1,86 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{scout_scout}
-  s.version = "0.0.6"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jesse Newland"]
-  s.date = %q{2011-04-10}
-  s.description = %q{API wrapper for scout.com}
-  s.email = %q{jnewland@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "lib/scout_scout.rb",
-    "lib/scout_scout/alert.rb",
-    "lib/scout_scout/cluster.rb",
-    "lib/scout_scout/descriptor.rb",
-    "lib/scout_scout/metric.rb",
-    "lib/scout_scout/person.rb",
-    "lib/scout_scout/plugin.rb",
-    "lib/scout_scout/server.rb",
-    "lib/scout_scout/trigger.rb",
-    "lib/scout_scout/version.rb",
-    "scout_scout.gemspec",
-    "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/fixtures/triggers.xml",
-    "spec/scout_scout_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/jnewland/scout_scout}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
-  s.summary = %q{API wrapper for scout.com}
-  s.test_files = [
-    "spec/scout_scout_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<hashie>, ["~> 0.1.8"])
-      s.add_runtime_dependency(%q<httparty>, ["~> 0.5.0"])
-      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
-      s.add_development_dependency(%q<fakeweb>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0"])
-    else
-      s.add_dependency(%q<hashie>, ["~> 0.1.8"])
-      s.add_dependency(%q<httparty>, ["~> 0.5.0"])
-      s.add_dependency(%q<nokogiri>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-      s.add_dependency(%q<fakeweb>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.0"])
-    end
-  else
-    s.add_dependency(%q<hashie>, ["~> 0.1.8"])
-    s.add_dependency(%q<httparty>, ["~> 0.5.0"])
-    s.add_dependency(%q<nokogiri>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-    s.add_dependency(%q<fakeweb>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.0"])
-  end
-end
-