ahoy_matey 1.6.1 → 2.0.0

data/Rakefile

@@ -5,4 +5,5 @@ task default: :test
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"
+  t.warning = false
 end

data/ahoy_matey.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["andrew@chartkick.com"]
   spec.summary       = "Simple, powerful visit tracking for Rails"
-  spec.description   = "Simple, powerful visit tracking for Rails"
   spec.homepage      = "https://github.com/ankane/ahoy"
   spec.license       = "MIT"
 
@@ -18,21 +17,20 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties"
+  spec.add_dependency "railties", ">= 4.2"
   spec.add_dependency "addressable"
-  spec.add_dependency "browser", "~> 2.0"
   spec.add_dependency "geocoder"
-  spec.add_dependency "referer-parser", ">= 0.3.0"
+  spec.add_dependency "browser", "~> 2.0"
+  spec.add_dependency "referer-parser", ">= 0.3"
   spec.add_dependency "user_agent_parser"
   spec.add_dependency "request_store"
-  spec.add_dependency "uuidtools"
-  spec.add_dependency "safely_block", ">= 0.1.1"
-  spec.add_dependency "rack-attack", "< 6"
+  spec.add_dependency "safely_block", ">= 0.2.1"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "mongoid"
 end

data/app/controllers/ahoy/base_controller.rb

@@ -1,18 +1,14 @@
 module Ahoy
   class BaseController < ApplicationController
-    # skip all filters except for authlogic
-    filters = _process_action_callbacks.map(&:filter) - [:load_authlogic]
+    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)
       before_action :verify_request_size
-    elsif respond_to?(:skip_action_callback)
+    else
       skip_action_callback *filters
       before_action :verify_request_size
-    else
-      skip_filter *filters
-      before_filter :verify_request_size
     end
 
     if respond_to?(:protect_from_forgery)

data/app/controllers/ahoy/events_controller.rb

@@ -8,8 +8,14 @@ module Ahoy
         elsif params[:events]
           request.params[:events]
         else
+          data =
+            if params[:events_json]
+              request.params[:events_json]
+            else
+              request.body.read
+            end
           begin
-            ActiveSupport::JSON.decode(request.body.read)
+            ActiveSupport::JSON.decode(data)
           rescue ActiveSupport::JSON.parse_error
             # do nothing
             []

data/app/controllers/ahoy/visits_controller.rb

@@ -2,7 +2,13 @@ module Ahoy
   class VisitsController < BaseController
     def create
       ahoy.track_visit
-      render json: {visit_id: ahoy.visit_id, visitor_id: ahoy.visitor_id}
+      render json: {
+        visit_token: ahoy.visit_token,
+        visitor_token: ahoy.visitor_token,
+        # legacy
+        visit_id: ahoy.visit_token,
+        visitor_id: ahoy.visitor_token
+      }
     end
   end
 end

data/app/jobs/ahoy/geocode_job.rb

@@ -0,0 +1,10 @@
+# for smooth update from Ahoy 1 -> 2
+module Ahoy
+  class GeocodeJob < ActiveJob::Base
+    queue_as { Ahoy.job_queue }
+
+    def perform(visit)
+      Ahoy::GeocodeV2Job.perform_now(visit.visit_token, visit.ip)
+    end
+  end
+end

data/app/jobs/ahoy/geocode_v2_job.rb

@@ -0,0 +1,29 @@
+module Ahoy
+  class GeocodeV2Job < ActiveJob::Base
+    queue_as { Ahoy.job_queue }
+
+    def perform(visit_token, ip)
+      location =
+        begin
+          Geocoder.search(ip).first
+        rescue => e
+          $stderr.puts e.message
+          nil
+        end
+
+      if location
+        data = {
+          visit_token: visit_token,
+          country: location.try(:country).presence,
+          region: location.try(:state).presence,
+          city: location.try(:city).presence,
+          postal_code: location.try(:postal_code).presence,
+          latitude: location.try(:latitude).presence,
+          longitude: location.try(:longitude).presence
+        }
+
+        Ahoy::Tracker.new(visit_token: visit_token).geocode(data)
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-  mount Ahoy::Engine => "/ahoy" if Ahoy.mount
+  mount Ahoy::Engine => "/ahoy" if Ahoy.api
 end
 
 Ahoy::Engine.routes.draw do

data/docs/Ahoy-2-Upgrade.md

