satellite 0.0.0 → 0.1.0

data/Gemfile

@@ -1,7 +1,4 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/satellite/adapters/google_analytics.rb

@@ -0,0 +1,281 @@
+module Satellite
+  module Adapters
+    class GoogleAnalytics
+
+      def initialize(params, use_ssl=false)
+        self.utm_params = extend_with_default_params(params)
+        self.utm_location = (use_ssl ? 'https://ssl' : 'http://www') + UTM_GIF_LOCATION
+      end
+
+      def track
+        #puts utm_params.inspect
+
+        utm_url = tracking_url
+
+        puts "--------sending request to GA-----------------------"
+        puts utm_url
+
+        open(utm_url, { "User-Agent" => 'Satellite/0.0.0', "Accept-Language" => 'de' })
+
+        # reset events / custom variables here
+        utm_params.delete(:utme)
+        true
+      end
+
+      def tracking_url
+        utm_location + "?" + utm_params.to_query
+      end
+
+      def track_event(category, action, label=nil, value=nil)
+        utm_params[:utme].set_event(category, action, label, value)
+        track
+      end
+
+      def track_page_view(path=nil)
+        utm_params.merge({ :utmp => path }) if path
+        track
+      end
+
+      def set_custom_variable(index, name, value, scope=nil)
+        utm_params[:utme].set_custom_variable(index, name, value, scope)
+      end
+
+      def unset_custom_variable(index)
+        utm_params[:utme].unset_custom_variable(index)
+      end
+
+      def []=(key, value)
+        value = Utme.parse(value) if key.to_s == 'utme'
+        utm_params[key] = value
+      end
+
+      def [](key)
+        utm_params[key]
+      end
+
+      class << self
+        attr_accessor :account_id
+      end
+
+      protected
+
+      attr_accessor :utm_params, :utm_location
+
+      private
+
+      # seems to be the current version
+      # search for 'utmwv' in http://www.google-analytics.com/ga.js
+      VERSION = "4.4sh" #"5.1.5"
+      UTM_GIF_LOCATION = ".google-analytics.com/__utm.gif"
+
+      # adds default params
+      def extend_with_default_params(params)
+        utme = params.delete(:utme)
+        {
+            :utmac => self.class.account_id,
+            :utmcc => '__utma%3D999.999.999.999.999.1%3B', # stub for non-existent cookie,
+            :utmcs => 'UTF-8',
+            :utme => Utme.parse(utme),
+            :utmhid => rand(0x7fffffff).to_s,
+            :utmn => rand(0x7fffffff).to_s,
+            :utmvid => rand(0x7fffffff).to_s,
+            :utmwv => VERSION,
+            # should get configured when initializing
+            #:utmhn => 'google-analytics.satellite.local',
+            #:utmr => 'https://rubygems.org/gems/satellite',
+            #:utmp => '/google-analytics',
+            #:utmip => '127.0.0.1',
+        }.merge(params)
+      end
+
+    end
+  end
+end
+
+module Satellite
+  module Adapters
+    class GoogleAnalytics::Utme
+
+      def initialize
+        @custom_variables = CustomVariables.new
+      end
+
+      def set_event(category, action, label=nil, value=nil)
+        @event = Event.new(category, action, label, value)
+        self
+      end
+
+      def set_custom_variable(slot, name, value, scope=nil)
+        @custom_variables.set_custom_variable(slot, CustomVariable.new(name, value, scope))
+        self
+      end
+
+      def unset_custom_variable(slot)
+        @custom_variables.unset_custom_variable(slot)
+        self
+      end
+
+      def to_s
+        @event.to_s + @custom_variables.to_s
+      end
+
+      alias_method :to_param, :to_s
+
+      class << self
+
+        @@regex_event = /5\((\w+)\*(\w+)(\*(\w+))?\)(\((\d+)\))?/
+        @@regex_custom_variables = /8\(([^\)]*)\)9\(([^\)]*)\)(11\(([^\)]*)\))?/
+        @@regex_custom_variable_value = /((\d)!)?(\w+)/
+
+        def parse(args)
+          return self.new if args.nil?
+          case args
+            when String
+              return self.from_string(args)
+            when self
+              return args
+            else
+              raise ArgumentError, "Could parse argument neither as String nor GATracker::Utme"
+          end
+        end
+
+        def from_string(str)
+          utme = self.new
+
+          # parse event
+          str.gsub!(@@regex_event) do |match|
+            utme.set_event($1, $2, $4, $6)
+            ''
+          end
+
+          # parse custom variables
+          str.gsub!(@@regex_custom_variables) do |match|
+            custom_vars = { }
+            match_names, match_values, match_scopes = $1, $2, $4
+
+            names = match_names.to_s.split('*')
+            values = match_values.to_s.split('*')
+            scopes = match_scopes.to_s.split('*')
+
+            raise ArgumentError, "Each custom variable must have a value defined." if names.length != values.length
+
+            names.each_with_index do |raw_name, i|
+              match_data = raw_name.match(@@regex_custom_variable_value)
+              slot, name = (match_data[2] || i+1).to_i, match_data[3]
+              custom_vars[slot] = { :name => name }
+            end
+
+            values.each_with_index do |raw_value, i|
+              match_data = raw_value.match(@@regex_custom_variable_value)
+              slot, value = (match_data[2] || i+1).to_i, match_data[3]
+              custom_vars[slot][:value] = value
+            end
+
+            scopes.each_with_index do |raw_scope, i|
+              match_data = raw_scope.match(@@regex_custom_variable_value)
+              slot, scope = (match_data[2] || i+1).to_i, match_data[3]
+              # silently ignore scope if there's no corresponding custom variable
+              custom_vars[slot][:scope] = scope if custom_vars[slot]
+            end
+
+            # finally set all the gathered custom vars
+            custom_vars.each do |key, custom_var|
+              utme.set_custom_variable(key, custom_var[:name], custom_var[:value], custom_var[:scope])
+            end
+            ''
+          end
+
+          utme
+        end
+      end
+
+      private
+
+      Event = Struct.new(:category, :action, :opt_label, :opt_value) do
+        def to_s
+          output = "5(#{category}*#{action}"
+          output += "*#{opt_label}" if opt_label
+          output += ")"
+          output += "(#{opt_value})" if opt_value
+          output
+        end
+      end
+
+      CustomVariable = Struct.new(:name, :value, :opt_scope)
+
+      class CustomVariables
+
+        @@valid_keys = 1..5
+
+        def initialize
+          @contents = { }
+        end
+
+        def set_custom_variable(slot, custom_variable)
+          raise ArgumentError, "Cannot set a slot other than #{@@valid_keys}. Given #{slot}" if not @@valid_keys.include?(slot)
+          @contents[slot] = custom_variable
+        end
+
+        def unset_custom_variable(slot)
+          raise ArgumentError, "Cannot unset a slot other than #{@@valid_keys}. Given #{slot}" if not @@valid_keys.include?(slot)
+          @contents.delete(slot)
+        end
+
+        # follows google custom variable format
+        #
+        # 8(NAMES)9(VALUES)11(SCOPES)
+        #
+        # best explained by examples
+        #
+        # 1)
+        # pageTracker._setCustomVar(1,"foo", "val", 1)
+        # ==> 8(foo)9(bar)11(1)
+        #
+        # 2)
+        # pageTracker._setCustomVar(1,"foo", "val", 1)
+        # pageTracker._setCustomVar(2,"bar", "vok", 3)
+        # ==> 8(foo*bar)9(val*vok)11(1*3)
+        #
+        # 3)
+        # pageTracker._setCustomVar(1,"foo", "val", 1)
+        # pageTracker._setCustomVar(2,"bar", "vok", 3)
+        # pageTracker._setCustomVar(4,"baz", "vol", 1)
+        # ==> 8(foo*bar*4!baz)9(val*vak*4!vol)11(1*3*4!1)
+        #
+        # 4)
+        # pageTracker._setCustomVar(4,"foo", "bar", 1)
+        # ==> 8(4!foo)9(4!bar)11(4!1)
+        #
+        def to_s
+          return '' if @contents.empty?
+
+          ordered_keys = @contents.keys.sort
+          names = values = scopes = ''
+
+          ordered_keys.each do |slot|
+            custom_variable = @contents[slot]
+            predecessor = @contents[slot-1]
+
+            has_predecessor = !!predecessor
+            has_scoped_predecessor = !!(predecessor.try(:opt_scope))
+
+            star = names.empty? ? '' : '*'
+            bang = (slot == 1 || has_predecessor) ? '' : "#{slot}!"
+
+            scope_star = scopes.empty? ? '' : '*'
+            scope_bang = (slot == 1 || has_scoped_predecessor) ? '' : "#{slot}!"
+
+            names += "#{star}#{bang}#{custom_variable.name}"
+            values += "#{star}#{bang}#{custom_variable.value}"
+            scopes += "#{scope_star}#{scope_bang}#{custom_variable.opt_scope}" if custom_variable.opt_scope
+          end
+
+          output = "8(#{names})9(#{values})"
+          output += "11(#{scopes})" if not scopes.empty?
+          output
+        end
+
+      end
+    end
+  end
+end

data/lib/satellite/controllers/google_analytics.rb

@@ -0,0 +1,38 @@
+module Satellite
+  module Controllers
+    class GoogleAnalyticsController
+
+      def tracker
+        @tracker ||= Satellite.get_tracker(:google_analytics, ga_params)
+      end
+
+      protected
+
+      def ga_visitor_id
+        "#{request.env["HTTP_USER_AGENT"]}#{rand(0x7fffffff).to_s}"
+      end
+
+      def ga_params
+        # domain specific stuff
+        domain_name = (request.env["SERVER_NAME"].nil? || request.env["SERVER_NAME"].blank?) ? "" : request.env["SERVER_NAME"]
+        referral = request.env['HTTP_REFERER'] || ''
+        path = request.env["REQUEST_URI"] || ''
+
+        # Capture the first three octects of the IP address and replace the forth
+        # with 0, e.g. 124.455.3.123 becomes 124.455.3.0
+        remote_address = request.env["REMOTE_ADDR"].to_s
+        ip = (remote_address.nil? || remote_address.blank?) ? '' : remote_address.gsub!(/([^.]+\.[^.]+\.[^.]+\.)[^.]+/, "\\1") + "0"
+
+        visitor_uuid = Digest::MD5.hexdigest(ga_visitor_id)
+
+        {
+            :utmhn => domain_name,
+            :utmr => referral,
+            :utmp => path,
+            :utmip => ip,
+            :utmvid => visitor_uuid
+        }
+      end
+    end
+  end
+end

data/lib/satellite.rb

@@ -1,76 +1,64 @@
 require 'open-uri'
 
-class Satellite
-
-  def initialize(params, use_ssl=false)
-    self.utm_params = extend_with_default_params(params)
-    self.utm_location = (use_ssl ? 'https://ssl' : 'http://www') + UTM_GIF_LOCATION
-  end
-
-  def track
+# stub some ActiveSupport functionality
+unless Object.const_defined?("ActiveSupport")
+  Dir.glob(File.dirname(__FILE__) + '/support/*') { |file| require file }
+end
 
-    utm_url = utm_location + "?" + utm_params.to_query
+# load tracking adapters
+Dir.glob(File.dirname(__FILE__) + '/satellite/adapters/*') { |file| require file }
 
-    puts "--------sending request to GA-----------------------"
-    puts utm_url
-    open(utm_url)
+module Satellite
 
-    # reset events / custom variables here
-    utm_params.delete(:utme)
+  class NoAdapterError < NameError
   end
 
-  def track_event(category, action, label=nil, value=nil)
-    utm_params[:utme].set_event(category, action, label, value)
-    track
-  end
+  class TrackerInterface
+    def initialize(adapter)
+      @adapter = adapter
+    end
 
-  def track_page_view(path=nil)
-    utm_params.merge({ :utmp => path }) if path
-    track
-  end
+    def track_page_view(path=nil)
+      @adapter.track_page_view(path)
+    end
 
-  def set_custom_variable(index, name, value, scope=nil)
-    utm_params[:utme].set_custom_variable(index, name, value, scope)
-  end
+    def track_event(category, action, label=nil, value=nil)
+      @adapter.track_event(category, action, label, value)
+    end
 
-  def unset_custom_variable(index)
-    utm_params[:utme].unset_custom_variable(index)
-  end
+    def set_custom_variable(slot, name, value, scope=nil)
+      @adapter.set_custom_variable(slot, name, value, scope)
+    end
 
-  def []=(key, value)
-    value = Utme.parse(value) if key.to_s == 'utme'
-    utm_params[key] = value
-  end
-
-  def [](key)
-    utm_params[key]
-  end
+    def unset_custom_variable(slot)
+      @adapter.unset_custom_variable(slot)
+    end
 
-  class << self
-    attr_accessor :account_id
-  end
+    def tracking_url
+      @adapter.tracking_url
+    end
 
-  protected
+    def type
+      @adapter.class
+    end
 
-  attr_accessor :utm_params, :utm_location
+    def []=(key, value)
+      @adapter[key] = value
+    end
 
-  private
+    def [](key)
+      @adapter[key]
+    end
+  end
 
-  # seems to be the current version
-  # search for 'utmwv' in http://www.google-analytics.com/ga.js
-  VERSION = "5.1.5"
-  UTM_GIF_LOCATION = ".google-analytics.com/__utm.gif"
+  def self.get_tracker(type, params = { })
+    begin
+      tracker_klass = "Satellite::Adapters::#{type.to_s.camelcase}".constantize
+    rescue
+      raise NoAdapterError, "There is no such adapter like 'Satellite::Adapters::#{type.to_s.camelcase}'"
+    end
 
-  # adds default params
-  def extend_with_default_params(params)
-    params.reverse_merge({
-                             :utme => Utme.parse(params[:utme]),
-                             :utmwv => VERSION,
-                             :utmn => rand(0x7fffffff).to_s,
-                             :utmac => GATracker.account_id
-                         })
+    TrackerInterface.new(tracker_klass.new(params))
   end
 
-end
-
-require 'satellite/utme'
+end

data/lib/support/object.rb

@@ -0,0 +1,34 @@
+unless Object.const_defined?("ActiveSupport")
+  class Object
+    def to_query(key)
+      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+
+      puts self.inspect
+      puts to_param
+
+      "#{CGI.escape(key.to_s).gsub(/%(5B|5D)/n) { [$1].pack('H*') }}=#{CGI.escape(to_param.to_s)}"
+    end
+
+    def to_param
+      to_s
+    end
+
+    def try(method, *args, &block)
+      begin
+        send(method, *args, &block)
+      rescue
+        nil
+      end
+    end
+  end
+
+  class Hash
+    def to_param(namespace = nil)
+      collect do |key, value|
+        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+      end.sort * '&'
+    end
+
+    alias_method :to_query, :to_param
+  end
+end

data/lib/support/string.rb

