touchpoints 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90c969ef338bf37fb2169bcea9077339a1ff1302567562c59c63ddf2f6622621
+  data.tar.gz: c80e1052ce904c814aa6a52e3afd3ff8c7b057eeba8fbe42d0971c368d0a50a5
+SHA512:
+  metadata.gz: e2b35d93675d8dfa395e747a5614c1148f3164d720ba94b76ac4c0e0a059e353afeb3169f3bed29c593ac0911c3682a95aff69c1908889e0e285ef9dce37b4f3
+  data.tar.gz: 28f295e6a06ff37c6ab5c6cfafd4b42555101ba36749705601ca358d08eadc345cb09c67b4492a9e5de29f4eb16e42582277387c91e8e3fcf453bcd419af48f9

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in touchpoints.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Cruz Horts
+
+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.md

@@ -0,0 +1,36 @@
+A channel is a source of traffic to our application. It could be:
+- direct: users enter our bare URL in their browser. No referrer.
+- organic: users click on a link on a search engine. Referrer is the search engine URL.
+- marketing: users click on a link of an affiliate or paid search result. UTM params are usually set. Referrer is the affiliate URL.
+- campaign: users click on a link of an email/site or enter a URL. UTM params are usually set. Referrer may not.
+
+A touchpoint is a visit from the outside world, to our website or set of websites under the same domain.
+
+Attribution is the process of assigning a channel to a customer, so we can know what
+channel we'd better put our money on.
+
+Usually, the attributed channel is the first touchpoint found 1 month after the user signed up (or any other event we decide).
+
+```
+bin/rails generate migration CreateTouchpoints user_entity_id:uuid utm_params:jsonb referer:string created_at:timestamp
+```
+
+If we have several hosts with same domain operating as a whole, we must share the session cookie between them. In your `config/initializers/session_store.rb`:
+
+```ruby
+Rails.application.config.session_store :cookie_store, key: '_creditspring_session', domain: ENV.fetch('DOMAIN', 'localhost')
+```
+
+In your ApplicationController:
+```ruby
+include Touchpoints::Tracker
+```
+
+Configure the gem, in `config/initializers/touchpoints.rb`:
+```ruby
+Touchpoints.configure do |config|
+  config.set :logging, true
+  config.set :model_id, :entity_id
+  config.set :model_foreign_id, :user_entity_id
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/concerns/touchpoints/tracker.rb

@@ -0,0 +1,86 @@
+module Touchpoints
+  module Tracker
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :_track_touchpoints
+    end
+
+    def _track_touchpoints
+      touchpoints = Array(session[get(:session_name)])
+                      .then(&method(:keep_only_recent))
+                      .then(&method(:add_if_different))
+                      .then(&method(:persist_if_logged_in))
+
+      Touchpoints.debug("Touchpoints: #{touchpoints.inspect}")
+
+      session[get(:session_name)] = touchpoints.last(get(:capacity))
+    end
+
+    private
+
+    def domain_from(string) # TODO: come up with a more resilient way of extracting the domain
+      uri = URI.parse string
+      return unless uri.host
+
+      uri.host.split('.').reverse[0..2].reverse.join('.')
+    end
+
+    def keep_only_recent(touchpoints)
+      touchpoints.select { |touchpoint| touchpoint['created_at'] > 60.days.ago }
+    end
+
+    def add_if_different(touchpoints)
+      return touchpoints if request.domain == domain_from(request.referer.to_s)
+
+      last_touchpoint = Hash(touchpoints.last)
+      utm_params = params.permit(*get(:utm_params)).to_h
+
+      new_touchpoint = { 'utm_params' => utm_params, 'referer' => request.referer, 'created_at' => Time.current }
+
+      Touchpoints.debug("Touchpoint (new): #{new_touchpoint.inspect}")
+      Touchpoints.debug("Touchpoint (last): #{last_touchpoint.inspect}")
+
+      if !equivalent_touchpoints?(new_touchpoint, last_touchpoint)
+        touchpoints << new_touchpoint
+        Touchpoints.debug('Touchpoint noted!')
+      end
+
+      touchpoints
+    end
+
+    def persist_if_logged_in(touchpoints)
+      return touchpoints unless logged_in?
+
+      last_touchpoint_persisted = get(:model).constantize.where(get(:model_foreign_id) => user_id).last
+      last_touchpoint_attributes = last_touchpoint_persisted ? last_touchpoint_persisted.attributes.slice('utm_params', 'referer') : {}
+
+      touchpoints.each do |touchpoint|
+        next if equivalent_touchpoints?(touchpoint, last_touchpoint_attributes)
+
+        touchpoint[get(:model_foreign_id)] = user_id if logged_in?
+        get(:model).constantize.new(touchpoint).save
+        Touchpoints.debug('Touchpoint persisted!')
+        last_touchpoint_persisted = nil
+      end
+
+      []
+    end
+
+    def logged_in?
+      respond_to?(get(:current_user_method)) && send(get(:current_user_method)).present?
+    end
+
+    def user_id
+      send(get(:current_user_method)).send(get(:model_id))
+    end
+
+    def equivalent_touchpoints?(a, b)
+      a['utm_params'] == b['utm_params'] && a['referer'] == b['referer']
+    end
+
+    def get(option)
+      Touchpoints.get(option)
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/sal/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,2 @@
+Touchpoints::Engine.routes.draw do
+end

data/lib/touchpoints.rb

@@ -0,0 +1,34 @@
+require "touchpoints/engine"
+
+module Touchpoints
+  @@configuration = {
+    session_name: '_touchpoints'.freeze,
+    utm_params: %w(utm_source utm_medium utm_campaign utm_term utm_content utm_uid).freeze,
+    logging: false,
+    model: 'Touchpoint'.freeze,
+    model_id: :id,
+    model_foreign_id: :user_id,
+    current_user_method: :current_user,
+    capacity: 22,
+  }
+
+  def self.configure
+    yield Touchpoints
+
+    debug "Touchpoint configuration: #{@@configuration.inspect}"
+  end
+
+  def self.set(option, value)
+    @@configuration[option] = value
+  end
+
+  def self.get(option)
+    @@configuration[option]
+  end
+
+  def self.debug(message)
+    return unless get(:logging)
+
+    puts message
+  end
+end

data/lib/touchpoints/engine.rb

@@ -0,0 +1,11 @@
+module Touchpoints
+  class Engine < ::Rails::Engine
+    # We want all the helpers to be used in the app
+    #isolate_namespace Touchpoints
+
+    config.app_generators do |g|
+      g.stylesheets false
+      g.javascripts false
+    end
+  end
+end

data/lib/touchpoints/version.rb

@@ -0,0 +1,3 @@
+module Touchpoints
+  VERSION = '0.1.0'
+end

data/touchpoints.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "touchpoints/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "touchpoints"
+  spec.version       = Touchpoints::VERSION
+  spec.authors       = ['Daniel Cruz Horts']
+
+  spec.summary       = %q{Track touchpoints.}
+  spec.homepage      = 'https://github.com/dncrht/touchpoints'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '>= 4'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-rails'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: touchpoints
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Cruz Horts
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/concerns/touchpoints/tracker.rb
+- bin/rails
+- bin/setup
+- config/routes.rb
+- lib/touchpoints.rb
+- lib/touchpoints/engine.rb
+- lib/touchpoints/version.rb
+- touchpoints.gemspec
+homepage: https://github.com/dncrht/touchpoints
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Track touchpoints.
+test_files: []