services 2.1.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97b67785d62fb93ba36e511d6e6a2a7f1f949468
-  data.tar.gz: 95180d3cc52cdb8e86a12f8937b46967739adb1b
+  metadata.gz: 1e3f42f5b3d4869497acf2e3405f0f278b25582d
+  data.tar.gz: 8c4d047373b919125c3117da284fd345f7a81816
 SHA512:
-  metadata.gz: 3610f3f8aa0b79110ea17583191f4f5dec5a976eb8b9a6fc632bf614aa5a96d0b38508ecb80e1c6f4f35a7b65198c6c341634c171f53f732fce6278b38505580
-  data.tar.gz: d43bca63c94f9ef81c24752720c5e5d3d08c352c35c5c2905090a956882b20ffb0427908aa1bdc863ad5f4ddee7b476c2909ba1b57eef88fd731471fab363445
+  metadata.gz: 3c776d68b4a336b6a7a04a0003137a176447d1a13a0061c25d3e78806b2243ee81c1cec2a46951be2713acabef16d734681a911cb81eb2ca4a2667b5ea1ae4df
+  data.tar.gz: 933e0c58c79076b20ab1448b7c6105154703b5aea272ef590d17002d4b092fea4cc5149fd385d1b8d1d6c1af7114fa6446501ef104ac141ec09ed58a4e95a4db

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.2.3
+
+* Add `on_error` option `return` to uniqueness checker
+
 ## 2.1.0
 
 * Add `find_ids` and `find_id` helpers to base service

data/lib/services/base.rb

@@ -73,9 +73,6 @@ module Services
 
     def controller
       @controller ||= begin
-        # raise "You must use Rails to use the `controller` helper." unless defined?(Rails)
-        # host = Rails.application.routes.default_url_options[:host] || ActionMailer::Base.default_url_options[:host]
-        # Rails.application.routes.default_url_options[:host]
         raise 'Please configure host.' if Services.configuration.host.nil?
         request = ActionDispatch::TestRequest.new
         request.host = Services.configuration.host

data/lib/services/modules/call_logger.rb

@@ -12,16 +12,18 @@ module Services
       end
 
       module ClassMethods
-        @call_logging_disabled = false
+        @_call_logging_disabled = false
 
-        attr_accessor :call_logging_disabled
+        def call_logging_disabled
+          @_call_logging_disabled
+        end
 
         def disable_call_logging
-          @call_logging_disabled = true
+          @_call_logging_disabled = true
         end
 
         def enable_call_logging
-          @call_logging_disabled = false
+          @_call_logging_disabled = false
         end
       end
 

data/lib/services/modules/uniqueness_checker.rb

@@ -10,6 +10,7 @@ module Services
         fail
         ignore
         reschedule
+        return
       )
 
       MAX_RETRIES = 10
@@ -21,45 +22,56 @@ module Services
 
       def check_uniqueness(*args, on_error: :fail)
         raise "on_error must be one of #{ON_ERROR.join(', ')}, but was #{on_error}" unless ON_ERROR.include?(on_error.to_sym)
-        raise 'Service args not found.' if @service_args.nil?
-        @uniqueness_args = args.empty? ? @service_args : args
-        new_uniqueness_key = uniqueness_key(@uniqueness_args)
-        raise "A uniqueness key with args #{@uniqueness_args.inspect} already exists." if @uniqueness_keys && @uniqueness_keys.include?(new_uniqueness_key)
-        if @similar_service_id = Services.configuration.redis.get(new_uniqueness_key)
-          case on_error.to_sym
-          when :fail
-            raise_non_unique_error
-          when :reschedule
-            if error_count >= MAX_RETRIES
-              raise_non_unique_error
-            else
-              increase_error_count
-              reschedule
-            end
+        @_on_error = on_error
+        raise 'Service args not found.' if @_service_args.nil?
+        @_uniqueness_args = args.empty? ? @_service_args : args
+        new_uniqueness_key = uniqueness_key(@_uniqueness_args)
+        raise "A uniqueness key with args #{@_uniqueness_args.inspect} already exists." if @_uniqueness_keys && @_uniqueness_keys.include?(new_uniqueness_key)
+        if @_similar_service_id = Services.configuration.redis.get(new_uniqueness_key)
+          if on_error.to_sym == :ignore
+            return false
+          else
+            @_retries_exhausted = on_error.to_sym == :reschedule && error_count >= MAX_RETRIES
+            raise_not_unique_error
           end
-          false
         else
-          @uniqueness_keys ||= []
-          @uniqueness_keys << new_uniqueness_key
+          @_uniqueness_keys ||= []
+          @_uniqueness_keys << new_uniqueness_key
           Services.configuration.redis.setex new_uniqueness_key, ONE_HOUR, @id
           true
         end
       end
 
       def call(*args)
-        @service_args = args
+        @_service_args = args
         super
+      rescue self.class::NotUniqueError => e
+        case @_on_error.to_sym
+        when :fail
+          raise e
+        when :reschedule
+          if @_retries_exhausted
+            raise e
+          else
+            increase_error_count
+            reschedule
+          end
+        when :return
+          return e
+        else
+          raise "Unexpected on_error: #{@_on_error}"
+        end
       ensure
-        Services.configuration.redis.del @uniqueness_keys unless @uniqueness_keys.nil? || @uniqueness_keys.empty?
+        Services.configuration.redis.del @_uniqueness_keys unless @_uniqueness_keys.nil? || @_uniqueness_keys.empty?
         Services.configuration.redis.del error_count_key
       end
 
       private
 
-      def raise_non_unique_error(retried = false)
-        message = "Service #{self.class} #{@id} with uniqueness args #{@uniqueness_args} is not unique, a similar service is already running: #{@similar_service_id}."
-        message << " The service has been retried #{MAX_RETRIES} times."
-        raise self.class::NotUniqueError, message
+      def raise_not_unique_error
+        message = "Service #{self.class} #{@id} with uniqueness args #{@_uniqueness_args} is not unique, a similar service is already running: #{@_similar_service_id}."
+        message << " The service has been retried #{MAX_RETRIES} times." if @_retries_exhausted
+        raise self.class::NotUniqueError.new(message)
       end
 
       def convert_for_rescheduling(arg)
@@ -79,7 +91,7 @@ module Services
 
       def reschedule
         # Convert service args for rescheduling first
-        reschedule_args = @service_args.map do |arg|
+        reschedule_args = @_service_args.map do |arg|
           convert_for_rescheduling arg
         end
         log "Rescheduling to be executed in #{retry_delay} seconds." if self.respond_to?(:log)
@@ -109,7 +121,7 @@ module Services
           'errors',
           self.class.to_s.gsub(':', '_')
         ].tap do |key|
-          key << Digest::MD5.hexdigest(@service_args.to_s) unless @service_args.empty?
+          key << Digest::MD5.hexdigest(@_service_args.to_s) unless @_service_args.empty?
         end.join(':')
       end
 

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '2.1.0'
+  VERSION = '2.2.3'
 end

data/spec/services/modules/uniqueness_checker_spec.rb

@@ -2,52 +2,73 @@ require 'spec_helper'
 
 shared_examples 'checking the uniqueness properly' do
   it 'notices when the same job is executed multiple times' do
-    wait_for_job_to_run_and_finish service, *args, 'fail', true do
+    wait_for_job_to_run_and_finish service_class, *args, 'fail', true do
       # Check that error is raised when on_error is "fail"
+      puts 'Checking on_error = fail'
       if defined?(fail_args)
+        puts "* with fail args #{fail_args}"
         3.times do
           fail_args.each do |fail_arg_group|
-            expect { service.call(*fail_arg_group, 'fail', false) }.to raise_error(service::NotUniqueError)
+            service = service_class.new
+            expect(service).to_not receive(:do_work)
+            expect { service.call(*fail_arg_group, 'fail', false) }.to raise_error(service_class::NotUniqueError)
           end
         end
       end
       if defined?(pass_args)
+        puts "* with pass args #{pass_args}"
         3.times do
           pass_args.each do |pass_arg_group|
+            service = service_class.new
+            expect(service).to receive(:do_work)
             expect { service.call(*pass_arg_group, 'fail', false) }.to_not raise_error
           end
         end
       end
 
       # Check that no error is raised when on_error is "ignore"
+      puts 'Checking on_error = ignore'
       if defined?(fail_args)
+        puts "* with fail args #{fail_args}"
         3.times do
           fail_args.each do |fail_arg_group|
+            service = service_class.new
+            expect(service).to receive(:do_work)
             expect { service.call(*fail_arg_group, 'ignore', false) }.to_not raise_error
           end
         end
       end
       if defined?(pass_args)
+        puts "* with pass args #{pass_args}"
         3.times do
           pass_args.each do |pass_arg_group|
+            service = service_class.new
+            expect(service).to receive(:do_work)
             expect { service.call(*pass_arg_group, 'ignore', false) }.to_not raise_error
           end
         end
       end
 
       # Check that service is rescheduled when on_error is "reschedule"
+      puts 'Checking on_error = reschedule'
       if defined?(fail_args)
+        puts "* with fail args #{fail_args}"
         3.times do
           fail_args.each do |fail_arg_group|
-            expect(service).to receive(:perform_in).with(an_instance_of(Fixnum), *fail_arg_group, 'reschedule', false)
+            service = service_class.new
+            expect(service).to_not receive(:do_work)
+            expect(service_class).to receive(:perform_in).with(an_instance_of(Fixnum), *fail_arg_group, 'reschedule', false)
             expect { service.call(*fail_arg_group, 'reschedule', false) }.to_not raise_error
           end
         end
       end
       if defined?(pass_args)
+        puts "* with pass args #{pass_args}"
         3.times do
           pass_args.each do |pass_arg_group|
-            expect(service).to_not receive(:perform_in)
+            service = service_class.new
+            expect(service).to receive(:do_work)
+            expect(service_class).to_not receive(:perform_in)
             expect { service.call(*pass_arg_group, 'reschedule', false) }.to_not raise_error
           end
         end
@@ -63,35 +84,35 @@ end
 describe Services::Base::UniquenessChecker do
   context 'when the service checks for uniqueness with the default args' do
     it_behaves_like 'checking the uniqueness properly' do
-      let(:service)   { UniqueService }
-      let(:args)      { [] }
-      let(:fail_args) { [] }
+      let(:service_class) { UniqueService }
+      let(:args)          { [] }
+      let(:fail_args)     { [] }
     end
   end
 
   context 'when the service checks for uniqueness with custom args' do
     it_behaves_like 'checking the uniqueness properly' do
-      let(:service)   { UniqueWithCustomArgsService }
-      let(:args)      { ['foo', 1, 'bar'] }
-      let(:fail_args) { [['foo', 1, 'pelle']] }
-      let(:pass_args) { [['foo', 2, 'bar']] }
+      let(:service_class) { UniqueWithCustomArgsService }
+      let(:args)          { ['foo', 1, 'bar'] }
+      let(:fail_args)     { [['foo', 1, 'pelle']] }
+      let(:pass_args)     { [['foo', 2, 'bar']] }
     end
   end
 
   context 'when the service checks for uniqueness multiple times' do
     it_behaves_like 'checking the uniqueness properly' do
-      let(:service)   { UniqueMultipleService }
-      let(:args)      { ['foo', 1, true] }
-      let(:fail_args) { args.map { |arg| [arg] } }
-      let(:pass_args) { [%w(pelle)] }
+      let(:service_class) { UniqueMultipleService }
+      let(:args)          { ['foo', 1, true] }
+      let(:fail_args)     { args.map { |arg| [arg] } }
+      let(:pass_args)     { [['pelle']] }
     end
   end
 
   context 'when the service does not check for uniqueness' do
     it_behaves_like 'checking the uniqueness properly' do
-      let(:service)   { NonUniqueService }
-      let(:args)      { [] }
-      let(:pass_args) { [] }
+      let(:service_class) { NonUniqueService }
+      let(:args)          { [] }
+      let(:pass_args)     { [] }
     end
   end
 end

data/spec/support/test_services.rb

@@ -117,15 +117,19 @@ end
 class UniqueService < Services::Base
   def call(on_error, sleep)
     check_uniqueness on_error: on_error
+    do_work
     sleep 0.5 if sleep
   end
+  def do_work; end
 end
 
 class UniqueWithCustomArgsService < Services::Base
   def call(uniqueness_arg1, uniqueness_arg2, ignore_arg, on_error, sleep)
     check_uniqueness uniqueness_arg1, uniqueness_arg2, on_error: on_error
+    do_work
     sleep 0.5 if sleep
   end
+  def do_work; end
 end
 
 class UniqueMultipleService < Services::Base
@@ -133,14 +137,18 @@ class UniqueMultipleService < Services::Base
     args.each do |arg|
       check_uniqueness arg, on_error: on_error
     end
+    do_work
     sleep 0.5 if sleep
   end
+  def do_work; end
 end
 
 class NonUniqueService < Services::Base
   def call(on_error, sleep)
+    do_work
     sleep 0.5 if sleep
   end
+  def do_work; end
 end
 
 class NestedExceptionService < Services::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake