trackablaze 0.1.0 → 0.1.1

data/lib/trackablaze/command.rb

@@ -11,14 +11,18 @@ module Trackablaze
       Trackablaze::Tracker.load_trackers
       config = YAML::load( File.open( file ) )
       
-      results = Trackablaze::Tracker.run_trackers(config)
+      tracker_items = []
+      config.each do |c|
+        tracker_items << Trackablaze::TrackerItem.new(c)
+      end
+      
+      results = Trackablaze::TrackerItem.run(tracker_items)
       
-      (0..config.length-1).each do |n|
-        c = config[n]
-        tracker_name = c.keys.first
-        puts "[ #{Trackablaze::Tracker.trackers[tracker_name].title} ]".center(75,'-')
-        puts "params: #{c[tracker_name]['params']}"
-        puts "results: #{results[n]}"
+      tracker_items.each do |tracker_item|
+        puts "[ #{tracker_item.title} ]".center(75,'-')
+        puts "Key: #{tracker_item.key}"
+        puts "params: #{tracker_item.params}"
+        puts "results: #{results[tracker_item.key]}"
       end
     end
   end

data/lib/trackablaze/tracker.rb

@@ -1,6 +1,19 @@
 module Trackablaze
   class Tracker
     
+    # A string that uniquely identifies this instance of the tracker
+    # This is to optimize multiple instances that are exactly the same
+    # e.g. if 100 people want to track amolk's twitter account, the tracker can
+    # be run only once, optimizing calls to Twitter API. 
+    def self.key(config)
+      # By default we use all params and metrics
+      sb = []
+      sb.push(self.handle)
+      sb.push(config['params'].flatten) if config['params']
+      sb.push((config['metrics'] || default_metrics).flatten)
+      sb.flatten.join('_')
+    end
+    
     class << self
       attr_accessor :trackers
     
@@ -9,36 +22,7 @@ module Trackablaze
         Trackablaze::Tracker.subclasses.each do |t|
           @trackers[t.handle] = t
         end
-      end
-      
-      # This function takes config object, similar in structure to a loaded yml config file
-      def run_trackers(config)
-        results = []
-        trackers = {}
-        index = 0
-        config.each do |tracker_node|
-          tracker_name = tracker_node.keys.first
-          trackers[tracker_name] ||= []
-          tracker_config = tracker_node.values.first
-          tracker_config['index'] = index
-          trackers[tracker_name] << tracker_config
-          index += 1
-        end
-
-        trackers.each do |tracker_name, tracker_configs|
-          tracker = Trackablaze::Tracker.trackers[tracker_name].new
-
-          tracker_config_index = 0
-          tracker.get_metrics(tracker_configs).each do |tracker_result|
-            index = tracker_configs[tracker_config_index]['index']
-            results[index] = tracker_result
-            tracker_config_index += 1
-          end
-        end
-      
-        return results
-      end
-
+      end      
     end
     
     def self.handle
@@ -62,11 +46,8 @@ module Trackablaze
     end
     
     def add_error(metrics, error, field = nil)
-      puts "ADDING ERROR #{error} on #{field}"
       metrics['errors'] ||= []
       metrics['errors'].push({:error => error, :field => field})
-      
-      puts "ADDED ERROR #{metrics.inspect}"
     end
 
   end

data/lib/trackablaze/tracker_item.rb

@@ -0,0 +1,54 @@
+module Trackablaze
+  class TrackerItem
+    attr_accessor :name, :config, :params, :metrics, :tracker_class
+    def initialize(config)
+    	@name = config.keys[0]
+  		@tracker_class = Trackablaze::Tracker.trackers[self.name]
+    	@config = config[self.name]
+  		@params = self.config['params']
+  		@metrics = self.config['metrics'] || @tracker_class.default_metrics
+    end
+  
+    def key()
+      @key ||= tracker_class.key(config)
+    end
+    
+    def title
+      @tracker_class.title
+    end
+
+    # This function takes config object, similar in structure to a loaded yml config file
+    def self.run(tracker_items)
+      Trackablaze::Tracker.load_trackers
+      
+      results = {}
+    
+      # Dedup tracker items using unique key
+      unique_tracker_items = tracker_items.uniq {|ti| ti.key}
+    
+      # Gather up all unique tracker_items for a given tracker
+      tracker_items_by_tracker = {}
+      unique_tracker_items.each do |tracker_item|
+        tracker_name = tracker_item.name
+      
+        tracker_items_by_tracker[tracker_name] ||= []
+        tracker_items_by_tracker[tracker_name] << tracker_item
+      end
+
+      # Run one tracker at a time
+      tracker_items_by_tracker.each do |tracker_name, items|
+        tracker = items.first.tracker_class.new
+        tracker_results = tracker.get_metrics(items)
+      
+        # Store results by tracker item key
+        (0..items.length-1).each do |index|
+          item = items[index]
+          results[item.key] = tracker_results[index]
+        end
+      end
+
+      # All keys should have results now, return results
+      return results
+    end
+  end
+end

data/lib/trackablaze.rb

@@ -1,5 +1,6 @@
 require 'trackablaze/utils'
 require 'trackablaze/command'
+require 'trackablaze/tracker_item'
 require 'trackablaze/tracker'
 
 Dir[File.dirname(__FILE__) + '/../trackers/*.rb'].each do |path|

data/trackers/facebook_page.rb

@@ -2,21 +2,20 @@ require 'mini_fb'
 
 module Trackablaze
   class FacebookPage < Tracker
-    def get_metrics(configs)
-      configs.collect {|c| get_metrics_single(c)}
+    def get_metrics(tracker_items)
+      tracker_items.collect {|tracker_item| get_metrics_single(tracker_item)}
     end
     
-    def get_metrics_single(config)      
-      params, metrics_keys = config['params'], config['metrics']
+    def get_metrics_single(tracker_item)  
       metrics = {}
   
-      if (params["page_id"].nil?)
+      if (tracker_item.params["page_id"].nil?)
         add_error(metrics, "No Facebook page ID supplied", "page_id") 
         return metrics
       end
   
       begin
-        page_info = MiniFB.get(nil, params["page_id"])
+        page_info = MiniFB.get(nil, tracker_item.params["page_id"])
       rescue
         page_info = {}
       end
@@ -25,11 +24,9 @@ module Trackablaze
         add_error(metrics, "Invalid Facebook page ID supplied", "page_id")
         return metrics
       end
-      
-      metrics_keys ||= FacebookPage.default_metrics
   
-      metrics_keys.each do |metrics_key|
-        metrics[metrics_key] = page_info[metrics_key]
+      tracker_item.metrics.each do |metric|
+        metrics[metric] = page_info[metric]
       end
   
       metrics

data/trackers/twitter.rb

@@ -2,22 +2,21 @@ require 'twitter'
 
 module Trackablaze
   class Twitter < Tracker
-    def get_metrics(configs)
-      configs.collect {|c| get_metrics_single(c)}
+    def get_metrics(tracker_items)
+      tracker_items.collect {|tracker_item| get_metrics_single(tracker_item)}
     end
     
-    def get_metrics_single(config)      
-      params, metrics_keys = config['params'], config['metrics']
+    def get_metrics_single(tracker_item)  
       metrics = {}
   
-      if (params["handle"].nil? || params["handle"].empty?)
+      if (tracker_item.params["handle"].nil? || tracker_item.params["handle"].empty?)
         add_error(metrics, "No handle supplied", "handle") 
         return metrics
       end
       
       user = nil
       begin
-        user = ::Twitter.user(params["handle"])
+        user = ::Twitter.user(tracker_item.params["handle"])
       rescue      
       end
 
@@ -25,12 +24,9 @@ module Trackablaze
         add_error(metrics, "Invalid handle supplied", "handle")
         return metrics
       end
-      
-      metrics_keys ||= Twitter.default_metrics
   
-      metrics_keys.each do |metrics_key|
-        value = user[metrics_key]
-        metrics[metrics_key] = value
+      tracker_item.metrics.each do |metric|
+        metrics[metric] = user[metric]
       end
   
       metrics

data/version.rb

@@ -1,3 +1,3 @@
 module Trackablaze
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: trackablaze
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Amol Kelkar
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-12 00:00:00 -07:00
+date: 2011-06-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,6 +113,7 @@ extra_rdoc_files: []
 files: 
 - lib/trackablaze/command.rb
 - lib/trackablaze/tracker.rb
+- lib/trackablaze/tracker_item.rb
 - lib/trackablaze/utils.rb
 - lib/trackablaze.rb
 - trackers/facebook_page.rb