cats_core 1.3.28 → 1.3.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83f9bfdc22317ca433717055d41463cf8d70aed78994c62a9a924bcead85c561
-  data.tar.gz: ffcb5a3122bd29126aa6902388af57a8979b414fa8378f5bd9f4c364aea6029d
+  metadata.gz: 5ac9b1b8f8a818f2992adf7b2d3fc5ce78340ae1f3ad092c05c90211c52a2d38
+  data.tar.gz: 4e2a4269952f62ac0293ac354fe2d84ca4e894b326a8bce6b65b00aa534242ba
 SHA512:
-  metadata.gz: 5b77e70633822f0dcc6db6caedd36c1f7baecd232b466a1bc975c02b29c32e7129fd6d767e800a5dd1c7b17ff9e2da9250f74d136797591a9c19043b07bddd8d
-  data.tar.gz: 2d29e1087a864c93d57a050f5fa6df3ff993abd63b060604f88bc7d2df282aa94ca5f48e1183b852a2974c1e5c0b36d5fd94082f3517181f1a2023363fb819bb
+  metadata.gz: 26fbde7964902e432c4c08ce116466052732a66d6b592139426276fd33ab872d8ad8431cd86652d3026a7faa7c2799952f2ffa30ae7a2599c8e49f2e89a0d217
+  data.tar.gz: a2097e28a69ea6cdd93f38c58eb8fe7a41e92c2fa5cb0c816e5def3cf7233c53a7d03c7830fa254e17481537be3e82685795f215e50e6ecbed6b949cccb11a01

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/donation.rb

@@ -19,7 +19,7 @@ module Cats
       validates :unit_of_measure, presence: true, if: -> { donation_type == KIND }
 
       delegate(:name, to: :donor, prefix: true)
-      delegate(:reference_no, to: :plan, prefix: true)
+      delegate(:reference_no, to: :plan, prefix: true, allow_nil: true)
       delegate(:name, to: :commodity_category, prefix: true, allow_nil: true)
       delegate(:code, to: :currency, prefix: true, allow_nil: true)
       delegate(:abbreviation, to: :unit_of_measure, prefix: true, allow_nil: true)

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

@@ -11,6 +11,7 @@ module Cats
       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/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.28'.freeze
+    VERSION = '1.3.32'.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/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.28
+  version: 1.3.32
 platform: ruby
 authors:
 - Henock L.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-18 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