ahoy_matey 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d09c2a1f7783c94ad857652adfbe8150deb702f9162daf28c2bf9c11454f4277
-  data.tar.gz: 0e0a9779762c9ad912ba6d8866f85783c00aa0a96f3c53a4b6b803a3cdf41af2
+  metadata.gz: 1fb8aecda5242614f518d06dbdc9449305f0ed30677d667e01eb1edefc627bc7
+  data.tar.gz: 8f52fbe0bab0a0ac1c5722b06f342add3d31c0c441230b77f03ae566e07f746b
 SHA512:
-  metadata.gz: e479ea5345820038c0a4fe4296504781614b53c6cfef5a79856c51073f768dc64082d494ba64d1e03ec41a346832c320565de63c5953f3bdf91e6e2697a1b7c9
-  data.tar.gz: 5fc7c4e73835b1ffc7be2d9c125894baccf204b7e7785784887574d80b8d7581d10e1ced1c0562cd7804ad66a22ce05df64ef6b302a981faa567569b618c8557
+  metadata.gz: '059927d7fe2344882860ae81ff23e142a09ed955da818da8d3e679b03173b39e64ffc611e4e682a912901678cd9b790b461805f788c423cd2b4331c2a340c226'
+  data.tar.gz: f2d53c35500ee4d30485cfbf6c5d444cbf03c50cec4762783a972411343e19b8baf53b61286cc4aa78bbbe98a69df21da701989422263780447341fdce756db0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 4.0.0 (2021-08-14)
+
+- Disabled geocoding by default
+- Made the `geocoder` gem an optional dependency
+- Updated Ahoy.js to 0.4.0
+- Updated API to return 400 status code when missing required parameters
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
 ## 3.3.0 (2021-08-13)
 
 - Added `country_code` to geocoding

data/README.md

@@ -4,6 +4,8 @@
 
 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.
 
+**Ahoy 4.0 was recently released** - see [how to upgrade](#upgrading)
+
 :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
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
@@ -143,12 +145,6 @@ end
 ahoy.track("Viewed book", {title: "The World is Flat"});
 ```
 
-Track events automatically with:
-
-```javascript
-ahoy.trackAll();
-```
-
 See [Ahoy.js](https://github.com/ankane/ahoy.js) for a complete list of features.
 
 #### Native Apps
@@ -350,7 +346,13 @@ Safely.report_exception_method = ->(e) { Rollbar.error(e) }
 
 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`:
+To enable geocoding, add this line to your application’s Gemfile:
+
+```ruby
+gem 'geocoder'
+```
+
+And update `config/initializers/ahoy.rb`:
 
 ```ruby
 Ahoy.geocode = true
@@ -743,62 +745,19 @@ Send a `POST` request to `/ahoy/events` with `Content-Type: application/json` an
 
 ## Upgrading
 
-### 3.0
-
-If you installed Ahoy before 2.1 and want to keep legacy user agent parsing and bot detection, add to your Gemfile:
-
-```ruby
-gem "browser", "~> 2.0"
-gem "user_agent_parser"
-```
-
-And add to `config/initializers/ahoy.rb`:
-
-```ruby
-Ahoy.user_agent_parser = :legacy
-```
-
-### 2.2
-
-Ahoy now ships with better bot detection if you use Device Detector. This should be more accurate but can significantly reduce the number of visits recorded. For existing installs, it’s opt-in to start. To use it, add to `config/initializers/ahoy.rb`:
-
-```ruby
-Ahoy.bot_detection_version = 2
-```
-
-### 2.1
-
-Ahoy recommends [Device Detector](https://github.com/podigee/device_detector) for user agent parsing and makes it the default for new installations. To switch, add to `config/initializers/ahoy.rb`:
+### 4.0
 
-```ruby
-Ahoy.user_agent_parser = :device_detector
-```
+There are two notable changes to geocoding:
 
-Backfill existing records with:
-
-```ruby
-Ahoy::Visit.find_each do |visit|
-  client = DeviceDetector.new(visit.user_agent)
-  device_type =
-    case client.device_type
-    when "smartphone"
-      "Mobile"
-    when "tv"
-      "TV"
-    else
-      client.device_type.try(:titleize)
-    end
+1. Geocoding is now disabled by default (this was already the case for new installations with 3.2.0+). Check out the instructions for [how to enable it](#geocoding).
 
-  visit.browser = client.name
-  visit.os = client.os_name
-  visit.device_type = device_type
-  visit.save(validate: false) if visit.changed?
-end
-```
+2. The `geocoder` gem is now an optional dependency. To use geocoding, add it to your Gemfile:
 
-### 2.0
+  ```ruby
+  gem 'geocoder'
+  ```
 
-See the [upgrade guide](docs/Ahoy-2-Upgrade.md)
+Also, check out the [upgrade notes](https://github.com/ankane/ahoy.js#upgrading) for Ahoy.js.
 
 ## History
 

data/app/controllers/ahoy/base_controller.rb

@@ -5,19 +5,27 @@ module Ahoy
     skip_after_action(*filters, raise: false)
     skip_around_action(*filters, raise: false)
 
-    before_action :verify_request_size
-    before_action :renew_cookies
-
     if respond_to?(:protect_from_forgery)
       protect_from_forgery with: :null_session, if: -> { Ahoy.protect_from_forgery }
     end
 
+    before_action :verify_request_size
+    before_action :check_params
+    before_action :renew_cookies
+
     protected
 
     def ahoy
       @ahoy ||= Ahoy::Tracker.new(controller: self, api: true)
     end
 
+    def check_params
+      if ahoy.send(:missing_params?)
+        logger.info "[ahoy] Missing required parameters"
+        render plain: "Missing required parameters\n", status: :bad_request
+      end
+    end
+
     # set proper ttl if cookie generated from JavaScript
     # approach is not perfect, as user must reload the page
     # for new cookie settings to take effect
@@ -28,7 +36,7 @@ module Ahoy
     def verify_request_size
       if request.content_length > Ahoy.max_content_length
         logger.info "[ahoy] Payload too large"
-        render plain: "Payload too large\n", status: 413
+        render plain: "Payload too large\n", status: :payload_too_large
       end
     end
   end

data/app/jobs/ahoy/geocode_v2_job.rb

@@ -6,6 +6,8 @@ module Ahoy
       location =
         begin
           Geocoder.search(ip).first
+        rescue NameError
+          raise "Add the geocoder gem to your Gemfile to use geocoding"
         rescue => e
           Ahoy.log "Geocode error: #{e.class.name}: #{e.message}"
           nil

data/lib/ahoy.rb

@@ -4,7 +4,6 @@ require "ipaddr"
 # dependencies
 require "active_support"
 require "active_support/core_ext"
-require "geocoder"
 require "safely/core"
 
 # modules
@@ -44,7 +43,7 @@ module Ahoy
   self.quiet = true
 
   mattr_accessor :geocode
-  self.geocode = true
+  self.geocode = false
 
   mattr_accessor :max_content_length
   self.max_content_length = 8192
@@ -128,10 +127,6 @@ ActiveSupport.on_load(:action_view) do
 end
 
 # Mongoid
-# TODO use
-# ActiveSupport.on_load(:mongoid) do
-#   Mongoid::Document::ClassMethods.include(Ahoy::Model)
-# end
-if defined?(ActiveModel)
-  ActiveModel::Callbacks.include(Ahoy::Model)
+ActiveSupport.on_load(:mongoid) do
+  Mongoid::Document::ClassMethods.include(Ahoy::Model)
 end

data/lib/ahoy/query_methods.rb

@@ -19,35 +19,21 @@ module Ahoy
         when "mongoid"
           relation = where(Hash[properties.map { |k, v| ["properties.#{k}", v] }])
         when /mysql/
-          if column_type == :json
-            properties.each do |k, v|
-              if v.nil?
-                v = "null"
-              elsif v == true
-                v = "true"
-              end
-
-              relation = relation.where("JSON_UNQUOTE(properties -> ?) = ?", "$.#{k}", v.as_json)
-            end
-          else
-            properties.each do |k, v|
-              # TODO cast to json instead
-              relation = relation.where("properties REGEXP ?", "[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "").gsub("+", "\\\\+")}[,}]")
+          column = column_type == :json || connection.try(:mariadb?) ? "properties" : "CAST(properties AS JSON)"
+          properties.each do |k, v|
+            if v.nil?
+              v = "null"
+            elsif v == true
+              v = "true"
             end
+
+            relation = relation.where("JSON_UNQUOTE(JSON_EXTRACT(#{column}, ?)) = ?", "$.#{k}", v.as_json)
           end
         when /postgres|postgis/
-          if column_type == :jsonb
+          case column_type
+          when :jsonb
             relation = relation.where("properties @> ?", properties.to_json)
-          elsif column_type == :json
-            properties.each do |k, v|
-              relation =
-                if v.nil?
-                  relation.where("properties ->> ? IS NULL", k.to_s)
-                else
-                  relation.where("properties ->> ? = ?", k.to_s, v.as_json.to_s)
-                end
-            end
-          elsif column_type == :hstore
+          when :hstore
             properties.each do |k, v|
               relation =
                 if v.nil?
@@ -57,10 +43,7 @@ module Ahoy
                 end
             end
           else
-            properties.each do |k, v|
-              # TODO cast to jsonb instead
-              relation = relation.where("properties SIMILAR TO ?", "%[{,]#{{k.to_s => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "").gsub("+", "\\\\+")}[,}]%")
-            end
+            relation = relation.where("properties::jsonb @> ?", properties.to_json)
           end
         else
           raise "Adapter not supported: #{adapter_name}"
@@ -84,17 +67,10 @@ module Ahoy
         when "mongoid"
           raise "Adapter not supported: #{adapter_name}"
         when /mysql/
-          if connection.try(:mariadb?)
-            props.each do |prop|
-              quoted_prop = connection.quote("$.#{prop}")
-              relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(properties, #{quoted_prop}))")
-            end
-          else
-            column = column_type == :json ? "properties" : "CAST(properties AS JSON)"
-            props.each do |prop|
-              quoted_prop = connection.quote("$.#{prop}")
-              relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(#{column}, #{quoted_prop}))")
-            end
+          column = column_type == :json || connection.try(:mariadb?) ? "properties" : "CAST(properties AS JSON)"
+          props.each do |prop|
+            quoted_prop = connection.quote("$.#{prop}")
+            relation = relation.group("JSON_UNQUOTE(JSON_EXTRACT(#{column}, #{quoted_prop}))")
           end
         when /postgres|postgis/
           # convert to jsonb to fix

data/lib/ahoy/tracker.rb

@@ -19,8 +19,6 @@ module Ahoy
     def track(name, properties = {}, options = {})
       if exclude?
         debug "Event excluded"
-      elsif missing_params?
-        debug "Missing required parameters"
       else
         data = {
           visit_token: visit_token,
@@ -41,8 +39,6 @@ module Ahoy
     def track_visit(defer: false, started_at: nil)
       if exclude?
         debug "Visit excluded"
-      elsif missing_params?
-        debug "Missing required parameters"
       else
         if defer
           set_cookie("ahoy_track", true, nil, false)
@@ -155,6 +151,7 @@ module Ahoy
       @options[:api]
     end
 
+    # private, but used by API
     def missing_params?
       if Ahoy.cookies && api? && Ahoy.protect_from_forgery
         !(existing_visit_token && existing_visitor_token)

data/lib/ahoy/version.rb

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

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

@@ -19,7 +19,7 @@ end
 # set to true for JavaScript tracking
 Ahoy.api = false
 
-# set to true for geocoding
-# we recommend configuring local geocoding first
+# set to true for geocoding (and add the geocoder gem to your Gemfile)
+# we recommend configuring local geocoding as well
 # see https://github.com/ankane/ahoy#geocoding
 Ahoy.geocode = false

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

@@ -4,7 +4,7 @@ end
 # set to true for JavaScript tracking
 Ahoy.api = false
 
-# set to true for geocoding
-# we recommend configuring local geocoding first
+# set to true for geocoding (and add the geocoder gem to your Gemfile)
+# we recommend configuring local geocoding as well
 # see https://github.com/ankane/ahoy#geocoding
 Ahoy.geocode = false

data/vendor/assets/javascripts/ahoy.js

@@ -2,7 +2,7 @@
  * Ahoy.js
  * Simple, powerful JavaScript analytics
  * https://github.com/ankane/ahoy.js
- * v0.3.9
+ * v0.4.0
  * MIT License
  */
 
@@ -26,7 +26,7 @@
       if (domain) {
         cookieDomain = "; domain=" + domain;
       }
-      document.cookie = name + "=" + escape(value) + expires + cookieDomain + "; path=/";
+      document.cookie = name + "=" + escape(value) + expires + cookieDomain + "; path=/; samesite=lax";
     },
     get: function (name) {
       var i, c;
@@ -478,8 +478,7 @@
 
   ahoy.trackClicks = function (selector) {
     if (selector === undefined) {
-      log("trackClicks will require a selector in 0.4.0");
-      selector = "a, button, input[type=submit]";
+      throw new Error("Missing selector");
     }
     onEvent("click", selector, function (e) {
       var properties = eventProperties.call(this, e);
@@ -491,8 +490,7 @@
 
   ahoy.trackSubmits = function (selector) {
     if (selector === undefined) {
-      log("trackSubmits will require a selector in 0.4.0");
-      selector = "form";
+      throw new Error("Missing selector");
     }
     onEvent("submit", selector, function (e) {
       var properties = eventProperties.call(this, e);
@@ -501,10 +499,9 @@
   };
 
   ahoy.trackChanges = function (selector) {
+    log("trackChanges is deprecated and will be removed in 0.5.0");
     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";
+      throw new Error("Missing selector");
     }
     onEvent("change", selector, function (e) {
       var properties = eventProperties.call(this, e);
@@ -512,14 +509,6 @@
     });
   };
 
-  ahoy.trackAll = function() {
-    log("trackAll is deprecated and will be removed in 0.4.0");
-    ahoy.trackView();
-    ahoy.trackClicks("a, button, input[type=submit]");
-    ahoy.trackSubmits("form");
-    ahoy.trackChanges("input, textarea, select");
-  };
-
   // push events from queue
   try {
     eventQueue = JSON.parse(getCookie("ahoy_events") || "[]");

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2021-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: geocoder
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.5
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: safely_block
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="