voyager_api 0.1.2 → 0.2.0

data/Gemfile

@@ -1,7 +1,8 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-#   gem "activesupport", ">= 2.3.5"
+gem "activesupport"
+gem 'i18n'
 
 gem "httpclient"
 gem "nokogiri"

data/Gemfile.lock

@@ -1,6 +1,8 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
     git (1.2.5)
     growl (1.0.3)
     guard (0.6.3)
@@ -8,6 +10,7 @@ GEM
     guard-minitest (0.4.0)
       guard (~> 0.4)
     httpclient (2.2.1)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -16,6 +19,7 @@ GEM
     minitest (2.5.1)
     mocha (0.10.0)
       metaclass (~> 0.0.1)
+    multi_json (1.0.3)
     nokogiri (1.5.0)
     rake (0.9.2)
     rb-fsevent (0.4.3.1)
@@ -26,10 +30,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   bundler (~> 1.0.0)
   growl
   guard-minitest
   httpclient
+  i18n
   jeweler (~> 1.6.4)
   minitest
   mocha

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/config/item_status_codes.yml

@@ -0,0 +1,172 @@
+1n:
+    short_message: Available
+    long_message: Not checked out
+1r:
+    short_message: 'Available (Requests: %REQS)'
+    long_message: 'Not checked out (Requests: %REQS)'
+2n:
+    short_message: 'Checked out, due %DATE'
+    long_message: 'Checked out, due %DATE - Recall, or try Borrow Direct or ILL.'
+    services:
+        -   recall_hold
+        -   borrow_direct
+        -   ill
+2r:
+    short_message: 'Checked out, due %DATE (Requests: %REQS)'
+    long_message: 'Checked out, due %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+    services:
+        -   borrow_direct
+        -   ill
+3n:
+    short_message: 'Checked out, due %DATE'
+    long_message: 'Checked out, due %DATE - Recall, or try Borrow Direct or ILL.'
+    services:
+        -   recall_hold
+        -   borrow_direct
+        -   ill
+3r:
+    short_message: 'Checked out, due %DATE (Requests: %REQS)'
+    long_message: 'Checked out, due %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+    services:
+        -   borrow_direct
+        -   ill
+4n:
+    short_message: 'Overdue as of %DATE'
+    long_message: 'Overdue as of %DATE - Recall, or try Borrow Direct.'
+    services:
+        -   recall_hold
+        -   borrow_direct
+4r:
+    short_message: 'Overdue as of %DATE (Requests: %REQS)'
+    long_message: 'Overdue as of %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+    services:
+        -   borrow_direct
+        -   ill
+5n:
+        short_message: 'Requests: %REQS'
+        long_message: 'Requests: %REQS'
+5r:
+        short_message: 'Checked out, due %DATE (Requests: %REQS)'
+        long_message: 'Checked out, due %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+6n:
+        short_message: 'Requests: %REQS'
+        long_message: 'Requests: %REQS'
+6r:
+        short_message: 'Checked out, due %DATE (Requests: %REQS)'
+        long_message: 'Checked out, due %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+7n:
+        short_message: 'On hold at %LOC'
+        long_message: 'On hold at %LOC. Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+7r:
+        short_message: 'On hold at %LOC (Requests: %REQS)'
+        long_message: 'On hold at %LOC (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+8n:
+        short_message: 'In transit %DATE'
+        long_message: 'In transit %DATE. Place a hold request.'
+        services:
+            -   recall_hold
+8r:
+        short_message: 'In transit %DATE (Requests: %REQS)'
+        long_message: 'In transit %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+9n:
+        short_message: 'In transit to %LOC %DATE'
+        long_message: 'In transit to %LOC %DATE. Place a hold request.'
+        services:
+            -   recall_hold
+9r:
+        short_message: 'In transit to %LOC %DATE (Requests: %REQS)'
+        long_message: 'In transit to %LOC %DATE (Requests: %REQS). Try Borrow Direct.'
+        services:
+            -   borrow_direct
+10n:
+        short_message: 'In transit to %LOC %DATE. Place a hold request.'
+        long_message: 'In transit to %LOC %DATE. Place a hold request.'
+        services:
+            -   recall_hold
+10r:
+        short_message: 'In transit to %LOC %DATE (Requests: %REQS)'
+        long_message: 'In transit to %LOC %DATE (Requests: %REQS). Try Borrow Direct.'
+        services:
+            -   borrow_direct
+11n:
+        short_message: 'Returned %DATE'
+        long_message: 'Returned %DATE'
+11r:
+        short_message: 'Returned %DATE (Requests: %REQS)'
+        long_message: 'Returned %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+12n:
+        short_message: 'Missing %DATE'
+        long_message: 'Missing %DATE. Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+12r:
+        short_message: 'Missing %DATE (Requests: %REQS)'
+        long_message: 'Missing %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+13n:
+        short_message: 'Unavailable %DATE'
+        long_message: 'Unavailable %DATE. Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+13r:
+        short_message: 'Unavailable %DATE (Requests: %REQS)'
+        long_message: 'Unavailable %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+14n:
+        short_message: 'Unavailable %DATE'
+        long_message: 'Unavailable %DATE. Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+14r:
+        short_message: 'Unavailable %DATE (Requests: %REQS)'
+        long_message: 'Unavailable %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+18n:
+        short_message: 'Sent to bindery for 1 month on %DATE'
+        long_message: 'Sent to bindery for 1 month on %DATE. Try Borrow Direct or ILL. '
+        services:
+            -   borrow_direct
+            -   ill
+18r:
+        short_message: 'Sent to bindery for 1 month on %DATE (Requests: %REQS)'
+        long_message: 'Sent to bindery for 1 month on %DATE (Requests: %REQS). Try Borrow Direct or ILL.'
+        services:
+            -   borrow_direct
+            -   ill
+22n:
+        short_message: 'In Process %DATE'
+        long_message: 'In Process %DATE. Place an In Process item request.'
+        services:
+            -   in_process
+22r:
+        short_message: 'In Process %DATE (Requests: %REQS)'
+        long_message: 'In Process %DATE (Requests: %REQS). Place an In Process item request.'
+        services:
+            -   in_process

data/config/order_status_codes.yml

@@ -0,0 +1,25 @@
+'0':
+    short_message: 'In the Pre-Order Process'
+    long_message: 'In the Pre-Order Process. Try Borrow Direct or ILL.'
+    services:
+        -   borrow_direct
+        -   ill
+'1':
+    short_message: 'Received %DATE'
+    long_message: 'Received %DATE. Place an In Process item request.'
+    services:
+        -   in_process
+'4':
+    short_message: 'Not yet received; claimed %DATE'
+    long_message: 'Not yet received; claimed %DATE. Try Borrow Direct or ILL.'
+    services:
+        -   on_order
+        -   borrow_direct
+        -   ill
+'8':
+    short_message: 'Copy On Order %DATE'
+    long_message: 'Copy On Order %DATE. Try Borrow Direct or ILL.'
+    services:
+        -   on_order
+        -   borrow_direct
+        -   ill

data/lib/holdings/collection.rb

@@ -18,12 +18,41 @@ module Voyager
       end
       
       # Generate output hash from Record class instances
-      def to_hash
+      def to_hash(options = {})
+        options.reverse_merge!(:output_type => :raw, :content_type => :full, :message_type => :long_message)
+
+        # :output_type --> :raw (default) | :condensed
+        # 
+        # if :output_type == :condensed
+        #   :content_type --> :brief | :full (default)
+        #     :brief  -->  basic elements: currently location_name, call_number, overall location status, services
+        #     :full   -->  all elements
+        #   if :content_type == :full
+        #     :message_type --> :short_message | :long_message (default)
+        #   
+        
+        raise ":output_type not defined" unless options[:output_type] == :raw || options[:output_type] == :condensed
+        raise ":content_type not defined" unless options[:content_type] == :full || options[:content_type] == :brief
+        raise ":message_type not defined" unless options[:message_type] == :long_message || options[:message_type] == :short_message
+        
         output = {}
-        output[:records] = @records.collect do |rec|
-          rec.to_hash
+
+        case options[:output_type]
+        when :raw
+          output[:records] = @records.collect { |rec| rec.to_hash }
+        when :condensed
+          # convert @records into a holdings hash
+          holdings = @records.collect { |rec| rec.to_hash }
+          case options[:content_type]
+          when :full
+            output[:condensed_holdings_full] = condense_holdings(holdings,options)
+          when :brief
+            output[:condensed_holdings_brief] = condense_holdings(holdings,options)
+          end
         end
+          
         output
+
       end
 
       private
@@ -44,6 +73,203 @@ module Voyager
           Record.new(record_node)
         end
       end
+
+      def condense_holdings(holdings,options)
+        
+        # processing varies depending on complexity
+        complexity = determine_complexity(holdings)
+        process_holdings(holdings,complexity,options)
+
+      end
+
+      def determine_complexity(holdings)
+
+        # holdings are complex if anything other than item_status has a value
+
+        complexity = :complex
+
+        holdings.each do |holding|
+          if [:summary_holdings, :supplements, :indexes, :notes,
+              :reproduction_note, :current_issues, :temp_locations,
+              :orders].all? { |key| holding[key].empty?}
+            complexity = :simple
+          end
+        end
+
+        complexity
+
+      end
+
+      def process_holdings(holdings,complexity,options)
+
+        entries = [] 
+        holdings.each do |holding|
+          # test for location and call number
+          entry = entries.find { |entry| entry[:location_name] == holding[:location_name] && 
+            entry[:call_number] == holding[:call_number] }
+
+          unless entry
+            entry = {
+              :location_name => holding[:location_name],
+              :call_number => holding[:call_number],
+              :status => '',
+              :copies => [],
+              :services => []
+            }
+            entry[:copies] << {:items => {}} if complexity == :simple
+            entries << entry
+          end
+
+          # for simple holdings put consolidated status information in the first copy
+          if complexity == :simple
+            item_status = holding[:item_status]
+            messages = item_status[:messages]
+            messages.each do |message|
+              text = message[options[:message_type]]
+              if entry[:copies].first[:items].has_key?(text)
+                entry[:copies].first[:items][text][:count] += 1
+              else
+                entry[:copies].first[:items][text] = {
+                  :status => item_status[:status],
+                  :count => 1
+                }
+              end
+            end
+          # for complex holdings create hash of elements for each copy and add to entry :copies array
+          else
+            out = {}
+            # process status messages
+            item_status = holding[:item_status]
+            messages = item_status[:messages]
+            out[:items] = {}
+            messages.each do |message|
+              text = message[options[:message_type]]
+              if out[:items].has_key?(text)
+                out[:items][text][:count] += 1
+              else
+                out[:items][text] = {
+                  :status => item_status[:status],
+                  :count => 1
+                }
+              end
+            end
+            # add other elements to :copies array
+            [:current_issues, :indexes, :notes, :orders, :reproduction_note, :supplements,
+              :summary_holdings, :temp_locations].each { |type| add_holdings_elements(out,holding,type,options[:message_type]) }
+
+            entry[:copies] << out
+            
+          end
+
+          entry[:services] << holding[:services]
+
+        end
+        
+        # get overall status of each location entry
+        entries.each { |entry| determine_overall_status(entry) }
+
+        # condense services list
+        entries.each { |entry| entry[:services] = entry[:services].flatten.uniq }
+
+        output_condensed_holdings(entries,options[:content_type])
+
+      end
+
+      def add_holdings_elements(out,holding,type,message_type)
+        
+        case type
+        when :current_issues
+          out[type] = "Current Issues: " + holding[type].join('; ') unless holding[type].empty?
+        when :indexes
+          out[type] = "Indexes: " + holding[type].join(' ') unless holding[type].empty?
+        when :notes
+          out[type] = "Notes: " + holding[type].join(' ') unless holding[type].empty?
+        when :orders
+          unless holding[type].empty?
+             messages = holding[type].each.collect { |message| message[message_type] }
+             out[type] = "Order Information: " + messages.join('; ')
+           end
+        when :reproduction_note
+          out[type] = holding[type] unless holding[type].empty?
+        when :supplements
+          out[type] = "Supplements: " + holding[type].join(' ') unless holding[type].empty?
+        when :summary_holdings
+          out[type] = "Library has: " + holding[type].join(' ') unless holding[type].empty?
+        when :temp_locations
+          out[type] = holding[type] unless holding[type].empty?
+        else
+        end
+        
+      end
+
+      def determine_overall_status(entry)
+        
+        a = 0   # available
+        s = 0   # some available
+        n = 0   # not available
+
+        status = ''
+
+        entry[:copies].each do |copy|
+          copy[:items].each_pair do |message,details|
+            a = 1 if details[:status] == 'available'
+            s = 2 if details[:status] == 'some_available'
+            n = 4 if details[:status] == 'not_available'
+          end
+        end
+
+        #               |  some           |  not
+        # available (1) |  available (2)  |  available (4)    total (a+s+n)
+        # -----------------------------------------------------------------
+        #     Y               Y                 Y               7
+        #     Y               Y                 N               3
+        #     Y               N                 Y               5
+        #     Y               N                 N               1
+        #     N               Y                 Y               6
+        #     N               Y                 N               2
+        #     N               N                 Y               4
+        #     N               N                 N               0
+        #
+        # :available is returned if all items are available (1).
+        # :not_available is returned if everything is unavailable (4).
+        # :none is returned if there is no status (0).
+        # otherwise :some_available is returned:
+        # All status are checked; as long as something is available, even if
+        # there are some items check out, :some_available is returned.
+        #
+
+        case a + s + n
+        when 0
+          status = 'none'
+          status = 'online' if entry[:location_name].match(/^Online/)
+        when 1
+          status = 'available'
+        when 4
+          status = 'not_available'
+        else
+          status = 'some_available'
+        end
+
+        entry[:status] = status
+
+      end
+
+      def output_condensed_holdings(entries,type)
+        
+        case type
+        when :full
+          entries
+        when :brief
+          entries.collect do |entry|
+            {:location_name => entry[:location_name],
+              :call_number => entry[:call_number],
+              :status => entry[:status],
+              :services => entry[:services]}
+          end
+        end
+        
+      end
+
     end
   end
 end