ahoy_matey 2.0.0 → 3.2.0

data/docs/Data-Store-Examples.md

@@ -1,240 +0,0 @@
-# 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
-```

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

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

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

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

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

@@ -1,5 +0,0 @@
-class Ahoy::Store < Ahoy::DatabaseStore
-end
-
-# set to true for JavaScript tracking
-Ahoy.api = false

data/test/query_methods/mongoid_test.rb

@@ -1,23 +0,0 @@
-require_relative "../test_helper"
-
-Mongoid.logger.level = Logger::WARN
-Mongo::Logger.logger.level = Logger::WARN
-
-Mongoid.configure do |config|
-  config.connect_to("ahoy_test")
-end
-
-class MongoidEvent
-  include Mongoid::Document
-  include Ahoy::QueryMethods
-
-  field :properties, type: Hash
-end
-
-class MongoidTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    MongoidEvent
-  end
-end

data/test/query_methods/mysql_json_test.rb

@@ -1,18 +0,0 @@
-require_relative "../test_helper"
-
-ActiveRecord::Base.establish_connection adapter: "mysql2", username: "root", database: "ahoy_test"
-
-ActiveRecord::Migration.create_table :mysql_json_events, force: true do |t|
-  t.json :properties
-end
-
-class MysqlJsonEvent < MysqlBase
-end
-
-class MysqlJsonTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    MysqlJsonEvent
-  end
-end

data/test/query_methods/mysql_text_test.rb

@@ -1,19 +0,0 @@
-require_relative "../test_helper"
-
-ActiveRecord::Base.establish_connection adapter: "mysql2", username: "root", database: "ahoy_test"
-
-ActiveRecord::Migration.create_table :mysql_text_events, force: true do |t|
-  t.text :properties
-end
-
-class MysqlTextEvent < MysqlBase
-  serialize :properties, JSON
-end
-
-class MysqlTextTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    MysqlTextEvent
-  end
-end

data/test/query_methods/postgresql_hstore_test.rb

@@ -1,20 +0,0 @@
-require_relative "../test_helper"
-
-ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
-
-ActiveRecord::Migration.enable_extension "hstore"
-
-ActiveRecord::Migration.create_table :postgresql_hstore_events, force: true do |t|
-  t.hstore :properties
-end
-
-class PostgresqlHstoreEvent < PostgresqlBase
-end
-
-class PostgresqlHstoreTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    PostgresqlHstoreEvent
-  end
-end

data/test/query_methods/postgresql_json_test.rb

@@ -1,18 +0,0 @@
-require_relative "../test_helper"
-
-ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
-
-ActiveRecord::Migration.create_table :postgresql_json_events, force: true do |t|
-  t.json :properties
-end
-
-class PostgresqlJsonEvent < PostgresqlBase
-end
-
-class PostgresqlJsonTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    PostgresqlJsonEvent
-  end
-end

data/test/query_methods/postgresql_jsonb_test.rb

@@ -1,19 +0,0 @@
-require_relative "../test_helper"
-
-ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
-
-ActiveRecord::Migration.create_table :postgresql_jsonb_events, force: true do |t|
-  t.jsonb :properties
-  t.index :properties, using: 'gin'
-end
-
-class PostgresqlJsonbEvent < PostgresqlBase
-end
-
-class PostgresqlJsonbTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    PostgresqlJsonbEvent
-  end
-end

data/test/query_methods/postgresql_text_test.rb

@@ -1,19 +0,0 @@
-require_relative "../test_helper"
-
-ActiveRecord::Base.establish_connection adapter: "postgresql", database: "ahoy_test"
-
-ActiveRecord::Migration.create_table :postgresql_text_events, force: true do |t|
-  t.text :properties
-end
-
-class PostgresqlTextEvent < PostgresqlBase
-  serialize :properties, JSON
-end
-
-class PostgresqlTextTest < Minitest::Test
-  include QueryMethodsTest
-
-  def model
-    PostgresqlTextEvent
-  end
-end

data/test/test_helper.rb

@@ -1,100 +0,0 @@
-require "bundler/setup"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-require "active_record"
-require "mongoid"
-
-ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
-
-class PostgresqlBase < ActiveRecord::Base
-  include Ahoy::QueryMethods
-  establish_connection adapter: "postgresql", database: "ahoy_test"
-  self.abstract_class = true
-end
-
-class MysqlBase < ActiveRecord::Base
-  include Ahoy::QueryMethods
-  establish_connection adapter: "mysql2", username: "root", database: "ahoy_test"
-  self.abstract_class = true
-end
-
-module QueryMethodsTest
-  def setup
-    model.delete_all
-  end
-
-  def test_empty
-    assert_equal 0, count_events({})
-  end
-
-  def test_string
-    create_event value: "world"
-    assert_equal 1, count_events(value: "world")
-  end
-
-  def test_number
-    create_event value: 1
-    assert_equal 1, count_events(value: 1)
-  end
-
-  def test_date
-    today = Date.today
-    create_event value: today
-    assert_equal 1, count_events(value: today)
-  end
-
-  def test_time
-    now = Time.now
-    create_event value: now
-    assert_equal 1, count_events(value: now)
-  end
-
-  def test_true
-    create_event value: true
-    assert_equal 1, count_events(value: true)
-  end
-
-  def test_false
-    create_event value: false
-    assert_equal 1, count_events(value: false)
-  end
-
-  def test_nil
-    create_event value: nil
-    assert_equal 1, count_events(value: nil)
-  end
-
-  def test_any
-    create_event hello: "world", prop2: "hi"
-    assert_equal 1, count_events(hello: "world")
-  end
-
-  def test_multiple
-    create_event prop1: "hi", prop2: "bye"
-    assert_equal 1, count_events(prop1: "hi", prop2: "bye")
-  end
-
-  def test_multiple_order
-    create_event prop2: "bye", prop1: "hi"
-    assert_equal 1, count_events(prop1: "hi", prop2: "bye")
-  end
-
-  def test_partial
-    create_event hello: "world"
-    assert_equal 0, count_events(hello: "world", prop2: "hi")
-  end
-
-  def test_prefix
-    create_event value: 123
-    assert_equal 0, count_events(value: 1)
-  end
-
-  def create_event(properties)
-    model.create(properties: properties)
-  end
-
-  def count_events(properties)
-    model.where_properties(properties).count
-  end
-end