universal-track-manager 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 253af979db440458ba5a3f941ea9b84c9994533d41235537fc35d627dfa5f79c
-  data.tar.gz: 37af0fad8dc0046c0299646f6c67881b535862c62a41da3df0f85acf9b80113c
+  metadata.gz: 54c410242cd15acf4c1d221e8baa171aaf3742004452b3571d947b4569f152a5
+  data.tar.gz: b27f33e20d3d020094213b51082ada41bd7af8594167b9c4682381e900036b12
 SHA512:
-  metadata.gz: '0707199623e18dea70620ee4039b7600bb95a397a6f7267675a793179dde8d55f15ee93019e7a50656fbb340af6c791d2730719fc5fd08ecd9b40f55edc1bb9d'
-  data.tar.gz: f4cb6880d671e27b82ae99d1f5c2c17baf05f62e0f1b22c5fd9540ceaf43a14e4ae894862bd91001c2303f4d4634968f8b58efcb9be3ad80b4010392e3094aa5
+  metadata.gz: 5dc2873c890a7910625bd2b3106c23ead3c46392b01df7e890823069f714fda4bf7e61f95472a5c3cdb6e9ebca0306d5d3ea966aff885316ff6a9c408c2da8b6
+  data.tar.gz: d73313e68338e89885a43347867c063809b3663aa89d8a344819f54190f61b1f5c7dac6a6eac4ea274a36d53511a75b5c91f1cca0c578fcd6a7870244a1e5fc8

data/lib/generators/templates/create_universal_track_manager_tables.rb

@@ -0,0 +1,45 @@
+class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    ActiveRecord::Base.transaction do
+
+      create_table :browsers do |t|
+        # this table gets automatically populated by inbound traffic
+        t.string :browser_name, size: 255
+      end
+
+      add_index :browsers, :browser_name
+
+      create_table :campaigns do |t|
+        # this table gets automatically populated by inbound traffic
+        t.string :utm_source, limit: 50
+        t.string :utm_medium, limit: 50
+        t.string :utm_campaign, limit: 50
+        t.string :utm_content, limit: 50
+        t.string :utm_term, limit: 50
+        t.timestamps
+      end
+
+      add_index :campaigns, [:utm_source, :utm_medium, :utm_campaign, :utm_content, :utm_term], name: "utm_all_combined"
+
+      create_table :visits do |t|
+        t.datetime :first_pageload
+        t.datetime :last_pageload
+        t.integer :original_visit_id
+        t.integer :campaign_id
+        t.integer :browser_id
+        t.string :ip_v4_address, length: 15
+
+        t.integer :viewport_width
+        t.integer :viewport_height
+      end
+    end
+  end
+
+  def self.down
+    ActiveRecord::Base.transaction do
+      drop_table :browsers
+      drop_table :visits
+      drop_table :campaigns
+    end
+  end
+end

data/lib/generators/universal_track_manager/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+module UniversalTrackManager
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Creates a UTM initializer and copy locale files to your application."
+
+    source_root File.expand_path('../templates', __dir__)
+
+
+    class_option :orm, type: 'boolean'
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    desc "Creates an initializer for Universal Track Manager and copy files to your application."
+    def copy_initializer
+      migration_template "create_universal_track_manager_tables.rb",  "db/migrate/create_universal_track_manager_tables.rb"
+    end
+
+    def migration_version
+      "[#{ActiveRecord::Migration.current_version}]" if ActiveRecord::Migration.respond_to?(:current_version)
+    end
+  end
+end
+
+

data/lib/railtie.rb

@@ -0,0 +1,7 @@
+# module UniversalTrackManager
+#   class Railtie < Rails::Railtie
+#     rake_tasks do
+#       require 'universal_track_manager/install_generator.rb'
+#     end
+#   end
+# end

data/lib/universal-track-manager.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift __dir__
+
+def require_all(path)
+  pattern = File.join(__dir__, path, "*.rb")
+  Dir.glob(pattern).sort.each do |f|
+    require f
+  end
+end
+
+
+# require_all("generators/templates")
+
+require_all("generators/universal_track_manager")
+require_all("universal_track_manager/controllers/concerns")
+require_all("universal_track_manager/models")
+
+module UniversalTrackManager
+  require "railtie.rb" if defined?(Rails)
+end
+
+

data/lib/universal_track_manager/base.rb

@@ -0,0 +1,7 @@
+module UniversalTrackManager
+  def self.config(options)
+    # set the config options
+    
+    
+  end
+end

data/lib/universal_track_manager/controllers/concerns/universal_track_manager_concern.rb

