scout_agent 3.1.7 → 3.1.8

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 3.1.8
+
+* Switching XMPP default to off until we enable that feature
+* Added a queue_for_plugin() alias to the API for queue_for_mission()
+* Added some examples to the API documentation
+
 == 3.1.7
 
 * Reverting DNS changes due to other severe issues they caused (you can switch

data/lib/scout_agent/api.rb

@@ -243,13 +243,26 @@ module ScoutAgent
     def queue_for_mission(mission_id, message, options = { })
       QueueCommand.new(mission_id, message, options)
     end
+    alias_method :queue_for_plugin, :queue_for_mission
     
     # 
     # This method queues a report that will be sent straight to the Scout server
-    # during the next checkin.  The passed +fields+ must be a Hash and must
-    # contain a <tt>:plugin_id</tt> key/value pair that tells the server which
-    # plugin this report belongs to.  The returned object and background
-    # processing rules are the same as those described in queue_for_mission().
+    # during the next checkin.
+    # 
+    # The passed +fields+ must be a Hash and must contain a <tt>:plugin_id</tt>
+    # key/value pair that tells the server which plugin this report belongs to.
+    # All other pairs in the +fields+ Hash will be considered the data for your
+    # report.  For example, you could send the current Time in a report as
+    # follows:
+    # 
+    #   now = Time.now
+    #   ScoutAgent::API.queue_report( :hour      => now.hour,
+    #                                 :minute    => now.min,
+    #                                 :second    => now.sec,
+    #                                 :plugin_id => 42 )
+    # 
+    # The returned object and background processing rules are the same as those
+    # described in queue_for_mission().
     # 
     def queue_report(fields, options = { })
       QueueCommand.new(:report, fields, options)
@@ -271,6 +284,12 @@ module ScoutAgent
     # outlined in queue_report().  The returned object and background processing
     # rules are the same as those described in queue_for_mission().
     # 
+    # Thus a typical alert message looks like:
+    # 
+    #   ScoutAgent::API.queue_alert( :subject   => "You should know",
+    #                                :body      => "Details here...",
+    #                                :plugin_id => 42 )
+    # 
     def queue_alert(fields, options = { })
       QueueCommand.new(:alert, fields, options)
     end
@@ -281,6 +300,12 @@ module ScoutAgent
     # outlined in queue_report().  The returned object and background processing
     # rules are the same as those described in queue_for_mission().
     # 
+    # Thus a typical error message looks like:
+    # 
+    #   ScoutAgent::API.queue_error( :subject   => "Something went wrong",
+    #                                :body      => "Details here...",
+    #                                :plugin_id => 42 )
+    # 
     def queue_error(fields, options = { })
       QueueCommand.new(:error, fields, options)
     end

data/lib/scout_agent/plan.rb

@@ -24,7 +24,7 @@ module ScoutAgent
         [:proxy_url,          nil],
         [:run_as_daemon,      true],
         [:logging_level,      "INFO"],
-        [:enable_xmpp,        true],
+        [:enable_xmpp,        false],
         [:test_mode,          false],
 
         [:periodic_snapshots, true],

data/lib/scout_agent.rb

@@ -91,7 +91,7 @@ module ScoutAgent
   end
 
   # The version of this agent.
-  VERSION = "3.1.7".freeze
+  VERSION = "3.1.8".freeze
   # A Pathname reference to the agent code directory, used in dynamic loading.
   LIB_DIR = Pathname.new(File.dirname(__FILE__)) + agent_name
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scout_agent
 version: !ruby/object:Gem::Version 
-  version: 3.1.7
+  version: 3.1.8
 platform: ruby
 authors: 
 - James Edward Gray II
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -05:00
+date: 2009-05-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency