ahoy_matey 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0885adb69bce04e71f7fd609edc8c780355faf3d
-  data.tar.gz: 0f28e71f18107dfd51a323a451e1c688dc14434c
+  metadata.gz: 2e6b98a3bbcd3ab67886e562a6a285344a1d0b53
+  data.tar.gz: 97975b14612ca24bf380584f1020c39407a88894
 SHA512:
-  metadata.gz: ee3c5d227ab4ee129e986bc315acac53569664f99c99e5a131b286c6a1f6822ac148891e7c44e60e0edb5fc76e5d494e5a665f89fdba03a190c442db134aecac
-  data.tar.gz: 1ecec9955ebed58e57ea78e22fafaaae7a8fc8c24a4f3debc928a5da109fc8be4db9174c257c5c32b1dde228d13aa53745d4b4c3c57d99625a702be6a3c673cd
+  metadata.gz: 3808dc8508cdbf29d1b018224179141d2588be09b76752035ddbb9f697ec22df873a0272de63e536575a6d887fcfee3997e9a9d3eddd7cfee02eafdbc68e8e9a
+  data.tar.gz: d8c2b3764a85b9f66d0b06da755260e501c089fe3cab7d8a584cf4e167803714b103f1cf6b692eea242e3571ceabda097acb8285da9f88cb79f3213a4b8a3e79

data/README.md

@@ -1,6 +1,6 @@
 # Ahoy
 
-:fire: Simple, powerful visit tracking for Rails.
+:fire: Simple, powerful visit tracking for Rails
 
 In under a minute, start learning more about your visitors.
 
@@ -8,9 +8,15 @@ In under a minute, start learning more about your visitors.
 - location - country, region, and city
 - technology - browser, OS, and device type
 
-It’s all stored in **your database** so you can easily combine it with other models.
+It’s all stored in **your database** so you can easily combine it with other data.
 
-## Ready, Set, Go!
+See which campaigns generate the most revenue effortlessly.
+
+```ruby
+Order.joins(:visit).group("campaign").sum(:revenue)
+```
+
+## Ready, Set, Go
 
 Add this line to your application’s Gemfile:
 
@@ -36,27 +42,26 @@ Lastly, include the javascript file in `app/assets/javascripts/application.js` a
 
 When a person visits your website, Ahoy creates a visit with lots of useful information.
 
-- traffic source (referrer, referring domain, campaign, landing page)
-- location (country, region, and city)
-- technology (browser, OS, and device type)
+Use the `current_visit` method to access it.
 
-This information is great on it’s own, but super powerful when combined with other models.
+The information is great on it’s own, but super powerful when combined with other models.
 
 You can store the visit id on any model. For instance, when someone places an order:
 
 ```ruby
-Order.create!(
-  ahoy_visit_id: ahoy_visit.id,
-  # ... more attributes ...
-)
+class Order < ActiveRecord::Base
+  visitable # needs better name
+end
 ```
 
+The visit_id column will be automatically set. Magic!
+
 When you want to explore where most orders are coming from, you can do a number of queries.
 
 ```ruby
-Order.joins(:ahoy_visits).group("referring_domain").count
-Order.joins(:ahoy_visits).group("city").count
-Order.joins(:ahoy_visits).group("device_type").count
+Order.joins(:visit).group("referring_domain").count
+Order.joins(:visit).group("device_type").count
+Order.joins(:visit).group("city").count
 ```
 
 ## Features
@@ -65,21 +70,13 @@ Order.joins(:ahoy_visits).group("device_type").count
 - Gracefully degrades when cookies are disabled
 - Gets campaign from utm_campaign parameter
 
-# How It Works
-
-When a user visits your website for the first time, the Javascript library generates a unique visit and visitor id.
-
-It sends the event to the server.
-
-A visit cookie is set for 4 hours, and a visitor cookie is set for 2 years.
-
 ## TODO
 
 - better readme
 - model integration
 - update visit when user logs in
 - better browser / OS detection
-- set ahoy_visit_id automatically on `visitable` models
+- set visit_id automatically on `visitable` models
 
 ## Contributing
 

data/app/controllers/ahoy/visits_controller.rb

@@ -1,5 +1,6 @@
 module Ahoy
   class VisitsController < ActionController::Base
+    before_filter :halt_bots
 
     def create
       visit =
@@ -23,7 +24,6 @@ module Ahoy
         visit.campaign = (landing_uri.query_values || {})["utm_campaign"]
       end
 
-      browser = Browser.new(ua: request.user_agent)
       visit.browser = browser.name
 
       # TODO add more
@@ -71,5 +71,17 @@ module Ahoy
       render json: {id: visit.id}
     end
 
+    protected
+
+    def browser
+      @browser ||= Browser.new(ua: request.user_agent)
+    end
+
+    def halt_bots
+      if browser.bot?
+        render json: {}
+      end
+    end
+
   end
 end

data/lib/ahoy/controller_extensions.rb

@@ -1,8 +1,23 @@
 module Ahoy
   module ControllerExtensions
 
-    def ahoy_visit
-      @ahoy_visit ||= Ahoy::Visit.where(visit_token: cookies[:ahoy_visit]).first if cookies[:ahoy_visit]
+    def self.included(base)
+      base.helper_method :current_visit
+    end
+
+    protected
+
+    def current_visit
+      if cookies[:ahoy_visit]
+        @current_visit ||= Ahoy::Visit.where(visit_token: cookies[:ahoy_visit]).first
+        if @current_visit
+          @current_visit
+        else
+          # clear cookie if visits are destroyed
+          cookies.delete(:ahoy_visit)
+          nil
+        end
+      end
     end
 
   end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Kane