command_service_object 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa75461af29202c5201ee4bf51357b26eb76a9d89401499fe28eb2ce57a26460
-  data.tar.gz: 25b955a98a36b653a64c28a7c2adc517ce39f8d2a8fe31216fea3e72c14654e9
+  metadata.gz: 71a2cbd62d96248cddea4dc3cfbdeb6f07d1d43b62582eb573ca3e689322af01
+  data.tar.gz: 333ecebd2230edf5c67967d4fcfd526a81e0f51d50111ca95f264c543ae12d14
 SHA512:
-  metadata.gz: 3cdc7896788d8e66861ec9fed7f63c0b8a68ee15408d227af8174cea3914c6a351c7f99aeb31c340b595bca07df77c7ef0bef09bbbd5af7829634ed352e613b4
-  data.tar.gz: 41f52ac46e60b75966e210ab33a5363d5879a3adfa4ad8cd88d856bf0454adf2103c0dada86c2d260d81ab4821f562790c9d19e0b841449f14f2304837ea9551
+  metadata.gz: af30bd8432c0a1a045c152992e038381f64dc5cbd8882aff7bcc483ad8e5e86d24768df660c8502d2afeb2fad756f75edaeb9e12f28c67c40b604ff289906b42
+  data.tar.gz: dcace53060dc60e462025ca5dcb3d6ca93e440fc5f1ada54e587103ce18a6a35aa4dc50705a109d605c72212b8ec96600d1629edfd9d3cc39536568e0c147732

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    command_service_object (0.5.10)
+    command_service_object (0.5.11)
       virtus (~> 1.0, >= 1.0.5)
 
 GEM

data/README.md

@@ -2,21 +2,27 @@
 
 Rails Generator for command service object.
 
-### Theory:
+## Theory
+
 [Command Design Pattern](https://en.wikipedia.org/wiki/Command_pattern) consists of `Command Object` and `Service Object` (Executor), Command object is responsible for containing `Client` requests and run input validations on it to ensure that the request is valid and set default values, then `Service Object` applies the business logic on that command.
 
-### Implementation:
-Service consists of several objects { `Command Object` ` Usecase Object`   And `Error Object` (business logic error) }.
+### Implementation
+
+Service consists of several objects { `Command Object` `Usecase Object`   And `Error Object` (business logic error) }.
 
 - **Command Object:** the object that responsible for containing `Client` requests and run input validations it's implemented using [Virtus](https://github.com/solnic/virtus) gem and can use `activerecord` for validations and it's existed under `commands` dir.
 - **Usecase Object:** this object responsible for executing the business logic, Every `usecase` should execute one command type only so that command name should be the same as usecase object name, usecase object existed under 'usecases` dir.
-- **Error Object:** business logic errors existed user `errors` dir inside the service dir.
+- **Micros:** small reusable logic under the same service.
+
+#### Result Object
 
-#### Result Object:
-In case of  successful or failure `ApplicationService` the responsible object for all services will return `service_result` object this object contain `value!` method  containing successful call result, and `errors` method containing failure `errors` objects.
+In case of successful or failure `ApplicationService` the responsible object for all services will return `service_result` object this object contain `value!` method containing successful call result, and `errors` method containing failure `errors` objects.
 
-> You can check if the result successful or not by using `ok?` method. 
+#### Business Logic Failures
 
+To raise bussiness logic failures you can use `fail!` helper method with `message: String, extra_data: Hash` arguments.
+
+> You can check if the result successful or not by using `ok?` method.
 
 ## Installation
 
@@ -25,49 +31,69 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'command_service_object'
 ```
+
 And then execute:
 
-    $ bundle
+  `bundle`
 
 Or install it yourself as:
 
-    $ gem install command_service_object
+  `gem install command_service_object`
 
 Next, you need to run the generator:
 
-```bash
-$ rails generate service:install
-```
+  `rails generate service:install`
 
 ## Usage
 
-    $ rails g service [service_name] [usecases usecases]
-### Generate Service ex:
+  $ rails g service [service_name] [usecases usecases]
+
+### Generate Service ex
 
-    $ rails g service auth login
+  $ rails g service auth login
 output
 
 ```bash
 app/services/
 ├── application_service.rb
+├── external/
 ├── auth_service
 │   ├── commands
 │   │   └── login.rb
 │   └── usecases
 │       ├── login.rb
-│       ├── login.rb
 │       └── micros
-│           └── user_profile_image.rb
 ├── case_base.rb
 └── service_result.rb
 ```
 
-### Generate micros ex:
+### Generate micros ex
 
-    $ rails g service:micro auth user_profile_image
+  $ rails g service:micro auth generate_jwt_token_for
+
+```bash
+app/services/
+├── auth_service
+│   └── usecases
+│       └── micros
+│           └── generate_jwt_token_for.rb
+```
+
+```ruby
+# app/services/auth_service/usecases/micros/generate_jwt_token_for.rb
+
+module PaymentService::Usecases::Micros
+  class GenerateJwtTokenFor < CaseBase
+    def call
+        # <Payload>
+    end
+  end
+end
+```
 
 then you can edit command params
 > you can read [Virtus gem docs](https://github.com/solnic/virtus) for more info. 
+
 ```ruby
 # app/services/auth_service/commands/login.rb
 # frozen_string_literal: true
@@ -87,7 +113,9 @@ module AuthService::Commands
   end
 end
 ```
+
 and then add your business logic
+
 ```ruby
 # app/services/auth_service/usecases/login.rb
 # frozen_string_literal: true
@@ -95,14 +123,13 @@ and then add your business logic
 module AuthService::Usecases
   class Login < CaseBase
     include CommandServiceObject::Hooks
-    micros :user_profile_image
+    micros :generate_jwt_token_for
     #
     # Your business logic goes here, keep [call] method clean by using private
     # methods for Business logic.
     #
     def call
-      result  = user_profile_image(image_url) # set user profile image ex.
-      balance = user_balance # get user balance ex.
+      token = generate_jwt_token_for(user)
     end
 
     # This method will run if call method raise error
@@ -117,10 +144,33 @@ module AuthService::Usecases
       end
   end
 end
+```
 
+### External APIs or Services
+
+You can wrap external apis or services under `external/` dir
+
+#### ex
+
+```ruby
+module External
+  class StripeService
+    class << self
+      def charge(customer:, amount:, currency:, description: nil)
+        Stripe::Charge.create(
+          customer:    customer.id,
+          amount:      (round_up(amount, currency) * 100).to_i,
+          description: description || customer.email,
+          currency:    currency
+        )
+      end
+    end
+  end
+end
 ```
 
 usage from controller
+
 ```ruby
 class AuthenticationController < ApplicationController
   default_service :auth_service

data/lib/command_service_object.rb

@@ -5,7 +5,7 @@ require 'command_service_object/helpers/model_helper'
 require 'command_service_object/helpers/controller_helper'
 require 'command_service_object/helpers/failure_helper'
 require 'command_service_object/hooks'
-require_dependency 'virtus'
+require 'virtus'
 
 if defined?(Rails) && Rails::VERSION::STRING >= '3.0'
   require 'command_service_object/railtie'

data/lib/command_service_object/helpers/controller_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/all'
+
 module CommandServiceObject
   module ControllerHelper
     def self.included(base)

data/lib/command_service_object/hooks.rb

@@ -26,32 +26,22 @@ module CommandServiceObject
         _called_micros.reverse_each(&:rollback)
       end
 
-      def setup_getters(getters)
-        getters.each do |getter|
-          method_name = getter.name.split('::').last.underscore
-
-          define_singleton_method(method_name) do |_payload|
-            getter.new.call(args)
-          end
-        end
-      end
-
       def setup_micros(micros)
         micros.each do |micro|
           method_name = micro.name.split('::').last.underscore
 
           # unrollable micros
-          define_singleton_method("#{method_name}!") do |payload|
-            micro.new(payload).call
+          define_singleton_method("#{method_name}!") do |cmd|
+            micro.new(cmd).call
           end
 
           # rollable micros
-          define_singleton_method(method_name) do |payload|
-            obj = micro.new(payload)
-            obj.call
+          define_singleton_method(method_name) do |cmd|
+            obj = micro.new(cmd)
+            result = obj.call
 
             _called_micros << obj
-            obj
+            result
           end
         end
       end

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '0.5.10'.freeze
+  VERSION = '0.5.11'.freeze
 end

data/lib/generators/service/install/templates/services/application_service.rb

@@ -6,24 +6,26 @@ class ApplicationService
       raise Errors::InvalidCommand, cmd.class if cmd.invalid?
 
       usecase = usecase_for(cmd).new(cmd)
-      usecase.call
+      result  = ServiceResult.new { usecase.call }
+
+      rollback(usecase, result, cmd) if result.error.present?
+      result
     rescue StandardError => e
-      if usecase
-        usecase.rollback_micros
-        usecase.rollback
-      end
-      handle_failure(e)
-      raise e
+      log_errors(e, cmd)
+      ServiceResult.new { raise e }
+    end
+
+    def rollback(usecase, result, cmd)
+      usecase.rollback_micros
+      usecase.rollback
+      log_errors(result.error, cmd)
     end
 
-    def handle_failure(failure)
-      # don't log custom failures if you want :D
-      return if failure.class.is_a?(CommandServiceObject::Failure)
-      #
+    def log_errors(err, _cmd)
+      return if err.class.is_a?(CommandServiceObject::Failure)
       # Add your logging logic
       # ex:
-      #   Rollbar.error(failure)
-      #
+      #   Rollbar.error(err)
     end
 
     private

data/lib/generators/service/install/templates/services/case_base.rb

@@ -3,10 +3,11 @@
 class CaseBase
   include CommandServiceObject::FailureHelper
 
-  attr_reader :payload
+  attr_reader :cmd
+  alias_attribute :payload, :cmd
 
-  def initialize(payload)
-    @payload = payload
+  def initialize(cmd)
+    @cmd = cmd
   end
 
   def rollback; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Adham EL-Deeb
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2019-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler