added possible use custom sidekiq worker

README.markdown

@@ -65,6 +65,29 @@ config.disabled = Rails.env.test?
 
 If you have any additional questions, please contact support@getvero.com.
 
+## Custom Sidekiq worker
+
+You can use custom sidekiq worker:
+
+    config.worker = GetVeroWorker
+
+
+    class GetVeroWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 5, queue: :vero
+
+      sidekiq_retries_exhausted do |msg|
+        Rails.logger.error "*"*90
+        Rails.logger.error "Failed ----#{msg['jid']}---- #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+      end
+
+      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
+
 ## Setup tracking
 
 You will need to define who should be tracked and what information about them

lib/vero/api.rb

@@ -15,7 +15,13 @@ def run_api(api_klass, options)
         return if config.disabled
         validate_configured!
         options.merge!(config.request_params)
-        Vero::Sender.send(api_klass, config.async, config.domain, options)
+        Vero::Sender.send(
+          api_klass,
+          config.async,
+          config.domain,
+          options,
+          config
+        )
       end
 
       protected

lib/vero/config.rb

@@ -3,10 +3,12 @@
 module Vero
   class Config
     attr_writer :domain
-    attr_accessor :api_key, :secret, :development_mode, :async, :disabled, :logging
+    attr_accessor :api_key, :secret, :development_mode, :async, :worker,
+                  :disabled, :logging
 
     def self.available_attributes
-      [:api_key, :secret, :development_mode, :async, :disabled, :logging, :domain]
+      [:api_key, :secret, :development_mode, :async, :disabled, :logging,
+       :domain, :worker]
     end
 
     def initialize
@@ -56,6 +58,7 @@ def reset!
       self.logging          = false
       self.api_key          = nil
       self.secret           = nil
+      self.worker           = nil
     end
 
     def update_attributes(attributes = {})

lib/vero/sender.rb

@@ -33,14 +33,14 @@ def self.senders
       t
     end
 
-    def self.send(api_class, sender_strategy, domain, options)
+    def self.send(api_class, sender_strategy, domain, options, config)
       sender_class = if self.senders[sender_strategy]
         self.senders[sender_strategy]
       else
         self.senders[false]
       end
-      
-      (sender_class.new).call(api_class, domain, options)
+
+      (sender_class.new).call(api_class, domain, options, config)
     rescue => e
       options_s = JSON.dump(options)
       Vero::App.log(self.new, "method: #{api_class.name}, options: #{options_s}, error: #{e.message}")

lib/vero/senders/base.rb

@@ -3,12 +3,12 @@
 module Vero
   module Senders
     class Base
-      def call(api_class, domain, options)
+      def call(api_class, domain, options, _config)
         response = api_class.perform(domain, options)
         options_s = JSON.dump(options)
         Vero::App.log(self, "method: #{api_class.name}, options: #{options_s}, response: job performed")
         response
       end
     end
   end
-end
+end

lib/vero/senders/delayed_job.rb

@@ -4,7 +4,7 @@
 module Vero
   module Senders
     class DelayedJob
-      def call(api_class, domain, options)
+      def call(api_class, domain, options, _config)
         response = ::Delayed::Job.enqueue api_class.new(domain, options)
         options_s = JSON.dump(options)
         Vero::App.log(self, "method: #{api_class.name}, options: #{options_s}, response: delayed job queued")
@@ -18,4 +18,4 @@ def call(api_class, domain, options)
       end
     end
   end
-end
+end

lib/vero/senders/invalid.rb

@@ -1,9 +1,9 @@
 module Vero
   module Senders
     class Invalid
-      def call(api_class, domain, options)
+      def call(api_class, domain, options, _config)
         raise "Vero sender not supported by your version of Ruby. Please change `config.async` to a valid sender. See https://github.com/getvero/vero for more information."
       end
     end
   end
-end
+end

lib/vero/senders/resque.rb

@@ -19,9 +19,10 @@ def self.perform(api_class_name, domain, options)
 
   module Senders
     class Resque
-      def call(api_class, domain, options)
-        ::Resque.enqueue(ResqueWorker, api_class.to_s, domain, options)
+      def call(api_class, domain, options, config)
+        worker = config.worker ? Module.const_get(config.worker) : ResqueWorker
+        ::Resque.enqueue(worker, api_class.to_s, domain, options)
       end
     end
   end
-end
+end

lib/vero/senders/sidekiq.rb

@@ -13,11 +13,12 @@ def perform(api_class, domain, options)
 
   module Senders
     class Sidekiq
-      def call(api_class, domain, options)
-        response = ::Vero::SidekiqWorker.perform_async(api_class.to_s, domain, options)
+      def call(api_class, domain, options, config)
+        worker = config.worker ? Module.const_get(config.worker.to_s) : ::Vero::SidekiqWorker
+        response = worker.send(: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
+end

lib/vero/trackable/base.rb

@@ -43,7 +43,11 @@ def to_vero
           end
         end
 
-        result[:email] = result.delete(:email_address) if result.has_key?(:email_address)
+        if result.has_key?(:email_address)
+          result[:email] = result.delete(:email_address)
+          result['email'] = result[:email]
+        end
+
         result[:_user_type] = self.class.name
         result
       end

spec/lib/api_spec.rb

@@ -15,7 +15,8 @@
 
       allow(Vero::App).to receive(:default_context).and_return(mock_context)
 
-      expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Events::TrackAPI, true, "https://api.getvero.com", expected)
+      expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Events::TrackAPI,
+                                                  true, "https://api.getvero.com", expected, mock_context.config)
 
       subject.track!(input)
     end
@@ -39,7 +40,8 @@
       let(:input) { {:email => "james@getvero.com", :data => {:age => 25}} }
 
       specify do
-        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::TrackAPI, true, "https://api.getvero.com", expected)
+        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::TrackAPI,
+                                                    true, "https://api.getvero.com", expected, mock_context.config)
         subject.track!(input)
       end
     end
@@ -50,7 +52,8 @@
       let(:input) { {:email => "james@getvero.com", :changes => {:age => 25}} }
 
       specify do
-        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::EditAPI, true, "https://api.getvero.com", expected)
+        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::EditAPI,
+                                                    true, "https://api.getvero.com", expected, mock_context.config)
         subject.edit_user!(input)
       end
     end
@@ -61,7 +64,8 @@
       let(:input) { {:add => ["boom"], :remove => ["tish"]} }
 
       specify do
-        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::EditTagsAPI, true, "https://api.getvero.com", expected)
+        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::EditTagsAPI,
+                                                    true, "https://api.getvero.com", expected, mock_context.config)
         subject.edit_user_tags!(input)
       end
     end
@@ -72,7 +76,8 @@
       let(:input) { {:email => "james@getvero"} }
 
       specify do
-        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::UnsubscribeAPI, true, "https://api.getvero.com", expected)
+        expect(Vero::Sender).to receive(:send).with(Vero::Api::Workers::Users::UnsubscribeAPI,
+                                                    true, "https://api.getvero.com", expected, mock_context.config)
         subject.unsubscribe!(input)
       end
     end
@@ -83,9 +88,10 @@
       let(:input) { {:email => "james@getvero"} }
 
       specify do
-        Vero::Sender.should_receive(:send).with(Vero::Api::Workers::Users::ResubscribeAPI, true, "https://api.getvero.com", expected)
+        Vero::Sender.should_receive(:send).with(Vero::Api::Workers::Users::ResubscribeAPI,
+                                                true, "https://api.getvero.com", expected, mock_context.config)
         subject.resubscribe!(input)
       end
     end
   end
-end
+end

spec/lib/senders/sidekiq_spec.rb

@@ -1,11 +1,22 @@
 require 'spec_helper'
+class VeroSidekiqWorker;end
 
 describe Vero::Senders::Sidekiq do
   subject { Vero::Senders::Sidekiq.new }
   describe :call do
     it "should perform_async a Vero::SidekiqWorker" do
+      mock_context = Vero::Context.new
       Vero::SidekiqWorker.should_receive(:perform_async).with('Vero::Api::Workers::Events::TrackAPI', "abc", {:test => "abc"}).once
-      subject.call(Vero::Api::Workers::Events::TrackAPI, "abc", {:test => "abc"})
+      subject.call(Vero::Api::Workers::Events::TrackAPI, "abc", {:test => "abc"}, mock_context.config)
+    end
+    context 'use custom worker' do
+      it "should perform_async a VeroCustomWorker" do
+        mock_context = Vero::Context.new
+        worker = VeroSidekiqWorker
+        allow(mock_context.config).to receive(:worker).and_return(worker)
+        worker.should_receive(:perform_async).with('Vero::Api::Workers::Events::TrackAPI', "abc", {:test => "abc"}).once
+        subject.call(Vero::Api::Workers::Events::TrackAPI, "abc", {:test => "abc"}, mock_context.config)
+      end
     end
   end
 end
@@ -22,4 +33,4 @@
       subject.perform('Vero::Api::Workers::Events::TrackAPI', "abc", {:test => "abc"})
     end
   end
-end
+end

vero.gemspec

@@ -1,4 +1,3 @@
-
 # -*- encoding: utf-8 -*-
 $:.push('lib')
 require "vero/version"