vero 0.0.4 → 0.1.0

data/Gemfile.lock

@@ -3,6 +3,8 @@ PATH
   specs:
     vero (0.0.4)
       delayed_job
+      delayed_job_active_record
+      delayed_job_mongoid
       rest-client
 
 GEM
@@ -36,6 +38,7 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
+    bson (1.6.4)
     builder (3.0.0)
     columnize (0.3.6)
     debugger (1.1.3)
@@ -47,6 +50,12 @@ GEM
     debugger-ruby_core_source (1.1.3)
     delayed_job (3.0.3)
       activesupport (~> 3.0)
+    delayed_job_active_record (0.3.2)
+      activerecord (> 2.1.0)
+      delayed_job (~> 3.0.0)
+    delayed_job_mongoid (1.0.8)
+      delayed_job (~> 3.0.0)
+      mongoid (>= 2.0)
     diff-lcs (1.1.3)
     erubis (2.7.0)
     hike (1.2.1)
@@ -58,6 +67,12 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.18)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.11)
+      activemodel (~> 3.1)
+      mongo (<= 1.6.2)
+      tzinfo (~> 0.3.22)
     multi_json (1.3.6)
     polyglot (0.3.3)
     rack (1.4.1)

data/README.markdown

@@ -1,6 +1,8 @@
 # vero
 
-vero makes it easy to interact with Vero's REST API from your Rails 3.x 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. For more information about the platform, visit [Vero](http://getvero.com).
+vero makes it easy to interact with Vero's REST API from your Rails 3.x 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. 
+
+For more information about the platform, [click here](http://getvero.com) to visit Vero.
 
 ## Installation
 
@@ -12,7 +14,7 @@ Or install the gem:
 
     gem install 'vero'
 
-Create a [Vero account](http://getvero.com). Create an initializer in your config folder called vero.rb with the following:
+Create a [Vero account](http://getvero.com). Create an initializer in your config/initializers folder called vero.rb with the following:
     
     # config/initializers/vero.rb
     Vero::App.init do |config|
@@ -22,6 +24,10 @@ Create a [Vero account](http://getvero.com). Create an initializer in your confi
 
 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.
 
+By default, events are sent asynchronously using DelayedJob. To force all events to be sent synchronously, add the following line to your initializer:
+
+    config.async = 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:
@@ -50,21 +56,21 @@ Each symbol passed to trackable should reference either an instance method or an
       end
     end
 
-__NOTE: 'email' is a required field__. 
-
-If the user's email address is stored in a different field, you can do the following:
+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:
     
     # app/models/user.rb
     class User < ActiveRecord::Base
       include Vero::Trackable 
       trackable :email
 
-      def email; self.email_address; end
+      def email; self.primary_contact; end
     end
 
 ## Sending events
 
-To send an event, call the #track instance method on a model that is trackable. If you're using Devise you can do the following:
+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
@@ -88,7 +94,7 @@ To send an event, call the #track instance method on a model that is trackable.
       end
     end
 
-You may want to send additional data about the event:
+You may want to send additional data about an event:
     
     # app/controllers/contests_controller.rb
     class ContestsController < ActionController::Base

data/info

@@ -0,0 +1,10 @@
+# Logfile created on 2012-06-09 15:46:52 -0700 by logger.rb/31641
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>-4237502754608315000, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>-2674137733832633223, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)
+Vero: Error attempting to track event: {:auth_token=>"YWJjZDEyMzQ6ZWZnaDU2Nzg=", :development_mode=>true, :event_name=>"test_event", :identity=>{:email=>"durkster@gmail.com", :age=>20}, :data=>{:test=>1}, :cta=>"test"} error: Connection refused - connect(2)

data/lib/vero/app.rb

@@ -6,13 +6,21 @@ module Vero
       @@config = Config.new
 
       if block_given?
-        block.call self.config
+        block.call(self.config)
         @@config.configured = true
       end
     end
 
+    def self.reset!
+      @@config = nil
+    end
+
     def self.config
       @@config
     end
+
+    def self.configured?
+      self.config && self.config.configured
+    end
   end
 end

data/lib/vero/config.rb

@@ -4,17 +4,17 @@ module Vero
     attr_accessor :api_key, :secret, :development_mode, :async, :configured
 
     def initialize
-      self.configured = false
-      self.development_mode = Rails.env.development?
-      self.async = true
+      self.configured       = false
+      self.development_mode = !Rails.env.production?
+      self.async            = true
     end
 
     def request_params
       temp = {}
 
       temp_auth_token = self.auth_token
-      temp[:auth_token] = temp_auth_token unless temp_auth_token.nil?
-      temp[:development_mode] = self.development? unless self.development_mode.nil?
+      temp[:auth_token]       = temp_auth_token       unless temp_auth_token.nil?
+      temp[:development_mode] = self.development_mode unless self.development_mode.nil?
 
       temp
     end
@@ -25,16 +25,7 @@ module Vero
 
     def auth_token
       return if api_key.blank? || secret.blank?
-
       Base64::encode64("#{api_key}:#{secret}").gsub(/[\n ]/, '')
     end
-
-    def development?
-      self.development_mode || !Rails.env.production?
-    end
-
-    def configured?
-      self.configured
-    end
   end
 end

data/lib/vero/trackable.rb

@@ -4,28 +4,40 @@ require 'vero/jobs/rest_post_job'
 module Vero
   module Trackable
     def self.included(base)
-      @@vero_trackable_map = []
+      @vero_trackable_map = []
       base.extend(ClassMethods)
     end
 
     module ClassMethods
       def trackable(*args)
-        @@vero_trackable_map = args
+        if @vero_trackable_map.kind_of?(Array)
+          @vero_trackable_map = (@vero_trackable_map << args).flatten
+        else
+          @vero_trackable_map = args
+        end
       end
 
       def trackable_map
-        @@vero_trackable_map
+        @vero_trackable_map
+      end
+
+      def trackable_map_reset!
+        @vero_trackable_map = nil
       end
     end
 
     def to_vero
-      self.class.trackable_map.inject({}) do |hash, symbol|
+      result = self.class.trackable_map.inject({}) do |hash, symbol|
         hash[symbol] = self.send(symbol)
         hash
       end
+
+      result[:email] = result.delete(:email_address) if result.has_key?(:email_address)
+      result
     end
 
     def track(event_name, event_data = {}, cta = '')
+      validate_configured!
       validate_track_params!(event_name, event_data, cta)
 
       config = Vero::App.config
@@ -38,16 +50,35 @@ module Vero
 
     private
     def post_now(url, params)
-      job = Vero::Jobs::RestPostJob.new(url, params)
-      job.perform
+      begin
+        job = Vero::Jobs::RestPostJob.new(url, params)
+        job.perform
+      rescue => e
+        Rails.logger.info "Vero: Error attempting to track event: #{params.to_s} error: #{e.message}"
+      end
     end
 
     def post_later(url, params)
       job = Vero::Jobs::RestPostJob.new(url, params)
-      ::Delayed::Job.enqueue job
+
+      begin
+        ::Delayed::Job.enqueue job
+      rescue ActiveRecord::StatementInvalid => e
+        if e.message == "Could not find table 'delayed_jobs'"
+          raise "To send ratings asynchronously, you must configure delayed_job. Run `rails generate delayed_job:active_record` then `rake db:migrate`."
+        else
+          raise e
+        end
+      end
       'success'
     end
 
+    def validate_configured!
+      unless Vero::App.configured?
+        raise "You must configure the 'vero' gem. Visit https://bitbucket.org/semblance/vero/overview for more details."
+      end
+    end
+
     def validate_track_params!(event_name, event_data, cta)
       result = true
 

data/lib/vero/version.rb

@@ -1,3 +1,3 @@
 module Vero
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/vero.rb

@@ -1,8 +1,15 @@
 require 'rails'
 
 module Vero 
-  autoload :Session,    'vero/session'
   autoload :Config,     'vero/config'
   autoload :App,        'vero/app'
   autoload :Trackable,  'vero/trackable'
+end
+
+if defined? ActiveRecord
+  require 'delayed_job_active_record'
+end
+
+if defined? Mongoid
+  require 'delayed_job_mongoid'
 end

data/spec/lib/app_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Vero::App do
-  describe "#init" do
+  describe :init do
     it "should create a Config object" do
       Vero::App.config.should be_nil
       Vero::App.init {}
@@ -10,7 +10,7 @@ describe Vero::App do
 
     it "should ignore configuring the config if no block is provided" do
       Vero::App.init
-      Vero::App.config.configured?.should be_false
+      Vero::App.configured?.should be_false
     end
 
     it "should pass configuration defined in the block to the config file" do
@@ -22,5 +22,17 @@ describe Vero::App do
       end
       Vero::App.config.api_key.should == "abcd1234"
     end
+
+    it "should init should be able to set async" do
+      Vero::App.init do |c|
+        c.async = false
+      end
+      Vero::App.config.async.should be_false
+
+      Vero::App.init do |c|
+        c.async = true
+      end
+      Vero::App.config.async.should be_true
+    end
   end
 end

data/spec/lib/config_spec.rb

@@ -9,7 +9,7 @@ describe Vero::Config do
     @config.async.should be_true
   end
 
-  describe "#auth_token" do
+  describe :auth_token do
     it "should return nil if either api_key or secret are not set" do
       @config.api_key = nil
       @config.secret = "abcd"
@@ -31,7 +31,7 @@ describe Vero::Config do
     end
   end
 
-  describe "#request_params" do
+  describe :request_params do
     it "should return a hash of auth_token and development_mode if they are set" do
       @config.api_key = nil
       @config.secret = nil
@@ -47,7 +47,7 @@ describe Vero::Config do
     end
   end
 
-  describe "#domain" do
+  describe :domain do
     it "should return www.getvero.com when not set" do
       @config.domain.should == 'www.getvero.com'
       @config.domain = 'blah.com'
@@ -60,25 +60,21 @@ describe Vero::Config do
     end
   end
 
-  describe "#development?" do
-    it "should return the value set in development_mode" do
-      @config.development_mode = true
-      @config.development?.should be_true
-    end
-
-    it "should return true when development_mode is false but Rails.env is either development or test" do
-      @config.development_mode = false
-
+  describe :development_mode do
+    it "by default it should return true when Rails.env is either development or test" do
       stub_env('development') {
-        @config.development?.should be_true
+        config = Vero::Config.new
+        config.development_mode.should be_true
       }
 
       stub_env('test') {
-        @config.development?.should be_true
+        config = Vero::Config.new
+        config.development_mode.should be_true
       }
 
       stub_env('production') {
-        @config.development?.should be_false
+        config = Vero::Config.new
+        config.development_mode.should be_false
       }
     end
   end

data/spec/lib/trackable_spec.rb

@@ -1,17 +1,9 @@
 require 'spec_helper'
 
 describe Vero::Trackable do
-  before :each do
-    Vero::App.init do |c|
-      c.api_key = 'abcd1234'
-      c.secret = 'efgh5678'
-      c.async = false
-    end
-    @user = User.new
-  end
-
-  describe "#track" do
+  context "the gem has not been configured" do
     before :each do
+      Vero::App.reset!
       @request_params = {
         event_name: 'test_event',
         auth_token: 'YWJjZDEyMzQ6ZWZnaDU2Nzg=',
@@ -21,31 +13,105 @@ describe Vero::Trackable do
         development_mode: true
       }
       @url = "http://www.getvero.com/api/v1/track.json"
+      @user = User.new
+    end
+
+    describe :track do
+      it "should raise an error" do
+        @user.stub(:post_later).and_return('success')
+        expect { @user.track(@request_params[:event_name], @request_params[:data], 'test') }.to raise_error
+      end
+    end
+  end
+
+  context "the gem has been configured" do
+    before :each do
+      Vero::App.init do |c|
+        c.api_key = 'abcd1234'
+        c.secret = 'efgh5678'
+        c.async = false
+      end
+      @user = User.new
     end
 
-    it "should send a track request when async is set to false" do
-      @user.stub(:post_now).and_return(200)
-      @user.should_receive(:post_now).with(@url, @request_params).at_least(:once)
-      @user.track(@request_params[:event_name], @request_params[:data], 'test').should == 200
-      @user.track(@request_params[:event_name]).should == 200
+    describe :track do
+      before :each do
+        @request_params = {
+          event_name: 'test_event',
+          auth_token: 'YWJjZDEyMzQ6ZWZnaDU2Nzg=',
+          identity: {email: 'durkster@gmail.com', age: 20},
+          data: { test: 1 },
+          cta: 'test',
+          development_mode: true
+        }
+        @url = "http://www.getvero.com/api/v1/track.json"
+      end
+
+      it "should not send a track request when the required parameters are invalid" do
+        @user.stub(:post_now).and_return(200)
+
+        expect { @user.track(nil) }.to raise_error
+        expect { @user.track('') }.to raise_error
+        expect { @user.track('test', '') }.to raise_error
+        expect { @user.track('test', {}, 8) }.to raise_error
+      end
+
+      it "should send a track request when async is set to false" do
+        @user.stub(:post_now).and_return(200)
+        @user.should_receive(:post_now).with(@url, @request_params).at_least(:once)
+        @user.track(@request_params[:event_name], @request_params[:data], 'test').should == 200
+        @user.track(@request_params[:event_name]).should == 200
+      end
+
+      it "should create a delayed job when async is set to true" do
+        @user.stub(:post_later).and_return('success')
+        @user.should_receive(:post_later).with(@url, @request_params).at_least(:once)
+        
+        Vero::App.config.async = true
+        @user.track(@request_params[:event_name], @request_params[:data], 'test').should == 'success'
+        @user.track(@request_params[:event_name]).should == 'success'
+      end
+
+      it "should not raise an error when async is set to false and the request times out" do
+        Vero::App.config.async = false
+        Vero::App.config.domain = "localhost"
+        Rails.stub(:logger).and_return(Logger.new('info'))
+
+        expect { @user.track(@request_params[:event_name], @request_params[:data], 'test') }.to_not raise_error
+      end
     end
 
-    it "should create a delayed job when async is set to true" do
-      @user.stub(:post_later).and_return('success')
-      @user.should_receive(:post_later).with(@url, @request_params).at_least(:once)
-      
-      Vero::App.config.async = true
-      @user.track(@request_params[:event_name], @request_params[:data], 'test').should == 'success'
-      @user.track(@request_params[:event_name]).should == 'success'
+    describe :trackable do
+      after :each do
+        User.trackable_map_reset!
+        User.trackable :email, :age
+      end
+
+      it "should build an array of trackable params" do
+        User.trackable_map_reset!
+        User.trackable :email, :age
+        User.trackable_map.should == [:email, :age]
+      end
+
+      it "should append new trackable items to an existing trackable map" do
+        User.trackable_map_reset!
+        User.trackable :email, :age
+        User.trackable :hair_colour
+        User.trackable_map.should == [:email, :age, :hair_colour]
+      end
     end
 
-    it "should not send a track request when the required parameters are invalid" do
-      @user.stub(:post_now).and_return(200)
+    describe :to_vero do
+      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 = UserWithoutEmail.new
+        user.to_vero.should == {email: 'durkster@gmail.com', age: 20}
 
-      expect { @user.track(nil) }.to raise_error
-      expect { @user.track('') }.to raise_error
-      expect { @user.track('test', '') }.to raise_error
-      expect { @user.track('test', {}, 8) }.to raise_error
+        user = UserWithEmailAddress.new
+        user.to_vero.should == {email: 'durkster@gmail.com', age: 20}
+      end
     end
   end
 end

data/spec/support/user_support.rb

@@ -8,6 +8,34 @@ class User
     'durkster@gmail.com'
   end
 
+  def age
+    20
+  end
+end
+
+class UserWithoutEmail
+  include Vero::Trackable
+  trackable :email, :age
+
+  def email; self.primary_contact; end
+
+  def primary_contact
+    'durkster@gmail.com'
+  end
+
+  def age
+    20
+  end
+end
+
+class UserWithEmailAddress
+  include Vero::Trackable
+  trackable :email_address, :age
+
+  def email_address
+    'durkster@gmail.com'
+  end
+
   def age
     20
   end

data/vero.gemspec

@@ -6,7 +6,7 @@ require "vero/version"
 Gem::Specification.new do |s|
   s.name     = "vero"
   s.version  = Vero::VERSION.dup
-  s.date     = "2012-06-03"
+  s.date     = "2012-06-09"
   s.summary  = "Rails 3.x gem for Vero"
   s.email    = "support@getvero.com"
   s.homepage = "http://getvero.com/"
@@ -14,7 +14,9 @@ Gem::Specification.new do |s|
   
   dependencies = [
     [:runtime, 'rest-client'],
-    [:runtime, 'delayed_job']
+    [:runtime, 'delayed_job'],
+    [:runtime, 'delayed_job_active_record'],
+    [:runtime, 'delayed_job_mongoid']
   ]
   
   s.files         = Dir['**/*']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vero
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000 Z
+date: 2012-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: support@getvero.com
 executables: []
@@ -51,6 +83,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- info
 - lib/vero/app.rb
 - lib/vero/config.rb
 - lib/vero/jobs/rest_post_job.rb