voyager_api 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc.07.27.2011-15:02:08

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p290@voyager_api"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "httpclient"
+gem "nokogiri"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "guard-minitest"
+  gem "rb-fsevent"  # comment out if not on mac
+  gem "mocha"
+  gem "growl"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    growl (1.0.3)
+    guard (0.5.1)
+      thor (~> 0.14.6)
+    guard-minitest (0.4.0)
+      guard (~> 0.4)
+    httpclient (2.2.1)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.3.1)
+    mocha (0.9.12)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rb-fsevent (0.4.1)
+    rcov (0.9.9)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  growl
+  guard-minitest
+  httpclient
+  jeweler (~> 1.6.4)
+  minitest
+  mocha
+  nokogiri
+  rb-fsevent
+  rcov

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  watch(%r{^test/(.*)test_(.*).rb})
+  watch(%r{^lib/((?:(?:[^/]+)/)*)([^/]+)\.rb}) do |m| 
+    Dir.glob("test/#{m[1]}test_#{m[2]}*.rb")
+  end
+  watch(%r{^test/helper(.*).rb})  { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 James Stuart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= voyager_api
+
+Description goes here.
+
+== Contributing to voyager_api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 James Stuart. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "voyager_api"
+  gem.homepage = "http://github.com/cul/voyager_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Columbia University Voyager 7 API wrapper}
+  gem.description = %Q{Middleware gem for Voyager 7 API calls, specificially holdings information }
+  gem.email = "github@jamesstuart.org"
+  gem.authors = ["James Stuart", "Gary Bertchume"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "voyager_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/holdings/collection.rb

@@ -0,0 +1,44 @@
+module Voyager
+  module Holdings
+    class Collection
+      attr_reader :records, :xml
+
+      DEFAULT_OPAC_URL = "http://bearberry.cc.columbia.edu:7014/vxws/GetHoldingsService"
+
+      def self.new_from_opac(bibid, url = DEFAULT_OPAC_URL, httpclient = nil)
+        conn = Voyager::Connection.new(:http_client => httpclient)
+        Collection.new(conn.request(url, :bibId => bibid))
+      end
+
+      def initialize(raw_xml)
+        @xml = load_and_namespace_xml(raw_xml)
+        parse_xml
+      end
+      
+      def to_hash
+        output = {}
+        output[:records] = @records.collect do |rec|
+          rec.to_hash
+        end
+        output
+      end
+
+      private
+
+      def load_and_namespace_xml(raw_xml)
+        xml = Nokogiri::XML(raw_xml)
+        xml.root.add_namespace_definition("hol", "http://www.endinfosys.com/Voyager/holdings")
+        xml.root.add_namespace_definition("mfhd", "http://www.endinfosys.com/Voyager/mfhd")
+        xml.root.add_namespace_definition("item", "http://www.endinfosys.com/Voyager/item")
+        xml.root.add_namespace_definition("slim", "http://www.loc.gov/MARC21/slim")
+        return xml
+      end
+
+      def parse_xml
+        @records = @xml.css("hol|mfhdCollection>mfhd|mfhdRecord").collect do |record_node|
+          Record.new(record_node)
+        end
+      end
+    end
+  end
+end

data/lib/holdings/item.rb

@@ -0,0 +1,253 @@
+module Voyager
+  module Holdings
+    class Item
+      attr_reader :holding_id, :item_count, :temp_locations, :item_status
+   
+      def initialize(xml_node)   
+      
+        @holding_id = xml_node.attributes["mfhdId"].value
+      
+        item = xml_node.at_css("mfhd|itemCollection")
+        
+        @item_count = item.at_css("item|itemCount").content
+        @temp_locations = parse_for_temp_locations(item)    # array
+        @item_status = parse_for_circ_status(item, @item_count)          # hash
+        
+      end
+      
+      private
+      
+      def parse_for_temp_locations(item)
+        
+        # select only nodes for temp location information
+        itemLocation = item.css("item|itemLocation").reject { |loc| loc.at_css("item|itemLocationData[@name='tmpLoc']").content.empty? }
+        
+        return [] unless itemLocation.length > 0
+        
+        messages = []
+        
+        itemLocation.each do |loc|
+          label = []
+          ['itemEnum', 'itemChron','itemYear', 'itemCaption', 'itemFreeText'].each do |type|
+            loc_data = loc.at_css("item|itemLocationData[@name=#{type}]")
+            label << loc_data.content unless loc_data.content.empty?
+          end
+          if label.empty?
+            messages << "Shelved in " + loc.at_css("item|itemLocationData[@name='tempLocation']").content
+          else
+            messages << label.join(" ") + " Shelved in " + loc.at_css("item|itemLocationData[@name='tempLocation']").content
+          end
+        end
+        
+        messages
+        
+      end
+      
+      def parse_for_circ_status(item,item_count)
+        
+        # no items = no status available
+        if item_count == "0"
+          return {:status => 'none', :messages => ['No item status available'] }
+        end
+
+        itemRecord = item.css("item|itemRecord")
+        
+        # collect the records into an arry of hashes for ease of handling
+        records = itemRecord.collect do |record|
+          data = {}
+          record.css("item|itemData").collect do |rec|
+            data[rec.attr("name")] = rec.content
+          end
+          data
+        end
+
+        status = determine_status(records,item_count)
+        messages = generate_messages(records)
+
+        return {:status => status, :messages => messages }
+        
+      end
+      
+      def determine_status(records,item_count)
+        
+        # this may need to be refined
+        # statusCode = 1 in first (and only) record seems to mean nothing is checked out
+        status = 'available'
+        if records.first['statusCode'].to_i > 1
+          if records.length == item_count.to_i
+            status = 'not_available'
+          else
+            status = 'some_available'
+          end
+        end
+        
+        status
+          
+      end
+      
+      def generate_messages(records)
+        
+        messages = []
+        
+        records.each do |record|
+          if record['requestCount'] == '0'
+            messages << generate_message_no_requests(record)
+          else
+            messages << generate_message_requests(record)
+          end
+          
+        end
+        
+        messages
+        
+      end
+      
+      def generate_message_no_requests(record)
+        
+        labels = []
+        ['enumeration', 'chronology','year', 'caption', 'text'].each do |type|
+          labels << record[type] unless record[type].empty?
+        end
+        labels.empty? ? label = '' : label = labels.join(' ') + ' '
+        
+        datetime = record['statusDate'].split(' ') # split into date/time
+        
+        message = ''
+        
+        # status patron message otherwise a 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'
+          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"
+          else
+            message = "Unknown"
+          end
+        
+        end
+        
+        # add label
+        message.insert(0, label) unless label.empty?
+ 
+        message
+ 
+      end
+      
+      def generate_message_requests(record)
+        
+        labels = []
+        ['enumeration', 'chronology','year', 'caption', 'text'].each do |type|
+          labels << record[type] unless record[type].empty?
+        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?
+ 
+        message
+ 
+      end
+      
+    end
+  end
+end

data/lib/holdings/order.rb

@@ -0,0 +1,68 @@
+module Voyager
+  module Holdings
+    class Order
+      attr_reader :orders, :current_issues
+   
+      def initialize(xml_node)   
+
+        serialsCheckIn = xml_node.at_css("mfhd|serialsCheckIn")
+        @current_issues = parse_current_issues(serialsCheckIn)
+        
+        poLineItems = xml_node.at_css("mfhd|poLineItems")
+        @orders = parse_order(poLineItems)
+
+      end
+
+      private
+      
+      def parse_current_issues(serialsCheckIn)
+        
+        return [] unless serialsCheckIn
+        
+        current_issues = []
+
+        # cannot verify that there can be only one mfhd:recent node
+        serialsCheckIn.css("mfhd|recent").each do |recent|
+          # there can be more than one enumChron per recent node
+          recent.css("mfhd|enumChron").each do |enumChron|
+            current_issues << enumChron.content
+          end
+        end
+        
+        current_issues
+        
+      end
+
+      def parse_order(poLineItems)
+        
+        return [] unless poLineItems
+        
+        poLineItems.css("mfhd|lineItemStatus").collect { |lineItemStatus| generate_order_message(lineItemStatus) }
+        
+      end
+
+      def generate_order_message(lineItemStatus)
+        
+        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
+        
+      end
+
+    end
+  end   
+end