ahoy_matey 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eee3fa6c02d811dff0ae4091ab08589366949211
-  data.tar.gz: 953da9d5b867bfb6c8abff089faa3ee06b965b0d
+  metadata.gz: 3e588efc9bc71536e8077c79e1b874db35333d92
+  data.tar.gz: 1c97d1fc30240204a78519d8a3866e68351d40b9
 SHA512:
-  metadata.gz: 4f37f8317be93f3c5192bdbc4b79fabdfa995d97da6385ad1eeb90074ea3ef8d9d4896e7f51ad4961e63f863d6269eb0fe8b59168d632db4de83b9ab158eb0ea
-  data.tar.gz: 402780cfd8f187c0f084562ae853678f18e43ce80b331e5820843e59b823e8733d12de0fd2d2c2413cde8ea596b9c474e36a9ec70c81f26aeb1c62f143aa1d05
+  metadata.gz: e448cfa2434da5e946fc7be76dcb0b626f70301828c2fa21fb19ea94e7d2e0d0faeb6d1b140159e9ee4e0de8a805322650d78fe41bf456d3698adc13ccc3e117
+  data.tar.gz: 795e1ecfb5d87235bd9e3fd66e0714afbda91b9e8ace354509345b12aa62e98e88379874263348b3f96464d18620d8c5db137542716e36e37345df0cfa168aa2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.1
+
+- Fixed `visitable` outside of requests
+
 ## 1.0.0
 
 - Added support for any data store, and Mongoid out of the box

data/README.md

@@ -1,8 +1,8 @@
 # Ahoy
 
-:fire: Simple, powerful analytics for Rails
+Ahoy provides a solid foundation to track visits and events in Ruby, JavaScript, and native apps.
 
-Ahoy makes it easy to track visitors and users.  Track visits (sessions) and events in Ruby, JavaScript, and native apps.  Works with any data store so you can easily scale.
+:fire: Works with any data store so you can easily scale.
 
 :postbox: To track emails, check out [Ahoy Email](https://github.com/ankane/ahoy_email).
 
@@ -25,16 +25,14 @@ And add the javascript file in `app/assets/javascripts/application.js` after jQu
 
 ## Choose a Data Store
 
-### ActiveRecord
-
-#### PostgreSQL
+### PostgreSQL
 
 ```sh
 rails generate ahoy:stores:active_record -d postgresql
 rake db:migrate
 ```
 
-#### MySQL and SQLite
+### MySQL or SQLite
 
 Add [activeuuid](https://github.com/jashmenn/activeuuid) to your Gemfile.
 
@@ -90,6 +88,8 @@ class Ahoy::Store < Ahoy::Stores::BaseStore
 end
 ```
 
+See the [ActiveRecordStore](https://github.com/ankane/ahoy/blob/master/lib/ahoy/stores/active_record_store.rb) for an example.
+
 ## How It Works
 
 ### Visits
@@ -101,7 +101,7 @@ When someone visits your website, Ahoy creates a visit with lots of useful infor
 - **technology** - browser, OS, and device type
 - **utm parameters** - source, medium, term, content, campaign
 
-Use the `current_visit` method to access it, and the `ahoy.visit_id` and `ahoy.visitor_id` methods to get the ids.
+Use the `current_visit` method to access it.
 
 ### Events
 
@@ -150,58 +150,74 @@ ahoy.authenticate(user)
 Stores are built to be highly customizable.
 
 ```ruby
-class Ahoy::Store < Ahoy::Stores::ActiveRecord
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
   # add methods here
 end
 ```
 
 ### Exclude Bots and More
 
-Bots are excluded by default. To change this, use:
+Exclude visits and events from being tracked with:
 
 ```ruby
-def exclude?
-  bot? || request.ip == "192.168.1.1"
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+
+  def exclude?
+    bot? || request.ip == "192.168.1.1"
+  end
+
 end
 ```
 
+Bots are excluded by default.
+
 ### Track Additional Values
 
 ```ruby
-def track_visit(options)
-  super do |visit|
-    visit.gclid = visit_properties.landing_params["gclid"]
-  end
-end
-```
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
 
-or
+  def track_visit(options)
+    super do |visit|
+      visit.gclid = visit_properties.landing_params["gclid"]
+    end
+  end
 
-```ruby
-def track_event(name, properties, options)
-  super do |event|
-    event.ip = request.ip
+  def track_event(name, properties, options)
+    super do |event|
+      event.ip = request.ip
+    end
   end
+
 end
 ```
 
 ### Customize User
 
+If you use a method other than `current_user`, set it here:
+
 ```ruby
-def user
-  controller.true_user
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+
+  def user
+    controller.true_user
+  end
+
 end
 ```
 
 ### Report Exceptions
 
-Exceptions are caught by default so analytics do not break your app.
+Exceptions are rescued so analytics do not break your app.
 
 To report them to a service, use:
 
 ```ruby
-def report_exception(e)
-  Rollbar.report_exception(e)
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+
+  def report_exception(e)
+    Rollbar.report_exception(e)
+  end
+
 end
 ```
 
@@ -210,12 +226,16 @@ end
 For ActiveRecord and Mongoid stores
 
 ```ruby
-def visit_model
-  CustomVisit
-end
+class Ahoy::Store < Ahoy::Stores::ActiveRecordStore
+
+  def visit_model
+    CustomVisit
+  end
+
+  def event_model
+    CustomEvent
+  end
 
-def event_model
-  CustomEvent
 end
 ```
 

data/lib/ahoy/model.rb

@@ -13,7 +13,7 @@ module Ahoy
       end
       class_eval %Q{
         def set_visit
-          self.#{name} ||= RequestStore.store[:ahoy].visit
+          self.#{name} ||= RequestStore.store[:ahoy].try(:visit)
         end
       }
     end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable