sojourn 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05e30ba3490b5cb18a66e3ecf4bdb0048e0ce529
-  data.tar.gz: 055a2accda2519d306ed020f9df334694cea68c0
+  metadata.gz: a5bcd732bdfc1df4fdd68744f4c807f894104848
+  data.tar.gz: 927a8ba15bd0948cb8c390c15b7c900785051a1f
 SHA512:
-  metadata.gz: 8c8eaa338c482230664097aae7910ebae14f9ebace498dc9feff819d96fce1b66e65546c1416f3e23e3dee6342c0936fe209e081eb11a1a0aeff62de82a74947
-  data.tar.gz: 70f60a8e7ba6a81055acd0306736b4feff026eed0f2dbac10d18510bd2e6e4dec6711a9c96eacac5eef6767ef12e1ce2b042d0739f31285ec95bdb9286f25f24
+  metadata.gz: 469867e717db9bc51b25e1b414a711db552631225524e781a2c9a5d62e3faefdf2d8e0f77acd426aaa7ac094b62e35b7361ec5c761ed4dadaddf7ce8bba2d32b
+  data.tar.gz: 44d5346a2ccabc605e220af036077b2f9969213580bc04188852f5d6ee6ff4a2b3a6ea1bf566cefdaa0cde87177092d3892247448bafdc19703cf8f9c96dc3f4

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 99
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+ - 2.2.4
+ - 2.1.8
+ - 2.0.0-p648
+addons:
+  code_climate:
+    repo_token: f8a0ab3c3b30ca6a3091f30a9e344344a80f919837de817d576c0e3f174a4e2c

data/README.md

@@ -1,4 +1,4 @@
-# Sojourn
+# Sojourn [![Build Status](https://img.shields.io/travis/smudge/sojourn.svg)](https://travis-ci.org/smudge/sojourn) [![Code Climate](https://img.shields.io/codeclimate/github/smudge/sojourn.svg)](https://codeclimate.com/github/smudge/sojourn) [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/smudge/sojourn.svg)](https://codeclimate.com/github/smudge/sojourn/coverage)
 
 Simple source & event tracking for Rails. This gem automatically tracks *sojourners*
 (i.e. unique visitors) based on:
@@ -19,9 +19,7 @@ associated with this UUID and with the current user's ID (if logged-in).
 
 Events (`Sojourn::Event`) consist of a name, a set of properties (key-value hash) and information
 about the request. In the current ActiveRecord implementation, requests (`Sojourn::Request`) can
-be queried separately and may have many events. Requests also track browser (`Sojourn::Browser`)
-and campaign (`Sojourn::Campaign`) info as unique models. See 'Usage' below for the details
-of these models.
+be queried separately and may have many events. See 'Usage' below for the details of these models.
 
 
 ## Usage
@@ -30,37 +28,17 @@ of these models.
 # Track a custom event (highly encouraged!):
 sojourn.track! 'clicked call-to-action', plan_choice: 'enterprise'
 
+# If you don't have access to a controller context (i.e. the event is not occurring during a web
+# request), you can still track a raw event like this:
+
+Sojourn.track_raw_event! 'subscription expired', plan: 'enterprise', customer_id: 'xyb123'
+
+# Read events using ActiveRecord
 e = Sojourn::Event.last
 e.name               # event name (e.g. 'clicked call-to-action')
 e.sojourner_uuid     # uuid tracked across requests, stored in cookie
 e.user               # User or nil
 e.properties         # key-value hash (e.g. "{ plan_choice: 'enterprise' }")
-e.request            # Sojourn::Request object
-
-r = Sojourn::Request.last
-r.referer
-r.host
-r.path
-r.controller
-r.action
-r.params
-r.method
-r.ip_address
-r.campaign           # Sojourn::Campaign object (nil if no campaign detected)
-r.browser            # Sojourn::Browser object
-
-b = Sojourn::Browser.last
-b.known?             # whether or not the browser was detected successfully
-b.user_agent
-b.name
-b.version
-b.platform
-b.bot?
-
-c = Sojourn::Campaign.last
-c.path               # Base path (e.g. '/posts/2')
-c.params             # Notable (tracked) params, sorted. (Typically utm-style, but configurable.)
-
 ```
 
 ## Default Events
@@ -81,6 +59,42 @@ A `'!sojourning'` event takes place whenever any of the following is true:
   initializer.)
 
 
+## Properties
+
+In addition to properties that you manually add, events will automatically include data about
+the current web request. An example looks like this:
+
+```json
+{
+  "custom_property":"value",
+  "request":{
+    "uuid":"5e698f6ca74a016c49ca6b91a79cada7",
+    "host":"example.com",
+    "path":"/my-news",
+    "controller":"news",
+    "action":"index",
+    "method":"get",
+    "params":{
+      "utm_campaign":"daily_updates",
+      "page":"1"
+    },
+    "referer":"https://mail.google.com",
+    "ip_address":"42.42.42.42",
+    "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.48 Safari/537.36"
+  },
+  "browser":{
+    "bot":false,
+    "name":"Chrome",
+    "known":true,
+    "version":"48",
+    "platform":"mac"
+  },
+  "campaign":{
+    "utm_campaign":"daily_updates"
+  }
+}
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -115,4 +129,3 @@ highly scalable data backends.
   website.
 * Relies solely on cookies to track visitor UUID across requests (no JS, fingerprinting, etc)
 * Relies on ActiveRecord for storage. (At a bigger scale, append-only logs are preferred)
-* There are no tests.

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts 'rspec rake tasks not found'
+end

data/lib/generators/sojourn/install_generator.rb

@@ -21,7 +21,7 @@ module Sojourn
       end
 
       def create_migrations
-        %w(campaigns browsers requests events).map { |m| "create_sojourn_#{m}" }.each do |name|
+        %w(events).map { |m| "create_sojourn_#{m}" }.each do |name|
           if self.class.migration_exists?('db/migrate', name)
             say "        #{set_color('skip', :yellow)}  #{name}.rb (migration already exists)"
           else

data/lib/generators/sojourn/templates/create_sojourn_events.rb

@@ -3,13 +3,11 @@ class CreateSojournEvents < ActiveRecord::Migration
     create_table :sojourn_events do |t|
       t.string :sojourner_uuid, limit: 36, null: false
       t.string :name
-      t.text :properties
-      t.references :sojourn_request
+      t.column :properties, :jsonb
       t.references :user
       t.timestamp :created_at
     end
     add_index :sojourn_events, [:sojourner_uuid]
-    add_index :sojourn_events, [:sojourn_request_id]
     add_index :sojourn_events, [:user_id]
     add_index :sojourn_events, [:created_at]
     add_index :sojourn_events, [:name]

data/lib/sojourn.rb

@@ -16,9 +16,13 @@ module Sojourn
   end
 
   def self.tables_exist?
-    @tables_exist ||= %w(sojourn_events sojourn_requests sojourn_browsers sojourn_campaigns)
+    @tables_exist ||= %w(sojourn_events sojourn_requests)
                       .map { |t| ActiveRecord::Base.connection.table_exists?(t) }.all?
   end
+
+  def self.track_raw_event!(name, properties)
+    Event.create! sojourner_uuid: '!unknown', name: name, properties: properties
+  end
 end
 
 ActionController::Base.send :include, Sojourn::Controller

data/lib/sojourn/configuration.rb

@@ -1,7 +1,6 @@
 require_relative 'session_stores/cookie'
 
 class Configuration
-
   attr_accessor :campaign_params
   attr_accessor :session_store
   attr_accessor :cookie_name
@@ -24,5 +23,4 @@ private
     self.cookie_name = :_sojourn
     self.tracking_enabled = true
   end
-
 end

data/lib/sojourn/controller.rb

@@ -2,7 +2,6 @@ require_relative 'tracker'
 
 module Sojourn
   module Controller
-
     def self.included(base)
       base.before_filter :track_sojourning
       base.before_filter :save_sojourn_session
@@ -21,6 +20,5 @@ module Sojourn
     def save_sojourn_session
       sojourn.update_session!
     end
-
   end
 end

data/lib/sojourn/event.rb

@@ -1,13 +1,12 @@
+require_relative 'serializers/indifferent_json'
+
 module Sojourn
   class Event < ActiveRecord::Base
-    DEFAULT_FIELDS = [:id, :sojourner_uuid, :name, :properties, :sojourn_request_id, :user_id, :created_at]
+    DEFAULT_FIELDS = %i(id sojourner_uuid name properties user_id created_at)
 
-    belongs_to :request, foreign_key: :sojourn_request_id
     belongs_to :user
-    has_one :campaign, through: :request
-    has_one :browser, through: :request
 
-    serialize :properties
+    serialize :properties, Serializers::IndifferentJSON
 
     before_save do
       properties.keys.map(&:to_sym).each do |key|

data/lib/sojourn/request.rb

@@ -1,42 +1,123 @@
-require_relative 'campaign'
-require_relative 'browser'
-require_relative 'serializers/symbol'
+require 'securerandom'
 require 'addressable/uri'
+require 'browser'
+require 'referer-parser'
 
 module Sojourn
-  class Request < ActiveRecord::Base
-    attr_accessor :user_agent
+  class Request
+    KEYS = %w(uuid referer host path controller action params method ip_address user_agent)
 
-    serialize :method, Serializers::Symbol
-    serialize :params
+    attr_reader :request
 
-    belongs_to :campaign, foreign_key: :sojourn_campaign_id
-    belongs_to :browser, foreign_key: :sojourn_browser_id
-    has_many :events, foreign_key: :sojourn_request_id
+    def initialize(request)
+      @request = request
+    end
 
-    def self.from_request(request)
-      new referer: request.referer.try(:truncate, 2048),
-          host: request.host.try(:truncate, 2048),
-          path: request.path.try(:truncate, 2048),
-          controller: request.params[:controller],
-          action: request.params[:action],
-          params: request.filtered_parameters.with_indifferent_access.except(:controller, :action),
-          method: request.request_method_symbol,
-          ip_address: request.remote_ip,
-          user_agent: request.user_agent
+    def outside_referer?
+      referer.present? && referer_host != host
     end
 
-    before_validation do
-      self.campaign ||= Campaign.from_request(self)
-      self.browser ||= Browser.from_request(self) if user_agent
+    def any_utm_data?
+      tracked_param_keys.map { |p| downcased_params[p].present? }.any?
     end
 
-    def outside_referer?
-      referer.present? && Addressable::URI.parse(referer).host != host
+    def tracked_params
+      Hash[downcased_params.slice(*tracked_param_keys).delete_if { |_, v| v.blank? }.sort]
     end
 
-    def any_utm_data?
-      Sojourn.config.campaign_params.map { |p| params[p].present? }.any?
+    def raw_data
+      Hash[KEYS.map { |k| [k, send(k)] }].with_indifferent_access
+    end
+
+    def browser_data
+      return @browser_data if @browser_data
+      @browser_data = {
+        name: browser.name,
+        version: browser.version,
+        platform: browser.platform,
+        bot: browser.bot?,
+        known: browser.known?
+      }
+    end
+
+    def referer_data
+      return @referer_data if @referer_data
+      p = RefererParser::Parser.new.parse(sanitized_referer)
+      @referer_data = {
+        known: p[:known],
+        host: referer_host,
+        source: p[:source],
+        medium: p[:medium],
+        term: p[:term]
+      }
+    rescue
+      @referer_data = {}
+    end
+
+  private
+
+    def uuid
+      @uuid ||= request.uuid || SecureRandom.uuid
+    end
+
+    def referer
+      @referer ||= request.referer.try(:truncate, 2048)
+    end
+
+    def host
+      @host ||= request.host.try(:truncate, 2048)
+    end
+
+    def path
+      @path ||= request.path.try(:truncate, 2048)
+    end
+
+    def controller
+      @controller ||= request.params[:controller]
+    end
+
+    def action
+      @action ||= request.params[:action]
+    end
+
+    def params
+      @params ||= request.filtered_parameters.with_indifferent_access.except(:controller, :action)
+    end
+
+    def method
+      @method ||= request.request_method_symbol
+    end
+
+    def ip_address
+      @ip_address ||= request.remote_ip
+    end
+
+    def user_agent
+      @user_agent ||= request.user_agent
+    end
+
+    def referer_host
+      @referer_host ||= parsed_referer.host
+    end
+
+    def sanitized_referer
+      @sanitized_referer ||= parsed_referer.display_uri
+    end
+
+    def parsed_referer
+      @parsed_referer ||= Addressable::URI.parse(referer)
+    end
+
+    def downcased_params
+      params.each_with_object({}) { |(k, v), h| h[k.to_s.downcase] = v }
+    end
+
+    def tracked_param_keys
+      Sojourn.config.campaign_params.map(&:to_s).map(&:downcase)
+    end
+
+    def browser
+      @browser ||= Browser.new(user_agent: user_agent) if user_agent
     end
   end
 end

data/lib/sojourn/serializers/indifferent_json.rb

@@ -0,0 +1,13 @@
+module Sojourn
+  module Serializers
+    class IndifferentJSON
+      def self.load(string)
+        JSON.parse(string || '{}').with_indifferent_access
+      end
+
+      def self.dump(hash)
+        (hash || {}).to_json
+      end
+    end
+  end
+end

data/lib/sojourn/session_stores/cookie.rb

@@ -1,7 +1,6 @@
 module Sojourn
   module SessionStores
     class Cookie
-
       def initialize(ctx)
         @ctx = ctx
       end
@@ -43,7 +42,6 @@ module Sojourn
       def cookie_name
         @cookie_name ||= Sojourn.config.cookie_name
       end
-
     end
   end
 end

data/lib/sojourn/tracker.rb

@@ -13,7 +13,7 @@ module Sojourn
     def track!(event_name, properties = {}, user_id = current_user_id)
       return unless Sojourn.tables_exist?
       properties = default_event_properties.merge(properties)
-      Event.create! sojourner_uuid: sojourner_uuid, name: event_name, request: request,
+      Event.create! sojourner_uuid: sojourner_uuid, name: event_name,
                     properties: properties, user_id: user_id
     end
 
@@ -37,7 +37,7 @@ module Sojourn
   private
 
     def request
-      @request ||= Request.from_request(ctx.request)
+      @request ||= Request.new(ctx.request)
     end
 
     def session
@@ -70,6 +70,10 @@ module Sojourn
                                      Sojourn.config.default_properties_block
       end
       @ctx.sojourn_event_properties(properties) if @ctx.respond_to? :sojourn_event_properties
+      properties.merge! request: request.raw_data
+      properties.merge! campaign: request.tracked_params if request.tracked_params.any?
+      properties.merge! browser: request.browser_data
+      properties.merge! referer: request.referer_data if request.referer_data.any?
       properties
     end
   end

data/lib/sojourn/version.rb

@@ -1,3 +1,3 @@
 module Sojourn
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

data/sojourn.gemspec

@@ -22,7 +22,13 @@ sojourn tracks the referer, utm data, and logged-in user (if any)).gsub("\n", '
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
 
   spec.add_dependency 'browser', '>= 0.8.0'
   spec.add_dependency 'addressable', '>= 2.3.1'
+  spec.add_dependency 'referer-parser', '~> 0.3.0'
+  spec.add_dependency 'rails', '~> 3.2.0'
 end

data/spec/mocks/controller.rb

@@ -0,0 +1,15 @@
+require 'mocks/user'
+require 'mocks/request'
+require 'mocks/cookie'
+
+module Mocks
+  class Controller
+    attr_accessor :current_user, :request, :cookies
+
+    def initialize(user = User.new, request = Request.new, cookies = Cookie.new)
+      self.current_user = user
+      self.request = request
+      self.cookies = cookies
+    end
+  end
+end

data/spec/mocks/cookie.rb

@@ -0,0 +1,30 @@
+# Credit: https://kylecrum.wordpress.com/2009/07/19/mock-cookies-in-rails-tests-the-easy-way/
+
+module Mocks
+  class Cookie < Hash
+    def [](name)
+      super(name)
+    end
+
+    def []=(key, options)
+      if options.is_a?(Hash)
+        options.symbolize_keys!
+      else
+        options = { value: options }
+      end
+      super(key, options[:value])
+    end
+
+    def delete(key, _)
+      super(key)
+    end
+
+    def permanent
+      self
+    end
+
+    def signed
+      self
+    end
+  end
+end

data/spec/mocks/request.rb

@@ -0,0 +1,56 @@
+require 'securerandom'
+
+module Mocks
+  class Request
+    CHROME_UA = <<-EOF.squish
+        Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko)
+          Chrome/41.0.2228.0 Safari/537.36
+      EOF
+
+    attr_reader :opts
+
+    def initialize(opts = {})
+      @opts = opts
+    end
+
+    def uuid
+      opts[:uuid] || SecureRandom.uuid
+    end
+
+    def referer
+      opts[:referer]
+    end
+
+    def host
+      opts[:host] || 'http://example.com'
+    end
+
+    def path
+      opts[:path] || '/'
+    end
+
+    def params
+      opts[:params] || {}.with_indifferent_access
+    end
+
+    def method
+      opts[:method] || 'GET'
+    end
+
+    def filtered_parameters
+      @filtered_parameters ||= params.merge(filtered: true)
+    end
+
+    def request_method_symbol
+      @request_method_symbol ||= method.downcase.to_sym
+    end
+
+    def remote_ip
+      opts[:remote_ip] || '192.168.1.1'
+    end
+
+    def user_agent
+      opts[:user_agent] || CHROME_UA
+    end
+  end
+end

data/spec/mocks/user.rb

@@ -0,0 +1,9 @@
+module Mocks
+  class User
+    attr_accessor :id
+
+    def initialize(id = rand(10_000))
+      self.id = id
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'rspec/its'
+require 'rails'
+require 'active_record'
+require 'sojourn'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ActiveRecord::Base.establish_connection adapter: 'sqlite3',
+                                            database: ':memory:'
+
+    ActiveRecord::Schema.define do
+      self.verbose = false
+
+      create_table :sojourn_events do |t|
+        t.string :sojourner_uuid, limit: 36, null: false
+        t.string :name
+        t.text :properties
+        t.references :sojourn_request
+        t.references :user
+        t.timestamp :created_at
+      end
+
+      create_table :sojourn_requests do |t|
+        t.string :host, limit: 2048
+        t.string :path, limit: 2048
+        t.string :method
+        t.string :controller
+        t.string :action
+        t.string :ip_address
+        t.text :user_agent
+        t.text :params
+        t.text :referer
+        t.timestamp :created_at
+      end
+    end
+  end
+
+  config.before do
+    Sojourn::Event.delete_all
+  end
+end

data/spec/tracker_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'securerandom'
+require 'mocks/controller'
+
+module Sojourn
+  COOKIE_NAME = Sojourn.config.cookie_name
+
+  describe Tracker do
+    let(:user) { Mocks::User.new }
+    let(:request) { Mocks::Request.new }
+    let(:cookies) { Mocks::Cookie.new }
+    let(:ctx) { Mocks::Controller.new(user, request, cookies) }
+    let(:tracker) { Tracker.new(ctx) }
+
+    describe '#track!' do
+      let(:event_name) { 'foo' }
+      let(:opts) { { bar: true } }
+      before { tracker.track!(event_name, opts) }
+      subject { Event.last }
+
+      its(:user_id) { is_expected.to eq(user.id) }
+      its(:name) { is_expected.to eq(event_name) }
+
+      describe 'request' do
+        subject { Event.last.properties[:request] }
+
+        its([:params]) { is_expected.to eq('filtered' => true) }
+        its([:method]) { is_expected.to eq('get') }
+      end
+
+      describe 'properties' do
+        subject { Event.last.properties }
+
+        its(:keys) { is_expected.to eq(%w(request browser bar)) }
+        its([:browser, :name]) { is_expected.to eq('Chrome') }
+      end
+    end
+
+    describe '#sojourning!' do
+      before { tracker.sojourning! }
+      subject { Event.last }
+
+      its(:name) { is_expected.to eq('!sojourning') }
+
+      context 'when already tracked once' do
+        before do
+          tracker.update_session!
+          Sojourn::Event.delete_all
+          tracker.sojourning!
+        end
+
+        it { is_expected.to be_nil }
+      end
+
+      context 'when user changes' do
+        before do
+          tracker.update_session!
+          Sojourn::Event.delete_all
+          ctx.current_user = Mocks::User.new
+          tracker.sojourning!
+        end
+
+        its(:name) { is_expected.to eq('!logged_in') }
+      end
+
+      context 'when user logs out' do
+        before do
+          tracker.update_session!
+          Sojourn::Event.delete_all
+          ctx.current_user = nil
+          tracker.sojourning!
+        end
+
+        its(:name) { is_expected.to eq('!logged_out') }
+      end
+    end
+
+    describe 'update_session!' do
+      subject { cookies }
+
+      context 'before' do
+        its([COOKIE_NAME]) { is_expected.to be_nil }
+      end
+
+      context 'after running' do
+        before { tracker.update_session! }
+
+        its([COOKIE_NAME, :uuid]) { is_expected.to_not be_nil }
+        its([COOKIE_NAME, :user_id]) { is_expected.to eq(user.id) }
+
+        context 'with existing cookie' do
+          let(:sojourner_uuid) { SecureRandom.uuid }
+          let(:cookie_data) { { user_id: user.id, uuid: sojourner_uuid } }
+          let(:cookies) { Mocks::Cookie[{ COOKIE_NAME => cookie_data }] }
+
+          its([COOKIE_NAME, :uuid]) { is_expected.to eq(sojourner_uuid) }
+          its([COOKIE_NAME, :user_id]) { is_expected.to eq(user.id) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sojourn
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Smudge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
   name: browser
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: referer-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: " Sojourn tracks site visitors and sources, with the ability to recognise
   multiple sources per visitor. Each time a new source is detected, sojourn tracks
   the referer, utm data, and logged-in user (if any)"
@@ -75,28 +159,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - lib/generators/sojourn/install_generator.rb
 - lib/generators/sojourn/templates/config_initializer.rb
-- lib/generators/sojourn/templates/create_sojourn_browsers.rb
-- lib/generators/sojourn/templates/create_sojourn_campaigns.rb
 - lib/generators/sojourn/templates/create_sojourn_events.rb
-- lib/generators/sojourn/templates/create_sojourn_requests.rb
 - lib/sojourn.rb
-- lib/sojourn/browser.rb
-- lib/sojourn/campaign.rb
 - lib/sojourn/configuration.rb
 - lib/sojourn/controller.rb
 - lib/sojourn/event.rb
 - lib/sojourn/request.rb
-- lib/sojourn/serializers/symbol.rb
+- lib/sojourn/serializers/indifferent_json.rb
 - lib/sojourn/session_stores/cookie.rb
 - lib/sojourn/tracker.rb
 - lib/sojourn/version.rb
 - sojourn.gemspec
+- spec/mocks/controller.rb
+- spec/mocks/cookie.rb
+- spec/mocks/request.rb
+- spec/mocks/user.rb
+- spec/spec_helper.rb
+- spec/tracker_spec.rb
 homepage: ''
 licenses:
 - ''
@@ -117,9 +205,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Simple user source tracking for Rails.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/mocks/controller.rb
+- spec/mocks/cookie.rb
+- spec/mocks/request.rb
+- spec/mocks/user.rb
+- spec/spec_helper.rb
+- spec/tracker_spec.rb

data/lib/generators/sojourn/templates/create_sojourn_browsers.rb

@@ -1,13 +0,0 @@
-class CreateSojournBrowsers < ActiveRecord::Migration
-  def change
-    create_table :sojourn_browsers do |t|
-      t.text :user_agent, unique: true
-      t.string :name
-      t.string :version
-      t.string :platform
-      t.boolean :known
-      t.boolean :bot
-    end
-    add_index :sojourn_browsers, [:user_agent]
-  end
-end

data/lib/generators/sojourn/templates/create_sojourn_campaigns.rb

@@ -1,10 +0,0 @@
-class CreateSojournCampaigns < ActiveRecord::Migration
-  def change
-    create_table :sojourn_campaigns do |t|
-      t.string :path, limit: 2048
-      t.string :params, limit: 2048
-      t.timestamp :created_at
-    end
-    add_index :sojourn_campaigns, [:path, :params]
-  end
-end

data/lib/generators/sojourn/templates/create_sojourn_requests.rb

@@ -1,19 +0,0 @@
-class CreateSojournRequests < ActiveRecord::Migration
-  def change
-    create_table :sojourn_requests do |t|
-      t.references :sojourn_campaign
-      t.references :sojourn_browser
-      t.string :host, limit: 2048
-      t.string :path, limit: 2048
-      t.string :method
-      t.string :controller
-      t.string :action
-      t.string :ip_address
-      t.text :params
-      t.text :referer
-      t.timestamp :created_at
-    end
-    add_index :sojourn_requests, [:sojourn_campaign_id]
-    add_index :sojourn_requests, [:sojourn_browser_id]
-  end
-end

data/lib/sojourn/browser.rb

@@ -1,27 +0,0 @@
-require 'browser'
-
-module Sojourn
-  class Browser < ActiveRecord::Base
-    has_many :requests, foreign_key: :sojourn_browser_id
-    has_many :events, through: :requests
-
-    def self.from_request(request)
-      where(user_agent: request.user_agent).first_or_initialize
-    end
-
-    before_validation do
-      self.name ||= browser.name
-      self.version ||= browser.version
-      self.platform ||= browser.platform
-      self.known ||= browser.known?
-      self.bot ||= browser.bot?
-      true # otherwise .valid? will return false
-    end
-
-  private
-
-    def browser
-      @browser ||= ::Browser.new(user_agent: user_agent)
-    end
-  end
-end

data/lib/sojourn/campaign.rb

@@ -1,27 +0,0 @@
-module Sojourn
-  class Campaign < ActiveRecord::Base
-
-    has_many :requests, foreign_key: :sojourn_campaign_id
-    has_many :events, through: :requests
-
-    class << self
-
-      def from_request(request)
-        return unless (params = tracked_params(request.params)).any?
-        where(path: request.path.downcase.try(:truncate, 2048))
-          .where(params: params.to_param.try(:truncate, 2048)).first_or_initialize
-      end
-
-    private
-
-      def tracked_params(params)
-        Hash[filter_params(params).sort.map { |k, v| [k.downcase, v.downcase] }]
-      end
-
-      def filter_params(params)
-        params.slice(*Sojourn.config.campaign_params).delete_if { |_, v| v.blank? }
-      end
-
-    end
-  end
-end

data/lib/sojourn/serializers/symbol.rb

@@ -1,13 +0,0 @@
-module Sojourn
-  module Serializers
-    class Symbol
-      def self.load(string)
-        string.to_sym
-      end
-
-      def self.dump(symbol)
-        symbol.to_s
-      end
-    end
-  end
-end