ahoy_matey 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b0851dfc7538c6768d6f694d7e8356f0aef3e3ff66ba361447e000a2db5bac
-  data.tar.gz: c28eb30ab780037d83550d359a36d6790e3a16f60b314b5d0be170d11b3c427b
+  metadata.gz: 1da649f5c85699714bff1777f3226b232f555e79ec2ece218280541bbb1264d5
+  data.tar.gz: '0180556a4ad007b5d9df07faa327a6d53e9a2cfe1bf810cb78e9d24d6cdc060b'
 SHA512:
-  metadata.gz: 85fb407054564104efc83ae3d425c6253db7495d6f6d4156c741156f64fcd7fe048035f78e4563bf9ec92c69c7e6dfef41e29f7d1031174705b17c595ef96572
-  data.tar.gz: ff03757afbb0deca1a11dc4ece02310bbd8a03f644f675c2eee32c1bf7711013f0cd38eb0fd009541b97b3a5b914a756279e88dbe0cbc8a8bd14ed064d648089
+  metadata.gz: e7cd93d376c86d34123c964fceb7f84ef33dc0513bfb66ac1e9da1b5654a7bed69041eb0d99477b50f87c77b5bf8e4c396e4dc8bf99b10db2699ef09fb11ecf8
+  data.tar.gz: f11f02dbd35f36982d932d12a905d060770d9f01f4b0bdfe572002dd5a10feaa07b79b1d3eb0e2df3376f00c6fbe67bbcc29549498599bd9634e164ff04d4184

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.0.0
+
+- Made Device Detector the default user agent parser
+- Made v2 the default bot detection version
+- Removed a large number of dependencies
+- Removed search keyword detection (most search engines today prevent this)
+- Removed support for Rails < 5
+
 ## 2.2.1
 
 - Updated Ahoy.js to 0.3.4

data/README.md

@@ -31,12 +31,12 @@ Restart your web server, open a page in your browser, and a visit will be create
 Track your first event from a controller with:
 
 ```ruby
-ahoy.track "My first event", {language: "Ruby"}
+ahoy.track "My first event", language: "Ruby"
 ```
 
 ### JavaScript, Native Apps, & AMP
 
-First, enable the API in `config/initializers/ahoy.rb`:
+Enable the API in `config/initializers/ahoy.rb`:
 
 ```ruby
 Ahoy.api = true
@@ -44,7 +44,9 @@ Ahoy.api = true
 
 And restart your web server.
 
-For JavaScript and Rails 6 / Webpacker, run:
+### JavaScript
+
+For Rails 6 / Webpacker, run:
 
 ```sh
 yarn add ahoy.js
@@ -56,7 +58,7 @@ And add to `app/javascript/packs/application.js`:
 import ahoy from "ahoy.js";
 ```
 
-For JavaScript and Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
+For Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
 
 ```javascript
 //= require ahoy
@@ -68,14 +70,6 @@ Track an event with:
 ahoy.track("My second event", {language: "JavaScript"});
 ```
 
-For Android, check out [Ahoy Android](https://github.com/instacart/ahoy-android). For other platforms, see the [API spec](#api-spec).
-
-For AMP, track an event with:
-
-```erb
-<%= amp_event "My third event", language: "AMP" %>
-```
-
 ### GDPR Compliance
 
 Ahoy provides a number of options to help with GDPR compliance. See the [GDPR section](#gdpr-compliance-1) for more info.
@@ -86,9 +80,9 @@ Ahoy provides a number of options to help with GDPR compliance. See the [GDPR se
 
 When someone visits your website, Ahoy creates a visit with lots of useful information.
 
-- **traffic source** - referrer, referring domain, landing page, search keyword
-- **location** - country, region, and city
-- **technology** - browser, OS, and device type
+- **traffic source** - referrer, referring domain, landing page
+- **location** - country, region, city, latitude, longitude
+- **technology** - browser, OS, device type
 - **utm parameters** - source, medium, term, content, campaign
 
 Use the `current_visit` method to access it.
@@ -113,23 +107,7 @@ Ahoy.server_side_visits = :when_needed
 
 ### Events
 
-Each event has a `name` and `properties`.
-
-There are several ways to track events.
-
-#### JavaScript
-
-```javascript
-ahoy.track("Viewed book", {title: "The World is Flat"});
-```
-
-or track events automatically with:
-
-```javascript
-ahoy.trackAll();
-```
-
-See [Ahoy.js](https://github.com/ankane/ahoy.js) for a complete list of features.
+Each event has a `name` and `properties`. There are several ways to track events.
 
 #### Ruby
 
@@ -137,7 +115,7 @@ See [Ahoy.js](https://github.com/ankane/ahoy.js) for a complete list of features
 ahoy.track "Viewed book", title: "Hot, Flat, and Crowded"
 ```
 
-or track actions automatically with:
+Track actions automatically with:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -151,6 +129,20 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+#### JavaScript
+
+```javascript
+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
 
 For Android, check out [Ahoy Android](https://github.com/instacart/ahoy-android). For other platforms, see the [API spec](#api-spec).
@@ -415,6 +407,8 @@ Ahoy can mask IPs with the same approach [Google Analytics uses for IP anonymiza
 Ahoy.mask_ips = true
 ```
 
+IPs are masked before geolocation is performed.
+
 To mask previously collected IPs, use:
 
 ```ruby
@@ -507,7 +501,7 @@ end
 
 Two useful methods you can use are `request` and `controller`.
 
-You can pass additional visit data from JavaScript with: [master]
+You can pass additional visit data from JavaScript with:
 
 ```javascript
 ahoy.configure({visitParams: {referral_code: 123}});
@@ -631,6 +625,21 @@ 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`:

data/app/controllers/ahoy/base_controller.rb

@@ -1,13 +1,10 @@
 module Ahoy
   class BaseController < ApplicationController
     filters = _process_action_callbacks.map(&:filter) - Ahoy.preserve_callbacks
-    if Rails::VERSION::MAJOR >= 5
-      skip_before_action(*filters, raise: false)
-      skip_after_action(*filters, raise: false)
-      skip_around_action(*filters, raise: false)
-    else
-      skip_action_callback(*filters)
-    end
+    skip_before_action(*filters, raise: false)
+    skip_after_action(*filters, raise: false)
+    skip_around_action(*filters, raise: false)
+
     before_action :verify_request_size
     before_action :renew_cookies
 
@@ -31,7 +28,7 @@ module Ahoy
     def verify_request_size
       if request.content_length > Ahoy.max_content_length
         logger.info "[ahoy] Payload too large"
-        render text: "Payload too large\n", status: 413
+        render plain: "Payload too large\n", status: 413
       end
     end
   end

data/lib/ahoy.rb

@@ -1,11 +1,12 @@
 require "ipaddr"
 
+# dependencies
 require "active_support"
 require "active_support/core_ext"
-require "addressable/uri"
 require "geocoder"
 require "safely/core"
 
+# modules
 require "ahoy/utils"
 require "ahoy/base_store"
 require "ahoy/controller"
@@ -72,7 +73,7 @@ module Ahoy
   self.track_bots = false
 
   mattr_accessor :bot_detection_version
-  self.bot_detection_version = 1
+  self.bot_detection_version = 2
 
   mattr_accessor :token_generator
   self.token_generator = -> { SecureRandom.uuid }
@@ -81,10 +82,12 @@ module Ahoy
   self.mask_ips = false
 
   mattr_accessor :user_agent_parser
-  self.user_agent_parser = :legacy
+  self.user_agent_parser = :device_detector
+
+  mattr_accessor :logger
 
   def self.log(message)
-    Rails.logger.info { "[ahoy] #{message}" }
+    logger.info { "[ahoy] #{message}" } if logger
   end
 
   def self.mask_ip(ip)

data/lib/ahoy/base_store.rb

@@ -52,11 +52,13 @@ module Ahoy
             if Ahoy.user_agent_parser == :device_detector
               detector = DeviceDetector.new(request.user_agent)
               if Ahoy.bot_detection_version == 2
-                detector.bot? || detector.device_type.nil?
+                detector.bot? || (detector.device_type.nil? && detector.os_name.nil?)
               else
                 detector.bot?
               end
             else
+              # no need to throw friendly error if browser isn't defined
+              # since will error in visit_properties
               Browser.new(request.user_agent).bot?
             end
           else

data/lib/ahoy/controller.rb

@@ -1,5 +1,3 @@
-require "request_store"
-
 module Ahoy
   module Controller
     def self.included(base)
@@ -9,7 +7,7 @@ module Ahoy
       end
       base.before_action :set_ahoy_cookies, unless: -> { Ahoy.api_only }
       base.before_action :track_ahoy_visit, unless: -> { Ahoy.api_only }
-      base.before_action :set_ahoy_request_store
+      base.around_action :set_ahoy_request_store
     end
 
     def ahoy
@@ -41,7 +39,13 @@ module Ahoy
     end
 
     def set_ahoy_request_store
-      RequestStore.store[:ahoy] ||= ahoy
+      previous_value = Thread.current[:ahoy]
+      begin
+        Thread.current[:ahoy] = ahoy
+        yield
+      ensure
+        Thread.current[:ahoy] = previous_value
+      end
     end
   end
 end

data/lib/ahoy/database_store.rb

@@ -34,7 +34,7 @@ module Ahoy
         # upsert since visit might not be found due to eventual consistency
         visit_model.where(visit_token: visit_token).find_one_and_update({"$set": data}, {upsert: true})
       elsif visit
-        visit.update_attributes(data)
+        visit.update!(data)
       else
         Ahoy.log "Visit for geocode not found: #{visit_token}"
       end

data/lib/ahoy/engine.rb

@@ -1,6 +1,8 @@
 module Ahoy
   class Engine < ::Rails::Engine
     initializer "ahoy", after: "sprockets.environment" do
+      Ahoy.logger ||= Rails.logger
+
       # allow Devise to be loaded after Ahoy
       require "ahoy/warden" if defined?(Warden)
 

data/lib/ahoy/model.rb

@@ -2,14 +2,12 @@ module Ahoy
   module Model
     def visitable(name = :visit, **options)
       class_eval do
-        safe_options = options.dup
-        safe_options[:optional] = true if Rails::VERSION::MAJOR >= 5
-        belongs_to(name, class_name: "Ahoy::Visit", **safe_options)
+        belongs_to(name, class_name: "Ahoy::Visit", optional: true, **options)
         before_create :set_ahoy_visit
       end
       class_eval %{
         def set_ahoy_visit
-          self.#{name} ||= RequestStore.store[:ahoy].try(:visit_or_create)
+          self.#{name} ||= Thread.current[:ahoy].try(:visit_or_create)
         end
       }
     end

data/lib/ahoy/tracker.rb

@@ -127,7 +127,6 @@ module Ahoy
       @user ||= @store.user
     end
 
-    # TODO better name
     def visit_properties
       @visit_properties ||= Ahoy::VisitProperties.new(request, api: api?).generate
     end
@@ -186,7 +185,7 @@ module Ahoy
 
     def trusted_time(time = nil)
       if !time || (api? && !(1.minute.ago..Time.now).cover?(time))
-        Time.zone.now
+        Time.current
       else
         time
       end
@@ -197,7 +196,7 @@ module Ahoy
     end
 
     def report_exception(e)
-      raise e if Rails.env.development? || Rails.env.test?
+      raise e if !defined?(Rails) || Rails.env.development? || Rails.env.test?
       Safely.report_exception(e)
     end
 

data/lib/ahoy/version.rb

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

data/lib/ahoy/visit_properties.rb

@@ -1,7 +1,6 @@
-require "browser"
+require "cgi"
 require "device_detector"
-require "referer-parser"
-require "user_agent_parser"
+require "uri"
 
 module Ahoy
   class VisitProperties
@@ -21,23 +20,26 @@ module Ahoy
     private
 
     def utm_properties
-      landing_uri = Addressable::URI.parse(landing_page) rescue nil
-      landing_params = (landing_uri && landing_uri.query_values) || {}
+      landing_params = {}
+      begin
+        landing_uri = URI.parse(landing_page)
+        # could also use Rack::Utils.parse_nested_query
+        landing_params = CGI.parse(landing_uri.query) if landing_uri
+      rescue
+        # do nothing
+      end
 
       props = {}
       %w(utm_source utm_medium utm_term utm_content utm_campaign).each do |name|
-        props[name.to_sym] = params[name] || landing_params[name]
+        props[name.to_sym] = params[name] || landing_params[name].try(:first)
       end
       props
     end
 
     def traffic_properties
-      # cache for performance
-      @@referrer_parser ||= RefererParser::Parser.new
-
+      uri = URI.parse(referrer) rescue nil
       {
-        referring_domain: (Addressable::URI.parse(referrer).host.first(255) rescue nil),
-        search_keyword: (@@referrer_parser.parse(@referrer)[:term].first(255) rescue nil).presence
+        referring_domain: uri.try(:host).try(:first, 255)
       }
     end
 
@@ -60,6 +62,9 @@ module Ahoy
           device_type: device_type
         }
       else
+        raise "Add browser to your Gemfile to use legacy user agent parsing" unless defined?(Browser)
+        raise "Add user_agent_parser to your Gemfile to use legacy user agent parsing" unless defined?(UserAgentParser)
+
         # cache for performance
         @@user_agent_parser ||= UserAgentParser::Parser.new
 

data/lib/generators/ahoy/activerecord_generator.rb

@@ -27,8 +27,7 @@ module Ahoy
         template "active_record_visit_model.rb", "app/models/ahoy/visit.rb"
         template "active_record_event_model.rb", "app/models/ahoy/event.rb"
         migration_template "active_record_migration.rb", "db/migrate/create_ahoy_visits_and_events.rb", migration_version: migration_version
-        migrate_command = rails5? ? "rails" : "rake"
-        puts "\nAlmost set! Last, run:\n\n    #{migrate_command} db:migrate"
+        puts "\nAlmost set! Last, run:\n\n    rails db:migrate"
       end
 
       def properties_type
@@ -44,14 +43,12 @@ module Ahoy
         end
       end
 
-      def rails5?
-        Rails::VERSION::MAJOR >= 5
+      def rails52?
+        ActiveRecord::VERSION::STRING >= "5.2"
       end
 
       def migration_version
-        if rails5?
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/ahoy/mongoid_generator.rb

@@ -11,10 +11,6 @@ module Ahoy
         template "mongoid_event_model.rb", "app/models/ahoy/event.rb"
         puts "\nAlmost set! Last, run:\n\n    rake db:mongoid:create_indexes"
       end
-
-      def rails5?
-        Rails::VERSION::MAJOR >= 5
-      end
     end
   end
 end

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

@@ -1,10 +1,10 @@
-class Ahoy::Event < <%= rails5? ? "ApplicationRecord" : "ActiveRecord::Base" %>
+class Ahoy::Event < ApplicationRecord
   include Ahoy::QueryMethods
 
   self.table_name = "ahoy_events"
 
   belongs_to :visit
-  belongs_to :user<%= rails5? ? ", optional: true" : nil %><% if properties_type == "text" %>
+  belongs_to :user, optional: true<% if properties_type == "text" %>
 
   serialize :properties, JSON<% end %>
 end

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

@@ -26,8 +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
+      t.float :latitude
+      t.float :longitude
 
       # utm parameters
       t.string :utm_source
@@ -55,7 +55,8 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.timestamp :time
     end
 
-    add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" && rails5? %>
-    add_index :ahoy_events, "properties jsonb_path_ops", using: "gin"<% end %>
+    add_index :ahoy_events, [:name, :time]<% if properties_type == "jsonb" %><% if rails52? %>
+    add_index :ahoy_events, :properties, using: :gin, opclass: :jsonb_path_ops<% else %>
+    add_index :ahoy_events, "properties jsonb_path_ops", using: "gin"<% end %><% end %>
   end
 end

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

@@ -1,6 +1,6 @@
-class Ahoy::Visit < <%= rails5? ? "ApplicationRecord" : "ActiveRecord::Base" %>
+class Ahoy::Visit < ApplicationRecord
   self.table_name = "ahoy_visits"
 
   has_many :events, class_name: "Ahoy::Event"
-  belongs_to :user<%= rails5? ? ", optional: true" : nil %>
+  belongs_to :user, optional: true
 end

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

@@ -18,9 +18,3 @@ end
 
 # set to true for JavaScript tracking
 Ahoy.api = false
-
-# better user agent parsing
-Ahoy.user_agent_parser = :device_detector
-
-# better bot detection
-Ahoy.bot_detection_version = 2

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

@@ -3,9 +3,3 @@ end
 
 # set to true for JavaScript tracking
 Ahoy.api = false
-
-# better user agent parsing
-Ahoy.user_agent_parser = :device_detector
-
-# better bot detection
-Ahoy.bot_detection_version = 2

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

@@ -3,7 +3,7 @@ class Ahoy::Event
 
   # associations
   belongs_to :visit, index: true
-  belongs_to :user, index: true<%= rails5? ? ", optional: true" : nil %>
+  belongs_to :user, index: true, optional: true
 
   # fields
   field :name, type: String

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

@@ -3,7 +3,7 @@ class Ahoy::Visit
 
   # associations
   has_many :events, class_name: "Ahoy::Event"
-  belongs_to :user, index: true<%= rails5? ? ", optional: true" : nil %>
+  belongs_to :user, index: true, optional: true
 
   # required
   field :visit_token, type: String

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  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'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: geocoder
   requirement: !ruby/object:Gem::Requirement
@@ -52,62 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.5
-- !ruby/object:Gem::Dependency
-  name: browser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: referer-parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: user_agent_parser
-  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: 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: safely_block
   requirement: !ruby/object:Gem::Requirement
@@ -288,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="