ahoy_matey 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ef1f6ecc94ec7e579782279c9187ec29be12393
-  data.tar.gz: 0515d97b0c1916bd94e057de85fb1a1ccb11f8d2
+  metadata.gz: e01d2ba2f3f5b56e44fa016d8f0eb16e669b499d
+  data.tar.gz: 9f243b939b05458432e3651d7f75728bbd592ab8
 SHA512:
-  metadata.gz: 7fb051cdca6fa1fe250094b03acf393e28c93c93df0a4ca9379fd6aa468478668be22f4cce72316ea5d9db20824d7ea700e627c5f2787f0b9ce24878d2736346
-  data.tar.gz: 00435c1bb0c2f83fec2eef2bf73d45c908269d793a5c18ebc3de39dd3286c13f33e390a8c83e3d3c05581602836c905be0740a21d381ec695a3bcc968dc584dd
+  metadata.gz: 10c69828ab683a8a0048e22a62f83d1c920d811e7e723658c8e90d954e2f7221b695a91038dae105bfecabb04b5470d45d9a9108b2b784663a377f4eed02a43c
+  data.tar.gz: 6200522f9ede3ce32ab07bd02fcfc5e179b874cea692ea6ade74f62cbd7b7642870ad568a7115408b01976a9dc29e04f716048d71f833ade6a0c86434a4602ab

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.5
+
+- Added support for Doorkeeper
+- Added options to `visitable`
+- Added `landing_params` method
+
 ## 0.1.4
 
 - Added `ahoy.ready()` and `ahoy.log()` for events

data/README.md

@@ -19,6 +19,8 @@ Order.joins(:visit).group("utm_campaign").sum(:revenue)
 
 :seedling: To track events like page views, check out [Ahoy Events](https://github.com/ankane/ahoy_events).
 
+:postbox: To track emails, check out [Ahoy Email](https://github.com/ankane/ahoy_email).
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -167,7 +169,7 @@ Turn off logging
 ahoy.debug(false);
 ```
 
-### Native Apps [experimental]
+### Native Apps
 
 When a user launches the app, create a visit.  Send a `POST` request to `/ahoy/visits` with:
 
@@ -189,6 +191,22 @@ Send the visit token in the `Ahoy-Visit` header for all requests.
 
 After 4 hours, create another visit and use the updated visit token.
 
+### Doorkeeper
+
+To attach the user with [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper), be sure you have a `current_resource_owner` method in `ApplicationController`.
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  private
+
+  def current_resource_owner
+    User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
+  end
+
+end
+```
+
 ### More
 
 - Excludes bots
@@ -210,11 +228,42 @@ Change the platform on the web
 var ahoy = {"platform": "Mobile Web"}
 ```
 
+Track additional values
+
+```ruby
+class Visit < ActiveRecord::Base
+  ahoy_visit
+
+  before_create :set_gclid
+
+  def set_gclid
+    self.gclid = landing_params["gclid"]
+  end
+
+end
+```
+
+Use a method besides `current_user`
+
+```ruby
+Ahoy.user_method = :true_user
+```
+
+or use a Proc
+
+```ruby
+Ahoy.user_method = proc {|controller| controller.current_user }
+```
+
+Customize visitable
+
+```ruby
+visitable :sign_up_visit, class_name: "Visit"
+```
+
 ## TODO
 
-- track emails
 - simple dashboard
-- hook to store additional fields
 - turn off modules
 
 ## History

data/app/controllers/ahoy/visits_controller.rb

@@ -13,7 +13,7 @@ module Ahoy
           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=)
+          v.user = Ahoy.fetch_user(self) if v.respond_to?(:user=)
           v.platform = params[:platform] if v.respond_to?(:platform=)
           v.app_version = params[:app_version] if v.respond_to?(:app_version=)
           v.os_version = params[:os_version] if v.respond_to?(:os_version=)

data/lib/ahoy/model.rb

@@ -21,12 +21,8 @@ module Ahoy
         end
 
         def set_utm_parameters
-          landing_uri = Addressable::URI.parse(landing_page) rescue nil
-          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] if respond_to?(:"#{name}=")
-            end
+          %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
+            self[name] = landing_params[name] if respond_to?(:"#{name}=")
           end
           true
         end
@@ -92,23 +88,31 @@ module Ahoy
           true
         end
 
+        def landing_params
+          @landing_params ||= begin
+            landing_uri = Addressable::URI.parse(landing_page) rescue nil
+            ActiveSupport::HashWithIndifferentAccess.new((landing_uri && landing_uri.query_values) || {})
+          end
+        end
+
       end # end class_eval
     end
 
-    def visitable
+    def visitable(name = nil, options = {})
+      if name.is_a?(Hash)
+        name = nil
+        options = name
+      end
+      name ||= :visit
       class_eval do
-        belongs_to :visit
-
+        belongs_to name, options
         before_create :set_visit
-
+      end
+      class_eval %Q{
         def set_visit
-          if !self.class.column_names.include?("visit_id")
-            raise "Add a visit_id column to this table to use visitable"
-          else
-            self.visit ||= RequestStore.store[:ahoy_controller].try(:send, :current_visit)
-          end
+          self.#{name} ||= RequestStore.store[:ahoy_controller].try(:send, :current_visit)
         end
-      end
+      }
     end
 
   end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/ahoy_matey.rb

@@ -24,6 +24,19 @@ module Ahoy
     @referrer_parser ||= RefererParser::Referer.new("https://github.com/ankane/ahoy")
   end
 
+  def self.fetch_user(controller)
+    if user_method.respond_to?(:call)
+      user_method.call(controller)
+    else
+      controller.send(user_method)
+    end
+  end
+
+  mattr_accessor :user_method
+  self.user_method = proc do |controller|
+    (controller.respond_to?(:current_user) && controller.current_user) || (controller.respond_to?(:current_resource_owner, true) and controller.send(:current_resource_owner))
+  end
+
 end
 
 ActionController::Base.send :include, Ahoy::Controller

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable