ahoy_matey 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8ac2f7e33c48f8b761a8ffee2ae5cd715e52849
-  data.tar.gz: 7d069547085fb036b792492826c7a1fb81363367
+  metadata.gz: 5e7ae0f31293a7769778587395e0bd568e61f6f7
+  data.tar.gz: 8b941ee921205a3fd192b520934f7e57fb3ead7c
 SHA512:
-  metadata.gz: 301bf689ed83f0f44a5c13cc4c1a53707e7ee5fbf7fe53936d560224a647c6d379be3c67834f15d5ec855d0f80081bd37dd4c6db4b9ab573c5ce3661902fb91c
-  data.tar.gz: 3a3016d19a6f00750362bcd9a36992cb04b673bc77832c752cd4ea1fdc065e4faff8f06c38dbb628a9c078c291a0989cc15140966465a453708a572b42d4a31f
+  metadata.gz: e6d0bae8709e973024253730e1a95479e6effefca95356b89d88e0019f69eefa2b7eeb8a3ea194e9ef75f80e3011dd64e021f4b82fbba0bc7adea1738e81a212
+  data.tar.gz: 04abbb97db3428069c283284b07168188e69e98babd8e95eb93245a49da42ea753b46b91aa32d1d5a0f0867dcc5438f4fc93b22681d927326a7b38a1c53c329e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.1.3
+
+- Supports `current_user` from `ApplicationController`
+- Added `ahoy.reset()`
+- Added `ahoy.debug()`
+- Added experimental support for native apps
+- Prefer `ahoy` over `Ahoy`
+
 ## 0.1.2
 
 - Attach user on Devise sign up

data/README.md

@@ -17,6 +17,30 @@ See which campaigns generate the most revenue effortlessly.
 Order.joins(:visit).group("utm_campaign").sum(:revenue)
 ```
 
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'ahoy_matey'
+```
+
+And run the generator. This creates a model to store visits.
+
+```sh
+rails generate ahoy:install
+rake db:migrate
+```
+
+Lastly, include the javascript file in `app/assets/javascripts/application.js` after jQuery.
+
+```javascript
+//= require jquery
+//= require ahoy
+```
+
+We recommend using traditional analytics services like [Google Analytics](http://www.google.com/analytics/) as well.
+
 ## How It Works
 
 When someone visits your website, Ahoy creates a visit with lots of useful information.
@@ -65,13 +89,15 @@ Order.joins(:visit).group("device_type").count
 
 Ahoy automatically attaches the `current_user` to the `current_visit`.
 
+If you define your own `current_user` method, be sure to add it to `ActionController::Base`, not `ApplicationController`.
+
 With [Devise](https://github.com/plataformatec/devise), it will attach the user even if he / she signs in after the visit starts.
 
 With other authentication frameworks, add this to the end of your sign in method:
 
 ```ruby
-if current_visit
-  current_visit.user ||= current_user
+if current_visit and !current_visit.user
+  current_visit.user = current_user
   current_visit.save!
 end
 ```
@@ -109,45 +135,64 @@ http://datakick.org/?utm_medium=twitter&utm_campaign=social&utm_source=tweet123
 
 Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for IP-based geocoding.
 
-### Multiple Subdomains [master]
+### Multiple Subdomains
 
-To track visits across multiple subdomains, add this to your layout **before** the javascript files.
+To track visits across multiple subdomains, add this **before** the javascript files.
 
-```html
-<script>
-  var Ahoy = {"domain": "yourdomain.com"};
-</script>
+```javascript
+var ahoy = {"domain": "yourdomain.com"};
 ```
 
-### More
-
-- Excludes bots
-- Degrades gracefully when cookies are disabled
-- Don’t need a field? Just remove it from the migration
+### Development
 
-## Installation
+Ahoy is built with developers in mind.  You can run the following code in your browser’s console.
 
-Add this line to your application’s Gemfile:
+Force a new visit
 
-```ruby
-gem 'ahoy_matey'
+```javascript
+ahoy.reset(); // then reload the page
 ```
 
-And run the generator. This creates a model to store visits.
+Log messages
 
-```sh
-rails generate ahoy:install
-rake db:migrate
+```javascript
+ahoy.debug();
 ```
 
-Lastly, include the javascript file in `app/assets/javascripts/application.js` after jQuery.
+Turn off logging
 
 ```javascript
-//= require jquery
-//= require ahoy
+ahoy.debug(false);
 ```
 
-We recommend using traditional analytics services like [Google Analytics](http://www.google.com/analytics/) as well.
+### Native Apps [experimental]
+
+When a user launches the app, create a visit.  Send a `POST` request to `/ahoy/visits` with:
+
+- platform - `iOS`, `Android`, etc.
+- app_version - `1.0.0`
+- os_version - `7.0.6`
+- visitor_token - if you have one
+
+The endpoint will return a JSON response like:
+
+```json
+{
+  "visit_token": "8tx2ziymkwa1WlppnkqxyaBaRlXrEQ3K",
+  "visitor_token": "hYBIV0rBfrIUAiArWweiECt4N9pyiygN"
+}
+```
+
+Send the visit token in the `Ahoy-Visit` header for all requests.
+
+After 4 hours, create another visit and use the updated visit token.
+
+### More
+
+- Excludes bots
+- Degrades gracefully when cookies are disabled
+- Don’t need a field? Just remove it from the migration
+- Visits are 4 hours by default
 
 ## Reference
 
@@ -157,6 +202,12 @@ Use a different model
 Ahoy.visit_model = UserVisit
 ```
 
+Change the platform on the web
+
+```javascript
+var ahoy = {"platform": "Mobile Web"}
+```
+
 ## TODO
 
 - simple dashboard

data/app/controllers/ahoy/visits_controller.rb

@@ -1,25 +1,38 @@
 module Ahoy
-  class VisitsController < ActionController::Base
+  class VisitsController < ApplicationController
+    # skip all filters
+    skip_filter *_process_action_callbacks.map(&:filter)
+
     before_filter :halt_bots
 
     def create
+      visit_token = generate_token
+      visitor_token = params[:visitor_token] || generate_token
+
       visit =
         Ahoy.visit_model.new do |v|
-          v.visit_token = params[:visit_token]
-          v.visitor_token = params[:visitor_token]
+          v.visit_token = visit_token
+          v.visitor_token = visitor_token
           v.ip = request.remote_ip if v.respond_to?(:ip=)
           v.user_agent = request.user_agent if v.respond_to?(:user_agent=)
           v.referrer = params[:referrer] if v.respond_to?(:referrer=)
           v.landing_page = params[:landing_page] if v.respond_to?(:landing_page=)
           v.user = current_user if respond_to?(:current_user) and v.respond_to?(:user=)
+          v.platform = params[:platform] if v.respond_to?(:platform=)
+          v.app_version = params[:app_version] if v.respond_to?(:app_version=)
+          v.os_version = params[:os_version] if v.respond_to?(:os_version=)
         end
 
       visit.save!
-      render json: {id: visit.id}
+      render json: {visit_token: visit.visit_token, visitor_token: visit.visitor_token}
     end
 
     protected
 
+    def generate_token
+      SecureRandom.urlsafe_base64(32).gsub(/[\-_]/, "").first(32)
+    end
+
     def browser
       @browser ||= Browser.new(ua: request.user_agent)
     end

data/lib/ahoy/controller.rb

@@ -11,8 +11,9 @@ module Ahoy
     protected
 
     def current_visit
-      if cookies[:ahoy_visit]
-        @current_visit ||= Ahoy.visit_model.where(visit_token: cookies[:ahoy_visit]).first
+      visit_token = cookies[:ahoy_visit] || request.headers["Ahoy-Visit"]
+      if visit_token
+        @current_visit ||= Ahoy.visit_model.where(visit_token: visit_token).first
       end
     end
 

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/ahoy_matey.rb

@@ -31,10 +31,11 @@ ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)
 
 if defined?(Warden)
   Warden::Manager.after_set_user except: :fetch do |user, auth, opts|
-    request = Rack::Request.new(auth.env)
-    if request.cookies["ahoy_visit"]
-      visit = Ahoy.visit_model.where(visit_token: request.cookies["ahoy_visit"]).first
-      if visit
+    request = ActionDispatch::Request.new(auth.env)
+    visit_token = request.cookies["ahoy_visit"] || request.headers["Ahoy-Visit"]
+    if visit_token
+      visit = Ahoy.visit_model.where(visit_token: visit_token).first
+      if visit and !visit.user
         visit.user = user
         visit.save!
       end

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

@@ -39,6 +39,11 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.string :utm_content
       t.string :utm_campaign
 
+      # native apps
+      # t.string :platform
+      # t.string :app_version
+      # t.string :os_version
+
       t.timestamp :created_at
     end
 

data/vendor/assets/javascripts/ahoy.js

@@ -3,24 +3,16 @@
 (function (window) {
   "use strict";
 
-  var debugMode = false;
-  var options = window.Ahoy || {};
+  var ahoy = window.ahoy || window.Ahoy || {};
   var $ = window.jQuery || window.Zepto || window.$;
   var visitToken, visitorToken;
-  var visitTtl, visitorTtl;
-
-  if (debugMode) {
-    visitTtl = 0.2;
-    visitorTtl = 5; // 5 minutes
-  } else {
-    visitTtl = 4 * 60; // 4 hours
-    visitorTtl = 2 * 365 * 24 * 60; // 2 years
-  }
+  var visitTtl = 4 * 60; // 4 hours
+  var visitorTtl = 2 * 365 * 24 * 60; // 2 years
 
   // cookies
 
   // http://www.quirksmode.org/js/cookies.html
-  function setCookie(name, value, ttl, domain) {
+  function setCookie(name, value, ttl) {
     var expires = "";
     var cookieDomain = "";
     if (ttl) {
@@ -28,8 +20,8 @@
       date.setTime(date.getTime() + (ttl * 60 * 1000));
       expires = "; expires=" + date.toGMTString();
     }
-    if (domain) {
-      cookieDomain = "; domain=" + domain;
+    if (ahoy.domain) {
+      cookieDomain = "; domain=" + ahoy.domain;
     }
     document.cookie = name + "=" + value + expires + cookieDomain + "; path=/";
   }
@@ -50,26 +42,13 @@
     return null;
   }
 
-  // ids
-
-  // https://github.com/klughammer/node-randomstring
-  function generateToken() {
-    var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghiklmnopqrstuvwxyz';
-    var length = 32;
-    var string = '';
-    var i, randomNumber;
-
-    for (i = 0; i < length; i++) {
-      randomNumber = Math.floor(Math.random() * chars.length);
-      string += chars.substring(randomNumber, randomNumber + 1);
-    }
-
-    return string;
+  function destroyCookie(name) {
+    setCookie(name, "", -1);
   }
 
-  function debug(message) {
-    if (debugMode) {
-      window.console.log(message, visitToken, visitorToken);
+  function log(message) {
+    if (getCookie("ahoy_debug")) {
+      window.console.log(message);
     }
   }
 
@@ -78,26 +57,18 @@
   visitToken = getCookie("ahoy_visit");
   visitorToken = getCookie("ahoy_visitor");
 
-  if (visitToken && visitorToken) {
+  if (visitToken && visitorToken && visitToken != "test") {
     // TODO keep visit alive?
-    debug("Active visit");
+    log("Active visit");
   } else {
-    if (!visitorToken) {
-      visitorToken = generateToken();
-      setCookie("ahoy_visitor", visitorToken, visitorTtl, options.domain);
-    }
-
-    // always generate a new visit id here
-    visitToken = generateToken();
-    setCookie("ahoy_visit", visitToken, visitTtl, options.domain);
+    setCookie("ahoy_visit", "test", 1);
 
     // make sure cookies are enabled
     if (getCookie("ahoy_visit")) {
-      debug("Visit started");
+      log("Visit started");
 
       var data = {
-        visit_token: visitToken,
-        visitor_token: visitorToken,
+        platform: ahoy.platform || "Web",
         landing_page: window.location.href
       };
 
@@ -106,12 +77,35 @@
         data.referrer = document.referrer;
       }
 
-      debug(data);
+      if (visitorToken) {
+        data.visitor_token = visitorToken;
+      }
+
+      log(data);
 
-      $.post("/ahoy/visits", data);
+      $.post("/ahoy/visits", data, function(response) {
+        setCookie("ahoy_visit", response.visit_token, visitTtl);
+        setCookie("ahoy_visitor", response.visitor_token, visitorTtl);
+      }, "json");
     } else {
-      debug("Cookies disabled");
+      log("Cookies disabled");
     }
   }
 
+  ahoy.reset = function () {
+    destroyCookie("ahoy_visit");
+    destroyCookie("ahoy_visitor");
+    return true;
+  };
+
+  ahoy.debug = function (enabled) {
+    if (enabled === false) {
+      destroyCookie("ahoy_debug");
+    } else {
+      setCookie("ahoy_debug", "t", 365 * 24 * 60); // 1 year
+    }
+    return true;
+  };
+
+  window.ahoy = ahoy;
 }(window));

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable