fog_tracker 0.1.4 → 0.1.5

data/Guardfile

@@ -1,8 +1,9 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2, :cli => "--color --format documentation" do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+guard 'rspec', :version => 2,
+  :cli => "--color --format documentation -r ./spec/spec_helper.rb" do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.md

@@ -68,25 +68,28 @@ How is it [done]? (Usage)
     # get all S3 objects in a given account
     tracker["my production account::Storage::AWS::files"]
 
-  ----------------
-  *Usage Tips*
+----------------
+*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:
+* 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}"}
+        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 an Array containing 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|
-      	puts "Got #{resources.count} resources from account "+
-		      resources.first.tracker_account[:name]
-      end
-    ).start
+        FogTracker::Tracker.new(YAML::load(File.read 'accounts.yml'),
+          :callback => Proc.new do |resources|
+          	puts "Got #{resources.count} resources from account "+
+    		      resources.first.tracker_account[:name]
+          end
+        ).start
 
-  To get a Resource's Hash of account information, call its `tracker_account` method _(credentials are removed)_.
+* The resources returned from a query are all Fog::Model objects, but they are "decorated" with some extra methods for your convenience. This simplifies the code that consumes the resources, because it does not have to know anything about the tracker. Here are the methods added:
+  1. To get a Resource's Hash of account information, call its `tracker_account` method _(credentials are removed)_.
+  2. To query for more resources, you can call `resource.tracker_query(query_string)`, though you cannot yet pass a block to this method.
+  3. To get a collection of resources from the same account, call `resource.account_resources(collection_name)`.
 
-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.
+* 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/bin/{tracker → fog_tracker}

@@ -4,10 +4,10 @@
 #   Uses the Fog gem to track the status of cloud computing resources
 #
 # == Usage
-#   tracker.rb [options] ACCOUNTS_CONFIG_FILE.YML
+#   fog_tracker.rb [options] ACCOUNTS_CONFIG_FILE.YML
 #
 # == Options (all options can be put into the config file)
-#   -d, --delay [INTEGER]       Seconds between status updates. default = 180
+#   -d, --delay [INTEGER]       Seconds between status updates.
 #   -l, --log-level [LEVEL]     Sets Log4r level for console output. default = INFO
 #   -h, --help                  Displays help message
 #

data/lib/fog_tracker/account_tracker.rb

@@ -18,7 +18,7 @@ module FogTracker
     # @param [Hash] options optional additional parameters:
     #  - :delay (Integer) - Default time between polling of accounts
     #  - :callback (Proc) - A Method or Proc to call each time an account is polled.
-    #    (should take the name of the account as its only required parameter)
+    #    (should take an Array of resources as its only required parameter)
     #  - :error_callback (Proc) - A Method or Proc to call if polling errors occur.
     #    (should take a single Exception as its only required parameter)
     #  - :logger - a Ruby Logger-compatible object
@@ -29,6 +29,7 @@ module FogTracker
       @log      = options[:logger] || FogTracker.default_logger
       @delay    = options[:delay]  || account[:polling_time] ||
                               FogTracker::DEFAULT_POLLING_TIME
+      @account[:polling_time] = @delay  # TODO - test this
       @error_proc = options[:error_callback]
       @log.debug "Creating tracker for account #{@name}."
       create_collection_trackers

data/lib/fog_tracker/collection_tracker.rb

@@ -5,7 +5,7 @@ module FogTracker
   class CollectionTracker
 
     # An Array of Fog::Model objects, all of the same resource type (class)
-    attr_accessor :collection
+    attr_reader :collection
 
     # Creates an object for tracking a single Fog collection in a single account
     # @param [String] resource_type the Fog collection name for this resource type

data/lib/fog_tracker/extensions/fog_model.rb

@@ -0,0 +1,46 @@
+module FogTracker
+  module Extensions
+    # Adds convenience methods to Fog::Model instances for gathering
+    # information about its account, and about other Fog::Model resources
+    module FogModel
+      extend Forwardable        # Resources need to be queriable
+
+      # a FogTracker::CollectionTracker - *do not modify* - used for {#tracker_account}
+      attr_accessor :_fog_collection_tracker
+
+      # a FogTracker::QueryParser - *do not modify* - used for tracker_query
+      attr_accessor :_query_processor
+      def_delegator :@_query_processor, :execute, :tracker_query
+
+      # Returns a cleaned copy of the resource's account information
+      # from the its collection tracker (credentials are removed).
+      # @return [Hash] a cleaned copy of the resource's account information
+      def tracker_account
+        (not _fog_collection_tracker) ? Hash.new :
+        _fog_collection_tracker.clean_account_data
+      end
+
+      # Returns Fog::Model resources from this Resource's account only
+      # @param [String] collection_name a String which is converted to
+      #   a RegEx, and used to match collection names for resources
+      #   in the same account as the current resource.
+      # @return [Array <Fog::Model>] an Array of resources from this Model's
+      #   accout, whose collection matches collection_name.
+      def account_resources(collection_name)
+        (not @_query_processor) ? Array.new :
+        @_query_processor.execute(
+          "#{tracker_account[:name]}::"+
+          "#{tracker_account[:service]}::"+
+          "#{tracker_account[:provider]}::"+
+          "#{collection_name}"
+        )
+      end
+    end
+  end
+end
+
+module Fog
+  class Model
+    include FogTracker::Extensions::FogModel
+  end
+end

data/lib/fog_tracker/query/query_processor.rb

@@ -16,7 +16,7 @@ module FogTracker
         @log      = options[:logger] || FogTracker.default_logger
       end
 
-      # Uses the query string to filter this account's resources 
+      # Uses the query string to filter this account's resources
       # for a desired subset
       # @param [String] query a string used to filter for matching resources
       # @return [Array <Fog::Model>] an Array of Resources, filtered by query
@@ -24,7 +24,9 @@ module FogTracker
         acct_pattern, svc_pattern, prov_pattern, col_pattern = parse_query(query)
         filter_by_collection(
           filter_by_provider(
-            filter_by_service(get_results_by_account(acct_pattern), svc_pattern),
+            filter_by_service(
+              attach_query_methods(get_results_by_account(acct_pattern)),
+              svc_pattern),
             prov_pattern),
           col_pattern)
       end
@@ -89,6 +91,12 @@ module FogTracker
         end
       end
 
+      # adds the _tracker_query_parser attribute to all resources
+      def attach_query_methods(resources)
+        resources.each {|resource| resource._query_processor = self}
+        resources
+      end
+
     end
   end
 end

data/lib/fog_tracker/tracker.rb

@@ -12,7 +12,7 @@ module FogTracker
     # @param [Hash] options optional additional parameters:
     #  - :delay (Integer) - Default time between polling of accounts
     #  - :callback (Proc) - A Method or Proc to call each time an account is polled.
-    #    (should take the name of the account as its only required parameter)
+    #    (should take an Array of resources as its only required parameter)
     #  - :error_callback (Proc) - A Method or Proc to call if polling errors occur.
     #    (should take a single Exception as its only required parameter)
     #  - :logger - a Ruby Logger-compatible object
@@ -56,12 +56,12 @@ module FogTracker
 
     # Returns an Array of resource types for a given account
     # @param [String] name the name of the account
-    # @return [Array<String>] an array of Resource types 
+    # @return [Array<String>] an array of Resource types
     def types_for_account(account_name)
       @trackers[account_name].tracked_types
     end
 
-    # Returns an array of Resources matching the {query_string}.
+    # Returns an array of Resources matching the query_string.
     # Calls any block passed for each resulting resource.
     # @param [String] query_string a string used to filter for matching resources
     #          it might look like: "Account Name::Compute::AWS::servers"

data/lib/fog_tracker/version.rb

@@ -1,3 +1,3 @@
 module FogTracker
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/lib/fog_tracker/account_tracker_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module FogTracker
 
     describe AccountTracker do

data/spec/lib/fog_tracker/{resource_tracker_spec.rb → collection_tracker_spec.rb}

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module FogTracker
 
     describe CollectionTracker do

data/spec/lib/fog_tracker/extensions/fog_model_spec.rb

@@ -0,0 +1,54 @@
+module FogTracker
+  module Extensions
+    describe FogModel do
+
+      before(:each) do
+        @model = FAKE_AWS.servers.new
+      end
+
+      describe '#tracker_account' do
+        context "with no collection tracker assigned" do
+          it "returns an empty Hash" do
+            @model.tracker_account.should == Hash.new
+          end
+        end
+        context "with a collection tracker assigned" do
+          before(:each) do
+            @account_data = {   # some sample account data
+              :name => 'fake account name',
+              :provider => 'AWS', :service => 'Compute'
+            }
+            @fake_tracker = double "mock account tracker"
+            @fake_tracker.stub(:clean_account_data).and_return(@account_data)
+            @model._fog_collection_tracker = @fake_tracker
+          end
+          it "returns a Hash of the resource's acccount data" do
+            @fake_tracker.should_receive(:clean_account_data)
+            @model.tracker_account.should == @account_data
+          end
+        end
+      end
+
+      describe '#tracker_query' do
+        context "with no query processor assigned" do
+          it "raises a NoMethodError" do
+            q = Proc.new { @model.tracker_query('XXX') }
+            q.should raise_error
+          end
+        end
+        context "with a query processor assigned" do
+          before(:each) do
+            @fake_processor = double "mock query processor"
+            @fake_processor.stub(:query).and_return(Array.new)
+            @model._query_processor = @fake_processor
+          end
+          it "forwards the query to its query processor" do
+            @fake_processor.should_receive(:execute).with('XXX')
+            @model.tracker_query('XXX')
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/fog_tracker/query/query_processor_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module FogTracker
   module Query
 
@@ -90,9 +88,15 @@ module FogTracker
               true
             end
           end
-
+          it "assigns itself to @_query_processor on all resoruces" do
+            @processor.execute(QUERY['matching all Resources']).each do |resource|
+              resource._query_processor.should == @processor
+            end
+          end
         end
+
       end
     end
