services 7.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aedebb8369e465e6bc0dbde201a6f2e353ef4fb50b9c7e1568914a6aa5c6bdd
-  data.tar.gz: b9fcc3a9b6a1d38de2257bdab6145c68db707e0665d5538430e3db2ac46bef2e
+  metadata.gz: 968f73b837027e7a1fd1d445b18073fec9e4fa449c5975086551c51c58dccf8b
+  data.tar.gz: 92f3ada6ce7a8617e8a50ddf4a5f11827722845dd952c244547f93e76853c283
 SHA512:
-  metadata.gz: '08637ac5fe53454bd404fd069f00179a010cfb0f32295948b403796b7d24ec106b9485a732f2c37d05e9983bc8188ae5e76152c871c77a9fa1f6008ae3e4dfbb'
-  data.tar.gz: f494e1694f08b16debb2d21d6d82a2473b46822e5ca433d64e5c74b28d85b074937bd94b440c277593253bd5e67b2c1a2b2aaf0058d1155b92ba7880dbf4e772
+  metadata.gz: 6d8931cc9b545291cd231cdec1ede213e0838261d3fdcfe19dfd3f71b70c0f83dbf11798573ead47238041bb889e9943abed244cc78661febee80c5ddac9b2ed
+  data.tar.gz: 3438431663f57852b0167a85ad4dd9f895198f7854090b4d06e8844c2eba01089d3c0a743a4ff37adf8abe9b4cb02395d9bde6fb8bc17923f95a71b9d5007086

data/Appraisals

@@ -1,11 +1,11 @@
-appraise 'rails_4.2' do
-  gem 'rails', '~> 4.2.0'
+appraise 'rails_5.2' do
+  gem 'rails', '~> 5.2.0'
 end
 
-appraise 'rails_5.0' do
-  gem 'rails', '~> 5.0.0'
+appraise 'rails_6.0' do
+  gem 'rails', '~> 6.0.0'
 end
 
-appraise 'rails_5.1' do
-  gem 'rails', '~> 5.1.0'
+appraise 'rails_6.1' do
+  gem 'rails', '~> 6.1.0'
 end

data/README.md

@@ -1,8 +1,8 @@
 # Services
 
 [![Gem Version](https://badge.fury.io/rb/services.png)](http://badge.fury.io/rb/services)
-[![Build Status](https://secure.travis-ci.org/krautcomputing/services.png)](http://travis-ci.org/krautcomputing/services)
-[![Code Climate](https://codeclimate.com/github/krautcomputing/services.png)](https://codeclimate.com/github/krautcomputing/services)
+[![Build Status](https://secure.travis-ci.org/manuelmeurer/services.png)](http://travis-ci.org/manuelmeurer/services)
+[![Code Climate](https://codeclimate.com/github/manuelmeurer/services.png)](https://codeclimate.com/github/manuelmeurer/services)
 
 Services is a collection of modules and base classes that let you simply add a service layer to your Rails app.
 
@@ -20,7 +20,7 @@ For disambiguation: in this README, when you read "Services" with a uppercase "S
 
 #### Ruby >= 2.2.5
 
-#### Rails >= 4.2
+#### Rails >= 5.2
 
 #### Redis >= 3.0
 
@@ -28,7 +28,7 @@ Redis is used at several points, e.g. to store information about the currently r
 
 #### Postgres (optional)
 
-The SQL that `Services::Query` (discussed further down) generates is optimized for Postgres. It might work with other databases but it's not guaranteed. If you're not using Postgres, you can still use all other parts of Services, just don't use `Services::Query` or, even better, submit a [pull request](https://github.com/krautcomputing/services/issues) that fixes it to work with your database!
+The SQL that `Services::Query` (discussed further down) generates is optimized for Postgres. It might work with other databases but it's not guaranteed. If you're not using Postgres, you can still use all other parts of Services, just don't use `Services::Query` or, even better, submit a [pull request](https://github.com/manuelmeurer/services/issues) that fixes it to work with your database!
 
 #### Sidekiq (optional)
 

data/gemfiles/{rails_4.2.gemfile → rails_5.2.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 5.2.0"
 
 gemspec path: "../"

data/gemfiles/{rails_5.0.gemfile → rails_6.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.0"
+gem "rails", "~> 6.0.0"
 
 gemspec path: "../"

data/gemfiles/{rails_5.1.gemfile → rails_6.1.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.1.0"
+gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/lib/services.rb

@@ -5,8 +5,8 @@ require_relative 'services/logger/null'
 module Services
   include GemConfig::Base
 
-  BackgroundProcessorNotFound = Class.new(StandardError)
-  RedisNotFound               = Class.new(StandardError)
+  NoBackgroundProcessorFound = Class.new(StandardError)
+  RedisNotFound              = Class.new(StandardError)
 
   with_configuration do
     has :logger, default: Services::Logger::Null.new
@@ -18,18 +18,15 @@ module Services
     @redis ||= self.configuration.redis || (defined?(Redis.current) && Redis.current) or fail RedisNotFound, 'Redis not configured.'
   end
 
-  def self.allow_class_method_in_queries(klass, method)
-    (configuration.allowed_class_methods_in_queries[klass.to_s] ||= Set.new) << method.to_sym
+  def self.allow_class_method_in_queries(klass, method, arity = nil)
+    (configuration.allowed_class_methods_in_queries[klass.to_s] ||= {})[method.to_sym] = arity
   end
 end
 
 require_relative 'services/version'
 require_relative 'services/logger/file'
 require_relative 'services/logger/redis'
-begin
-  require_relative 'services/asyncable'
-rescue Services::BackgroundProcessorNotFound
-end
+require_relative 'services/asyncable'
 require_relative 'services/modules/call_logger'
 require_relative 'services/modules/exception_wrapper'
 require_relative 'services/modules/object_class'

data/lib/services/asyncable.rb

@@ -1,13 +1,6 @@
 require 'active_support/concern'
 require 'global_id'
 
-begin
-  require 'sidekiq'
-  require 'sidekiq/api'
-rescue LoadError
-  raise Services::BackgroundProcessorNotFound
-end
-
 module Services
   module Asyncable
     extend ActiveSupport::Concern
@@ -15,7 +8,26 @@ module Services
     ASYNC_METHOD_SUFFIXES = %i(async in at).freeze
 
     included do
-      include Sidekiq::Worker
+      sidekiq_loaded = false
+
+      begin
+        require 'sidekiq'
+        require 'sidekiq/api'
+      rescue LoadError
+      else
+        include Sidekiq::Worker
+        sidekiq_loaded = true
+      end
+
+      unless sidekiq_loaded
+        begin
+          require 'sucker_punch'
+        rescue LoadError
+          raise Services::NoBackgroundProcessorFound
+        else
+          include SuckerPunch::Job
+        end
+      end
     end
 
     module ClassMethods
@@ -33,19 +45,22 @@ module Services
       args = args.map do |arg|
         GlobalID::Locator.locate(arg) || arg
       end
-      # If the `call` method takes any kwargs and the last argument is a hash, symbolize the hash keys,
-      # otherwise they won't be recognized as kwards when splatted.
-      # Since the arguments to `perform` are serialized to the database before Sidekiq picks them up,
-      # symbol keys are converted to strings.
+
       call_method = method(:call)
+
       # Find the first class that inherits from `Services::Base`.
       while !(call_method.owner < Services::Base)
         call_method = call_method.super_method
       end
-      if call_method.parameters.map(&:first).grep(/\Akey/).any? && args.last.is_a?(Hash)
-        args.last.symbolize_keys!
+
+      # If the `call` method takes any kwargs and the last argument is a hash, pass them to the method as kwargs.
+      kwargs = if call_method.parameters.map(&:first).grep(/\Akey/).any? && args.last.is_a?(Hash)
+        args.pop.symbolize_keys
+      else
+        {}
       end
-      call *args
+
+      call *args, **kwargs
     end
   end
 end

data/lib/services/base.rb

@@ -11,7 +11,10 @@ module Services
       def inherited(subclass)
         subclass.const_set :Error, Class.new(StandardError)
         subclass.public_send :include, Rails.application.routes.url_helpers if defined?(Rails)
-        subclass.public_send :include, Asyncable if defined?(Asyncable)
+        begin
+          subclass.public_send :include, Asyncable
+        rescue Services::NoBackgroundProcessorFound
+        end
         subclass.public_send :prepend, CallLogger, ExceptionWrapper, UniquenessChecker
       end
 
@@ -22,7 +25,7 @@ module Services
       @id = SecureRandom.hex(6)
     end
 
-    def call(*args)
+    def call(*args, **kwargs)
       raise NotImplementedError
     end
 

data/lib/services/modules/call_logger.rb

@@ -27,9 +27,9 @@ module Services
         end
       end
 
-      def call(*args)
+      def call(*args, **kwargs)
         unless self.class.call_logging_disabled
-          log "START with args: #{args}", caller: caller
+          log "START with args: #{args}, kwargs: #{kwargs}", caller: caller
           start = Time.now
         end
         begin

data/lib/services/modules/exception_wrapper.rb

@@ -1,7 +1,7 @@
 module Services
   class Base
     module ExceptionWrapper
-      def call(*args)
+      def call(*args, **kwargs)
         super
       rescue StandardError => e
         if e.class <= self.class::Error

data/lib/services/modules/uniqueness_checker.rb

@@ -14,7 +14,7 @@ module Services
       ).freeze
 
       MAX_RETRIES = 10.freeze
-      ONE_DAY     = (60 * 60 * 24).freeze
+      THIRTY_DAYS = (60 * 60 * 24 * 30).freeze
 
       def self.prepended(mod)
         mod.const_set :NotUniqueError, Class.new(mod::Error)
@@ -37,12 +37,12 @@ module Services
         else
           @_uniqueness_keys ||= []
           @_uniqueness_keys << new_uniqueness_key
-          Services.redis.setex new_uniqueness_key, ONE_DAY, @id
+          Services.redis.setex new_uniqueness_key, THIRTY_DAYS, @id
           true
         end
       end
 
-      def call(*args)
+      def call(*args, **kwargs)
         @_service_args = args
         super
       rescue self.class::NotUniqueError => e
@@ -103,7 +103,7 @@ module Services
       end
 
       def increase_error_count
-        Services.redis.setex error_count_key, retry_delay + ONE_DAY, error_count + 1
+        Services.redis.setex error_count_key, retry_delay + THIRTY_DAYS, error_count + 1
       end
 
       def uniqueness_key(args)

data/lib/services/query.rb

@@ -71,8 +71,10 @@ module Services
       end
 
       conditions.each do |k, v|
-        if (Services.configuration.allowed_class_methods_in_queries[object_class.to_s] || []).include?(k)
-          case object_class.method(k).arity
+        allowed_class_methods = Services.configuration.allowed_class_methods_in_queries[object_class.to_s]
+        if allowed_class_methods&.key?(k)
+          arity = allowed_class_methods[k] || object_class.method(k).arity
+          case arity
           when 0
             unless v == true
               raise ArgumentError, "Method #{k} of class #{self} takes no arguments, so `true` must be passed as the value for this param, not #{v} (#{v.class})."

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '7.2.0'.freeze
+  VERSION = '8.0.0'.freeze
 end

data/services.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.email                 = 'manuel@krautcomputing.com'
   gem.summary               = 'A nifty service layer for your Rails app'
   gem.description           = 'A nifty service layer for your Rails app'
-  gem.homepage              = 'http://krautcomputing.github.io/services'
+  gem.homepage              = 'http://manuelmeurer.github.io/services'
   gem.license               = 'MIT'
   gem.required_ruby_version = '>= 2.2.5'
   gem.files                 = `git ls-files`.split($/)

data/spec/support/test_services.rb

@@ -81,14 +81,14 @@ module Services
 end
 
 class EmptyService < Services::Base
-  def call(*args)
+  def call(*args, **kwargs)
   end
 end
 
 class EmptyServiceWithoutCallLogging < Services::Base
   disable_call_logging
 
-  def call(*args)
+  def call(*args, **kwargs)
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Manuel Meurer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -193,9 +193,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - lib/services.rb
 - lib/services/asyncable.rb
 - lib/services/base.rb
@@ -227,11 +227,11 @@ files:
 - spec/support/redis-server
 - spec/support/shared.rb
 - spec/support/test_services.rb
-homepage: http://krautcomputing.github.io/services
+homepage: http://manuelmeurer.github.io/services
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,8 +246,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: A nifty service layer for your Rails app
 test_files: