ahoy_matey 2.2.1 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b0851dfc7538c6768d6f694d7e8356f0aef3e3ff66ba361447e000a2db5bac
-  data.tar.gz: c28eb30ab780037d83550d359a36d6790e3a16f60b314b5d0be170d11b3c427b
+  metadata.gz: 141aeb0d7f78023ecefb04f274637e06c68d6d8af9ece0ac583d8cff701b59f9
+  data.tar.gz: f44945bbdad4be224a57b4e915175ef983c4c24ed28eca4accc8e5fcce171105
 SHA512:
-  metadata.gz: 85fb407054564104efc83ae3d425c6253db7495d6f6d4156c741156f64fcd7fe048035f78e4563bf9ec92c69c7e6dfef41e29f7d1031174705b17c595ef96572
-  data.tar.gz: ff03757afbb0deca1a11dc4ece02310bbd8a03f644f675c2eee32c1bf7711013f0cd38eb0fd009541b97b3a5b914a756279e88dbe0cbc8a8bd14ed064d648089
+  metadata.gz: ee9f88551691cc6be92b5adf9bfd0495065e43510679a61377bc12082c44ac7b0cff544ca88b3157ec92d05432ff58e654b491c7e256eb2c6032b5517573e6e3
+  data.tar.gz: 45565919c04c0f7c05cf87d0ef0f35fedd867cbd7569ee72a613770efab6a0c7dac1d884d6d0830c4f28efcf475ece191e7d44cb3712b18454c30b0de1658a4d

data/CHANGELOG.md

@@ -1,15 +1,42 @@
-## 2.2.1
+## 3.0.4 (2020-06-07)
+
+- Updated Ahoy.js to 0.3.6
+
+## 3.0.3 (2020-04-17)
+
+- Updated Ahoy.js to 0.3.5
+
+## 3.0.2 (2020-04-03)
+
+- Added `cookie_options`
+
+## 3.0.1 (2019-09-21)
+
+- Made `Ahoy::Tracker` work outside of requests
+- Fixed storage of `false` values with customized store
+- Fixed error with `user_method` and `Rails::InfoController`
+- Gracefully handle `ActionDispatch::RemoteIp::IpSpoofAttackError`
+
+## 3.0.0 (2019-05-29)
+
+- 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 (2019-05-26)
 
 - Updated Ahoy.js to 0.3.4
 - Fixed v2 bot detection
 - Added latitude and longitude to installation
 
-## 2.2.0
+## 2.2.0 (2019-01-04)
 
 - Added `amp_event` helper
 - Improved bot detection for Device Detector
 
-## 2.1.0
+## 2.1.0 (2018-05-18)
 
 - Added option for IP masking
 - Added option to use anonymity sets instead of cookies
@@ -17,19 +44,19 @@
 - Fixed `visitable` for Rails 4.2
 - Removed `search_keyword` from new installs
 
-## 2.0.2
+## 2.0.2 (2018-03-14)
 
 - Fixed error on duplicate records
 - Fixed message when visit not found for geocoding
 - Better compatibility with GeoLite2
 - Better browser compatibility for Ahoy.js
 
-## 2.0.1
+## 2.0.1 (2018-02-26)
 
 - Added `Ahoy.server_side_visits = :when_needed` to automatically create visits server-side when needed for events and `visitable`
 - Better handling of visit duration and expiration in JavaScript
 
-## 2.0.0
+## 2.0.0 (2018-02-25)
 
 - Removed dependency on jQuery
 - Use `navigator.sendBeacon` by default in supported browsers
@@ -51,58 +78,58 @@ Breaking changes
 - Removed most built-in stores
 - Removed support for Rails < 4.2
 
-## 1.6.1
+## 1.6.1 (2018-02-02)
 
 - Added `gin` index on properties for events
 - Fixed `visitable` options when name not provided
 
-## 1.6.0
+## 1.6.0 (2017-05-01)
 
 - Added support for Rails 5.1
 
-## 1.5.5
+## 1.5.5 (2017-03-23)
 
 - Added support for Rails API
 - Added NATS and NSQ stores
 
-## 1.5.4
+## 1.5.4 (2017-01-22)
 
 - Fixed issue with duplicate events
 - Added support for PostGIS for `where_properties`
 
-## 1.5.3
+## 1.5.3 (2016-10-31)
 
 - Fixed error with Rails 5 and Mongoid 6
 - Fixed regression with server not generating visit and visitor tokens
 - Accept UTM parameters as request parameters (for native apps)
 
-## 1.5.2
+## 1.5.2 (2016-08-26)
 
 - Better support for Rails 5
 
-## 1.5.1
+## 1.5.1 (2016-08-19)
 
 - Restored throttling after removing side effects
 
-## 1.5.0
+## 1.5.0 (2016-08-19)
 
 - Removed throttling due to unintended side effects with its implementation
 - Ensure basic token requirements
 - Fixed visit recreation on cookie expiration
 - Fixed issue where `/ahoy/visits` is called indefinitely when `Ahoy.cookie_domain = :all`
 
-## 1.4.2
+## 1.4.2 (2016-06-21)
 
 - Fixed issues with `where_properties`
 
-## 1.4.1
+## 1.4.1 (2016-06-20)
 
 - Added `where_properties` method
 - Added Kafka store
 - Added `mount` option
 - Use less intrusive version of `safely`
 
-## 1.4.0
+## 1.4.0 (2016-03-23)
 
 - Use `ActiveRecordTokenStore` by default (integer instead of uuid for id)
 - Detect database for `rails g ahoy:stores:active_record` for easier installation
@@ -110,55 +137,55 @@ Breaking changes
 - Fixed issue with log silencer
 - Use multi-column indexes on `ahoy_events` table creation
 
-## 1.3.1
+## 1.3.1 (2016-03-22)
 
 - Raise errors in test environment
 
-## 1.3.0
+## 1.3.0 (2016-03-06)
 
 - Added throttling
 - Added `max_content_length` and `max_events_per_request`
 
-## 1.2.2
+## 1.2.2 (2016-03-05)
 
 - Fixed issue with latest version of `browser` gem
 - Added support for RabbitMQ
 - Added support for Amazon Kinesis Firehose
 - Fixed deprecation warnings in Rails 5
 
-## 1.2.1
+## 1.2.1 (2015-08-14)
 
 - Fixed `SystemStackError: stack level too deep` when used with `activerecord-session_store`
 
-## 1.2.0
+## 1.2.0 (2015-06-07)
 
 - Added support for PostgreSQL `jsonb` column type
 - Added Fluentd store
 - Added latitude, longitude, and postal_code to visits
 - Log exclusions
 
-## 1.1.1
+## 1.1.1 (2015-01-05)
 
 - Better support for Authlogic
 - Added `screen_height` and `screen_width`
 
-## 1.1.0
+## 1.1.0 (2014-11-02)
 
 - Added `geocode` option
 - Report errors to service by default
 - Fixed association mismatch
 
-## 1.0.2
+## 1.0.2 (2014-07-10)
 
 - Fixed BSON for Mongoid 3
 - Fixed Doorkeeper integration
 - Fixed user tracking in overridden authenticate method
 
-## 1.0.1
+## 1.0.1 (2014-06-27)
 
 - Fixed `visitable` outside of requests
 
-## 1.0.0
+## 1.0.0 (2014-06-18)
 
 - Added support for any data store, and Mongoid out of the box
 - Added `track_visits_immediately` option
@@ -166,17 +193,17 @@ Breaking changes
 - Visits expire after inactivity, not fixed interval
 - Added `visit_duration` and `visitor_duration` options
 
-## 0.3.2
+## 0.3.2 (2014-06-15)
 
 - Fixed bot exclusion for visits
 - Fixed user method
 
-## 0.3.1
+## 0.3.1 (2014-06-12)
 
 - Fixed visitor cookies when set on server
 - Added `domain` option for server cookies
 
-## 0.3.0
+## 0.3.0 (2014-06-11)
 
 - Added `current_visit_token` and `current_visitor_token` method
 - Switched to UUIDs
@@ -184,47 +211,47 @@ Breaking changes
 - Skip server-side bot events
 - Added `request` argument to `exclude_method`
 
-## 0.2.2
+## 0.2.2 (2014-05-26)
 
 - Added `exclude_method` option
 - Added support for batch events
 - Fixed cookie encoding
 - Fixed `options` variable from being modified
 
-## 0.2.1
+## 0.2.1 (2014-05-16)
 
 - Fixed IE 8 error
 - Added `track_bots` option
 - Added `$authenticate` event
 
-## 0.2.0
+## 0.2.0 (2014-05-13)
 
 - Added event tracking (merged ahoy_events)
 - Added ahoy.js
 
-## 0.1.8
+## 0.1.8 (2014-05-11)
 
 - Fixed bug with `user_type` set to `false` instead of `nil`
 
-## 0.1.7
+## 0.1.7 (2014-05-11)
 
 - Made cookie functions public for ahoy_events
 
-## 0.1.6
+## 0.1.6 (2014-05-07)
 
 - Better user agent parser
 
-## 0.1.5
+## 0.1.5 (2014-05-01)
 
 - Added support for Doorkeeper
 - Added options to `visitable`
 - Added `landing_params` method
 
-## 0.1.4
+## 0.1.4 (2014-04-27)
 
 - Added `ahoy.ready()` and `ahoy.log()` for events
 
-## 0.1.3
+## 0.1.3 (2014-04-24)
 
 - Supports `current_user` from `ApplicationController`
 - Added `ahoy.reset()`
@@ -232,16 +259,16 @@ Breaking changes
 - Added experimental support for native apps
 - Prefer `ahoy` over `Ahoy`
 
-## 0.1.2
+## 0.1.2 (2014-04-15)
 
 - Attach user on Devise sign up
 - Ability to specify visit model
 
-## 0.1.1
+## 0.1.1 (2014-03-20)
 
 - Made most database columns optional
 - Performance hack for referer-parser
 
-## 0.1.0
+## 0.1.0 (2014-03-19)
 
 - First major release

data/README.md

@@ -1,10 +1,10 @@
 # Ahoy
 
-:fire: Simple, powerful analytics for Rails
+: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.
 
-:postbox: To track emails, check out [Ahoy Email](https://github.com/ankane/ahoy_email), and for A/B testing, check out [Field Test](https://github.com/ankane/field_test)
+: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)
 
@@ -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).
@@ -189,7 +181,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[5.2]
+class AddVisitIdToOrders < ActiveRecord::Migration[6.0]
   def change
     add_column :orders, :ahoy_visit_id, :bigint
   end
@@ -300,7 +292,7 @@ By default, a new visit is created after 4 hours of inactivity. Change this with
 Ahoy.visit_duration = 30.minutes
 ```
 
-### Multiple Subdomains
+### Cookies
 
 To track visits across multiple subdomains, use:
 
@@ -308,6 +300,12 @@ To track visits across multiple subdomains, use:
 Ahoy.cookie_domain = :all
 ```
 
+Set other [cookie options](https://api.rubyonrails.org/classes/ActionDispatch/Cookies.html) with:
+
+```ruby
+Ahoy.cookie_options = {same_site: :lax}
+```
+
 ### Geocoding
 
 Disable geocoding with:
@@ -316,7 +314,7 @@ Disable geocoding with:
 Ahoy.geocode = false
 ```
 
-Change the job queue with:
+The default job queue is `:ahoy`. Change this with:
 
 ```ruby
 Ahoy.job_queue = :low_priority
@@ -415,6 +413,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
@@ -433,6 +433,28 @@ Ahoy.cookies = false
 
 Previously set cookies are automatically deleted.
 
+## Data Retention
+
+Delete older data with:
+
+```ruby
+Ahoy::Visit.where("started_at < ?", 2.years.ago).find_in_batches do |visits|
+  visit_ids = visits.map(&:id)
+  Ahoy::Event.where(visit_id: visit_ids).delete_all
+  Ahoy::Visit.where(id: visit_ids).delete_all
+end
+```
+
+Delete data for a specific user with:
+
+```ruby
+user_id = 123
+visit_ids = Ahoy::Visit.where(user_id: user_id).pluck(:id)
+Ahoy::Event.where(visit_id: visit_ids).delete_all
+Ahoy::Visit.where(id: visit_ids).delete_all
+Ahoy::Event.where(user_id: user_id).delete_all
+```
+
 ## Development
 
 Ahoy is built with developers in mind. You can run the following code in your browser’s console.
@@ -507,7 +529,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 +653,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`: