services_base 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76f9b2dbd6def46e2fd9d04e111922114aa491b6
-  data.tar.gz: a30277e540d0f3cc81059462a66c0b350a0142f6
+  metadata.gz: a0ccf1501a60361ff4746fe5e597a45bcd99f851
+  data.tar.gz: c89233b63b68af9f60d2819fede2f631e7a225af
 SHA512:
-  metadata.gz: 56e85f8247cde3512526a1b4b4ba5dc66e237b0649c1629bf988f6cd3bc1ea32ac7af1d0d56767c8744805cf2260b3e8502305ccd9b744b6cbae61875dcc3530
-  data.tar.gz: 0f2672dddac5b2b98b715532a6eacfe0e68385c1c9179a35476fa079112e65e5a4fcd8541c01e596af005f8a9ffe9eb354565932c5c71bcf53b3012b263338c0
+  metadata.gz: f84ea0cbb0088f1fc89a23a277d5f0237b96f142d45b39852a444dabd48a3d9ce4bad25f34f8ea0f208c20c898f917a30def7ea24e72fb704e08a2b2771a2da9
+  data.tar.gz: 36112023f6dfd8f4ed2ebee787e10abf4b61b88ebc83a983fbbcada06b29982c37e62f7b6e411500f4c91f842bc5adbcaed2aee95b62ed5ca3738ce82ea91faf

data/.gitignore

@@ -8,4 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
-
+.byebug_history

data/README.md

@@ -38,6 +38,36 @@ class Services::MyService
     return Services::Responses::Error.new(result_object, error_message: 'Something went wrong', error_code: 123)
   end
 end
+
+response = Services::MyService.call(123)
+response.is_a?(Services::Responses::Success)  # true when it's a success
+response.is_a?(Services::Responses::Error)    # true when it's an error
+response.is_a?(Services::Responses::Base)     # always true
+
+response.success?       # true/false
+response.result         # the resulting object
+response.error_code     # available when there's an error
+response.error_message  # available when there's an error
+```
+
+## Configuration
+
+When running a service asynchronously (ie: in Sidekiq or Delayed Job), it may be desirable to raise an exception instead of returning a `Services::Responses::Error` in order to retry the job at a later time. It is easy to do so:
+
+```ruby
+Services::Responses.configure do |config|
+  config.raise_exception_on_async_error = true
+end
+```
+
+When `raise_exception_on_async_error` is set to `true`, an exception will be thrown whenever a new 
+`Services::Responses::Error` is initialized during an asynchronous job.
+
+Alternatively, you can raise an exception only for a specific `Error` object:
+
+```ruby
+# will raise an exception ONLY if it's called from an async job.
+Services::Responses::Error.new(my_exception, raise_exception_on_async_error: true)
 ```
 
 ## License

data/lib/services/responses/base.rb

@@ -15,6 +15,9 @@ module Services
         !success?
       end
 
+      def self.async_environment?
+        (defined?(Sidekiq) && !!Sidekiq.server?) || (ENV["_"] || "").include?("delayed_job") || (ENV["_"] || "").include?("resque")
+      end
     end
   end
 end

data/lib/services/responses/configuration.rb

@@ -0,0 +1,19 @@
+module Services::Responses
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :raise_exception_on_async_error
+
+    def initialize
+      @raise_exception_on_async_error = false
+    end
+  end
+end
+
+Services::Responses.configuration ||= Services::Responses::Configuration.new

data/lib/services/responses/error.rb

@@ -3,13 +3,33 @@ module Services
     class Error < Services::Responses::Base
       attr_accessor :error_message, :error_code
 
-      def initialize(result, error_message: nil, error_code: nil)
-        @result, @error_message, @error_code = result, error_message, error_code
+      def initialize(result, error_message: nil, error_code: nil, raise_exception_on_async_error: nil)
+        @result, @error_message, @error_code, @raise_exception_on_async_error = 
+        result, error_message, error_code, raise_exception_on_async_error
+
+        raise_if_async!
       end
 
       def success?
         false
       end
+
+    protected
+      def raise_if_async!
+        return unless should_raise?
+
+        if @result.is_a?(Exception)
+          raise @result
+        else
+          err = ("#{@error_message} " + "[#{@error_code}]".gsub("[]", "")).strip
+          raise StandardError.new(err)
+        end
+      end
+
+      def should_raise?
+        (Services::Responses.configuration.raise_exception_on_async_error || @raise_exception_on_async_error) \
+          && Services::Responses::Base.async_environment?
+      end
     end
   end
 end

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/services_base.rb

@@ -3,3 +3,4 @@ require "services/base"
 require "services/responses/base"
 require "services/responses/error"
 require "services/responses/success"
+require "services/responses/configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services_base
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Carl Mercier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - bin/setup
 - lib/services/base.rb
 - lib/services/responses/base.rb
+- lib/services/responses/configuration.rb
 - lib/services/responses/error.rb
 - lib/services/responses/success.rb
 - lib/services/version.rb
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple skeleton for implementing consistent Service Objects and Micro-Services