ahoy_matey 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7973efa4435f37d54dfa0bd84b7441473a4e3ddf
-  data.tar.gz: 3ceb16b3595ae8b258e63102ae996667652802af
+  metadata.gz: 443dfa85abf63a4f515ea9c6865beb09f77404ab
+  data.tar.gz: 9099a3d7a51f6426f0ebae09fd3d9c831385a1e5
 SHA512:
-  metadata.gz: a16bd0b6d30f134a901d2574bc944d411e049e1a7fcaae46707245a98287013b2e4c26c69eca8fd77cf00394e34bd6576843b62d85fc7d93e92344565e7e58a1
-  data.tar.gz: 6c228da084f4949c9fbd8618b1fdc2a04f83a75402d3f2eadbba954f6f02988b040b223181f4b7a34e5ec6d5e375c218a367ceb3457239966bff877b8b564503
+  metadata.gz: a0967ab9bfbb9fe5a22214d1eb74705edbeede65bdb82a07ecf2982e49a8ce8c74bd22ddfe2b302e16d63d602b1d5058c30322d1b5011879f3fc407dee9e1b37
+  data.tar.gz: b1c10a691345e7078f017eb009b64f17106cb1324bac5432bd85cc4986a18016028c4a917fe58d8e1e664ab958db43989b0097e36666343755c2001c65df199d

data/README.md

@@ -2,7 +2,7 @@
 
 :fire: Simple, powerful visit tracking for Rails
 
-In under a minute, start learning more about your visitors.
+You get:
 
 - traffic source - referrer, referring domain, landing page, search keyword
 - location - country, region, and city
@@ -39,25 +39,49 @@ Lastly, include the javascript file in `app/assets/javascripts/application.js` a
 //= require ahoy
 ```
 
-## What You Get
+## How It Works
 
-When a person visits your website, Ahoy creates a visit with lots of useful information.
+When someone visits your website, Ahoy creates a visit with lots of useful information.
 
 Use the `current_visit` method to access it.
 
-The information is great on it’s own, but super powerful when combined with other models.
+Explore your visits with queries like:
 
-You can store the visit id on any model. For instance, when someone places an order:
+```ruby
+Visit.group(:search_keyword).count
+Visit.group(:country).count
+Visit.group(:referring_domain).count
+```
+
+[Chartkick](http://chartkick.com/) and [Groupdate](https://github.com/ankane/groupdate) make it super easy to visualize the data.
+
+```erb
+<%= line_chart Visit.group_by_day(:created_at).count %>
+```
+
+## The Power
+
+This information is great on its own, but super powerful when combined with other models.
+
+Let’s associate orders with visits.
 
 ```ruby
 class Order < ActiveRecord::Base
-  visitable # needs better name
+  visitable
 end
 ```
 
-The visit_id column will be automatically set. Magic!
+When a visitor places an order, the `visit_id` column will be automatically set. Magic!
 
-When you want to explore where most orders are coming from, you can do a number of queries.
+To see where most of your orders are coming from, create an association:
+
+```ruby
+class Order < ActiveRecord::Base
+  belongs_to :visit
+end
+```
+
+And query away:
 
 ```ruby
 Order.joins(:visit).group("referring_domain").count
@@ -65,18 +89,52 @@ Order.joins(:visit).group("device_type").count
 Order.joins(:visit).group("city").count
 ```
 
+## Users
+
+Ahoy automatically attaches the `current_user` to the `current_visit`.
+
+With [Devise](https://github.com/plataformatec/devise), it will attach the user even if he / she signs in after the visit starts.
+
+To see the visits for a given user, create an association:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :visits
+end
+```
+
+And use:
+
+```ruby
+user = User.first
+user.visits
+```
+
+## Location
+
+Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for IP-based geocoding.
+
+## UTM Parameters
+
+Use UTM Parameters to track campaigns. [This is great for emails and social media](http://www.thunderseo.com/blog/utm-parameters/). Just add them to your links and Ahoy will pick them up.
+
+```
+http://datakick.org/?utm_medium=email&utm_campaign=newsletter&utm_source=newsletter-2014-03
+```
+
+or
+
+```
+http://datakick.org/?utm_medium=twitter&utm_campaign=social&utm_source=tweet123
+```
+
 ## Features
 
 - Excludes bots
 - Degrades gracefully when cookies are disabled
-- Gets campaign from utm_campaign parameter
 
 ## TODO
 
-- better readme
-- model integration
-- update visit when user logs in
-- set visit_id automatically on `visitable` models
 - simple dashboard
 - hook to store additional fields
 - turn off modules

data/ahoy_matey.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "browser", ">= 0.4.0"
   spec.add_dependency "geocoder"
   spec.add_dependency "referer-parser"
+  spec.add_dependency "request_store"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/app/controllers/ahoy/visits_controller.rb

@@ -4,7 +4,7 @@ module Ahoy
 
     def create
       visit =
-        Ahoy::Visit.new do |v|
+        Ahoy.visit_model.new do |v|
           v.visit_token = params[:visit_token]
           v.visitor_token = params[:visitor_token]
           v.ip = request.remote_ip
@@ -14,11 +14,6 @@ module Ahoy
           v.user = current_user if respond_to?(:current_user)
         end
 
-      visit.set_traffic_source
-      visit.set_technology
-      visit.set_location
-      visit.set_utm_parameters
-
       visit.save!
       render json: {id: visit.id}
     end

data/lib/ahoy/controller.rb

@@ -3,13 +3,16 @@ module Ahoy
 
     def self.included(base)
       base.helper_method :current_visit
+      base.before_filter do
+        RequestStore.store[:ahoy_controller] ||= self
+      end
     end
 
     protected
 
     def current_visit
       if cookies[:ahoy_visit]
-        @current_visit ||= Ahoy::Visit.where(visit_token: cookies[:ahoy_visit]).first
+        @current_visit ||= Ahoy.visit_model.where(visit_token: cookies[:ahoy_visit]).first
       end
     end
 

data/lib/ahoy/engine.rb

@@ -0,0 +1,5 @@
+module Ahoy
+  class Engine < ::Rails::Engine
+    isolate_namespace Ahoy
+  end
+end

data/lib/ahoy/model.rb

@@ -0,0 +1,99 @@
+module Ahoy
+  module Model
+
+    def ahoy_visit
+      class_eval do
+
+        belongs_to :user, polymorphic: true
+
+        before_create :set_traffic_source
+        before_create :set_utm_parameters
+        before_create :set_technology
+        before_create :set_location
+
+        def set_traffic_source
+          referring_uri = Addressable::URI.parse(referrer) rescue nil
+          self.referring_domain = referring_uri.try(:host)
+          search_keyword = RefererParser::Referer.new(referrer).search_term rescue nil
+          self.search_keyword = search_keyword.present? ? search_keyword : nil
+        end
+
+        def set_utm_parameters
+          landing_uri = Addressable::URI.parse(landing_page) rescue nil
+          if landing_uri
+            query_values = landing_uri.query_values || {}
+            %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
+              self[name] = query_values[name]
+            end
+          end
+        end
+
+        def set_technology
+          browser = Browser.new(ua: user_agent)
+
+          self.browser = browser.name
+
+          # TODO add more
+          self.os =
+            if browser.android?
+              "Android"
+            elsif browser.ios?
+              "iOS"
+            elsif browser.windows_phone?
+              "Windows Phone"
+            elsif browser.blackberry?
+              "Blackberry"
+            elsif browser.chrome_os?
+              "Chrome OS"
+            elsif browser.mac?
+              "Mac"
+            elsif browser.windows?
+              "Windows"
+            elsif browser.linux?
+              "Linux"
+            end
+
+          self.device_type =
+            if browser.tv?
+              "TV"
+            elsif browser.console?
+              "Console"
+            elsif browser.tablet?
+              "Tablet"
+            elsif browser.mobile?
+              "Mobile"
+            else
+              "Desktop"
+            end
+        end
+
+        def set_location
+          location = Geocoder.search(ip).first rescue nil
+          if location
+            self.country = location.country.presence
+            self.region = location.state.presence
+            self.city = location.city.presence
+          end
+        end
+
+      end # end class_eval
+    end
+
+    def visitable
+      class_eval do
+        belongs_to :visit
+
+        before_create :set_visit
+
+        def set_visit
+          if !self.class.column_names.include?("visit_id")
+            raise "Add a visit_id column to this table to use visitable"
+          else
+            self.visit ||= RequestStore.store[:ahoy_controller].try(:send, :current_visit)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/ahoy_matey.rb

@@ -1,28 +1,33 @@
-require "ahoy/version"
-require "ahoy/controller"
 require "addressable/uri"
 require "browser"
 require "geocoder"
 require "referer-parser"
+require "request_store"
+require "ahoy/version"
+require "ahoy/controller"
+require "ahoy/model"
+require "ahoy/engine"
 
 module Ahoy
-  class Engine < ::Rails::Engine
-    isolate_namespace Ahoy
+
+  def self.visit_model
+    ::Visit
   end
+
 end
 
 ActionController::Base.send :include, Ahoy::Controller
+ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)
 
 if defined?(Warden)
   Warden::Manager.after_authentication do |user, auth, opts|
-    p user
-    p auth.env
-    p opts
     request = Rack::Request.new(auth.env)
     if request.cookies["ahoy_visit"]
-      visit = Ahoy::Visit.where(visit_token: request.cookies["ahoy_visit"]).first
-      visit.user = user
-      visit.save!
+      visit = Ahoy.visit_model.where(visit_token: request.cookies["ahoy_visit"]).first
+      if visit
+        visit.user = user
+        visit.save!
+      end
     end
   end
 end

data/lib/generators/ahoy/install_generator.rb

@@ -24,6 +24,15 @@ module Ahoy
       def copy_migration
         migration_template "install.rb", "db/migrate/install_ahoy.rb"
       end
+
+      def generate_model
+        invoke "active_record:model", ["Visit"], migration: false
+      end
+
+      def inject_ahoy_content
+        inject_into_class "app/models/visit.rb", "Visit", "  ahoy_visit\n"
+      end
+
     end
   end
 end

data/lib/generators/ahoy/templates/install.rb

@@ -1,6 +1,6 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
-    create_table :ahoy_visits do |t|
+    create_table :visits do |t|
       # cookies
       t.string :visit_token
       t.string :visitor_token
@@ -39,7 +39,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.timestamp :created_at
     end
 
-    add_index :ahoy_visits, [:visit_token], unique: true
-    add_index :ahoy_visits, [:user_id, :user_type]
+    add_index :visits, [:visit_token], unique: true
+    add_index :visits, [:user_id, :user_type]
   end
 end

data/vendor/assets/javascripts/ahoy.js

@@ -63,7 +63,9 @@
   }
 
   function debug(message) {
-    window.console.log(message, visitToken, visitorToken);
+    if (debugMode) {
+      window.console.log(message, visitToken, visitorToken);
+    }
   }
 
   // main

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-02 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,9 +122,10 @@ files:
 - Rakefile
 - ahoy_matey.gemspec
 - app/controllers/ahoy/visits_controller.rb
-- app/models/ahoy/visit.rb
 - config/routes.rb
 - lib/ahoy/controller.rb
+- lib/ahoy/engine.rb
+- lib/ahoy/model.rb
 - lib/ahoy/version.rb
 - lib/ahoy_matey.rb
 - lib/generators/ahoy/install_generator.rb
@@ -136,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple, powerful visit tracking for Rails

data/app/models/ahoy/visit.rb

@@ -1,71 +0,0 @@
-module Ahoy
-  class Visit < ActiveRecord::Base
-    belongs_to :user, polymorphic: true
-
-    def set_traffic_source
-      referring_uri = Addressable::URI.parse(referrer) rescue nil
-      self.referring_domain = referring_uri.try(:host)
-      search_keyword = RefererParser::Referer.new(referrer).search_term rescue nil
-      self.search_keyword = search_keyword.present? ? search_keyword : nil
-    end
-
-    def set_utm_parameters
-      landing_uri = Addressable::URI.parse(landing_page) rescue nil
-      if landing_uri
-        query_values = landing_uri.query_values || {}
-        %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
-          self[name] = query_values[name]
-        end
-      end
-    end
-
-    def set_technology
-      browser = Browser.new(ua: user_agent)
-
-      self.browser = browser.name
-
-      # TODO add more
-      self.os =
-        if browser.android?
-          "Android"
-        elsif browser.ios?
-          "iOS"
-        elsif browser.windows_phone?
-          "Windows Phone"
-        elsif browser.blackberry?
-          "Blackberry"
-        elsif browser.chrome_os?
-          "Chrome OS"
-        elsif browser.mac?
-          "Mac"
-        elsif browser.windows?
-          "Windows"
-        elsif browser.linux?
-          "Linux"
-        end
-
-      self.device_type =
-        if browser.tv?
-          "TV"
-        elsif browser.console?
-          "Console"
-        elsif browser.tablet?
-          "Tablet"
-        elsif browser.mobile?
-          "Mobile"
-        else
-          "Desktop"
-        end
-    end
-
-    def set_location
-      location = Geocoder.search(ip).first rescue nil
-      if location
-        self.country = location.country.presence
-        self.region = location.state.presence
-        self.city = location.city.presence
-      end
-    end
-
-  end
-end