voyager_oracle_api 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activesupport"
+gem 'i18n'
+gem 'ruby-oci8'
+gem 'json'
+gem 'activesupport'
+
+# 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,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    growl (1.0.3)
+    guard (0.6.3)
+      thor (~> 0.14.6)
+    guard-minitest (0.4.0)
+      guard (~> 0.4)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.7.5)
+    metaclass (0.0.1)
+    minitest (2.5.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    rake (0.9.2)
+    rb-fsevent (0.4.3.1)
+    rcov (0.9.10)
+    ruby-oci8 (2.1.2)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (> 1.0.0)
+  growl
+  guard-minitest
+  i18n
+  jeweler (~> 1.6.4)
+  json
+  minitest
+  mocha
+  rb-fsevent
+  rcov
+  ruby-oci8

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_oracle_api
+
+Description goes here.
+
+== Contributing to voyager_oracle_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,59 @@
+# 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_oracle_api"
+  gem.homepage = "http://github.com/cul/voyager_oracle_api"
+  gem.license = "MIT"
+  gem.summary = %Q{Columbia University Voyager Oracle API wrapper}
+  gem.description = %Q{Middleware gem for Voyager Oracle API calls, specificially holdings information }
+  gem.email = "github@jamesstuart.org"
+  gem.authors = ["James Stuart", "Gary Bertchume"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+Dir.glob(File.join(File.dirname(__FILE__), "tasks", "**", "*.rake")).each { |f| load f }
+
+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_oracle_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+

data/VERSION

@@ -0,0 +1 @@
+0.1.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/collection.rb

@@ -0,0 +1,33 @@
+module Voyager
+  class Collection
+    attr_reader :holdings, :holdings_status
+    
+    def initialize(args = {})
+      @connection = args[:connection] || raise("Must pass a connection")
+      @bibid = args[:bibid] || raise("Must pass a bibid")
+      @bibid = @bibid.to_s
+            
+      parse_results
+      
+    end
+    
+    def to_hash(args = {})
+      {
+        statuses: @holdings_status.to_hash(args)
+      }
+    end
+    
+    private
+    
+    def parse_results
+      results = @connection.results['retrieve_holdings'][@bibid]
+     
+      @holdings = results.reject { |r| r["MFHD_ID"].nil? }
+      status = Status.new(holdings)
+      
+      @holdings_status = status.statuses
+
+    end
+    
+  end
+end

data/lib/oracle_connection.rb

@@ -0,0 +1,94 @@
+module Voyager
+  class OracleConnection
+
+    attr_reader :connection
+    attr_accessor :results 
+
+    def initialize(args = {})
+      @connection = args['connection'] 
+
+
+      unless args.has_key?('connection')
+        app_config_filename = File.join(File.dirname(__FILE__), "..",  "config" ,"app_config.yml")
+
+        args = YAML.load_file(app_config_filename)['oracle_connection_details'] if args == {} and File.exists?(app_config_filename)
+
+        raise "Need argument 'user'" unless args.has_key?('user') 
+        raise "Need argument 'password'" unless args.has_key?('password')
+        raise "Need argument 'service'" unless args.has_key?('service')
+
+        @connection = OCI8.new(args['user'], args['password'], args['service'])
+        @connection.prefetch_rows = 1000
+      end
+
+      @results = {}
+
+    end
+
+    
+    def retrieve_holdings(*bibids)
+      query = <<-HERE
+        select a.bib_id, a.mfhd_id, c.item_id, item_status
+        from bib_mfhd a, mfhd_master b, mfhd_item c, item_status d
+        where a.bib_id IN (~bibid~) and
+        b.mfhd_id = a.mfhd_id and
+        suppress_in_opac = 'N' and
+        c.mfhd_id (+) = b.mfhd_id and
+        d.item_id (+) = c.item_id
+        order by c.mfhd_id, c.item_id, item_status
+      HERE
+
+
+      raw_results = execute_select_command(query, bibid: bibids)
+      parse_results(raw_results, name: 'retrieve_holdings', hash_by: 'BIB_ID')
+    end
+
+
+    private
+
+    def parse_results(results, *args)
+      options = args.extract_options!
+      @results[options[:name]] ||= {}
+      result_hash = @results[options[:name]]
+
+      results.each do |row|
+        if (key = row[options[:hash_by]])
+          result_hash[key] ||= []
+          result_hash[key] << row
+        end
+      end
+
+      return result_hash
+    end
+
+
+
+
+    def execute_select_command(query, *args)
+      options = args.extract_options!
+      options.each do |name, value|
+        value = [value] unless value.kind_of?(Array)
+        formatted_value = value.collect { |item| "'#{item.to_s.gsub("'","''")}'"}.join(',')
+        query.gsub!("~#{name.to_s}~",formatted_value)
+      end
+
+
+      cursor = @connection.parse(query)
+
+      results = []
+      cursor.exec
+      
+      cursor.fetch_hash do |row|
+        results << row
+      end
+
+      cursor.close
+
+      return results
+
+    
+    end
+
+
+  end
+end