operators-service 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02f0e60904dcfc6c7baeaa3eb7c5961569324a29
-  data.tar.gz: 581a8c1c10bb01243a3f7d6e8916d17143d5ed23
+  metadata.gz: 634bbd42b41f927730054c62e7e20dac29645295
+  data.tar.gz: e10721496f308ed987c709e098414860256a0d02
 SHA512:
-  metadata.gz: fcee045378315213c2534675556e36fb2c656b705fac43364a473ba7c804406c802692310151a46ced25295846b34175348b12a178f8eff6c77fe4fc3317c7ee
-  data.tar.gz: cc75bb53af3b0a8218383af1a033e5c3596a9d6e92962c8b9d1ab2eca9124bda3dd54e7867eb6634617c19ba6d98191e595a56ef1c0085ddc8a5d0d5d3963296
+  metadata.gz: eb61e37922dbf36f925bd08fa137f958b3592c3735e2a33925ae49d5e22672c07b2e8fc9d4a5456035d62ba5ca0499788192a79a2ac81a4ad681d562fbe2f310
+  data.tar.gz: c0c0b2de4616dd5dd009e1d2f64a87ee7a23ec0293d1d8da8b8f8e87231c1173c6e8e54d477130d623cd2ae4f85969dd75fea35601372d8bb7b957ac6db94844

data/README.md

@@ -1,6 +1,10 @@
 # Operators::Service
 
-Operators::Service is a lightweight implementation of Service Object based on Either Monad. That gives an home of application business logic.
+[![Gem Version](https://badge.fury.io/rb/operators-service.svg)](https://badge.fury.io/rb/operators-service)
+[![CircleCI](https://circleci.com/gh/operators-rb/operators-service.svg?style=shield&circle-token=ce6107feab9a4989e9c8163c6d652bb1bad40cf7)](https://circleci.com/gh/operators-rb/operators-service)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3fc7bafea686b44d257f/maintainability)](https://codeclimate.com/github/operators-rb/operators-service/maintainability)
+
+Operators::Service is a lightweight implementation of Service Object based on [Either Monad](https://github.com/dry-rb/dry-monads). That gives an home of application business logic.
 
 Service Objects are created when an action:
 
@@ -28,20 +32,105 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class UserCreator < Operators::Service
+  attr_reader :params
+  
+  def initialize(params)
+    @params = params
+  end
+
+  def call
+    user = User.create(params)
+    if !user.new_record?
+      success(user)
+    else
+      failure(user.errors)
+    end
+  end
+end
+```
+
+`success` - returns instance of `Dry::Monads::Either::Right`
+
+`failure` - returns instance of `Dry::Monads::Either::Left`
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    UserCreator.call(user_params).fmap do |user|
+      render json: user
+    end.or_fmap do |errors|
+      render json: errors.full_messages
+    end
+  end
+  
+  private
+  
+  def user_params
+    params.require(:user).permit!
+  end
+end
+```
+
+### More complicated usage
+
+If you need `rescue_callbacks` then you should define `calling` instead of `call`.
+
+```ruby
+class Auth < Operators::Service
+  rescue_callbacks AuthError, CredentialsError
+
+  def initialize(options)
+    @options = options
+  end
 
-## Development
+  def calling
+    return failure('User already authed') if @options[:failure] # returns Dry::Monads::Left('User already authed')
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    first_auth_transaction
+    second_auth_transaction
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    success('ok') # returns Dry::Monads::Right('ok')
+  end
+
+  private
+
+  def first_auth_transaction
+    # do something...
+  end
+
+  def second_auth_transaction
+    raise AuthError, 'Auth error message' if @options[:auth_error]
+  end
+
+  # Wrapper for your error result
+  def error_wrap(error)
+    error # 'User already authed' || 'Auth error message'
+  end
+
+  # Wrapper for your success results
+  def success_wrap(success_result)
+    success_result # ok
+  end
+end
+```
+
+```ruby
+success = Auth.call(email: 'email', password: 'password')
+# Dry::Monads::Right('ok')
+
+failure = Auth.call(email: 'email', password: 'password', failure: true)
+# Dry::Monads::Left('User already authed')
+
+raised_error = Auth.call(email: 'email', password: 'password', auth_error: true)
+# Dry::Monads::Left('Auth error message')
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/operators-rb/operators-service.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/operators/service.rb

@@ -8,6 +8,14 @@ module Operators
           failure(error.message)
         end
       end
+
+      define_method :failure_wrapper do |&block|
+        begin
+          block.call
+        rescue *exceptions => error
+          failure(error.message)
+        end
+      end
     end
 
     rescue_callbacks

data/operators-service.gemspec

@@ -5,13 +5,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'operators-service'
-  spec.version       = '0.2.0'
+  spec.version       = '0.2.1'
   spec.authors       = ['Yaroslav Bezrukavyi', 'Kirill Shevchenko']
   spec.email         = ['yaroslav.bezrukavyi@gmail.com', 'hello@kirillshevch.com']
 
   spec.summary       = 'You will always know the type of the result'
   spec.description   = 'Service Object is based on Either Monad'
-  spec.homepage      = 'http://operators-rb.org'
+  spec.homepage      = 'https://github.com/operators-rb/operators-service'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: operators-service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Yaroslav Bezrukavyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -116,7 +116,7 @@ files:
 - operators-service.gemspec
 - spec/operators/service_spec.rb
 - spec/spec_helper.rb
-homepage: http://operators-rb.org
+homepage: https://github.com/operators-rb/operators-service
 licenses:
 - MIT
 metadata: {}
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: You will always know the type of the result