services_base 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a6c9556231cf5b53f1e17362a3a3d35e4ca9792
-  data.tar.gz: be28c11b0980042cc3df8fbd92ade87509825d7b
+SHA256:
+  metadata.gz: e08cc56780595fc4e0b65496e1c7390c38a750a9ed0ca0b6909e0bf42446d5bc
+  data.tar.gz: 80d6012ad972450cd9a18ed08dc9d299a5db68a1b9c640d2d851fae311b4233e
 SHA512:
-  metadata.gz: 58fa5fe8fda0a7d13a7ea0a3703324bc631d4d5f1249888b375298d8cf587eb1b9d0ceaef298901b2de44c11be382c59b293aa9326ecc539ef6c2f022f262e25
-  data.tar.gz: e8ec7e84e59be28abd2672c4b74ffe688b555c52dd41e95e031e9f4c86ae0ac2418246d0c20146bb8aebd8c3a276dce807b60df528494f3932591b8363de16ca
+  metadata.gz: e5423dd27046562d40eedb65aa57895c36d5ed4a39fdd008361a07738af818cc93e94c8073ea23c6592322e0f5edf620d0292a2635d5fcd0082a634cd182dac2
+  data.tar.gz: 7f893261a0dcbff1518a0043e6c5b0085d0a9f8e24bcb91f3553ef9b20a2c136932486275aadab14b383ad93dabc3e2bfb76e41f3f81178749a28747cc537488

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+.byebug_history

data/Guardfile

@@ -11,32 +11,4 @@ guard :rspec, cmd: "bundle exec rspec" do
   # Ruby files
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
-
-  # # Rails files
-  # rails = dsl.rails(view_extensions: %w(erb haml slim))
-  # dsl.watch_spec_files_for(rails.app_files)
-  # dsl.watch_spec_files_for(rails.views)
-
-  # watch(rails.controllers) do |m|
-  #   [
-  #     rspec.spec.call("routing/#{m[1]}_routing"),
-  #     rspec.spec.call("controllers/#{m[1]}_controller"),
-  #     rspec.spec.call("acceptance/#{m[1]}")
-  #   ]
-  # end
-
-  # # Rails config changes
-  # watch(rails.spec_helper)     { rspec.spec_dir }
-  # watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
-  # watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
-
-  # # Capybara features specs
-  # watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
-  # watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
-
-  # # Turnip features and steps
-  # watch(%r{^spec/acceptance/(.+)\.feature$})
-  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-  #   Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
-  # end
 end

data/README.md

@@ -1,6 +1,8 @@
 # ServicesBase
 
-ServicesBase is a very simple Base module for implementing Service Objects and Micro-Services in Ruby.
+ServicesBase is a very simple skeleton for implementing Service Objects and Micro-Services in Ruby.
+
+It implements a Base module for your service objects (`Services::Base`) and two Response classes (`Services::Responses::Success` and `Services::Responses::Error`).
 
 It was heavily inspired by Chris Holtz's excellent article [Organize your app with service objects](http://chrisholtz.com/blog/organize-your-app-with-service-objects/). You should read it.
 
@@ -21,15 +23,52 @@ Or install it yourself as:
     $ gem install services_base
 
 ## Usage
+```ruby
+class Services::MyService
+  include Services::Base
+
+  def call(id)
+    # do something
+    result_object = { foo: 'bar' }
+
+    # and return success
+    return Services::Responses::Success.new(result_object)
+
+    # or if there's an error:
+    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:
 
-    class Services::MyService
-      include ServicesBase
+```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.
 
-      def call(id)
-        # do something
-      end
-    end
+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/base.rb

@@ -0,0 +1,21 @@
+# Significantly inspired by http://chrisholtz.com/blog/organize-your-app-with-service-objects/
+module Services
+  module Base
+    def self.included(base)
+      base.extend ClassMethods
+      base.include InstanceMethods
+    end
+
+    module ClassMethods
+      def call(*args, &block)
+        self.new.call *args, &block
+      end
+    end
+
+    module InstanceMethods
+      def call(*args, &block)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/services/responses/base.rb

@@ -0,0 +1,23 @@
+module Services
+  module Responses
+    class Base
+      attr_reader :result
+
+      def initialize(result = nil)
+        @result = result
+      end
+
+      def success?
+        raise NotImplementedError
+      end
+
+      def error?
+        !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

@@ -0,0 +1,37 @@
+module Services
+  module Responses
+    class Error < Services::Responses::Base
+      attr_accessor :error_message, :error_code, :exception
+
+      def initialize(result, error_message: nil, error_code: nil, exception: nil, raise_exception_on_async_error: nil)
+        @result, @error_message, @error_code, @exception, @raise_exception_on_async_error =
+        result, error_message, error_code, exception, 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
+        elsif @exception
+          raise @exception
+        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/responses/success.rb

@@ -0,0 +1,9 @@
+module Services
+  module Responses
+    class Success < Services::Responses::Base
+      def success?
+        true
+      end
+    end
+  end
+end

data/lib/services/version.rb

@@ -0,0 +1,3 @@
+module Services
+  VERSION = "1.0.1"
+end

data/lib/services_base.rb

@@ -1,22 +1,6 @@
-require "services_base/version"
-
-# Significantly inspired by http://chrisholtz.com/blog/organize-your-app-with-service-objects/
-module ServicesBase
-  def self.included(base)
-    base.extend ClassMethods
-    base.include InstanceMethods
-  end
-
-  module ClassMethods
-    def call(*args, &block)
-      @instance ||= self.new
-      @instance.call *args, &block
-    end
-  end
-
-  module InstanceMethods
-    def call(*args, &block)
-      raise NotImplementedError
-    end
-  end
-end
+require "services/version"
+require "services/base"
+require "services/responses/base"
+require "services/responses/error"
+require "services/responses/success"
+require "services/responses/configuration"

data/services_base.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'services_base/version'
+require 'services/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "services_base"
-  spec.version       = ServicesBase::VERSION
+  spec.version       = Services::VERSION
   spec.authors       = ["Carl Mercier"]
   spec.email         = ["carl@varagesale.com"]
 
-  spec.summary       = %q{Simple Base module for implementing consistent Service Objects and Micro-Services in Ruby}
-  spec.description   = %q{Simple Base module for implementing consistent Service Objects and Micro-Services in Ruby}
+  spec.summary       = %q{Simple skeleton for implementing consistent Service Objects and Micro-Services in Ruby}
+  spec.description   = %q{Simple skeleton for implementing consistent Service Objects and Micro-Services in Ruby}
   spec.homepage      = "https://github.com/varagesale/services_base"
   spec.license       = "MIT"
 
@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: services_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Carl Mercier
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple Base module for implementing consistent Service Objects and Micro-Services
+description: Simple skeleton for implementing consistent Service Objects and Micro-Services
   in Ruby
 email:
 - carl@varagesale.com
@@ -98,14 +98,19 @@ files:
 - Rakefile
 - bin/console
 - 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
 - lib/services_base.rb
-- lib/services_base/version.rb
 - services_base.gemspec
 homepage: https://github.com/varagesale/services_base
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,10 +125,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Simple Base module for implementing consistent Service Objects and Micro-Services
+summary: Simple skeleton for implementing consistent Service Objects and Micro-Services
   in Ruby
 test_files: []

data/lib/services_base/version.rb

@@ -1,3 +0,0 @@
-module ServicesBase
-  VERSION = "0.1.0"
-end