uw_catalog 0.0.2

data/lib/uw_catalog.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'data_mapper'
+require 'yaml'
+
+require 'uw_catalog/model/bib_data'
+require 'uw_catalog/model/location'
+require 'uw_catalog/model/holding'
+require 'uw_catalog/model/item'
+require 'uw_catalog/model/items_listing'
+require 'uw_catalog/voyager_sql'
+require 'uw_catalog/voyager_item_status'
+require 'uw_catalog/catalog'
+require 'uw_catalog/data_loader'

data/lib/uw_catalog/catalog.rb

@@ -0,0 +1,98 @@
+module UwCatalog
+
+  class UwCatalogError < RuntimeError; end
+  class UwCatalogAccessError < UwCatalogError; end
+  class UwCatalogTimeoutError < UwCatalogError; end
+  class UwCatalogNotFoundError < UwCatalogError; end
+
+  class Catalog
+    def self.get_bibliographic_data(bibid)
+      bibs = Array.new
+      begin
+        sql = VoyagerSql.get_bibliographic_sql
+        data = DataLoader.get_data(:UW, sql, bibid)
+        data.each do | d |
+          bib = BibData.new
+          DataLoader.load(d, bib)
+          bibs << bib
+        end
+      rescue => e
+        throw UwCatalogError.new("#{e.class}: #{e.message}") 
+      end
+      bibs
+    end
+
+    def self.get_item_from_hash(d)
+     item = Item.new({:id => d[:item_id], :item_enum=>d[:item_enum], 
+                     :copy_number=>d[:copy_number], :on_reserve=>d[:on_reserve], 
+                     :item_status=>d[:item_status],     
+                     :item_barcode=>d[:item_barcode], 
+                     :item_status_date=>d[:item_status_date], :current_due_date=>d[:current_due_date], 
+                     :hold_recall_status_date=>d[:hold_recall_status_date]})
+    end
+
+    def self.get_availability_data_hash(bibid)
+        data_hash = Catalog.get_items_data_hash(bibid)
+    end
+
+    def self.parse_availability_data_hash(data_hash)
+      ret = Array.new
+      data_hash.each do |d|
+	loc_id = d[:location_id]
+	location = d[:location]
+        if !d[:temp_location].nil?
+           loc_id = d[:temp_location_id]
+	   location = d[:temp_location]
+        end
+
+        loc = Location.new({:id => loc_id, :location => location})
+        idx = ret.index(loc)
+        if (idx.nil?)
+          ret << loc
+        else
+          loc = ret.at(idx)
+        end
+        h = Holding.new({:id=>d[:holding_id], :call_number => d[:display_call_no], 
+                         :item_enum => d[:item_enum],
+                         :perm_location_id => d[:location_id], :perm_location => d[:location]})
+        holding = loc.get_holding(h)
+        if (holding.nil?)
+          loc.add_holding(h)
+          holding = h
+        end
+        if (!d[:item_id].nil?)
+          item = get_item_from_hash(d) 
+	  holding.add_item(item)
+        end
+      end
+      ret
+    end
+
+    def self.get_availability_data(bibid)
+      ret = Array.new
+      begin
+        data_hash = get_availability_data_hash(bibid)
+        parse_availability_data_hash(data_hash)
+      rescue => e
+        throw UwCatalogError.new("#{e.class}: #{e.message}") 
+      end
+    end
+
+    def self.get_items_data_hash(bibid)
+      data = Array.new
+      begin
+        sql = VoyagerSql.get_holdings_with_items_sql
+        data = DataLoader.get_data(:UW, sql, bibid)
+
+        sql = VoyagerSql.get_holdings_without_items_sql
+        holdings_without_items_data = DataLoader.get_data(:UW, sql, bibid)
+        data.concat(holdings_without_items_data)
+      rescue => e
+        throw UwCatalogError.new("#{e.class}: #{e.message}") 
+      end
+      data    
+    end
+
+  end
+
+end

data/lib/uw_catalog/data_loader.rb