+
   end
 end

data/spec/lib/fog_tracker/tracker_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module FogTracker
   describe Tracker do
 

data/spec/support/_mocks.rb

@@ -18,6 +18,11 @@ module FogTracker
     ],
   }
   FAKE_ACCOUNTS = {FAKE_ACCOUNT_NAME => FAKE_ACCOUNT}
+  FAKE_AWS = Fog::Compute.new(
+    :provider => 'AWS',
+    :aws_access_key_id => FAKE_ACCOUNT[:credentials][:aws_access_key_id],
+    :aws_secret_access_key => FAKE_ACCOUNT[:credentials][:aws_secret_access_key],
+  )
   module Query
     QUERY = {}  # Used in query_processor_spec.rb
   end
@@ -31,8 +36,9 @@ module Fog
       (1..NUMBER_OF_FAKE_RESOURCE_TYPES).each do |class_index|
         eval(%Q{
             class FakeCollectionType#{class_index} ; end
-            class FakeResourceType#{class_index}
+            class FakeResourceType#{class_index} < Fog::Model
               def collection ; FakeCollectionType#{class_index}.new end
+              def identity; "Fake_ID_for_Type#{class_index} " end
             end
           })
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000Z
+date: 2012-01-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70093896997020 !ruby/object:Gem::Requirement
+  requirement: &70122132638240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70093896997020
+  version_requirements: *70122132638240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70093896996120 !ruby/object:Gem::Requirement
+  requirement: &70122132637400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093896996120
+  version_requirements: *70122132637400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70093896994520 !ruby/object:Gem::Requirement
+  requirement: &70122132636520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093896994520
+  version_requirements: *70122132636520
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70093896993060 !ruby/object:Gem::Requirement
+  requirement: &70122132635680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093896993060
+  version_requirements: *70122132635680
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70093896991540 !ruby/object:Gem::Requirement
+  requirement: &70122132634960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093896991540
+  version_requirements: *70122132634960
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70093896989420 !ruby/object:Gem::Requirement
+  requirement: &70122132634360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093896989420
+  version_requirements: *70122132634360
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
-  requirement: &70093896987000 !ruby/object:Gem::Requirement
+  requirement: &70122132633680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,13 +87,13 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093896987000
+  version_requirements: *70122132633680
 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:
 - benton@bentonroberts.com
 executables:
-- tracker
+- fog_tracker
 extensions: []
 extra_rdoc_files: []
 files:
@@ -103,21 +103,22 @@ files:
 - Guardfile
 - README.md
 - Rakefile
-- bin/tracker
+- bin/fog_tracker
 - config/accounts.yml.example
 - fog_tracker.gemspec
-- lib/fog/core/model.rb
 - lib/fog_tracker.rb
 - lib/fog_tracker/account_tracker.rb
 - lib/fog_tracker/collection_tracker.rb
+- lib/fog_tracker/extensions/fog_model.rb
 - lib/fog_tracker/query/query_processor.rb
 - lib/fog_tracker/tracker.rb
 - lib/fog_tracker/util/string_underscore.rb
 - lib/fog_tracker/version.rb
 - lib/tasks/rspec.rake
 - spec/lib/fog_tracker/account_tracker_spec.rb
+- spec/lib/fog_tracker/collection_tracker_spec.rb
+- spec/lib/fog_tracker/extensions/fog_model_spec.rb
 - spec/lib/fog_tracker/query/query_processor_spec.rb
-- spec/lib/fog_tracker/resource_tracker_spec.rb
 - spec/lib/fog_tracker/tracker_spec.rb
 - spec/spec_helper.rb
 - spec/support/_configure_logging.rb
@@ -137,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 589883015526840149
+      hash: -3623635241096457723
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 589883015526840149
+      hash: -3623635241096457723
 requirements: []
 rubyforge_project: fog_tracker
 rubygems_version: 1.8.10
@@ -156,8 +157,9 @@ summary: Tracks the state of cloud computing resources across multiple accounts
   multiple service providers
 test_files:
 - spec/lib/fog_tracker/account_tracker_spec.rb
+- spec/lib/fog_tracker/collection_tracker_spec.rb
+- spec/lib/fog_tracker/extensions/fog_model_spec.rb
 - spec/lib/fog_tracker/query/query_processor_spec.rb
-- spec/lib/fog_tracker/resource_tracker_spec.rb
 - spec/lib/fog_tracker/tracker_spec.rb
 - spec/spec_helper.rb
 - spec/support/_configure_logging.rb

data/lib/fog/core/model.rb

@@ -1,21 +0,0 @@
-module Fog
-
-  # Adds an accessor and a method to decorate Fog::Model instances
-  # with tracker account information
-  class Model
-
-    # a FogTracker::CollectionTracker
-    attr_accessor :_fog_collection_tracker
-
-    # Returns a cleaned copy of the resource's account information
-    # from the its collection tracker (credentials are removed).
-    def tracker_account
-      if _fog_collection_tracker
-        _fog_collection_tracker.clean_account_data
-      else
-        Hash.new
-      end
-    end
-
-  end
-end