trackablaze 0.1.6 → 0.1.7

data/README.markdown

@@ -132,8 +132,8 @@ are made of up of a **YAML config file** and a **ruby code file**.
 
 
 A tracker must implement get_metrics() method. This method takes
-in an array of configurations. Your tracker may choose to query
-for each configuration one by one or use any available optimized
+in an array of tracker items (i.e. configurations). Your tracker may choose to query
+for each tracker item one by one or use any available optimized
 API calls. For example, the above code queries Twitter API once
 for each user handle, but can be optimized by using the 
 ::Twitter.users API call that takes an array of user handles.
@@ -152,5 +152,5 @@ please see the wiki.
 
 Trackablaze and its recipes are distributed under the MIT License.
 
-[1]:http://railswizard.org/
+[1]:http://trackablaze.com
 [2]:https://github.com/aflatune/trackablaze-gem/tree/master/trackers

data/lib/trackablaze.rb

@@ -1,5 +1,7 @@
 require 'trackablaze/utils'
 require 'trackablaze/command'
+require 'trackablaze/param'
+require 'trackablaze/metric'
 require 'trackablaze/tracker_item'
 require 'trackablaze/tracker'
 

data/lib/trackablaze/metric.rb

@@ -0,0 +1,16 @@
+module Trackablaze
+  class Metric
+    attr_accessor :name, :title, :config
+    
+    def initialize(name, config)
+      @name = name
+      @title = config['title']
+      @default = config['default']
+      @config = config
+    end
+    
+    def default?
+      @default == true
+    end
+  end
+end

data/lib/trackablaze/param.rb

@@ -0,0 +1,12 @@
+module Trackablaze
+  class Param
+    attr_accessor :name, :title, :description, :config
+    
+    def initialize(name, config)
+      @name = name
+      @title = config['title']
+      @description = config['description']
+      @config = config
+    end
+  end
+end

data/lib/trackablaze/tracker.rb

@@ -1,58 +1,68 @@
 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
-  
-    # A string that uniquely identifies this instance of the tracker, without the metrics list
-    # This is used in the csv output
-    def self.key2(config)
-      # By default we use all params and metrics
-      sb = []
-      sb.push(self.handle)
-      sb.push(config['params'].flatten) if config['params']
-      sb.flatten.join('_')
-    end
-    
+  class Tracker    
     class << self
-      attr_accessor :trackers
-    
+      attr_accessor :trackers, :info, :handle, :params, :metrics, :title, :default_metrics
+
+      def load
+        @info = YAML::load( File.open( File.dirname(__FILE__) + "/../../trackers/#{self.handle}.yml" ) )
+        @title = @info['title']
+        @params = {}
+
+        self.info['params'].each do |param_name, param_config| 
+          @params[param_name] = Param.new(param_name, param_config)
+        end
+
+        @metrics = {}
+        self.info['metrics'].each do |metric_name, metric_config| 
+          @metrics[metric_name] = Metric.new(metric_name, metric_config)
+        end
+
+        @default_metrics = self.info['metrics'].collect{|k, v| k if v && v['default']}.compact
+      end
+
+      def handle
+        @handle ||= self.name.split('::')[1].underscore
+      end
+        
       def load_trackers
         @trackers = {}
         Trackablaze::Tracker.subclasses.each do |t|
+          t.load
           @trackers[t.handle] = t
         end
-      end      
-    end
-    
-    def self.handle
-      @handle ||= self.name.split('::')[1].underscore
-    end
-    
-    def self.info
-      @info ||= YAML::load( File.open( File.dirname(__FILE__) + "/../../trackers/#{self.handle}.yml" ) )
-    end
-    
-    def self.title
-      self.info['title']
-    end
-    
-    def self.default_metrics
-      @default_metrics ||= self.info['metrics'].collect{|k, v| k if v && v['default']}.compact
-    end
-    
-    def get_metrics(params, metrics)
-      {}
+      end
+      
+      # 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 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
+
+      # A string that uniquely identifies this instance of the tracker, without the metrics list
+      # This is used in the csv output
+      def key2(config)
+        # By default we use all params and metrics
+        sb = []
+        sb.push(self.handle)
+        sb.push(config['params'].flatten) if config['params']
+        sb.flatten.join('_')
+      end
+
+
+      def param_title(param_name)
+        (params[param_name].title if params[param_name]) || param_name
+      end
+
+      def metric_title(metric_name)
+        (metrics[metric_name].title if metrics[metric_name]) || metric_name
+      end
     end
     
     def add_error(metrics, error, field = nil)
@@ -60,22 +70,5 @@ module Trackablaze
       metrics['errors'].push({:error => error, :field => field})
     end
 
-    def self.param_title(param_name)
-      param_info = info['params'][param_name]
-      if param_info
-        param_info['name']
-      else
-        param_name
-      end
-    end
-    
-    def self.metric_title(metric_name)
-      metric_info = info['metrics'][metric_name]
-      if metric_info
-        metric_info['name']
-      else
-        metric_name
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -7,5 +7,5 @@ Dir[File.dirname(__FILE__) + '/support/*'].each{|path| require path}
 require 'trackablaze'
 
 RSpec.configure do |config|
-
+  Trackablaze::Tracker.load_trackers
 end

data/spec/trackablaze/trackers/sanity_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+# This is a simple set of tests to make sure that
+# all trackers conform to basic requirements.
+
+Trackablaze::Tracker.trackers.each do |tracker_handle, tracker_class|
+  describe tracker_class do
+    describe 'basics' do
+      it("should have a handle"){ tracker_class.handle.should be_kind_of(String); tracker_class.handle.should_not be_empty } 
+    end
+    
+    describe 'tracker configuration yml' do 
+      it("should exist (#{tracker_class.handle}.yml)") { tracker_class.info.should_not be_nil; }
+      it("should be a hash"){ tracker_class.info.should be_kind_of(Hash); } 
+    end
+    
+    describe 'tracker configuration' do
+      it("should have params"){ tracker_class.params.should be_kind_of(Hash); } 
+      it("should have metrics"){ tracker_class.metrics.should be_kind_of(Hash); } 
+    end
+    
+    describe 'tracker params' do
+      tracker_class.params.each do |param_name, param|
+        describe "param #{param_name}" do
+          it("should have a name"){ param.name.should be_kind_of(String); param.name.should_not be_empty }
+          it("should have a title"){ param.title.should be_kind_of(String); param.title.should_not be_empty }
+          it("should have a description"){ param.description.should be_kind_of(String); param.description.should_not be_empty }
+        end
+      end
+    end
+
+    describe 'tracker metrics' do
+      tracker_class.metrics.each do |metric_name, metric|
+        describe "metric #{metric_name}" do
+          it("should have a name"){ metric.name.should be_kind_of(String); metric.name.should_not be_empty }
+        end
+      end
+    end
+
+    describe 'tracker interface' do
+      ['get_metrics'].each do |method_name|
+        it("should have method #{method_name}"){ tracker_class.new.should respond_to(method_name) }
+      end
+      
+      it("get_metrics should return empty array when given an empty array"){ tracker_class.new.get_metrics([]).should == [] }
+    end
+  end
+end

data/trackers/facebook_page.yml

@@ -2,11 +2,11 @@ title: 'Facebook page'
 
 params:
   page_id:
-    name: 'Page ID'
+    title: 'Page ID'
     description: 'This is the page ID (e.g. michaeljackson or 125602120804573)'
     type: string
   
 metrics:
   likes:
-    name: 'Likes'
+    title: 'Likes'
     default: true

data/trackers/klout.yml

@@ -2,42 +2,42 @@ title: 'Klout'
 
 params:
   username:
-    name: 'Username'
+    title: 'Username'
     description: 'Klout username'
     type: string
   
 metrics:
   kscore:
-    name: 'Score'
+    title: 'Score'
     description: 'Klout score'
     default: true
 
   slope:
-    name: 'Slope'
+    title: 'Slope'
     description: 'How fast Klout score is changing'
 
   kclass:
-    name: 'Class'
+    title: 'Class'
     description: 'Klout class assigned to the user'
     default: true
     
   network_score:
-    name: 'Network score'
+    title: 'Network score'
     description: 'Network Influence is the influence level of your engaged audience (see http://corp.klout.com/kscore)'
     
   amplification_score:
-    name: 'Amplification probability'
+    title: 'Amplification probability'
     description: 'Amplification Probability is the likelihood that your content will be acted upon (see http://corp.klout.com/kscore)'
     
   true_reach:
-    name: 'True reach'
+    title: 'True reach'
     description: 'True Reach is the size of your engaged audience (see http://corp.klout.com/kscore)'
     
   delta_1day:
-    name: '1 day delta'
+    title: '1 day delta'
     description: 'Change in Klout score in 1 day'
     default: true
         
   delta_5day:
-    name: '5 day delta'
+    title: '5 day delta'
     description: 'Change in Klout score in 5 days'

data/trackers/pagerank.yml

@@ -2,11 +2,11 @@ title: 'Google PageRank'
 
 params:
   domain:
-    name: 'Domain'
+    title: 'Domain'
     description: 'Domain name (e.g. google.com)'
     type: string
   
 metrics:
   pagerank:
-    name: 'PageRank'
+    title: 'PageRank'
     default: true

data/trackers/twitter.yml

@@ -2,15 +2,15 @@ title: 'Twitter'
 
 params:
   handle:
-    name: 'Handle'
+    title: 'Handle'
     description: 'Twitter handle, i.e. username'
     type: string
   
 metrics:
   followers_count:
-    name: 'Followers'
+    title: 'Followers'
     default: true
   friends_count:
-    name: 'Following'
+    title: 'Following'
   statuses_count:
-    name: 'Tweets'
+    title: 'Tweets'

data/version.rb

@@ -1,3 +1,3 @@
 module Trackablaze
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -2,7 +2,7 @@
 name: trackablaze
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Amol Kelkar
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-19 00:00:00 -07:00
+date: 2011-06-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -123,6 +123,8 @@ extra_rdoc_files: []
 
 files: 
 - lib/trackablaze/command.rb
+- lib/trackablaze/metric.rb
+- lib/trackablaze/param.rb
 - lib/trackablaze/tracker.rb
 - lib/trackablaze/tracker_item.rb
 - lib/trackablaze/utils.rb
@@ -138,6 +140,7 @@ files:
 - README.markdown
 - version.rb
 - spec/spec_helper.rb
+- spec/trackablaze/trackers/sanity_spec.rb
 - bin/trackablaze
 has_rdoc: true
 homepage: http://trackablaze.com
@@ -169,3 +172,4 @@ specification_version: 3
 summary: A tool to track web metrics.
 test_files: 
 - spec/spec_helper.rb
+- spec/trackablaze/trackers/sanity_spec.rb