@@ -0,0 +1,22 @@
+module UwCatalog
+
+  class DataLoader
+
+    def self.load_dynamic_object(data_struct, class_name)
+      cls = Object.const_get(class_name)
+      obj = cls.new
+      data_struct.each_pair {|key, value| obj.send("#{key}=",value) }
+      obj
+    end
+
+    def self.load(data_struct, obj)
+      data_struct.each_pair {|key, value| obj.send("#{key}=",value) }
+    end
+
+    def self.get_data(repository_key, sql, bibid)
+      repository(repository_key).adapter.select(sql, bibid)
+    end
+
+  end
+
+end

data/lib/uw_catalog/model/bib_data.rb

@@ -0,0 +1,16 @@
+module UwCatalog
+
+  class BibData
+    attr_accessor :bibid, :title, :author, :edition, :pub_place, :publisher, :publish_date
+
+    def published_display
+      ret = ''
+      ret += edition unless edition.nil?
+      ret += pub_place unless pub_place.nil?
+      ret += publisher unless publisher.nil?
+      ret += publish_date unless publish_date.nil?
+    end
+
+  end
+
+end

data/lib/uw_catalog/model/holding.rb

@@ -0,0 +1,102 @@
+module UwCatalog
+  class Holding
+    @@date_format = "%B %d, %Y"
+    attr_accessor :id, :call_number, :item_enum, :perm_location_id, :perm_location, :items
+
+    def initialize(h=Hash.new)
+      @items = Array.new
+      h.each {|k,v| send("#{k}=",v)}
+    end
+
+    def  ==(another_holding)
+      self.id == another_holding.id
+    end
+
+    def get_copies
+      if items.nil?
+	return Array.new
+      end
+      copies = items.collect {|c| c.copy_number}.uniq
+    end
+    
+    def self.get_item_rank(item)
+      status_guide = VoyagerItemStatus.status_guide(item.item_status.to_i)
+      status_guide[:rank]
+    end
+
+    def self.override_status(item)
+      (16 == item.item_status.to_i)
+    end
+
+    def add_item(item)
+      idx = items.index(item)
+      if idx.nil?
+        items << item
+      else
+        item_in_list = items.fetch(idx)
+        if Holding.override_status(item_in_list)
+        elsif Holding.override_status(item)
+            items.delete_at(idx)
+            items << item
+        else 
+          if Holding.get_item_rank(item_in_list) > Holding.get_item_rank(item)
+            items.delete_at(idx)
+            items << item
+          end
+        end
+      end
+    end
+
+    def get_items_display(concise = false)
+      ret = Hash.new
+      return ret unless items.size > 0
+
+      status_list = Array.new 
+
+      items.each do |item|
+        status_available, status_text = get_status(item)
+        status_list <<  {:item_id => item.id, :status_text => status_text,
+               :available => status_available, :copy_number=> item.copy_number, :item_enum => item.item_enum}
+      end
+      if (concise)
+        total_count = status_list.size
+        status_list.keep_if{|i| i[:available] == false}.compact
+        if (total_count > 0 && status_list.size == 0)
+          status_list << {:status_text => 'Available', :available => true}
+        end
+      end
+
+      status_list.sort! {|a,b| a[:item_enum].to_s <=> b[:item_enum].to_s} unless status_list.size < 1
+      ret[:status] = status_list
+      ret
+    end
+
+    def get_status(item)
+      status_guide = VoyagerItemStatus.status_guide(item.item_status.to_i)
+      status_available = status_guide[:available]
+      status_text = status_guide[:forward_status]
+      ret = status_text
+      status_date = nil
+      if status_guide[:display_date]
+        case item.item_status.to_i
+        when 2, 3
+          status_date = item.current_due_date.strftime(@@date_format) unless item.current_due_date.nil?
+          if (!item.item_enum.nil?)
+            status_text = "#{item.item_enum} Not Available - #{status_text}, Due on #{status_date}"
+          else
+            status_text = "Not Available - #{status_text}, Due on #{status_date}."
+          end
+        else  
+          status_date = item.item_status_date.strftime(@@date_format) unless item.item_status_date.nil?
+          if (!item.item_enum.nil?)
+            status_text = "#{item.item_enum} Not Available - #{status_text} #{status_date}"
+          else
+            status_text = "#{status_text} #{status_date}."
+          end
+        end
+      end
+      return [status_available, status_text]
+   end
+
+  end
+end

data/lib/uw_catalog/model/item.rb

@@ -0,0 +1,16 @@
+module UwCatalog
+  class Item
+    attr_accessor :id, :item_enum, :copy_number, :on_reserve, :item_status, 
+                  :item_barcode,  
+                  :item_status_date, :current_due_date, :hold_recall_status_date
+
+    def initialize(h=Hash.new)
+      h.each {|k,v| send("#{k}=",v)}
+    end
+
+    def ==(another_item)
+      self.id == another_item.id
+    end
+
+  end
+end

data/lib/uw_catalog/model/items_listing.rb

@@ -0,0 +1,6 @@
+module UwCatalog
+  class ItemsListing
+    attr_accessor :holding_id, :location_id, :location_display_name, :display_call_no, :item_id, :item_status,
+                :item_status_date, :current_due_date, :hold_recall_status_date, :item_barcode, :on_reserve
+  end
+end

data/lib/uw_catalog/model/location.rb

@@ -0,0 +1,36 @@
+module UwCatalog
+  class Location
+
+    attr_accessor :id, :location, :holdings
+
+    def initialize(h=Hash.new)
+      @holdings = Array.new
+      h.each {|k,v| send("#{k}=",v)}
+    end
+
+    def ==(another_loc)
+      self.id == another_loc.id
+    end
+
+    def display_location
+      location
+    end
+
+    def add_holding(holding)
+      idx = @holdings.index(holding)
+      if idx.nil?
+        holdings << holding
+      end
+    end
+
+    def get_holding(holding)
+      idx = @holdings.index(holding)
+      if idx.nil?
+        nil
+      else
+        @holdings.at(idx)
+      end
+    end
+
+  end
+end

data/lib/uw_catalog/version.rb

@@ -0,0 +1,3 @@
+module UwCatalog
+  VERSION = "0.0.2"
+end

data/lib/uw_catalog/voyager_item_status.rb

@@ -0,0 +1,49 @@
+module UwCatalog
+  class VoyagerItemStatus
+    @@item_statuses = 
+      {
+        0 => { :voyager_identifer => 0, :available => false, :forward_status => "Unknown", :display_date => false, :rank => 25 },
+        1 => { :voyager_identifer => 1, :available => true, :forward_status => "Available", :display_date => false, :rank => 20 },
+        2 => { :voyager_identifer => 2, :available => false, :forward_status => "Checked Out", :display_date => true, :rank => 7 },
+        3 => { :voyager_identifer => 3, :available => false, :forward_status => "Checked Out", :display_date => true, :rank => 8 },
+        4 => { :voyager_identifer => 4, :available => false, :forward_status => "Overdue", :display_date => true, :rank => 9 },
+        5 => { :voyager_identifer => 5, :available => false, :forward_status => "Recalled", :display_date => true, :rank => 14 },
+        6 => { :voyager_identifer => 6, :available => false, :forward_status => "Requested", :display_date => true, :rank => 15 },
+        7 => { :voyager_identifer => 7, :available => false, :forward_status => "On Hold", :display_date => true, :rank => 10 },
+        8 => { :voyager_identifer => 8, :available => false, :forward_status => "In Transit", :display_date => true, :rank => 11 },
+        9 => { :voyager_identifer => 9, :available => false, :forward_status => "In Transit", :display_date => true, :rank => 12 },
+        10 => { :voyager_identifer => 10, :available => false, :forward_status => "In Transit", :display_date => true, :rank => 13 },
+        11 => { :voyager_identifer => 11, :available => true, :forward_status => "Available", :display_date => false, :rank => 19 },
+        12 => { :voyager_identifer => 12, :available => false, :forward_status => "Missing", :display_date => true, :rank => 5 },
+        13 => { :voyager_identifer => 13, :available => false, :forward_status => "Lost", :display_date => true, :rank => 4 },
+        14 => { :voyager_identifer => 14, :available => false, :forward_status => "Lost", :display_date => true, :rank => 3 },
+        15 => { :voyager_identifer => 15, :available => false, :forward_status => "Missing", :display_date => true, :rank => 23 },
+        16 => { :voyager_identifer => 16, :available => false, :forward_status => "Damaged", :display_date => true, :rank => 24 },
+        17 => { :voyager_identifer => 17, :available => false, :forward_status => "Withdrawn", :display_date => true, :rank => 25 },
+        18 => { :voyager_identifer => 18, :available => false, :forward_status => "At Bindery", :display_date => true, :rank => 6 },
+        19 => { :voyager_identifer => 19, :available => true, :forward_status => "Needed By Circulation Staff", :display_date => false, :rank => 21 },
+        20 => { :voyager_identifer => 20, :available => true, :forward_status => "Needed By Cataloging Staff", :display_date => false, :rank => 22 },
+        21 => { :voyager_identifer => 21, :available => false, :forward_status => "Scheduled", :display_date => true, :rank => 1 },
+        22 => { :voyager_identifer => 22, :available => false, :forward_status => "In Process", :display_date => true, :rank => 2 },
+        23 => { :voyager_identifer => 23, :available => false, :forward_status => "Requested", :display_date => true, :rank => 18 },
+        24 => { :voyager_identifer => 24, :available => false, :forward_status => "Requested", :display_date => true, :rank => 16 },
+        25 => { :voyager_identifer => 25, :available => false, :forward_status => "Requested", :display_date => true, :rank => 17 }
+      }
+    def self.status_guide(status_code)
+      @@item_statuses[status_code]
+    end
+
+    def available?(itemStatusCode)
+      item_statuses[itemStatusCode][:available]
+    end
+    
+    def forward_status
+      item_statuses[itemStatusCode][:forward_status]
+    end
+    
+    def display_date?
+      item_statuses[itemStatusCode][:display_date]
+    end
+    
+  end
+end

data/lib/uw_catalog/voyager_sql.rb

@@ -0,0 +1,80 @@
+module UwCatalog
+
+  class VoyagerSql
+
+    def self.get_bibliographic_sql()
+      "select distinct bib_text.bib_id as bibid, bib_text.author as author, bib_text.title_brief as title, " + 
+      "bib_text.edition, bib_text.pub_place, bib_text.publisher as publisher, bib_text.publisher_date as publish_date " +
+      "from bib_text, bib_mfhd, mfhd_master, location " + 
+      "where bib_text.bib_id=? " + 
+      "and bib_text.bib_id=bib_mfhd.bib_id " + 
+      "and bib_mfhd.mfhd_id=mfhd_master.mfhd_id " + 
+      "and mfhd_master.location_id=location.location_id " + 
+      "and location.suppress_in_opac='N'"
+    end
+
+    def self.get_holdings_with_items_sql()
+      "select distinct mfhd_master.mfhd_id as holding_id," + 
+      "mfhd_master.location_id, " +
+      "hloc.location_display_name as location," +
+      "item.temp_location as temp_location_id," +          
+      "iloc.location_display_name as temp_location," +  
+      "mfhd_master.display_call_no," + 
+      "mfhd_item.item_enum," +     
+      "item.item_id, " +
+      "item.copy_number," +
+      "item.on_reserve, " +
+      "item.item_type_id," +
+      "item_barcode.item_barcode, " +
+      "item_status.item_status, " +
+      "item_status.item_status_date," +
+      "circ_transactions.current_due_date, " +
+      "hold_recall_items.hold_recall_status_date " +
+      "from bib_mfhd, mfhd_master, location hloc, location iloc, mfhd_item, item, item_status, item_barcode " +
+      ", circ_transactions, hold_recall_items " +
+      "where bib_mfhd.bib_id=? " + 
+      "and bib_mfhd.mfhd_id=mfhd_master.mfhd_id " +
+      "and mfhd_master.location_id=hloc.location_id " + 
+      "and mfhd_master.suppress_in_opac='N' " +
+      "and hloc.suppress_in_opac='N' " +
+      "and mfhd_master.mfhd_id=mfhd_item.mfhd_id " +
+      "and mfhd_item.item_id=item.item_id " +
+      "and item.temp_location=iloc.location_id (+) " + 
+      "and item.item_id=item_status.item_id " +
+      "and item.item_id=item_barcode.item_id " + 
+      "and item_barcode.barcode_status=1 " +
+      "and item.item_id=circ_transactions.item_id (+) " +
+      "and item.item_id=hold_recall_items.item_id (+) "
+    end
+
+    def self.get_holdings_without_items_sql()
+      "select distinct mfhd_master.mfhd_id as holding_id," + 
+      "mfhd_master.location_id, " +
+      "location.location_display_name as location," + 
+      "null as temp_location_id," +
+      "null as temp_location," +  
+      "mfhd_master.display_call_no," +  
+      "null as item_enum, " +  
+      "null as item_id, " +
+      "null as copy_number, " +
+      "null as perm_location, " +
+      "null as temp_location, " +
+      "null as on_reserve, " +
+      "null as item_type_id," +
+      "null as item_barcode, " +
+      "null as item_status, " +
+      "null as item_sequence_number," + 
+      "null as item_status_date," +
+      "null as current_due_date, " + 
+      "null as hold_recall_status_date " + 
+      "from bib_mfhd, mfhd_master, location " +
+      "where bib_mfhd.bib_id=? " + 
+      "and bib_mfhd.mfhd_id=mfhd_master.mfhd_id " +
+      "and mfhd_master.location_id=location.location_id " + 
+      "and mfhd_master.suppress_in_opac='N' " +
+      "and location.suppress_in_opac='N' " +
+      "and not exists (select 'x' from mfhd_item mi where mi.mfhd_id = mfhd_master.mfhd_id)"
+    end
+
+  end
+end

data/uw_catalog.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uw_catalog/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "uw_catalog"
+  gem.version       = UwCatalog::VERSION
+  gem.authors       = ["Ev Krylova"]
+  gem.email         = ["ekrylova@wisc.edu"]
+  gem.description   = %q{Gem for the University of Wisconsin Library Voyager catalog data}
+  gem.summary       = %q{Use UW-Madison Voyager catalog data}
+  gem.homepage      = "https://github.com/ekrylova/uw_catalog"
+  
+  gem.add_dependency('data_mapper', '~>1.2.0')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.files         = [
+     # "Gemfile",
+     # "Rakefile",
+      "uw_catalog.gemspec",
+      "lib/uw_catalog.rb",
+      "lib/uw_catalog/model/location.rb",
+      "lib/uw_catalog/model/holding.rb",
+      "lib/uw_catalog/model/bib_data.rb",
+      "lib/uw_catalog/model/item.rb",
+      "lib/uw_catalog/model/items_listing.rb",
+      "lib/uw_catalog/version.rb",
+      "lib/uw_catalog/catalog.rb",
+      "lib/uw_catalog/data_loader.rb",
+      "lib/uw_catalog/voyager_item_status.rb",
+      "lib/uw_catalog/voyager_sql.rb"
+    ]
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'yard'
+
+  gem.add_dependency('data_mapper', '~> 1.2.0')
+  gem.add_dependency('dm-oracle-adapter', '~> 1.2.0')
+  gem.add_dependency('ruby-oci8', '~> 2.1.3')
+
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: uw_catalog
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ev Krylova
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dm-oracle-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: ruby-oci8
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+description: Gem for the University of Wisconsin Library Voyager catalog data
+email:
+- ekrylova@wisc.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- uw_catalog.gemspec
+- lib/uw_catalog.rb
+- lib/uw_catalog/model/location.rb
+- lib/uw_catalog/model/holding.rb
+- lib/uw_catalog/model/bib_data.rb
+- lib/uw_catalog/model/item.rb
+- lib/uw_catalog/model/items_listing.rb
+- lib/uw_catalog/version.rb
+- lib/uw_catalog/catalog.rb
+- lib/uw_catalog/data_loader.rb
+- lib/uw_catalog/voyager_item_status.rb
+- lib/uw_catalog/voyager_sql.rb
+homepage: https://github.com/ekrylova/uw_catalog
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Use UW-Madison Voyager catalog data
+test_files: []
+has_rdoc: