RubyGems - analytical - Versions diffs - 0.3.0 → 0.5.0 - Mend

analytical 0.3.0 → 0.5.0

Files changed (13) hide show

data/README.rdoc +45 -0
data/VERSION +1 -1
data/analytical.gemspec +2 -2
data/example/app/views/layouts/application.html.erb +1 -1
data/lib/analytical.rb +10 -12
data/lib/analytical/clicky.rb +1 -1
data/lib/analytical/console.rb +21 -4
data/lib/analytical/kiss_metrics.rb +2 -2
data/spec/analytical/clicky_spec.rb +6 -6
data/spec/analytical/google_spec.rb +4 -4
data/spec/analytical/kiss_metrics_spec.rb +4 -4
data/spec/analytical_spec.rb +0 -7
metadata +3 -3

data/README.rdoc CHANGED

@@ -3,8 +3,53 @@
 Gem for managing multiple analytics services in your rails app.
 Initial service implementations include: Google Analytics, Clicky[http://getclicky.com], and KISSMetrics[http://kissmetrics.com].
+== Usage
+Add the following to your controllers:
+    analytical :modules=>[:console, :google, :clicky]
+Then, in your template files, you'll want to add the analytical helper methods for initializing the tracking javascript:
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>Example</title>
+        <%= stylesheet_link_tag :all %>
+        <%= javascript_include_tag :defaults %>
+        <%= csrf_meta_tag %>
+        <% analytical.identify '5', :email=>'josh@transfs.com' %>
+        <%= raw analytical.head_javascript %>
+      </head>
+      <body>
+        <%= raw analytical.body_prepend_javascript %>
+        <%= yield %>
+        <%= raw analytical.body_append_javascript %>
+      </body>
+    </html>
+Note the example above also includes an identify() command that will apply to every page.  More likely, you'll want to make this identify() command conditional so that it only applies when you have a logged-in user:
+    <% analytical.identify(current_user.id, :email=>current_user.email) if current_user %>
+You can sprinkle the track() and event() tracking methods throughout your views & controllers as needed.
+    analytical.track '/a/really/nice/url'
+    analytical.event 'Some Awesome Event', :with=>:data
+By default, Analytical will be disabled in development mode... and it will enable the Console module only.  To change this behavior, you can pass a Proc/lambda to the :disable_if option, as well as specify the :development_modules that you want to use:
+    analytical :modules=>[:google], :development_modules=>[], :disable_if=>lambda{ |controller| controller.i_can_haz_tracking? }
+== Adding new modules
+New modules should be fairly easy to add.  Follow the structure that I've used in the Clicky, Google, and KISSMetrics modules... and you should be fine.  All modules should include the Analytical::Base::Api module, so that they have some default behavior for methods that they don't support or need.
 == Note on Patches/Pull Requests
+I would be extremely happy to accept contributions to this project!  If you think something should work differently, send me a message and I'd love to discuss your ideas.  Even better:
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add specs for it. This is important so I don't break it in a future version unintentionally.

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.3.0
1	+ 0.5.0

data/analytical.gemspec CHANGED

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{analytical}
-  s.version = "0.3.0"
+  s.version = "0.5.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Krall"]
-  s.date = %q{2010-04-28}
+  s.date = %q{2010-04-29}
   s.description = %q{Gem for managing multiple analytics services in your rails app.}
   s.email = %q{josh@transfs.com}
   s.extra_rdoc_files = [

data/example/app/views/layouts/application.html.erb CHANGED

@@ -6,7 +6,7 @@
   <%= javascript_include_tag :defaults %>
   <%= csrf_meta_tag %>
-	<% raw analytical.identify '5', :email=>'josh@transfs.com' %>
+	<% analytical.identify '5', :email=>'josh@transfs.com' %>
 	<%= raw analytical.head_javascript %>
 </head>
 <body>

data/lib/analytical.rb CHANGED

@@ -24,24 +24,22 @@ module Analytical
       end
     end if File.exists?("#{RAILS_ROOT}/config/analytical.yml")
-    self.analytical_options = self.analytical_options.merge config_options
-    if self.analytical_options[:disable_if].call
-      self.analytical_options[:modules] = self.analytical_options[:development_modules]
-    end
-    self.analytical_options[:modules].each do |m|
-      Analytical::Api.send :include, "Analytical::#{m.to_s.camelize}".constantize
-    end
+    self.analytical_options = self.analytical_options.reverse_merge config_options
   end
   module InstanceMethods
     # any method placed here will apply to instances
     def analytical
-      options = self.class.analytical_options.merge({
-        :ssl => request.ssl?
-      })
-      @analytical ||= Analytical::Api.new options
+      @analytical ||= begin
+        options = self.class.analytical_options.merge({
+          :ssl => request.ssl?
+        })
+        if options[:disable_if].call(self)
+          options[:modules] = options[:development_modules]
+        end
+        Analytical::Api.new options
+      end
     end
   end

data/lib/analytical/clicky.rb CHANGED

@@ -37,7 +37,7 @@ module Analytical
       end
       def identify(id, *args)
-        data = { :id=>id }.merge(args.first)
+        data = { :id=>id }.merge(args.first || {})
         code = <<-HTML
         <script type='text/javascript'>
           var clicky_custom_session = #{data.to_json};

data/lib/analytical/console.rb CHANGED

@@ -2,7 +2,6 @@ module Analytical
   module Console
     class Api
       include Analytical::Base::Api
-      include ActionView::Helpers::JavaScriptHelper
       def initialize(parent, options={})
         super
@@ -21,15 +20,33 @@ module Analytical
       end
       def track(*args)
-        "console.log(\"Analytical Track: #{escape_javascript args.to_json}\");"
+        "console.log(\"Analytical Track: \"+\"#{escape args.first}\");"
       end
       def identify(id, *args)
-        "console.log(\"Analytical Identify: #{id} #{escape_javascript args.to_json}\");"
+        data = args.first || {}
+        "console.log(\"Analytical Identify: \"+\"#{id}\"+\" \"+$H(#{data.to_json}).toJSON());"
       end
       def event(name, *args)
-        "console.log(\"Analytical Event: #{name} #{escape_javascript args.to_json}\");"
+        data = args.first || {}
+        "console.log(\"Analytical Event: \"+\"#{name}\"+\" \"+$H(#{data.to_json}).toJSON());"
+      end
+      private
+      CONSOLE_JS_ESCAPE_MAP = {
+        '\\' => '\\\\',
+        '</' => '<\/',
+        "\r\n" => '\n',
+        "\n" => '\n',
+        "\r" => '\n',
+        '"' => '\\"',
+        "'" => "\\'"
+      }
+      def escape(js)
+        js.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { CONSOLE_JS_ESCAPE_MAP[$1] }
       end
     end

data/lib/analytical/kiss_metrics.rb CHANGED

@@ -21,12 +21,12 @@ module Analytical
       end
       def identify(id, *args)
-        data = args.first
+        data = args.first || {}
         "_kmq.push([\"identify\", \"#{data[:email]}\"]);"
       end
       def event(name, *args)
-        data = args.first
+        data = args.first || {}
         "_kmq.push([\"record\", \"#{name}\", #{data.to_json}]);"
       end

data/spec/analytical/clicky_spec.rb CHANGED

@@ -29,21 +29,21 @@ describe "Analytical::Clicky::Api" do
   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/
+      @api.init_javascript(:head).should == ''
+      @api.init_javascript(:body_prepend).should == ''
+      @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/
+        @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"/
+      @api.init_javascript(:body_append).should =~ /"email":\w*"someone@test\.com"/
     end
   end
 end

data/spec/analytical/google_spec.rb CHANGED

@@ -29,10 +29,10 @@ describe "Analytical::Google::Api" do
   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
+      @api.init_javascript(:head).should == ''
+      @api.init_javascript(:body_prepend).should =~ /google-analytics.com\/ga.js/
+      @api.init_javascript(:body_prepend).should =~ /abcdef/
+      @api.init_javascript(:body_append).should == ''
     end
   end
 end

data/spec/analytical/kiss_metrics_spec.rb CHANGED

@@ -35,10 +35,10 @@ describe "Analytical::KissMetrics::Api" do
   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
+      @api.init_javascript(:head).should == ''
+      @api.init_javascript(:body_prepend).should =~ /scripts.kissmetrics.com/
+      @api.init_javascript(:body_prepend).should =~ /abcdef/
+      @api.init_javascript(:body_append).should == ''
     end
   end
 end

data/spec/analytical_spec.rb CHANGED

@@ -40,12 +40,6 @@ describe "Analytical" do
         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
@@ -53,7 +47,6 @@ describe "Analytical" 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

metadata CHANGED

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments:
   - 0
-  - 3
+  - 5
   - 0
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joshua Krall
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-04-28 00:00:00 -05:00
+date: 2010-04-29 00:00:00 -05:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency