Merge pull request #12557 from transcom/MAIN-B-18911-gun-safe-backend

Main b 18911 gun safe backend

migrations/app/migrations_manifest.txt

@@ -919,7 +919,9 @@
 20240402155228_updateLongBeachGbloc.up.sql
 20240402192009_add_shipment_locator_and_shipment_seq_num.up.sql
 20240403172437_backfill_counties_again.up.sql
+20240404152441_add_gun_safe_to_entitlements.up.sql
 20240405190435_add_safety_privilege.up.sql
 20240411201158_add_application_parameter_and_validation_code_table.up.sql
+20240412201837_edit_gun_safe_entitlement_not_null.up.sql
 20240416145256_update_safety_privilege_label.up.sql
 20240503123556_add_diversion_reason_to_mto_shipments.up.sql

migrations/app/schema/20240404152441_add_gun_safe_to_entitlements.up.sql

@@ -0,0 +1,7 @@
+-- Adds new column to entitlements table
+-- allows customer to move a gun safe with their move.
+ALTER TABLE entitlements
+ADD COLUMN IF NOT EXISTS gun_safe BOOLEAN DEFAULT FALSE;
+
+-- Comments on new column
+COMMENT ON COLUMN entitlements.gun_safe IS 'True if customer is entitled to move a gun safe up to 500 lbs without it being charged against their authorized weight allowance.';

migrations/app/schema/20240412201837_edit_gun_safe_entitlement_not_null.up.sql

@@ -0,0 +1,5 @@
+-- COALESCE makes sure that any currently NULL gun_safe values are converted to false before setting to NOT NULL.
+ALTER TABLE entitlements
+ALTER COLUMN gun_safe TYPE boolean USING (COALESCE(gun_safe, false)),
+ALTER COLUMN gun_safe SET DEFAULT false,
+ALTER COLUMN gun_safe SET NOT NULL;

pkg/handlers/ghcapi/internal/payloads/model_to_payload.go

@@ -616,6 +616,7 @@ func Entitlement(entitlement *models.Entitlement) *ghcmessages.Entitlements {
 		totalDependents = int64(*entitlement.TotalDependents)
 	}
 	requiredMedicalEquipmentWeight := int64(entitlement.RequiredMedicalEquipmentWeight)
+	gunSafe := entitlement.GunSafe
 	return &ghcmessages.Entitlements{
 		ID:                             strfmt.UUID(entitlement.ID.String()),
 		AuthorizedWeight:               authorizedWeight,
@@ -629,7 +630,8 @@ func Entitlement(entitlement *models.Entitlement) *ghcmessages.Entitlements {
 		TotalWeight:                    totalWeight,
 		RequiredMedicalEquipmentWeight: requiredMedicalEquipmentWeight,
 		OrganizationalClothingAndIndividualEquipment: entitlement.OrganizationalClothingAndIndividualEquipment,
-		ETag: etag.GenerateEtag(entitlement.UpdatedAt),
+		GunSafe: gunSafe,
+		ETag:    etag.GenerateEtag(entitlement.UpdatedAt),
 	}
 }
 

pkg/handlers/primeapi/payloads/model_to_payload.go

@@ -200,6 +200,7 @@ func Entitlement(entitlement *models.Entitlement) *primemessages.Entitlements {
 		ID:                             strfmt.UUID(entitlement.ID.String()),
 		AuthorizedWeight:               authorizedWeight,
 		DependentsAuthorized:           entitlement.DependentsAuthorized,
+		GunSafe:                        entitlement.GunSafe,
 		NonTemporaryStorage:            entitlement.NonTemporaryStorage,
 		PrivatelyOwnedVehicle:          entitlement.PrivatelyOwnedVehicle,
 		ProGearWeight:                  int64(entitlement.ProGearWeight),

pkg/handlers/primeapiv2/payloads/model_to_payload.go

@@ -147,6 +147,7 @@ func Entitlement(entitlement *models.Entitlement) *primev2messages.Entitlements
 		ID:                             strfmt.UUID(entitlement.ID.String()),
 		AuthorizedWeight:               authorizedWeight,
 		DependentsAuthorized:           entitlement.DependentsAuthorized,
+		GunSafe:                        entitlement.GunSafe,
 		NonTemporaryStorage:            entitlement.NonTemporaryStorage,
 		PrivatelyOwnedVehicle:          entitlement.PrivatelyOwnedVehicle,
 		ProGearWeight:                  int64(entitlement.ProGearWeight),

pkg/models/ghc_entitlements.go

@@ -22,6 +22,7 @@ type Entitlement struct {
 	DBAuthorizedWeight                           *int             `db:"authorized_weight"`
 	WeightAllotted                               *WeightAllotment `db:"-"`
 	StorageInTransit                             *int             `db:"storage_in_transit"`
+	GunSafe                                      bool             `db:"gun_safe"`
 	RequiredMedicalEquipmentWeight               int              `db:"required_medical_equipment_weight"`
 	OrganizationalClothingAndIndividualEquipment bool             `db:"organizational_clothing_and_individual_equipment"`
 	ProGearWeight                                int              `db:"pro_gear_weight"`

pkg/services/order/order_updater.go

@@ -426,6 +426,10 @@ func allowanceFromTOOPayload(existingOrder models.Order, payload ghcmessages.Upd
 		order.Entitlement.StorageInTransit = &newSITAllowance
 	}
 
+	if payload.GunSafe != nil {
+		order.Entitlement.GunSafe = *payload.GunSafe
+	}
+
 	return order
 }
 
@@ -478,6 +482,10 @@ func allowanceFromCounselingPayload(existingOrder models.Order, payload ghcmessa
 		order.Entitlement.StorageInTransit = &newSITAllowance
 	}
 
+	if payload.GunSafe != nil {
+		order.Entitlement.GunSafe = *payload.GunSafe
+	}
+
 	return order
 }
 

swagger-def/definitions/prime/Entitlements.yaml

@@ -13,6 +13,9 @@ properties:
     example: true
     type: boolean
     x-nullable: true
+  gunSafe:
+    type: boolean
+    example: false
   nonTemporaryStorage:
     example: false
     type: boolean

swagger-def/ghc.yaml

@@ -3917,6 +3917,9 @@ definitions:
         example: true
         type: boolean
         x-nullable: true
+      gunSafe:
+        type: boolean
+        example: false
       nonTemporaryStorage:
         example: false
         type: boolean
@@ -4666,6 +4669,10 @@ definitions:
         description: the number of storage in transit days that the customer is entitled to for a given shipment on their move
         type: integer
         minimum: 0
+      gunSafe:
+        description: True if user is entitled to move a gun safe (up to 500 lbs) as part of their move without it being charged against their weight allowance.
+        type: boolean
+        x-nullable: true
   UpdateBillableWeightPayload:
     type: object
     properties:
@@ -4735,6 +4742,10 @@ definitions:
         description: the number of storage in transit days that the customer is entitled to for a given shipment on their move
         type: integer
         minimum: 0
+      gunSafe:
+        description: True if user is entitled to move a gun safe (up to 500 lbs) as part of their move without it being charged against their weight allowance.
+        type: boolean
+        x-nullable: true
   MoveTaskOrder:
     description: The Move (MoveTaskOrder)
     properties:

swagger-def/support.yaml

@@ -863,6 +863,9 @@ definitions:
         example: true
         type: boolean
         x-nullable: true
+      gunSafe:
+        type: boolean
+        example: false
       nonTemporaryStorage:
         example: false
         type: boolean