vero 0.5.12 → 0.6.0

data/CHANGES.md

@@ -0,0 +1,9 @@
+## 0.6.0
+
+- **All APIs using the `trackable` interface will now pass up an `:id`** (if
+it has been made available). In the past the gem would assume that the user's id
+would always be equal to their email address, but now the gem properly implements
+the Vero API.
+
+- **`update_user!` method no longer takes an optional new email address as a
+parameter**. It is recommended that the email be made a trackable field.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vero (0.5.11)
+    vero (0.6.0)
       girl_friday (>= 0.11.2)
       json
       rest-client

data/README.markdown

@@ -1,9 +1,12 @@
 # vero
 [![Build Status](https://travis-ci.org/getvero/vero.png?branch=master)](https://travis-ci.org/getvero/vero)
 
-vero makes it easy to interact with Vero's REST API from your Ruby app. Vero is a user lifecycle platform that allows you to engage and re-engage your customer base via email, based on the actions they perform in your software. 
+[vero](https://github.com/getvero/vero) makes it easy to interact with Vero's
+REST API from your Ruby app. Vero is an email marketing platform that allows you
+to engage and re-engage your customer base based on the actions they perform in
+your software.
 
-For more information about the platform, [click here](http://getvero.com) to visit Vero.
+For more information about the platform, [click here](http://getvero.com).
 
 ## Installation
 
@@ -15,51 +18,63 @@ Or install the gem:
 
     gem install vero
 
-Create a [Vero account](http://getvero.com). Create an initializer in your config/initializers folder called vero.rb with the following:
-    
+Create an initializer in your config/initializers folder called vero.rb with the
+following:
+
     # config/initializers/vero.rb
     Vero::App.init do |config|
       config.api_key = "Your API key goes here"
       config.secret = "Your API secret goes here"
     end
 
-You will be able to find your API key and secret by logging into Vero and clicking the 'Account' button at the top of the page.
+You will be able to find your API key and secret by logging into Vero
+([sign up](http://getvero.com) if you haven't already) and clicking the
+'Your Account' link at the top of the page then select 'API Keys'.
 
-By default, events are sent asynchronously using a background thread. We do however offer a few alternatives:
+By default, events are sent asynchronously using a background thread.
+We recommend that you select one of the supported queue-based alternatives:
 
     config.async = :none            # Synchronously
     config.async = :thread          # Background thread (default)
     config.async = :delayed_job     # DelayedJob
-    config.async = :resque          # Resque
+    config.async = :resque          # Resque (recommended)
 
-**Note:** Background threads are not supported by Ruby 1.8.7 or earlier. You must explicitly set `config.async` to either `:none`, `:delayed_job` or `:resque`.
+**Note:** Background threads are not supported by Ruby 1.8.7 or earlier.
+You must explicitly set `config.async` to either `:none`, `:delayed_job` or
+`:resque`.
 
-**Note:** If you're using DelayedJob and Mongoid, you must add `gem "delayed_job_mongoid"` to your Gemfile.
+**Note:** If you're using Mongoid with DelayedJob, you must add
+`gem "delayed_job_mongoid"` to your Gemfile.
 
-Finally, vero will automatcially choose whether to send requests to your **development** or **live** environment if you are using Rails 3.x. You can override this in your initializer:
+Finally, vero will automatically choose whether to send requests to your
+**development** or **live** environment if you are using Rails 3.x. You can
+override this in your initializer:
 
     config.development_mode = true # or false
 
 ## Setup tracking
 
-You will need to define who should be tracked and what information about them you'd like to send to Vero. In this example we'll track users:
-    
+You will need to define who should be tracked and what information about them
+you would like sent to Vero. In this example we'll track users:
+
     # app/models/user.rb
     class User < ActiveRecord::Base
-      include Vero::Trackable 
-      trackable :email, :name, :age
+      include Vero::Trackable
+      trackable :id, :email, :name
 
       ...
     end
 
-As you can see we're saying that a User is trackable and that we'd like to pass up their email address, name and age. 
+As you can see we're saying that a User is trackable and that we'd like to pass
+up their user id, email address, and name.
+
+Each symbol passed to trackable should reference either an instance method or
+field. Therefore it's perfectly legal to do something like:
 
-Each symbol passed to trackable should reference either an instance method or an ActiveRecord field. Therefore it's perfectly legal to do something like:
-    
     # app/models/user.rb
     class User < ActiveRecord::Base
-      include Vero::Trackable 
-      trackable :email, :contest_count
+      include Vero::Trackable
+      trackable :id, :email, :contest_count
 
       has_many :contests
 
@@ -68,22 +83,29 @@ Each symbol passed to trackable should reference either an instance method or an
       end
     end
 
-There is one caveat, email (or email_address) is a required field. If the user's email address is stored under a different field, you can do the following:
-    
+There is one caveat: you must pass an "id" to the API in order to perform
+requests. In many cases the user "id" will simply be their email address. The
+API will assume that if an "id" is not present that it should use "email" as
+the "id".
+
+If the user's email address is stored under a different field, you can do the
+following:
+
     # app/models/user.rb
     class User < ActiveRecord::Base
-      include Vero::Trackable 
-      trackable :email
+      include Vero::Trackable
+      trackable :id, :email
 
       def email; self.primary_contact; end
     end
 
-Finally, you can track multiple properties stored in a Hash by doing the following:
+Finally, you can track multiple properties stored in a Hash by doing the
+following:
 
     # app/models/user.rb
     class User < ActiveRecord::Base
-      include Vero::Trackable 
-      trackable :email, {:extras => :properties}
+      include Vero::Trackable
+      trackable :id, :email, {:extras => :properties}
 
       def email; self.primary_contact; end
 
@@ -94,28 +116,29 @@ Finally, you can track multiple properties stored in a Hash by doing the followi
         }
       end
     end
-    
-**Note:** You may choose to bypass extending the `User` model by calling the API directly. More information can be found below.
+
+**Note:** You may choose to bypass extending the `User` model by calling the
+API via [simple DSL](https://github.com/getvero/vero#simple-dsl) found below.
 
 ## Sending events
 
 Events can be sent by any model which has been previously marked as trackable.
 
 To send an event:
-    
+
     # app/controllers/contests_controller.rb
     class ContestsController < ActionController::Base
       before_filter :authenticate_user!
       ...
 
-      
+
       def create
         @contest = current_user.contests.build(params[:contest])
 
         if @contest.save
           # Tell Vero that a new contest has been created
-          current_user.track('new_contest_created')
-          
+          current_user.track!('new_contest_created')
+
           flash[:notice] = "New contest saved successfully!"
           redirect_to contests_path
         else
@@ -126,20 +149,20 @@ To send an event:
     end
 
 You may want to send additional data about an event:
-    
+
     # app/controllers/contests_controller.rb
     class ContestsController < ActionController::Base
       before_filter :authenticate_user!
       ...
 
-      
+
       def create
         @contest = current_user.contests.build(params[:contest])
 
         if @contest.save
           # Tell Vero that a new contest has been created, and the id and name
-          current_user.track('new_contest_created', {:id => @contest.id, :name => @content.name})
-          
+          current_user.track!('new_contest_created', {:id => @contest.id, :name => @content.name})
+
           flash[:notice] = "New contest saved successfully!"
           redirect_to contests_path
         else
@@ -151,9 +174,11 @@ You may want to send additional data about an event:
 
 ## Simple DSL
 
-To avoid having to extend the `User` model, we offer the option to call our API using a simple DSL (thanks @jherdman) as you would from the Javascript library.
+To avoid having to extend the `User` model, we offer the option to call our API
+using a simple DSL (thanks @jherdman) as you would from the Javascript library.
 
-First, ensure you've correctly configured the gem following the instructions as outlined in Installation. Now you can call the API using the following methods:
+First, ensure you've correctly configured the gem following the instructions as
+outlined in Installation. Now you can call the API using the following methods:
 
     class UsersController < ApplicationController
       include Vero::DSL
@@ -161,30 +186,30 @@ First, ensure you've correctly configured the gem following the instructions as
       def perform_action
         # Tracking an event
         vero.events.track!({
-          :event_name => "test_event", 
-          :data => {:date => "2013-02-12 16:17"}, 
-          :identity => {:email => "james@getvero.com"}
+          :event_name => "test_event",
+          :data => {:date => "2013-02-12 16:17"},
+          :identity => {:id => 123, :email => "james@getvero.com"}
         })
       end
 
       def create
         # Identifying a user
-        vero.users.track!({:email => "james@getvero.com", :data => {}})
+        vero.users.track!({:id => 123, :data => {}})
       end
 
       def update
         # Editing a user
-        vero.users.edit_user!({:email => "james@getvero.com", :changes => {:age => 25}})
+        vero.users.edit_user!({:id => 123, :changes => {:age => 25}})
 
         # Editing a user's tags
-        vero.users.edit_user_tags!({:email => "james@getvero.com", :add => [], :remove => ["awesome"]})
-        
+        vero.users.edit_user_tags!({:id => 123, :add => ["awesome"], :remove => []})
+
         # Changing a user's id
-        vero.users.reidentify!({:id => "james@getvero.com", :new_id => "honeybadger@getvero.com"})
+        vero.users.reidentify!({:id => 123, :new_id => "honeybadger@getvero.com"})
       end
 
       def destroy
-        vero.users.unsubscribe!({:email => "james@getvero.com"})
+        vero.users.unsubscribe!({:id => 123})
       end
     end
 
@@ -194,8 +219,20 @@ This gem is distributed under the MIT License.
 
 Copyright (C) 2013 Vero (Invc Me Inc.)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/vero/context/api.rb

@@ -6,27 +6,33 @@ module Vero
     end
 
     def identify!
-      data    = subject.to_vero
-      options = {:email => data[:email], :data => data}
+      identity = subject.to_vero
+      options = {:id => identity[:id], :email => identity[:email], :data => identity}
       Vero::Api::Users.track!(options, self)
     end
 
-    def update_user!(email = nil)
-      changes = subject.to_vero
-      options = {:email => (email || changes[:email]), :changes => changes}
+    def update_user!
+      identity = subject.to_vero
+      options = {:id => identity[:id], :email => identity[:email], :changes => identity}
       Vero::Api::Users.edit_user!(options, self)
     end
 
     def update_user_tags!(add = [], remove = [])
-      identity  = subject.to_vero
-      options   = {:email => identity[:email], :add => add, :remove => remove}
+      identity = subject.to_vero
+      options = {:id => identity[:id], :email => identity[:email], :add => Array(add), :remove => Array(remove)}
       Vero::Api::Users.edit_user_tags!(options, self)
     end
 
     def unsubscribe!
-      identity  = subject.to_vero
-      options   = {:email => identity[:email]}
+      identity = subject.to_vero
+      options = {:id => identity[:id], :email => identity[:email]}
       Vero::Api::Users.unsubscribe!(options, self)
     end
+
+    def reidentify!(previous_id)
+      identity = subject.to_vero
+      options = {:id => previous_id, :new_id => identity[:id]}
+      Vero::Api::Users.reidentify!(options, self)
+    end
   end
 end

data/lib/vero/dsl.rb

@@ -15,7 +15,7 @@ module Vero
   #   end
   module DSL
     def vero
-      @proxy ||= Proxy.new
+      @_vero_proxy ||= Proxy.new
     end
 
     # :nodoc:

data/lib/vero/trackable/base.rb

@@ -38,7 +38,7 @@ module Vero
           other.reject! { |i| !(i.is_a?(Hash) && i.has_key?(:extras)) }
           other.each do |h|
             symbol = h[:extras]
-            t = respond_to?(symbol) ? send(symbol) : nil
+            t = respond_to?(symbol, true) ? send(symbol) : nil
             result.merge!(t) if t.is_a?(Hash)
           end
         end
@@ -59,4 +59,4 @@ module Vero
       end
     end
   end
-end
+end

data/lib/vero/version.rb

@@ -1,3 +1,3 @@
 module Vero
-  VERSION = '0.5.12'
+  VERSION = '0.6.0'
 end

data/spec/lib/api/events/track_api_spec.rb

@@ -19,31 +19,31 @@ describe Vero::Api::Workers::Events::TrackAPI do
       it "should raise an error if event_name is a blank String" do
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => nil}
         subject.options = options
-        expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+        expect { subject.send(:validate!) }.to raise_error
 
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'}
         subject.options = options
-        expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+        expect { subject.send(:validate!) }.to_not raise_error
       end
 
       it "should raise an error if data is not either nil or a Hash" do
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event', :data => []}
         subject.options = options
-        expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+        expect { subject.send(:validate!) }.to raise_error
 
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event', :data => nil}
         subject.options = options
-        expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+        expect { subject.send(:validate!) }.to_not raise_error
 
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event', :data => {}}
         subject.options = options
-        expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+        expect { subject.send(:validate!) }.to_not raise_error
       end
 
       it "should not raise an error when the keys are Strings" do
         options = {"auth_token" => 'abcd', "identity" => {"email" => 'test@test.com'}, "event_name" => 'test_event', "data" => {}}
         subject.options = options
-        expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+        expect { subject.send(:validate!) }.to_not raise_error
       end
     end
 

data/spec/lib/api/users/edit_api_spec.rb

@@ -15,7 +15,7 @@ describe Vero::Api::Workers::Users::EditAPI do
     it "should not raise an error when the keys are Strings" do
       options = {"auth_token" => 'abcd', "email" => 'test@test.com', "changes" => { "email" => 'test@test.com' }}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
   end
 

data/spec/lib/api/users/edit_tags_api_spec.rb

@@ -16,45 +16,45 @@ describe Vero::Api::Workers::Users::EditTagsAPI do
     it "should raise an error if email is a blank String" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => nil, :add => []}
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
 
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :add => []}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
 
     it "should raise an error if add is not an Array or missing" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :add => "foo" }
 
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
     end
 
     it "should raise an error if remove is not an Array or missing" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :remove => "foo" }
 
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
     end
 
     it "should raise an error if botha add and remove are missing" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com'}
 
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
     end
 
     it "should not raise an error if the correct arguments are passed" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :remove => [ "Hi" ] }
 
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
 
     it "should not raise an error when the keys are Strings" do
       options = {"auth_token" => 'abcd', "identity" => {"email" => 'test@test.com'}, "email" => 'test@test.com', "remove" => [ "Hi" ] }
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
   end
 

data/spec/lib/api/users/reidentify_spec.rb

@@ -15,7 +15,7 @@ describe Vero::Api::Workers::Users::ReidentifyAPI do
     it "should not raise an error when the keys are Strings" do
       options = {"auth_token" => 'abcd', "id" => 'test@test.com', "new_id" => 'test2@test.com'}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
 
     it "should raise an error if id is missing" do

data/spec/lib/api/users/track_api_spec.rb

@@ -15,39 +15,39 @@ describe Vero::Api::Workers::Users::TrackAPI do
     it "should raise an error if email and id are are blank String" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :id => nil, :email => nil}
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
 
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :id => nil, :email => 'test@test.com'}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
 
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :id => "", :email => nil}
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
 
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :id => "user123", :email => nil}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
 
     it "should raise an error if data is not either nil or a Hash" do
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :data => []}
       subject.options = options
-      expect { subject.send(:validate!) }.to raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to raise_error
 
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :data => nil}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
 
       options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :email => 'test@test.com', :data => {}}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
 
     it "should not raise an error when the keys are Strings" do
       options = {"auth_token" => 'abcd', "identity" => {"email" => 'test@test.com'}, "email" => 'test@test.com', "data" => {}}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
   end
 

data/spec/lib/api/users/unsubscribe_api_spec.rb

@@ -15,7 +15,7 @@ describe Vero::Api::Workers::Users::UnsubscribeAPI do
     it "should not raise an error when the keys are Strings" do
       options = {"auth_token" => 'abcd', "email" => 'test@test.com', "changes" => { "email" => 'test@test.com' }}
       subject.options = options
-      expect { subject.send(:validate!) }.to_not raise_error(ArgumentError)
+      expect { subject.send(:validate!) }.to_not raise_error
     end
   end
 

data/spec/lib/trackable_spec.rb

@@ -1,5 +1,14 @@
 require 'spec_helper'
 
+def vero_context(user, logging = true, async = false)
+  context = Vero::Context.new(Vero::App.default_context)
+  context.subject = user
+  context.config.logging = logging
+  context.config.async = async
+
+  context
+end
+
 describe Vero::Trackable do
   before :each do
     @request_params = {
@@ -16,26 +25,17 @@ describe Vero::Trackable do
   end
 
   context "the gem has not been configured" do
-    before :each do
-      Vero::App.reset!
-    end
+    before { Vero::App.reset! }
+    it "should raise an error when API requests are made" do
+      expect { @user.track(@request_params[:event_name], @request_params[:data]) }.to raise_error
 
-    describe :track do
-      it "should raise an error" do
-        expect { @user.track(@request_params[:event_name], @request_params[:data]) }.to raise_error(RuntimeError, "You must configure the 'vero' gem. Visit https://github.com/semblancesystems/vero for more details.")
-      end
-    end
-
-    describe :identity! do
-      it "should raise an error" do
-        @user.stub(:post_later).and_return('success')
-        expect { @user.identity! }.to raise_error
-      end
+      @user.stub(:post_later).and_return('success')
+      expect { @user.identity! }.to raise_error
     end
   end
 
   context "the gem has been configured" do
-    before :each do
+    before do
       Vero::App.init do |c|
         c.api_key = 'abcd1234'
         c.secret = 'efgh5678'
@@ -55,48 +55,31 @@ describe Vero::Trackable do
       end
 
       it "should not send a track request when the required parameters are invalid" do
-        expect { @user.track!(nil) }.to raise_error(ArgumentError)
-        expect { @user.track!('') }.to raise_error(ArgumentError)
-        expect { @user.track!('test', '') }.to raise_error(ArgumentError)
+        expect { @user.track!(nil) }.to raise_error
+        expect { @user.track!('') }.to raise_error
+        expect { @user.track!('test', '') }.to raise_error
       end
 
       it "should send a `track!` request when async is set to false" do
-        context = Vero::Context.new(Vero::App.default_context)
-        context.subject = @user
-        context.config.logging = true
-
+        context = vero_context(@user)
         @user.stub(:with_vero_context).and_return(context)
 
         RestClient.stub(:post).and_return(200)
 
-        # RestClient.should_receive(:post).with("https://api.getvero.com/api/v2/events/track.json", {:data=>{:test=>1}, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20, :_user_type=>"User"}, :auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true}.to_json, @content_type_params)
-
         Vero::Api::Events.stub(:track!).and_return(200)
         Vero::Api::Events.should_receive(:track!).with(@request_params, context)
         @user.track!(@request_params[:event_name], @request_params[:data]).should == 200
 
-        # RestClient.should_receive(:post).with("https://api.getvero.com/api/v2/events/track.json", {:data=>{}, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20, :_user_type=>"User"}, :auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true}.to_json, @content_type_params)
-
         Vero::Api::Events.stub(:track!).and_return(200)
         Vero::Api::Events.should_receive(:track!).with(@request_params.merge(:data => {}), context)
         @user.track!(@request_params[:event_name]).should == 200
       end
 
       context 'when set to be async' do
-        let(:my_context) { Vero::Context.new(Vero::App.default_context) }
-
-        before do
-          my_context.config.logging = true
-          my_context.subject = @user
-          my_context.config.async = true
-
-          @user.stub(:with_vero_context).and_return(my_context)
-        end
+        before { @user.stub(:with_vero_context).and_return vero_context(@user, true, true) }
 
         context 'using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.8.7')
-          end
+          before { stub_const('RUBY_VERSION', '1.8.7') }
 
           it 'raises an error' do
             expect { @user.track!(@request_params[:event_name], @request_params[:data]) }.to raise_error
@@ -105,9 +88,7 @@ describe Vero::Trackable do
         end
 
         context 'not using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.9.3')
-          end
+          before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
             @user.track!(@request_params[:event_name], @request_params[:data]).should be_true
@@ -120,6 +101,7 @@ describe Vero::Trackable do
     describe :identify! do
       before do
         @request_params = {
+          :id => nil,
           :email => 'durkster@gmail.com',
           :data => {:email => 'durkster@gmail.com', :age => 20, :_user_type => "User"}
         }
@@ -127,14 +109,9 @@ describe Vero::Trackable do
       end
 
       it "should send an `identify` request when async is set to false" do
-        context = Vero::Context.new(Vero::App.default_context)
-        context.subject = @user
-
+        context = vero_context(@user)
         @user.stub(:with_vero_context).and_return(context)
 
-        # RestClient.stub(:post).and_return(200)
-        # RestClient.should_receive(:post).with(@url, @request_params.to_json, @content_type_params)
-
         Vero::Api::Users.stub(:track!).and_return(200)
         Vero::Api::Users.should_receive(:track!).with(@request_params, context)
 