@@ -0,0 +1,147 @@
+# Ahoy 2 Upgrade
+
+Ahoy 2.0 brings a number of exciting changes:
+
+- jQuery is no longer required
+- Uses `navigator.sendBeacon` by default in supported browsers
+- Simpler interface for data stores
+
+## How to Upgrade
+
+Update your Gemfile:
+
+```ruby
+gem 'ahoy_matey', '~> 2'
+```
+
+And run:
+
+```sh
+bundle install
+```
+
+Add to `config/initializers/ahoy.rb`:
+
+```ruby
+Ahoy.api = true
+Ahoy.server_side_visits = false
+```
+
+If you use `visitable`, add `class_name` to each instance:
+
+```ruby
+visitable class_name: "Visit"
+```
+
+Then follow the instructions for your data store.
+
+- [ActiveRecordTokenStore](#activerecordtokenstore)
+- [ActiveRecordStore](#activerecordstore)
+- [MongoidStore](#mongoidstore)
+- [Others](#others)
+
+## Data Stores
+
+### ActiveRecordTokenStore
+
+In `config/initializers/ahoy.rb`, replace `Ahoy::Store` with:
+
+```ruby
+class Ahoy::Store < Ahoy::DatabaseStore
+  def visit_model
+    Visit
+  end
+end
+```
+
+### ActiveRecordStore
+
+Add [uuidtools](https://github.com/sporkmonger/uuidtools) to your Gemfile.
+
+In `config/initializers/ahoy.rb`, replace `Ahoy::Store` with:
+
+```ruby
+class Ahoy::Store < Ahoy::DatabaseStore
+  def track_visit(data)
+    data[:id] = ensure_uuid(data.delete(:visit_token))
+    data[:visitor_id] = ensure_uuid(data.delete(:visitor_token))
+    super(data)
+  end
+
+  def track_event(data)
+    data[:id] = ensure_uuid(data.delete(:event_id))
+    super(data)
+  end
+
+  def visit
+    @visit ||= visit_model.find_by(id: ensure_uuid(ahoy.visit_token)) if ahoy.visit_token
+  end
+
+  def visit_model
+    Visit
+  end
+
+  UUID_NAMESPACE = UUIDTools::UUID.parse("a82ae811-5011-45ab-a728-569df7499c5f")
+
+  def ensure_uuid(id)
+    UUIDTools::UUID.parse(id).to_s
+  rescue
+    UUIDTools::UUID.sha1_create(UUID_NAMESPACE, id).to_s
+  end
+end
+```
+
+### MongoidStore
+
+In `config/initializers/ahoy.rb`, replace `Ahoy::Store` with:
+
+```ruby
+class Ahoy::Store < Ahoy::DatabaseStore
+  def track_visit(data)
+    data[:_id] = binary_uuid(data.delete(:visit_token))
+    data[:visitor_id] = binary_uuid(data.delete(:visitor_token))
+    super(data)
+  end
+
+  def track_event(data)
+    data[:_id] = binary_uuid(data.delete(:event_id))
+    super(data)
+  end
+
+  def geocode(data)
+    visit_model.where(id: binary_uuid(ahoy.visit_token)).find_one_and_update({"$set": data}, {upsert: true})
+  end
+
+  def visit
+    @visit ||= visit_model.where(id: binary_uuid(ahoy.visit_token)).first if ahoy.visit_token
+  end
+
+  def visit_model
+    Visit
+  end
+
+  def binary_uuid(token)
+    token = token.delete("-")
+    if defined?(::BSON)
+      ::BSON::Binary.new(token, :uuid)
+    elsif defined?(::Moped::BSON)
+      ::Moped::BSON::Binary.new(:uuid, token)
+    else
+      token
+    end
+  end
+end
+```
+
+### Others
+
+Check out the [data store examples](Data-Store-Examples.md).
+
+## Throttling
+
+Throttling was removed due to limited practical usefulness. See [instructions for adding it back](../README.md#throttling) if you need it.
+
+## Options
+
+- The `mount` option was renamed to `api`
+- The `track_visits_immediately` option was renamed to `server_side_visits`

data/docs/Data-Store-Examples.md

@@ -0,0 +1,240 @@
+# Data Store Examples
+
+- [Kafka](#kafka)
+- [RabbitMQ](#rabbitmq)
+- [Fluentd](#fluentd)
+- [NATS](#nats)
+- [NSQ](#nsq)
+- [Amazon Kinesis Firehose](#amazon-kinesis-firehose)
+
+### Kafka
+
+Add [ruby-kafka](https://github.com/zendesk/ruby-kafka) to your Gemfile.
+
+```ruby
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    post("ahoy_visits", data)
+  end
+
+  def track_event(data)
+    post("ahoy_events", data)
+  end
+
+  def geocode(data)
+    post("ahoy_geocode", data)
+  end
+
+  def authenticate(data)
+    post("ahoy_auth", data)
+  end
+
+  private
+
+  def post(topic, data)
+    producer.produce(data.to_json, topic: topic)
+  end
+
+  def producer
+    @producer ||= begin
+      client =
+        Kafka.new(
+          seed_brokers: ENV["KAFKA_URL"] || "localhost:9092",
+          logger: Rails.logger
+        )
+      producer = client.async_producer(delivery_interval: 3)
+      at_exit { producer.shutdown }
+      producer
+    end
+  end
+end
+```
+
+### RabbitMQ
+
+Add [bunny](https://github.com/ruby-amqp/bunny) to your Gemfile.
+
+```ruby
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    post("ahoy_visits", data)
+  end
+
+  def track_event(data)
+    post("ahoy_events", data)
+  end
+
+  def geocode(data)
+    post("ahoy_geocode", data)
+  end
+
+  def authenticate(data)
+    post("ahoy_auth", data)
+  end
+
+  private
+
+  def post(topic, message)
+    channel.queue(topic, durable: true).publish(message.to_json)
+  end
+
+  def channel
+    @channel ||= begin
+      conn = Bunny.new
+      conn.start
+      conn.create_channel
+    end
+  end
+end
+```
+
+### Fluentd
+
+Add [fluent-logger](https://github.com/fluent/fluent-logger-ruby) to your Gemfile.
+
+```ruby
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    post("ahoy_visits", data)
+  end
+
+  def track_event(data)
+    post("ahoy_events", data)
+  end
+
+  def geocode(data)
+    post("ahoy_geocode", data)
+  end
+
+  def authenticate(data)
+    post("ahoy_auth", data)
+  end
+
+  private
+
+  def post(topic, message)
+    logger.post(topic, message)
+  end
+
+  def logger
+    @logger ||= Fluent::Logger::FluentLogger.new("ahoy", host: "localhost", port: 24224)
+  end
+end
+```
+
+### NATS
+
+Add [nats-pure](https://github.com/nats-io/pure-ruby-nats) to your Gemfile.
+
+```ruby
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    post("ahoy_visits", data)
+  end
+
+  def track_event(data)
+    post("ahoy_events", data)
+  end
+
+  def geocode(data)
+    post("ahoy_geocode", data)
+  end
+
+  def authenticate(data)
+    post("ahoy_auth", data)
+  end
+
+  private
+
+  def post(topic, data)
+    client.publish(topic, data.to_json)
+  end
+
+  def client
+    @client ||= begin
+      require "nats/io/client"
+      client = NATS::IO::Client.new
+      client.connect(servers: (ENV["NATS_URL"] || "nats://127.0.0.1:4222").split(","))
+      client
+    end
+  end
+end
+```
+
+### NSQ
+
+Add [nsq-ruby](https://github.com/wistia/nsq-ruby) to your Gemfile.
+
+```ruby
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    post("ahoy_visits", data)
+  end
+
+  def track_event(data)
+    post("ahoy_events", data)
+  end
+
+  def geocode(data)
+    post("ahoy_geocode", data)
+  end
+
+  def authenticate(data)
+    post("ahoy_auth", data)
+  end
+
+  private
+
+  def post(topic, data)
+    client.write_to_topic(topic, data.to_json)
+  end
+
+  def client
+    @client ||= begin
+      require "nsq"
+      client = Nsq::Producer.new(
+        nsqd: ENV["NSQ_URL"] || "127.0.0.1:4150"
+      )
+      at_exit { client.terminate }
+      client
+    end
+  end
+end
+```
+
+### Amazon Kinesis Firehose
+
+Add [aws-sdk-firehose](https://github.com/aws/aws-sdk-ruby) to your Gemfile.
+
+```ruby
+class Ahoy::Store < Ahoy::BaseStore
+  def track_visit(data)
+    post("ahoy_visits", data)
+  end
+
+  def track_event(data)
+    post("ahoy_events", data)
+  end
+
+  def geocode(data)
+    post("ahoy_geocode", data)
+  end
+
+  def authenticate(data)
+    post("ahoy_auth", data)
+  end
+
+  private
+
+  def post(topic, data)
+    client.put_record(
+      delivery_stream_name: topic,
+      record: {data: "#{data.to_json}\n"}
+    )
+  end
+
+  def client
+    @client ||= Aws::Firehose::Client.new
+  end
+end
+```