ahoy_matey 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac410ebebcbaf5aad9ccc62e1880017a529122f6
-  data.tar.gz: 9394bb160b09cc8b28d15c23c0d81443b37547c9
+  metadata.gz: 181105196800b983c765eacf7faa0ad9280a1553
+  data.tar.gz: 67a7a2cb8dea093d979323b384b18d3b7f4e4ba7
 SHA512:
-  metadata.gz: df2fd19329ea584adfc8a6a2f730fe651650f812c9806e75ade1869376fd787ffa7537621cf518ac8ffd42e9e83ee6e21828c826023c957622c8f94b8c544cf4
-  data.tar.gz: 7ae8ddc2287e8182055cb293558286127c49c594b0fcd3cb5516571d4ff3c1ecd71c1cc4de469f7d4dfccaa5f493b5cdc4037c734bb96a140173f5457d6c397f
+  metadata.gz: a3dd6aeb1bd934d5ae71b84b38188c8c991a28c764aeecebf1566e3f675c120953c3a443ad38330e5db68d530e7fd1bce7ad2d5f3e469fe8e6b403f4381a6257
+  data.tar.gz: ea652c7992e43801a5f6dc5bfac7284c336a6ab11e544a1298b96bf100807251f4059355f6650932f42a85ade1a6a2eac9e3204f14a32186289feabf26d03165

data/CHANGELOG.md

@@ -1,6 +1,12 @@
-## 1.3.1
+## 1.4.0
 
+- Use `ActiveRecordTokenStore` by default (integer instead of uuid for id)
+- Detect database for `rails g ahoy:stores:active_record` for easier installation
+- Use `safely` as default exception handler
 - Fixed issue with log silencer
+
+## 1.3.1
+
 - Raise errors in test environment
 
 ## 1.3.0

data/README.md

@@ -1,17 +1,11 @@
 # Ahoy
 
-:fire: Never build an analytics platform from scratch again.
-
-Ahoy provides a solid foundation to track visits and events in Ruby, JavaScript, and native apps.
-
-Works with any data store so you can easily scale.
+Ahoy provides a solid foundation to track visits and events in Ruby, JavaScript, and native apps. Works with any data store so you can easily scale.
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
 :postbox: To track emails, check out [Ahoy Email](https://github.com/ankane/ahoy_email).
 
-See [upgrade instructions](#100) on how to move to 1.0.
-
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -31,56 +25,23 @@ And add the javascript file in `app/assets/javascripts/application.js` after jQu
 
 Ahoy supports a number of data stores out of the box.  You can start with one of them and customize as needed, or create your own store from scratch.
 
-- [PostgreSQL](#postgresql)
-- [MySQL](#mysql-or-sqlite)
-- [SQLite](#mysql-or-sqlite)
+- [PostgreSQL, MySQL, or SQLite](#postgresql-mysql-or-sqlite)
 - [MongoDB](#mongodb)
 - [Fluentd](#fluentd)
-- [RabbitMQ](#rabbitmq-master)
-- [Kinesis Firehose](#kinesis-firehose-master)
+- [RabbitMQ](#rabbitmq)
+- [Amazon Kinesis Firehose](#amazon-kinesis-firehose)
 - [Logs](#logs)
 - [Custom](#custom)
 
-### PostgreSQL
-
-For Rails 4.2 and PostgreSQL 9.4 or greater, use:
-
-```sh
-rails generate ahoy:stores:active_record -d postgresql-jsonb
-rake db:migrate
-```
-
-For Rails 4 and PostgreSQL 9.2 or greater, use:
-
-```sh
-rails generate ahoy:stores:active_record -d postgresql
-rake db:migrate
-```
-
-Otherwise, follow the instructions for MySQL.
-
-### MySQL or SQLite
-
-Add [activeuuid](https://github.com/jashmenn/activeuuid) to your Gemfile.
-
-```ruby
-gem 'activeuuid', '>= 0.5.0'
-```
+### PostgreSQL, MySQL, or SQLite
 
-And run:
+Run:
 
 ```sh
 rails generate ahoy:stores:active_record
 rake db:migrate
 ```
 
-If you just want visits, run:
-
-```sh
-rails generate ahoy:stores:active_record_visits
-rake db:migrate
-```
-
 ### MongoDB
 
 ```sh
@@ -119,7 +80,7 @@ rails generate ahoy:stores:bunny
 
 Use `ENV["RABBITMQ_URL"]` to configure.
 
-### Kinesis Firehose
+### Amazon Kinesis Firehose
 
 Add [aws-sdk](https://github.com/aws/aws-sdk-ruby) to your Gemfile.
 
@@ -223,7 +184,7 @@ ahoy.authenticate(user)
 Stores are built to be highly customizable.
 
 ```ruby
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
   # add methods here
 end
 ```
@@ -233,7 +194,7 @@ end
 Exclude visits and events from being tracked with:
 
 ```ruby
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
   def exclude?
     bot? || request.ip == "192.168.1.1"
   end
@@ -245,7 +206,7 @@ Bots are excluded by default.
 ### Track Additional Values
 
 ```ruby
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
   def track_visit(options)
     super do |visit|
       visit.gclid = visit_properties.landing_params["gclid"]
@@ -265,7 +226,7 @@ end
 If you use a method other than `current_user`, set it here:
 
 ```ruby
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
   def user
     controller.true_user
   end
@@ -274,18 +235,12 @@ end
 
 ### Report Exceptions
 
-Exceptions are rescued so analytics do not break your app.
-
-Ahoy uses [Errbase](https://github.com/ankane/errbase) to try to report them to a service by default.
+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
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
-  def report_exception(e)
-    Rollbar.report_exception(e)
-  end
-end
+Safely.report_exception_method = proc { |e| Rollbar.error(e) }
 ```
 
 ### Use Different Models
@@ -293,7 +248,7 @@ end
 For ActiveRecord and Mongoid stores
 
 ```ruby
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
   def visit_model
     CustomVisit
   end
@@ -361,11 +316,13 @@ First, generate a migration and add a `visit_id` column.
 ```ruby
 class AddVisitIdToOrders < ActiveRecord::Migration
   def change
-    add_column :orders, :visit_id, :uuid
+    add_column :orders, :visit_id, :integer
   end
 end
 ```
 
+**Note**: Use the `uuid` column type if the `id` column on `visits` is a `uuid`.
+
 Then, add `visitable` to the model.
 
 ```ruby
@@ -406,7 +363,13 @@ Ahoy.geocode = :async
 
 For Rails 4.0 and 4.1, you’ll need to add [activejob_backport](https://github.com/ankane/activejob_backport).
 
-Or disable it with:
+To change the queue name (`ahoy` by default), use:
+
+```ruby
+Ahoy.job_queue = :low_priority
+```
+
+Or disable geocoding with:
 
 ```ruby
 Ahoy.geocode = false
@@ -505,7 +468,7 @@ added_item_ids = Ahoy::Event.where(user_id: viewed_store_ids, name: "Added item
 viewed_checkout_ids = Ahoy::Event.where(user_id: added_item_ids, name: "Viewed checkout").uniq.pluck(:user_id)
 ```
 
-The same approach also works with visitor ids.
+The same approach also works with visitor tokens.
 
 ## Native Apps
 
@@ -513,7 +476,7 @@ The same approach also works with visitor ids.
 
 When a user launches the app, create a visit.
 
-Generate a `visit_id` and `visitor_id` as [UUIDs](http://en.wikipedia.org/wiki/Universally_unique_identifier).
+Generate a `visit_token` and `visitor_token` as [UUIDs](http://en.wikipedia.org/wiki/Universally_unique_identifier).
 
 Send these values in the `Ahoy-Visit` and `Ahoy-Visitor` headers with all requests.
 
@@ -540,25 +503,34 @@ Use an array to pass multiple events at once.
 
 ## Upgrading
 
-### PostgreSQL 9.4 + JSONB
+### 1.4.0
 
-```sh
-rails g migration change_properties_to_jsonb_on_ahoy_events
+There’s nothing to do, but it’s worth noting the default store was changed from `ActiveRecordStore` to `ActiveRecordTokenStore` for new installations.
+
+### json -> jsonb
+
+Create a migration to add a new `jsonb` column.
+
+```ruby
+rename_column :ahoy_events, :properties, :properties_json
+add_column :ahoy_events, :properties, :jsonb
 ```
 
-And add:
+Restart your web server immediately afterwards, as Ahoy will rescue and report errors until then.
 
-```rb
-def up
-  change_column :ahoy_events, :properties, :jsonb, using: "properties::jsonb"
-end
+Sync the new column.
 
-def down
-  change_column :ahoy_events, :properties, :json
+```ruby
+Ahoy::Event.where(properties: nil).select(:id).find_in_batches do |events|
+  Ahoy::Event.where(id: events.map(&:id)).update_all("properties = properties_json::jsonb")
 end
 ```
 
-Note: This will lock the table while the migration is running.
+Then create a migration to drop the old column.
+
+```ruby
+remove_column :ahoy_events, :properties_json
+```
 
 ### 1.0.0
 

data/ahoy_matey.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails"
+  spec.add_dependency "railties"
   spec.add_dependency "addressable"
   spec.add_dependency "browser", "~> 2.0"
   spec.add_dependency "geocoder"
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "user_agent_parser"
   spec.add_dependency "request_store"
   spec.add_dependency "uuidtools"
-  spec.add_dependency "errbase"
+  spec.add_dependency "safely_block"
   spec.add_dependency "rack-attack"
 
   spec.add_development_dependency "bundler", "~> 1.5"

data/lib/ahoy.rb

@@ -1,4 +1,3 @@
-require "rails"
 require "active_support/core_ext"
 require "addressable/uri"
 require "browser"
@@ -7,7 +6,7 @@ require "referer-parser"
 require "user_agent_parser"
 require "request_store"
 require "uuidtools"
-require "errbase"
+require "safely_block"
 
 require "ahoy/version"
 require "ahoy/tracker"
@@ -27,7 +26,6 @@ require "ahoy/stores/fluentd_store"
 require "ahoy/stores/mongoid_store"
 require "ahoy/stores/kinesis_firehose_store"
 require "ahoy/stores/bunny_store"
-require "ahoy/log_silencer"
 require "ahoy/engine"
 require "ahoy/warden" if defined?(Warden)
 
@@ -77,6 +75,9 @@ module Ahoy
   mattr_accessor :throttle_period
   self.throttle_period = 1.minute
 
+  mattr_accessor :job_queue
+  self.job_queue = :ahoy
+
   def self.ensure_uuid(id)
     valid = UUIDTools::UUID.parse(id) rescue nil
     if valid

data/lib/ahoy/engine.rb

@@ -1,12 +1,30 @@
 module Ahoy
   class Engine < ::Rails::Engine
     initializer "ahoy.middleware", after: "sprockets.environment" do |app|
-      Rails::Rack::Logger.send(:prepend, Ahoy::LogSilencer) if Ahoy.quiet
-
       if Ahoy.throttle
         require "ahoy/throttle"
         app.middleware.use Ahoy::Throttle
       end
+
+      next unless Ahoy.quiet
+
+      # Parse PATH_INFO by assets prefix
+      AHOY_PREFIX = "/ahoy/".freeze
+
+      # Just create an alias for call in middleware
+      Rails::Rack::Logger.class_eval do
+        def call_with_quiet_ahoy(env)
+          if env["PATH_INFO"].start_with?(AHOY_PREFIX) && logger.respond_to?(:silence_logger)
+            logger.silence_logger do
+              call_without_quiet_ahoy(env)
+            end
+          else
+            call_without_quiet_ahoy(env)
+          end
+        end
+        alias_method :call_without_quiet_ahoy, :call
+        alias_method :call, :call_with_quiet_ahoy
+      end
     end
   end
 end

data/lib/ahoy/stores/active_record_token_store.rb

@@ -7,7 +7,8 @@ module Ahoy
             v.visit_token = ahoy.visit_token
             v.visitor_token = ahoy.visitor_token
             v.user = user if v.respond_to?(:user=)
-            v.created_at = options[:started_at]
+            v.started_at = options[:started_at] if v.respond_to?(:started_at)
+            v.created_at = options[:started_at] if v.respond_to?(:created_at)
           end
 
         set_visit_properties(visit)

data/lib/ahoy/stores/base_store.rb

@@ -27,7 +27,7 @@ module Ahoy
       end
 
       def report_exception(e)
-        Errbase.report(e)
+        raise e
       end
 
       def user
@@ -73,7 +73,7 @@ module Ahoy
 
       def geocode(visit)
         if Ahoy.geocode == :async
-          Ahoy::GeocodeJob.perform_later(visit)
+          Ahoy::GeocodeJob.set(queue: Ahoy.job_queue).perform_later(visit)
         end
       end
 

data/lib/ahoy/tracker.rb

@@ -124,15 +124,14 @@ module Ahoy
       @store.exclude?
     end
 
+    # odd pattern for backwards compatibility
+    # TODO remove this method in next major release
     def report_exception(e)
-      begin
+      safely do
         @store.report_exception(e)
-      rescue
-        # fail-safe
-        $stderr.puts "Error reporting exception"
-      end
-      if Rails.env.development? || Rails.env.test?
-        raise e
+        if Rails.env.development? || Rails.env.test?
+          raise e
+        end
       end
     end
 

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/lib/generators/ahoy/stores/active_record_events_generator.rb

@@ -24,7 +24,8 @@ module Ahoy
         end
 
         def copy_migration
-          unless options["database"].in?([nil, "postgresql", "postgresql-jsonb"])
+          @database = options["database"] || detect_database
+          unless @database.in?([nil, "postgresql", "postgresql-jsonb", "mysql", "sqlite"])
             raise Thor::Error, "Unknown database option"
           end
           migration_template "active_record_events_migration.rb", "db/migrate/create_ahoy_events.rb"
@@ -37,6 +38,15 @@ module Ahoy
         def create_initializer
           template "active_record_initializer.rb", "config/initializers/ahoy.rb"
         end
+
+        def detect_database
+          postgresql_version = ActiveRecord::Base.connection.send(:postgresql_version) rescue 0
+          if postgresql_version >= 90400
+            "postgresql-jsonb"
+          elsif postgresql_version >= 90200
+            "postgresql"
+          end
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@ module Ahoy
     self.table_name = "ahoy_events"
 
     belongs_to :visit
-    belongs_to :user<% if options["database"].blank? %>
+    belongs_to :user<% unless %w(postgresql postgresql-jsonb).include?(@database) %>
 
     serialize :properties, JSON<% end %>
   end

data/lib/generators/ahoy/stores/templates/active_record_events_migration.rb

@@ -1,20 +1,19 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
-    create_table :ahoy_events, id: false do |t|
-      t.uuid :id, default: nil, primary_key: true
-      t.uuid :visit_id, default: nil
+    create_table :ahoy_events do |t|
+      t.integer :visit_id
 
       # user
       t.integer :user_id
       # add t.string :user_type if polymorphic
 
       t.string :name
-      t.<% case options["database"] when "postgresql" %>json<% when "postgresql-jsonb" %>jsonb<% else %>text<% end %> :properties
+      t.<% case @database when "postgresql" %>json<% when "postgresql-jsonb" %>jsonb<% else %>text<% end %> :properties
       t.timestamp :time
     end
 
-    add_index :ahoy_events, [:visit_id]
-    add_index :ahoy_events, [:user_id]
-    add_index :ahoy_events, [:time]
+    add_index :ahoy_events, [:visit_id, :name]
+    add_index :ahoy_events, [:user_id, :name]
+    add_index :ahoy_events, [:name, :time]
   end
 end

data/lib/generators/ahoy/stores/templates/active_record_initializer.rb

@@ -1,3 +1,3 @@
-class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
   # customize here
 end

data/lib/generators/ahoy/stores/templates/active_record_visits_migration.rb

@@ -1,8 +1,8 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
-    create_table :visits, id: false do |t|
-      t.uuid :id, default: nil, primary_key: true
-      t.uuid :visitor_id, default: nil
+    create_table :visits do |t|
+      t.string :visit_token
+      t.string :visitor_token
 
       # the rest are recommended but optional
       # simply remove the columns you don't want
@@ -51,6 +51,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.timestamp :started_at
     end
 
+    add_index :visits, [:visit_token], unique: true
     add_index :visits, [:user_id]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: errbase
+  name: safely_block
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -219,7 +219,6 @@ files:
 - lib/ahoy/deckhands/utm_parameter_deckhand.rb
 - lib/ahoy/engine.rb
 - lib/ahoy/geocode_job.rb
-- lib/ahoy/log_silencer.rb
 - lib/ahoy/logger_silencer.rb
 - lib/ahoy/model.rb
 - lib/ahoy/stores/active_record_store.rb

data/lib/ahoy/log_silencer.rb

@@ -1,16 +0,0 @@
-module Ahoy
-  module LogSilencer
-    PATH_INFO = "PATH_INFO".freeze
-    AHOY_PREFIX = "/ahoy/".freeze
-
-    def call(env)
-      if env[PATH_INFO].start_with?(AHOY_PREFIX) && logger.respond_to?(:silence_logger)
-        logger.silence_logger do
-          super
-        end
-      else
-        super
-      end
-    end
-  end
-end