services 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81eb2b7ac07028e41e889899270a9c0144f91443
-  data.tar.gz: 1464d7a79faba0c979904f3620770c791fbbcca3
+  metadata.gz: 5351a6064b1da2a70dd0ce2fba47810bd7deb0f5
+  data.tar.gz: d73f3b3835195a720b4c370d15a67a017ca49a2e
 SHA512:
-  metadata.gz: 79a292567b259d7bbc5781752da14923376dd005f01cf31eb81a6a7c6fe37d8f978c1a369c4588e622c65a2d329bac1e0f1f52a28e13560864c9061e44289374
-  data.tar.gz: 6b5f428b5b1acc15a6f35437cbb52bf6c36009ba1866fb8956b308fb130e5466fc77af9ac016e13ba99eb6fb2f68a9b01efeee6e92570a033eb311947b2cee1d
+  metadata.gz: cdeb74e291c384e338a04acf1c0036788a84bf87813ff25cae0c19b83d3157cb2b749fb09949f4f14a413fe6e90d6c1045516f86f776c176c45a52bbb147e310
+  data.tar.gz: 1ef404e5414c1fb352336b038861884404fac189dece2ce97d2261b81aee00453341e64ad85f1cb256e79e2adffcc0759ca9758de3aa2d1772877a10dd03d23c

data/.gitignore

@@ -1,2 +1,2 @@
 Gemfile.lock
-spec/support/logs/**/*.log
+spec/support/log/**/*.log

data/lib/services.rb

@@ -18,8 +18,8 @@ begin
   require_relative 'services/asyncable'
 rescue Services::BackgroundProcessorNotFound
 end
-require_relative 'services/base/call_logger'
-require_relative 'services/base/exception_wrapper'
-require_relative 'services/base/uniqueness_checker'
+require_relative 'services/modules/call_logger'
+require_relative 'services/modules/exception_wrapper'
+require_relative 'services/modules/uniqueness_checker'
 require_relative 'services/base'
 require_relative 'services/railtie' if defined?(Rails)

data/lib/services/base.rb

@@ -9,7 +9,7 @@ module Services
         subclass.const_set :Error, Class.new(StandardError)
         subclass.send :include, Rails.application.routes.url_helpers if defined?(Rails)
         subclass.send :include, Asyncable if defined?(Asyncable)
-        subclass.send :prepend, CallLogger, UniquenessChecker
+        subclass.send :prepend, CallLogger, ExceptionWrapper, UniquenessChecker
       end
 
       delegate :call, to: :new

data/lib/services/{base → modules}/call_logger.rb

@@ -8,8 +8,15 @@ module Services
           result = super
         rescue StandardError => e
           log "#{e.class}: #{e.message}"
-          e.backtrace.each do |line|
-            log line
+          if e.respond_to?(:cause) && !e.cause.nil?
+            log "caused by: #{e.cause.class}: #{e.cause.message}"
+            e.cause.backtrace.each do |line|
+              log line
+            end
+          else
+            e.backtrace.each do |line|
+              log line
+            end
           end
           raise e
         ensure

data/lib/services/modules/uniqueness_checker.rb

@@ -0,0 +1,40 @@
+module Services
+  class Base
+    module UniquenessChecker
+      def self.prepended(mod)
+        mod.const_set :NotUniqueError, Class.new(mod::Error)
+      end
+
+      def check_uniqueness!(*args)
+        raise 'A variable named @uniqueness_key is already defined. Have you called `check_uniqueness!` twice?' if defined?(@uniqueness_key)
+        raise 'Could not find @uniqueness_all_args' unless defined?(@uniqueness_all_args)
+        args = @uniqueness_all_args if args.empty?
+        @uniqueness_key = uniqueness_key(args)
+        if similar_service_id = Services.configuration.redis.get(@uniqueness_key)
+          raise self.class::NotUniqueError, "Service #{self.class} with args #{args} is not unique, a similar service is already running: #{similar_service_id}"
+        else
+          Services.configuration.redis.setex @uniqueness_key, 60 * 60, @id
+        end
+      end
+
+      def call(*args)
+        @uniqueness_all_args = args
+        super
+      ensure
+        Services.configuration.redis.del @uniqueness_key if defined?(@uniqueness_key)
+      end
+
+      private
+
+      def uniqueness_key(args)
+        [
+          'services',
+          'uniqueness',
+          self.class.to_s
+        ].tap do |key|
+          key << Digest::MD5.hexdigest(args.to_s) unless args.empty?
+        end.join(':')
+      end
+    end
+  end
+end

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '0.1.7'
+  VERSION = '0.2.1'
 end

data/spec/services/base_spec.rb

@@ -66,30 +66,32 @@ describe Services::Base do
   end
 
   context 'checking for uniqueness' do
-    context 'when the service was set to check for uniqueness' do
+    context 'when the service was set to check for uniqueness with the default args' do
       it 'raises an error when the same job is executed twice' do
         wait_for_job_to_run UniqueService.perform_async
-        expect do
-          UniqueService.call
-        end.to raise_error(UniqueService::NotUniqueError)
+        expect { UniqueService.call }.to raise_error(UniqueService::NotUniqueError)
+      end
+    end
+
+    context 'when the service was set to check for uniqueness with custom args' do
+      it 'raises an error when a job with the same custom args is executed twice' do
+        wait_for_job_to_run UniqueWithCustomArgsService.perform_async('foo', 'bar', 'baz')
+        expect { UniqueWithCustomArgsService.call('foo', 'bar', 'pelle') }.to raise_error(UniqueWithCustomArgsService::NotUniqueError)
+        expect { UniqueWithCustomArgsService.call('foo', 'baz', 'pelle') }.to_not raise_error
       end
     end
 
     context 'when the service was not set to check for uniqueness' do
       it 'does not raise an error when the same job is executed twice' do
         wait_for_job_to_run NonUniqueService.perform_async
-        expect do
-          NonUniqueService.call
-        end.to_not raise_error
+        expect { NonUniqueService.call }.to_not raise_error
       end
     end
   end
 
   context 'when executed asynchronously' do
     it 'finds its own worker' do
-      3.times do
-        OwnWorkerService.perform_async
-      end
+      3.times { OwnWorkerService.perform_async }
       jid = OwnWorkerService.perform_async
       own_worker_data = wait_for { Services.configuration.redis.get(jid) }
       own_worker_json = JSON.parse(own_worker_data)
@@ -97,16 +99,12 @@ describe Services::Base do
     end
 
     it 'finds its sibling workers' do
-      sibling_worker_jids = (1..3).map do
-        SiblingWorkersService.perform_async
-      end
+      sibling_worker_jids = (1..3).map { SiblingWorkersService.perform_async }
       jid = SiblingWorkersService.perform_async
       sibling_worker_data = wait_for { Services.configuration.redis.get(jid) }
       sibling_worker_json = JSON.parse(sibling_worker_data)
       expect(sibling_worker_json.size).to eq(3)
-      expected_sibling_worker_jids = sibling_worker_json.map do |_, _, work|
-        work['payload']['jid']
-      end
+      expected_sibling_worker_jids = sibling_worker_json.map { |_, _, work| work['payload']['jid'] }
       expect(expected_sibling_worker_jids).to match_array(sibling_worker_jids)
     end
   end

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ require_relative 'support/test_services'
 require_relative 'support/helpers'
 
 support_dir = Pathname.new(File.expand_path('../support', __FILE__))
-log_dir     = support_dir.join('logs')
+log_dir     = support_dir.join('log')
 
 redis_port    = 6379
 redis_pidfile = support_dir.join('redis.pid')

data/spec/support/test_services.rb

@@ -1,7 +1,13 @@
 class UniqueService < Services::Base
-  check_uniqueness!
-
   def call
+    check_uniqueness!
+    sleep 0.5
+  end
+end
+
+class UniqueWithCustomArgsService < Services::Base
+  def call(uniqueness_arg1, uniqueness_arg2, ignore_arg)
+    check_uniqueness! uniqueness_arg1, uniqueness_arg2
     sleep 0.5
   end
 end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tries
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
 description: ''
@@ -128,8 +128,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -138,17 +138,17 @@ files:
 - lib/services.rb
 - lib/services/asyncable.rb
 - lib/services/base.rb
-- lib/services/base/call_logger.rb
-- lib/services/base/exception_wrapper.rb
-- lib/services/base/uniqueness_checker.rb
 - lib/services/logger.rb
+- lib/services/modules/call_logger.rb
+- lib/services/modules/exception_wrapper.rb
+- lib/services/modules/uniqueness_checker.rb
 - lib/services/railtie.rb
 - lib/services/version.rb
 - services.gemspec
 - spec/services/base_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
-- spec/support/logs/.gitkeep
+- spec/support/log/.gitkeep
 - spec/support/redis-cli
 - spec/support/redis-server
 - spec/support/test_services.rb
@@ -162,12 +162,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -180,7 +180,7 @@ test_files:
 - spec/services/base_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
-- spec/support/logs/.gitkeep
+- spec/support/log/.gitkeep
 - spec/support/redis-cli
 - spec/support/redis-server
 - spec/support/test_services.rb

data/lib/services/base/uniqueness_checker.rb

@@ -1,49 +0,0 @@
-module Services
-  class Base
-    module UniquenessChecker
-      def self.prepended(mod)
-        mod.instance_eval do
-          def check_uniqueness?
-            @check_uniqueness
-          end
-
-          def check_uniqueness!
-            @check_uniqueness = true
-          end
-        end
-        mod.const_set :NotUniqueError, Class.new(mod::Error)
-      end
-
-      def call(*args)
-        if self.class.check_uniqueness?
-          key = unique_key(args)
-          if Services.configuration.redis.exists(key)
-            raise self.class::NotUniqueError
-          else
-            Services.configuration.redis.setex key, 60 * 60, Time.now
-            begin
-              super
-            ensure
-              Services.configuration.redis.del key
-            end
-          end
-        else
-          super
-        end
-      end
-
-      private
-
-      def unique_key(args)
-        # TODO: symbolize keys in hashes in args and sort hashes by key
-        args = args.dup
-        key = [
-          'services',
-          'uniqueness',
-          self.class.to_s,
-          Digest::MD5.hexdigest(args.to_s)
-        ].join(':')
-      end
-    end
-  end
-end