google_analytics_tools 0.2

data/Rakefile

@@ -0,0 +1,53 @@
+require "rubygems"
+require "pathname"
+require "rake"
+require "rake/testtask"
+
+task :default => [ :test ]
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+# Gem
+require "rake/gempackagetask"
+require "lib/google_analytics_tools/version"
+
+NAME = "google_analytics_tools"
+SUMMARY = "A clean interface to generating the Google Analytics _gaq"
+GEM_VERSION = GoogleAnalyticsTools::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.summary = s.description = SUMMARY
+  s.author = "Scott Bauer"
+  s.homepage = "http://rdoc.info/projects/Bauerpauer/google_analytics_tools"
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  s.files = %w(Rakefile) + Dir.glob("lib/**/*")
+
+  s.add_dependency "json"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{NAME} as a gem"
+task :install => [:repackage] do
+  sh %{gem install pkg/#{NAME}-#{GEM_VERSION}}
+end
+
+task :version do
+  puts GEM_VERSION
+end
+
+spec_file = ".gemspec"
+desc "Create #{spec_file}"
+task :gemspec do
+  File.open(spec_file, "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/google_analytics_tools/tracking/async_tracking_queue.rb

@@ -0,0 +1,44 @@
+module GoogleAnalyticsTools
+
+  class AsyncTrackingQueue
+
+    def initialize
+      @events = []
+    end
+    
+    def <<(event)
+      push(event)
+    end
+
+    def push(event, tracker_id = nil)
+      @events << renderer_for_event(event, tracker_id)
+    end
+
+    def to_s
+<<-JAVASCRIPT
+<script type="text/javascript">
+var _gaq = _gaq || [];
+#{@events.map { |event| event.to_s }.join("\n")}
+(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';
+var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+})();
+</script>
+JAVASCRIPT
+    end
+    
+    private
+    
+    def renderer_for_event(event, tracker_id)
+      case event
+      when Event then EventRenderer.new(event, tracker_id)
+      when EventCollection then EventCollectionRenderer.new(event, tracker_id)
+      end
+    end
+
+  end
+end
+
+GAT = GoogleAnalyticsTools
+GAQ = GAT::AsyncTrackingQueue

data/lib/google_analytics_tools/tracking/events/event.rb

@@ -0,0 +1,14 @@
+class GAQ
+  
+  class Event
+    
+    attr_reader :name, :params
+    
+    def initialize(name, *params)
+      @name = name
+      @params = params
+    end
+
+  end
+  
+end

data/lib/google_analytics_tools/tracking/events/event_collection.rb

@@ -0,0 +1,29 @@
+class GAQ
+  
+  class EventCollection
+    
+    include Enumerable
+    
+    class InvalidEventError < StandardError
+      def initialize(non_event)
+        super("GAQ::EventCollection#<< expects instances of GAQ::Event, you passed #{non_event}")
+      end
+    end
+    
+    def initialize
+      @events = []
+    end
+    
+    def <<(event)
+      raise InvalidEventError.new(event) unless event.is_a?(GAQ::Event)
+
+      @events << event
+    end
+
+    def each
+      @events.each { |e| yield e }
+    end
+    
+  end
+  
+end

data/lib/google_analytics_tools/tracking/events/event_collection_renderer.rb

@@ -0,0 +1,16 @@
+class GAQ
+  
+  class EventCollectionRenderer
+    
+    def initialize(event_collection, tracker_id)
+      @event_collection = event_collection
+      @tracker_id = tracker_id
+    end
+
+    def to_s
+      @event_collection.map { |event| EventRenderer.new(event, @tracker_id).to_s }.join("\n")
+    end
+
+  end
+
+end

data/lib/google_analytics_tools/tracking/events/event_renderer.rb

@@ -0,0 +1,16 @@
+class GAQ
+  
+  class EventRenderer
+    
+    def initialize(event, tracker_id)
+      @event = event
+      @tracker_id = tracker_id
+    end
+
+    def to_s
+      "_gaq.push(#{[@tracker_id ? "#{@tracker_id}.#{@event.name}" : @event.name, *@event.params].to_json});"
+    end
+
+  end
+
+end

data/lib/google_analytics_tools/tracking/events/events.rb

@@ -0,0 +1,89 @@
+module GAQ::Events
+
+  class SetAccount < ::GAQ::Event
+
+    def initialize(account_id)
+      super('_setAccount', account_id)
+    end
+
+  end
+
+  class SetDomainName < ::GAQ::Event
+
+    def initialize(domain_name)
+      super('_setDomainName', domain_name)
+    end
+
+  end
+
+  class TrackPageview < ::GAQ::Event
+
+    def initialize
+      super('_trackPageview')
+    end
+
+  end
+  
+  class TrackEvent < ::GAQ::Event
+
+    def initialize(category, action, label = nil, value = nil)
+      if label || value
+        super('_trackEvent', category.to_s, action.to_s, label ? label.to_s : nil, value ? value.to_i : nil)
+      else
+        super('_trackEvent', category.to_s, action.to_s)
+      end
+    end
+
+  end
+  
+  module ECommerce
+    
+    class AddTransaction < ::GAQ::Event
+      
+      # _gaq.push(['_addTrans',
+      #   '1234',           // order ID - required
+      #   'Acme Clothing',  // affiliation or store name
+      #   '11.99',          // total - required
+      #   '1.29',           // tax
+      #   '5',              // shipping
+      #   'San Jose',       // city
+      #   'California',     // state or province
+      #   'USA'             // country
+      # ]);
+      
+      def initialize(order_id, store_name, total, tax, shipping, city, state_or_province, country)
+        super('_addTrans', order_id.to_s, store_name.to_s, total.to_s, tax.to_s, shipping.to_s, city.to_s, state_or_province.to_s, country.to_s)
+      end
+
+    end
+    
+    class AddItem < ::GAQ::Event
+      
+      # _gaq.push(['_addItem',
+      #   '1234',           // order ID - required
+      #   'DD44',           // SKU/code - required
+      #   'T-Shirt',        // product name
+      #   'Green Medium',   // category or variation
+      #   '11.99',          // unit price - required
+      #   '1'               // quantity - required
+      # ]);
+      
+      def initialize(order_id, product_id, product_name, product_variation, unit_price, quantity)
+        super('_addItem', order_id.to_s, product_id.to_s, product_name.to_s, product_variation.to_s, unit_price.to_s, quantity.to_s)
+      end
+      
+    end
+    
+    class TrackTransaction < ::GAQ::Event
+
+      # _gaq.push(['_trackTrans']); //submits transaction to the Analytics servers
+      
+      def initialize
+        super('_trackTrans')
+      end
+
+    end
+    
+  end
+
+end

data/lib/google_analytics_tools/version.rb

@@ -0,0 +1,3 @@
+module GoogleAnalyticsTools
+  VERSION = "0.2"
+end

data/lib/google_analytics_tools.rb

@@ -0,0 +1,11 @@
+require "json"
+require "pathname"
+
+$:.unshift(Pathname(__FILE__).dirname.expand_path)
+
+require "google_analytics_tools/tracking/async_tracking_queue"
+require "google_analytics_tools/tracking/events/event"
+require "google_analytics_tools/tracking/events/event_collection"
+require "google_analytics_tools/tracking/events/event_renderer"
+require "google_analytics_tools/tracking/events/event_collection_renderer"
+require "google_analytics_tools/tracking/events/events"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: google_analytics_tools
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Scott Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A clean interface to generating the Google Analytics _gaq
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/google_analytics_tools/tracking/async_tracking_queue.rb
+- lib/google_analytics_tools/tracking/events/event.rb
+- lib/google_analytics_tools/tracking/events/event_collection.rb
+- lib/google_analytics_tools/tracking/events/event_collection_renderer.rb
+- lib/google_analytics_tools/tracking/events/event_renderer.rb
+- lib/google_analytics_tools/tracking/events/events.rb
+- lib/google_analytics_tools/version.rb
+- lib/google_analytics_tools.rb
+has_rdoc: true
+homepage: http://rdoc.info/projects/Bauerpauer/google_analytics_tools
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A clean interface to generating the Google Analytics _gaq
+test_files: []
+