vero 0.0.4

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gemspec
+gem 'rails'
+gem 'debugger', :require => 'debugger'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    vero (0.0.4)
+      delayed_job
+      rest-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.5)
+      actionpack (= 3.2.5)
+      mail (~> 2.4.4)
+    actionpack (3.2.5)
+      activemodel (= 3.2.5)
+      activesupport (= 3.2.5)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.5)
+      activesupport (= 3.2.5)
+      builder (~> 3.0.0)
+    activerecord (3.2.5)
+      activemodel (= 3.2.5)
+      activesupport (= 3.2.5)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.5)
+      activemodel (= 3.2.5)
+      activesupport (= 3.2.5)
+    activesupport (3.2.5)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    columnize (0.3.6)
+    debugger (1.1.3)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.2)
+    debugger-linecache (1.1.1)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
+    delayed_job (3.0.3)
+      activesupport (~> 3.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.5)
+      actionmailer (= 3.2.5)
+      actionpack (= 3.2.5)
+      activerecord (= 3.2.5)
+      activeresource (= 3.2.5)
+      activesupport (= 3.2.5)
+      bundler (~> 1.0)
+      railties (= 3.2.5)
+    railties (3.2.5)
+      actionpack (= 3.2.5)
+      activesupport (= 3.2.5)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.2)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  rails
+  rspec
+  vero!

data/README.markdown

@@ -0,0 +1,113 @@
+# 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).
+
+## Installation
+
+Include in your Gemfile:
+
+    gem 'vero'
+
+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:
+    
+    # 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.
+
+## 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:
+    
+    # app/models/user.rb
+    class User < ActiveRecord::Base
+      include Vero::Trackable 
+      trackable :email, :name, :age
+
+      ...
+    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. 
+
+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
+
+      has_many :contests
+
+      def contest_count
+        self.contests.count
+      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:
+    
+    # app/models/user.rb
+    class User < ActiveRecord::Base
+      include Vero::Trackable 
+      trackable :email
+
+      def email; self.email_address; 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:
+    
+    # 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')
+          
+          flash[:notice] = "New contest saved successfully!"
+          redirect_to contests_path
+        else
+          flash[:alert] = "Unable to create your contest. Please review your details and try again."
+          render 'new'
+        end
+      end
+    end
+
+You may want to send additional data about the 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})
+          
+          flash[:notice] = "New contest saved successfully!"
+          redirect_to contests_path
+        else
+          flash[:alert] = "Unable to create your contest. Please review your details and try again."
+          render 'new'
+        end
+      end
+    end

data/lib/vero/app.rb

@@ -0,0 +1,18 @@
+module Vero
+  class App
+    @@config = nil
+
+    def self.init(&block)
+      @@config = Config.new
+
+      if block_given?
+        block.call self.config
+        @@config.configured = true
+      end
+    end
+
+    def self.config
+      @@config
+    end
+  end
+end

data/lib/vero/config.rb

@@ -0,0 +1,40 @@
+module Vero
+  class Config
+    attr_writer :domain
+    attr_accessor :api_key, :secret, :development_mode, :async, :configured
+
+    def initialize
+      self.configured = false
+      self.development_mode = Rails.env.development?
+      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
+    end
+
+    def domain
+      @domain || 'www.getvero.com'
+    end
+
+    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/jobs/rest_post_job.rb

@@ -0,0 +1,11 @@
+require 'rest-client'
+
+module Vero
+  module Jobs
+    class RestPostJob < Struct.new(:url, :params)
+      def perform
+        RestClient.post(url, params)
+      end
+    end
+  end
+end

data/lib/vero/trackable.rb

@@ -0,0 +1,61 @@
+require 'delayed_job'
+require 'vero/jobs/rest_post_job'
+
+module Vero
+  module Trackable
+    def self.included(base)
+      @@vero_trackable_map = []
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def trackable(*args)
+        @@vero_trackable_map = args
+      end
+
+      def trackable_map
+        @@vero_trackable_map
+      end
+    end
+
+    def to_vero
+      self.class.trackable_map.inject({}) do |hash, symbol|
+        hash[symbol] = self.send(symbol)
+        hash
+      end
+    end
+
+    def track(event_name, event_data = {}, cta = '')
+      validate_track_params!(event_name, event_data, cta)
+
+      config = Vero::App.config
+      request_params = config.request_params
+      request_params.merge!(event_name: event_name, identity: self.to_vero, data: event_data, cta: cta)
+      
+      method = !config.async ? :post_now : :post_later
+      self.send(method, "http://#{config.domain}/api/v1/track.json", request_params)
+    end
+
+    private
+    def post_now(url, params)
+      job = Vero::Jobs::RestPostJob.new(url, params)
+      job.perform
+    end
+
+    def post_later(url, params)
+      job = Vero::Jobs::RestPostJob.new(url, params)
+      ::Delayed::Job.enqueue job
+      'success'
+    end
+
+    def validate_track_params!(event_name, event_data, cta)
+      result = true
+
+      result &&= event_name.kind_of?(String) && !event_name.blank?
+      result &&= event_data.nil? || event_data.kind_of?(Hash)
+      result &&= cta.nil? || cta.kind_of?(String)
+
+      raise ArgumentError.new({event_name: event_name, event_data: event_data, cta: cta}) unless result
+    end
+  end
+end

data/lib/vero/version.rb

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

data/lib/vero.rb

@@ -0,0 +1,8 @@
+require 'rails'
+
+module Vero 
+  autoload :Session,    'vero/session'
+  autoload :Config,     'vero/config'
+  autoload :App,        'vero/app'
+  autoload :Trackable,  'vero/trackable'
+end

data/spec/lib/app_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Vero::App do
+  describe "#init" do
+    it "should create a Config object" do
+      Vero::App.config.should be_nil
+      Vero::App.init {}
+      Vero::App.config.should_not be_nil
+    end
+
+    it "should ignore configuring the config if no block is provided" do
+      Vero::App.init
+      Vero::App.config.configured?.should be_false
+    end
+
+    it "should pass configuration defined in the block to the config file" do
+      Vero::App.init
+
+      Vero::App.config.api_key.should be_nil
+      Vero::App.init do |c|
+        c.api_key = "abcd1234"
+      end
+      Vero::App.config.api_key.should == "abcd1234"
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Vero::Config do
+  before :each do
+    @config = Vero::Config.new
+  end
+
+  it "should be async by default" do
+    @config.async.should be_true
+  end
+
+  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"
+      @config.auth_token.should be_nil
+
+      @config.api_key = "abcd"
+      @config.secret = nil
+      @config.auth_token.should be_nil
+
+      @config.api_key = "abcd"
+      @config.secret = "abcd"
+      @config.auth_token.should_not be_nil
+    end
+
+    it "should return an expected auth_token" do
+      @config.api_key = "abcd1234"
+      @config.secret = "efgh5678"
+      @config.auth_token.should == "YWJjZDEyMzQ6ZWZnaDU2Nzg="
+    end
+  end
+
+  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
+      @config.development_mode = nil
+      @config.request_params.should == {}
+
+      @config.api_key = "abcd1234"
+      @config.secret = "abcd1234"
+      @config.request_params.should == {auth_token: "YWJjZDEyMzQ6YWJjZDEyMzQ="}
+
+      @config.development_mode = true
+      @config.request_params.should == {auth_token: "YWJjZDEyMzQ6YWJjZDEyMzQ=", development_mode: true}
+    end
+  end
+
+  describe "#domain" do
+    it "should return www.getvero.com when not set" do
+      @config.domain.should == 'www.getvero.com'
+      @config.domain = 'blah.com'
+      @config.domain.should_not == 'www.getvero.com'
+    end
+
+    it "should return the domain value" do
+      @config.domain = 'test.unbelieveable.com.au'
+      @config.domain.should == 'test.unbelieveable.com.au'
+    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
+
+      stub_env('development') {
+        @config.development?.should be_true
+      }
+
+      stub_env('test') {
+        @config.development?.should be_true
+      }
+
+      stub_env('production') {
+        @config.development?.should be_false
+      }
+    end
+  end
+end

data/spec/lib/trackable_spec.rb

@@ -0,0 +1,51 @@
+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
+    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 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 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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'vero'
+require 'debugger'
+
+Dir[::File.expand_path('../support/**/*.rb',  __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end
+
+def stub_env(new_env, &block)
+  original_env = Rails.env
+  Rails.instance_variable_set("@_env", ActiveSupport::StringInquirer.new(new_env))
+  block.call
+ensure
+  Rails.instance_variable_set("@_env", ActiveSupport::StringInquirer.new(original_env))
+end

data/spec/support/user_support.rb

@@ -0,0 +1,14 @@
+require 'vero'
+
+class User
+  include Vero::Trackable
+  trackable :email, :age
+
+  def email
+    'durkster@gmail.com'
+  end
+
+  def age
+    20
+  end
+end

data/vero.gemspec

@@ -0,0 +1,38 @@
+
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "vero/version"
+
+Gem::Specification.new do |s|
+  s.name     = "vero"
+  s.version  = Vero::VERSION.dup
+  s.date     = "2012-06-03"
+  s.summary  = "Rails 3.x gem for Vero"
+  s.email    = "support@getvero.com"
+  s.homepage = "http://getvero.com/"
+  s.authors  = ['James Lamont']
+  
+  dependencies = [
+    [:runtime, 'rest-client'],
+    [:runtime, 'delayed_job']
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "1.8.23"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: vero
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- James Lamont
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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
+  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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- lib/vero/app.rb
+- lib/vero/config.rb
+- lib/vero/jobs/rest_post_job.rb
+- lib/vero/trackable.rb
+- lib/vero/version.rb
+- lib/vero.rb
+- README.markdown
+- spec/lib/app_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/trackable_spec.rb
+- spec/spec_helper.rb
+- spec/support/user_support.rb
+- vero.gemspec
+homepage: http://getvero.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rails 3.x gem for Vero
+test_files:
+- spec/lib/app_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/trackable_spec.rb
+- spec/spec_helper.rb
+- spec/support/user_support.rb