sfanalytics 0.2.1 → 0.2.13

data/README.rdoc

@@ -2,6 +2,47 @@
 
 SFanalytics provides Google Analytics for your app. Probably only really useful for Ecommerce users of analytics, to provide the functionality to add the order items to your transactions for tracking in Analytics. 
 
+== Usage
+SFanalytics provides a set of helpers that provide the standard and ecommerce functionality of Google Analytics. 
+
+A simple example of its usage is:
+  <%- 
+  analytics_add_transaction( {
+      :id           => 'A01',
+      :store_name   => 'TEST STORE',
+      :total        => '3.54',
+      :vat          => '0.34',
+      :postage      => '2.20',
+      :city         => 'Test City',
+      :county       => 'Test County',
+      :country      => 'Test Kingdom'
+    }, 'UA-1234567-1'
+  )
+
+  analytics_add_item( {
+      :sku        => 'TEST123',
+      :name       => 'Test Item',
+      :category   => 'Test Categoru',
+      :price      => '1.99',
+      :quantity   => '2'
+    }, 'UA-1234567-1'
+  )
+
+  analytics_add_item( {
+      :sku        => 'TEST124',
+      :name       => 'Test Item3',
+      :category   => 'Test Categoru',
+      :price      => '1.99',
+      :quantity   => '3'
+    }, 'UA-1234567-2'
+  )
+
+  %>
+
+  <%= analytics_generate('UA-1234566-1') %>
+  
+This adds a transaction, then some line items to the transaction, then outputs the analytics code when analytics_generate is called. Technically the analytics ID is only required on the first helper call, but it does no harm to include it on each call.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.13

data/init.rb

@@ -1,3 +1 @@
-[SFanalytics].each do |sfanalytics|
-  ActionView::Base.send :include, sfanalytics
-end
+require 'sfanalytics'

data/lib/sfanalytics/view_helpers.rb

@@ -0,0 +1,19 @@
+module SFanalytics
+  module ViewHelpers
+    attr_reader :analytics
+    def analytics_generate(analytics_id = '')
+      @analytics = SFanalytics::SFa::new(analytics_id) unless @analytics
+      return @analytics.generate
+    end
+    
+    def analytics_add_transaction(transaction, analytics_id = '')
+      @analytics = SFanalytics::SFa::new(analytics_id) unless @analytics
+      return @analytics.add_transaction(transaction)
+    end
+    
+    def analytics_add_item(item, analytics_id = '')
+      @analytics = SFanalytics::SFa::new(analytics_id) unless @analytics
+      return @analytics.add_line_item(item)
+    end
+  end
+end

data/lib/sfanalytics.rb

@@ -1,58 +1,64 @@
 require 'haml'
 
-class SFanalytics
-  attr_reader :analytics_id, :transaction, :line_items, :transaction_id
+module SFanalytics
+  class SFa
+    attr_reader :analytics_id, :transaction, :line_items, :transaction_id
   
-  def initialize(analytics_id)
-    raise ArgumentError.new if ! analytics_id.match(/UA-\d{0,8}-\d{0,3}/)
-    @analytics_id = analytics_id
-    @line_items = ''
-  end
+    if defined? Rails
+      require 'sfanalytics/view_helpers'
+      ActionView::Base.send :include, ViewHelpers
+    end
+
+    def initialize(analytics_id)
+      raise ArgumentError.new if ! analytics_id.match(/UA-\d{0,8}-\d{0,3}/)
+      @analytics_id = analytics_id
+      @line_items = ''
+    end
+
+    def generate
+      template = File.read(File.dirname(__FILE__) + '/../templates/analytics.html.haml')
   
