single_action_service 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccec320aef581ff48f0c28df5af6aae1bf230d9e89a9f5d57a3f8d24198af9df
-  data.tar.gz: 65c81e05d2e24048d68108759a69a173d4ed98c3f6a53122ee84da932006368d
+  metadata.gz: a4d4eb3fec3dc55edbf5aab8460812be72f6ff3f088a75a530b42a00ad904b1c
+  data.tar.gz: a1f12498a8534810f69ba23df56ceff9cc3d3f2ea3cbea91a0429d61bac70551
 SHA512:
-  metadata.gz: 6ad02a79662b3ebf898b9a39e2fd3964a857a555625911585269ab828223567ec276f4494207304de91bd975ec90c3d6d9bc6ef19007cd1539922b730a85323a
-  data.tar.gz: 16e68e8501718248f59f044edbd096feb8efce0dbe42ba42169d6987e9318250d12e3523fdf1dbdd6e203cc7cc571a5202382644989469efc92761df9c2a47ae
+  metadata.gz: 3c192083a4ffba6795f46eb684b9f7e1b3b6805f0c1a87d889c78a64c73aba4c4bed6e9a1daa4fb84a9bfd97a5160dabe3d5b982a43a3f0f656f40d8299f24c1
+  data.tar.gz: ceced5347723cc62ea5f4fe30b8721a6e295ebc8163d5c075cdc424f3b9b1b321d79ba00e64ceace8634f6d60732e7536ec3dab477989bb5f0cbba0390240b01

data/README.md

@@ -1,8 +1,8 @@
 # SingleActionService
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/single_action_service`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/single_action_service.svg)](https://rubygems.org/gems/single_action_service)
 
-TODO: Delete this and the text above, and describe your gem
+Implementation of a Service Object pattern in Ruby.
 
 ## Installation
 
@@ -22,22 +22,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+1. Inherit:
+```ruby
+class MySingleAction < SingleActionService::Base
+end
+```
+2. Create a constructor with parameters or pass them to call:
+```ruby
+# Usually a data source is passed
+def initialize(x, y)
+  @x = x
+  @y = y
+end
+```
+or
+```ruby
+def call(x, y)
+end
+```
+3. Perform the action:
+```ruby
+sum = x + y
+```
+4. Return the result:
+```ruby
+success(sum)
+```
+or without data
+```ruby
+success
+```
+5. Or return an error:
+```ruby
+return error(sum, code: 1) unless sum.positive?
+```
+The first parameter is any data (optional).
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The 'code' parameter is used to identify the error (optional).
 
-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).
+6. You can process the result received from the service as follows:
+```ruby
+action = MySingleAction.new
+result = action.call(1,2)
+# or uses result.error?
+if result.success?
+  result.data
+else
+  {
+    error_code: result.error_code,
+    data: result.data
+  }
+end
+```
+or uses data! if you want to throw an exception
+```ruby
+begin
+  result = MySingleAction.new.call(1,2).data!
+rescue SingleActionService::InvalidResult => e
+  {
+    error_code: e.result.error_code,
+    data: e.result.data
+  }
+end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/single_action_service. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sequenia/single_action_service. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the SingleActionService project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/single_action_service/blob/master/CODE_OF_CONDUCT.md).

data/lib/single_action_service/exceptions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SingleActionService
+  class Error < StandardError; end
+
+  class InvalidResult < ArgumentError
+    attr_reader :result
+
+    def initialize(result)
+      @result = result
+    end
+  end
+end

data/lib/single_action_service/result.rb

@@ -15,5 +15,11 @@ module SingleActionService
     def error?
       !success?
     end
+
+    def data!
+      return data if success?
+
+      raise InvalidResult.new(self)
+    end
   end
 end

data/lib/single_action_service/version.rb

@@ -1,3 +1,3 @@
 module SingleActionService
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/single_action_service.rb

@@ -1,7 +1,7 @@
+require "single_action_service/exceptions"
 require "single_action_service/base"
 require "single_action_service/result"
 require "single_action_service/version"
 
 module SingleActionService
-  class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: single_action_service
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bazov Peter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2020-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - bin/setup
 - lib/single_action_service.rb
 - lib/single_action_service/base.rb
+- lib/single_action_service/exceptions.rb
 - lib/single_action_service/result.rb
 - lib/single_action_service/version.rb
 - single_action_service.gemspec
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Single Action Service