ahoy_matey 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b95be84952b86c8d63b829a5f79706212be5c25
-  data.tar.gz: f187b36cf4fceedffea505d542cfcfe967933832
+  metadata.gz: d6686254ab1f5bb79219bdb93194e2e3ddb9ddd8
+  data.tar.gz: afd9cb6035e939db2c60b881b5a80a2ea0bb407e
 SHA512:
-  metadata.gz: f91f26c2cd6f80f792b74dfb3364eadd78a35c76f6894da57468ad8d981c05bc97796c9013f49d8a5acfbec1632e3310b4fa391588f6e21ad6d4b9b4c309ce3a
-  data.tar.gz: 18dc372e351d0ca497da3642befb01de577b3e5b426442a006150801a6be70ea8b8ff5c24f7bc52a6c248b7d2f428c7de03317154309d5b0e0982a80746f0925
+  metadata.gz: 504dd73058c78a635072af48ca326f623a335af74d5cbfc7636ccd0c2d5a0ab12304cee3cc01d51f11829aa80200dada366734d7f55d1b99946ff0d49b072bb2
+  data.tar.gz: f1664a981c88b2896e856ec8bcdba0e4b1e94e26b93f290b1b495ad72166787952965ff5566e5325eb0be59ddcf8f70ebc4cdeeccf40cfa8614475fa4c5e35ae

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.2.2
+
+- Fixed issue with latest version of `browser` gem
+- Added support for RabbitMQ
+- Added support for Amazon Kinesis Firehose
+- Fixed deprecation warnings in Rails 5
+
 ## 1.2.1
 
 - Fixed `SystemStackError: stack level too deep` when used with `activerecord-session_store`

data/README.md

@@ -36,19 +36,21 @@ Ahoy supports a number of data stores out of the box.  You can start with one of
 - [SQLite](#mysql-or-sqlite)
 - [MongoDB](#mongodb)
 - [Fluentd](#fluentd)
+- [RabbitMQ](#rabbitmq-master)
+- [Kinesis Firehose](#kinesis-firehose-master)
 - [Logs](#logs)
 - [Custom](#custom)
 
 ### PostgreSQL
 
-For Rails 4 and PostgreSQL 9.4 or greater, use:
+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 and 9.3, use:
+For Rails 4 and PostgreSQL 9.2 or greater, use:
 
 ```sh
 rails generate ahoy:stores:active_record -d postgresql
@@ -101,6 +103,38 @@ rails generate ahoy:stores:fluentd
 
 Use `ENV["FLUENTD_HOST"]` and `ENV["FLUENTD_PORT"]` to configure.
 
+### RabbitMQ
+
+Add [bunny](https://github.com/ruby-amqp/bunny) to your Gemfile.
+
+```ruby
+gem 'bunny'
+```
+
+And run:
+
+```sh
+rails generate ahoy:stores:bunny
+```
+
+Use `ENV["RABBITMQ_URL"]` to configure.
+
+### Kinesis Firehose
+
+Add [aws-sdk](https://github.com/aws/aws-sdk-ruby) to your Gemfile.
+
+```ruby
+gem 'aws-sdk', '>= 2.0.0'
+```
+
+And run:
+
+```sh
+rails generate ahoy:stores:kinesis_firehose
+```
+
+Configure delivery streams and credentials in the initializer.
+
 ### Logs
 
 ```sh
@@ -119,13 +153,11 @@ This creates a class for you to fill out.
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::BaseStore
-
   def track_visit(options)
   end
 
   def track_event(name, properties, options)
   end
-
 end
 ```
 
@@ -172,7 +204,7 @@ ahoy.track "Viewed book", title: "Hot, Flat, and Crowded"
 
 #### Native Apps
 
-See the [HTTP spec](#native-apps) until libraries are built.
+See the [HTTP spec](#native-apps-1) until libraries are built.
 
 ### Users
 
@@ -202,11 +234,9 @@ Exclude visits and events from being tracked with:
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
-
   def exclude?
     bot? || request.ip == "192.168.1.1"
   end
-
 end
 ```
 
@@ -216,7 +246,6 @@ Bots are excluded by default.
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
-
   def track_visit(options)
     super do |visit|
       visit.gclid = visit_properties.landing_params["gclid"]
@@ -228,7 +257,6 @@ class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
       event.ip = request.ip
     end
   end
-
 end
 ```
 
@@ -238,11 +266,9 @@ If you use a method other than `current_user`, set it here:
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
-
   def user
     controller.true_user
   end
-
 end
 ```
 
@@ -256,11 +282,9 @@ To customize this, use:
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
-
   def report_exception(e)
     Rollbar.report_exception(e)
   end
-
 end
 ```
 
@@ -270,7 +294,6 @@ For ActiveRecord and Mongoid stores
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
-
   def visit_model
     CustomVisit
   end
@@ -278,7 +301,6 @@ class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
   def event_model
     CustomEvent
   end
-
 end
 ```
 
@@ -302,7 +324,7 @@ Rails actions
 
 ```ruby
 class ApplicationController < ActionController::Base
-  after_filter :track_action
+  after_action :track_action
 
   protected
 
@@ -332,7 +354,19 @@ Ahoy.visit_duration = 30.minutes
 
 ### ActiveRecord
 
-Let’s associate orders with visits. Add a `visit_id` column on orders and do:
+Let’s associate orders with visits.
+
+First, generate a migration and add a `visit_id` column.
+
+```ruby
+class AddVisitIdToOrders < ActiveRecord::Migration
+  def change
+    add_column :orders, :visit_id, :uuid
+  end
+end
+```
+
+Then, add `visitable` to the model.
 
 ```ruby
 class Order < ActiveRecord::Base
@@ -340,9 +374,7 @@ class Order < ActiveRecord::Base
 end
 ```
 
-When a visitor places an order, the `visit_id` column is automatically set.
-
-:tada: Magic!
+When a visitor places an order, the `visit_id` column is automatically set. :tada:
 
 Customize the column and class name with:
 
@@ -356,13 +388,11 @@ To attach the user with [Doorkeeper](https://github.com/doorkeeper-gem/doorkeepe
 
 ```ruby
 class ApplicationController < ActionController::Base
-
   private
 
   def current_resource_owner
     User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
   end
-
 end
 ```
 
@@ -393,7 +423,7 @@ Ahoy.track_visits_immediately = true
 You can exclude API endpoints and other actions with:
 
 ```ruby
-skip_before_filter :track_ahoy_visit
+skip_before_action :track_ahoy_visit
 ```
 
 ## Development
@@ -517,13 +547,13 @@ rails g migration change_properties_to_jsonb_on_ahoy_events
 And add:
 
 ```rb
-  def up
-    change_column :ahoy_events, :properties, :jsonb, using: "properties::jsonb"
-  end
+def up
+  change_column :ahoy_events, :properties, :jsonb, using: "properties::jsonb"
+end
 
-  def down
-    change_column :ahoy_events, :properties, :json
-  end
+def down
+  change_column :ahoy_events, :properties, :json
+end
 ```
 
 Note: This will lock the table while the migration is running.
@@ -573,11 +603,9 @@ If you have a custom subscriber, copy the `track` method to `track_event` in `Ah
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
-
   def track_event(name, properties, options)
     # code copied from the track method in your subscriber
   end
-
 end
 ```
 
@@ -589,12 +617,10 @@ To restore this behavior, use:
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
-
   def authenticate(user)
     super
     ahoy.track "$authenticate"
   end
-
 end
 ```
 
@@ -606,7 +632,6 @@ Skip this step if you do not use these options.
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
-
   def user
     # logic from Ahoy.user_method goes here
     controller.true_user
@@ -616,7 +641,6 @@ class Ahoy::Store < Ahoy::Stores::ActiveRecordTokenStore
     # logic from Ahoy.track_bots and Ahoy.exclude_method goes here
     bot? || request.ip == "192.168.1.1"
   end
-
 end
 ```
 

data/ahoy_matey.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails"
   spec.add_dependency "addressable"
-  spec.add_dependency "browser", ">= 0.4.0"
+  spec.add_dependency "browser", "~> 2.0"
   spec.add_dependency "geocoder"
   spec.add_dependency "referer-parser", ">= 0.3.0"
   spec.add_dependency "user_agent_parser"

data/app/controllers/ahoy/base_controller.rb

@@ -1,7 +1,12 @@
 module Ahoy
   class BaseController < ApplicationController
     # skip all filters except for authlogic
-    skip_filter *(_process_action_callbacks.map(&:filter) - [:load_authlogic])
+    filters = _process_action_callbacks.map(&:filter) - [:load_authlogic]
+    if respond_to?(:skip_action)
+      skip_action *filters
+    else
+      skip_filter *filters
+    end
 
     def ahoy
       @ahoy ||= Ahoy::Tracker.new(controller: self, api: true)

data/lib/ahoy.rb

@@ -25,6 +25,9 @@ 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/kinesis_firehose_store"
+require "ahoy/stores/bunny_store"
+require "ahoy/log_silencer"
 require "ahoy/engine"
 require "ahoy/warden" if defined?(Warden)
 
@@ -91,10 +94,10 @@ begin
   require "active_record/session_store/extension/logger_silencer"
 rescue LoadError
   require "ahoy/logger_silencer"
-  Logger.send :include, Ahoy::LoggerSilencer
+  Logger.send(:prepend, Ahoy::LoggerSilencer)
 
   begin
     require "syslog/logger"
-    Syslog::Logger.send :include, Ahoy::LoggerSilencer
+    Syslog::Logger.send(:prepend, Ahoy::LoggerSilencer)
   rescue LoadError; end
 end

data/lib/ahoy/controller.rb

@@ -5,10 +5,14 @@ module Ahoy
     def self.included(base)
       base.helper_method :current_visit
       base.helper_method :ahoy
-      base.before_filter :set_ahoy_cookies
-      base.before_filter :track_ahoy_visit
-      base.before_filter do
-        RequestStore.store[:ahoy] ||= ahoy
+      if base.respond_to?(:before_action)
+        base.before_action :set_ahoy_cookies
+        base.before_action :track_ahoy_visit
+        base.before_action :set_ahoy_request_store
+      else
+        base.before_filter :set_ahoy_cookies
+        base.before_filter :track_ahoy_visit
+        base.before_filter :set_ahoy_request_store
       end
     end
 
@@ -30,5 +34,9 @@ module Ahoy
         ahoy.track_visit(defer: !Ahoy.track_visits_immediately)
       end
     end
+
+    def set_ahoy_request_store
+      RequestStore.store[:ahoy] ||= ahoy
+    end
   end
 end

data/lib/ahoy/deckhands/request_deckhand.rb

@@ -17,31 +17,37 @@ module Ahoy
       end
 
       def referrer
-        @options[:api] ? request.params["referrer"] : request.referer
+        @options[:api] ? params["referrer"] : request.referer
       end
 
       def landing_page
-        @options[:api] ? request.params["landing_page"] : request.original_url
+        @options[:api] ? params["landing_page"] : request.original_url
       end
 
       def platform
-        request.params["platform"]
+        params["platform"]
       end
 
       def app_version
-        request.params["app_version"]
+        params["app_version"]
       end
 
       def os_version
-        request.params["os_version"]
+        params["os_version"]
       end
 
       def screen_height
-        request.params["screen_height"]
+        params["screen_height"]
       end
 
       def screen_width
-        request.params["screen_width"]
+        params["screen_width"]
+      end
+
+      private
+
+      def params
+        @params ||= request.params
       end
     end
   end

data/lib/ahoy/deckhands/technology_deckhand.rb

@@ -15,16 +15,16 @@ module Ahoy
 
       def device_type
         @device_type ||= begin
-          browser = Browser.new(ua: @user_agent)
+          browser = Browser.new(@user_agent)
           if browser.bot?
             "Bot"
-          elsif browser.tv?
+          elsif browser.device.tv?
             "TV"
-          elsif browser.console?
+          elsif browser.device.console?
             "Console"
-          elsif browser.tablet?
+          elsif browser.device.tablet?
             "Tablet"
-          elsif browser.mobile?
+          elsif browser.device.mobile?
             "Mobile"
           else
             "Desktop"

data/lib/ahoy/engine.rb

@@ -1,25 +1,7 @@
 module Ahoy
   class Engine < ::Rails::Engine
-    # from https://github.com/evrone/quiet_assets/blob/master/lib/quiet_assets.rb
     initializer "ahoy.middleware", after: "sprockets.environment" do
-      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_chain :call, :quiet_ahoy
-      end
+      Rails::Rack::Logger.send(:prepend, Ahoy::LogSilencer) if Ahoy.quiet
     end
   end
 end

data/lib/ahoy/log_silencer.rb

@@ -0,0 +1,16 @@
+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

data/lib/ahoy/logger_silencer.rb

@@ -7,13 +7,9 @@ require "active_support/concern"
 
 module Ahoy
   module LoggerSilencer
-    extend ActiveSupport::Concern
-
-    included do
-      cattr_accessor :silencer
-      self.silencer = true
-      alias_method_chain :level, :threadsafety
-      alias_method_chain :add, :threadsafety
+    def self.prepended(base)
+      base.cattr_accessor :silencer
+      base.silencer = true
     end
 
     def thread_level
@@ -24,15 +20,15 @@ module Ahoy
       Thread.current[thread_hash_level_key] = level
     end
 
-    def level_with_threadsafety
-      thread_level || level_without_threadsafety
+    def level
+      thread_level || super
     end
 
-    def add_with_threadsafety(severity, message = nil, progname = nil, &block)
+    def add(severity, message = nil, progname = nil, &block)
       if !defined?(@logdev) || @logdev.nil? || (severity || UNKNOWN) < level
         true
       else
-        add_without_threadsafety(severity, message, progname, &block)
+        super
       end
     end
 

data/lib/ahoy/stores/base_store.rb

@@ -45,7 +45,7 @@ module Ahoy
       protected
 
       def bot?
-        @bot ||= request ? Browser.new(ua: request.user_agent).bot? : false
+        @bot ||= request ? Browser.new(request.user_agent).bot? : false
       end
 
       def request

data/lib/ahoy/stores/bunny_store.rb

@@ -0,0 +1,33 @@
+module Ahoy
+  module Stores
+    class BunnyStore < LogStore
+      def log_visit(data)
+        post(visits_queue, data)
+      end
+
+      def log_event(data)
+        post(events_queue, data)
+      end
+
+      def channel
+        @channel ||= begin
+          conn = Bunny.new
+          conn.start
+          conn.create_channel
+        end
+      end
+
+      def post(queue, message)
+        channel.queue(queue, durable: true).publish(message.to_json)
+      end
+
+      def visits_queue
+        "ahoy_visits"
+      end
+
+      def events_queue
+        "ahoy_events"
+      end
+    end
+  end
+end

data/lib/ahoy/stores/kinesis_firehose_store.rb

@@ -0,0 +1,42 @@
+module Ahoy
+  module Stores
+    class KinesisFirehoseStore < LogStore
+      def log_visit(data)
+        post(visits_stream, data)
+      end
+
+      def log_event(data)
+        post(events_stream, data)
+      end
+
+      def client
+        @client ||= Aws::Firehose::Client.new(credentials)
+      end
+
+      def post(stream, data)
+        client.put_record(
+          delivery_stream_name: stream,
+          record: {
+            data: "#{data.to_json}\n"
+          }
+        )
+      end
+
+      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
+  end
+end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

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

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

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

@@ -0,0 +1,9 @@
+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/kinesis_firehose_initializer.rb

@@ -0,0 +1,17 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,16 +42,16 @@ dependencies:
   name: browser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: geocoder
   requirement: !ruby/object:Gem::Requirement
@@ -205,12 +205,15 @@ 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
 - 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/kinesis_firehose_store.rb
 - lib/ahoy/stores/log_store.rb
 - lib/ahoy/stores/mongoid_store.rb
 - lib/ahoy/subscribers/active_record.rb
@@ -222,8 +225,10 @@ files:
 - lib/generators/ahoy/stores/active_record_events_generator.rb
 - lib/generators/ahoy/stores/active_record_generator.rb
 - lib/generators/ahoy/stores/active_record_visits_generator.rb
+- 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/kinesis_firehose_generator.rb
 - lib/generators/ahoy/stores/log_generator.rb
 - lib/generators/ahoy/stores/mongoid_events_generator.rb
 - lib/generators/ahoy/stores/mongoid_generator.rb
@@ -233,8 +238,10 @@ files:
 - lib/generators/ahoy/stores/templates/active_record_initializer.rb
 - lib/generators/ahoy/stores/templates/active_record_visit_model.rb
 - lib/generators/ahoy/stores/templates/active_record_visits_migration.rb
+- 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/kinesis_firehose_initializer.rb
 - lib/generators/ahoy/stores/templates/log_initializer.rb
 - lib/generators/ahoy/stores/templates/mongoid_event_model.rb
 - lib/generators/ahoy/stores/templates/mongoid_initializer.rb
@@ -262,10 +269,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.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: