acts_as_referred 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42d5ef44865bb5d0ba9ed490390891ef07c74a6d
+  data.tar.gz: 9745dd1b1913d9cb7a735c012149a532883063f3
+SHA512:
+  metadata.gz: c93d99f61e5aed0cedc4e2706e2f9b7c70607fde113cdc7e08d63e593509cbf5634d11b2c9615667a9a7aabd3af9237b6642b141812117be884586627089fe32
+  data.tar.gz: f3d48468214d25ae3ff4fecf8641205daf72079c891746c30f25e2e95346779083e75c676d3a26a0f60df65021dc006861e3d39d31b6a3f280e36242ca9b84ed

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 rene paulokat
+
+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,89 @@
+= ActsAsReferred
+
+A gentle gem which offers the possibility to track referrer and campaigning.
+After an ActiveRecord-instance that includes +acts_as_referred+ gets persistet to your database a relational +Referee+ is persistet as well.
+
+A +before_action+ included to ApplicationController scans the incoming request for specific data supplied in the request-url. 
+
+This information is stored in a cookie and in the session as well. The created cookie is valid for 1 month. 
+
+The action then makes this data available to your model. When supplied with +acts_as_referred+ your pimped model will make use of a +after_create+ action to create a relational +Referee+ after it was created.
+
+
+== Status 
+
+not yet production ready
+
+== Install 
+
+at this stage only by github:
+so add to your Gemfile  
+
+  gem 'acts_as_referred', :git => 'git://github.com/erpe/acts_as_referred.git'
+
+afterwards run the rake task to create necessary database table
+
+  rake acts_as_referred:create_table
+
+add +acts_as_referred+ to your model e.g.
+
+  class Order < ActiveRecord::Base
+    acts_as_referred
+  end
+
+and the final step - adopt your ApplicationController with:
+
+  class ApplicationController < ActionController::Base
+    include ActsAsReferred::Controller
+  end
+
+
++acts_as_referred+ supports manual tagged campaigns 
+
+If you use google-adwords you have to define manual-url-tagging instead of googles default auto-tagging
+
+Auto-tagging (gclid) is recognized as campaign but can not be resolved. 
+(could be by parsing e.g. google-analytics cookies - but i think its kind of bad practice to relay on googles cookie-syntax)
+
+
+== Usage 
+
+A example Order-model which includes +acts_as_referred+ has a relation to *Referee* on creation
+you can query referees after relational order was created:
+
+
+[order.referee.is_campaign]
+  returns true if request supplied campaign-arguments
+
+[order.referee.campaign]
+  returns campaign name if supplied by tagging 
+
+[order.referee.keywords]
+  returns supplied keywords in the request.
+
+[order.referee.host]
+  returns referrer-hostname
+
+[order.referee.path]
+  returns path part of request
+
+[Referee.campaigns]
+  returns collection of referee-instances connected to a campaign
+
+
+== Background  
+
+whenever a request travels through ApplicationController and initializes a session the delivered referrer is persisted in the session. 
+As soon as an ActiveRecord which includes +acts_as_referred+ gets created the stored referrer will be used to build a new *Referee*
+
+[A typical request coming in from adwords (non-auto-tagging!) looks like]
+  
+  http://example.com/terror-in-baskets?utm_campaign=NSA&utm_term=PRISM&utm_medium=intercepted&utm_source=fbook
+
+[If you prefer  - what i'd  apreciate - Piwik as privacy-aware tracking]
+  
+  http://example.com/terror-in-baskets?pk_campaign=NSA&pk_kwd=PRISM
+
++ActsAsReferred+ stores the supplied campaign and keywords with in a +Referee+
+
+

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+Dir.glob('lib/tasks/*.rake').each {|r| import r}
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsReferred'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/acts_as_referred.rb

@@ -0,0 +1,21 @@
+require 'acts_as_referred/instance_methods'
+require 'acts_as_referred/model'
+require 'acts_as_referred/class_methods'
+require 'acts_as_referred/controller'
+
+module ActsAsReferred
+  extend ActiveSupport::Concern
+  
+  included do
+  end
+
+  # provide rake-tasks to create db-migration
+  class RakeTasks < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, ActsAsReferred

data/lib/acts_as_referred/class_methods.rb

@@ -0,0 +1,14 @@
+module ActsAsReferred
+  module ClassMethods
+  
+    # Hook to serve behavior to ActiveRecord-Descendants
+    def acts_as_referred(options = {})
+      
+      has_one :referee, as: :referable, dependent: :destroy, class_name: 'Referee'
+      after_create :create_referrer
+
+      include ActsAsReferred::InstanceMethods
+    end
+    
+  end
+end

data/lib/acts_as_referred/controller.rb

@@ -0,0 +1,87 @@
+module ActsAsReferred
+ 
+  # Namespce for controller-related functionality
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :_check_cookie_and_session
+      before_filter :_supply_model_hook
+    end
+
+    protected
+    
+    # The before_filter which processes necessary data for 
+    # +acts_as_referred+ - models
+    def _supply_model_hook
+
+      # 3.2.1 -> adwords auto-tagging - (show hint to manual tag adwords):
+      #  ?gclid=xxxx   
+      # 3.2.2 -> manual tagging 
+      #  ?utm_source=google&utm_medium=cpc&utm_term=my_keyword&utm_campaign=my_summerdeal  
+      # 3.2.3 -> manual url-tagging specific for piwik 
+      #  ?pk_campaign=my_summerdeal&pk_kwd=my_keyword  
+      # cookie / session persisted:
+      # e.g.: "req=http://foo/baz?utm_campaign=plonk|ref=http://google.com/search|count=0"
+      
+      tmp = session[:__reqref]
+      _struct = nil
+      if tmp
+        arr = tmp.split('|')
+        _struct = OpenStruct.new(
+                    request_url: arr[0].split('=',2)[1],
+                    referrer_url: minlength_or_nil(arr[1].split('=',2)[1]),
+                    visit_count: arr[2].split('=',2)[1].to_i
+                    )
+      end
+
+      ActiveRecord::Base.send(
+                              :define_method, 
+                              '_get_reqref', 
+                              proc{ _struct }   
+                             )
+    end
+
+
+    private
+
+    # checks for existing +__reqref+ key in session
+    # if not found checks for signed cookie with key +__reqref+
+    # if this is the initial request to our site, we write a cookie with 
+    # referrer and request.url
+    def _check_cookie_and_session
+      args = {}
+      if session[:__reqref]
+        tmp = session[:__reqref]
+      else
+        if cookies.signed[:__reqref]
+          tmp = cookies.signed[:__reqref]
+          tmp = _increment_returning_count(tmp)
+          _set_cookie(__reqref: tmp)
+        else
+          tmp = "req=#{request.url}|ref=#{request.referrer}|ret=0"
+          _set_cookie(__reqref: tmp)
+        end
+        session[:__reqref] = tmp
+      end
+    end
+
+    def _set_cookie(args={})
+      args.each_pair do |k,v|
+        cookies.signed[k] = { value: v, expires: 1.month.from_now }
+      end
+    end
+
+    def _increment_returning_count(tmp)
+      arr = tmp.split("|")
+      arr[-1] = "ret=#{arr[-1].split('=')[-1].to_i + 1}"
+      arr.join('|')
+    end
+
+    def minlength_or_nil(string)
+      URI.parse(string).host ? string : nil
+    end
+    
+  end
+
+end

data/lib/acts_as_referred/instance_methods.rb

@@ -0,0 +1,20 @@
+module ActsAsReferred
+  module InstanceMethods
+    
+    private
+
+    # after create hook to create a corresponding +Referee+
+    def create_referrer
+      if struct = _get_reqref
+
+        self.create_referee(
+                    origin: struct.referrer_url, 
+                    request: struct.request_url, 
+                    visits: struct.visit_count
+                    )
+      end
+    end
+
+  end
+end
+

data/lib/acts_as_referred/model.rb

@@ -0,0 +1,146 @@
+module ActsAsReferred
+
+  # Namespace for ActsAsReferred-model
+  module Model
+
+    # Represents a Referee - 
+    # *attributes*
+    # [origin]        the full URI of referrer
+    # [origin_host]   host-part of referrer
+    # [request]       the full request as string
+    # [request_query] the query-string - may be nil
+    # [campaign]      the supplied campaign-name in query
+    # [keywords]      the supplied keywords in query
+    # [is_campaign]   if this referee is from campaign
+    # [visits]        number of visits before conversion
+    #
+    class ::Referee < ActiveRecord::Base
+      
+      self.table_name = 'referees'
+
+      belongs_to :referable, polymorphic: true
+
+      before_create :process_request_and_referrer
+
+      # all referees which where created throughout a 
+      # campaign-based request
+      scope :campaigns, -> { where('is_campaign=?', true) }
+
+      # returns referrer as instance of URI
+      def origin_uri
+        has_referrer? ? URI.parse(origin) : nil
+      end
+      
+      # returns host-part of referrer  
+      # may be nil
+      def host
+        origin_host
+      end
+
+      # returns path part of request
+      # may be nil
+      def request_path
+        URI.parse(request).path
+      end
+      
+      def has_referrer?
+        true if origin
+      end
+
+      def has_request?
+        true if request
+      end
+
+      def has_query?
+        true if request_query
+      end
+
+      private
+
+      def process_request_and_referrer
+        process_origin if origin
+        
+        if request && URI.parse(request).query
+          self.request_query = URI.parse(request).query
+          if process_request
+            self.is_campaign = true
+          end
+        end
+      end
+
+      def process_request
+        if self.request_query
+          if self.request_query.match(/utm_campaign/) || self.request_query.match(/utm_term/)
+            return process_google_tagged(self.request_query)
+          end
+          if self.request_query.match(/pk_campaign/) || self.request_query.match(/pk_term/)
+            return process_piwik_tagged(self.request_query)
+          end
+          if self.request_query.match(/gclid/)
+            return process_google_auto_tagged(self.request_query)
+          end
+        end
+      end
+
+      
+      # a.t.m. only care about campaign name and keywords
+      def process_google_tagged(string)
+        hash = Hash[* string.split('&').collect { |i| i.split('=') }.flatten]
+        retval = nil
+        hash.keys.each do |key|
+          case key
+          #when 'utm_source'
+          #  source = hash[key]
+          when 'utm_campaign'
+            self.campaign = hash[key]
+            retval = true
+          #when 'utm_medium'
+          #  medium = hash[key]
+          when 'utm_term'
+            self.keywords = hash[key]
+            retval = true
+          end
+        end
+        retval
+      end
+      
+      # standard piwik campaign-tracking
+      def process_piwik_tagged(string)
+        hash = Hash[*(string.split('&').collect { |i| i.split('=') }.flatten)]
+        retval = nil
+        hash.keys.each do |key|
+          case key
+          when 'pk_campaign'
+            self.campaign = hash[key]
+            retval = true
+          when 'pk_kwd'
+            self.keywords = hash[key]
+            retval = true
+          end
+        end
+        retval
+      end
+
+      # adwords set to autotagging
+      # no chance to get campaign info by url
+      # would have to do cookie parsing - what would suck
+      def process_google_auto_tagged(string)
+        hash = Hash[* string.split('|').collect { |i| i.split('=') }.flatten]
+        retval = nil
+        if hash['gclid']
+          self.campaign = "Adwords - autotagged: #{hash['gclid']}"
+          self.is_campaign = true
+          retval = true
+        end
+        retval
+      end
+      
+      def process_origin
+        self.origin_host = URI.parse(origin).host
+      end
+
+    end
+
+  end
+
+end