ahoy_matey 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a219da19a81b96724452cfbdc4286539398e821
-  data.tar.gz: 59f20f3824b077697868421296e70833d3e11f95
+  metadata.gz: 0885adb69bce04e71f7fd609edc8c780355faf3d
+  data.tar.gz: 0f28e71f18107dfd51a323a451e1c688dc14434c
 SHA512:
-  metadata.gz: 79846a0acf1bb30aca352d9d5bd00a92ce4eb16aac5970ddbc1c7ca04046d7cb4789b0127d70371ed2652f0f778087eab3eba2134e9b7e6b72dd129eb61113ea
-  data.tar.gz: a21aa44815dca19d629f53a29bdcf37b239068c8238b9cda947a9eadb9bcc8514413655ae99da3b81d7ec9a0a906aa404636ddc227f112d43d2ccf6bd5c263cc
+  metadata.gz: ee3c5d227ab4ee129e986bc315acac53569664f99c99e5a131b286c6a1f6822ac148891e7c44e60e0edb5fc76e5d494e5a665f89fdba03a190c442db134aecac
+  data.tar.gz: 1ecec9955ebed58e57ea78e22fafaaae7a8fc8c24a4f3debc928a5da109fc8be4db9174c257c5c32b1dde228d13aa53745d4b4c3c57d99625a702be6a3c673cd

data/README.md

@@ -1,8 +1,16 @@
 # Ahoy
 
-Simple, powerful visit tracking for Rails.
+:fire: Simple, powerful visit tracking for Rails.
 
-## Get Started
+In under a minute, start learning more about your visitors.
+
+- traffic source - referrer, referring domain, campaign, landing page
+- 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.
+
+## Ready, Set, Go!
 
 Add this line to your application’s Gemfile:
 
@@ -17,20 +25,18 @@ rails generate ahoy:install
 rake db:migrate
 ```
 
-Next, include the javascript file in your `app/assets/javascripts/application.js` after jQuery.
+Lastly, include the javascript file in `app/assets/javascripts/application.js` after jQuery.
 
 ```javascript
 //= require jquery
 //= require ahoy
 ```
 
-That’s it.
-
 ## What You Get
 
 When a person visits your website, Ahoy creates a visit with lots of useful information.
 
-- source (referrer, referring domain, campaign, landing page)
+- traffic source (referrer, referring domain, campaign, landing page)
 - location (country, region, and city)
 - technology (browser, OS, and device type)
 
@@ -40,7 +46,7 @@ You can store the visit id on any model. For instance, when someone places an or
 
 ```ruby
 Order.create!(
-  visit_id: ahoy_visit.id,
+  ahoy_visit_id: ahoy_visit.id,
   # ... more attributes ...
 )
 ```
@@ -67,6 +73,14 @@ 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
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/ahoy/controller_extensions.rb

@@ -0,0 +1,9 @@
+module Ahoy
+  module ControllerExtensions
+
+    def ahoy_visit
+      @ahoy_visit ||= Ahoy::Visit.where(visit_token: cookies[:ahoy_visit]).first if cookies[:ahoy_visit]
+    end
+
+  end
+end

data/lib/ahoy/version.rb

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

data/lib/ahoy_matey.rb

@@ -1,4 +1,5 @@
 require "ahoy/version"
+require "ahoy/controller_extensions"
 require "addressable/uri"
 require "browser"
 require "geocoder"
@@ -8,3 +9,5 @@ module Ahoy
     isolate_namespace Ahoy
   end
 end
+
+ActionController::Base.send :include, Ahoy::ControllerExtensions

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

@@ -8,13 +8,10 @@ class <%= migration_class_name %> < ActiveRecord::Migration
       t.string :ip
       t.text :user_agent
 
-      # acquisition
+      # traffic source
       t.text :referrer
       t.string :referring_domain
       t.string :campaign
-      # t.string :social_network
-      # t.string :search_engine
-      # t.string :search_keyword
       t.text :landing_page
 
       # technology

data/vendor/assets/javascripts/ahoy.js

@@ -1,14 +1,9 @@
-/*
- * Ahoy.js - 0.0.1
- * Super simple visit tracking
- * https://github.com/ankane/ahoy
- * MIT License
- */
+/*jslint browser: true, indent: 2, plusplus: true, vars: true */
 
 (function () {
   "use strict";
 
-  var debugMode = true;
+  var debugMode = false;
   var visitTtl, visitorTtl;
 
   if (debugMode) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kane
@@ -96,6 +96,7 @@ files:
 - app/controllers/ahoy/visits_controller.rb
 - app/models/ahoy/visit.rb
 - config/routes.rb
+- lib/ahoy/controller_extensions.rb
 - lib/ahoy/version.rb
 - lib/ahoy_matey.rb
 - lib/generators/ahoy/install_generator.rb