command_service_object 0.6.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8ab15141c6bc3153127d058369fdc2b0aed2f0f91ccd65a3bac690de01ccde
-  data.tar.gz: f63cb499ebc6472cbfc37d82962c1e59672589c25a7e48e122f056e0ad1947b9
+  metadata.gz: f443a5cc09eca1c23b649f3662cf4fa1ee4ee3203f8b5869fddb0847ebc5c090
+  data.tar.gz: 0e2188106ea26d10dada611fb620a113147d598ef8775abce191a7c2cc6df2b9
 SHA512:
-  metadata.gz: 55f4a339b73e771c011788148001407e64189993163c4ffd0702d776131438ce061c860797d0871e4e46a6e6432518894ce83d642527d10ed655c5c6aed7063d
-  data.tar.gz: da257195f7ec587c14ad74607efb1a85608098f8c17a63e47bd6df6cad26d1566a1ab94067bd4341d93d70ecd166b08f1ed8c7b4df8a323dc46487bf3a4dfbf0
+  metadata.gz: 5f9cb881156fcf6fd2393bdc5fd76399aa0d7b61d6c330c587c79ac22acb390f8ff1b07fbc79a73408edbd2f370306191420ebf29e8e35b0b90991530599805c
+  data.tar.gz: d742ef303630b50c26c07498d2557af1a593e20690544a617df4f416390cebbdb9fef6e8d2be5d0de94e51f6467a30e13a6bfa2ec35f7fb179cfb2750d034d6e

data/Gemfile.lock

@@ -1,135 +1,148 @@
 PATH
   remote: .
   specs:
-    command_service_object (0.6.3)
+    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.3'.freeze
+  VERSION = '1.1.1'.freeze
 end

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

@@ -12,15 +12,26 @@ 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 = "app/services/#{service_name}/commands/#{m.underscore}.rb"
+        template 'command.rb.erb', path unless options.skip_command?
+      end
+
+      def create_test(m)
+        path = "spec/services/#{service_name}/commands/#{m.underscore}_spec.rb"
+        template 'command_spec.rb.erb', path
+      end
+
       def service_name
         "#{name.underscore}_service"
       end

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

@@ -0,0 +1,30 @@
+require_relative '../setup/setup_generator.rb'
+
+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 = "app/services/#{service_name}/entities/#{m.underscore}.rb"
+          template 'entity.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/entity/templates/entity.rb.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Entities
+  class <%= @entity %>
+    include Virtus.model(nullify_blank: true)
+
+    # attribute :name, String
+  end
+end

data/lib/generators/service/external/external_generator.rb

@@ -0,0 +1,37 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class ExternalGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :externals, type: :array, default: [], banner: 'external external'
+
+      def create_externals
+        invoke Service::Generators::SetupGenerator, [name]
+
+        externals.each do |m|
+          @external = m.classify
+          create_main(m)
+          create_test(m)
+        end
+      end
+
+      private
+
+      def create_main(m)
+        path = "app/services/#{service_name}/externals/#{m.underscore}.rb"
+        template 'external.rb.erb', path
+      end
+
+      def create_test(m)
+        path = "spec/services/#{service_name}/externals/#{m.underscore}_spec.rb"
+        template 'external_spec.rb.erb', path
+      end
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/external/templates/external.rb.erb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Externals
+  module <%= @external %>
+    extend self
+
+    # Example
+    # def balance(id)
+    #   res = http.get("user/:id")
+    #   res_as_json = JSON.parse(res.body)
+    #
+    #   The return value should only be OpenStruct or Hash Object
+    #   OpenStruct.new(user_id: res_as_json[:id], balance: res_as_json[:balance])
+    # end
+  end
+end

data/lib/generators/service/external/templates/external_spec.rb.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe <%= service_name.classify %>::Externals::<%= @external %> do
+  # Example
+  # context "when success" do
+  #   it 'should be okay?' do
+  #     expect(subject.[method_name]).to eql([result])
+  #   end
+  # end
+end

data/lib/generators/service/install/templates/initializer.rb

@@ -1,3 +1,8 @@
+require 'hutch'
+
+Hutch::Logging.logger = Rails.logger
+Hutch.connect
+
 CommandServiceObject.configure do |config|
   # By setting the append_controller_helper to false you will need to
   # manually include the CommandServiceObject::ServiceControllerHelper

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

@@ -2,38 +2,79 @@
 
 class ApplicationService
   class << self
+    attr_reader :cmd, :usecase, :bm, :result
+
     def call(cmd)
-      raise Errors::InvalidCommand, cmd.class if cmd.invalid?
+      @cmd = cmd
+      @bm = Benchmark.measure do
+        raise Errors::InvalidCommand, cmd.class if cmd.invalid?
+
+        @usecase = usecase_class.new(cmd)
+        raise Errors::NotAuthorizedError, cmd.class unless usecase.allowed?
 
-      usecase = usecase_for(cmd).new(cmd)
-      raise Errors::NotAuthorizedError, cmd.class unless usecase.allowed?
+        @result = ServiceResult.new { usecase.call }
 
-      result = ServiceResult.new { usecase.call }
+        rollback if result.error.present?
+      end
 
-      rollback(usecase, result, cmd) if result.error.present?
+      log_command
       result
     rescue StandardError => e
-      log_errors(e, cmd)
-      ServiceResult.new { raise e }
+      ServiceResult.new { raise e }      
     end
 
-    def rollback(usecase, result, cmd)
+    def rollback
       usecase.rollback_micros
       usecase.rollback
-      log_errors(result.error, cmd)
+      log_errors(result.error)
     end
 
-    def log_errors(err, _cmd)
-      return if err.class.is_a?(CommandServiceObject::Failure)
-      # Add your logging logic
-      # ex:
-      #   Rollbar.error(err)
+    private
+
+    def log_command
+      service_logger = ActiveSupport::Logger.new(Rails.root.join('log', 'services.log').to_s)
+      service_logger.formatter = proc do |severity, datetime, progname, msg|
+        "[#{msg['usecase']}] [#{msg['status']}] [#{datetime.to_s(:db)} ##{Process.pid}] -- #{msg['body']}\n"
+      end
+      log_body = result.ok? ? success_log : failure_log
+
+      service_logger.info(log_body)
     end
 
-    private
+    def success_log
+      {
+        usecase: "#{service_name}::#{usecase_name}",
+        status: 'success',
+        body: {
+            cmd: cmd.as_json,
+            result: result.value!.as_json,
+            benchmark: bm.as_json
+          }
+      }.as_json
+    end
 
-    def usecase_for(cmd)
+    def failure_log
+      {
+        usecase: "#{service_name}::#{usecase_name}",
+        status: 'faild',
+        body: {
+          cmd: cmd.as_json,
+          error: result.error.to_s,
+          benchmark: bm.as_json
+        }
+      }.as_json
+    end
+
+    def usecase_class
       cmd.class.name.gsub('Commands', 'Usecases').constantize
     end
+
+    def service_name
+      cmd.class.name.split('::').first
+    end
+
+    def usecase_name
+      cmd.class.name.split('::').last
+    end
   end
 end

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

@@ -1,14 +1,27 @@
 # frozen_string_literal: true
 
+require 'hutch'
+
 class CaseBase
-  include CommandServiceObject::FailureHelper
   include CommandServiceObject::Hooks
+  include CommandServiceObject::FailureHelper
+  include CommandServiceObject::CheckHelper
 
-  attr_reader :cmd
+  attr_reader :cmd, :issuer, :right_name
   alias_attribute :payload, :cmd
 
   def initialize(cmd)
     @cmd = cmd
+    @issuer = cmd.try(:issuer)
+    @right_name = "#{service_name}.#{case_name}"
+  end
+
+  def case_name
+    self.class.name.split('::').last.downcase
+  end
+
+  def service_name
+    self.class.name.split('::').first.remove('Service').downcase
   end
 
   def allowed?

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

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 class CommandBase
-  include Virtus.model
   include ActiveModel::Validations
+  include Virtus.model(nullify_blank: true)
 
   # if you need to enable policies add issuer attribute
-  # attribute :issuer, User
-  # validates :issuer, presence: true
+  attribute :issuer, Object, default: :default_issuer
+
+  private
+
+  def default_issuer
+    nil
+  end
 end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'hutch'
+
+class ListenerBase < SimpleDelegator
+  include Hutch::Consumer
+end

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

@@ -0,0 +1,55 @@
+require "active_record"
+
+class QueryBase
+  RelationRequired = Class.new(StandardError)
+
+  def initialize(*args)
+    @options = args.extract_options!
+    @relation = args.first || base_relation
+
+    if relation.nil?
+      raise(
+        RelationRequired,
+        "Queries require a base relation defined. Use .queries method to define relation."
+      )
+    elsif !relation.is_a?(ActiveRecord::Relation)
+      raise(
+        RelationRequired,
+        "Queries accept only ActiveRecord::Relation as input"
+      )
+    end
+  end
+
+  def self.call(*args)
+    new(*args).query
+  end
+
+  def self.queries(subject)
+    self.base_relation = subject
+  end
+
+  def base_relation
+    return nil if self.class.base_relation.nil?
+
+    if self.class.base_relation.is_a?(ActiveRecord::Relation)
+      self.class.base_relation
+    elsif self.class.base_relation < ActiveRecord::Base
+      self.class.base_relation.all
+    end
+  end
+
+  private
+
+  class << self
+    attr_accessor :base_relation
+  end
+
+  attr_reader :relation, :options
+
+  def query
+    raise(
+      NotImplementedError,
+      "You need to implement #query method which returns ActiveRecord::Relation object"
+    )
+  end
+end

data/lib/generators/service/listener/listener_generator.rb

@@ -0,0 +1,30 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class ListenerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :listeners, type: :array, default: [], banner: 'Listener Listener'
+
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
+
+      def create_micros
+        listeners.each do |m|
+          @listener = m.classify
+
+          path = "app/services/#{service_name}/listeners/#{m.underscore}.rb"
+          template 'listener.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/listener/templates/listener.rb.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Listeners
+  class <%= @listener %> < ListenerBase
+    consume 'channel name'
+
+    def process(message)
+      # Logic
+    end
+  end
+end

data/lib/generators/service/query/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This will generatet query_object under [service_name]/queries
+
+Example:
+    rails generate service:query [service name] [query name]
+
+    This will create:
+        services/[service_name]/queries/[query_name].rb

data/lib/generators/service/query/query_generator.rb

@@ -0,0 +1,30 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class QueryGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :queries, type: :array, default: [], banner: 'query query'
+
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
+
+      def create_queries
+        queries.each do |m|
+          @query = m.classify
+
+          path = "app/services/#{service_name}/queries/#{m.underscore}.rb"
+          template 'query.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/query/templates/query.rb.erb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Queries
+  class <%= @query %> < QueryBase
+    # queries UserService::Models::User
+
+    # Example
+    # def query
+    #   map_rows(relation.where(phone: options.fetch(:phone)))
+    # end
+
+    private
+
+    # def map_rows(rows)
+    #   rows.map { |r| UserService::Views::User.new(r.as_json).to_hash }
+    # end
+
+    # def map_row(r)
+    #   UserService::Views::User.new(r.as_json).to_hash
+    # end
+  end
+end

data/lib/generators/service/service_generator.rb

@@ -4,7 +4,6 @@ require 'rubygems'
 require_relative './setup/setup_generator.rb'
 require_relative './usecase/usecase_generator.rb'
 require_relative './command/command_generator.rb'
-require_relative './test/test_generator.rb'
 require 'rails/generators'
 require 'rails/generators/model_helpers'
 
@@ -16,6 +15,7 @@ module Service
       # Skiping options
       class_option :skip_usecase, type: :boolean, default: false, aliases: '-U'
       class_option :skip_command, type: :boolean, default: false, aliases: '-C'
+      class_option :skip_entity,  type: :boolean, default: false, aliases: '-E'
       class_option :skip_test,    type: :boolean, default: false, aliases: '-T'
 
       def install_if_not
@@ -39,12 +39,6 @@ module Service
 
         invoke Service::Generators::CommandGenerator, [name, usecases]
       end
-
-      def generate_tests
-        return if options.skip_test?
-
-        invoke Service::Generators::TestGenerator, [name, usecases]
-      end
     end
   end
 end

data/lib/generators/service/setup/setup_generator.rb

@@ -1,13 +1,23 @@
 module Service
   module Generators
     class SetupGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
       def setup
         return if File.exist?("app/services/#{service_name}")
 
         empty_directory("app/services/#{service_name}")
+        empty_directory("app/services/#{service_name}/listeners")
+        empty_directory("app/services/#{service_name}/jobs")
+        empty_directory("app/services/#{service_name}/externals")
+        empty_directory("app/services/#{service_name}/queries")
         empty_directory("app/services/#{service_name}/usecases")
         empty_directory("app/services/#{service_name}/commands")
+        empty_directory("app/services/#{service_name}/entities")
         empty_directory("app/services/#{service_name}/usecases/micros")
+
+        path = "app/services/#{service_name}/doc.md"
+        template 'doc.md.erb', path unless File.exist?(path)
       end
 
       private

data/lib/generators/service/setup/templates/doc.md.erb

@@ -0,0 +1,39 @@
+## <%= service_name.classify %>
+The authorization system is responsible for identifying a particular user.
+
+### Database Tables
+- users
+- profiles
+
+### Entities:
+###### *Many objects are not fundamentally defined by their attributes, but rather by a thread of continuity and identity.*
+- User
+  - name: string
+  - email: string
+  - phone: string
+  - Profile:
+    - address: string
+    - foo: boolean
+    - bar: int
+
+### Usecases (Processes):
+###### *Use Cases focus on Users, Actions, and Processes.*
+- **[Login](login-uml-and-full-doc)** - the process for authorization, we write out to the user an authentication key for a month. Only a user with a verified phone and email address can authenticate.
+- **[Logout](logout-uml-and-full-doc)** - After logging out, the user will need to log in again to access the system.
+
+### Queries:
+- FindByEmail(email: string)
+- FindByName(name: string)
+
+### Listeners:
+###### *An event listener that waits for an event outside the service to occur.*
+- order_status
+
+### Externals:
+###### *Wrapper for any external interactions.*
+- **UserService**
+  - user_info(id: id)
+- **Stripe** - payment gateway wrapper.
+  - charge(pid, amount, currency)
+  - refund(charge_id)
+  - create_customer(email, phone, name)

data/lib/generators/service/usecase/templates/usecase.rb.erb

@@ -7,7 +7,17 @@ module <%= service_name.classify %>::Usecases
     # methods for Business logic.
     #
     def call
+      # Use check! for business logic validation,
+      # If the given block returns false then it will raise a business logic failure with the given message.
+      # Ex: check!("user should not have any active cards") { cmd.issuer.active_cards.empty? }
+
       replace_me
+
+      output
+    end
+
+    def output
+      # return entity object
     end
 
     # This method will run if call method raise error
@@ -24,10 +34,14 @@ module <%= service_name.classify %>::Usecases
       true
     end
 
+    def broadcast
+      Hutch.publish('<%= service_name %>', action: '<%= "#{@usecase.underscore}" %>', subject: {})
+    end
+
     private
 
-      def replace_me
-        # [business logic]
-      end
+    def replace_me
+      # [business logic]
+    end
   end
 end

data/lib/generators/service/usecase/usecase_generator.rb

@@ -12,13 +12,23 @@ module Service
 
         usecases.each do |u|
           @usecase = u.classify
-          path = "app/services/#{service_name}/usecases/#{u.underscore}.rb"
-          template 'usecase.rb.erb', path
+          create_main(u)
+          create_test(u)
         end
       end
 
       private
 
+      def create_main(m)
+        path = "app/services/#{service_name}/usecases/#{m.underscore}.rb"
+        template 'usecase.rb.erb', path unless options.skip_command?
+      end
+
+      def create_test(m)
+        path = "spec/services/#{service_name}/usecases/#{m.underscore}_spec.rb"
+        template 'usecase_spec.rb.erb', path
+      end
+
       def service_name
         "#{name.underscore}_service"
       end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 1.1.1
 platform: ruby
 authors:
 - Adham EL-Deeb
 - Mohamed Diaa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,14 +79,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: hutch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: command_service_object gem helps you to generate service and command
   objects using rails generator.
 email:
@@ -148,16 +162,25 @@ files:
 - lib/command_service_object.rb
 - lib/command_service_object/configuration.rb
 - lib/command_service_object/failure.rb
+- lib/command_service_object/helpers/check_helper.rb
 - lib/command_service_object/helpers/controller_helper.rb
 - lib/command_service_object/helpers/failure_helper.rb
 - lib/command_service_object/helpers/model_helper.rb
 - lib/command_service_object/hooks.rb
 - lib/command_service_object/railtie.rb
 - lib/command_service_object/version.rb
+- lib/generators/.DS_Store
 - lib/generators/service/USAGE
 - lib/generators/service/command/USAGE
 - lib/generators/service/command/command_generator.rb
 - lib/generators/service/command/templates/command.rb.erb
+- lib/generators/service/command/templates/command_spec.rb.erb
+- lib/generators/service/entity/entity_generator.rb
+- lib/generators/service/entity/templates/entity.rb.erb
+- lib/generators/service/external/external_generator.rb
+- lib/generators/service/external/templates/external.rb.erb
+- lib/generators/service/external/templates/external_spec.rb.erb
+- lib/generators/service/external/templates/external_test.rb.erb
 - lib/generators/service/getter/getter_generator.rb
 - lib/generators/service/getter/templates/getter.rb.erb
 - lib/generators/service/install/install_generator.rb
@@ -165,19 +188,22 @@ files:
 - lib/generators/service/install/templates/services/application_service.rb
 - lib/generators/service/install/templates/services/case_base.rb
 - lib/generators/service/install/templates/services/command_base.rb
+- lib/generators/service/install/templates/services/listener_base.rb
+- lib/generators/service/install/templates/services/query_base.rb
 - lib/generators/service/install/templates/services/service_result.rb
+- lib/generators/service/listener/listener_generator.rb
+- lib/generators/service/listener/templates/listener.rb.erb
 - lib/generators/service/micro/micro_generator.rb
 - lib/generators/service/micro/templates/micro.rb.erb
-- lib/generators/service/policies.rb
+- lib/generators/service/query/USAGE
+- lib/generators/service/query/query_generator.rb
+- lib/generators/service/query/templates/query.rb.erb
 - lib/generators/service/service_generator.rb
 - lib/generators/service/setup/setup_generator.rb
-- lib/generators/service/test/USAGE
-- lib/generators/service/test/templates/minitest/usecase.rb.erb
-- lib/generators/service/test/templates/rspec/command.rb.erb
-- lib/generators/service/test/templates/rspec/usecase.rb.erb
-- lib/generators/service/test/test_generator.rb
+- lib/generators/service/setup/templates/doc.md.erb
 - lib/generators/service/usecase/USAGE
 - lib/generators/service/usecase/templates/usecase.rb.erb
+- lib/generators/service/usecase/templates/usecase_spec.rb.erb
 - lib/generators/service/usecase/usecase_generator.rb
 homepage: https://github.com/adham90/command_service_object
 licenses:
@@ -202,8 +228,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Rails Generator for command service object.
 test_files: []

data/lib/generators/service/policies.rb

@@ -1,5 +0,0 @@
-class
-  def initialize(*args)
-
-  end
-end

data/lib/generators/service/test/USAGE

@@ -1,8 +0,0 @@
-Description:
-    Explain the generator
-
-Example:
-    rails generate service Thing
-
-    This will create:
-        what/will/it/create

data/lib/generators/service/test/templates/minitest/usecase.rb.erb

@@ -1 +0,0 @@
-# frozen_string_literal: true

data/lib/generators/service/test/test_generator.rb

@@ -1,72 +0,0 @@
-require_relative '../setup/setup_generator.rb'
-
-module Service
-  module Generators
-    class TestGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('templates', __dir__)
-      argument :tests, type: :array, default: [], banner: 'usecase usecase'
-
-      def generate_test
-        return if options.skip_test?
-
-        if defined?(Minitest)
-          minitest_test
-        elsif defined?(RSpec)
-          rspec_test
-        end
-      end
-
-      private
-
-      def minitest_test
-        dir = create_test_dir('test')
-
-        tests.each do |t|
-          @test = t.classify
-          path  = "#{dir}/usecases/#{t.underscore}_test.rb"
-          template 'minitest/usecase.rb.erb', path
-        end
-      end
-
-      def rspec_test
-        dir = create_test_dir('spec')
-        create_usecase_test(dir)
-        create_command_test(dir)
-      end
-
-      def create_usecase_test(dir)
-        tests.each do |t|
-          @test = t.classify
-          path  = "#{dir}/usecases/#{t.underscore}_spec.rb"
-          template 'rspec/usecase.rb.erb', path
-        end
-      end
-
-      def create_command_test(dir)
-        tests.each do |t|
-          @test = t.classify
-          path  = "#{dir}/commands/#{t.underscore}_spec.rb"
-          template 'rspec/command.rb.erb', path
-        end
-      end
-
-      def create_test_dir(path)
-        test_path    = "#{path}/services"
-        service_test = "#{test_path}/#{service_name}"
-        usecases_path = "#{test_path}/#{service_name}/usecases"
-        commands_path = "#{test_path}/#{service_name}/commands"
-
-        empty_directory(test_path)    unless File.exist?(test_path)
-        empty_directory(service_test) unless File.exist?(service_test)
-        empty_directory(usecases_path) unless File.exist?(usecases_path)
-        empty_directory(commands_path) unless File.exist?(commands_path)
-
-        service_test
-      end
-
-      def service_name
-        "#{name.underscore}_service"
-      end
-    end
-  end
-end