ahoy_matey 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93699ebff0f9bfc35b50d48e7ff477963114b1b2
-  data.tar.gz: 848e8110b3cedef57143e54d8415e23a5e650c66
+  metadata.gz: e8ac2f7e33c48f8b761a8ffee2ae5cd715e52849
+  data.tar.gz: 7d069547085fb036b792492826c7a1fb81363367
 SHA512:
-  metadata.gz: fbd26a7a790231a5b8e8b3dfa2d9b7b99b9e87cd862cffbd15d53ae4a003d1e18afea1f4f46c34576c3a5d6a5f25f4f9f39cfdbb94ab9e58a24488df85c18119
-  data.tar.gz: b4046b11ece28d61d46f852bf3b0a699f52d24d34faffad687dce093260fcc564d8a5aee29e3583ec3f354fa3fb17d1e68721e7c2419551ab7e0f0e006e46ee3
+  metadata.gz: 301bf689ed83f0f44a5c13cc4c1a53707e7ee5fbf7fe53936d560224a647c6d379be3c67834f15d5ec855d0f80081bd37dd4c6db4b9ab573c5ce3661902fb91c
+  data.tar.gz: 3a3016d19a6f00750362bcd9a36992cb04b673bc77832c752cd4ea1fdc065e4faff8f06c38dbb628a9c078c291a0989cc15140966465a453708a572b42d4a31f

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.1.2
+
+- Attach user on Devise sign up
+- Ability to specify visit model
+
+## 0.1.1
+
+- Made most database columns optional
+- Performance hack for referer-parser
+
+## 0.1.0
+
+- First major release

data/README.md

@@ -6,10 +6,10 @@ Visits are stored in **your database** so you can easily combine them with other
 
 You get:
 
-- traffic source - referrer, referring domain, landing page, search keyword
-- location - country, region, and city
-- technology - browser, OS, and device type
-- utm parameters - source, medium, term, content, campaign
+- **traffic source** - referrer, referring domain, landing page, search keyword
+- **location** - country, region, and city
+- **technology** - browser, OS, and device type
+- **utm parameters** - source, medium, term, content, campaign
 
 See which campaigns generate the most revenue effortlessly.
 
@@ -17,30 +17,6 @@ See which campaigns generate the most revenue effortlessly.
 Order.joins(:visit).group("utm_campaign").sum(:revenue)
 ```
 
-Goes great with services like [Google Analytics](http://www.google.com/analytics/)
-
-## Ready, Set, Go
-
-Add this line to your application’s Gemfile:
-
-```ruby
-gem 'ahoy_matey'
-```
-
-And run the generator. This creates a model to store visits.
-
-```sh
-rails generate ahoy:install
-rake db:migrate
-```
-
-Lastly, include the javascript file in `app/assets/javascripts/application.js` after jQuery.
-
-```javascript
-//= require jquery
-//= require ahoy
-```
-
 ## How It Works
 
 When someone visits your website, Ahoy creates a visit with lots of useful information.
@@ -61,7 +37,7 @@ Visit.group(:referring_domain).count
 <%= line_chart Visit.group_by_day(:created_at).count %>
 ```
 
-## The Power
+### The Power
 
 This information is great on its own, but super powerful when combined with other models.
 
@@ -77,7 +53,7 @@ When a visitor places an order, the `visit_id` column is automatically set.
 
 :tada: Magic!
 
-To see where your orders are coming from, use:
+See where orders are coming from with simple joins:
 
 ```ruby
 Order.joins(:visit).group("referring_domain").count
@@ -85,12 +61,21 @@ Order.joins(:visit).group("city").count
 Order.joins(:visit).group("device_type").count
 ```
 
-## Users
+### Users
 
 Ahoy automatically attaches the `current_user` to the `current_visit`.
 
 With [Devise](https://github.com/plataformatec/devise), it will attach the user even if he / she signs in after the visit starts.
 
+With other authentication frameworks, add this to the end of your sign in method:
+
+```ruby
+if current_visit
+  current_visit.user ||= current_user
+  current_visit.save!
+end
+```
+
 To see the visits for a given user, create an association:
 
 ```ruby
@@ -106,13 +91,9 @@ user = User.first
 user.visits
 ```
 
-## Location
-
-Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for IP-based geocoding.
-
-## UTM Parameters
+### UTM Parameters
 
-Use UTM Parameters to track campaigns. [This is great for emails and social media](http://www.thunderseo.com/blog/utm-parameters/). Just add them to your links and Ahoy will pick them up.
+Use UTM parameters to track campaigns. [This is great for emails and social media](http://www.thunderseo.com/blog/utm-parameters/). Just add them to your links and Ahoy will pick them up.
 
 ```
 http://datakick.org/?utm_medium=email&utm_campaign=newsletter&utm_source=newsletter-2014-03
@@ -124,10 +105,57 @@ or
 http://datakick.org/?utm_medium=twitter&utm_campaign=social&utm_source=tweet123
 ```
 
-## More Features
+### Location
+
+Ahoy uses [Geocoder](https://github.com/alexreisner/geocoder) for IP-based geocoding.
+
+### Multiple Subdomains [master]
+
+To track visits across multiple subdomains, add this to your layout **before** the javascript files.
+
+```html
+<script>
+  var Ahoy = {"domain": "yourdomain.com"};
+</script>
+```
+
+### More
 
 - Excludes bots
 - Degrades gracefully when cookies are disabled
+- Don’t need a field? Just remove it from the migration
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'ahoy_matey'
+```
+
+And run the generator. This creates a model to store visits.
+
+```sh
+rails generate ahoy:install
+rake db:migrate
+```
+
+Lastly, include the javascript file in `app/assets/javascripts/application.js` after jQuery.
+
+```javascript
+//= require jquery
+//= require ahoy
+```
+
+We recommend using traditional analytics services like [Google Analytics](http://www.google.com/analytics/) as well.
+
+## Reference
+
+Use a different model
+
+```ruby
+Ahoy.visit_model = UserVisit
+```
 
 ## TODO
 
@@ -135,6 +163,10 @@ http://datakick.org/?utm_medium=twitter&utm_campaign=social&utm_source=tweet123
 - hook to store additional fields
 - turn off modules
 
+## History
+
+View the [changelog](https://github.com/ankane/ahoy/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/ahoy/model.rb

@@ -75,7 +75,14 @@ module Ahoy
 
         def set_location
           if respond_to?(:ip) and [:country=, :region=, :city=].any?{|method| respond_to?(method) }
-            location = Geocoder.search(ip).first rescue nil
+            location =
+              begin
+                Geocoder.search(ip).first
+              rescue => e
+                $stderr.puts e.message
+                nil
+              end
+
             if location
               self.country = location.country.presence if respond_to?(:country=)
               self.region = location.state.presence if respond_to?(:region=)

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/ahoy_matey.rb

@@ -11,7 +11,11 @@ require "ahoy/engine"
 module Ahoy
 
   def self.visit_model
-    ::Visit
+    @visit_model || ::Visit
+  end
+
+  def self.visit_model=(visit_model)
+    @visit_model = visit_model
   end
 
   # TODO private
@@ -26,7 +30,7 @@ ActionController::Base.send :include, Ahoy::Controller
 ActiveRecord::Base.send(:extend, Ahoy::Model) if defined?(ActiveRecord)
 
 if defined?(Warden)
-  Warden::Manager.after_authentication do |user, auth, opts|
+  Warden::Manager.after_set_user except: :fetch do |user, auth, opts|
     request = Rack::Request.new(auth.env)
     if request.cookies["ahoy_visit"]
       visit = Ahoy.visit_model.where(visit_token: request.cookies["ahoy_visit"]).first

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

@@ -1,7 +1,7 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
     create_table :visits do |t|
-      # cookies *required*
+      # cookies
       t.string :visit_token
       t.string :visitor_token
 

data/vendor/assets/javascripts/ahoy.js

@@ -4,9 +4,10 @@
   "use strict";
 
   var debugMode = false;
-  var visitTtl, visitorTtl;
+  var options = window.Ahoy || {};
   var $ = window.jQuery || window.Zepto || window.$;
   var visitToken, visitorToken;
+  var visitTtl, visitorTtl;
 
   if (debugMode) {
     visitTtl = 0.2;
@@ -19,14 +20,18 @@
   // cookies
 
   // http://www.quirksmode.org/js/cookies.html
-  function setCookie(name, value, ttl) {
+  function setCookie(name, value, ttl, domain) {
     var expires = "";
+    var cookieDomain = "";
     if (ttl) {
       var date = new Date();
       date.setTime(date.getTime() + (ttl * 60 * 1000));
       expires = "; expires=" + date.toGMTString();
     }
-    document.cookie = name + "=" + value + expires + "; path=/";
+    if (domain) {
+      cookieDomain = "; domain=" + domain;
+    }
+    document.cookie = name + "=" + value + expires + cookieDomain + "; path=/";
   }
 
   function getCookie(name) {
@@ -79,12 +84,12 @@
   } else {
     if (!visitorToken) {
       visitorToken = generateToken();
-      setCookie("ahoy_visitor", visitorToken, visitorTtl);
+      setCookie("ahoy_visitor", visitorToken, visitorTtl, options.domain);
     }
 
     // always generate a new visit id here
     visitToken = generateToken();
-    setCookie("ahoy_visit", visitToken, visitTtl);
+    setCookie("ahoy_visit", visitToken, visitTtl, options.domain);
 
     // make sure cookies are enabled
     if (getCookie("ahoy_visit")) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md