Set process status type constant

Check the process status type to calculate Unavailable status
Check the process status when the value is in process,
in combination with the requested value

related to pulibrary/orangelight#5715
See https://pul-confluence.atlassian.net/wiki/spaces/ALMA/pages/1025114135/Availability

@mzelesky Thank you for sharing your Alma knowledge and contributing
to create this documentation https://docs.google.com/document/d/1VzbWI4mEy8M2WWIpGBfYv1UtcgqtI6fj8LoomRT17_4/edit?pli=1&tab=t.0
We've created a simpler approach to  calculate the status in bibdata.

Author: christinach

app/adapters/alma_adapter/alma_item.rb

@@ -1,4 +1,5 @@
 class AlmaAdapter
+  # rubocop:disable Metrics/ClassLength
   class AlmaItem < SimpleDelegator
     attr_reader :item
 
@@ -242,7 +243,7 @@ def availability_summary
         copy_number: holding_data['copy_id'],
         status: status[:code],        # Available
         status_label: status[:label], # Item in place
-        status_source: status[:source], # e.g. work_order, process_type, base_status
+        status_source: status[:source], # e.g. process_type, base_status
         process_type: status[:process_type],
         on_reserve: on_reserve? ? 'Y' : 'N',
         item_type:, # e.g., Gen
@@ -291,36 +292,74 @@ def item_type
       item_data.dig('policy', 'value')
     end
 
+    def process_type_value
+      item_data.dig('process_type', 'value')
+    end
+
+    def process_type_desc
+      item_data.dig('process_type', 'desc')
+    end
+
+    def base_status_value
+      item_data.dig('base_status', 'value')
+    end
+
+    def base_status_desc
+      item_data.dig('base_status', 'desc')
+    end
+
+    def work_order_type_value
+      item_data.dig('work_order_type', 'value')
+    end
+
+    def work_order_type_desc
+      item_data.dig('work_order_type', 'desc')
+    end
+
+    def requested?
+      item_data['requested'] == true
+    end
+
+    # Currently we handle the 'In Process' logic in the orangelight codebase
+    def in_process_work_order_type_values
+      ['AcqWorkOrder', 'Firestone']
+    end
+
     def calculate_status
-      return status_from_work_order_type if item_data.dig('work_order_type', 'value').present?
-      return status_from_process_type if item_data.dig('process_type', 'value').present?
+      return process_type_status_unavailable unless process_type_value.empty?
+
+      return no_process_type_calculate_status if process_type_value.empty?
+
+      # keep status_from_base_status until we confirm that the alma items
+      # will always have the process type attribute with or without value
 
       status_from_base_status
     end
 
-    def status_from_work_order_type
-      value = item_data['work_order_type']['value']
-      desc = item_data['work_order_type']['desc']
-
-      # [Source for values](https://developers.exlibrisgroup.com/alma/apis/docs/xsd/rest_item.xsd/)
-      # [Work Order documentation](https://pul-confluence.atlassian.net/wiki/spaces/ALMA/pages/1770142/Work+Orders)
-      code = if value.in?(%w[Pres AcqWorkOrder CollDev HMT Firestone])
-               'Unavailable'
-             else
-               # "COURSE" or "PHYSICAL_TO_DIGITIZATION"
-               'Available'
-             end
-      { code:, label: desc, source: 'work_order' }
+    PROCESS_TYPE_VALUES = %w[ACQ CLAIM_RETURNED_LOAN HOLDSHELF ILL LOAN LOST_ILL LOST_LOAN LOST_LOAN_AND_PAID MISSING REQUESTED TECHNICAL TRANSIT TRANSIT_TO_REMOTE_STORAGE WORK_ORDER_DEPARTMENT].freeze
+    def process_type_status_unavailable
+      label, source = if process_type_value.in?(PROCESS_TYPE_VALUES)
+                        if process_type_value == 'WORK_ORDER_DEPARTMENT' && in_process_work_order_type_values.include?(work_order_type_value)
+                          [work_order_type_desc, 'work_order']
+                        else
+                          ['Unavailable', 'process_type']
+                        end
+                      end
+      { code: 'Unavailable', label:, source:, process_type: process_type_value }
     end
 
-    def status_from_process_type
-      # For now we return "Unavailable" for any item that has a process_type.
-      # You can see a list of all the possible values here:
-      #   https://developers.exlibrisgroup.com/alma/apis/docs/xsd/rest_item.xsd/
-      value = item_data.dig('process_type', 'value')
-      desc = item_data.dig('process_type', 'desc')
+    def no_process_type_calculate_status
+      # no process type and requested true sends to illiad
+      code, value, source = if requested?
+                              ['Unavailable', 'Unavailable', 'requested_true']
+                            elsif !requested? && base_status_value == '1'
+                              # Currently Orangelight is looking for Item in place for alma items
+                              # this is why we keep base_status_desc
+                              # we can replace this with Available when we refactor Orangelight to look for Available
+                              ['Available', base_status_desc, 'base_status']
+                            end
 
-      { code: 'Unavailable', label: desc, source: 'process_type', process_type: value }
+      { code:, label: value, source:, process_type: process_type_value }
     end
 
     def status_from_base_status
@@ -339,4 +378,5 @@ def holding_location_label(code)
       [composite_library_label_display, label].compact_blank.join(' - ')
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

spec/adapters/alma_adapter/alma_item_spec.rb

@@ -180,7 +180,8 @@ def build_item(code:, retention_reason:)
           'base_status' => { 'value' => '0', 'desc' => 'Item not in place' },
           'process_type' => { 'value' => 'WORK_ORDER_DEPARTMENT', 'desc' => 'In Process' },
           'work_order_type' => { 'value' => 'AcqWorkOrder', 'desc' => 'Acquisitions and Cataloging' },
-          'work_order_at' => { 'value' => 'AcqDepttechserv', 'desc' => 'Acquisitions and Cataloging' }
+          'work_order_at' => { 'value' => 'AcqDepttechserv', 'desc' => 'Acquisitions and Cataloging' },
+          'requested' => false
         }
       )
     end
@@ -194,7 +195,8 @@ def build_item(code:, retention_reason:)
           'base_status' => { 'value' => '0', 'desc' => 'Item not in place' },
           'process_type' => { 'value' => 'WORK_ORDER_DEPARTMENT', 'desc' => 'In Process' },
           'work_order_type' => { 'value' => 'CollDev', 'desc' => 'Collection Development Office' },
-          'work_order_at' => { 'value' => 'CollDev', 'desc' => 'Collection Development Office' }
+          'work_order_at' => { 'value' => 'CollDev', 'desc' => 'Collection Development Office' },
+          'requested' => false
         }
       )
     end
@@ -208,7 +210,8 @@ def build_item(code:, retention_reason:)
           'base_status' => { 'value' => '1', 'desc' => 'Item in place' },
           'process_type' => { 'value' => 'TRANSIT', 'desc' => 'Transit' },
           'work_order_type' => { 'value' => 'HMT', 'desc' => 'Holdings Management' },
-          'work_order_at' => { 'value' => 'HMT', 'desc' => 'Holdings Management' }
+          'work_order_at' => { 'value' => 'HMT', 'desc' => 'Holdings Management' },
+          'requested' => false
         }
       )
     end
@@ -220,7 +223,8 @@ def build_item(code:, retention_reason:)
         'item_data' => {
           'pid' => '23194161020006421',
           'base_status' => { 'value' => '0', 'desc' => 'Item not in place' },
-          'process_type' => { 'value' => 'ACQ', 'desc' => 'Acquisition' }
+          'process_type' => { 'value' => 'ACQ', 'desc' => 'Acquisition' },
+          'requested' => false
         }
       )
     end
@@ -229,15 +233,15 @@ def build_item(code:, retention_reason:)
       Alma::BibItem.new(
         'bib_data' => { 'mms_id' => '9939075533506421' },
         'holding_data' => { 'holding_id' => '22194161030006421' },
-        'item_data' => { 'pid' => '23194161020006421', 'base_status' => { 'value' => '1', 'desc' => 'Item in place' } }
+        'item_data' => { 'pid' => '23194161020006421', 'process_type' => { 'value' => '' }, 'base_status' => { 'value' => '1', 'desc' => 'Item in place' }, 'requested' => false }
       )
     end
 
     let(:item_base_status_not_in_place) do
       Alma::BibItem.new(
         'bib_data' => { 'mms_id' => '9939075533506421' },
         'holding_data' => { 'holding_id' => '22194161030006421' },
-        'item_data' => { 'pid' => '23194161020006421', 'base_status' => { 'value' => '0', 'desc' => 'Item not in place' } }
+        'item_data' => { 'pid' => '23194161020006421', 'process_type' => { 'value' => 'ACQ', 'desc' => 'Acquisition' }, 'base_status' => { 'value' => '0', 'desc' => 'Item not in place' }, 'requested' => false }
       )
     end
 

spec/adapters/alma_adapter_spec.rb

@@ -243,19 +243,23 @@
   describe 'holding availability' do
     let(:library_lewis_reserves) { file_fixture('alma/library_lewis_reserves.json') }
     let(:library_lewis_stacks) { file_fixture('alma/library_lewis_stacks.json') }
+    let(:library_firestone_stacks) { file_fixture('alma/library_firestone_stacks.json') }
 
     before do
       stub_alma_holding_items(mms_id: '9919392043506421', holding_id: '22105104420006421', filename: '9919392043506421_holding_items.json')
       stub_alma_holding_items(mms_id: '99122455086806421', holding_id: '22477860740006421', filename: '99122455086806421_holding_items.json')
       stub_alma_library(library_code: 'firestone', location_code: 'dixn')
       stub_alma_library(library_code: 'firestone', location_code: 'stacks')
 
+      stub_alma_holding_items(mms_id: '99126856502706421', holding_id: '22965530090006421', filename: '99126856502706421_process_type_requested.json')
+
       # https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/9999362473506421/holdings/22752541670006421/items?limit=100&order_by=enum_a
       stub_alma_holding_items(mms_id: '9999362473506421', holding_id: '22752541670006421', filename: '9999362473506421_holding_items.json')
       stub_alma_holding_items(mms_id: '9999362473506421', holding_id: '22752541690006421', filename: '9999362473506421_holding_items_two.json')
 
       stub_alma_library(library_code: 'lewis', location_code: 'resterm', body: library_lewis_reserves)
       stub_alma_library(library_code: 'lewis', location_code: 'stacks', body: library_lewis_stacks)
+      stub_alma_library(library_code: 'firestone', location_code: 'stacks', body: library_firestone_stacks)
     end
 
     it 'reports holdings availability' do
@@ -276,21 +280,31 @@
       # but we are not really using this value anymore.
       expect(item[:on_reserve]).to eq 'N'
 
-      # Make sure temp locations are handled and the permanent location is preserved.
-      availability = adapter.get_availability_holding(id: '9999362473506421', holding_id: '22752541690006421')
+      create(:holding_location, code: 'firestone$stacks', label: 'Stacks')
+      availability = adapter.get_availability_holding(id: '99126856502706421', holding_id: '22965530090006421')
       item = availability.first
-      expect(item[:in_temp_library]).to be true
-      expect(item[:temp_library_code]).to eq 'lewis'
-
-      # Test an actual response. These values are not particularly meaningful, but to make sure we don't
-      # inadvertently change them when refactoring.
-      item_test = { barcode: '32101099065268', id: '23752541680006421', holding_id: '22752541690006421', copy_number: '0',
-                    status: 'Available', status_label: 'Item in place', status_source: 'base_status', process_type: nil,
-                    on_reserve: 'Y', item_type: 'Gen', pickup_location_id: 'lewis', pickup_location_code: 'lewis',
-                    location: 'lewis$resterm', label: 'Lewis Library - Term Loan Reserves', description: '', enum_display: '',
-                    chron_display: '', requested: false, in_temp_library: true, temp_library_code: 'lewis',
-                    temp_library_label: 'Lewis Library - Term Loan Reserves', temp_location_code: 'lewis$resterm',
-                    temp_location_label: 'Lewis Library - Term Loan Reserves' }
+      expect(item[:in_temp_library]).to be false
+      expect(item[:temp_library_code]).to be_nil
+
+      item_test = { barcode: '32101116415405',
+                    id: '23965530080006421',
+                    holding_id: '22965530090006421',
+                    copy_number: '',
+                    status: 'Unavailable',
+                    status_label: 'Unavailable',
+                    status_source: 'process_type',
+                    process_type: 'HOLDSHELF',
+                    on_reserve: 'N',
+                    item_type: 'Gen',
+                    pickup_location_id: 'firestone',
+                    pickup_location_code: 'firestone',
+                    location: 'firestone$stacks',
+                    label: 'Firestone Library - Stacks',
+                    description: '',
+                    enum_display: '',
+                    chron_display: '',
+                    requested: true,
+                    in_temp_library: false }
       expect(item).to eq item_test
     end
 
@@ -312,30 +326,42 @@
     before do
       stub_alma_ids(ids: '9965126093506421', status: 200)
       stub_alma_holding_items(mms_id: '9965126093506421', holding_id: '22202918790006421', filename: '9965126093506421_holding_items.json')
+      stub_alma_holding_items(mms_id: '99131644166406421', holding_id: '221091258440006421', filename: '99131644166406421_in_process_acq.json')
       stub_alma_ids(ids: '9943506421', status: 200)
       stub_alma_holding_items(mms_id: '9943506421', holding_id: '22261963850006421', filename: '9943506421_holding_items.json')
       stub_alma_library(library_code: 'firestone', location_code: 'stacks')
       stub_alma_library(library_code: 'recap', location_code: 'xr')
     end
 
-    it 'uses the work_order to calculate status' do
-      availability = adapter.get_availability_holding(id: '9965126093506421', holding_id: '22202918790006421')
-      item = availability.first
-      expect(item[:status]).to eq 'Unavailable'
-      expect(item[:status_label]).to eq 'Holdings Management'
-      expect(item[:status_source]).to eq 'work_order'
+    context 'item with process type value' do
+      # PROCESS_TYPE_VALUES = ACQ CLAIM_RETURNED_LOAN HOLDSHELF ILL LOAN LOST_ILL LOST_LOAN LOST_LOAN_AND_PAID MISSING REQUESTED TECHNICAL TRANSIT TRANSIT_TO_REMOTE_STORAGE WORK_ORDER_DEPARTMENT
+      it '-WORK_ORDER_DEPARTMENT- and work order not AcqWorkOrder or Firestone it has status and label Unavailable' do
+        availability = adapter.get_availability_holding(id: '9965126093506421', holding_id: '22202918790006421')
+        item = availability.first
+        expect(item[:status]).to eq 'Unavailable'
+        expect(item[:status_label]).to eq 'Unavailable'
+        expect(item[:status_source]).to eq 'process_type'
+      end
+
+      it '-WORK_ORDER_DEPARTMENT- and work order is AcqWorkOrder it has status Unavailable and label Acquisitions and Cataloging' do
+        availability = adapter.get_availability_holding(id: '99131644166406421', holding_id: '221091258440006421')
+        item = availability.first
+        expect(item[:status]).to eq 'Unavailable'
+        expect(item[:status_label]).to eq 'Acquisitions and Cataloging'
+        expect(item[:status_source]).to eq 'work_order'
+      end
     end
 
     it 'uses the process_type to calculate status' do
       availability = adapter.get_availability_holding(id: '9943506421', holding_id: '22261963850006421')
       item = availability.find { |bib_item| bib_item[:id] == '23261963800006421' }
       expect(item[:status]).to eq 'Unavailable'
-      expect(item[:status_label]).to eq 'Transit'
+      expect(item[:status_label]).to eq 'Unavailable'
       expect(item[:status_source]).to eq 'process_type'
       expect(item[:process_type]).to eq 'TRANSIT'
     end
 
-    it 'uses the base_status to calculate status' do
+    it 'when there is no process_type value it uses the base_status to calculate status' do
       availability = adapter.get_availability_holding(id: '9943506421', holding_id: '22261963850006421')
       item = availability.first
       expect(item[:status]).to eq 'Available'