-  def generate
-    
-    template = File.read(File.dirname(__FILE__) + '/../templates/analytics.html.haml')
-    
-    obj = Object.new
-    Haml::Engine.new(template).def_method(obj, :render, :analytics_id, :analytics_transaction, :line_items)
-    return obj.render(
-      :analytics_id => @analytics_id,
-      :analytics_transaction => @transaction,
-      :line_items => @line_items
-    )
-    
-    obj = Object.new
-    Haml::Engine.new(template).def_method(obj, :render, :analytics_id)
-    return obj.render(:analytics_id => "Hello!")
-  end
+      obj = Object.new
+      Haml::Engine.new(template).def_method(obj, :render, :analytics_id, :analytics_transaction, :line_items)
+      return obj.render(
+        :analytics_id => @analytics_id,
+        :analytics_transaction => @transaction,
+        :line_items => @line_items
+      )
+  
+      obj = Object.new
+      Haml::Engine.new(template).def_method(obj, :render, :analytics_id)
+      return obj.render(:analytics_id => "Hello!")
+    end
 
-  def add_transaction(transaction)
-    
-    template = File.read(File.dirname(__FILE__) + '/../templates/transaction.html.haml')
-     
-    obj = Object.new
-    Haml::Engine.new(template).def_method(obj, :render, :analytics_id, :transaction)
-    @transaction = obj.render(
-      :analytics_id => @analytics_id,
-      :transaction => transaction
-    )
-
-    @transaction_id = transaction[:id]
-    return true
-  end
+    def add_transaction(transaction)
+  
+      template = File.read(File.dirname(__FILE__) + '/../templates/transaction.html.haml')
+   
+      obj = Object.new
+      Haml::Engine.new(template).def_method(obj, :render, :analytics_id, :transaction)
+      @transaction = obj.render(
+        :analytics_id => @analytics_id,
+        :transaction => transaction
+      )
+
+      @transaction_id = transaction[:id]
+      return true
+    end
+
+    def add_line_item(item)
+      raise "No Transaction Defined" unless(@transaction)
+
+      template = File.read(File.dirname(__FILE__) + '/../templates/line_item.html.haml')
+
+      obj = Object.new
+      Haml::Engine.new(template).def_method(obj, :render, :transaction, :item)
+      @line_items << obj.render(
+        :transaction => @transaction_id,
+        :item => item
+      )
   
-  def add_line_item(item)
-    raise "No Transaction Defined" unless(@transaction)
-
-    template = File.read(File.dirname(__FILE__) + '/../templates/line_item.html.haml')
-
-    obj = Object.new
-    Haml::Engine.new(template).def_method(obj, :render, :transaction, :item)
-    @line_items << obj.render(
-      :transaction => @transaction_id,
-      :item => item
-    )
-    
-    return true
+      return true
+    end
   end
-end
+end

data/sfanalytics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sfanalytics}
-  s.version = "0.2.1"
+  s.version = "0.2.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Graeme Lawton"]
-  s.date = %q{2010-04-29}
+  s.date = %q{2010-05-04}
   s.description = %q{
         SFanalytics provides Google Analytics for your app. Probably only really
         useful for Ecommerce users of analytics, to provide the functionality to add
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "init.rb",
      "lib/sfanalytics.rb",
+     "lib/sfanalytics/view_helpers.rb",
      "sfanalytics.gemspec",
      "templates/analytics.html.haml",
      "templates/line_item.html.haml",

data/test/sfanalytics_spec.rb

@@ -1,28 +1,29 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe SFanalytics, "initialize" do
+describe SFanalytics do
+  describe SFanalytics::SFa, "initialize" do
   
-  it "should be instantiated with a valid looking analytics id" do
-    lambda { SFanalytics.new( "UA-1234567-1" ) }.should_not raise_error
-    lambda { SFanalytics.new() }.should raise_error(ArgumentError)
-    lambda { SFanalytics.new( "foobar" ) }.should raise_error(ArgumentError)
-  end
+    it "should be instantiated with a valid looking analytics id" do
+      lambda { SFanalytics::SFa.new( "UA-1234567-1" ) }.should_not raise_error
+      lambda { SFanalytics::SFa.new() }.should raise_error(ArgumentError)
+      lambda { SFanalytics::SFa.new( "foobar" ) }.should raise_error(ArgumentError)
+    end
   
-end 
+  end 
 
-describe SFanalytics, "generate" do
+  describe SFanalytics::SFa, "generate" do
 
-  before(:each) do
-    @sfanalytics = SFanalytics.new('UA-1234567-1')
-  end
+    before(:each) do
+      @sfanalytics = SFanalytics::SFa.new('UA-1234567-1')
+    end
 
-  it "should be able to generate output code" do
-    @sfanalytics.should respond_to(:generate)
-    @sfanalytics.generate.class.should == String
-  end
+    it "should be able to generate output code" do
+      @sfanalytics.should respond_to(:generate)
+      @sfanalytics.generate.class.should == String
+    end
   
-  it "should generate the correct basic tracking code" do
-    @sfanalytics.generate.should == <<-EOS
+    it "should generate the correct basic tracking code" do
+      @sfanalytics.generate.should == <<-EOS
 <script type='text/javascript'>
   var _gaq = _gaq || [];
   _gaq.push(['_setAccount', 'UA-1234567-1']);
@@ -35,35 +36,35 @@ describe SFanalytics, "generate" do
   (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
   })();
 </script>
-    EOS
-  end
+      EOS
+    end
   
-end
-
-describe SFanalytics, "generate_transaction" do
-  before(:each) do
-    @sfanalytics = SFanalytics.new('UA-1234567-1')
-    @trx_data = {
-      :id           => 'A01',
-      :store_name   => 'TEST STORE',
-      :total        => '3.54',
-      :vat          => '0.34',
-      :postage      => '2.20',
-      :city         => 'Test City',
-      :county       => 'Test County',
-      :country      => 'Test Kingdom'
-    }
   end
+
+  describe SFanalytics::SFa, "generate_transaction" do
+    before(:each) do
+      @sfanalytics = SFanalytics::SFa.new('UA-1234567-1')
+      @trx_data = {
+        :id           => 'A01',
+        :store_name   => 'TEST STORE',
+        :total        => '3.54',
+        :vat          => '0.34',
+        :postage      => '2.20',
+        :city         => 'Test City',
+        :county       => 'Test County',
+        :country      => 'Test Kingdom'
+      }
+    end
   
-  it "should allow a transaction to be added" do
-    @sfanalytics.should respond_to(:add_transaction)
-    lambda {@sfanalytics.add_transaction}.should raise_error(ArgumentError)
-    @sfanalytics.add_transaction(@trx_data).should == true
-  end
+    it "should allow a transaction to be added" do
+      @sfanalytics.should respond_to(:add_transaction)
+      lambda {@sfanalytics.add_transaction}.should raise_error(ArgumentError)
+      @sfanalytics.add_transaction(@trx_data).should == true
+    end
   
-  it "should generate the correct code with a transaction" do
-    @sfanalytics.add_transaction(@trx_data).should
-    @sfanalytics.generate().should == <<-EOS
+    it "should generate the correct code with a transaction" do
+      @sfanalytics.add_transaction(@trx_data).should
+      @sfanalytics.generate().should == <<-EOS
 <script type='text/javascript'>
   var _gaq = _gaq || [];
   _gaq.push(['_setAccount', 'UA-1234567-1']);
@@ -85,65 +86,66 @@ describe SFanalytics, "generate_transaction" do
   (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
   })();
 </script>
-    EOS
+      EOS
+    end
   end
-end
 
-describe SFanalytics, "Add order items" do
+  describe SFanalytics::SFa, "Add order items" do
   
-  before(:each) do
-    @sfanalytics = SFanalytics.new('UA-1234567-1')
-    @sfanalytics.add_transaction({
-      :id           => 'A01',
-      :store_name   => 'TEST STORE',
-      :total        => '3.54',
-      :vat          => '0.34',
-      :postage      => '2.20',
-      :city         => 'Test City',
-      :county       => 'Test County',
-      :country      => 'Test Kingdom'
-    })
-    @line_item = {
-      :sku        => 'TEST123',
-      :name       => 'Test Item',
-      :category   => 'Test Categoru',
-      :price      => '1.99',
-      :quantity   => '2'
-    }
-  end
+    before(:each) do
+      @sfanalytics = SFanalytics::SFa.new('UA-1234567-1')
+      @sfanalytics.add_transaction({
+        :id           => 'A01',
+        :store_name   => 'TEST STORE',
+        :total        => '3.54',
+        :vat          => '0.34',
+        :postage      => '2.20',
+        :city         => 'Test City',
+        :county       => 'Test County',
+        :country      => 'Test Kingdom'
+      })
+      @line_item = {
+        :sku        => 'TEST123',
+        :name       => 'Test Item',
+        :category   => 'Test Categoru',
+        :price      => '1.99',
+        :quantity   => '2'
+      }
+    end
   
-  it "should allow a line_item to be added" do
-    @sfanalytics.should respond_to(:add_line_item)
-    lambda {@sfanalytics.add_line_item}.should raise_error(ArgumentError)
-    @sfanalytics.add_line_item(@line_item).should == true
-    @sfanalytics.generate.should match /_addItem/
-  end
+    it "should allow a line_item to be added" do
+      @sfanalytics.should respond_to(:add_line_item)
+      lambda {@sfanalytics.add_line_item}.should raise_error(ArgumentError)
+      @sfanalytics.add_line_item(@line_item).should == true
+      @sfanalytics.generate.should match /_addItem/
+    end
   
-  it "should allow multiple line_items to be added" do
-    @sfanalytics.add_line_item(@line_item)
-    @sfanalytics.add_line_item(@line_item)
-    #Check there are two instances of _addItem
-    @sfanalytics.generate.split(/_addItem/).count.should == 3
+    it "should allow multiple line_items to be added" do
+      @sfanalytics.add_line_item(@line_item)
+      @sfanalytics.add_line_item(@line_item)
+      #Check there are two instances of _addItem
+      @sfanalytics.generate.split(/_addItem/).count.should == 3
     
-    @sfanalytics.generate.split(/TEST123/).count.should == 3
-    @sfanalytics.generate.split(/A01/).count.should == 4    
-  end
+      @sfanalytics.generate.split(/TEST123/).count.should == 3
+      @sfanalytics.generate.split(/A01/).count.should == 4    
+    end
   
-end
-
-describe SFanalytics, "Error Handling" do
-  before (:each) do
-    @line_item = {
-      :sku        => 'TEST123',
-      :name       => 'Test Item',
-      :category   => 'Test Categoru',
-      :price      => '1.99',
-      :quantity   => '2'
-    }
   end
 
-  it "should fail if you try to add items with no transaction" do
-    sfanalytics = SFanalytics.new('UA-1234567-1')
-    lambda{sfanalytics.add_line_item(@line_item)}.should raise_error
+  describe SFanalytics::SFa, "Error Handling" do
+    before (:each) do
+      @line_item = {
+        :sku        => 'TEST123',
+        :name       => 'Test Item',
+        :category   => 'Test Categoru',
+        :price      => '1.99',
+        :quantity   => '2'
+      }
+    end
+
+    it "should fail if you try to add items with no transaction" do
+      sfanalytics = SFanalytics::SFa.new('UA-1234567-1')
+      lambda{sfanalytics.add_line_item(@line_item)}.should raise_error
+    end
   end
-end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 13
+  version: 0.2.13
 platform: ruby
 authors: 
 - Graeme Lawton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 +01:00
+date: 2010-05-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ files:
 - VERSION
 - init.rb
 - lib/sfanalytics.rb
+- lib/sfanalytics/view_helpers.rb
 - sfanalytics.gemspec
 - templates/analytics.html.haml
 - templates/line_item.html.haml