sojourn 0.1.1 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f2ae69a242be094ed09f87d8721b0b12c7369a4
-  data.tar.gz: 16deb25d1a1598c08cd96162a59ec25a344fde88
+  metadata.gz: 9caf4fdd9129f3391d00292849ea95096e2e7bb8
+  data.tar.gz: 3cae47fe7eea5430c668cb8d63993ab9eca5a89f
 SHA512:
-  metadata.gz: 99a18bf20addc6f178c68b9fc96a990c512ef6c1839c54755dc523327c77984dafedff591a122da996e536e030de6e247800f3643f00b9425c937c22770d7788
-  data.tar.gz: dc459a98a2a177b53aacebfd400b37853ad61c6da727ed48713884d1f7960c90146e7c362211391a551472aed00389038204920da5724ce5f9f2cc7d0ad7618b
+  metadata.gz: cb52529bf9c8f7623ad5e35ace62dc89933c7c11b086a39241d92b98bfaebf4fc1d7de7f4b62f009f107fce7e8cad8d8c1548bbbdc31b61b6b5b8d1a581b6567
+  data.tar.gz: 6db0dd0268c3fd39d40340b6e9254b436f367f03bfb013259c80920e445b239adc4e2db329b76cd11e362153d1ef78de43b3545ee472a781170b53dce192ade3

data/.gitignore

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

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# Sojourn
 
 Simple source & event tracking for Rails. This gem automatically tracks *sojourners*
 (i.e. unique visitors) based on:
@@ -11,22 +11,18 @@ Simple source & event tracking for Rails. This gem automatically tracks *sojourn
 
 ## How It Works
 
-Whenever a new visitor ("sojourner") arrives to the site, an event is tracked containing
-basic data about their browser and where they came from. Similar events are also tracked
-whenever a user logs in, logs out, or visits again from an external site. In addition,
-you can track a custom event anytime a visitor does something of interest to you.
+**Everything is tracked in the form of events.** Yep, events all the way down.
+(See 'Why Events?' below for the reasoning behind this.)
 
-Ultimately, rather than storing parts of the data in separate tables, **all data is
-tracked in the form of events.** Yep, events all the way down. (See 'Why Events?' below
-for the reasoning behind this.)
+Sojourn assigns each *sojourner* a UUID, which is tracked across requests. All events are
+associated with this UUID and with the current user's ID (if logged-in).
 
-Sojourn assigns each "sojourner" a UUID, which is tracked across requests. All events are
-associated with this UUID and with the current user's ID (if logged-in). The current
-request is also assigned a UUID (which defaults to the `X-Request-ID` header).
+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.
 
-Events consist of an event name (defining a collection of events), a session UUID,
-and a set of properties (key-value data) which includes information about the request.
-In the PostgreSQL implementation, we use a `JSONB` column to store the key-value data.
 
 ## Usage
 
@@ -34,16 +30,37 @@ In the PostgreSQL implementation, we use a `JSONB` column to store the key-value
 # Track a custom event (highly encouraged!):
 sojourn.track! 'clicked call-to-action', plan_choice: 'enterprise'
 
-# 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.)
 
-# 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'
 ```
 
 ## Default Events
@@ -56,7 +73,7 @@ The three built-in events are as follows:
 '!logged_out' # The sojourner has logged-out.
 ```
 
-A `'!sojourning'` event takes place whenever any of the following conditions is met:
+A `'!sojourning'` event takes place whenever any of the following is true:
 
 * The sojourner has never been seen before (i.e. direct traffic of some kind)
 * The referer is from an external source (i.e. not the current `request.host`)
@@ -64,42 +81,6 @@ A `'!sojourning'` event takes place whenever any of the following conditions is
   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:
@@ -121,17 +102,10 @@ To install migrations and the `sojourn.rb` initializer, execute:
 The idea is that, at a certain scale, this kind of tracking should be dumped directly into
 append-only logs (or an event bus / messaging queue) for asynchronous processing.
 
-This is made easier when everything can be represented, at a basic level, as a set of discrete
-events. In theory, it works with just about any data store, and makes for easy time series and
-funnel analysis. I'd like to move away from ActiveRecord at some point and open up the door for
-other, more horizontally scalable data backends, ideally with a focus on streaming data (e.g.
-Kafka combined with Samza or Storm).
-
-An added benfit of storing the start of each visit as its own event in the series (i.e. the
-built-in `!sojourning` event) is that you can change the length of your visit window after
-the fact and re-run your analysis. The more traditional approach is to tag each event with
-some kind of incrementing visit ID, which forces you into defining what a "unique visit"
-means for your product before you've even collected any data.
+This is made easier when everything can be represented, at a basic level, as discrete events.
+In theory, it works with just about any data store, and makes for easy time series and funnel
+analysis. I'd like to move away from ActiveRecord at some point and open up the door for other,
+highly scalable data backends.
 
 ## Current Limitations (i.e. the 'todo' list)
 
@@ -141,3 +115,4 @@ means for your product before you've even collected any data.
   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,9 +1 @@
 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(events).map { |m| "create_sojourn_#{m}" }.each do |name|
+        %w(campaigns browsers requests 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_browsers.rb

@@ -0,0 +1,13 @@
+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

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

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

@@ -4,10 +4,12 @@ class CreateSojournEvents < ActiveRecord::Migration
       t.string :sojourner_uuid, limit: 36, null: false
       t.string :name
       t.column :properties, :jsonb
+      t.references :sojourn_request
       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/generators/sojourn/templates/create_sojourn_requests.rb

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,16 @@
+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 (request.tracked_params).any?
+        where(params: request.tracked_params.to_param.try(:truncate, 2048)).first_or_initialize
+      end
+
+    end
+  end
+end

data/lib/sojourn/configuration.rb

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

data/lib/sojourn/controller.rb

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

data/lib/sojourn/event.rb

@@ -2,9 +2,12 @@ require_relative 'serializers/indifferent_json'
 
 module Sojourn
   class Event < ActiveRecord::Base
-    DEFAULT_FIELDS = %i(id sojourner_uuid name properties user_id created_at)
+    DEFAULT_FIELDS = [:id, :sojourner_uuid, :name, :properties, :sojourn_request_id, :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, Serializers::IndifferentJSON
 

data/lib/sojourn/request.rb

@@ -1,20 +1,38 @@
-require 'securerandom'
+require_relative 'campaign'
+require_relative 'browser'
+require_relative 'serializers/symbol'
 require 'addressable/uri'
-require 'browser'
-require 'referer-parser'
 
 module Sojourn
-  class Request
-    KEYS = %w(uuid referer host path controller action params method ip_address user_agent)
+  class Request < ActiveRecord::Base
+    attr_accessor :user_agent
 
-    attr_reader :request
+    serialize :method, Serializers::Symbol
+    serialize :params
 
-    def initialize(request)
-      @request = 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 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
+    end
+
+    before_validation do
+      self.campaign ||= Campaign.from_request(self)
+      self.browser ||= Browser.from_request(self) if user_agent
     end
 
     def outside_referer?
-      referer.present? && referer_host != host
+      referer.present? && Addressable::URI.parse(referer).host != host
     end
 
     def any_utm_data?
@@ -25,90 +43,20 @@ module Sojourn
       Hash[downcased_params.slice(*tracked_param_keys).delete_if { |_, v| v.blank? }.sort]
     end
 
-    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 = { known: false } unless browser
-      @browser_data ||= {
-        name: browser.name,
-        version: browser.version,
-        platform: browser.platform,
-        bot: browser.bot?,
-        known: browser.known?
+      b = browser.try(:send, :browser) || ::Browser.new(user_agent: user_agent)
+      @browser_data = {
+        name: b.name,
+        version: b.version,
+        platform: b.platform,
+        bot: b.bot?,
+        known: b.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
@@ -116,9 +64,5 @@ module Sojourn
     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/symbol.rb

@@ -0,0 +1,13 @@
+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

data/lib/sojourn/session_stores/cookie.rb

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

data/lib/sojourn/tracker.rb

@@ -13,7 +13,8 @@ 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,
+      Event.reset_column_information if Event.columns_hash['properties'].type != :jsonb
+      Event.create! sojourner_uuid: sojourner_uuid, name: event_name, request: request,
                     properties: properties, user_id: user_id
     end
 
@@ -37,7 +38,7 @@ module Sojourn
   private
 
     def request
-      @request ||= Request.new(ctx.request)
+      @request ||= Request.from_request(ctx.request)
     end
 
     def session
@@ -70,10 +71,8 @@ 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!(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.1.1'
+  VERSION = '1.0.0.pre'
 end

data/lib/sojourn.rb

@@ -16,7 +16,7 @@ module Sojourn
   end
 
   def self.tables_exist?
-    @tables_exist ||= %w(sojourn_events sojourn_requests)
+    @tables_exist ||= %w(sojourn_events sojourn_requests sojourn_browsers sojourn_campaigns)
                       .map { |t| ActiveRecord::Base.connection.table_exists?(t) }.all?
   end
 

data/sojourn.gemspec

@@ -22,13 +22,7 @@ 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

metadata

@@ -1,190 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: sojourn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Smudge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !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
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !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
+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)"
+  the referer, utm data, and logged-in user (if any)'
 email:
 - nathan@ngriffith.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
 - 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/indifferent_json.rb
+- lib/sojourn/serializers/symbol.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:
 - ''
@@ -195,24 +108,18 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Simple user source tracking for Rails.
-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
+test_files: []

data/.codeclimate.yml

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

data/.rubocop.yml

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

data/.travis.yml

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

data/spec/mocks/controller.rb

@@ -1,15 +0,0 @@
-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

@@ -1,30 +0,0 @@
-# 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

@@ -1,56 +0,0 @@
-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.key?(:user_agent) ? opts[:user_agent] : CHROME_UA
-    end
-  end
-end

data/spec/mocks/user.rb

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

data/spec/spec_helper.rb

@@ -1,47 +0,0 @@
-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

@@ -1,110 +0,0 @@
-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 'properties' do
-        subject { Event.last.properties }
-
-        its(:keys) { is_expected.to eq(%w(request browser bar)) }
-        its([:request, :params]) { is_expected.to eq('filtered' => true) }
-        its([:request, :method]) { is_expected.to eq('get') }
-        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
-
-      context 'when user agent not present' do
-        let(:request) { Mocks::Request.new(user_agent: nil) }
-
-        its(:name) { is_expected.to eq('!sojourning') }
-
-        describe 'properties' do
-          subject { Event.last.properties }
-
-          its([:browser, :known]) { is_expected.to be(false) }
-          its([:browser, :name]) { is_expected.to be_nil }
-        end
-      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