ahoy_matey 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e11f3086c12a1418ea7436e291ca9d2f0c7e0aa3091c48c904d05b4be6a210
-  data.tar.gz: 5b5c6afc94c0db23f2f1616f6e9edc0ae95ff334e33704c26417705d06d04670
+  metadata.gz: d09c2a1f7783c94ad857652adfbe8150deb702f9162daf28c2bf9c11454f4277
+  data.tar.gz: 0e0a9779762c9ad912ba6d8866f85783c00aa0a96f3c53a4b6b803a3cdf41af2
 SHA512:
-  metadata.gz: fd75680d3d04b2383c30b19848f88fcb838f1498e8819d2d758aec6443e85bfb2f73a421da968cb54628097631c777ac1f95dd1ca4bae6d6b22d748a44dcb84d
-  data.tar.gz: 2d336bd12312cddf4b76f213b1f7f84b1fc2f0b67302e75096d1eb21013982f532064b31894ba217f7ccbafdbaf5eb4c691a3a86350b8abf1449374f66015909
+  metadata.gz: e479ea5345820038c0a4fe4296504781614b53c6cfef5a79856c51073f768dc64082d494ba64d1e03ec41a346832c320565de63c5953f3bdf91e6e2697a1b7c9
+  data.tar.gz: 5fc7c4e73835b1ffc7be2d9c125894baccf204b7e7785784887574d80b8d7581d10e1ced1c0562cd7804ad66a22ce05df64ef6b302a981faa567569b618c8557

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.3.0 (2021-08-13)
+
+- Added `country_code` to geocoding
+- Updated Ahoy.js to 0.3.9
+- Fixed install generator for MariaDB
+
 ## 3.2.0 (2021-03-01)
 
 - Disabled geocoding by default for new installations

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2020 Andrew Kane
+Copyright (c) 2014-2021 Andrew Kane
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 :fire: Simple, powerful, first-party analytics for Rails
 
-Track visits and events in Ruby, JavaScript, and native apps. Data is stored in your database by default so you can easily combine it with other data.
+Track visits and events in Ruby, JavaScript, and native apps. Data is stored in your database by default, and you can customize it for any data store as you grow.
 
 :postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for emails and [Field Test](https://github.com/ankane/field_test) for A/B testing
 
@@ -74,14 +74,14 @@ ahoy.track("My second event", {language: "JavaScript"});
 
 Check out [Ahoy iOS](https://github.com/namolnad/ahoy-ios) and [Ahoy Android](https://github.com/instacart/ahoy-android).
 
-### GDPR Compliance
-
-Ahoy provides a number of options to help with GDPR compliance. See the [GDPR section](#gdpr-compliance-1) for more info.
-
 ### Geocoding Setup
 
 To enable geocoding, see the [Geocoding section](#geocoding).
 
+### GDPR Compliance
+
+Ahoy provides a number of options to help with GDPR compliance. See the [GDPR section](#gdpr-compliance-1) for more info.
+
 ## How It Works
 
 ### Visits
@@ -189,7 +189,7 @@ Order.joins(:ahoy_visit).group("device_type").count
 Here’s what the migration to add the `ahoy_visit_id` column should look like:
 
 ```ruby
-class AddVisitIdToOrders < ActiveRecord::Migration[6.0]
+class AddVisitIdToOrders < ActiveRecord::Migration[6.1]
   def change
     add_column :orders, :ahoy_visit_id, :bigint
   end
@@ -204,7 +204,7 @@ visitable :sign_up_visit
 
 ### Users
 
-Ahoy automatically attaches the `current_user` to the visit. With [Devise](https://github.com/plataformatec/devise), it attaches the user even if he or she signs in after the visit starts.
+Ahoy automatically attaches the `current_user` to the visit. With [Devise](https://github.com/plataformatec/devise), it attaches the user even if they sign in after the visit starts.
 
 With other authentication frameworks, add this to the end of your sign in method:
 
@@ -314,9 +314,41 @@ Set other [cookie options](https://api.rubyonrails.org/classes/ActionDispatch/Co
 Ahoy.cookie_options = {same_site: :lax}
 ```
 
-### Geocoding
+You can also [disable cookies](#anonymity-sets--cookies)
+
+### Token Generation
 
-Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for geocoding. We recommend configuring [local geocoding](#local-geocoding) so IP addresses are not sent to a 3rd party service. If you do use a 3rd party service, be sure to add it to your GDPR subprocessor list. If Ahoy is configured to [mask ips](#ip-masking), the masked IP is used (this increases privacy but can reduce accuracy).
+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).
+
+```ruby
+Ahoy.token_generator = -> { Druuid.gen }
+```
+
+### Throttling
+
+You can use [Rack::Attack](https://github.com/kickstarter/rack-attack) to throttle requests to the API.
+
+```ruby
+class Rack::Attack
+  throttle("ahoy/ip", limit: 20, period: 1.minute) do |req|
+    if req.path.start_with?("/ahoy/")
+      req.ip
+    end
+  end
+end
+```
+
+### Exceptions
+
+Exceptions are rescued so analytics do not break your app. Ahoy uses [Safely](https://github.com/ankane/safely) to try to report them to a service by default. To customize this, use:
+
+```ruby
+Safely.report_exception_method = ->(e) { Rollbar.error(e) }
+```
+
+## Geocoding
+
+Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for geocoding. We recommend configuring [local geocoding](#local-geocoding) or [load balancer geocoding](#load-balancer-geocoding) so IP addresses are not sent to a 3rd party service. If you do use a 3rd party service and adhere to GDPR, be sure to add it to your subprocessor list. If Ahoy is configured to [mask IPs](#ip-masking), the masked IP is used (this can reduce accuracy but is better for privacy).
 
 To enable geocoding, update `config/initializers/ahoy.rb`:
 
@@ -367,36 +399,29 @@ Geocoder.configure(
 )
 ```
 
-### Token Generation
+### Load Balancer Geocoding
 
-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).
+Some load balancers can add geocoding information to request headers.
 
-```ruby
-Ahoy.token_generator = -> { Druuid.gen }
-```
+- [nginx](https://nginx.org/en/docs/http/ngx_http_geoip_module.html)
+- [Google Cloud](https://cloud.google.com/load-balancing/docs/custom-headers)
+- [Cloudflare](https://support.cloudflare.com/hc/en-us/articles/200168236-Configuring-Cloudflare-IP-Geolocation)
 
-### Throttling
-
-You can use [Rack::Attack](https://github.com/kickstarter/rack-attack) to throttle requests to the API.
+Update `config/initializers/ahoy.rb` with:
 
 ```ruby
-class Rack::Attack
-  throttle("ahoy/ip", limit: 20, period: 1.minute) do |req|
-    if req.path.start_with?("/ahoy/")
-      req.ip
-    end
+Ahoy.geocode = false
+
+class Ahoy::Store < Ahoy::DatabaseStore
+  def track_visit(data)
+    data[:country] = request.headers["<country-header>"]
+    data[:region] = request.headers["<region-header>"]
+    data[:city] = request.headers["<city-header>"]
+    super(data)
   end
 end
 ```
 
-### Exceptions
-
-Exceptions are rescued so analytics do not break your app. Ahoy uses [Safely](https://github.com/ankane/safely) to try to report them to a service by default. To customize this, use:
-
-```ruby
-Safely.report_exception_method = ->(e) { Rollbar.error(e) }
-```
-
 ## GDPR Compliance
 
 Ahoy provides a number of options to help with [GDPR compliance](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).
@@ -455,7 +480,11 @@ Ahoy can switch from cookies to [anonymity sets](https://privacypatterns.org/pat
 Ahoy.cookies = false
 ```
 
-Previously set cookies are automatically deleted.
+Previously set cookies are automatically deleted. If you use JavaScript tracking, also set:
+
+```javascript
+ahoy.configure({cookies: false});
+```
 
 ## Data Retention
 

data/app/jobs/ahoy/geocode_v2_job.rb

@@ -14,6 +14,7 @@ module Ahoy
       if location && location.country.present?
         data = {
           country: location.country,
+          country_code: location.try(:country_code).presence,
           region: location.try(:state).presence,
           city: location.try(:city).presence,
           postal_code: location.try(:postal_code).presence,

data/lib/ahoy/database_store.rb

@@ -53,7 +53,7 @@ module Ahoy
 
     def visit
       unless defined?(@visit)
-        @visit = visit_model.where(visit_token: ahoy.visit_token).first if ahoy.visit_token
+        @visit = visit_model.find_by(visit_token: ahoy.visit_token) if ahoy.visit_token
       end
       @visit
     end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/lib/generators/ahoy/activerecord_generator.rb

@@ -27,6 +27,11 @@ module Ahoy
         end
       end
 
+      # requires database connection to check for MariaDB
+      def serialize_properties?
+        properties_type == "text" || (properties_type == "json" && ActiveRecord::Base.connection.try(:mariadb?))
+      end
+
       # use connection_config instead of connection.adapter
       # so database connection isn't needed
       def adapter

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

@@ -4,7 +4,7 @@ class Ahoy::Event < ApplicationRecord
   self.table_name = "ahoy_events"
 
   belongs_to :visit
-  belongs_to :user, optional: true<% if properties_type == "text" %>
+  belongs_to :user, optional: true<% if serialize_properties? %>
 
   serialize :properties, JSON<% end %>
 end

data/vendor/assets/javascripts/ahoy.js

@@ -1,8 +1,8 @@
-/*
+/*!
  * Ahoy.js
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.3.8
+ * v0.3.9
  * MIT License
  */
 
@@ -12,97 +12,6 @@
   (global = global || self, global.ahoy = factory());
 }(this, (function () { 'use strict';
 
-  var isUndefined = function (value) { return value === undefined; };
-
-  var isNull = function (value) { return value === null; };
-
-  var isBoolean = function (value) { return typeof value === 'boolean'; };
-
-  var isObject = function (value) { return value === Object(value); };
-
-  var isArray = function (value) { return Array.isArray(value); };
-
-  var isDate = function (value) { return value instanceof Date; };
-
-  var isBlob = function (value) { return value &&
-    typeof value.size === 'number' &&
-    typeof value.type === 'string' &&
-    typeof value.slice === 'function'; };
-
-  var isFile = function (value) { return isBlob(value) &&
-    typeof value.name === 'string' &&
-    (typeof value.lastModifiedDate === 'object' ||
-      typeof value.lastModified === 'number'); };
-
-  var serialize = function (obj, cfg, fd, pre) {
-    cfg = cfg || {};
-
-    cfg.indices = isUndefined(cfg.indices) ? false : cfg.indices;
-
-    cfg.nullsAsUndefineds = isUndefined(cfg.nullsAsUndefineds)
-      ? false
-      : cfg.nullsAsUndefineds;
-
-    cfg.booleansAsIntegers = isUndefined(cfg.booleansAsIntegers)
-      ? false
-      : cfg.booleansAsIntegers;
-
-    cfg.allowEmptyArrays = isUndefined(cfg.allowEmptyArrays)
-      ? false
-      : cfg.allowEmptyArrays;
-
-    fd = fd || new FormData();
-
-    if (isUndefined(obj)) {
-      return fd;
-    } else if (isNull(obj)) {
-      if (!cfg.nullsAsUndefineds) {
-        fd.append(pre, '');
-      }
-    } else if (isBoolean(obj)) {
-      if (cfg.booleansAsIntegers) {
-        fd.append(pre, obj ? 1 : 0);
-      } else {
-        fd.append(pre, obj);
-      }
-    } else if (isArray(obj)) {
-      if (obj.length) {
-        obj.forEach(function (value, index) {
-          var key = pre + '[' + (cfg.indices ? index : '') + ']';
-
-          serialize(value, cfg, fd, key);
-        });
-      } else if (cfg.allowEmptyArrays) {
-        fd.append(pre + '[]', '');
-      }
-    } 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)) {
-          while (prop.length > 2 && prop.lastIndexOf('[]') === prop.length - 2) {
-            prop = prop.substring(0, prop.length - 2);
-          }
-        }
-
-        var key = pre ? pre + '[' + prop + ']' : prop;
-
-        serialize(value, cfg, fd, key);
-      });
-    } else {
-      fd.append(pre, obj);
-    }
-
-    return fd;
-  };
-
-  var index_module = {
-    serialize: serialize,
-  };
-  var index_module_1 = index_module.serialize;
-
   // https://www.quirksmode.org/js/cookies.html
 
   var Cookies = {
@@ -190,6 +99,16 @@
     return (config.useBeacon || config.trackNow) && isEmpty(config.headers) && canStringify && typeof(window.navigator.sendBeacon) !== "undefined" && !config.withCredentials;
   }
 
+  function serialize(object) {
+    var data = new FormData();
+    for (var key in object) {
+      if (object.hasOwnProperty(key)) {
+        data.append(key, object[key]);
+      }
+    }
+    return data;
+  }
+
   // cookies
 
   function setCookie(name, value, ttl) {
@@ -238,7 +157,7 @@
       if (matches.apply(element, [selector])) {
         return element;
       } else if (element.parentElement) {
-        return matchesSelector(element.parentElement, selector)
+        return matchesSelector(element.parentElement, selector);
       }
       return null;
     } else {
@@ -370,7 +289,7 @@
       // stringify so we keep the type
       data.events_json = JSON.stringify(data.events);
       delete data.events;
-      window.navigator.sendBeacon(eventsUrl(), index_module_1(data));
+      window.navigator.sendBeacon(eventsUrl(), serialize(data));
     });
   }
 
@@ -393,7 +312,7 @@
     return obj;
   }
 
-  function eventProperties(e) {
+  function eventProperties() {
     return cleanObject({
       tag: this.tagName.toLowerCase(),
       id: presence(this.id),
@@ -557,8 +476,12 @@
     ahoy.track("$view", properties);
   };
 
-  ahoy.trackClicks = function () {
-    onEvent("click", "a, button, input[type=submit]", function (e) {
+  ahoy.trackClicks = function (selector) {
+    if (selector === undefined) {
+      log("trackClicks will require a selector in 0.4.0");
+      selector = "a, button, input[type=submit]";
+    }
+    onEvent("click", selector, function (e) {
       var properties = eventProperties.call(this, e);
       properties.text = properties.tag == "input" ? this.value : (this.textContent || this.innerText || this.innerHTML).replace(/[\s\r\n]+/g, " ").trim();
       properties.href = this.href;
@@ -566,25 +489,35 @@
     });
   };
 
-  ahoy.trackSubmits = function () {
-    onEvent("submit", "form", function (e) {
+  ahoy.trackSubmits = function (selector) {
+    if (selector === undefined) {
+      log("trackSubmits will require a selector in 0.4.0");
+      selector = "form";
+    }
+    onEvent("submit", selector, function (e) {
       var properties = eventProperties.call(this, e);
       ahoy.track("$submit", properties);
     });
   };
 
-  ahoy.trackChanges = function () {
-    onEvent("change", "input, textarea, select", function (e) {
+  ahoy.trackChanges = function (selector) {
+    if (selector === undefined) {
+      // put here instead of above to prevent message with trackAll
+      log("trackChanges is deprecated and will be removed in 0.4.0");
+      selector = "input, textarea, select";
+    }
+    onEvent("change", selector, function (e) {
       var properties = eventProperties.call(this, e);
       ahoy.track("$change", properties);
     });
   };
 
   ahoy.trackAll = function() {
+    log("trackAll is deprecated and will be removed in 0.4.0");
     ahoy.trackView();
-    ahoy.trackClicks();
-    ahoy.trackSubmits();
-    ahoy.trackChanges();
+    ahoy.trackClicks("a, button, input[type=submit]");
+    ahoy.trackSubmits("form");
+    ahoy.trackChanges("input, textarea, select");
   };
 
   // push events from queue

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Simple, powerful, first-party analytics for Rails