ahoy_matey 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65d9ae15e5742baab80cca54630bd9c446dde514ab820c16163bf856c23839e6
-  data.tar.gz: ca4d9f657de0ef24e56334ae11045ccd615012dac032a0c8e42f1acfc2973da4
+  metadata.gz: b7b0851dfc7538c6768d6f694d7e8356f0aef3e3ff66ba361447e000a2db5bac
+  data.tar.gz: c28eb30ab780037d83550d359a36d6790e3a16f60b314b5d0be170d11b3c427b
 SHA512:
-  metadata.gz: 931116ac80eb7774c70fdfeeb4168724fc1608cb1476e9fc7568686d1c523bd4fd3ab5f023249e26b654088136f7004a8d09537d628db8610b23268270b9363a
-  data.tar.gz: 85e15776ffb648e5385658def3525cf0dfc3c8a0d2c1060e5f14af7a50a806c17640bf6741ccc8ed34b8b98b1b3afd3894a534faa539825171b9602ba4279afa
+  metadata.gz: 85fb407054564104efc83ae3d425c6253db7495d6f6d4156c741156f64fcd7fe048035f78e4563bf9ec92c69c7e6dfef41e29f7d1031174705b17c595ef96572
+  data.tar.gz: ff03757afbb0deca1a11dc4ece02310bbd8a03f644f675c2eee32c1bf7711013f0cd38eb0fd009541b97b3a5b914a756279e88dbe0cbc8a8bd14ed064d648089

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.2.1
+
+- Updated Ahoy.js to 0.3.4
+- Fixed v2 bot detection
+- Added latitude and longitude to installation
+
 ## 2.2.0
 
 - Added `amp_event` helper

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2018 Andrew Kane
+Copyright (c) 2014-2019 Andrew Kane
 
 MIT License
 

data/README.md

@@ -8,6 +8,8 @@ Track visits and events in Ruby, JavaScript, and native apps. Data is stored in
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://travis-ci.org/ankane/ahoy.svg?branch=master)](https://travis-ci.org/ankane/ahoy)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -42,13 +44,25 @@ Ahoy.api = true
 
 And restart your web server.
 
-For JavaScript, add to `app/assets/javascripts/application.js`:
+For JavaScript and Rails 6 / Webpacker, run:
+
+```sh
+yarn add ahoy.js
+```
+
+And add to `app/javascript/packs/application.js`:
+
+```javascript
+import ahoy from "ahoy.js";
+```
+
+For JavaScript and Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
 
 ```javascript
 //= require ahoy
 ```
 
-And track an event with:
+Track an event with:
 
 ```javascript
 ahoy.track("My second event", {language: "JavaScript"});
@@ -85,7 +99,11 @@ Prevent certain Rails actions from creating visits with:
 skip_before_action :track_ahoy_visit
 ```
 
-This is typically useful for APIs.
+This is typically useful for APIs. If your entire Rails app is an API, you can use:
+
+```ruby
+Ahoy.api_only = true
+```
 
 You can also defer visit tracking to JavaScript. This is useful for preventing bots (that aren’t detected by their user agent) and users with cookies disabled from creating a new visit on each request. `:when_needed` will create visits server-side only when needed by events, and `false` will disable server-side creation completely, discarding events without a visit.
 
@@ -154,34 +172,34 @@ Say we want to associate orders with visits. Just add `visitable` to the model.
 
 ```ruby
 class Order < ApplicationRecord
-  visitable
+  visitable :ahoy_visit
 end
 ```
 
-When a visitor places an order, the `visit_id` column is automatically set :tada:
+When a visitor places an order, the `ahoy_visit_id` column is automatically set :tada:
 
 See where orders are coming from with simple joins:
 
 ```ruby
-Order.joins(:visit).group("referring_domain").count
-Order.joins(:visit).group("city").count
-Order.joins(:visit).group("device_type").count
+Order.joins(:ahoy_visit).group("referring_domain").count
+Order.joins(:ahoy_visit).group("city").count
+Order.joins(:ahoy_visit).group("device_type").count
 ```
 
-Here’s what the migration to add the `visit_id` column should look like:
+Here’s what the migration to add the `ahoy_visit_id` column should look like:
 
 ```ruby
-class AddVisitIdToOrders < ActiveRecord::Migration[5.1]
+class AddVisitIdToOrders < ActiveRecord::Migration[5.2]
   def change
-    add_column :orders, :visit_id, :bigint
+    add_column :orders, :ahoy_visit_id, :bigint
   end
 end
 ```
 
-Customize the column and class name with:
+Customize the column with:
 
 ```ruby
-visitable :sign_up_visit, class_name: "Ahoy::Visit"
+visitable :sign_up_visit
 ```
 
 ### Users
@@ -236,6 +254,28 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+#### Knock
+
+To attach the user with [Knock](https://github.com/nsarno/knock), either include `Knock::Authenticable`in `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::API
+  include Knock::Authenticable
+end
+```
+
+Or include it in Ahoy:
+
+```ruby
+Ahoy::BaseController.include Knock::Authenticable
+```
+
+And use:
+
+```ruby
+Ahoy.user_method = ->(controller) { controller.send(:authenticate_entity, "user") }
+```
+
 ### Exclusions
 
 Bots are excluded from tracking by default. To include them, use:
@@ -303,6 +343,8 @@ Geocoder.configure(
 )
 ```
 
+If you use Heroku, you can use an unofficial buildpack like [this one](https://github.com/temedica/heroku-buildpack-maxmind-geolite2) to avoid including the database in your repo.
+
 ### Token Generation
 
 Ahoy uses random UUIDs for visit and visitor tokens by default, but you can use your own generator like [Druuid](https://github.com/recurly/druuid).
@@ -465,6 +507,23 @@ end
 
 Two useful methods you can use are `request` and `controller`.
 
+You can pass additional visit data from JavaScript with: [master]
+
+```javascript
+ahoy.configure({visitParams: {referral_code: 123}});
+```
+
+And use:
+
+```ruby
+class Ahoy::Store < Ahoy::DatabaseStore
+  def track_visit(data)
+    data[:referral_code] = request.parameters[:referral_code]
+    super(data)
+  end
+end
+```
+
 ### Use Different Models
 
 ```ruby
@@ -570,20 +629,6 @@ Send a `POST` request to `/ahoy/events` with `Content-Type: application/json` an
 }
 ```
 
-## Webpacker
-
-For Webpacker, use Yarn to install the JavaScript library:
-
-```sh
-yarn add ahoy.js
-```
-
-Then include it in your pack.
-
-```es6
-import ahoy from "ahoy.js";
-```
-
 ## Upgrading
 
 ### 2.2

data/lib/ahoy.rb

@@ -63,7 +63,7 @@ module Ahoy
 
   mattr_accessor :user_method
   self.user_method = lambda do |controller|
-    (controller.respond_to?(:current_user) && controller.current_user) || (controller.respond_to?(:current_resource_owner, true) && controller.send(:current_resource_owner)) || nil
+    (controller.respond_to?(:current_user, true) && controller.send(:current_user)) || (controller.respond_to?(:current_resource_owner, true) && controller.send(:current_resource_owner)) || nil
   end
 
   mattr_accessor :exclude_method

data/lib/ahoy/base_store.rb

@@ -50,10 +50,11 @@ module Ahoy
         @bot = begin
           if request
             if Ahoy.user_agent_parser == :device_detector
+              detector = DeviceDetector.new(request.user_agent)
               if Ahoy.bot_detection_version == 2
-                DeviceDetector.new(request.user_agent).device_type.nil?
+                detector.bot? || detector.device_type.nil?
               else
-                DeviceDetector.new(request.user_agent).bot?
+                detector.bot?
               end
             else
               Browser.new(request.user_agent).bot?

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/lib/generators/ahoy/templates/active_record_migration.rb.tt

@@ -26,6 +26,8 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :country
       t.string :region
       t.string :city
+      t.decimal :latitude, precision: 10, scale: 8
+      t.decimal :longitude, precision: 11, scale: 8
 
       # utm parameters
       t.string :utm_source

data/lib/generators/ahoy/templates/mongoid_visit_model.rb.tt

@@ -16,23 +16,20 @@ class Ahoy::Visit
   field :ip, type: String
   field :user_agent, type: String
   field :referrer, type: String
-  field :landing_page, type: String
-
-  # traffic source
   field :referring_domain, type: String
-  field :search_keyword, type: String
+  field :landing_page, type: String
 
   # technology
   field :browser, type: String
   field :os, type: String
   field :device_type, type: String
-  field :screen_height, type: Integer
-  field :screen_width, type: Integer
 
   # location
   field :country, type: String
   field :region, type: String
   field :city, type: String
+  field :latitude, type: Float
+  field :longitude, type: Float
 
   # utm parameters
   field :utm_source, type: String

data/vendor/assets/javascripts/ahoy.js

@@ -2,7 +2,7 @@
  * Ahoy.js
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.3.3
+ * v0.3.4
  * MIT License
  */
 
@@ -12,48 +12,82 @@
   (global.ahoy = factory());
 }(this, (function () { 'use strict';
 
-  function isUndefined (value) {
-    return value === undefined
+  function isUndefined(value) {
+    return value === undefined;
   }
 
-  function isObject (value) {
-    return value === Object(value)
+  function isNull(value) {
+    return value === null;
   }
 
-  function isArray (value) {
-    return Array.isArray(value)
+  function isObject(value) {
+    return value === Object(value);
   }
 
-  function isBlob (value) {
-    return value != null &&
-        typeof value.size === 'number' &&
-        typeof value.type === 'string' &&
-        typeof value.slice === 'function'
+  function isArray(value) {
+    return Array.isArray(value);
   }
 
-  function isFile (value) {
-    return isBlob(value) &&
-        typeof value.lastModified === 'number' &&
-        typeof value.name === 'string'
+  function isDate(value) {
+    return value instanceof Date;
   }
 
-  function isDate (value) {
-    return value instanceof Date
+  function isBlob(value) {
+    return (
+      value &&
+      typeof value.size === 'number' &&
+      typeof value.type === 'string' &&
+      typeof value.slice === 'function'
+    );
   }
 
-  function objectToFormData (obj, fd, pre) {
+  function isFile(value) {
+    return (
+      isBlob(value) &&
+      (typeof value.lastModifiedDate === 'object' ||
+        typeof value.lastModified === 'number') &&
+      typeof value.name === 'string'
+    );
+  }
+
+  function isFormData(value) {
+    return value instanceof FormData;
+  }
+
+  function objectToFormData(obj, cfg, fd, pre) {
+    if (isFormData(cfg)) {
+      pre = fd;
+      fd = cfg;
+      cfg = null;
+    }
+
+    cfg = cfg || {};
+    cfg.indices = isUndefined(cfg.indices) ? false : cfg.indices;
+    cfg.nulls = isUndefined(cfg.nulls) ? true : cfg.nulls;
     fd = fd || new FormData();
 
     if (isUndefined(obj)) {
-      return fd
+      return fd;
+    } else if (isNull(obj)) {
+      if (cfg.nulls) {
+        fd.append(pre, '');
+      }
     } else if (isArray(obj)) {
-      obj.forEach(function (value) {
+      if (!obj.length) {
         var key = pre + '[]';
 
-        objectToFormData(value, fd, key);
-      });
-    } else if (isObject(obj) && !isFile(obj) && !isDate(obj)) {
-      Object.keys(obj).forEach(function (prop) {
+        fd.append(key, '');
+      } else {
+        obj.forEach(function(value, index) {
+          var key = pre + '[' + (cfg.indices ? index : '') + ']';
+
+          objectToFormData(value, cfg, fd, key);
+        });
+      }
+    } else if (isDate(obj)) {
+      fd.append(pre, obj.toISOString());
+    } else if (isObject(obj) && !isFile(obj) && !isBlob(obj)) {
+      Object.keys(obj).forEach(function(prop) {
         var value = obj[prop];
 
         if (isArray(value)) {
@@ -62,20 +96,20 @@
           }
         }
 
-        var key = pre ? (pre + '[' + prop + ']') : prop;
+        var key = pre ? pre + '[' + prop + ']' : prop;
 
-        objectToFormData(value, fd, key);
+        objectToFormData(value, cfg, fd, key);
       });
     } else {
       fd.append(pre, obj);
     }
 
-    return fd
+    return fd;
   }
 
   var objectToFormdata = objectToFormData;
 
-  // http://www.quirksmode.org/js/cookies.html
+  // https://www.quirksmode.org/js/cookies.html
 
   var Cookies = {
     set: function (name, value, ttl, domain) {
@@ -112,13 +146,16 @@
     urlPrefix: "",
     visitsUrl: "/ahoy/visits",
     eventsUrl: "/ahoy/events",
-    cookieDomain: null,
     page: null,
     platform: "Web",
     useBeacon: true,
     startOnReady: true,
     trackVisits: true,
-    cookies: true
+    cookies: true,
+    cookieDomain: null,
+    headers: {},
+    visitParams: {},
+    withCredentials: false
   };
 
   var ahoy = window.ahoy || window.Ahoy || {};
@@ -151,8 +188,12 @@
     return config.urlPrefix + config.eventsUrl;
   }
 
+  function isEmpty(obj) {
+    return Object.keys(obj).length === 0;
+  }
+
   function canTrackNow() {
-    return (config.useBeacon || config.trackNow) && canStringify && typeof(window.navigator.sendBeacon) !== "undefined";
+    return (config.useBeacon || config.trackNow) && isEmpty(config.headers) && canStringify && typeof(window.navigator.sendBeacon) !== "undefined" && !config.withCredentials;
   }
 
   // cookies
@@ -220,7 +261,7 @@
     document.readyState === "interactive" || document.readyState === "complete" ? callback() : document.addEventListener("DOMContentLoaded", callback);
   }
 
-  // http://stackoverflow.com/a/2117523/1177228
+  // https://stackoverflow.com/a/2117523/1177228
   function generateId() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
       var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
@@ -261,12 +302,22 @@
           contentType: "application/json; charset=utf-8",
           dataType: "json",
           beforeSend: CSRFProtection,
-          success: success
+          success: success,
+          headers: config.headers,
+          xhrFields: {
+            withCredentials: config.withCredentials
+          }
         });
       } else {
         var xhr = new XMLHttpRequest();
         xhr.open("POST", url, true);
+        xhr.withCredentials = config.withCredentials;
         xhr.setRequestHeader("Content-Type", "application/json");
+        for (var header in config.headers) {
+          if (config.headers.hasOwnProperty(header)) {
+            xhr.setRequestHeader(header, config.headers[header]);
+          }
+        }
         xhr.onload = function() {
           if (xhr.status === 200) {
             success();
@@ -285,7 +336,8 @@
     if (config.cookies) {
       data.visit_token = event.visit_token;
       data.visitor_token = event.visitor_token;
-    }  delete event.visit_token;
+    }
+    delete event.visit_token;
     delete event.visitor_token;
     return data;
   }
@@ -402,6 +454,12 @@
           data.referrer = document.referrer;
         }
 
+        for (var key in config.visitParams) {
+          if (config.visitParams.hasOwnProperty(key)) {
+            data[key] = config.visitParams[key];
+          }
+        }
+
         log(data);
 
         sendRequest(visitsUrl(), data, function () {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -295,8 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple, powerful analytics for Rails