fog_tracker 0.1.2 → 0.1.3

data/README.md

@@ -14,15 +14,15 @@ The Fog Tracker uses the [Fog gem](https://github.com/fog/fog) to periodically p
 ----------------
 Why is it?
 ----------------
-The Fog Tracker is intended to be a foundation library, on top of which more complex cloud dashboard or management applications can be built. It allows such applications to decouple their requests to cloud service providers from their access to the results of those requests.
+The Fog Tracker is intended to be a foundation library, on top of which more complex cloud dashboard or management applications can be built. It is a polling and query layer, allowing such applications to decouple their (read-only) requests to cloud service providers from access to the results of those requests.
 
 
 ----------------
 Where is it? (Installation)
 ----------------
-Install the Fog Tracker gem (and its dependencies if necessary) from RubyGems
+Install the Fog Tracker gem and its dependencies from RubyGems:
 
-    gem install fog_tracker [rake bundler]
+    gem install fog_tracker
 
 
 ----------------
@@ -57,7 +57,7 @@ How is it [done]? (Usage)
 
     tracker.start
 
-3) Access the Fog object collections by calling `Tracker::query`, and passing it a filter-based query String. The query string format is: `account_name::service::provider::collection`
+3) Access the Fog object collections by passing a filter-based query String to `Tracker::query`. The query string format is: `account_name::service::provider::collection`
 
     # get all Compute instances across all accounts and providers
     tracker.query("*::Compute::*::servers")
@@ -68,11 +68,14 @@ How is it [done]? (Usage)
     # get all S3 objects in a given account
     tracker["my production account::Storage::AWS::files"]
 
-  If you're tired of calling `each` on the results of every query, pass a single-argument block, and it will be invoked once with each resulting resource:
+  ----------------
+  *Usage Tips*
+
+  Instead of calling `each` on the results of every query, you can pass a single-argument block, and it will be invoked once with each resulting resource:
 
     tracker.query("*::*::*::*"){|r| puts "Found #{r.class} #{r.identity}"}
 
-  You can also pass a Proc to the Tracker at initialization, which will be invoked whenever an account's Resources have been updated. It should accept a list of the updated Resources as its first argument:
+  You can also pass a Proc to the Tracker at initialization, which will be invoked whenever an account's Resources have been updated. It should accept an Array containing the updated Resources as its first argument:
 
     FogTracker::Tracker.new(YAML::load(File.read 'accounts.yml'),
       :callback => Proc.new do |resources|
@@ -81,7 +84,9 @@ How is it [done]? (Usage)
       end
     ).start
 
-  The appropriate account information for each Fog resource, read from `accounts.yml` can be obtained by calling its `tracker_account` method.
+  To get a Resource's Hash of account information, call its `tracker_account` method _(credentials are removed)_.
+
+Any Exceptions that occur in the Tracker's polling threads are rescued and logged. If you want to take further action, you can initialize the Tracker with an `:error_callback` Proc, similar to the Account update `:callback` -- except that the `:error_callback` should accept an Exception instead of an Array of Resources.
 
 
 ----------------

data/lib/fog_tracker/account_tracker.rb

@@ -20,6 +20,8 @@ module FogTracker
     # * +:delay+ - Default time between polling of accounts
     # * +:callback+ - A Method or Proc to call each time an account is polled.
     #     It should take the name of the account as its only required parameter
+    # * +:error_callback+ - A Proc to call if polling errors occur.
+    #     It should take a single Exception as its only required parameter
     # * +:logger+ - a Ruby Logger-compatible object
     def initialize(account_name, account, options={})
       @name     = account_name
@@ -28,6 +30,7 @@ module FogTracker
       @log      = options[:logger] || FogTracker.default_logger
       @delay    = options[:delay]  || account[:polling_time] ||
                               FogTracker::DEFAULT_POLLING_TIME
+      @error_proc = options[:error_callback]
       @log.debug "Creating tracker for account #{@name}."
       create_resource_trackers
     end
@@ -46,8 +49,10 @@ module FogTracker
             end
           rescue Exception => e
             @log.error "Exception polling account #{name}: #{e.message}"
-            @log.error e.backtrace.join("\n")
-            exit 99
+            e.backtrace.each {|line| @log.debug line}
+            @error_proc.call(e) if @error_proc
+            sleep @delay
+            retry
           end
         end
       else

data/lib/fog_tracker/tracker.rb

