voyager_api 0.1.2 → 0.2.0

data/lib/holdings/item.rb

@@ -77,7 +77,11 @@ module Voyager
         
         # no items = no status available
         if item_count == "0"
-          return {:status => 'none', :messages => ['No item status available'] }
+          return {:status => 'none', 
+                  :messages => [ {:status_code => '0', 
+                                  :short_message => 'Status unknown',
+                                  :long_message => 'No item status available'} ] 
+                }
         end
 
         # item:itemRecord nodes
@@ -140,112 +144,110 @@ module Voyager
       def generate_messages(records)
         
         messages = []
-        
         records.each do |record|
-          # messages differ based on whether there is a request count
-          if record[:requestCount] == '0'
-            messages << generate_message_no_requests(record)
-          else
-            messages << generate_message_requests(record)
-          end
-          
+          messages << generate_message(record)
         end
-        
         messages
         
       end
       
       # Generate message from a record (item:itemRecord node)
-      # No request count
       #
       # * *Args*    :
       #   - +record+ -> Hash of data from an item:itemRecord node
       # * *Returns* :
-      #   - Formatted message
+      #   - Formatted message in a hash
+      #     :status_code => code of status message
+      #     :short_message => short version of message
+      #     :long_message => long version of message
       #
-      def generate_message_no_requests(record)
-        
-        # label is descriptive information for items; optional
-        labels = []
-        [:enumeration, :chronology, :year, :caption, :text].each do |type|
-          labels << record[type] unless record[type].empty?
-        end
-        labels.empty? ? label = '' : label = labels.join(' ') + ' '
+      def generate_message(record)
         
-        datetime = record[:statusDate].split(' ') # split into date/time
-        
-        message = ''
-        
-        # status patron message otherwise a regular message
+        short_message = ''
+        long_message = ''
+        code = ''        
+
+        # status patron message otherwise regular message
         if record[:patronGroupCode].strip.match(/^(IND|MIS|ACO)/)
         
-          message = record[:lastName].strip + ' ' + record[:firstName].strip
-          
+          code = 'sp'
+          long_message = record[:lastName].strip + ' ' + record[:firstName].strip
+          # done in two steps in case ending puctuation is missing
+          short_message = long_message.gsub(/(Try|Place).+/, '').strip
+          short_message = short_message.gsub(/\W$/, '')
+
         else
         
-          case record[:statusCode]
-          when '1'
-            message = 'Not checked out'
-          when '2'
-            message = "Checked out, due #{datetime.join(' ')} - Recall, or try Borrow Direct or ILL."
-          when '3'
-            message = "Checked out, due #{datetime.join(' ')} - Recall, or try Borrow Direct or ILL."
-          when '4'
-            message = "Overdue as of #{datetime.join(' ')} - Recall, or try Borrow Direct."
-          when '5'
-            message = "Requests: #{record[:requestCount]}"
-          when '6'
-            message = "Requests: #{record[:requestCount]}"
-          when '7'
-            message = "On hold at #{record[:holdLocation]}. Try Borrow Direct or ILL."
-          when '8'
-            message = "In transit #{datetime[0]}. Place a hold request."
-          when '9'
-            message = "In transit to #{record[:holdLocation]} #{datetime[0]}. Place a hold request."
-          when '10'
-            message = "In transit to #{record[:holdLocation]} #{datetime[0]}. Place a hold request."
-          when '11'
-            message = "Returned #{datetime[0]}"
-          when '12'
-            message = "Missing #{datetime[0]}. Try Borrow Direct or ILL."
-          when '13'
-            message = "Unavailable #{datetime[0]}. Try Borrow Direct or ILL."
-          when '14'
-            message = "Unavailable #{datetime[0]}. Try Borrow Direct or ILL."
-          when '18'
-            message = "Sent to bindery for 1 month on #{datetime[0]}. Try Borrow Direct or ILL."
-          when '21'
-            message = "Scheduled"
-          when '22'
-            message = "In Process #{datetime[0]}. Place an In Process item request."
-          when '23'
-            message = "Requested"
-          when '24'
-            message = "Requested"
-          when '25'
-            message = "Requested"
+          code = record[:statusCode]
+          # append suffix to indicate whether there are requests - n = no requests, r = requests
+          record[:requestCount] == '0' ? code += 'n' : code += 'r'
+          
+          # get parms for the message being processed
+          parms = ITEM_STATUS_CODES[code]
+        
+          raise "Status code not found in config/item_status_codes.yml" unless parms
+      
+          short_message = make_substitutions(parms['short_message'],record)
+          long_message = make_substitutions(parms['long_message'],record)
+
+        end
+     
+        # add labels
+        short_message = add_label(short_message,record)
+        long_message = add_label(long_message,record)
+     
+        return { :status_code => code, 
+                  :short_message => short_message, 
+                  :long_message => long_message }
+ 
+      end
+
+      def format_datetime(record)
+        
+        # format date / time
+        datetime = ''
+        unless record[:statusDate].empty?
+          # use date in record so we can use stored test features
+          todays_date = DateTime.parse(record[:todaysDate])
+#          todays_date = DateTime.now
+          status_date = DateTime.parse(record[:statusDate])
+          diff = status_date - todays_date
+          # we have to accommodate dates in the past and the future relative to today
+          # remove times from past dates over 1 day old and future dates more than 2 days away
+          if diff.to_i > 2 || diff.to_i < 0
+            datetime = record[:statusDate].gsub(/\s.+/, '')
           else
