cats_core 1.3.27 → 1.3.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1076d840160f1faee39901d7f1d9ccf7926c0413739ebed870a740c66f2e2f08
-  data.tar.gz: cfb54300abc22e4889a0cd75c83c47bf355f089cf84ca7645f743ee65ea4b69a
+  metadata.gz: bf517b4f0fd512472ced053c4f283d19c661fe849c7331163cf6e321ddd5ebe6
+  data.tar.gz: 7b09f3a11ad9ef8d5ded20a2c5e7d4b7b09b1e27a06565462fc5f59d7fed163e
 SHA512:
-  metadata.gz: 6e68a5e3f35ea31220701ca97df067eb03a16983ff8b32431b7a04c415d1ca1ea09b1943149cd098d52b3c704ca2a5ca0b9ca363e2bc3db5a92d1871e2202a11
-  data.tar.gz: 5d90ebf4ed67ee13e9a351e7feea4d90429f6299e40a7349d23faf033ec1a41bcf6aed6c7023bb965451378d28242675c6af099a0d67d331ca053466b624f1c7
+  metadata.gz: '0818b51b0f8b75240043aff989521a71d641be5b4c4a0dc7eec7c47f40643a867c692cdee3faca3adc279503df252a2e2d68d453ec3f7a230f9f06a42d6b537e'
+  data.tar.gz: dfe92285182fd027eb1f0d87186e3a122301c0d611748bb05708d76891e1dc8832b56c0b3ea8ab44adc557a0a3b27b99b6981ae815c4e7331bcce9c44c28d984

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

@@ -55,6 +55,8 @@ module Cats
           @user.add_detail(:warehouse, params[:warehouse_id])
         when 'hub_manager'
           @user.add_detail(:hub, params[:hub_id])
+        when 'regional_manager'
+          @user.add_detail(:region, params[:region_id])
         end
 
         data = ActiveModelSerializers::SerializableResource.new(role)
@@ -64,7 +66,7 @@ module Cats
       def revoke_role
         role = Cats::Core::Role.find(params[:role_id])
         @user.roles.delete(role)
-        @user.remove_detail(role.name) if %w[warehouse_manager hub_manager].include?(role.name)
+        @user.remove_detail(role.name) if %w[warehouse_manager hub_manager regional_manager].include?(role.name)
         data = ActiveModelSerializers::SerializableResource.new(role)
         render json: { success: true, data: data }
       end

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

@@ -1,13 +1,21 @@
 module Cats
   module Core
     class DispatchPlanItem < ApplicationRecord
+      AUTHORIZED = 'Authorized'.freeze
+      SOURCE_AUTHORIZED = 'Source Authorized'.freeze
+      DESTINATION_AUTHORIZED = 'Destination Authorized'.freeze
+      UNAUTHORIZED = 'Unauthorized'.freeze
+      STATUSES = [AUTHORIZED, DESTINATION_AUTHORIZED, SOURCE_AUTHORIZED, UNAUTHORIZED].freeze
+
       belongs_to :source, class_name: 'Cats::Core::Location'
       belongs_to :destination, class_name: 'Cats::Core::Location'
       belongs_to :dispatch_plan
       has_many :dispatches
+      has_many :hub_authorizations
 
-      validates :commodity_status, presence: true, inclusion: { in: Cats::Core::Commodity::COMMODITY_STATUSES }
+      validates :commodity_status, presence: true, inclusion: { in: Commodity::COMMODITY_STATUSES }
       validates :quantity, presence: true, numericality: { greater_than: 0 }
+      validates :status, presence: true, inclusion: { in: STATUSES }
 
       delegate(:reference_no, to: :dispatch_plan, prefix: :plan, allow_nil: true)
       delegate(:commodity_batch_no, :commodity_name, to: :dispatch_plan)
@@ -15,6 +23,63 @@ module Cats
       delegate(:name, to: :destination, prefix: true)
       delegate(:location_type, to: :source, prefix: true)
       delegate(:location_type, to: :destination, prefix: true)
+
+      # Authorize a dispatch plan item if it contains authorization entries
+      # under it. A dispatch plan item can be authorized by source hub, or
+      # source and destination hub. Hence the status can be `SOURCE_AUTHORIZED`,
+      # `AUTHORIZED`, or `UNAUTHORIZED` (default). This method sets those authorization
+      # values without any other interference by looking at available data and therefore
+      # no parameters are required.
+      #
+      def authorize
+        count = hub_authorizations.count
+        raise(StandardError, 'No authorization entries found.') if count.zero?
+
+        source_auth = hub_authorizations.where(authorization_type: HubAuthorization::SOURCE)
+        dest_auth = hub_authorizations.where(authorization_type: HubAuthorization::DESTINATION)
+
+        if source_auth.count.positive? && dest_auth.count.zero? && status == SOURCE_AUTHORIZED
+          raise(
+            StandardError,
+            'Plan item already authorized by source. Destination hub authorizations are required.'
+          )
+        end
+
+        if source_auth.count.zero? && dest_auth.count.positive? && status == DESTINATION_AUTHORIZED
+          raise(
+            StandardError,
+            'Plan item already authorized by destination. Source hub authorizations are required.'
+          )
+        end
+
+        total_src = source_auth.sum(&:quantity)
+        total_dest = dest_auth.sum(&:quantity)
+
+        if source_auth.count == count
+          validate_quantity(total_src, SOURCE_AUTHORIZED)
+          self.status = SOURCE_AUTHORIZED
+        elsif dest_auth.count == count
+          validate_quantity(total_dest, DESTINATION_AUTHORIZED)
+          self.status = DESTINATION_AUTHORIZED
+        else
+          validate_quantity(total_src, SOURCE_AUTHORIZED)
+          validate_quantity(total_dest, DESTINATION_AUTHORIZED)
+          self.status = AUTHORIZED
+        end
+        save!
+        self
+      end
+
+      def validate_quantity(quantity, type)
+        return if quantity == self.quantity
+
+        diff = self.quantity - quantity
+        desc = type.split(' ')[0].downcase
+        raise(
+          StandardError,
+          "Authorized #{desc} quantity is not the same as plan item quantity (#{diff} unaccounted for)."
+        )
+      end
     end
   end
 end

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

@@ -4,12 +4,14 @@ module Cats
       belongs_to :donation, optional: true
       belongs_to :commodity_category
       belongs_to :unit_of_measure
+      belongs_to :destination_warehouse, class_name: 'Cats::Core::Location'
 
       validates :reference_no, presence: true, uniqueness: true
-      validates :gift_date, :quantity, presence: true
+      validates :gift_date, :quantity, :requested_by, :request_reference, presence: true
       validates :quantity, numericality: { greater_than: 0 }
 
       delegate(:name, to: :commodity_category, prefix: true)
+      delegate(:name, to: :destination_warehouse, prefix: true)
       delegate(:abbreviation, to: :unit_of_measure, prefix: true)
 
       before_validation :set_commodity_category

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

@@ -0,0 +1,38 @@
+module Cats
+  module Core
+    class HubAuthorization < ApplicationRecord
+      SOURCE = 'Source'.freeze
+      DESTINATION = 'Destination'.freeze
+      AUTHORIZATION_TYPES = [SOURCE, DESTINATION].freeze
+
+      belongs_to :dispatch_plan_item, optional: true
+      belongs_to :store
+      belongs_to :authorized_by, class_name: 'Cats::Core::User'
+
+      validates :quantity, :authorization_type, presence: true
+      validates :quantity, numericality: { greater_than: 0 }
+      validates :authorization_type, inclusion: { in: AUTHORIZATION_TYPES }
+      validate :validate_quantity, on: %i[create update]
+
+      delegate(:plan_reference_no, to: :dispatch_plan_item)
+      delegate(:full_name, to: :authorized_by, prefix: true)
+      delegate(:name, to: :store, prefix: true)
+
+      def validate_quantity
+        return unless quantity
+
+        return unless dispatch_plan_item
+
+        total = dispatch_plan_item.quantity
+        used = HubAuthorization.where(
+          dispatch_plan_item: dispatch_plan_item,
+          authorization_type: authorization_type
+        ).sum(:quantity)
+        used -= quantity_was if quantity_was
+
+        remaining = total - used
+        errors.add(:quantity, "exceeds allocated quantity. Maximum allowed is #{remaining}") if quantity > remaining
+      end
+    end
+  end
+end

data/db/migrate/20210717032330_create_cats_core_donations.rb

@@ -4,6 +4,7 @@ class CreateCatsCoreDonations < ActiveRecord::Migration[6.1]
       t.string :reference_no, unique: true
       t.string :description
       t.string :donation_type, null: false
+      t.string :shipping_reference
       t.date :donated_on, null: false
       t.string :agency, null: false
       t.references :donor,

data/db/migrate/20210717032602_create_cats_core_gift_certificates.rb

@@ -24,8 +24,15 @@ class CreateCatsCoreGiftCertificates < ActiveRecord::Migration[6.1]
                    null: false,
                    index: { name: 'uom_on_gc_indx' },
                    foreign_key: { to_table: :cats_core_unit_of_measures }
+      t.references :destination_warehouse,
+                   null: false,
+                   index: { name: 'dw_on_gc_indx' },
+                   foreign_key: { to_table: :cats_core_locations }
       t.float :estimated_price
       t.float :estimated_tax
+      t.string :registration_no
+      t.string :requested_by, null: false
+      t.string :request_reference, null: false
 
       t.timestamps
     end

data/db/migrate/20210718043401_create_cats_core_dispatch_plan_items.rb

@@ -15,6 +15,7 @@ class CreateCatsCoreDispatchPlanItems < ActiveRecord::Migration[6.1]
                    foreign_key: { to_table: :cats_core_locations }
       t.float :quantity, null: false
       t.string :commodity_status, null: false, default: 'Good'
+      t.string :status, null: false, default: 'Unauthorized'
 
       t.timestamps
     end

data/db/migrate/20220209083928_create_cats_core_hub_authorizations.rb

@@ -0,0 +1,22 @@
+class CreateCatsCoreHubAuthorizations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :cats_core_hub_authorizations do |t|
+      t.references :dispatch_plan_item,
+                   null: true,
+                   index: { name: 'dpi_on_ha_indx' },
+                   foreign_key: { to_table: :cats_core_dispatch_plan_items }
+      t.references :store,
+                   null: false,
+                   index: { name: 'store_on_ha_indx' },
+                   foreign_key: { to_table: :cats_core_stores }
+      t.float :quantity, null: false
+      t.string :authorization_type, null: false
+      t.references :authorized_by,
+                   null: false,
+                   index: { name: 'ab_on_ha_indx' },
+                   foreign_key: { to_table: :cats_core_users }
+
+      t.timestamps
+    end
+  end
+end

data/lib/cats/core/version.rb

@@ -1,5 +1,5 @@
 module Cats
   module Core
-    VERSION = '1.3.27'.freeze
+    VERSION = '1.3.31'.freeze
   end
 end

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

@@ -5,5 +5,6 @@ FactoryBot.define do
     dispatch_plan
     quantity { 100 }
     commodity_status { Cats::Core::Commodity::GOOD }
+    status { Cats::Core::DispatchPlanItem::UNAUTHORIZED }
   end
 end

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

@@ -3,6 +3,7 @@ FactoryBot.define do
     reference_no { FFaker::Name.name }
     description { FFaker::Name.name }
     donation_type { Cats::Core::Donation::KIND }
+    shipping_reference { FFaker::Name.name }
     donated_on { Date.today }
     agency { 'WFP' }
     donor

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

@@ -5,6 +5,7 @@ FactoryBot.define do
     donation
     commodity_category { donation.commodity_category }
     unit_of_measure
+    destination_warehouse factory: :warehouse
     vessel { FFaker::Name.name }
     port { FFaker::Name.name }
     customs_declaration_no { FFaker::Name.name }
@@ -14,5 +15,8 @@ FactoryBot.define do
     quantity { 1.5 }
     estimated_price { 1.5 }
     estimated_tax { 1.5 }
+    registration_no { FFaker::Name.name }
+    requested_by { FFaker::Name.name }
+    request_reference { FFaker::Name.name }
   end
 end

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

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :hub_authorization, class: 'Cats::Core::HubAuthorization' do
+    dispatch_plan_item
+    store
+    quantity { 100 }
+    authorization_type { Cats::Core::HubAuthorization::SOURCE }
+    authorized_by factory: :user
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cats_core
 version: !ruby/object:Gem::Version
-  version: 1.3.27
+  version: 1.3.31
 platform: ruby
 authors:
 - Henock L.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -267,6 +267,7 @@ files:
 - app/models/cats/core/donation.rb
 - app/models/cats/core/donor.rb
 - app/models/cats/core/gift_certificate.rb
+- app/models/cats/core/hub_authorization.rb
 - app/models/cats/core/location.rb
 - app/models/cats/core/menu.rb
 - app/models/cats/core/menu_item.rb
@@ -391,6 +392,7 @@ files:
 - db/migrate/20220107124630_create_cats_core_monthly_rations.rb
 - db/migrate/20220107125025_create_cats_core_monthly_plan_items.rb
 - db/migrate/20220107132433_create_cats_core_monthly_plan_item_details.rb
+- db/migrate/20220209083928_create_cats_core_hub_authorizations.rb
 - lib/cats/core.rb
 - lib/cats/core/engine.rb
 - lib/cats/core/version.rb
@@ -411,6 +413,7 @@ files:
 - spec/factories/cats/core/donations.rb
 - spec/factories/cats/core/donors.rb
 - spec/factories/cats/core/gift_certificates.rb
+- spec/factories/cats/core/hub_authorizations.rb
 - spec/factories/cats/core/locations.rb
 - spec/factories/cats/core/menu_items.rb
 - spec/factories/cats/core/menus.rb