analytical 0.3.0

data/lib/analytical/google.rb

@@ -0,0 +1,34 @@
+module Analytical
+  module Google
+    class Api
+      include Analytical::Base::Api
+
+      def initialize(parent, options={})
+        super
+        @tracking_command_location = :body_prepend
+      end
+
+      def init_javascript(location)
+        return '' unless location==:body_prepend
+        js = <<-HTML
+        <!-- Analytical Init: Google -->
+        <script type="text/javascript">
+          var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+          document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+        </script>
+        <script type="text/javascript">
+          var googleAnalyticsTracker = _gat._getTracker("#{options[:key]}");
+          googleAnalyticsTracker._initData();
+          googleAnalyticsTracker._trackPageview();
+        </script>
+        HTML
+        js
+      end
+
+      def track(*args)
+        "googleAnalyticsTracker._trackPageview(\"#{args.first}\");"
+      end
+
+    end
+  end
+end

data/lib/analytical/kiss_metrics.rb

@@ -0,0 +1,35 @@
+module Analytical
+  module KissMetrics
+    class Api
+      include Analytical::Base::Api
+
+      def initialize(parent, options={})
+        super
+        @tracking_command_location = :body_prepend
+      end
+
+      def init_javascript(location)
+        return '' unless location==:body_prepend
+        js = <<-HTML
+        <!-- Analytical Init: KissMetrics -->
+        <script type="text/javascript">
+          var _kmq = _kmq || [];
+          (function(){function _kms(u,d){if(navigator.appName.indexOf("Microsoft")==0 && d)document.write("<scr"+"ipt defer='defer' async='true' src='"+u+"'></scr"+"ipt>");else{var s=document.createElement('script');s.type='text/javascript';s.async=true;s.src=u;(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);}}_kms('https://i.kissmetrics.com/i.js');_kms('http'+('https:'==document.location.protocol ? 's://s3.amazonaws.com/' : '://')+'scripts.kissmetrics.com/#{options[:key]}.1.js',1);})();
+        </script>
+        HTML
+        js
+      end
+
+      def identify(id, *args)
+        data = args.first
+        "_kmq.push([\"identify\", \"#{data[:email]}\"]);"
+      end
+
+      def event(name, *args)
+        data = args.first
+        "_kmq.push([\"record\", \"#{name}\", #{data.to_json}]);"
+      end
+
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'analytical'

data/spec/analytical/api_spec.rb

@@ -0,0 +1,122 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Analytical::Api" do
+
+  describe 'on initialization' do
+    it 'should construct an api class for each module' do
+      Analytical::Console::Api.should_receive(:new).and_return(@console = mock('console'))
+      Analytical::Google::Api.should_receive(:new).and_return(@google = mock('google'))
+      a = Analytical::Api.new :modules=>[:console, :google]
+      a.modules.should == {
+        :console=>@console, 
+        :google=>@google, 
+      }
+    end
+  end
+
+  describe 'with modules' do
+    before(:each) do
+      Analytical::Console::Api.stub!(:new).and_return(@console = mock('console'))
+      Analytical::Google::Api.stub!(:new).and_return(@google = mock('google'))
+      Analytical::Clicky::Api.stub!(:new).and_return(@clicky = mock('clicky'))      
+      
+      @api = Analytical::Api.new :modules=>[:console, :google]
+    end
+
+    describe '#track' do
+      it 'should store the #track command for each module api class' do
+        @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
+              
+        @console.should_receive(:queue).with(:track, 'something', {:a=>1, :b=>2})
+        @clicky.should_receive(:queue).with(:track, 'something', {:a=>1, :b=>2})
+        @google.should_receive(:queue).with(:track, 'something', {:a=>1, :b=>2})
+        
+        @api.track('something', {:a=>1, :b=>2})
+      end
+    end
+    
+    describe '#identify' do
+      it 'should store the #track command for each module api class' do
+        @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
+              
+        @console.should_receive(:queue).with(:identify, 'something', {:a=>1, :b=>2})
+        @clicky.should_receive(:queue).with(:identify, 'something', {:a=>1, :b=>2})
+        @google.should_receive(:queue).with(:identify, 'something', {:a=>1, :b=>2})
+        
+        @api.identify('something', {:a=>1, :b=>2})
+      end
+    end
+    
+    describe '#now' do
+      it 'should call a command on each module and collect the results' do
+        @api = Analytical::Api.new :modules=>[:console, :google, :clicky]        
+
+        @console.should_receive(:track).with('something', {:a=>1, :b=>2}).and_return('console track')
+        @clicky.should_receive(:track).with('something', {:a=>1, :b=>2}).and_return('clicky track')
+        @google.should_receive(:track).with('something', {:a=>1, :b=>2}).and_return('google track')
+        
+        @api.now.track('something', {:a=>1, :b=>2}).should == "console track\ngoogle track\nclicky track"
+      end
+    end
+    
+    describe 'when accessing a module by name' do
+      it 'should return the module api object' do
+        @api = Analytical::Api.new :modules=>[:console, :google, :clicky]
+        @api.console.should == @console
+        @api.clicky.should == @clicky
+        @api.google.should == @google
+      end
+    end
+        
+    describe 'gathering javascript' do
+      before(:each) do
+        @console.stub!(:tracking_command_location).and_return(:body_prepend)
+        @console.stub!(:process_queued_commands).and_return([])
+        @google.stub!(:tracking_command_location).and_return(:body_prepend)
+        @google.stub!(:process_queued_commands).and_return([])
+      end
+      describe '#head_javascript' do
+        it 'should return the javascript' do
+          @console.should_receive(:init_javascript).with(:head).and_return('console_a')
+          @google.should_receive(:init_javascript).with(:head).and_return('google_a')
+          @api.head_javascript.should == "console_a\ngoogle_a"
+        end
+      end
+      describe '#body_prepend_javascript' do
+        it 'should return the javascript' do
+          @console.should_receive(:init_javascript).with(:body_prepend).and_return('console_b')
+          @google.should_receive(:init_javascript).with(:body_prepend).and_return('google_b')
+          @api.body_prepend_javascript.should == "console_b\ngoogle_b"
+        end
+      end
+      describe '#body_append_javascript' do
+        it 'should return the javascript' do
+          @console.should_receive(:init_javascript).with(:body_append).and_return('console_c')                
+          @google.should_receive(:init_javascript).with(:body_append).and_return('google_c')                
+          @api.body_append_javascript.should == "console_c\ngoogle_c"
+        end
+      end
+      describe 'with stored commands' do
+        before(:each) do
+          @console.stub!(:track).and_return('console track called')
+          @console.stub!(:queue)
+          @console.stub!(:process_queued_commands).and_return(['console track called'])          
+          @google.stub!(:track).and_return('google track called')
+          @google.stub!(:queue)          
+          @google.stub!(:process_queued_commands).and_return(['google track called'])          
+          @api.track('something', {:a=>1, :b=>2})
+        end
+        describe '#body_prepend_javascript' do
+          it 'should return the javascript' do
+            @console.should_receive(:init_javascript).with(:body_prepend).and_return('console_b')
+            @google.should_receive(:init_javascript).with(:body_prepend).and_return('google_b')
+            @api.body_prepend_javascript.should == "console_b\ngoogle_b\n<script type='text/javascript'>\nconsole track called\ngoogle track called\n</script>"
+          end
+        end
+      end
+    end
+  end
+
+
+
+end

data/spec/analytical/clicky_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Analytical::Clicky::Api" do
+  before(:each) do
+    @parent = mock('api', :options=>{:google=>{:key=>'abc'}})
+  end
+  describe 'on initialize' do
+    it 'should set the command_location' do
+      a = Analytical::Clicky::Api.new @parent, {:key=>'abc'}
+      a.tracking_command_location.should == :body_append
+    end
+    it 'should set the options' do
+      a = Analytical::Clicky::Api.new @parent, {:key=>'abc'}
+      a.options.should == {:key=>'abc'}
+    end
+  end
+  describe '#track' do
+    it 'should return the tracking javascript' do
+      @api = Analytical::Clicky::Api.new @parent, {:key=>'abcdef'}
+      @api.track('pagename', {:some=>'data'}).should == "clicky.log(\"pagename\");"
+    end
+  end
+  describe '#identify' do
+    it 'should return the init code string' do
+      @api = Analytical::Clicky::Api.new @parent, {:key=>'abcdef'}
+      @api.identify('user id', {:a=>'b'}).should =~ /#{Regexp.escape({:id=>'user id', :a=>'b'}.to_json)}/
+    end
+  end
+  describe '#init_javascript' do
+    it 'should return the init javascript' do
+      @api = Analytical::Clicky::Api.new @parent, {:key=>'abcdef'}
+      @api.init_javascript[:head].should be_nil
+      @api.init_javascript[:body_prepend].should be_nil            
+      @api.init_javascript[:body_append].should =~ /static.getclicky.com\/js/
+      @api.init_javascript[:body_append].should =~ /abcdef/      
+    end
+    describe 'for an ssl connection' do
+      it 'should return the ssl init code' do
+        @api = Analytical::Clicky::Api.new @parent, {:key=>'abcdef', :ssl=>true}
+        @api.init_javascript[:body_append].should =~ /https/
+      end
+    end
+    describe 'with an identify command queued' do
+      @api = Analytical::Clicky::Api.new @parent, {:key=>'abcdef'}
+      @api.queue :identify, 'user id', {:email=>'someone@test.com'}
+      @api.init_javascript[:body_append].should =~ /"email":\w*"someone@test\.com"/
+    end
+  end
+end

data/spec/analytical/google_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Analytical::Google::Api" do
+  before(:each) do
+    @parent = mock('api', :options=>{:google=>{:key=>'abc'}})
+  end
+  describe 'on initialize' do
+    it 'should set the command_location' do
+      a = Analytical::Google::Api.new @parent, {:key=>'abc'}
+      a.tracking_command_location.should == :body_prepend
+    end
+    it 'should set the options' do
+      a = Analytical::Google::Api.new @parent, {:key=>'abc'}
+      a.options.should == {:key=>'abc'}
+    end
+  end
+  describe '#track' do
+    it 'should return the tracking javascript' do
+      @api = Analytical::Google::Api.new @parent, {:key=>'abcdef'}
+      @api.track('pagename', {:some=>'data'}).should == "googleAnalyticsTracker._trackPageview(\"pagename\");"
+    end
+  end
+  describe '#identify' do
+    it 'should return an empty string' do
+      @api = Analytical::Google::Api.new @parent, {:key=>'abcdef'}
+      @api.identify('nothing', {:matters=>'at all'}).should == ''
+    end
+  end
+  describe '#init_javascript' do
+    it 'should return the init javascript' do
+      @api = Analytical::Google::Api.new @parent, {:key=>'abcdef'}
+      @api.init_javascript[:head].should be_nil
+      @api.init_javascript[:body_prepend].should =~ /google-analytics.com\/ga.js/
+      @api.init_javascript[:body_prepend].should =~ /abcdef/      
+      @api.init_javascript[:body_append].should be_nil            
+    end
+  end
+end

data/spec/analytical/kiss_metrics_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Analytical::KissMetrics::Api" do
+  before(:each) do
+    @parent = mock('api', :options=>{:google=>{:key=>'abc'}})
+  end
+  describe 'on initialize' do
+    it 'should set the command_location' do
+      a = Analytical::KissMetrics::Api.new @parent, {:key=>'abc'}
+      a.tracking_command_location.should == :body_prepend
+    end
+    it 'should set the options' do
+      a = Analytical::KissMetrics::Api.new @parent, {:key=>'abc'}
+      a.options.should == {:key=>'abc'}
+    end
+  end
+  describe '#track' do
+    it 'should return the tracking javascript' do
+      @api = Analytical::KissMetrics::Api.new @parent, {:key=>'abcdef'}
+      @api.track('pagename', {:some=>'data'}).should == ''
+    end
+  end
+  describe '#identify' do
+    it 'should return an empty string' do
+      @api = Analytical::KissMetrics::Api.new @parent, {:key=>'abcdef'}
+      @api.identify('id', {:email=>'test@test.com'}).should == "_kmq.push([\"identify\", \"test@test.com\"]);"
+    end
+  end
+  describe '#event' do
+    it 'should return an empty string' do
+      @api = Analytical::KissMetrics::Api.new @parent, {:key=>'abcdef'}
+      @api.event('Big Deal', {:something=>'good'}).should == "_kmq.push([\"record\", \"Big Deal\", #{{:something=>'good'}.to_json}]);"
+    end
+  end
+  describe '#init_javascript' do
+    it 'should return the init javascript' do
+      @api = Analytical::KissMetrics::Api.new @parent, {:key=>'abcdef'}
+      @api.init_javascript[:head].should be_nil
+      @api.init_javascript[:body_prepend].should =~ /scripts.kissmetrics.com/
+      @api.init_javascript[:body_prepend].should =~ /abcdef/      
+      @api.init_javascript[:body_append].should be_nil            
+    end
+  end
+end

data/spec/analytical_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ostruct'
+
+describe "Analytical" do
+  before(:each) do
+    rails_env = mock('rails environment', :'production?'=>true, :'development?'=>false)
+    Rails.stub!(:env).and_return(rails_env)
+    File.stub!(:'exists?').and_return(false)
+  end
+
+  describe 'on initialization' do
+    class DummyForInit
+      extend Analytical
+      def request; OpenStruct.new(:'ssl?'=>true); end
+      def self.helper_method(*a); end
+    end
+
+    it 'should have the default options' do
+      DummyForInit.analytical
+      d = DummyForInit.new.analytical
+      d.options[:modules].should == []
+      d.options[:development_modules].should == [:console]
+      d.options[:disable_if].call.should be_false
+    end
+
+    it 'should open the initialization file' do
+      File.should_receive(:'exists?').with("#{RAILS_ROOT}/config/analytical.yml").and_return(true)
+      DummyForInit.analytical
+      DummyForInit.analytical_options[:google].should == {:key=>'google_12345'}
+      DummyForInit.analytical_options[:kiss_metrics].should == {:key=>'kiss_metrics_12345'}
+      DummyForInit.analytical_options[:clicky].should == {:key=>'clicky_12345'}            
+    end
+
+    describe 'in production mode' do
+      before(:each) do
+        Rails.env.stub!(:production?).and_return(true)
+      end
+      it 'should start with no modules' do
+        Analytical::Api.should_not_receive(:include)
+        DummyForInit.analytical
+        DummyForInit.new.analytical.options[:modules] = []
+      end
+      it 'should include specific modules' do
+        Analytical::Api.should_receive(:include).with(Analytical::Console)
+        Analytical::Api.should_receive(:include).with(Analytical::Google)
+        DummyForInit.analytical :modules=>[:google, :console]
+        DummyForInit.new.analytical.options[:modules] = [:google, :console]
+      end
+    end
+
+    describe 'in development mode' do
+      before(:each) do
+        Rails.env.stub!(:production?).and_return(false)
+      end
+      it 'should start with no modules' do
+        Analytical::Api.should_receive(:include).with(Analytical::Console)
+        DummyForInit.analytical
+        DummyForInit.new.analytical.options[:modules] = [:console]
+      end
+    end
+
+  end
+
+end

data/spec/config/analytical.yml

@@ -0,0 +1,6 @@
+google:
+  key: google_12345
+clicky:
+  key: clicky_12345
+kiss_metrics:
+  key: kiss_metrics_12345

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--color
+--loadby mtime
+--reverse
+--diff unified
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/json'
+require 'action_view'
+require 'spec'
+require 'spec/autorun'
+
+require 'analytical'
+require 'analytical/api'
+require 'analytical/base'
+require 'analytical/console'
+require 'analytical/google'
+require 'analytical/clicky'
+
+Spec::Runner.configure do |config|
+end
+
+module Rails
+end
+RAILS_ROOT = File.dirname(__FILE__)

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification 
+name: analytical
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Joshua Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Gem for managing multiple analytics services in your rails app.
+email: josh@transfs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- analytical.gemspec
+- example/.gitignore
+- example/Gemfile
+- example/README
+- example/Rakefile
+- example/app/controllers/application_controller.rb
+- example/app/controllers/page_controller.rb
+- example/app/helpers/application_helper.rb
+- example/app/helpers/page_helper.rb
+- example/app/views/layouts/application.html.erb
+- example/app/views/page/index.html.erb
+- example/app/views/page/test_a.html.erb
+- example/app/views/page/test_b.html.erb
+- example/config.ru
+- example/config/analytical.yml
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/mime_types.rb
+- example/config/initializers/secret_token.rb
+- example/config/initializers/session_store.rb
+- example/config/locales/en.yml
+- example/config/routes.rb
+- example/db/seeds.rb
+- example/doc/README_FOR_APP
+- example/lib/tasks/.gitkeep
+- example/public/404.html
+- example/public/422.html
+- example/public/500.html
+- example/public/favicon.ico
+- example/public/images/rails.png
+- example/public/javascripts/application.js
+- example/public/javascripts/controls.js
+- example/public/javascripts/dragdrop.js
+- example/public/javascripts/effects.js
+- example/public/javascripts/prototype.js
+- example/public/javascripts/rails.js
+- example/public/robots.txt
+- example/public/stylesheets/.gitkeep
+- example/script/rails
+- example/test/functional/page_controller_test.rb
+- example/test/performance/browsing_test.rb
+- example/test/test_helper.rb
+- example/test/unit/helpers/page_helper_test.rb
+- example/vendor/plugins/.gitkeep
+- lib/analytical.rb
+- lib/analytical/api.rb
+- lib/analytical/base.rb
+- lib/analytical/clicky.rb
+- lib/analytical/console.rb
+- lib/analytical/google.rb
+- lib/analytical/kiss_metrics.rb
+- rails/init.rb
+- spec/analytical/api_spec.rb
+- spec/analytical/clicky_spec.rb
+- spec/analytical/google_spec.rb
+- spec/analytical/kiss_metrics_spec.rb
+- spec/analytical_spec.rb
+- spec/config/analytical.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jkrall/analytical
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Gem for managing multiple analytics services in your rails app.
+test_files: 
+- spec/analytical/api_spec.rb
+- spec/analytical/clicky_spec.rb
+- spec/analytical/google_spec.rb
+- spec/analytical/kiss_metrics_spec.rb
+- spec/analytical_spec.rb
+- spec/spec_helper.rb