base_service 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c9c6bd5cbf220fa4f8ae5d2cabb042364a43689
+  data.tar.gz: 49000c5cbadefd476c34b45a5ec65f34b3f70639
+SHA512:
+  metadata.gz: 3afd229bbe5efe2a7db89cd9fe650a63d63b3b1b003ff2f9d710edcc3c826f233e338892d6b53707d617276a47169dff9a2b56bf42cebdb2588bdd5cfdc0f0d2
+  data.tar.gz: 2b471bbd8907163752921336c182294da92d2fffcc9081b3c3b40cee45437f7e03bbbec18e91bcceaff284b1723efa0d579956fe46443bf7f2c1622d5421c495

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+guard(
+  :rspec, cmd: "bundle exec rspec", failed_mode: :keep,
+  all_after_pass: false, all_on_start: true
+) do
+  watch %r{^spec/.+_spec\.rb$}
+	watch(%r{^lib/.+\.rb$})      { 'spec' }
+	watch('spec/spec_helper.rb') { 'spec' }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011, 2012, 2013 by Grouper
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+BaseService
+===========
+
+The client should extend this module, in order to implement this common
+service object pattern.
+
+### Advanced Syntax
+
+```ruby
+
+MyService.new(param1, param2).call do |on|
+  on.success { |result| puts "Success #{result}" }
+
+  on.failure { |error| puts "Generic failure #{error}" }
+  on.failure(:param1_error) { |error| puts "Problem with param1 #{param1}" }
+  on.failure(:param2_error) { |error| puts "Problem with param1 #{param1}" }
+end
+
+```
+
+### Semi-Advanced Syntax
+
+```ruby
+
+MyService.new(param1, param2).call do |on|
+  puts "Result: #{on.result}"
+end
+
+```
+
+## Support for (depreacted) legacy behaviour
+
+No command-query separation. :(
+
+```ruby
+
+result = MyService.new(param1, param2).call
+
+```
+
+## Example Service
+
+```ruby
+
+class MyService
+  include BaseService
+
+  def initialize(param1, param2)
+    @param1, @param2 = param1, param2
+  end
+
+  private
+  attr_reader :param1, :param2
+
+  def perform
+    return failure "no param1", :param1_error  unless param1.present?
+    return failure "no param2", :param2_error  unless param2.present?
+    return failure "neither param1 or 2" unless param1.present? && param2.present?
+
+    return "success!"
+  end
+end
+
+```
+

data/lib/base_service.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+require 'active_support/core_ext/object'
+require 'base_service/matcher'
+require 'base_service/failure'
+
+module BaseService
+  def call
+    perform
+
+    if block_given?
+      self.matcher = Matcher.new self
+      yield matcher
+      matcher.resolve
+    end
+
+    result
+  end
+
+  attr_reader :result, :was_success, :failure_code
+  alias was_success? was_success
+
+  private
+
+  attr_writer :was_success, :result, :failure_code
+  attr_accessor :matcher
+
+  def success(result)
+    self.was_success = true
+    self.result = result
+  end
+
+  def failure(result, code = nil)
+    self.was_success = false
+    self.result = result
+    self.failure_code = code
+  end
+end
+
+require 'base_service/version'

data/lib/base_service/failure.rb

@@ -0,0 +1,10 @@
+module BaseService
+  class Failure < RuntimeError
+    def initialize(service, result, code = nil)
+      @result, @code = result, code
+      super "#{service.class} failed"
+    end
+
+    attr_reader :result
+  end
+end

data/lib/base_service/matcher.rb

@@ -0,0 +1,41 @@
+module BaseService
+  class Matcher
+    def initialize(service)
+      @service, @specific_failure_blocks = service, {}
+    end
+
+    def success(&block)
+      self.generic_success_block = block
+    end
+
+    def failure(code = nil, &block)
+      if code.nil?
+        self.generic_failure_block = block
+      else
+        specific_failure_blocks[code] = block
+      end
+    end
+
+    def resolve
+      return appropriate_failure_block.call result if !was_success?
+      generic_success_block.call result if generic_success_block.present?
+    end
+
+    attr_reader :service, :specific_failure_blocks
+    attr_accessor :generic_success_block, :generic_failure_block
+    delegate :result, :was_success?, :failure_code, to: :service
+
+    def failure_handled?
+      generic_failure_block.present? || specific_failure_blocks[failure_code].present?
+    end
+
+    def appropriate_failure_block
+      specific_failure_blocks[failure_code] || generic_failure_block || raise_failure_not_handled
+    end
+
+    def raise_failure_not_handled
+      raise Failure.new(service, result, failure_code)
+    end
+  end
+end
+

data/lib/base_service/version.rb

@@ -0,0 +1,3 @@
+module BaseService
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: base_service
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brett Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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: rspec-its
+  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: 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
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Template for service objects in ruby
+email:
+- brett.richardson.nz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- lib/base_service.rb
+- lib/base_service/failure.rb
+- lib/base_service/matcher.rb
+- lib/base_service/version.rb
+homepage: http://www.mebrett.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Base Service for Ruby
+test_files: []