vero 0.5.2 → 0.5.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vero (0.5.1)
+    vero (0.5.2)
       girl_friday
       json
       rest-client
@@ -9,119 +9,122 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
-      rack (~> 1.4.0)
+      rack (~> 1.4.5)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     arel (3.0.2)
-    builder (3.0.3)
-    connection_pool (0.9.3)
-    delayed_job (3.0.4)
+    builder (3.0.4)
+    connection_pool (1.0.0)
+    delayed_job (3.0.5)
       activesupport (~> 3.0)
-    delayed_job_active_record (0.3.3)
+    delayed_job_active_record (0.4.3)
       activerecord (>= 2.1.0, < 4)
       delayed_job (~> 3.0)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.1)
     erubis (2.7.0)
-    girl_friday (0.11.1)
-      connection_pool (~> 0.9.0)
+    girl_friday (0.11.2)
+      connection_pool (~> 1.0)
       rubinius-actor
     hike (1.2.1)
     i18n (0.6.1)
     journey (1.0.4)
-    json (1.7.6)
-    mail (2.4.4)
+    json (1.7.7)
+    mail (2.5.3)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
+    mime-types (1.21)
+    mono_logger (1.0.0)
+    multi_json (1.7.2)
     polyglot (0.3.3)
-    rack (1.4.3)
+    rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
-    rack-protection (1.3.2)
+    rack-protection (1.5.0)
       rack
-    rack-ssl (1.3.2)
+    rack-ssl (1.3.3)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
       bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
     rake (10.0.3)
-    rdoc (3.12)
+    rdoc (3.12.2)
       json (~> 1.4)
-    redis (3.0.2)
+    redis (3.0.3)
     redis-namespace (1.2.1)
       redis (~> 3.0.0)
-    resque (1.23.0)
+    resque (1.24.0)
+      mono_logger (~> 1.0)
       multi_json (~> 1.0)
-      redis-namespace (~> 1.0)
+      redis-namespace (~> 1.2)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     rubinius-actor (0.0.2)
       rubinius-core-api
     rubinius-core-api (0.0.1)
-    sinatra (1.3.4)
+    sinatra (1.3.6)
       rack (~> 1.4)
       rack-protection (~> 1.3)
       tilt (~> 1.3, >= 1.3.3)
-    sprockets (2.1.3)
+    sprockets (2.2.2)
       hike (~> 1.2)
+      multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.16.0)
-    tilt (1.3.3)
+    thor (0.17.0)
+    tilt (1.3.6)
     treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    tzinfo (0.3.37)
     vegas (0.1.11)
       rack (>= 1.0.0)
 
@@ -131,7 +134,7 @@ PLATFORMS
 DEPENDENCIES
   delayed_job
   delayed_job_active_record
-  rails
+  rails (> 3)
   resque
   rspec
   vero!

data/README.markdown

@@ -148,23 +148,38 @@ You may want to send additional data about an event:
       end
     end
 
-## Calling the API directly
+## Simple DSL
 
-To avoid having to extend the `User` model, we offer the option to call our API directly, 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:
 
-    # Tracking an event
-    Vero::Api::Events.track!({:event_name => "test_event", :data => {:date => "2013-02-12 16:17"}, :identity => {:email => "james@getvero.com"}})
-    
-    # Identifying a user
-    Vero::Api::Users.track!({:email => "james@getvero.com"})
-    
-    # Editing a user
-    Vero::Api::Users.edit_user!({:email => "james@getvero.com", :changes => {:age => 25}})
-    
-    # Editing a user tags
-    Vero::Api::Users.edit_user_tags!({:email => "james@getvero.com", :add => [], :remove => ["awesome"]})
-    
-    # Unsubscribe a user
-    Vero::Api::Users.unsubscribe!({:email => "james@getvero.com"})
+    class UsersController < ApplicationController
+      include Vero::DSL
+
+      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"}
+        })
+      end
+
+      def create
+        # Identifying a user
+        vero.users.track!({:email => "james@getvero.com", :data => {}})
+      end
+
+      def update
+        # Editing a user
+        vero.users.edit_user!({:email => "james@getvero.com", :changes => {:age => 25}})
+
+        # Editing a user's tags
+        vero.users.edit_user_tags!({:email => "james@getvero.com", :add => [], :remove => ["awesome"]})
+      end
+
+      def destroy
+        vero.users.unsubscribe!({:email => "james@getvero.com"})
+      end
+    end

data/lib/vero.rb

@@ -6,6 +6,7 @@ module Vero
   autoload :App,                'vero/app'
   autoload :Context,            'vero/context'
   autoload :Trackable,          'vero/trackable'
+  autoload :DSL,                'vero/dsl'
   
   module Api
     module Workers
@@ -42,4 +43,4 @@ module Vero
   autoload :ResqueWorker,       'vero/senders/resque'
 end
 
-require 'vero/railtie' if defined?(Rails)
+require 'vero/railtie' if defined?(Rails)

data/lib/vero/api/events/track_api.rb

@@ -6,23 +6,17 @@ module Vero
           def url
             "#{@domain}/api/v2/events/track.json"
           end
-          
+
           def request
             RestClient.post(self.url, self.request_params_as_json, self.request_content_type)
           end
 
           def validate!
-            result = true
-            result &&= options[:event_name].to_s.blank? == false
-            result &&= (options[:data].nil? || options[:data].is_a?(Hash))
-
-            unless result
-              hash = {:data => options[:data], :event_name => options[:event_name]}
-              raise ArgumentError.new(JSON.dump(hash))
-            end
+            raise ArgumentError.new("Missing :event_name") if options[:event_name].to_s.blank?
+            raise ArgumentError.new(":data must be either nil or a Hash") unless (options[:data].nil? || options[:data].is_a?(Hash))
           end
         end
       end
     end
   end
-end
+end

data/lib/vero/api/users/edit_api.rb

@@ -12,16 +12,11 @@ module Vero
           end
 
           def validate!
-            result = true
-            result &&= options[:email].to_s.blank? == false
-            result &&= options[:changes].is_a?(Hash)
-
-            unless result
-              raise ArgumentError.new(:email => options[:email], :changes => options[:changes])
-            end
+            raise ArgumentError.new("Missing :email") if options[:email].to_s.blank?
+            raise ArgumentError.new(":changes must be a Hash") unless options[:changes].is_a?(Hash)
           end
         end
       end
     end
   end
-end
+end

data/lib/vero/api/users/edit_tags_api.rb

@@ -12,16 +12,13 @@ module Vero
           end
 
           def validate!
-            result = true
-            result &&= options[:email].to_s.blank? == false
-            result &&= (options[:add].is_a?(Array) || options[:remove].is_a?(Array))
-
-            unless result
-              raise ArgumentError.new(:email => options[:email], :add => options[:add], :remove => options[:remove])
-            end
+            raise ArgumentError.new("Missing :email") if options[:email].to_s.blank?
+            raise ArgumentError.new(":add must an Array if present") unless options[:add].nil? || options[:add].is_a?(Array)
+            raise ArgumentError.new(":remove must an Array if present") unless options[:remove].nil? || options[:remove].is_a?(Array)
+            raise ArgumentError.new("Either :add or :remove must be present") if (options[:remove].nil? && options[:add].nil?)
           end
         end
       end
     end
   end
-end
+end

data/lib/vero/api/users/track_api.rb

@@ -12,16 +12,11 @@ module Vero
           end
 
           def validate!
-            result = true
-            result &&= options[:email].to_s.blank? == false
-            result &&= (options[:data].nil? || options[:data].is_a?(Hash))
-
-            unless result
-              raise ArgumentError.new(:email => options[:email], :data => options[:data])
-            end
+            raise ArgumentError.new("Missing :email") if options[:email].to_s.blank?
+            raise ArgumentError.new(":data must be either nil or a Hash") unless (options[:data].nil? || options[:data].is_a?(Hash))
           end
         end
       end
     end
   end
-end
+end

data/lib/vero/api/users/unsubscribe_api.rb

@@ -12,15 +12,10 @@ module Vero
           end
 
           def validate!
-            result = true
-            result &&= options[:email].to_s.blank? == false
-
-            unless result
-              raise ArgumentError.new(:email => options[:email])
-            end
+            raise ArgumentError.new("Missing :email") if options[:email].to_s.blank?
           end
         end
       end
     end
   end
-end
+end

data/lib/vero/dsl.rb

@@ -0,0 +1,34 @@
+module Vero
+  ##
+  # A lightweight DSL for using the Vero API. You may find this desirable in
+  # your Rails controllers having decided not to mix the Vero gem directly into
+  # your models.
+  #
+  # Example usage:
+  #
+  #   class UsersController < ApplicationController
+  #     include Vero::DSL
+  #
+  #     def update
+  #       vero.users.track!({ ... })
+  #     end
+  #   end
+  module DSL
+    def vero
+      @proxy ||= Proxy.new
+    end
+
+    # :nodoc:
+    class Proxy
+      include Vero::Api
+
+      def users
+        Users
+      end
+
+      def events
+        Events
+      end
+    end
+  end
+end

data/lib/vero/version.rb

@@ -1,3 +1,3 @@
 module Vero
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

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

@@ -11,7 +11,45 @@ describe Vero::Api::Workers::Users::EditTagsAPI do
   end
 
   subject { Vero::Api::Workers::Users::EditTagsAPI.new('https://www.getvero.com', {:auth_token => 'abcd', :email => 'test@test.com', :add => ["test"]}) }
+
   describe :validate! 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)
+
+      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)
+    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)
+    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)
+    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)
+    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)
+    end
   end
 
   describe :request do
@@ -28,4 +66,4 @@ describe Vero::Api::Workers::Users::EditTagsAPI do
       expect { subject.perform }.to_not raise_error
     end
   end
-end
+end

data/spec/lib/dsl_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Vero::DSL do
+  subject(:dsl) { Class.new.extend(Vero::DSL) }
+
+  describe '#vero' do
+    it 'is a proxy to the API' do
+      expect(dsl.vero).to be_an_instance_of(Vero::DSL::Proxy)
+    end
+  end
+end
+
+describe Vero::DSL::Proxy do
+  subject(:proxy) { described_class.new }
+
+  describe '#users' do
+    it 'is a pointer to Vero::Api::Users' do
+      expect(proxy.users).to eql(Vero::Api::Users)
+    end
+  end
+
+  describe '#events' do
+    it 'is a pointer to Vero::Api::Events' do
+      expect(proxy.events).to eql(Vero::Api::Events)
+    end
+  end
+end

data/spec/lib/trackable_spec.rb

@@ -56,9 +56,9 @@ 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, "{\"data\":{},\"event_name\":null}")
-        expect { @user.track!('') }.to raise_error(ArgumentError, "{\"data\":{},\"event_name\":\"\"}")
-        expect { @user.track!('test', '') }.to raise_error(ArgumentError, "{\"data\":\"\",\"event_name\":\"test\"}")
+        expect { @user.track!(nil) }.to raise_error(ArgumentError)
+        expect { @user.track!('') }.to raise_error(ArgumentError)
+        expect { @user.track!('test', '') }.to raise_error(ArgumentError)
       end
 
       it "should send a `track!` request when async is set to false" do
@@ -359,4 +359,4 @@ describe Vero::Trackable do
       user.vero_track(request_params[:event_name], request_params[:data]).should == 200
     end
   end
-end
+end

data/vero.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.authors  = ['James Lamont']
   
   dependencies = [
-    [:development, 'rails'],
+    [:development, 'rails', "> 3"],
     [:development, 'rspec'],
     [:development, 'delayed_job'],
     [:development, 'delayed_job_active_record'],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vero
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +158,7 @@ files:
 - lib/vero/app.rb
 - lib/vero/config.rb
 - lib/vero/context.rb
+- lib/vero/dsl.rb
 - lib/vero/railtie.rb
 - lib/vero/sender.rb
 - lib/vero/senders/base.rb
@@ -183,6 +184,7 @@ files:
 - spec/lib/app_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/context_spec.rb
+- spec/lib/dsl_spec.rb
 - spec/lib/sender_spec.rb
 - spec/lib/trackable_spec.rb
 - spec/lib/view_helpers_spec.rb
@@ -224,6 +226,7 @@ test_files:
 - spec/lib/app_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/context_spec.rb
+- spec/lib/dsl_spec.rb
 - spec/lib/sender_spec.rb
 - spec/lib/trackable_spec.rb
 - spec/lib/view_helpers_spec.rb