cats_core 1.0.50 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13a3549ac212c8e869ce5aff6b3508787e75af7afaeadba4b0e99f5476b101e
-  data.tar.gz: d4993f0e36936fc4ed18ae9accca173189056c3cddae7fc2f16704f6509bac80
+  metadata.gz: 20f6349c8a17610b338d05e2fa64a35d76bf0f3737f898ed9ab4d58d76053085
+  data.tar.gz: 74f16a28eaaf4608b0b2d1935331d8837f49cc805511412df57f902c6d421349
 SHA512:
-  metadata.gz: 91d4ba5e59ef7da90cf36d6073d20819496bae612eff73cdeccada481293a956311732201b049da61e84ba1c12b1a7464d636202b101f66a49bcf22146211440
-  data.tar.gz: afdceef95b3321eaea7ebad43bd622b814ef268f97b20c5815af07376fc710b338b74a25bc3e81d6c4b366f00e30e6553c2f2dcc38e84685bc670201ce4e4e13
+  metadata.gz: 1b3dbbd8c4da02cb692bf9eae19d6e653ced98de74f54a6a9cae9c6c0dddbe2dfd7fb7b5ec4d1881445e0cf159a2e093111b2acc25dd72309b2c183ff6f94c5b
+  data.tar.gz: 05ad4779c0d90d975fc172c4c98c6729e3ff45092953408c31f4cdade4b01dae94eaf655dc857d793e6064770a3a44b93127e62b31ee890633871a509998768a

data/app/controllers/cats/core/dispatch_transactions_controller.rb

@@ -0,0 +1,13 @@
+module Cats
+  module Core
+    class DispatchTransactionsController < ApplicationController
+      include Common
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:source_id, :destination_id, :transaction_date, :quantity)
+      end
+    end
+  end
+end

data/app/controllers/cats/core/dispatches_controller.rb

@@ -0,0 +1,75 @@
+module Cats
+  module Core
+    class DispatchesController < ApplicationController
+      include Common
+
+      before_action :set_service, only: %i[create_receipt_authorization approve start search confirm]
+      before_action :set_dispatch, only: %i[approve start confirm]
+
+      def index
+        dispatches = Cats::Core::Dispatch.where(allocation_item_id: params[:id])
+        render json: { success: true, data: serialize(dispatches) }
+      end
+
+      def create
+        dispatch = Cats::Core::Dispatch.new(model_params)
+        dispatch.dispatch_status = Cats::Core::Dispatch::DRAFT
+        dispatch.prepared_by = current_user
+        if dispatch.save
+          render json: { success: true, data: serialize(dispatch) }, status: :created
+        else
+          render json: { success: false, error: dispatch.errors.full_messages[0] }, status: :unprocessable_entity
+        end
+      end
+
+      def create_receipt_authorization
+        allocation_item = Cats::Core::AllocationItem.find(params[:id])
+        dispatch = @service.create_receipt_authorization(
+          params[:reference_no], allocation_item, params[:quantity], params[:remark], current_user
+        )
+        render json: { success: true, data: serialize(dispatch) }
+      end
+
+      def approve
+        dispatch = @service.approve(@dispatch)
+        render json: { success: true, data: serialize(dispatch) }
+      rescue StandardError => e
+        render json: { success: false, error: e.message }
+      end
+
+      def start
+        dispatch = @service.start(@dispatch)
+        render json: { success: true, data: serialize(dispatch) }
+      rescue StandardError => e
+        render json: { success: false, error: e.message }
+      end
+
+      def confirm
+        dispatch = @service.confirm(@dispatch)
+        render json: { success: true, data: serialize(dispatch) }
+      rescue StandardError => e
+        render json: { success: false, error: e.message }
+      end
+
+      def search
+        data = @service.search(current_user, params[:status])
+        render json: { success: true, data: serialize(data) }
+      end
+
+      private
+
+      def set_service
+        @service = DispatchService.new
+      end
+
+      def set_dispatch
+        @dispatch = Cats::Core::Dispatch.find(params[:id])
+      end
+
+      def model_params
+        params.require(:payload).permit(:reference_no, :allocation_item_id, :transporter_id, :plate_no, :driver_name,
+                                        :driver_phone, :quantity, :remark)
+      end
+    end
+  end
+end

data/app/controllers/cats/core/receipts_controller.rb

@@ -0,0 +1,18 @@
+module Cats
+  module Core
+    class ReceiptsController < ApplicationController
+      include Common
+
+      def index
+        receipts = Cats::Core::Receipt.where(dispatch_id: params[:id])
+        render json: { success: true, data: serialize(receipts) }
+      end
+
+      private
+
+      def model_params
+        params.require(:payload).permit(:dispatch_id, :quantity, :commodity_status, :status, :remark, :prepared_by_id)
+      end
+    end
+  end
+end

data/app/controllers/concerns/cats/core/common.rb

@@ -0,0 +1,55 @@
+module Cats
+  module Core
+    module Common
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_clazz
+        before_action :set_object, only: %i[show update]
+      end
+
+      def index
+        data = serialize(@clazz.all)
+        render json: { success: true, data: data }
+      end
+
+      def show
+        render json: { success: true, data: serialize(@obj) }
+      end
+
+      def create
+        obj = @clazz.new(model_params)
+        if obj.save
+          render json: { success: true, data: serialize(obj) }, status: :created
+        else
+          render json: { success: false, error: obj.errors.full_messages[0] }, status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if @obj.update(model_params)
+          render json: { success: true, data: serialize(@obj) }
+        else
+          render json: { success: false, error: @obj.errors.full_messages[0] }, status: :unprocessable_entity
+        end
+      end
+
+      private
+
+      def serialize(data)
+        ActiveModelSerializers::SerializableResource.new(data)
+      end
+
+      def set_clazz
+        @clazz = "Cats::Core::#{controller_name.classify}".constantize
+      end
+
+      def set_object
+        @obj = @clazz.find(params[:id])
+      end
+
+      # This class should be overridden by respective child controllers
+      def model_params; end
+    end
+  end
+end

data/app/models/cats/core/dispatch.rb

@@ -13,6 +13,7 @@ module Cats
       belongs_to :prepared_by, class_name: 'Cats::Core::User'
       belongs_to :transporter
       belongs_to :allocation_item
+      has_many :receipts
 
       validates :reference_no, :plate_no, :driver_name, :driver_phone, :quantity, :commodity_status, presence: true
       validates :dispatch_status, presence: true, inclusion: { in: DISPATCH_STATUSES }

data/app/models/cats/core/receipt.rb

@@ -3,9 +3,10 @@ module Cats
     class Receipt < ApplicationRecord
       # Receipt status
       DRAFT = 'Draft'.freeze
-      ACCEPTED = 'Accepted'.freeze
-      DECLINED = 'Declined'.freeze
-      RECEIPT_STATUSES = [DRAFT, ACCEPTED, DECLINED].freeze
+      CONFIRMED = 'Confirmed'.freeze
+      STACKING = 'Stacking'.freeze
+      STACKED = 'Stacked'.freeze
+      RECEIPT_STATUSES = [DRAFT, CONFIRMED, STACKING, STACKED].freeze
 
       belongs_to :dispatch
       belongs_to :prepared_by, class_name: 'Cats::Core::User'
@@ -14,6 +15,35 @@ module Cats
       validates :quantity, numericality: { greater_than: 0 }
       validates :status, inclusion: { in: RECEIPT_STATUSES }
       validates :commodity_status, inclusion: { in: Cats::Core::Commodity::COMMODITY_STATUSES }
+      validate :validate_dispatch_status, :validate_total_quantity
+
+      delegate(:reference_no, to: :dispatch, prefix: true)
+      delegate(:email, to: :prepared_by, prefix: true)
+
+      def validate_dispatch_status
+        return unless dispatch
+
+        statuses = [Cats::Core::Dispatch::STARTED, Cats::Core::Dispatch::RECEIVED]
+        return if statuses.include?(dispatch.dispatch_status)
+
+        errors.add(:dispatch, 'should be in "Started" state.')
+      end
+
+      def validate_total_quantity
+        return unless dispatch && quantity
+
+        received = dispatch.receipts.sum(:quantity)
+        diff = dispatch.quantity - received
+        if new_record?
+          return if quantity <= diff
+
+          errors.add(:quantity, "total is higher than dispatch quantity (Max = #{diff}).")
+        else
+          return unless diff.negative?
+
+          errors.add(:quantity, "total is higher than dispatch quantity (Max = #{diff.abs}).")
+        end
+      end
     end
   end
 end

data/app/models/cats/core/receipt_transaction.rb

@@ -3,6 +3,8 @@ module Cats
     class ReceiptTransaction < Transaction
       belongs_to :source, class_name: 'Cats::Core::Receipt'
       belongs_to :destination, class_name: 'Cats::Core::Stack'
+
+      delegate(:code, to: :destination, prefix: true)
     end
   end
 end

data/app/models/cats/core/transaction.rb

@@ -12,12 +12,14 @@ module Cats
       validates :transaction_date, :quantity, :status, presence: true
       validates :quantity, numericality: { greater_than: 0 }
       validates :status, inclusion: { in: STATUSES }
-      validate :validate_quantity
+      validate :validate_quantity, unless: :skip_quantity_validation
 
       def validate_quantity
         return unless quantity.present? && source.present?
 
-        errors.add(:quantity, 'cannot be more than source quantity') if quantity > source.quantity
+        total = self.class.where(source: source).sum(:quantity)
+        diff = source.quantity - total
+        errors.add(:quantity, "total is higher than source quantity (Max = #{diff}).") if quantity > diff
       end
 
       def commit
@@ -27,10 +29,23 @@ module Cats
           source.save
           destination.save
           self.status = COMMITTED
-          save
+          save!
         end
       end
 
+      def skip_quantity_validation
+        # Quantity validation should be skipped if we are commiting transactions.
+        (
+          instance_of?(Cats::Core::DispatchTransaction) &&
+          destination &&
+          destination.dispatch_status == Cats::Core::Dispatch::STARTED
+        ) || (
+          instance_of?(Cats::Core::ReceiptTransaction) &&
+          source &&
+          source.status == Cats::Core::Receipt::STACKING
+        )
+      end
+
       def set_status
         return unless new_record?
 

data/app/serializers/cats/core/dispatch_serializer.rb

@@ -0,0 +1,8 @@
+class DispatchSerializer < ActiveModel::Serializer
+  attributes :id, :reference_no, :allocation_item_id, :transporter_id, :transporter_name, :plate_no, :driver_name,
+             :driver_phone, :quantity, :remark, :prepared_by_id, :prepared_by_email, :dispatch_status, :destination
+
+  def destination
+    object.allocation_item.destination.name
+  end
+end

data/app/serializers/cats/core/dispatch_transaction_serializer.rb

@@ -0,0 +1,4 @@
+class DispatchTransactionSerializer < ActiveModel::Serializer
+  attributes :id, :source_id, :source_code, :destination_id, :destination_reference_no, :quantity, :transaction_date,
+             :status
+end

data/app/serializers/cats/core/receipt_serializer.rb

@@ -0,0 +1,4 @@
+class ReceiptSerializer < ActiveModel::Serializer
+  attributes :id, :dispatch_id, :dispatch_reference_no, :commodity_status, :quantity, :status, :remark,
+             :prepared_by_id, :prepared_by_email
+end

data/app/services/cats/core/dispatch_service.rb

@@ -0,0 +1,136 @@
+module Cats
+  module Core
+    class DispatchService
+      def create_receipt_authorization(reference_no, allocation_item, quantity, remark, user)
+        status = allocation_item.allocation.allocation_status
+        raise(StandardError, 'Allocation not approved.') unless status == Cats::Core::Allocation::APPROVED
+
+        transporter = Cats::Core::Transporter.find_by(code: 'SUP-TRANS')
+        raise(StandardError, 'Supplier transporter does not exist.') unless transporter
+
+        store = Cats::Core::Store.find_by(code: 'SUP-STORE')
+        raise(StandardError, 'Supplier store does not exist.') unless store
+
+        commodity = allocation_item.allocation.commodity
+        stack = store.stacks.find_by(commodity: commodity)
+
+        raise(StandardError, 'Commodity not found in supplier store.') unless stack
+
+        dispatch = Cats::Core::Dispatch.create!(
+          reference_no: reference_no,
+          allocation_item: allocation_item,
+          transporter: transporter,
+          plate_no: 'Supplier plate no',
+          driver_name: 'Supplier driver',
+          driver_phone: 'Supplier driver phone',
+          quantity: quantity,
+          remark: remark,
+          prepared_by: user,
+          dispatch_status: Cats::Core::Dispatch::DRAFT
+        )
+
+        # Create a dispatch transaction
+        Cats::Core::DispatchTransaction.create!(
+          source: stack,
+          destination: dispatch,
+          transaction_date: Date.today,
+          quantity: quantity,
+          status: Cats::Core::Transaction::DRAFT
+        )
+        dispatch
+      end
+
+      def search(user, status)
+        details = user.details
+
+        unless details['stores'] || details['warehouse'] || details['hub']
+          raise(StandardError, 'User does not have associated location.')
+        end
+
+        if details['stores']
+          warehouse = Cats::Core::Store.find(details['stores'][0]).warehouse
+          hub = warehouse.parent
+
+          dispatches = Cats::Core::Dispatch.joins(:allocation_item)
+                                           .where(
+                                             allocation_item: { destination: hub },
+                                             dispatch_status: status
+                                           ).or(
+                                             Cats::Core::Dispatch.joins(:allocation_item)
+                                                                 .where(
+                                                                   allocation_item: { destination: warehouse },
+                                                                   dispatch_status: status
+                                                                 )
+                                           )
+        elsif details['warehouse']
+          warehouse = Cats::Core::Location.find(details['warehouse'])
+          hub = warehouse.parent
+          dispatches = Cats::Core::Dispatch.joins(:allocation_item)
+                                           .where(
+                                             allocation_item: { destination: hub },
+                                             dispatch_status: status
+                                           ).or(
+                                             Cats::Core::Dispatch.joins(:allocation_item)
+                                                                 .where(
+                                                                   allocation_item: { destination: warehouse },
+                                                                   dispatch_status: status
+                                                                 )
+                                           )
+        elsif details['hub']
+          hub = Cats::Core::Location.find(details['hub'])
+          dispatches = Cats::Core::Dispatch.joins(:allocation_item)
+                                           .where(
+                                             allocation_item: { destination: hub },
+                                             dispatch_status: status
+                                           )
+        end
+        dispatches
+      end
+
+      def approve(dispatch)
+        unless dispatch.dispatch_status == Cats::Core::Dispatch::DRAFT
+          raise(StandardError, 'Dispatch has to be in draft state.')
+        end
+
+        transactions = Cats::Core::DispatchTransaction.where(destination: dispatch).count
+        raise(StandardError, 'Dispatch has no transactions.') unless transactions.positive?
+
+        dispatch.dispatch_status = Cats::Core::Dispatch::APPROVED
+        dispatch.save
+        dispatch
+      end
+
+      def start(dispatch)
+        unless dispatch.dispatch_status == Cats::Core::Dispatch::APPROVED
+          raise(StandardError, 'Dispatch has to be approved first.')
+        end
+
+        dispatch.dispatch_status = Cats::Core::Dispatch::STARTED
+        dispatch.save
+        transactions = Cats::Core::DispatchTransaction.where(destination: dispatch)
+        transactions.each(&:commit)
+        dispatch
+      end
+
+      def confirm(dispatch)
+        total = dispatch.receipts.sum(:quantity)
+
+        unless total == dispatch.quantity
+          raise(
+            StandardError,
+            "There is an amount of #{dispatch.quantity - total} in the dispatch which is unaccounted for."
+          )
+        end
+
+        Cats::Core::Dispatch.transaction do
+          dispatch.dispatch_status = Cats::Core::Dispatch::RECEIVED
+          dispatch.receipts.each { |r| r.status = Cats::Core::Receipt::CONFIRMED }
+          dispatch.save
+          dispatch.receipts.each(&:save!)
+        end
+
+        dispatch
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -49,4 +49,22 @@ Cats::Core::Engine.routes.draw do
   end
   resources :currencies, except: %i[destroy]
   resources :unit_of_measures, except: %i[destroy]
+
+  get '/allocation_items/:id/dispatches', controller: :dispatches, action: :index, as: :dispatches_allocation_item
+  post '/allocation_items/:id/receipt_authorizaton',
+       controller: :dispatches,
+       action: :create_receipt_authorization,
+       as: :receipt_authorization_allocation_item
+
+  get '/dispatches/search', controller: :dispatches, action: :search, as: :search_dispatches
+  resources :dispatches, except: %i[index destroy] do
+    member do
+      get 'receipts', controller: :receipts, action: :index
+      post 'approve'
+      post 'start'
+      post 'confirm'
+    end
+  end
+  resources :dispatch_transactions, except: %i[new edit destroy]
+  resources :receipts, except: %i[index new edit destroy]
 end

data/lib/cats/core/version.rb

@@ -1,5 +1,5 @@
 module Cats
   module Core
-    VERSION = '1.0.50'.freeze
+    VERSION = '1.1.3'.freeze
   end
 end

data/spec/factories/cats/core/receipt_transactions.rb

@@ -1,5 +1,5 @@
 FactoryBot.define do
-  factory :receipt_transaction do
+  factory :receipt_transaction, class: 'Cats::Core::ReceiptTransaction' do
     source factory: :receipt
     destination factory: :stack
     transaction_date { Date.today }

data/spec/factories/cats/core/receipts.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :receipt, class: 'Cats::Core::Receipt' do
-    dispatch
-    quantity { 1.5 }
+    dispatch factory: :dispatch, dispatch_status: Cats::Core::Dispatch::STARTED
+    quantity { 50 }
     commodity_status { Cats::Core::Commodity::GOOD }
     status { Cats::Core::Receipt::DRAFT }
     remark { FFaker::Name.name }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cats_core
 version: !ruby/object:Gem::Version
-  version: 1.0.50
+  version: 1.1.3
 platform: ruby
 authors:
 - Henock L.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -220,13 +220,17 @@ files:
 - app/controllers/cats/core/application_controller.rb
 - app/controllers/cats/core/commodity_categories_controller.rb
 - app/controllers/cats/core/currencies_controller.rb
+- app/controllers/cats/core/dispatch_transactions_controller.rb
+- app/controllers/cats/core/dispatches_controller.rb
 - app/controllers/cats/core/locations_controller.rb
 - app/controllers/cats/core/menus_controller.rb
 - app/controllers/cats/core/notifications_controller.rb
+- app/controllers/cats/core/receipts_controller.rb
 - app/controllers/cats/core/roles_controller.rb
 - app/controllers/cats/core/spaces_controller.rb
 - app/controllers/cats/core/unit_of_measures_controller.rb
 - app/controllers/cats/core/users_controller.rb
+- app/controllers/concerns/cats/core/common.rb
 - app/jobs/cats/core/application_job.rb
 - app/models/cats/core/allocation.rb
 - app/models/cats/core/allocation_item.rb
@@ -269,9 +273,13 @@ files:
 - app/notifications/cats/core/simple_notification.rb
 - app/serializers/cats/core/commodity_category_serializer.rb
 - app/serializers/cats/core/currency_serializer.rb
+- app/serializers/cats/core/dispatch_serializer.rb
+- app/serializers/cats/core/dispatch_transaction_serializer.rb
 - app/serializers/cats/core/location_serializer.rb
+- app/serializers/cats/core/receipt_serializer.rb
 - app/serializers/cats/core/role_menu_serializer.rb
 - app/serializers/cats/core/unit_of_measure_serializer.rb
+- app/services/cats/core/dispatch_service.rb
 - app/services/cats/core/menu_service.rb
 - app/services/cats/core/notification_service.rb
 - app/services/cats/core/space_service.rb