sfanalytics 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Graeme Lawton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= sfanalytics
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Graeme Lawton. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sfanalytics"
+    gem.summary = %Q{Google Analytics Gem}
+    gem.description = %Q{
+        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.
+      }
+    gem.email = "graeme.lawton@setfiremedia.com"
+    gem.homepage = "http://github.com/graemel/sfanalytics"
+    gem.authors = ["Graeme Lawton"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sfanalytics #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sfanalytics.rb

@@ -0,0 +1,58 @@
+require 'haml'
+
+class SFanalytics
+  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
+  
+  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
+
+  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
+    )
+    
+    return true
+  end
+end

data/sfanalytics.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sfanalytics}
+  s.version = "0.1.0"
+
+  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.description = %q{
+        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.
+      }
+  s.email = %q{graeme.lawton@setfiremedia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sfanalytics.rb",
+     "sfanalytics.gemspec",
+     "templates/analytics.html.haml",
+     "templates/line_item.html.haml",
+     "templates/transaction.html.haml",
+     "test/sfanalytics_spec.rb",
+     "test/spec.opts",
+     "test/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/graemel/sfanalytics}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Google Analytics Gem}
+  s.test_files = [
+    "test/sfanalytics_spec.rb",
+     "test/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/templates/analytics.html.haml

@@ -0,0 +1,14 @@
+%script{:type => "text/javascript"}
+  var _gaq = _gaq || [];
+  
+  = "_gaq.push(['_setAccount', '#{analytics_id}']);"
+  _gaq.push(['_trackPageview']);
+
+  = "#{analytics_transaction}"
+  = "#{line_items}"
+  
+  (function() {
+  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+  (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
+  })();

data/templates/line_item.html.haml

@@ -0,0 +1,8 @@
+= "_gaq.push(['_addItem',"
+= "'#{transaction}',"          #order ID
+= "'#{item[:sku]}', "               #item sku
+= "'#{item[:name]}', "              #item name
+= "'#{item[:category]}', "          #category name
+= "'#{item[:price]}', "             #item price
+= "'#{item[:quantity]}', "          #quantity
+= "]);"

data/templates/transaction.html.haml

@@ -0,0 +1,10 @@
+= "_gaq.push(['_addTrans',"
+= "'#{transaction[:id]}',"             #Order ID
+= "'#{transaction[:store_name]}',"     #Store Name
+= "'#{transaction[:total]}',"          #Total Value
+= "'#{transaction[:vat]}',"            #VAT
+= "'#{transaction[:postage]}',"       #Postage
+= "'#{transaction[:city]}',"           #City
+= "'#{transaction[:county]}',"         #State
+= "'#{transaction[:country]}', "       #Country
+= "]);"

data/test/sfanalytics_spec.rb

@@ -0,0 +1,149 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe SFanalytics, "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
+  
+end 
+
+describe SFanalytics, "generate" do
+
+  before(:each) do
+    @sfanalytics = SFanalytics.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 generate the correct basic tracking code" do
+    @sfanalytics.generate.should == <<-EOS
+<script type='text/javascript'>
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', 'UA-1234567-1']);
+  _gaq.push(['_trackPageview']);
+  
+  
+  (function() {
+  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+  (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
+  })();
+</script>
+    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
+  
+  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
+<script type='text/javascript'>
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', 'UA-1234567-1']);
+  _gaq.push(['_trackPageview']);
+  _gaq.push(['_addTrans',
+  'A01',
+  'TEST STORE',
+  '3.54',
+  '0.34',
+  '2.20',
+  'Test City',
+  'Test County',
+  'Test Kingdom',
+  ]);
+  
+  (function() {
+  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+  (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
+  })();
+</script>
+    EOS
+  end
+end
+
+describe SFanalytics, "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
+  
+  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
+    
+    @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
+  end
+end

data/test/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

data/test/spec_helper.rb

@@ -0,0 +1,5 @@
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib sfanalytics]))
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: sfanalytics
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Graeme Lawton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: "\n        SFanalytics provides Google Analytics for your app. Probably only really\n        useful for Ecommerce users of analytics, to provide the functionality to add\n        the order items to your transactions for tracking in Analytics.\n      "
+email: graeme.lawton@setfiremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sfanalytics.rb
+- sfanalytics.gemspec
+- templates/analytics.html.haml
+- templates/line_item.html.haml
+- templates/transaction.html.haml
+- test/sfanalytics_spec.rb
+- test/spec.opts
+- test/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/graemel/sfanalytics
+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: Google Analytics Gem
+test_files: 
+- test/sfanalytics_spec.rb
+- test/spec_helper.rb