@@ -17,12 +17,15 @@ module FogTracker
     # * +:delay+ - Time between polling of accounts. Overrides per-account value
     # * +:callback+ - A Proc to call each time an account is polled.
     #     It should take the name of the account as its only required parameter
+    # * +:error_callback+ - A Proc to call if polling errors occur.
+    #     It should take a single Exception as its only required parameter
     # * +:logger+ - a Ruby Logger-compatible object
     def initialize(accounts = {}, options = {})
       @accounts = accounts
       @delay    = options[:delay]
       @callback = options[:callback]
       @log      = options[:logger] || FogTracker.default_logger
+      @error_proc = options[:error_callback]
       # Create a Hash that maps account names to AccountTrackers
       create_trackers
     end
@@ -86,7 +89,8 @@ module FogTracker
       @accounts.each do |name, account|
         @log.debug "Setting up tracker for account #{name}"
         @trackers[name] = AccountTracker.new(name, account,
-        {:delay => @delay, :callback => @callback, :logger => @log})
+        {:delay => @delay, :callback => @callback, 
+          :error_callback => @error_proc, :logger => @log})
       end
     end
 

data/lib/fog_tracker/version.rb

@@ -1,3 +1,3 @@
 module FogTracker
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/lib/fog_tracker/account_tracker_spec.rb

@@ -26,6 +26,24 @@ module FogTracker
         @tracker.resource_trackers.size.should be > 0
       end
 
+      context "when it encounters an Exception while updating" do
+        context "when initialized with an error callback" do
+          it "should fire the callback" do
+            ResourceTracker.any_instance.stub(:update).and_raise
+            receiver = double "error callback object"
+            receiver.stub(:callback)
+            tracker = AccountTracker.new(
+              FAKE_ACCOUNT_NAME, FAKE_ACCOUNT, {
+                :error_callback => Proc.new {|err| receiver.callback(err)}
+              }
+            )
+            receiver.should_receive(:callback).exactly(:once)
+            tracker.start
+            sleep THREAD_STARTUP_DELAY
+          end
+        end
+      end
+
       describe '#start' do
         it "sends update() to its ResourceTrackers" do
           @tracker.resource_trackers.each do |resource_tracker|
@@ -34,6 +52,17 @@ module FogTracker
           @tracker.start
           sleep THREAD_STARTUP_DELAY # wait for background thread to start
         end
+        it "invokes its callback Proc when its account is updated" do
+          receiver = double "account callback object"
+          receiver.stub(:callback)
+          tracker = AccountTracker.new(
+            FAKE_ACCOUNT_NAME, FAKE_ACCOUNT, :logger => LOG,
+            :callback => Proc.new {|resources| receiver.callback(resources)}
+          )
+          receiver.should_receive(:callback).exactly(FAKE_ACCOUNTS.size).times
+          tracker.start
+          sleep THREAD_STARTUP_DELAY
+        end
       end
 
       describe '#stop' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70121482437700 !ruby/object:Gem::Requirement
+  requirement: &2151853820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70121482437700
+  version_requirements: *2151853820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70121482437100 !ruby/object:Gem::Requirement
+  requirement: &2151853060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121482437100
+  version_requirements: *2151853060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70121482436440 !ruby/object:Gem::Requirement
+  requirement: &2151852120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121482436440
+  version_requirements: *2151852120
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70121482435700 !ruby/object:Gem::Requirement
+  requirement: &2151850540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121482435700
+  version_requirements: *2151850540
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70121482434720 !ruby/object:Gem::Requirement
+  requirement: &2151848880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121482434720
+  version_requirements: *2151848880
 - !ruby/object:Gem::Dependency
   name: guard-rake
-  requirement: &70121482433280 !ruby/object:Gem::Requirement
+  requirement: &2151844960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121482433280
+  version_requirements: *2151844960
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
-  requirement: &70121482432400 !ruby/object:Gem::Requirement
+  requirement: &2151843360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121482432400
+  version_requirements: *2151843360
 description: This gem peridically polls mutiple cloud computing services using the
   fog gem, asynchronously updating the state of the resulting collections of Fog Resources.
 email:
@@ -136,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2556488865982976006
+      hash: 586888198881977126
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -145,10 +145,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2556488865982976006
+      hash: 586888198881977126
 requirements: []
 rubyforge_project: fog_tracker
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Tracks the state of cloud computing resources across multiple accounts with