@@ -142,17 +119,13 @@ describe Vero::Trackable do
       end
 
       context 'when set to use async' do
-        let(:my_context) { Vero::Context.new(Vero::App.default_context) }
-
         before do
-          my_context.subject = @user
-          my_context.config.async = true
+          context = vero_context(@user, false, true)
+          @user.stub(:with_vero_context).and_return(context)
         end
 
         context 'and using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.8.7')
-          end
+          before { stub_const('RUBY_VERSION', '1.8.7') }
 
           it 'raises an error' do
             expect { @user.identify! }.to raise_error
@@ -160,9 +133,7 @@ describe Vero::Trackable do
         end
 
         context 'and not using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.9.3')
-          end
+          before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
             @user.identify!.should be_true
@@ -174,36 +145,19 @@ describe Vero::Trackable do
     describe :update_user! do
       before do
         @request_params = {
+          :id => nil,
           :email => 'durkster@gmail.com',
           :changes => {:email => 'durkster@gmail.com', :age => 20, :_user_type => "User"},
         }
         @url = "https://api.getvero.com/api/v2/users/edit.json"
       end
 
-      it "should be able to choose an email address" do
-        context = Vero::Context.new(Vero::App.default_context)
-        context.subject = @user
-
-        @user.stub(:with_vero_context).and_return(context)
-
-        # RestClient.stub(:put).and_return(200)
-        # RestClient.should_receive(:put).with(@url, @request_params.merge(:email => "durkster1@gmail.com").to_json, @content_type_params)
-
-        Vero::Api::Users.stub(:edit_user!).and_return(200)
-        Vero::Api::Users.should_receive(:edit_user!).with(@request_params.merge(:email => "durkster1@gmail.com"), context)
-
-        @user.with_vero_context.update_user!("durkster1@gmail.com").should == 200
-      end
-
       it "should send an `update_user` request when async is set to false" do
         context = Vero::Context.new(Vero::App.default_context)
         context.subject = @user
 
         @user.stub(:with_vero_context).and_return(context)
 
-        # RestClient.stub(:put).and_return(200)
-        # RestClient.should_receive(:put).with(@url, @request_params.to_json, @content_type_params)
-
         Vero::Api::Users.stub(:edit_user!).and_return(200)
         Vero::Api::Users.should_receive(:edit_user!).with(@request_params, context)
 
@@ -221,9 +175,7 @@ describe Vero::Trackable do
         end
 
         context 'and using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.8.7')
-          end
+          before { stub_const('RUBY_VERSION', '1.8.7') }
 
           it 'raises an error' do
             expect { @user.with_vero_context.update_user! }.to raise_error
@@ -231,9 +183,7 @@ describe Vero::Trackable do
         end
 
         context 'and not using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.9.3')
-          end
+          before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
             @user.with_vero_context.update_user!.should be_true
@@ -245,6 +195,7 @@ describe Vero::Trackable do
     describe :update_user_tags! do
       before do
         @request_params = {
+          :id => nil,
           :email => 'durkster@gmail.com',
           :add => [],
           :remove => []
@@ -259,9 +210,6 @@ describe Vero::Trackable do
 
         @user.stub(:with_vero_context).and_return(context)
 
-        # RestClient.stub(:put).and_return(200)
-        # RestClient.should_receive(:put).with(@url, @request_params.to_json, @content_type_params)
-
         Vero::Api::Users.stub(:edit_user_tags!).and_return(200)
         Vero::Api::Users.should_receive(:edit_user_tags!).with(@request_params, context)
 
@@ -284,6 +232,7 @@ describe Vero::Trackable do
     describe :unsubscribe! do
       before do
         @request_params = {
+          :id => nil,
           :email => 'durkster@gmail.com'
         }
         @url = "https://api.getvero.com/api/v2/users/unsubscribe.json"
@@ -296,9 +245,6 @@ describe Vero::Trackable do
 
         @user.stub(:with_vero_context).and_return(context)
 
-        # RestClient.stub(:post).and_return(200)
-        # RestClient.should_receive(:post).with(@url, @request_params)
-
         Vero::Api::Users.stub(:unsubscribe!).and_return(200)
         Vero::Api::Users.should_receive(:unsubscribe!).with(@request_params, context)
 
@@ -316,9 +262,7 @@ describe Vero::Trackable do
         end
 
         context 'and using Ruby 1.8.7' do
-          before do
-            stub_const('RUBY_VERSION', '1.8.7')
-          end
+          before { stub_const('RUBY_VERSION', '1.8.7') }
 
           it 'raises an error' do
             expect { @user.with_vero_context.unsubscribe! }.to raise_error
@@ -326,9 +270,7 @@ describe Vero::Trackable do
         end
 
         context 'and using Ruby 1.9.3' do
-          before do
-            stub_const('RUBY_VERSION', '1.9.3')
-          end
+          before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
             @user.with_vero_context.unsubscribe!.should be_true
@@ -338,32 +280,31 @@ describe Vero::Trackable do
     end
 
     describe :trackable do
-      after :each do
-        User.reset_trackable_map!
-        User.trackable :email, :age
-      end
+      before { User.reset_trackable_map! }
 
       it "should build an array of trackable params" do
-        User.reset_trackable_map!
         User.trackable :email, :age
         User.trackable_map.should == [:email, :age]
       end
 
       it "should append new trackable items to an existing trackable map" do
-        User.reset_trackable_map!
         User.trackable :email, :age
         User.trackable :hair_colour
         User.trackable_map.should == [:email, :age, :hair_colour]
       end
 
       it "should append an extra's hash to the trackable map" do
-        User.reset_trackable_map!
         User.trackable :email, {:extras => :properties}
         User.trackable_map.should == [:email, {:extras => :properties}]
       end
     end
 
     describe :to_vero do
+      before :all do
+        User.reset_trackable_map!
+        User.trackable :email, :age
+      end
+
       it "should return a hash of all values mapped by trackable" do
         user = User.new
         user.to_vero.should == {:email => 'durkster@gmail.com', :age => 20, :_user_type => "User"}
@@ -397,6 +338,9 @@ describe Vero::Trackable do
           :gender => "female"
         }
         user.to_vero.should == {:email => 'durkster@gmail.com', :age => 20, :gender => "female", :_user_type => "UserWithExtras"}
+
+        user = UserWithPrivateExtras.new
+        user.to_vero.should == {:email => 'durkster@gmail.com', :age => 26, :_user_type => "UserWithPrivateExtras"}
       end
     end
 

data/spec/support/user_support.rb

@@ -77,4 +77,18 @@ class UserWithExtras
   def email
     'durkster@gmail.com'
   end
+end
+
+class UserWithPrivateExtras
+  include Vero::Trackable
+  trackable :email, {:extras => :properties}
+
+  def email
+    'durkster@gmail.com'
+  end
+
+  private
+  def properties
+    {:age => 26}
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vero
 version: !ruby/object:Gem::Version
-  version: 0.5.12
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -145,6 +145,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - Gemfile
 - Gemfile.lock
 - lib/generators/vero_generator.rb