ahoy_matey 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 443dfa85abf63a4f515ea9c6865beb09f77404ab
-  data.tar.gz: 9099a3d7a51f6426f0ebae09fd3d9c831385a1e5
+  metadata.gz: 93699ebff0f9bfc35b50d48e7ff477963114b1b2
+  data.tar.gz: 848e8110b3cedef57143e54d8415e23a5e650c66
 SHA512:
-  metadata.gz: a0967ab9bfbb9fe5a22214d1eb74705edbeede65bdb82a07ecf2982e49a8ce8c74bd22ddfe2b302e16d63d602b1d5058c30322d1b5011879f3fc407dee9e1b37
-  data.tar.gz: b1c10a691345e7078f017eb009b64f17106cb1324bac5432bd85cc4986a18016028c4a917fe58d8e1e664ab958db43989b0097e36666343755c2001c65df199d
+  metadata.gz: fbd26a7a790231a5b8e8b3dfa2d9b7b99b9e87cd862cffbd15d53ae4a003d1e18afea1f4f46c34576c3a5d6a5f25f4f9f39cfdbb94ab9e58a24488df85c18119
+  data.tar.gz: b4046b11ece28d61d46f852bf3b0a699f52d24d34faffad687dce093260fcc564d8a5aee29e3583ec3f354fa3fb17d1e68721e7c2419551ab7e0f0e006e46ee3

data/README.md

@@ -2,6 +2,8 @@
 
 :fire: Simple, powerful visit tracking for Rails
 
+Visits are stored in **your database** so you can easily combine them with other data.
+
 You get:
 
 - traffic source - referrer, referring domain, landing page, search keyword
@@ -9,23 +11,23 @@ You get:
 - technology - browser, OS, and device type
 - utm parameters - source, medium, term, content, campaign
 
-It’s all stored in **your database** so you can easily combine it with other data.
-
 See which campaigns generate the most revenue effortlessly.
 
 ```ruby
 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"
+gem 'ahoy_matey'
 ```
 
-And run the generator. This creates a migration to store visits.
+And run the generator. This creates a model to store visits.
 
 ```sh
 rails generate ahoy:install
@@ -71,22 +73,16 @@ class Order < ActiveRecord::Base
 end
 ```
 
-When a visitor places an order, the `visit_id` column will be automatically set. Magic!
+When a visitor places an order, the `visit_id` column is automatically set.
 
-To see where most of your orders are coming from, create an association:
-
-```ruby
-class Order < ActiveRecord::Base
-  belongs_to :visit
-end
-```
+:tada: Magic!
 
-And query away:
+To see where your orders are coming from, use:
 
 ```ruby
 Order.joins(:visit).group("referring_domain").count
-Order.joins(:visit).group("device_type").count
 Order.joins(:visit).group("city").count
+Order.joins(:visit).group("device_type").count
 ```
 
 ## Users
@@ -128,7 +124,7 @@ or
 http://datakick.org/?utm_medium=twitter&utm_campaign=social&utm_source=tweet123
 ```
 
-## Features
+## More Features
 
 - Excludes bots
 - Degrades gracefully when cookies are disabled

data/app/controllers/ahoy/visits_controller.rb

@@ -7,11 +7,11 @@ module Ahoy
         Ahoy.visit_model.new do |v|
           v.visit_token = params[:visit_token]
           v.visitor_token = params[:visitor_token]
-          v.ip = request.remote_ip
-          v.user_agent = request.user_agent
-          v.referrer = params[:referrer]
-          v.landing_page = params[:landing_page]
-          v.user = current_user if respond_to?(:current_user)
+          v.ip = request.remote_ip if v.respond_to?(:ip=)
+          v.user_agent = request.user_agent if v.respond_to?(:user_agent=)
+          v.referrer = params[:referrer] if v.respond_to?(:referrer=)
+          v.landing_page = params[:landing_page] if v.respond_to?(:landing_page=)
+          v.user = current_user if respond_to?(:current_user) and v.respond_to?(:user=)
         end
 
       visit.save!

data/lib/ahoy/model.rb

@@ -12,10 +12,12 @@ module Ahoy
         before_create :set_location
 
         def set_traffic_source
-          referring_uri = Addressable::URI.parse(referrer) rescue nil
-          self.referring_domain = referring_uri.try(:host)
-          search_keyword = RefererParser::Referer.new(referrer).search_term rescue nil
-          self.search_keyword = search_keyword.present? ? search_keyword : nil
+          referring_domain = Addressable::URI.parse(referrer).host.first(255) rescue nil
+          self.referring_domain = referring_domain if respond_to?(:referring_domain=)
+          # performance hack for referer-parser
+          search_keyword = Ahoy.referrer_parser.parse(referrer)[1].first(255) rescue nil
+          self.search_keyword = search_keyword.presence if respond_to?(:search_keyword=)
+          true
         end
 
         def set_utm_parameters
@@ -23,57 +25,64 @@ module Ahoy
           if landing_uri
             query_values = landing_uri.query_values || {}
             %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
-              self[name] = query_values[name]
+              self[name] = query_values[name] if respond_to?(:"#{name}=")
             end
           end
+          true
         end
 
         def set_technology
-          browser = Browser.new(ua: user_agent)
+          if respond_to?(:user_agent)
+            browser = Browser.new(ua: user_agent)
 
-          self.browser = browser.name
+            self.browser = browser.name if respond_to?(:browser=)
 
-          # TODO add more
-          self.os =
-            if browser.android?
-              "Android"
-            elsif browser.ios?
-              "iOS"
-            elsif browser.windows_phone?
-              "Windows Phone"
-            elsif browser.blackberry?
-              "Blackberry"
-            elsif browser.chrome_os?
-              "Chrome OS"
-            elsif browser.mac?
-              "Mac"
-            elsif browser.windows?
-              "Windows"
-            elsif browser.linux?
-              "Linux"
-            end
+            # TODO add more
+            self.os =
+              if browser.android?
+                "Android"
+              elsif browser.ios?
+                "iOS"
+              elsif browser.windows_phone?
+                "Windows Phone"
+              elsif browser.blackberry?
+                "Blackberry"
+              elsif browser.chrome_os?
+                "Chrome OS"
+              elsif browser.mac?
+                "Mac"
+              elsif browser.windows?
+                "Windows"
+              elsif browser.linux?
+                "Linux"
+              end if respond_to?(:os=)
 
-          self.device_type =
-            if browser.tv?
-              "TV"
-            elsif browser.console?
-              "Console"
-            elsif browser.tablet?
-              "Tablet"
-            elsif browser.mobile?
-              "Mobile"
-            else
-              "Desktop"
-            end
+            self.device_type =
+              if browser.tv?
+                "TV"
+              elsif browser.console?
+                "Console"
+              elsif browser.tablet?
+                "Tablet"
+              elsif browser.mobile?
+                "Mobile"
+              else
+                "Desktop"
+              end if respond_to?(:device_type=)
+          end
+          true
         end
 
         def set_location
-          location = Geocoder.search(ip).first rescue nil
-          if location
-            self.country = location.country.presence
-            self.region = location.state.presence
-            self.city = location.city.presence
+          if respond_to?(:ip) and [:country=, :region=, :city=].any?{|method| respond_to?(method) }
+            location = Geocoder.search(ip).first rescue nil
+            if location
+              self.country = location.country.presence if respond_to?(:country=)
+              self.region = location.state.presence if respond_to?(:region=)
+              self.city = location.city.presence if respond_to?(:city=)
+            end
           end
+          true
         end
 
       end # end class_eval

data/lib/ahoy/version.rb

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

data/lib/ahoy_matey.rb

@@ -14,6 +14,12 @@ module Ahoy
     ::Visit
   end
 
+  # TODO private
+  # performance hack for referer-parser
+  def self.referrer_parser
+    @referrer_parser ||= RefererParser::Referer.new("https://github.com/ankane/ahoy")
+  end
+
 end
 
 ActionController::Base.send :include, Ahoy::Controller

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

@@ -1,10 +1,13 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
     create_table :visits do |t|
-      # cookies
+      # cookies *required*
       t.string :visit_token
       t.string :visitor_token
 
+      # the rest are recommended but optional
+      # simply remove the columns you don't want
+
       # standard
       t.string :ip
       t.text :user_agent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable