vero 0.6.0 → 0.7.0

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.7.0
+
+- **girl_friday has been replaced by sucker_punch**. The most significant
+effect of this change is that Ruby 1.8.7 will no longer be supported.
+
 ## 0.6.0
 
 - **All APIs using the `trackable` interface will now pass up an `:id`** (if

data/Gemfile.lock

@@ -2,9 +2,9 @@ PATH
   remote: .
   specs:
     vero (0.6.0)
-      girl_friday (>= 0.11.2)
       json
       rest-client
+      sucker_punch (~> 1.0)
 
 GEM
   remote: http://rubygems.org/
@@ -38,7 +38,8 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.4)
-    connection_pool (1.1.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
     delayed_job (3.0.5)
       activesupport (~> 3.0)
     delayed_job_active_record (0.4.4)
@@ -46,9 +47,6 @@ GEM
       delayed_job (~> 3.0)
     diff-lcs (1.2.4)
     erubis (2.7.0)
-    girl_friday (0.11.2)
-      connection_pool (~> 1.0)
-      rubinius-actor
     hike (1.2.2)
     i18n (0.6.1)
     journey (1.0.4)
@@ -61,6 +59,7 @@ GEM
     mime-types (1.23)
     mono_logger (1.0.1)
     multi_json (1.7.2)
+    netrc (0.7.7)
     polyglot (0.3.3)
     rack (1.4.5)
     rack-cache (1.2)
@@ -98,8 +97,9 @@ GEM
       redis-namespace (~> 1.2)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -108,9 +108,6 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
-    rubinius-actor (0.0.2)
-      rubinius-core-api
-    rubinius-core-api (0.0.1)
     sinatra (1.3.6)
       rack (~> 1.4)
       rack-protection (~> 1.3)
@@ -120,8 +117,11 @@ GEM
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
+    sucker_punch (1.1)
+      celluloid (~> 0.15.2)
     thor (0.18.1)
     tilt (1.3.7)
+    timers (1.1.0)
     treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)

data/README.markdown

@@ -39,19 +39,20 @@ We recommend that you select one of the supported queue-based alternatives:
     config.async = :delayed_job     # DelayedJob
     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:** If you're using Mongoid with DelayedJob, you must add
 `gem "delayed_job_mongoid"` to your Gemfile.
 
-Finally, vero will automatically choose whether to send requests to your
+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
 
+Finally, if you wish to disable vero requests when running your automated tests,
+add the following line to your initializer:
+
+    config.disabled = Rails.env.test?
+
 ## Setup tracking
 
 You will need to define who should be tracked and what information about them
@@ -217,7 +218,7 @@ outlined in Installation. Now you can call the API using the following methods:
 
 This gem is distributed under the MIT License.
 
-Copyright (C) 2013 Vero (Invc Me Inc.)
+Copyright (C) 2014 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

data/lib/vero/senders/thread.rb

@@ -1,26 +1,28 @@
 require 'json'
-require 'girl_friday'
+require 'sucker_punch'
 
 module Vero
-  module Senders
-    class Thread
-      VERO_SENDER_QUEUE = ::GirlFriday::WorkQueue.new(:vero_queue, :size => 1) do |msg|
-        api_class = msg[:api_class]
-        domain    = msg[:domain]
-        options   = msg[:options]
+  class SuckerPunchWorker
+    include SuckerPunch::Job
 
-        options_s = JSON.dump(options)
-        begin
-          api_class.perform(domain, options)
-          Vero::App.log(self, "method: #{api_class.name}, options: #{options_s}, response: job performed")
-        rescue => e
-          Vero::App.log(self, "method: #{api_class.name}, options: #{options_s}, response: #{e.message}")
-        end
+    def perform(api_class, domain, options)
+      new_options = {}
+      options.each { |k,v| new_options[k.to_sym] = v }
+
+      begin
+        api_class.new(domain, new_options).perform
+        Vero::App.log(self, "method: #{api_class.name}, options: #{options.to_json}, response: job performed")
+      rescue => e
+        Vero::App.log(self, "method: #{api_class.name}, options: #{options.to_json}, response: #{e.message}")
       end
+    end
+  end
 
+  module Senders
+    class Thread
       def call(api_class, domain, options)
-        !!VERO_SENDER_QUEUE.push(:api_class => api_class, :domain => domain, :options => options)
+        Vero::SuckerPunchWorker.new.async.perform(api_class, domain, options)
       end
     end
   end
-end
+end

data/lib/vero/version.rb

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

data/spec/lib/sender_spec.rb

@@ -8,21 +8,6 @@ describe Vero::Sender do
       subject.senders.should be_a(Hash)
     end
 
-    context 'when using Ruby 1.8' do
-      before do
-        stub_const('RUBY_VERSION', '1.8.7')
-      end
-
-      it "should have a default set of senders (true, false, none, thread)" do
-        subject.senders.should == {
-          true          => Vero::Senders::Invalid,
-          false         => Vero::Senders::Base,
-          :none         => Vero::Senders::Base,
-          :thread       => Vero::Senders::Invalid,
-        }
-      end
-    end
-
     context 'when using Ruby with verion greater than 1.8.7' do
       before do
         stub_const('RUBY_VERSION', '1.9.3')

data/spec/lib/trackable_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
 
-def vero_context(user, logging = true, async = false)
+def vero_context(user, logging = true, async = false, disabled = true)
   context = Vero::Context.new(Vero::App.default_context)
   context.subject = user
   context.config.logging = logging
   context.config.async = async
+  context.config.disabled = disabled
 
   context
 end
@@ -76,23 +77,17 @@ describe Vero::Trackable do
       end
 
       context 'when set to be async' do
-        before { @user.stub(:with_vero_context).and_return vero_context(@user, true, true) }
-
-        context 'using Ruby 1.8.7' do
-          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
-            expect { @user.track!(@request_params[:event_name]) }.to raise_error
-          end
+        before do
+          @context = vero_context(@user, true, true)
+          @user.stub(:with_vero_context).and_return(@context)
         end
 
         context 'not using Ruby 1.8.7' do
           before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
-            @user.track!(@request_params[:event_name], @request_params[:data]).should be_true
-            @user.track!(@request_params[:event_name]).should be_true
+            @user.track!(@request_params[:event_name], @request_params[:data]).should be_nil
+            @user.track!(@request_params[:event_name]).should be_nil
           end
         end
       end
@@ -120,23 +115,15 @@ describe Vero::Trackable do
 
       context 'when set to use async' do
         before do
-          context = vero_context(@user, false, true)
-          @user.stub(:with_vero_context).and_return(context)
-        end
-
-        context 'and using Ruby 1.8.7' do
-          before { stub_const('RUBY_VERSION', '1.8.7') }
-
-          it 'raises an error' do
-            expect { @user.identify! }.to raise_error
-          end
+          @context = vero_context(@user, false, true)
+          @user.stub(:with_vero_context).and_return(@context)
         end
 
         context 'and not using Ruby 1.8.7' do
           before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
-            @user.identify!.should be_true
+            @user.identify!.should be_nil
           end
         end
       end
@@ -165,19 +152,16 @@ 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
-
-          @user.stub(:with_vero_context).and_return(my_context)
+          @context = vero_context(@user, false, true)
+          @user.stub(:with_vero_context).and_return(@context)
         end
 
         context 'and using Ruby 1.8.7' do
           before { stub_const('RUBY_VERSION', '1.8.7') }
 
           it 'raises an error' do
+            @context.config.disabled = false
             expect { @user.with_vero_context.update_user! }.to raise_error
           end
         end
@@ -186,7 +170,7 @@ describe Vero::Trackable do
           before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
-            @user.with_vero_context.update_user!.should be_true
+            @user.with_vero_context.update_user!.should be_nil
           end
         end
       end
@@ -224,7 +208,7 @@ describe Vero::Trackable do
 
           @user.stub(:with_vero_context).and_return(context)
 
-          @user.with_vero_context.update_user_tags!.should be_true
+          @user.with_vero_context.update_user_tags!.should be_nil
         end
       end
     end
@@ -252,28 +236,16 @@ describe Vero::Trackable do
       end
 
       context 'when using async' do
-        let(:my_context) { Vero::Context.new(Vero::App.default_context) }
-
         before do
-          my_context.subject = @user
-          my_context.config.async = true
-
-          @user.stub(:with_vero_context).and_return(my_context)
-        end
-
-        context 'and using Ruby 1.8.7' do
-          before { stub_const('RUBY_VERSION', '1.8.7') }
-
-          it 'raises an error' do
-            expect { @user.with_vero_context.unsubscribe! }.to raise_error
-          end
+          @context = vero_context(@user, false, true)
+          @user.stub(:with_vero_context).and_return(@context)
         end
 
         context 'and using Ruby 1.9.3' do
           before { stub_const('RUBY_VERSION', '1.9.3') }
 
           it 'sends' do
-            @user.with_vero_context.unsubscribe!.should be_true
+            @user.with_vero_context.unsubscribe!.should be_nil
           end
         end
       end
@@ -342,6 +314,12 @@ describe Vero::Trackable do
         user = UserWithPrivateExtras.new
         user.to_vero.should == {:email => 'durkster@gmail.com', :age => 26, :_user_type => "UserWithPrivateExtras"}
       end
+
+      it "should allow extras to be provided instead :id or :email" do
+        user = UserWithOnlyExtras.new
+        user.properties = {:email => user.email}
+        user.to_vero.should == {:email => 'durkster@gmail.com', :_user_type => "UserWithOnlyExtras"}
+      end
     end
 
     describe :with_vero_context do

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 require 'vero'
 require 'json'
+require 'sucker_punch/testing/inline'
 
 Dir[::File.expand_path('../support/**/*.rb',  __FILE__)].each { |f| require f }
 
@@ -14,4 +15,4 @@ def stub_env(new_env, &block)
   block.call
 ensure
   Rails.instance_variable_set("@_env", ActiveSupport::StringInquirer.new(original_env))
-end
+end

data/spec/support/user_support.rb

@@ -91,4 +91,15 @@ class UserWithPrivateExtras
   def properties
     {:age => 26}
   end
+end
+
+class UserWithOnlyExtras
+  include Vero::Trackable
+  trackable({:extras => :properties})
+
+  attr_accessor :properties
+
+  def email
+    'durkster@gmail.com'
+  end
 end

data/vero.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
     [:development, 'resque'],
     [:runtime,     'json'],
     [:runtime,     'rest-client'],
-    [:runtime,     'girl_friday', ">= 0.11.2"]
+    [:runtime,     'sucker_punch', '~> 1.0']
   ]
 
   s.files         = Dir['**/*']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vero
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -124,21 +124,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: girl_friday
+  name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '1.0'
 description: 
 email: support@getvero.com
 executables: []