servicer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99a9950f7c88104948e676570b5eb3092e144fda
+  data.tar.gz: 073f9d1730486057c1a1db2883a6cac5e4badfab
+SHA512:
+  metadata.gz: 9be3adc87ffdd8224b376ee1edfe87ac6440c04e2d2ab9f3f2d85baca03c3e1b250b04d37dc760fc1ee4de2472c78551cf23f96e399e5a6117015b08ac6ee2c5
+  data.tar.gz: 6fd89c2f3c1127acf4464cd9a1073c9d1bd3288d1dca554f45eab63fdff41d634757ca7f70fee5d34570e6ad042cf8fe328e6e290eae34fb1739c6b78b6a4d54

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    channel: rubocop-0-52
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/*.gem

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,18 @@
+dist: trusty
+language: ruby
+script: "bundle exec rake"
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - ruby-head
+  - jruby-9.1.9.0 # https://github.com/travis-ci/travis-ci/issues/8446
+  - jruby-head
+  - rbx-3
+
+matrix:
+  allow_failures:
+    - rvm: 2.5
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+- initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rake'
+  gem 'rspec', '~> 3.7'
+
+  # Use same version as Code Climate for consistency with CI
+  # https://github.com/codeclimate/codeclimate-rubocop/blob/master/Gemfile.lock
+  gem 'rubocop', '0.52.1', require: false
+  gem 'rubocop-rspec', '1.21.0', require: false
+end
+
+gemspec

data/README.md

@@ -0,0 +1,166 @@
+# Servicer
+
+Simple Service Object builder.
+
+## Installation
+
+```
+gem install servicer
+```
+
+## Basic usage
+
+Servicer provides base class for building services, and set of additional layers for changing behaviour.
+
+Simplest use case is building Command Object for API:
+
+```
+class CreateUser < ::Servicer::Base
+  def call(current_user, params)
+    User.create(params)
+  end
+end
+
+CreateUser.call(current_user, params) #=> new User
+```
+
+In that form no layers are applied, so input will not be changed in any way. Servicer is proxying class `call` method,
+building new instance and calling `call` with the same params as provided (unless modified by layers).
+
+## Layers
+
+Layers are modifying how given service object behave. They can validate input, change params, and raise errors.
+Simplest call would look like this:
+
+```
+class CreateUser < ::Servicer::Base
+  layer :require_user
+
+  def call(current_user, params)
+    User.create(params)
+  end
+end
+```
+
+Multiple layers can be applied and they will be executed in order of mentioning them. Some of them will require
+additional parameters, documentation can be found below.
+
+### RequireUser
+
+This layer is raising `Servicer::AuthorizationError` is current user is not provided. This layer is not accepting
+any options.
+
+```
+class CreateUser < ::Servicer::Base
+  layer :require_user
+
+  def call(current_user, params)
+    User.create(params)
+  end
+end
+
+CreateUser.call(nil, params) #=> raises Servicer::AuthorizationError
+```
+
+### SetDefaultParams
+
+This layer is merging received params with default values provided using deep merge (nested hash values will be merged).
+Values from provided params always take precedence over default values.
+
+```
+class CreateUser < ::Servicer::Base
+  layer :set_default_values, {
+    role: 'user'
+  }
+
+  def call(current_user, params)
+    User.create(params)
+  end
+end
+
+CreateUser.call(nil, {}) #=> user.role == 'user'
+CreateUser.call(nil, { role: 'admin' }) #=> user.role == 'admin'
+```
+
+### ValidateParams
+
+This layer is validating params provided, raising `Servicer::ParamsError` if validation fails, and filtering any param
+that was not validated. It's using [dry-validation](http://dry-rb.org/gems/dry-validation/) under the hood, and you need
+to include it in your Gemfile.
+
+Please bear in mind that it's used for validating input, and not for checking user permissions.
+
+```
+class CreateUser < ::Servicer::Base
+  layer :validate_params do
+    required(:role).filled(:str?)
+    optional(:age).filled(:int?, gt?: 17)
+  end
+
+  def call(current_user, params)
+    User.create(params)
+  end
+end
+
+CreateUser.call(nil, {}) #=> raises Servicer::ParamsError
+CreateUser.call(nil, { role: 1 }) #=> raises Servicer::ParamsError
+CreateUser.call(nil, { role: 'admin' }) #=> user.role == 'admin'
+CreateUser.call(nil, { role: 'admin', age: 17 }) #=> raises Servicer::ParamsError
+CreateUser.call(nil, { role: 'admin', age: 18 }) #=> user.role == 'admin', user.age == 18
+```
+
+## Combining layers
+
+Multiple layers can be used together in order to provide final service:
+
+```
+class CreateUser < ::Servicer::Base
+  layer :require_user
+
+  layer :validate_params do
+    optional(:role).filled(:str?)
+    required(:age).filled(:int?, gt?: 17)
+  end
+
+  layer :set_default_values, {
+    role: 'user'
+  }
+
+  def call(current_user, params)
+    User.create(params)
+  end
+end
+```
+
+```
+class ListUsers < ::Servicer::Base
+  layer :validate_params do
+    optional(:role).filled(:str?)
+    optional(:limit).filled(:int?, gt?: 0, lt?: 1000)
+    optional(:offset).filled(:int?)
+  end
+
+  layer :set_default_values, {
+    limit: 10,
+    offset: 0
+  }
+
+  def call(current_user, params)
+    limit = params.delete(:limit)
+    offset = params.delete(:offset)
+    User.where(params).limit(limit).offset(offset)
+  end
+end
+```
+
+## License
+
+(The MIT License)
+
+Copyright © 2018 Bernard Potocki
+
+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/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['-c', '-f progress']
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/servicer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Simple Service Object builder.
+# See ::Servicer::Base for how to use it.
+module Servicer
+  class Error < StandardError; end
+  class AuthorizationError < Error; end
+  class ParamsError < Error; end
+
+  require_relative 'servicer/base'
+  require_relative 'servicer/layers'
+  require_relative 'servicer/version'
+end

data/lib/servicer/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Servicer
+  # This is base class for subclassing your services.
+  # Example:
+  #   class MyClass < ::Servicer::Base
+  #     layer :require_user
+  #
+  #     def call(current_user, params)
+  #       true
+  #     end
+  #   end
+  #
+  #   MyClass.call(current_user, params)
+  class Base
+    class AuthorizationError < ::Servicer::AuthorizationError; end
+    class ParamsError < ::Servicer::ParamsError; end
+
+    attr_reader :current_user, :params
+
+    class << self
+      def layers
+        @layers ||= []
+      end
+
+      # Apply layer. Layer class can be any class based on ::Servicer::Layers::Base or symbolized name of layer.
+      def layer(layer_class, options = {}, &block)
+        layer_class = ::Servicer::Layers.const_get(layer_class.to_s.camelcase) if layer_class.is_a?(Symbol)
+        layers << layer_class.new(options, &block)
+      end
+
+      # Main call. Will create instance and run `call` on it. In most cases instance method should be overwritten.
+      def call(current_user, params)
+        current_user, params = layers.inject([current_user, params]) { |arr, layer| layer.call(arr[0], arr[1]) }
+        new(current_user, params).call
+      end
+    end
+
+    # Main call. Overwrite this.
+    def call; end
+
+    private
+
+    def initialize(current_user, params)
+      @current_user = current_user
+      @params = params
+    end
+  end
+end

data/lib/servicer/layers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Servicer
+  # Module for Layers base.
+  module Layers
+    autoload :Base,             File.join(__dir__, 'layers', 'base')
+    autoload :RequireUser,      File.join(__dir__, 'layers', 'require_user')
+    autoload :SetDefaultParams, File.join(__dir__, 'layers', 'set_default_params')
+    autoload :ValidateParams,   File.join(__dir__, 'layers', 'validate_params')
+  end
+end

data/lib/servicer/layers/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Servicer
+  module Layers
+    # Base class for creating Layers.
+    class Base
+      def call(current_user, params)
+        [current_user, params]
+      end
+
+      private
+
+      def initialize(options, &block)
+        @options = options
+        @block = block
+      end
+    end
+  end
+end

data/lib/servicer/layers/require_user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Servicer
+  module Layers
+    # Layer verifying if current user exists, and raises ::Servicer::AAuthorizationError otherwise.
+    # Example:
+    #   layer :require_user
+    class RequireUser < ::Servicer::Layers::Base
+      def call(current_user, params)
+        raise AuthorizationError if current_user.nil?
+        [current_user, params]
+      end
+    end
+  end
+end

data/lib/servicer/layers/set_default_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Servicer
+  module Layers
+    # Layer setting default params using deep_merge.
+    # Example:
+    #   layer :set_default_params, {
+    #     limit: 10
+    #     offset: 0
+    #   }
+    class SetDefaultParams < ::Servicer::Layers::Base
+      def call(current_user, params)
+        # TODO: Remove hidden dependency on ActiveSupport
+        [current_user, @options.deep_merge(params)]
+      end
+    end
+  end
+end

data/lib/servicer/layers/validate_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Servicer
+  module Layers
+    # Layer validating provided params and raising ::Servicer::ParamsError if validation was unsuccessful.
+    # It uses `dry-validation` gem schema to build validation options. Please note that you need to add
+    # `dry-validations` to your Gemfile, as Servicer is not requiring it automatically.
+    # Please consult http://dry-rb.org/gems/dry-validation/ for details of how to build it.
+    # Example:
+    #   layer :validate_params do
+    #     optional(:limit).maybe(:int?, gt?: 0, lt?: 1_000)
+    #     optional(:offset).maybe(:int?)
+    #   end
+    class ValidateParams < ::Servicer::Layers::Base
+      def initialize(options, &block)
+        super
+        @schema = ::Dry::Validation.Schema do
+          configure do
+            config.input_processor = :sanitizer
+          end
+
+          instance_eval(&block)
+        end
+      end
+
+      def call(current_user, params)
+        validation = @schema.call(params)
+        raise ParamsError, validation.errors unless validation.success?
+
+        [current_user, validation.output]
+      end
+    end
+  end
+end

data/lib/servicer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Servicer
+  VERSION = '1.0.0'
+end

data/servicer.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'servicer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'servicer'
+  s.version     = Servicer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Bernard Potocki']
+  s.email       = ['bernard.potocki@imanel.org']
+  s.homepage    = 'http://github.com/imanel/servicer'
+  s.summary     = 'Simple Service Object builder.'
+  s.description = 'Simple Service Object builder.'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.3'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'servicer'
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true # Default in RSpec 4
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true # Default in RSpec 4
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups # Default in RSpec 4
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: servicer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bernard Potocki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-27 00:00:00.000000000 Z
+dependencies: []
+description: Simple Service Object builder.
+email:
+- bernard.potocki@imanel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/servicer.rb
+- lib/servicer/base.rb
+- lib/servicer/layers.rb
+- lib/servicer/layers/base.rb
+- lib/servicer/layers/require_user.rb
+- lib/servicer/layers/set_default_params.rb
+- lib/servicer/layers/validate_params.rb
+- lib/servicer/version.rb
+- servicer.gemspec
+- spec/spec_helper.rb
+homepage: http://github.com/imanel/servicer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Simple Service Object builder.
+test_files:
+- spec/spec_helper.rb