ahoy_matey 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 181105196800b983c765eacf7faa0ad9280a1553
-  data.tar.gz: 67a7a2cb8dea093d979323b384b18d3b7f4e4ba7
+  metadata.gz: 3f3a81162866c03a621491abb0194ebe878a7f48
+  data.tar.gz: 050571dcc31a26851ee56da2b373503507d3547c
 SHA512:
-  metadata.gz: a3dd6aeb1bd934d5ae71b84b38188c8c991a28c764aeecebf1566e3f675c120953c3a443ad38330e5db68d530e7fd1bce7ad2d5f3e469fe8e6b403f4381a6257
-  data.tar.gz: ea652c7992e43801a5f6dc5bfac7284c336a6ab11e544a1298b96bf100807251f4059355f6650932f42a85ade1a6a2eac9e3204f14a32186289feabf26d03165
+  metadata.gz: 7259821c2286af301fcc08ca16fa6b9ef284668740d5d4e7c136adc27c250521458da9a97a859c0ecf724ab2e469a78ff4670459333e08c594af658abb6b4707
+  data.tar.gz: 918d05e4515f41a79991324a93bb240965bb60d685279fcb53893228a87a6954c1dfd1ae4dbe162e5366d8d270fd5625546d2656795f4d51f0f839af0c6d8c85

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.4.1
+
+- Added `where_properties` method
+- Added Kafka store
+- Added `mount` option
+- Use less intrusive version of `safely`
+
 ## 1.4.0
 
 - Use `ActiveRecordTokenStore` by default (integer instead of uuid for id)

data/README.md

@@ -27,6 +27,7 @@ Ahoy supports a number of data stores out of the box.  You can start with one of
 
 - [PostgreSQL, MySQL, or SQLite](#postgresql-mysql-or-sqlite)
 - [MongoDB](#mongodb)
+- [Kafka](#kafka-master) [master]
 - [Fluentd](#fluentd)
 - [RabbitMQ](#rabbitmq)
 - [Amazon Kinesis Firehose](#amazon-kinesis-firehose)
@@ -48,6 +49,22 @@ rake db:migrate
 rails generate ahoy:stores:mongoid
 ```
 
+### Kafka [master]
+
+Add [ruby-kafka](https://github.com/zendesk/ruby-kafka) to your Gemfile.
+
+```ruby
+gem 'ruby-kafka'
+```
+
+And run:
+
+```sh
+rails generate ahoy:stores:kafka
+```
+
+Use `ENV["KAFKA_URL"]` to configure.
+
 ### Fluentd
 
 Add [fluent-logger](https://github.com/fluent/fluent-logger-ruby) to your Gemfile.
@@ -470,6 +487,14 @@ viewed_checkout_ids = Ahoy::Event.where(user_id: added_item_ids, name: "Viewed c
 
 The same approach also works with visitor tokens.
 
+### Querying Properties
+
+```ruby
+Ahoy::Event.where_properties(store_id: 1).count
+```
+
+**Note:** If you get a `NoMethodError`, upgrade Ahoy and add to your model `include Ahoy::Properties`.
+
 ## Native Apps
 
 ### Visits
@@ -501,6 +526,14 @@ Send a `POST` request as `Content-Type: application/json` to `/ahoy/events` with
 
 Use an array to pass multiple events at once.
 
+## Reference
+
+By default, Ahoy create endpoints at `/ahoy/visits` and `/ahoy/events`. To disable, use:
+
+```ruby
+Ahoy.mount = false
+```
+
 ## Upgrading
 
 ### 1.4.0

data/ahoy_matey.gemspec

@@ -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 "safely_block"
+  spec.add_dependency "safely_block", ">= 0.1.1"
   spec.add_dependency "rack-attack"
 
   spec.add_development_dependency "bundler", "~> 1.5"

data/config/routes.rb

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

data/lib/ahoy.rb

@@ -6,13 +6,14 @@ require "referer-parser"
 require "user_agent_parser"
 require "request_store"
 require "uuidtools"
-require "safely_block"
+require "safely/core"
 
 require "ahoy/version"
 require "ahoy/tracker"
 require "ahoy/controller"
 require "ahoy/model"
 require "ahoy/visit_properties"
+require "ahoy/properties"
 require "ahoy/deckhands/location_deckhand"
 require "ahoy/deckhands/request_deckhand"
 require "ahoy/deckhands/technology_deckhand"
@@ -24,6 +25,7 @@ require "ahoy/stores/active_record_token_store"
 require "ahoy/stores/log_store"
 require "ahoy/stores/fluentd_store"
 require "ahoy/stores/mongoid_store"
+require "ahoy/stores/kafka_store"
 require "ahoy/stores/kinesis_firehose_store"
 require "ahoy/stores/bunny_store"
 require "ahoy/engine"
@@ -66,6 +68,9 @@ module Ahoy
   mattr_accessor :max_events_per_request
   self.max_events_per_request = 10
 
+  mattr_accessor :mount
+  self.mount = true
+
   mattr_accessor :throttle
   self.throttle = true
 

data/lib/ahoy/properties.rb

@@ -0,0 +1,24 @@
+module Ahoy
+  module Properties
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def where_properties(properties)
+        relation = self
+        column_type = columns_hash["properties"].type
+        case column_type
+        when :jsonb, :json
+          properties.each do |k, v|
+            relation = relation.where("properties ->> ? = ?", k, v)
+          end
+        else
+          properties.each do |k, v|
+            # not 100%, but will do
+            relation = relation.where("properties LIKE ?", "%#{{k => v}.to_json.sub(/\A\{/, "").sub(/\}\z/, "")}%")
+          end
+        end
+        relation
+      end
+    end
+  end
+end

data/lib/ahoy/stores/active_record_store.rb

@@ -2,7 +2,7 @@ module Ahoy
   module Stores
     class ActiveRecordStore < BaseStore
       def track_visit(options, &block)
-        visit =
+        @visit =
           visit_model.new do |v|
             v.id = ahoy.visit_id
             v.visitor_id = ahoy.visitor_id

data/lib/ahoy/stores/active_record_token_store.rb

@@ -2,7 +2,7 @@ module Ahoy
   module Stores
     class ActiveRecordTokenStore < BaseStore
       def track_visit(options, &block)
-        visit =
+        @visit =
           visit_model.new do |v|
             v.visit_token = ahoy.visit_token
             v.visitor_token = ahoy.visitor_token

data/lib/ahoy/stores/kafka_store.rb

@@ -0,0 +1,40 @@
+module Ahoy
+  module Stores
+    class KafkaStore < LogStore
+      def log_visit(data)
+        post(visits_topic, data)
+      end
+
+      def log_event(data)
+        post(events_topic, data)
+      end
+
+      def client
+        @client ||= begin
+          client = Kafka.new(
+            seed_brokers: ENV["KAFKA_URL"],
+            logger: Rails.logger
+          )
+          at_exit { client.shutdown }
+          client
+        end
+      end
+
+      def producer
+        @producer ||= client.async_producer(delivery_interval: 3)
+      end
+
+      def post(topic, data)
+        producer.produce(data.to_json, topic: topic)
+      end
+
+      def visits_topic
+        "ahoy_visits"
+      end
+
+      def events_topic
+        "ahoy_events"
+      end
+    end
+  end
+end

data/lib/ahoy/stores/mongoid_store.rb

@@ -2,7 +2,7 @@ module Ahoy
   module Stores
     class MongoidStore < BaseStore
       def track_visit(options, &block)
-        visit =
+        @visit =
           visit_model.new do |v|
             v.id = binary(ahoy.visit_id)
             v.visitor_id = binary(ahoy.visitor_id)

data/lib/ahoy/tracker.rb

@@ -127,7 +127,7 @@ module Ahoy
     # odd pattern for backwards compatibility
     # TODO remove this method in next major release
     def report_exception(e)
-      safely do
+      Safely.safely do
         @store.report_exception(e)
         if Rails.env.development? || Rails.env.test?
           raise e

data/lib/ahoy/version.rb

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

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

@@ -0,0 +1,15 @@
+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/templates/active_record_event_model.rb

@@ -1,5 +1,7 @@
 module Ahoy
   class Event < ActiveRecord::Base
+    include Ahoy::Properties
+
     self.table_name = "ahoy_events"
 
     belongs_to :visit

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rack-attack
   requirement: !ruby/object:Gem::Requirement
@@ -221,11 +221,13 @@ files:
 - lib/ahoy/geocode_job.rb
 - lib/ahoy/logger_silencer.rb
 - lib/ahoy/model.rb
+- lib/ahoy/properties.rb
 - lib/ahoy/stores/active_record_store.rb
 - lib/ahoy/stores/active_record_token_store.rb
 - lib/ahoy/stores/base_store.rb
 - lib/ahoy/stores/bunny_store.rb
 - lib/ahoy/stores/fluentd_store.rb
+- lib/ahoy/stores/kafka_store.rb
 - lib/ahoy/stores/kinesis_firehose_store.rb
 - lib/ahoy/stores/log_store.rb
 - lib/ahoy/stores/mongoid_store.rb
@@ -242,6 +244,7 @@ files:
 - lib/generators/ahoy/stores/bunny_generator.rb
 - lib/generators/ahoy/stores/custom_generator.rb
 - lib/generators/ahoy/stores/fluentd_generator.rb
+- lib/generators/ahoy/stores/kafka_generator.rb
 - lib/generators/ahoy/stores/kinesis_firehose_generator.rb
 - lib/generators/ahoy/stores/log_generator.rb
 - lib/generators/ahoy/stores/mongoid_events_generator.rb
@@ -255,6 +258,7 @@ files:
 - lib/generators/ahoy/stores/templates/bunny_initializer.rb
 - lib/generators/ahoy/stores/templates/custom_initializer.rb
 - lib/generators/ahoy/stores/templates/fluentd_initializer.rb
+- lib/generators/ahoy/stores/templates/kafka_initializer.rb
 - lib/generators/ahoy/stores/templates/kinesis_firehose_initializer.rb
 - lib/generators/ahoy/stores/templates/log_initializer.rb
 - lib/generators/ahoy/stores/templates/mongoid_event_model.rb
@@ -283,11 +287,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Simple, powerful visit tracking for Rails
 test_files:
 - test/test_helper.rb
 - test/visit_properties_test.rb
-has_rdoc: