command_service_object 0.6.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607777d2ee7e9e849f063e7728bab3b04e6afd07bd2d7ff9e0d1df56fad42588
-  data.tar.gz: 8de7b00d60f28015668faa36ebbb0a8690a0d7dfff7869b547f9a35afc620522
+  metadata.gz: c58b761fce4de1db245e0074625141f0c803f50f4611b359f3a632b1d04ff05b
+  data.tar.gz: e01ded8f6eb6c98a867da1dadab904ac8b00f37a45e248a033b4a2d6728708e2
 SHA512:
-  metadata.gz: 17ec4ce37e7dafcd7f1b4c4d8bf557a6cdff8216655429043429e35697c5ca953ceb4238e44dc825c995d60846c9765c694abc3c4b7b1743e1b1f342ab2e1722
-  data.tar.gz: 7ae3011a9367531c709daed456598b8fa9a11b9c5192e305f08b81f8d2961d14a1ef7843114ee938e53bbcd575dcc7a8d1a6f55e17d8f813f1615e9a36521dcf
+  metadata.gz: ca1fae4e751ecf83514124c0fa189ff667ce7b180c2fdc531bd2e42365f64c4c55b3b71c0665c4ce137669dc578806044677027c37192d0b554bb766827f6263
+  data.tar.gz: 855ac6338a4660bc2fe704c4b42e9cb9ae9b8f45375b827149f23566d23b16fe566ebbf8d994114319fef56882ad896ce2663168747892ef3acd05b633725feb

data/Gemfile.lock

@@ -1,135 +1,148 @@
 PATH
   remote: .
   specs:
-    command_service_object (0.6.5)
+    command_service_object (1.1.0)
+      hutch (~> 1.0)
       virtus (~> 1.0, >= 1.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.3)
-      actionpack (= 5.2.3)
+    actioncable (5.2.4.4)
+      actionpack (= 5.2.4.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
+    actionmailer (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      actionview (= 5.2.4.4)
+      activejob (= 5.2.4.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
+    actionpack (5.2.4.4)
+      actionview (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+    actionview (5.2.4.4)
+      activesupport (= 5.2.4.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.3)
-      activesupport (= 5.2.3)
+    activejob (5.2.4.4)
+      activesupport (= 5.2.4.4)
       globalid (>= 0.3.6)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
+    activemodel (5.2.4.4)
+      activesupport (= 5.2.4.4)
+    activerecord (5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
       arel (>= 9.0)
-    activestorage (5.2.3)
-      actionpack (= 5.2.3)
-      activerecord (= 5.2.3)
+    activestorage (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activerecord (= 5.2.4.4)
       marcel (~> 0.3.1)
-    activesupport (5.2.3)
+    activesupport (5.2.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    amq-protocol (2.3.2)
     arel (9.0.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
+    builder (3.2.4)
+    bunny (2.15.0)
+      amq-protocol (~> 2.3, >= 2.3.1)
     byebug (9.0.6)
+    carrot-top (0.0.7)
+      json
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     equalizer (0.0.11)
-    erubi (1.8.0)
+    erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.6.0)
+    hutch (1.0.0)
+      activesupport (>= 4.2, < 7)
+      bunny (>= 2.15, < 2.16)
+      carrot-top (~> 0.0.7)
+      multi_json (~> 1.14)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    loofah (2.2.3)
+    json (2.3.1)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
-    mini_mime (1.0.1)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.10.4)
+    minitest (5.14.2)
+    multi_json (1.15.0)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    rack (2.0.7)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.3)
-      actioncable (= 5.2.3)
-      actionmailer (= 5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      activemodel (= 5.2.3)
-      activerecord (= 5.2.3)
-      activestorage (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails (5.2.4.4)
+      actioncable (= 5.2.4.4)
+      actionmailer (= 5.2.4.4)
+      actionpack (= 5.2.4.4)
+      actionview (= 5.2.4.4)
+      activejob (= 5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activerecord (= 5.2.4.4)
+      activestorage (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
       bundler (>= 1.3.0)
-      railties (= 5.2.3)
+      railties (= 5.2.4.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
-    sprockets (3.7.2)
+    rake (13.0.1)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby
@@ -140,8 +153,8 @@ DEPENDENCIES
   command_service_object!
   minitest (~> 5.11, >= 5.11.3)
   rails (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   thor (~> 0.20.3)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -8,19 +8,24 @@ Rails Generator for command service object.
 
 ### Implementation
 
-Service consists of several objects { `Command Object` `Usecase Object`   And `Error Object` (business logic error) }.
+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.
-- **Micros:** small reusable logic under the same service.
+- **[Command](https://en.wikipedia.org/wiki/Command_pattern):** 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:** 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.
+- **Micros:** Small reusable logic under the same service.
+- **Externals:** Simple ruby module works as a service interface whenever you wanna call any external service or even service that lives under the same project you should use it.
+- **Queries:** This dir is the only entry point for you to get any data form a service.
+- **Listeners:** An event listener that waits for an event outside the service to occur.
+- **Entities:** Many objects are not fundamentally defined by their attributes, but rather by a thread of continuity and identity.
 
-#### 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.
 
-#### Business Logic Failures
+### Helpers:
 
-To raise bussiness logic failures you can use `fail!` helper method with `message: String, extra_data: Hash` arguments.
+- Fail: You can use `fail!` helper to raise business logic failures, ex: `fail!('user should not have any active cards')`.
+- Check: To do business logic validations you can use `check!` helper ex: `check!('user should not have any active cards') { user.active_cards.empty? }`, if the given block returns false then it will raise fail! with the given message.
 
 > You can check if the result successful or not by using `ok?` method.
 
@@ -56,8 +61,8 @@ output
 ```bash
 app/services/
 ├── application_service.rb
-├── external/
 ├── auth_service
+│   ├ external/
 │   ├── commands
 │   │   └── login.rb
 │   └── usecases
@@ -99,11 +104,9 @@ then you can edit command params
 # frozen_string_literal: true
 
 module AuthService::Commands
-  class Login
+  class Login < CommandBase
     # You can read Virtus gem doc for more info.
     # https://github.com/solnic/virtus
-    include Virtus.model
-    include ActiveModel::Validations
 
     # Attributes
     # attribute :REPLACE_ME, String
@@ -129,13 +132,29 @@ module AuthService::Usecases
     # methods for Business logic.
     #
     def call
-      token = generate_jwt_token_for(user)
+      token = generate_jwt_token_for(cmd.user)
+      replace_me
+
+      output
+    end
+
+    def output
+      # return entity object
     end
 
     # This method will run if call method raise error
     def rollback
       # rollback logic
     end
+    
+    def allowed?
+      # policies loginc for issuer
+      # ex:
+      #
+      #   return false if issuer.role != :admin
+
+      true
+    end
 
     private
 
@@ -154,16 +173,16 @@ You can wrap external apis or services under `external/` dir
 
 ```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
+  module StripeService
+    extend 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

data/command_service_object.gemspec

@@ -36,8 +36,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug', '~> 9.0.6'
   spec.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.3'
   spec.add_development_dependency 'rails', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'thor', '~> 0.20.3'
 
   spec.add_dependency 'virtus', '~> 1.0', '>= 1.0.5'
+  spec.add_dependency 'hutch', '~> 1.0'
 end

data/lib/command_service_object.rb

@@ -4,6 +4,7 @@ require 'command_service_object/failure'
 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/helpers/check_helper'
 require 'command_service_object/hooks'
 require 'virtus'
 

data/lib/command_service_object/helpers/check_helper.rb

@@ -0,0 +1,9 @@
+module CommandServiceObject
+  module CheckHelper
+    def check!(message, &block)
+      raise "No block given" unless block_given?
+
+      fail!(message) unless block.call
+    end
+  end
+end

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '0.6.5'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/generators/service/command/command_generator.rb

@@ -1,4 +1,5 @@
 require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
 
 module Service
   module Generators
@@ -12,17 +13,36 @@ module Service
       def call
         invoke Service::Generators::SetupGenerator, [name]
         @model_attributes = model_attributes
+
         commands.each do |c|
           @command = c.classify
-          path = "app/services/#{service_name}/commands/#{c.underscore}.rb"
-          template 'command.rb.erb', path unless options.skip_command?
+          create_main(c)
+          create_test(c)
         end
       end
 
       private
 
+      def create_main(m)
+        path = "#{service_path}/commands/#{m.underscore}.rb"
+        template 'command.rb.erb', path
+      end
+
+      def create_test(m)
+        path = "#{spec_path}/commands/#{m.underscore}_spec.rb"
+        template 'command_spec.rb.erb', path
+      end
+
       def service_name
-        "#{name.underscore}_service"
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
       end
     end
   end

data/lib/generators/service/entity/entity_generator.rb

@@ -0,0 +1,39 @@
+require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
+
+module Service
+  module Generators
+    class EntityGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :entities, type: :array, default: [], banner: 'entities entities'
+
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
+
+      def create_micros
+        entities.each do |m|
+          @entity = m.classify
+
+          path = "#{service_path}/entities/#{m.underscore}.rb"
+          template 'entity.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
+      end
+    end
+  end
+end