-            message = "Unknown"
+            datetime = record[:statusDate]
           end
+        end
+        
+        datetime
         
+      end
+
+      def make_substitutions(message,record)
+
+        datetime = format_datetime(record)
+    
+        # substitute values for tokens in message strings
+        # date
+        unless datetime.empty?
+          message = message.gsub('%DATE', datetime)
+        end
+        # number of requests
+        unless record[:requestCount] == '0'
+          message = message.gsub('%REQS', record[:requestCount])
         end
+        # hold location
+        unless record[:holdLocation].empty?
+          message = message.gsub('%LOC', record[:holdLocation])
+        end
+
+        message
         
-        # add label
-        message.insert(0, label) unless label.empty?
- 
-        return message
- 
       end
-      
-      # Generate message from a record (item:itemRecord node)
-      # Request count
-      #
-      # * *Args*    :
-      #   - +record+ -> Hash of data from an item:itemRecord node
-      # * *Returns* :
-      #   - Formatted message
-      #
-      def generate_message_requests(record)
+
+      def add_label(message,record)
         
         # label is descriptive information for items; optional
         labels = []
@@ -254,69 +256,11 @@ module Voyager
         end
         labels.empty? ? label = '' : label = labels.join(' ') + ' '
         
-        datetime = record[:statusDate].split(' ') # split into date/time
-        
-        message = ''
-        
-        # status patron message otherwise regular message
-        if record[:patronGroupCode].strip.match(/^(IND|MIS|ACO)/)
-        
-          message = record[:lastName].strip + ' ' + record[:firstName].strip
-          
-        else
-        
-          case record[:statusCode]
-          when '1'
-            message = "Not checked out (Requests: #{record[:requestCount]})"
-          when '2'
-            message = "Checked out, due #{datetime.join(' ')} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '3'
-            message = "Checked out, due #{datetime.join(' ')} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '4'
-            message = "Overdue as of #{datetime.join(' ')} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '5'
-            message = "Checked out, due #{datetime.join(' ')} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '6'
-            message = "Checked out, due #{datetime.join(' ')} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '7'
-            message = "On hold at #{record[:holdLocation]} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '8'
-            message = "In transit #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct"
-          when '9'
-            message = "In transit to #{record[:holdLocation]} #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct."
-          when '10'
-            message = "In transit to #{record[:holdLocation]} #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct"
-          when '11'
-            message = "Returned #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '12'
-            message = "Missing #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '13'
-            message = "Unavailable #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '14'
-            message = "Unavailable #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '18'
-            message = "Sent to bindery for 1 month on #{datetime[0]} (Requests: #{record[:requestCount]}). Try Borrow Direct or ILL."
-          when '21'
-            message = "Scheduled (Requests: #{record[:requestCount]})"
-          when '22'
-            message = "In Process #{datetime[0]} (Requests: #{record[:requestCount]}). Place an In Process item request."
-          when '23'
-            message = "Requests: #{record[:requestCount]}"
-          when '24'
-            message = "Requests: #{record[:requestCount]}"
-          when '25'
-            message = "Requests: #{record[:requestCount]}"
-          else
-            message = "Unknown"
-          end
-        
-        end
-        
         # add label
         message.insert(0, label) unless label.empty?
- 
-        return message
- 
+        
+        message
+        
       end
       
     end

data/lib/holdings/order.rb

@@ -53,7 +53,10 @@ module Voyager
       # * *Args*    :
       #   - +poLineItems+ -> mfhd:poLineItems node
       # * *Returns* :
-      #   - Array of messages for orders
+      #   - Array of message hashes for orders
+      #       :status_code => status code
+      #       :short_message => short version of the message
+      #       :long_message => long version of the message
       #   - An empty array if there is no mfhd:poLineItems node
       #
       def parse_order(poLineItems)
@@ -76,22 +79,17 @@ module Voyager
         
         status = lineItemStatus.at_css("mfhd|status").content
         date = lineItemStatus.at_css("mfhd|date").content
-        
-        message = ''
-        
-        case status
-        when "0"
-          message = "In the Pre-Order Process. Try Borrow Direct or ILL."
-        when "1"
-          message = "Received #{date}. Place an In Process item request."
-        when "4"
-          message = "Not yet received; claimed #{date}. Try Borrow Direct or ILL."
-        when "8"
-          message = "Copy On Order #{date}. Try Borrow Direct or ILL."
-        else
-          message = "Unknown"
-        end
-        
+                
+        # get parms for the message being processed
+        parms = ORDER_STATUS_CODES[status]
+      
+        raise "Status code not found in config/order_status_codes.yml" unless parms
+    
+        short_message = parms['short_message'].gsub('%DATE',date)
+        long_message = parms['long_message'].gsub('%DATE',date)
+
+        { :status_code => status, :short_message => short_message, :long_message => long_message }
+
       end
 
     end

data/lib/holdings/record.rb

@@ -3,7 +3,7 @@ module Voyager
     class Record
       attr_reader :holding_id, :location_name, :call_number, :summary_holdings, :notes_852, :notes_866, :notes,
                   :shelving_title, :supplements, :indexes, :reproduction_note, :urls, :item_count, :temp_locations,
-                  :item_status, :orders, :current_issues
+                  :item_status, :orders, :current_issues, :services, :bibid
 
       # Record class initializing method
       # Populates instance variables from the mfhd:marcRecord node of the mfhd:mfhdRecord node.
@@ -13,6 +13,7 @@ module Voyager
       #   - +xml_node+ -> mfhd:mfhdRecord node
       #
       def initialize(xml_node)
+        @bibid = xml_node.attributes["bibId"].value
         @holding_id = xml_node.attributes["mfhdId"].value
         @location_name = xml_node.at_css("mfhd|mfhdData[@name='locationDisplayName']").content
         # marc record node
@@ -64,6 +65,9 @@ module Voyager
         @current_issues = order.current_issues
         @orders = order.orders
         
+        # add available services
+        @services = determine_services(@location_name,@call_number,@item_status,@orders,@bibid)
+        
       end
 
       # Collect data from all variables into a hash
@@ -73,6 +77,7 @@ module Voyager
       #
       def to_hash
         {
+          :bibid => @bibid,
           :holding_id => @holding_id,
           :location_name => @location_name,
           :call_number => @call_number,
@@ -86,6 +91,7 @@ module Voyager
           :item_count => @item_count,
           :temp_locations => @temp_locations,
           :item_status => @item_status,
+          :services => @services,
           :current_issues => @current_issues,
           :orders => @orders
         }
@@ -296,6 +302,99 @@ module Voyager
 
       end
       
+      def determine_services(location_name,call_number,item_status,orders,bibid)
+        
+        services = []
+        
+        unless orders.empty?
+          orders.each do |order|
+            parms = ORDER_STATUS_CODES[order[:status_code]]
+            raise "Status code not found in config/order_status_codes.yml" unless parms
+            services << parms['services'] unless parms['services'].nil?
+          end
+          return services.flatten.uniq
+        end
+        
+        services << scan_message(location_name)
+        
+        status = item_status[:status]
+        messages = item_status[:messages]
+        
+        case status
+        when 'online'
+        when 'none'
+          services << 'in_process' if call_number.match(/in process/i)
+        when 'available'
+          services << process_available(location_name,bibid)
+        when 'some_available'
+          services << process_some_available(location_name,bibid,messages)
+        when 'not_available'
+          services << scan_messages(messages)
+        else
+        end
+        
+        services.flatten.uniq
+        
+      end
+      
+      def process_available(location_name,bibid)
+        # offsite
+        if location_name.match(/^Offsite/) &&
+            HTTPClient.new.get_content("http://www.columbia.edu/cgi-bin/cul/lookupNBX?" + bibid) == "1"
+          return ['offsite']
+        end
+        # precat
+        if location_name.match(/^Precat/)
+           return ['precat']
+        end
+        return []
+      end
+      
+      def process_some_available(location_name,bibid,messages)
+        
+        services = []
+        # offsite
+        if location_name.match(/^Offsite/) &&
+            HTTPClient.new.get_content("http://www.columbia.edu/cgi-bin/cul/lookupNBX?" + bibid) == "1"
+          services << 'offsite'
+        end
+        
+        services << scan_messages(messages)
+
+        services
+        
+      end
+      
+      def scan_messages(messages)
+        services = []
+        messages.each do |message|
+          # status patrons
+          if message[:status_code] == 'sp'
+            services << scan_message(message[:long_message])
+          else
+            parms = ITEM_STATUS_CODES[message[:status_code]]
+            raise "Status code not found in config/order_status_codes.yml" unless parms
+            services << parms['services'] unless parms['services'].nil?
+          end
+        end
+        services
+      end
+      
+      
+      def scan_message(message)
+
+        out = []
+        out << 'recall_hold' if message =~ /Recall/i
+        out << 'recall_hold' if message =~ /hold /
+        out << 'borrow_direct' if message =~ /Borrow/
+        out << 'ill' if message =~ /ILL/
+        out << 'in_process' if message =~ /In Process/
+
+        out
+
+      end
+      
     end
+    
   end
 end