vero 0.8.1 → 0.9.0

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.9.0
+
+- *Added support for Sidekiq**. You can now use Sidekiq to deliver API requests to Vero. To do so, just specify `config.async = :sidekiq` in your config.rb file.
+
 ## 0.8.0
 
 - **"development_mode" flag has been deprecated.** It is recommended to use a multiple projects (with different API credentials). Please contact support@getvero.com for assistance in upgrading your account.

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    vero (0.8.1)
+    vero (0.8.2)
       json
       rest-client
-      sucker_punch (~> 1.5)
+      sucker_punch (= 1.5.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.21)
-      actionpack (= 3.2.21)
+    actionmailer (3.2.22)
+      actionpack (= 3.2.22)
       mail (~> 2.5.4)
-    actionpack (3.2.21)
-      activemodel (= 3.2.21)
-      activesupport (= 3.2.21)
+    actionpack (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -22,26 +22,27 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.21)
-      activesupport (= 3.2.21)
+    activemodel (3.2.22)
+      activesupport (= 3.2.22)
       builder (~> 3.0.0)
-    activerecord (3.2.21)
-      activemodel (= 3.2.21)
-      activesupport (= 3.2.21)
+    activerecord (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.21)
-      activemodel (= 3.2.21)
-      activesupport (= 3.2.21)
-    activesupport (3.2.21)
+    activeresource (3.2.22)
+      activemodel (= 3.2.22)
+      activesupport (= 3.2.22)
+    activesupport (3.2.22)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     arel (3.0.3)
     builder (3.0.4)
     celluloid (0.16.0)
       timers (~> 4.0.0)
-    delayed_job (4.0.6)
-      activesupport (>= 3.0, < 5.0)
+    connection_pool (2.2.0)
+    delayed_job (3.0.5)
+      activesupport (~> 3.0)
     delayed_job_active_record (4.0.3)
       activerecord (>= 3.0, < 5.0)
       delayed_job (>= 3.0, < 4.1)
@@ -51,21 +52,22 @@ GEM
     erubis (2.7.0)
     hike (1.2.3)
     hitimes (1.2.2)
+    hitimes (1.2.2-java)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     i18n (0.7.0)
     journey (1.0.4)
-    json (1.8.2)
-    json (1.8.2-java)
+    json (1.8.3)
+    json (1.8.3-java)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     mono_logger (1.1.0)
-    multi_json (1.11.0)
+    multi_json (1.11.2)
     netrc (0.10.3)
     polyglot (0.3.5)
-    rack (1.4.5)
+    rack (1.4.7)
     rack-cache (1.2)
       rack (>= 0.4)
     rack-protection (1.5.3)
@@ -74,17 +76,17 @@ GEM
       rack
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.21)
-      actionmailer (= 3.2.21)
-      actionpack (= 3.2.21)
-      activerecord (= 3.2.21)
-      activeresource (= 3.2.21)
-      activesupport (= 3.2.21)
+    rails (3.2.22)
+      actionmailer (= 3.2.22)
+      actionpack (= 3.2.22)
+      activerecord (= 3.2.22)
+      activeresource (= 3.2.22)
+      activesupport (= 3.2.22)
       bundler (~> 1.0)
-      railties (= 3.2.21)
-    railties (3.2.21)
-      actionpack (= 3.2.21)
-      activesupport (= 3.2.21)
+      railties (= 3.2.22)
+    railties (3.2.22)
+      actionpack (= 3.2.22)
+      activesupport (= 3.2.22)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
@@ -105,19 +107,25 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sidekiq (2.17.7)
+      celluloid (>= 0.15.2)
+      connection_pool (>= 1.0.0)
+      json
+      redis (>= 3.0.6)
+      redis-namespace (>= 1.3.1)
     sinatra (1.4.6)
       rack (~> 1.4)
       rack-protection (~> 1.4)
@@ -127,11 +135,11 @@ GEM
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sucker_punch (1.5.0)
-      celluloid (~> 0.16.0)
+    sucker_punch (1.5.1)
+      celluloid (= 0.16.0)
     thor (0.19.1)
     tilt (1.4.1)
-    timers (4.0.1)
+    timers (4.0.4)
       hitimes
     treetop (1.4.15)
       polyglot
@@ -139,6 +147,7 @@ GEM
     tzinfo (0.3.44)
     unf (0.1.4)
       unf_ext
+    unf (0.1.4-java)
     unf_ext (0.0.7.1)
     vegas (0.1.11)
       rack (>= 1.0.0)
@@ -148,9 +157,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  delayed_job
+  delayed_job (~> 3.0.0)
   delayed_job_active_record
   rails (~> 3.0)
   resque
   rspec
+  sidekiq (~> 2.0)
   vero!

data/README.markdown

@@ -27,8 +27,8 @@ following:
         config.api_key = "Your Production API key goes here"
         config.secret = "Your Production API secret goes here"
       else
-        config.api_key = "Your Test API key goes here"
-        config.secret = "Your Test API secret goes here"
+        config.api_key = "Your Development API key goes here"
+        config.secret = "Your Development API secret goes here"
       end
     end
 
@@ -36,31 +36,19 @@ 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'.
 
-Previously all Vero accounts supported two environments: *test* and *live*.
-This feature has been deprecated in favour of one account with multiple
-projects.
-
-The gem will continue to support development_mode but will require
-you to explicitly set it in the initialiser. We recommend migrating your
-account as soon as possible. If you have any questions, please contact
-support@getvero.com.
-
-    Vero::App.init do |config|
-      config.development_mode = !Rails.env.production? # or use true
-    end
-
 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 = :sidekiq         # Sidekiq
     config.async = :resque          # Resque (recommended)
 
 **Note:** If you're using Mongoid with DelayedJob, you must add
 `gem "delayed_job_mongoid"` to your Gemfile.
 
-Finally, if you wish to disable vero requests when running your automated tests,
+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?
@@ -221,6 +209,9 @@ outlined in Installation. Now you can call the API using the following methods:
 
         # Changing a user's id
         vero.users.reidentify!({:id => 123, :new_id => "honeybadger@getvero.com"})
+
+        # Resubscribing a user
+        vero.users.resubscribe!({:id => 123})
       end
 
       def destroy

data/lib/vero.rb

@@ -10,6 +10,7 @@ module Vero
   autoload :DSL,                  'vero/dsl'
   autoload :Sender,               'vero/sender'
   autoload :ResqueWorker,         'vero/senders/resque'
+  autoload :SidekiqWorker,        'vero/senders/sidekiq'
 
   module Api
     module Workers
@@ -24,6 +25,7 @@ module Vero
         autoload :EditAPI,        'vero/api/users/edit_api'
         autoload :EditTagsAPI,    'vero/api/users/edit_tags_api'
         autoload :UnsubscribeAPI, 'vero/api/users/unsubscribe_api'
+        autoload :ResubscribeAPI, 'vero/api/users/resubscribe_api'
         autoload :ReidentifyAPI,  'vero/api/users/reidentify_api'
       end
     end
@@ -36,6 +38,7 @@ module Vero
     autoload :Base,               'vero/senders/base'
     autoload :DelayedJob,         'vero/senders/delayed_job'
     autoload :Resque,             'vero/senders/resque'
+    autoload :Sidekiq,            'vero/senders/sidekiq'
     autoload :Invalid,            'vero/senders/invalid'
     autoload :Thread,             'vero/senders/thread'
   end

data/lib/vero/api.rb

@@ -12,12 +12,10 @@ module Vero
       end
 
       def run_api(api_klass, options)
+        return if config.disabled
         validate_configured!
         options.merge!(config.request_params)
-
-        unless config.disabled
-          Vero::Sender.send(api_klass, config.async, config.domain, options)
-        end
+        Vero::Sender.send(api_klass, config.async, config.domain, options)
       end
 
       protected
@@ -59,6 +57,10 @@ module Vero
         new(context).unsubscribe!(options)
       end
 
+      def self.resubscribe!(options, context = Vero::App.default_context)
+        new(context).resubscribe!(options)
+      end
+
       def track!(options)
         run_api(Vero::Api::Workers::Users::TrackAPI, options)
       end
@@ -75,6 +77,10 @@ module Vero
         run_api(Vero::Api::Workers::Users::UnsubscribeAPI, options)
       end
 
+      def resubscribe!(options)
+        run_api(Vero::Api::Workers::Users::ResubscribeAPI, options)
+      end
+
       def reidentify!(options)
         run_api(Vero::Api::Workers::Users::ReidentifyAPI, options)
       end

data/lib/vero/api/base_api.rb

@@ -14,7 +14,7 @@ module Vero
 
         def initialize(domain, options)
           @domain = domain
-          @options = options
+          self.options = options
           setup_logging
         end
 

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

@@ -0,0 +1,21 @@
+module Vero
+  module Api
+    module Workers
+      module Users
+        class ResubscribeAPI < BaseAPI
+          def url
+            "#{@domain}/api/v2/users/resubscribe.json"
+          end
+
+          def request
+            RestClient.post(url, @options)
+          end
+
+          def validate!
+            raise ArgumentError.new("Missing :id or :email") if options[:id].to_s.blank? && options[:email].to_s.blank?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vero/sender.rb

@@ -39,6 +39,7 @@ module Vero
       else
         self.senders[false]
       end
+      
       (sender_class.new).call(api_class, domain, options)
     rescue => e
       options_s = JSON.dump(options)

data/lib/vero/senders/sidekiq.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'sidekiq'
+
+module Vero
+  class SidekiqWorker
+    include ::Sidekiq::Worker
+
+    def perform(api_class, domain, options)
+      api_class.constantize.new(domain, options).perform
+      Vero::App.log(self, "method: #{api_class}, options: #{options.to_json}, response: sidekiq job queued")
+    end
+  end
+
+  module Senders
+    class Sidekiq
+      def call(api_class, domain, options)
+        response = ::Vero::SidekiqWorker.perform_async(api_class.to_s, domain, options)
+        Vero::App.log(self, "method: #{api_class.name}, options: #{options.to_json}, response: sidekiq job queued")
+        response
+      end
+    end
+  end
+end

data/lib/vero/version.rb

@@ -1,3 +1,3 @@
 module Vero
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

data/spec/lib/api/base_api_spec.rb

@@ -5,13 +5,13 @@ describe Vero::Api::Workers::BaseAPI do
 
   describe :options_with_symbolized_keys do
     it "should create a new options Hash with symbol keys (much like Hash#symbolize_keys in rails)" do
-      subject.options.should == {}
+      expect(subject.options).to eq({})
 
       subject.options = {:abc => 123}
-      subject.options.should == {:abc => 123}
+      expect(subject.options).to eq({:abc => 123})
 
       subject.options = {"abc" => 123}
-      subject.options.should == {:abc => 123}
+      expect(subject.options).to eq({:abc => 123})
     end
   end
 end

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

@@ -1,25 +1,18 @@
 require 'spec_helper'
 
 describe Vero::Api::Workers::Events::TrackAPI do
+  subject { Vero::Api::Workers::Events::TrackAPI.new('https://api.getvero.com', {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'}) }
 
-  context "request without properties" do
-    subject { Vero::Api::Workers::Events::TrackAPI.new('https://api.getvero.com', {}) }
-    it "should inherit from Vero::Api::Workers::BaseCaller" do
-      subject.should be_a(Vero::Api::Workers::BaseAPI)
-    end
-
-    it "should map to current version of Vero API" do
-      subject.send(:url).should == "https://api.getvero.com/api/v2/events/track.json"
-    end
+  it_behaves_like "a Vero wrapper" do
+    let(:end_point) { "/api/v2/events/track.json" }
   end
 
   context "request with properties" do
-    subject { Vero::Api::Workers::Events::TrackAPI.new('https://api.getvero.com', {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'}) }
     describe :validate! 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
+        expect { subject.send(:validate!) }.to raise_error(ArgumentError)
 
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'}
         subject.options = options
@@ -29,7 +22,7 @@ describe Vero::Api::Workers::Events::TrackAPI do
       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
+        expect { subject.send(:validate!) }.to raise_error(ArgumentError)
 
         options = {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event', :data => nil}
         subject.options = options
@@ -45,12 +38,17 @@ describe Vero::Api::Workers::Events::TrackAPI do
         subject.options = options
         expect { subject.send(:validate!) }.to_not raise_error
       end
+      
+      it 'should not raise an error when keys are Strings for initialization' do
+        options = {"auth_token" => 'abcd', "identity" => {"email" => 'test@test.com'}, "event_name" => 'test_event', "data" => {}}
+        expect { Vero::Api::Workers::Events::TrackAPI.new('https://api.getvero.com', options).send(:validate!) }.to_not raise_error
+      end
     end
 
     describe :request do
       it "should send a JSON request to the Vero API" do
-        RestClient.should_receive(:post).with("https://api.getvero.com/api/v2/events/track.json", {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'}.to_json, {:content_type => :json, :accept => :json})
-        RestClient.stub(:post).and_return(200)
+        expect(RestClient).to receive(:post).with("https://api.getvero.com/api/v2/events/track.json", {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'}.to_json, {:content_type => :json, :accept => :json})
+        allow(RestClient).to receive(:post).and_return(200)
         subject.send(:request)
       end
     end
@@ -60,7 +58,7 @@ describe Vero::Api::Workers::Events::TrackAPI do
     it "should not raise any errors" do
       obj = Vero::Api::Workers::Events::TrackAPI.new('https://api.getvero.com', {:auth_token => 'abcd', :identity => {:email => 'test@test.com'}, :event_name => 'test_event'})
 
-      RestClient.stub(:post).and_return(200)
+      allow(RestClient).to receive(:post).and_return(200)
       expect { obj.perform }.to_not raise_error
     end
   end