@@ -0,0 +1,82 @@
+module UniversalTrackManagerConcern
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :track_visitor
+  end
+
+  def permitted_utm_params
+    params.permit(:utm_campaign, :utm_source, :utm_term, :utm_content, :utm_medium)
+  end
+
+
+  def ip_address
+    request.ip
+  end
+
+  def user_agent
+    request.user_agent[0..255]
+  end
+
+
+  def utm_campaign
+    permitted_utm_params[:utm_campaign]
+  end
+
+  def utm_source
+    permitted_utm_params[:utm_source]
+  end
+
+  def utm_term
+    permitted_utm_params[:utm_term]
+  end
+
+  def utm_content
+    permitted_utm_params[:utm_content]
+  end
+
+  def utm_medium
+    permitted_utm_params[:utm_medium]
+  end
+
+  def track_visitor
+    if !session['visit_id']
+
+      visit = UniversalTrackManager::Visit.create!(ip_v4_address: ip_address,
+                                                   browser: find_or_create_browser_by_current,
+                                                   campaign: find_or_create_campaign_by_current)
+
+      session[:visit_id] = visit.id
+    else
+      # existing visit, maybe
+      existing_visit = UniversalTrackManager::Visit.find(session['visit_id'])
+
+      evict_visit!(existing_visit) if existing_visit.ip_v4_address != ip_address
+      evict_visit!(existing_visit) if existing_visit.browser.browser_name != user_agent
+    end
+  end
+
+  def find_or_create_browser_by_current
+    browser = UniversalTrackManager::Browser.find_or_create_by(browser_name: user_agent)
+  end
+
+  def find_or_create_campaign_by_current
+    campaign = UniversalTrackManager::Campaign.find_or_create_by(
+      utm_campaign: utm_campaign,
+      utm_source: utm_source,
+      utm_term: utm_term,
+      utm_content: utm_content,
+      utm_medium: utm_medium
+    )
+  end
+
+  def evict_visit!(old_visit)
+    visit = UniversalTrackManager::Visit.create!(
+              original_visit_id: old_visit.original_visit_id.nil? ?  old_visit.id : old_visit.original_visit_id,
+              ip_v4_address: ip_address,
+              browser: find_or_create_browser_by_current,
+              campaign: find_or_create_campaign_by_current)
+
+    session[:visit_id] = visit.id
+  end
+end

data/lib/universal_track_manager/models/browser.rb

@@ -0,0 +1,4 @@
+class UniversalTrackManager::Browser < ActiveRecord::Base
+  self.table_name = "browsers"
+  
+end

data/lib/universal_track_manager/models/campaign.rb

@@ -0,0 +1,4 @@
+class UniversalTrackManager::Campaign < ActiveRecord::Base
+  self.table_name = "campaigns"
+
+end

data/lib/universal_track_manager/models/visit.rb

@@ -0,0 +1,6 @@
+class UniversalTrackManager::Visit < ActiveRecord::Base
+  self.table_name = "visits"
+
+  belongs_to :campaign, class_name: "UniversalTrackManager::Campaign"
+  belongs_to :browser, class_name: "UniversalTrackManager::Browser"
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module UniversalTrackManager
+  VERSION = "0.0.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: universal-track-manager
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
@@ -9,20 +9,77 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-11-19 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: See https://github.com/jasonfb/universal_track_manager
 email: jason.fb@datatravels.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/universal_track_manager.rb
+- lib/generators/templates/create_universal_track_manager_tables.rb
+- lib/generators/universal_track_manager/install_generator.rb
+- lib/railtie.rb
+- lib/universal-track-manager.rb
+- lib/universal_track_manager/base.rb
+- lib/universal_track_manager/controllers/concerns/universal_track_manager_concern.rb
+- lib/universal_track_manager/models/browser.rb
+- lib/universal_track_manager/models/campaign.rb
+- lib/universal_track_manager/models/visit.rb
+- lib/version.rb
 homepage: http://rubygems.org/gems/unverisal-track-manager
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/jasonfb/universal_track_manager
-post_install_message: 
+post_install_message: |
+  ---------------------------------------------
+  Welcome to Universal Track Manager
+  to set up, please run
+
+  rails generate universal_track_manager:install
+  ---------------------------------------------
 rdoc_options: []
 require_paths:
 - lib
@@ -37,8 +94,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
-summary: A gem to track your visitors.
+summary: A gem to track visitors to your website.
 test_files: []

data/lib/universal_track_manager.rb

@@ -1,13 +0,0 @@
-
-
-["generators/**/*", "universal-track-manager/lib/**/*.rb"].each do |x|
-  Dir.glob(File.join(File.dirname(__FILE__), x)) do |c|
-    require(c) 
-  end
-end
-
-module UniversalTrackManager
-  require "railtie.rb" if defined?(Rails)
-end
-
-