@@ -0,0 +1,65 @@
+unless Object.const_defined?("ActiveSupport")
+  class String
+    def camelize(first_letter = :upper)
+      case first_letter
+        when :upper then
+          ActiveSupport::Inflector.camelize(self, true)
+        when :lower then
+          ActiveSupport::Inflector.camelize(self, false)
+      end
+    end
+
+    alias_method :camelcase, :camelize
+
+    def constantize
+      ActiveSupport::Inflector.constantize(self)
+    end
+
+    def underscore
+      ActiveSupport::Inflector.underscore(self)
+    end
+
+    def demodulize
+      ActiveSupport::Inflector.demodulize(self)
+    end
+  end
+
+  module ActiveSupport
+    module Inflector
+      extend self
+
+      def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+        if first_letter_in_uppercase
+          lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+        else
+          lower_case_and_underscored_word.to_s[0].chr.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+        end
+      end
+
+      def underscore(camel_cased_word)
+        word = camel_cased_word.to_s.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+
+      def demodulize(class_name_in_module)
+        class_name_in_module.to_s.gsub(/^.*::/, '')
+      end
+
+      def constantize(camel_cased_word)
+        names = camel_cased_word.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end
+    end
+  end
+end

data/satellite.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{satellite}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Maik Vlcek}]
+  s.date = %q{2011-08-25}
+  s.description = %q{Ruby on Rails server-side Analytics Tracker for Google and more}
+  s.email = %q{maik.vlcek@mymobai.de}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/satellite.rb",
+    "lib/satellite/adapters/google_analytics.rb",
+    "lib/satellite/controllers/google_analytics.rb",
+    "lib/support/object.rb",
+    "lib/support/string.rb",
+    "satellite.gemspec",
+    "test/helper.rb",
+    "test/test_satellite.rb"
+  ]
+  s.homepage = %q{http://github.com/mediavrog/satellite}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.9}
+  s.summary = %q{Ruby on Rails server-side Analytics Tracker for Google and more}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -14,5 +14,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'satellite'
 
+# used for storing private data like google account_id
+require 'local_conf' if File.exists?('local_conf.rb')
+
 class Test::Unit::TestCase
 end

data/test/test_satellite.rb

@@ -1,7 +1,58 @@
 require 'helper'
 
 class TestSatellite < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+
+  should "create a proper google adapter" do
+    tracker = Satellite.get_tracker(:google_analytics)
+    assert_equal tracker.type, Satellite::Adapters::GoogleAnalytics
+  end
+
+  should "return any created tracker as tracker interface" do
+    tracker = Satellite.get_tracker(:google_analytics)
+    assert_equal tracker.class, Satellite::TrackerInterface
+  end
+
+  context 'google_adapter' do
+
+    #http://www.google-analytics.com/__utm.gif?
+    #utmwv
+    #utms
+    #utmn
+    #utmhn
+    #utme
+    #utmcs
+    #utmsr
+    #utmsc
+    #utmul
+    #utmje
+    #utmfl
+    #utmdt=
+    #utmhid
+    #utmr
+    #utmp
+    #utmac
+    #utmcc
+    #utmu
+    should "properly track a page view" do
+      tracker = Satellite.get_tracker(:google_analytics, {
+          :utms => 1,
+          #:utmn => 123456789, autogenerated
+          :utmhn => 'api.mymobai.com',
+          :utme => '5(controller*action*coupon_redeem)(10)8(test)9(Please_track_this)11(1)',
+          :utmcn => 1,
+          :utmcs => 'UTF-8',
+          :utmsr => '1440x900',
+          :utmul => 'de',
+          :utmje => '1',
+          :utmfl => '10.3%20r183',
+          :utmdt => 'Properly track a page view',
+          #:utmhid => '1655425535', auto
+          :utmr => 'test.local/properly track a page view',
+          :utmp => '/test/properly-track-page-view',
+          :utmac => GOOGLE_ACCOUNT_ID
+      })
+      
+      assert_equal tracker.track_page_view, true
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: satellite
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Maik Vlcek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-24 00:00:00 Z
+date: 2011-08-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -89,11 +89,17 @@ extra_rdoc_files:
 files: 
 - .document
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/satellite.rb
+- lib/satellite/adapters/google_analytics.rb
+- lib/satellite/controllers/google_analytics.rb
+- lib/support/object.rb
+- lib/support/string.rb
+- satellite.gemspec
 - test/helper.rb
 - test/test_satellite.rb
 homepage: http://github.com/mediavrog/satellite