ahoy_matey 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2650b75c743530def251ca5e74c48c5a0a6654cc
-  data.tar.gz: 2dae4a806be1b4bd07d11f355440dedb2af33d85
+  metadata.gz: 242d802ebd49a361498abd778f6584270403a044
+  data.tar.gz: fbac0f07a91a227d362f81c59b9e5407f12a1914
 SHA512:
-  metadata.gz: 04ffd75191af402b3d371f3f641feda3b56482658163b6f4c00838da8c31debd812747199f707a7b87885291cab37855457d76b67a060dd07698bc298993d047
-  data.tar.gz: 28b522d37a313db0a4987bef9b7521642e0f5c6c44f01e71f3332df4095804d03b2ac68e20ebf106b7ebb6020a84c3a5c189910d0fe0d7cd7d2f3435c89be329
+  metadata.gz: 480eb913a57be006b6ed8a9387381f97fa90093ddf81f7509279e1821da88af79a50bb48811f61133efc480018e2ee09bca1f194e9a1a66ae130322abaf7f9d4
+  data.tar.gz: ad94528f28a55a852638cea255b0e17e0a1ecc941231f2bf2830faaa77541c736a17196baab0279771cdca5c20bb172d437b0f33f833c0e6dd5bcbfc7db46787

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.0 [unreleased]
+
+- Added `geocode` option
+- Report errors to service by default
+- Fixed association mismatch
+
 ## 1.0.2
 
 - Fixed BSON for Mongoid 3

data/README.md

@@ -6,6 +6,8 @@ Ahoy provides a solid foundation to track visits and events in Ruby, JavaScript,
 
 :postbox: To track emails, check out [Ahoy Email](https://github.com/ankane/ahoy_email).
 
+Never build an analytics platform from scratch again.
+
 See [upgrade instructions](#upgrading) on how to move to 1.0.
 
 ## Installation
@@ -213,7 +215,9 @@ end
 
 Exceptions are rescued so analytics do not break your app.
 
-To report them to a service, use:
+Ahoy uses [Errbase](https://github.com/ankane/errbase) to try to report them to a service by default.
+
+To customize this, use:
 
 ```ruby
 class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
@@ -327,6 +331,20 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+### Geocoding
+
+By default, geocoding is performed inline. For performance, move it to the background. Add [Active Job](https://github.com/ankane/activejob_backport) and set:
+
+```ruby
+Ahoy.geocode = :async
+```
+
+Or disable it with:
+
+```ruby
+Ahoy.geocode = false
+```
+
 ### Track Visits Immediately
 
 Visitor and visit ids are generated on the first request (so you can use them immediately), but the `track_visit` method isn’t called until the JavaScript library posts to the server.  This prevents browsers with cookies disabled from creating multiple visits and ensures visits are not created for API endpoints.  Change this with:
@@ -335,7 +353,7 @@ Visitor and visit ids are generated on the first request (so you can use them im
 Ahoy.track_visits_immediately = true
 ```
 
-**Note:** At the moment, geocoding is performed in the foreground, which can slow down the first page load.
+**Note:** It’s highly recommended to perform geocoding in the background with this option.
 
 You can exclude API endpoints and other actions with:
 

data/ahoy_matey.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "user_agent_parser"
   spec.add_dependency "request_store"
   spec.add_dependency "uuidtools"
+  spec.add_dependency "errbase"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/ahoy/geocode_job.rb

@@ -0,0 +1,14 @@
+module Ahoy
+  class GeocodeJob < ActiveJob::Base
+    queue_as :ahoy
+
+    def perform(visit)
+      deckhand = Deckhands::LocationDeckhand.new(visit.ip)
+      Ahoy::VisitProperties::LOCATION_KEYS.each do |key|
+        visit.send(:"#{key}=", deckhand.send(key)) if visit.respond_to?(:"#{key}=")
+      end
+      visit.save!
+    end
+
+  end
+end

data/lib/ahoy/stores/active_record_store.rb

@@ -11,14 +11,13 @@ module Ahoy
             v.started_at = options[:started_at]
           end
 
-        visit_properties.keys.each do |key|
-          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=")
-        end
+        set_visit_properties(visit)
 
         yield(visit) if block_given?
 
         begin
           visit.save!
+          geocode(visit)
         rescue ActiveRecord::RecordNotUnique
           # do nothing
         end

data/lib/ahoy/stores/active_record_token_store.rb

@@ -11,14 +11,13 @@ module Ahoy
             v.created_at = options[:started_at]
           end
 
-        visit_properties.keys.each do |key|
-          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=")
-        end
+        set_visit_properties(visit)
 
         yield(visit) if block_given?
 
         begin
           visit.save!
+          geocode(visit)
         rescue ActiveRecord::RecordNotUnique
           # do nothing
         end

data/lib/ahoy/stores/base_store.rb

@@ -18,12 +18,17 @@ module Ahoy
       def authenticate(user)
         @user = user
         if visit and visit.respond_to?(:user) and !visit.user
-          visit.user = user
-          visit.save!
+          begin
+            visit.user = user
+            visit.save!
+          rescue ActiveRecord::AssociationTypeMismatch
+            # do nothing
+          end
         end
       end
 
       def report_exception(e)
+        Errbase.report(e)
       end
 
       def user
@@ -41,7 +46,7 @@ module Ahoy
       protected
 
       def bot?
-        @bot ||= Browser.new(ua: request.user_agent).bot?
+        @bot ||= request ? Browser.new(ua: request.user_agent).bot? : false
       end
 
       def request
@@ -60,6 +65,20 @@ module Ahoy
         ahoy.visit_properties
       end
 
+      def set_visit_properties(visit)
+        keys = visit_properties.keys
+        keys -= Ahoy::VisitProperties::LOCATION_KEYS if Ahoy.geocode != true
+        keys.each do |key|
+          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=") && visit_properties[key]
+        end
+      end
+
+      def geocode(visit)
+        if Ahoy.geocode == :async
+          Ahoy::GeocodeJob.perform_later(visit)
+        end
+      end
+
     end
   end
 end

data/lib/ahoy/stores/mongoid_store.rb

@@ -11,13 +11,12 @@ module Ahoy
             v.started_at = options[:started_at]
           end
 
-        visit_properties.keys.each do |key|
-          visit.send(:"#{key}=", visit_properties[key]) if visit.respond_to?(:"#{key}=") && visit_properties[key]
-        end
+        set_visit_properties(visit)
 
         yield(visit) if block_given?
 
         visit.upsert
+        geocode(visit)
       end
 
       def track_event(name, properties, options, &block)

data/lib/ahoy/tracker.rb

@@ -119,7 +119,12 @@ module Ahoy
     end
 
     def report_exception(e)
-      @store.report_exception(e)
+      begin
+        @store.report_exception(e)
+      rescue
+        # fail-safe
+        $stderr.puts "Error reporting exception"
+      end
       if Rails.env.development?
         raise e
       end
@@ -130,11 +135,11 @@ module Ahoy
     end
 
     def existing_visit_id
-      @existing_visit_id ||= request.headers["Ahoy-Visit"] || request.cookies["ahoy_visit"]
+      @existing_visit_id ||= request && (request.headers["Ahoy-Visit"] || request.cookies["ahoy_visit"])
     end
 
     def existing_visitor_id
-      @existing_visitor_id ||= request.headers["Ahoy-Visitor"] || request.cookies["ahoy_visitor"]
+      @existing_visitor_id ||= request && (request.headers["Ahoy-Visitor"] || request.cookies["ahoy_visitor"])
     end
 
     def ensure_uuid(id)

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/ahoy.rb

@@ -5,6 +5,7 @@ require "referer-parser"
 require "user_agent_parser"
 require "request_store"
 require "uuidtools"
+require "errbase"
 
 require "ahoy/version"
 require "ahoy/tracker"
@@ -24,6 +25,14 @@ require "ahoy/stores/mongoid_store"
 require "ahoy/engine"
 require "ahoy/warden" if defined?(Warden)
 
+# background jobs
+begin
+  require "active_job"
+rescue LoadError
+  # do nothing
+end
+require "ahoy/geocode_job" if defined?(ActiveJob)
+
 # deprecated
 require "ahoy/subscribers/active_record"
 
@@ -44,6 +53,9 @@ module Ahoy
   mattr_accessor :quiet
   self.quiet = true
 
+  mattr_accessor :geocode
+  self.geocode = true
+
   def self.ensure_uuid(id)
     valid = UUIDTools::UUID.parse(id) rescue nil
     if valid

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

@@ -3,8 +3,8 @@ module Ahoy
     self.table_name = "ahoy_events"
 
     belongs_to :visit
-    belongs_to :user
+    belongs_to :user<% if options["database"] != "postgresql" %>
 
-    <% if options["database"] != "postgresql" %>serialize :properties, JSON<% end %>
+    serialize :properties, JSON<% end %>
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: errbase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +176,7 @@ files:
 - lib/ahoy/deckhands/traffic_source_deckhand.rb
 - lib/ahoy/deckhands/utm_parameter_deckhand.rb
 - lib/ahoy/engine.rb
+- lib/ahoy/geocode_job.rb
 - lib/ahoy/model.rb
 - lib/ahoy/stores/active_record_store.rb
 - lib/ahoy/stores/active_record_token_store.rb