RubyGems - ahoy_matey - Versions diffs - 1.6.1 → 2.0.0 - Mend

ahoy_matey 1.6.1 → 2.0.0

Files changed (95) hide show

checksums.yaml +4 -4
data/.github/ISSUE_TEMPLATE.md +7 -0
data/CHANGELOG.md +22 -0
data/CONTRIBUTING.md +40 -0
data/LICENSE.txt +1 -1
data/README.md +210 -489
data/Rakefile +1 -0
data/ahoy_matey.gemspec +6 -8
data/app/controllers/ahoy/base_controller.rb +2 -6
data/app/controllers/ahoy/events_controller.rb +7 -1
data/app/controllers/ahoy/visits_controller.rb +7 -1
data/app/jobs/ahoy/geocode_job.rb +10 -0
data/app/jobs/ahoy/geocode_v2_job.rb +29 -0
data/config/routes.rb +1 -1
data/docs/Ahoy-2-Upgrade.md +147 -0
data/docs/Data-Store-Examples.md +240 -0
data/lib/ahoy.rb +30 -88
data/lib/ahoy/base_store.rb +72 -0
data/lib/ahoy/controller.rb +4 -10
data/lib/ahoy/database_store.rb +72 -0
data/lib/ahoy/engine.rb +5 -7
data/lib/ahoy/model.rb +4 -26
data/lib/ahoy/{properties.rb → query_methods.rb} +18 -4
data/lib/ahoy/tracker.rb +60 -38
data/lib/ahoy/version.rb +1 -1
data/lib/ahoy/visit_properties.rb +65 -39
data/lib/generators/ahoy/activerecord_generator.rb +58 -0
data/lib/generators/ahoy/base_generator.rb +13 -0
data/lib/generators/ahoy/install_generator.rb +44 -0
data/lib/generators/ahoy/mongoid_generator.rb +20 -0
data/lib/generators/ahoy/templates/active_record_event_model.rb +10 -0
data/lib/generators/ahoy/{stores/templates/active_record_visits_migration.rb → templates/active_record_migration.rb} +19 -21
data/lib/generators/ahoy/templates/active_record_visit_model.rb +6 -0
data/lib/generators/ahoy/templates/base_store_initializer.rb +17 -0
data/lib/generators/ahoy/templates/database_store_initializer.rb +5 -0
data/lib/generators/ahoy/{stores/templates → templates}/mongoid_event_model.rb +4 -2
data/lib/generators/ahoy/{stores/templates → templates}/mongoid_visit_model.rb +7 -3
data/test/query_methods/mongoid_test.rb +23 -0
data/test/{properties → query_methods}/mysql_json_test.rb +1 -1
data/test/{properties → query_methods}/mysql_text_test.rb +1 -1
data/test/{properties → query_methods}/postgresql_hstore_test.rb +1 -1
data/test/{properties → query_methods}/postgresql_json_test.rb +1 -1
data/test/{properties → query_methods}/postgresql_jsonb_test.rb +1 -1
data/test/{properties → query_methods}/postgresql_text_test.rb +1 -1
data/test/test_helper.rb +4 -3
data/vendor/assets/javascripts/ahoy.js +551 -325
metadata +67 -112
data/lib/ahoy/deckhands/location_deckhand.rb +0 -49
data/lib/ahoy/deckhands/request_deckhand.rb +0 -52
data/lib/ahoy/deckhands/technology_deckhand.rb +0 -47
data/lib/ahoy/deckhands/traffic_source_deckhand.rb +0 -22
data/lib/ahoy/deckhands/utm_parameter_deckhand.rb +0 -23
data/lib/ahoy/geocode_job.rb +0 -13
data/lib/ahoy/logger_silencer.rb +0 -75
data/lib/ahoy/stores/active_record_store.rb +0 -61
data/lib/ahoy/stores/active_record_token_store.rb +0 -114
data/lib/ahoy/stores/base_store.rb +0 -88
data/lib/ahoy/stores/bunny_store.rb +0 -33
data/lib/ahoy/stores/fluentd_store.rb +0 -17
data/lib/ahoy/stores/kafka_store.rb +0 -42
data/lib/ahoy/stores/kinesis_firehose_store.rb +0 -42
data/lib/ahoy/stores/log_store.rb +0 -53
data/lib/ahoy/stores/mongoid_store.rb +0 -63
data/lib/ahoy/stores/nats_store.rb +0 -34
data/lib/ahoy/stores/nsq_store.rb +0 -36
data/lib/ahoy/subscribers/active_record.rb +0 -19
data/lib/ahoy/throttle.rb +0 -17
data/lib/generators/ahoy/stores/active_record_events_generator.rb +0 -59
data/lib/generators/ahoy/stores/active_record_generator.rb +0 -16
data/lib/generators/ahoy/stores/active_record_visits_generator.rb +0 -49
data/lib/generators/ahoy/stores/bunny_generator.rb +0 -15
data/lib/generators/ahoy/stores/custom_generator.rb +0 -15
data/lib/generators/ahoy/stores/fluentd_generator.rb +0 -15
data/lib/generators/ahoy/stores/kafka_generator.rb +0 -15
data/lib/generators/ahoy/stores/kinesis_firehose_generator.rb +0 -15
data/lib/generators/ahoy/stores/log_generator.rb +0 -15
data/lib/generators/ahoy/stores/mongoid_events_generator.rb +0 -19
data/lib/generators/ahoy/stores/mongoid_generator.rb +0 -14
data/lib/generators/ahoy/stores/mongoid_visits_generator.rb +0 -27
data/lib/generators/ahoy/stores/nats_generator.rb +0 -15
data/lib/generators/ahoy/stores/nsq_generator.rb +0 -15
data/lib/generators/ahoy/stores/templates/active_record_event_model.rb +0 -12
data/lib/generators/ahoy/stores/templates/active_record_events_migration.rb +0 -20
data/lib/generators/ahoy/stores/templates/active_record_initializer.rb +0 -3
data/lib/generators/ahoy/stores/templates/active_record_visit_model.rb +0 -4
data/lib/generators/ahoy/stores/templates/bunny_initializer.rb +0 -9
data/lib/generators/ahoy/stores/templates/custom_initializer.rb +0 -10
data/lib/generators/ahoy/stores/templates/fluentd_initializer.rb +0 -3
data/lib/generators/ahoy/stores/templates/kafka_initializer.rb +0 -9
data/lib/generators/ahoy/stores/templates/kinesis_firehose_initializer.rb +0 -17
data/lib/generators/ahoy/stores/templates/log_initializer.rb +0 -3
data/lib/generators/ahoy/stores/templates/mongoid_initializer.rb +0 -3
data/lib/generators/ahoy/stores/templates/nats_initializer.rb +0 -9
data/lib/generators/ahoy/stores/templates/nsq_initializer.rb +0 -9
data/test/visit_properties_test.rb +0 -44

data/lib/generators/ahoy/stores/bunny_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class BunnyGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "bunny_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/custom_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class CustomGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "custom_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/fluentd_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class FluentdGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "fluentd_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/kafka_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class KafkaGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "kafka_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/kinesis_firehose_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class KinesisFirehoseGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "kinesis_firehose_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/log_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class LogGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "log_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/mongoid_events_generator.rb DELETED Viewed

@@ -1,19 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class MongoidEventsGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def generate_model
-          template "mongoid_event_model.rb", "app/models/ahoy/event.rb"
-        end
-        def create_initializer
-          template "mongoid_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/mongoid_generator.rb DELETED Viewed

@@ -1,14 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class MongoidGenerator < Rails::Generators::Base
-        def boom
-          invoke "ahoy:stores:mongoid_visits"
-          invoke "ahoy:stores:mongoid_events"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/mongoid_visits_generator.rb DELETED Viewed

@@ -1,27 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class MongoidVisitsGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def generate_model
-          @visitor_id_type =
-            if defined?(::BSON)
-              "BSON::Binary"
-            elsif defined?(::Moped::BSON)
-              "Moped::BSON::Binary"
-            else
-              "String"
-            end
-          template "mongoid_visit_model.rb", "app/models/visit.rb"
-        end
-        def create_initializer
-          template "mongoid_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/nats_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class NatsGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "nats_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

data/lib/generators/ahoy/stores/nsq_generator.rb DELETED Viewed

@@ -1,15 +0,0 @@
-require "rails/generators"
-module Ahoy
-  module Stores
-    module Generators
-      class NsqGenerator < Rails::Generators::Base
-        source_root File.expand_path("../templates", __FILE__)
-        def create_initializer
-          template "nsq_initializer.rb", "config/initializers/ahoy.rb"
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-module Ahoy
-  class Event < ActiveRecord::Base
-    include Ahoy::Properties
-    self.table_name = "ahoy_events"
-    belongs_to :visit
-    belongs_to :user<%= Rails::VERSION::MAJOR >= 5 ? ", optional: true" : nil %><% unless %w(postgresql postgresql-jsonb).include?(@database) %>
-    serialize :properties, JSON<% end %>
-  end
-end

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

@@ -1,20 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
-  def change
-    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 @database when "postgresql" %>json<% when "postgresql-jsonb" %>jsonb<% else %>text<% end %> :properties
-      t.timestamp :time
-    end
-    add_index :ahoy_events, [:visit_id, :name]
-    add_index :ahoy_events, [:user_id, :name]
-    add_index :ahoy_events, [:name, :time]
-    <% if @database == "postgresql-jsonb" && ActiveRecord::VERSION::MAJOR >= 5 %>add_index :ahoy_events, 'properties jsonb_path_ops', using: 'gin'<% end %>
-  end
-end

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

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

data/lib/generators/ahoy/stores/templates/active_record_visit_model.rb DELETED Viewed

@@ -1,4 +0,0 @@
-class Visit < ActiveRecord::Base
-  has_many :ahoy_events, class_name: "Ahoy::Event"
-  belongs_to :user<%= Rails::VERSION::MAJOR >= 5 ? ", optional: true" : nil %>
-end

data/lib/generators/ahoy/stores/templates/bunny_initializer.rb DELETED Viewed

@@ -1,9 +0,0 @@
-class Ahoy::Store < Ahoy::Stores::BunnyStore
-  def visits_queue
-    "ahoy_visits"
-  end
-  def events_queue
-    "ahoy_events"
-  end
-end

data/lib/generators/ahoy/stores/templates/custom_initializer.rb DELETED Viewed

@@ -1,10 +0,0 @@
-class Ahoy::Store < Ahoy::Stores::BaseStore
-  def track_visit(options)
-  end
-  def track_event(name, properties, options)
-  end
-  def current_visit
-  end
-end

data/lib/generators/ahoy/stores/templates/fluentd_initializer.rb DELETED Viewed

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

data/lib/generators/ahoy/stores/templates/kafka_initializer.rb DELETED Viewed

@@ -1,9 +0,0 @@
-class Ahoy::Store < Ahoy::Stores::KafkaStore
-  def visits_topic
-    "ahoy_visits"
-  end
-  def events_topic
-    "ahoy_events"
-  end
-end

data/lib/generators/ahoy/stores/templates/kinesis_firehose_initializer.rb DELETED Viewed

@@ -1,17 +0,0 @@
-class Ahoy::Store < Ahoy::Stores::KinesisFirehoseStore
-  def credentials
-    {
-      access_key_id: ENV["AWS_ACCESS_KEY_ID"],
-      secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
-      region: "us-east-1"
-    }
-  end
-  def visits_stream
-    "ahoy_visits"
-  end
-  def events_stream
-    "ahoy_events"
-  end
-end

data/lib/generators/ahoy/stores/templates/log_initializer.rb DELETED Viewed

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

data/lib/generators/ahoy/stores/templates/mongoid_initializer.rb DELETED Viewed

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

data/lib/generators/ahoy/stores/templates/nats_initializer.rb DELETED Viewed

@@ -1,9 +0,0 @@
-class Ahoy::Store < Ahoy::Stores::NatsStore
-  def visits_subject
-    "ahoy_visits"
-  end
-  def events_subject
-    "ahoy_events"
-  end
-end

data/lib/generators/ahoy/stores/templates/nsq_initializer.rb DELETED Viewed

@@ -1,9 +0,0 @@
-class Ahoy::Store < Ahoy::Stores::NsqStore
-  def visits_topic
-    "ahoy_visits"
-  end
-  def events_topic
-    "ahoy_events"
-  end
-end

data/test/visit_properties_test.rb DELETED Viewed

@@ -1,44 +0,0 @@
-require_relative "test_helper"
-class TestVisitProperties < Minitest::Test
-  def setup
-    request = MiniTest::Mock.new
-    @visit_properties = Ahoy::VisitProperties.new(request)
-  end
-  def test_keys
-    with_geocode(true) do
-      assert_equal @visit_properties.keys, Ahoy::VisitProperties::KEYS
-    end
-  end
-  def test_keys_when_geocode_disabled
-    with_geocode(false) do
-      keys = @visit_properties.keys
-      refute keys.include?(:country)
-      refute keys.include?(:region)
-      refute keys.include?(:city)
-    end
-  end
-  def test_keys_when_geocode_async
-    with_geocode(:async) do
-      keys = @visit_properties.keys
-      refute keys.include?(:country)
-      refute keys.include?(:region)
-      refute keys.include?(:city)
-    end
-  end
-  private
-  def with_geocode(enabled)
-    original = Ahoy.geocode
-    Ahoy.geocode = enabled
-    yield
-  ensure
-    Ahoy.geocode = original
-  end
-end