exlibris-primo 0.1.1 → 0.1.4

data/README.rdoc

@@ -1,4 +1,7 @@
 = Exlibris::Primo
+{<img src="https://secure.travis-ci.org/scotdalton/exlibris-primo.png" alt="Build Status" />}[https://secure.travis-ci.org/scotdalton/exlibris-primo]
+{<img src="https://gemnasium.com/scotdalton/exlibris-primo.png" alt="Dependency Status" />}[https://gemnasium.com/scotdalton/exlibris-primo]
+{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/scotdalton/exlibris-primo]
 
 Exlibris::Primo offers a set of libraries for interacting with the ExLibris Primo APIs.
 
@@ -38,7 +41,7 @@ as instance variables.
 === Example of Exlibris::Primo::Record in action
   setup = { 
     :base_url => "http://primo.institution.edu", 
-    :resolver_base_url => "http://sfx.institution.edu", 
+    :resolver_base_url => "http://resolver.institution.edu", 
     :vid => "VID", 
     :institution => "DEFAULT", 
     :record_id => "PrimoRecordId" 
@@ -55,7 +58,7 @@ The Exlibris::Primo::EShelf class provides methods for reading a given user's Pr
   setup = { 
     :base_url => "http://primo.institution.edu", 
     :vid => "VID", 
-    :resolver_base_url => "http://sfx.institution.edu"
+    :resolver_base_url => "http://resolver.institution.edu"
   }
   eshelf = Exlibris::Primo::EShelf.new(setup, "USER_ID", "PRIMO")
   records = eshelf.records

data/Rakefile

@@ -20,9 +20,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -34,5 +31,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
-task :default => :test
+task :default => :test

data/lib/exlibris/primo/eshelf.rb

@@ -8,13 +8,14 @@ module Exlibris
     #   :base_url, :resolver_base_url, :vid, :config
     #
     # == Examples of usage
-    #   Exlibris::Primo::EShelf.new({ :base_url => "http://primo.institution.edu", :vid => "VID", :resolver_base_url => "http://sfx.institution.edu"} , "USER_ID", "PRIMO").count
+    #   Exlibris::Primo::EShelf.new({ :base_url => "http://primo.institution.edu", :vid => "VID", :resolver_base_url => "http://resolver.institution.edu"} , "USER_ID", "PRIMO").count
     #   Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute).basket_id
     class EShelf
       
       #Namespaces
       SEAR_NS = {'sear' => 'http://www.exlibrisgroup.com/xsd/jaguar/search'}
       PRIM_NS = {'prim' => 'http://www.exlibris.com/primo/xsd/primoeshelffolder'}
+      PRIM_BIB_NS = {'bib' => 'http://www.exlibrisgroup.com/xsd/primo/primo_nm_bib'}
       
       def initialize(setup, user_id, institution)
         @base_url = setup[:base_url]
@@ -49,7 +50,7 @@ module Exlibris
       # Fetch all records from user's Eshelf as an array of Primo Record objects
       def records    
         eshelf.search("//sear:DOC", SEAR_NS).each { |doc|
-          @records.push(Record.new({ :base_url => @base_url, :resolver_base_url => @resolver_base_url, :vid => @vid, :record => doc.at("//xmlns:record", doc.namespaces), :institution => @institution }))
+          @records.push(Record.new({ :base_url => @base_url, :resolver_base_url => @resolver_base_url, :vid => @vid, :record => doc.at("//bib:record", PRIM_BIB_NS), :institution => @institution }))
         } if @records.empty?
         return @records
       end
@@ -77,4 +78,4 @@ module Exlibris
       end
     end
   end
-end
+end

data/lib/exlibris/primo/holding.rb

@@ -143,16 +143,8 @@ module Exlibris
       # Return this holding as a new holdings subclass instance based on source
       def to_source
         return self if @source_class.nil?
-        begin
-          # Get source class in Primo::Source module
-           return Exlibris::Primo::Source.const_get(@source_class).new(:holding => self)
-        rescue Exception => e
-          Rails.logger.error("#{e.message}")
-          Rails.logger.error("Class #{@source_class} can't be found in Exlibris::Primo::Source.  
-            Please check primo.yml to ensure the class_name is defined correctly.  
-            Not converting to source.")
-          return self
-        end
+        # Get source class in Primo::Source module
+        return Exlibris::Primo::Source.const_get(@source_class).new(:holding => self)
       end
 
       # Convenience method for making base attributes accessible via Hash-like syntax.

data/lib/exlibris/primo/record.rb

@@ -23,7 +23,10 @@ module Exlibris
     # == Examples of usage
     #   Record.new({ :base_url => @base_url, :vid => @vid, :record => doc.at("//record") })
     class Record
-      
+      # Leverage ActiveSupport's Hash#from_xml method to transform PNX to JSON.
+      require 'active_support/core_ext'
+      require 'json'      
+
       SEAR_NS = {'sear' => 'http://www.exlibrisgroup.com/xsd/jaguar/search'}
       attr_reader :record_id, :type, :title, :url, :openurl, :creator, :raw_xml
       
@@ -65,13 +68,15 @@ module Exlibris
           }
       end
       
+      # Return a JSON representation of the PNX record
+      def to_json
+        # Leverage ActiveSupport's Hash#from_xml method to transform PNX to JSON.
+        Hash.from_xml(raw_xml).to_json
+      end
+      
       # Method for cleaning up raw xml from record
       def raw(record)
-          raw = "<record>"
-          # Hack to strip out spacing in record
-          record.children.each{|child| raw << child.to_xml.gsub(/\n\s*/, "").gsub(/\s$/, "")}
-          raw << "</record>"
-          return raw
+        record.to_xml(:indent => 0, :encoding => 'UTF-8')
       end
 
       private

data/lib/exlibris/primo/searcher.rb

@@ -8,7 +8,7 @@ module Exlibris
     #     * We have either an isbn OR an issn
     #     * We have a title AND an author AND a genre
     # If none of these criteria are met, Exlibris::Primo::Searcher.search
-    # will log a warning in the Rails log.
+    # will not perform the search.
     # Exlibris::Primo::Searcher will populate the following instance variables
     # accessible through readers:
     #   :count, :holdings, :rsrcs, :tocs, :related_links
@@ -59,9 +59,7 @@ module Exlibris
       # Process URLs based on links/linktorsrc
       # Process TOCs based on links/linktotoc
       def search
-        Rails.logger.warn("Insufficient search terms for #{self.class}. "+
-          "Please refer to #{self.class}'s documentation to determine how to structure "+
-          "a sufficient query.") and return if insufficient_query?
+        return if insufficient_query?
         # Call Primo Web Services
         unless @primo_id.nil? or @primo_id.empty?
           get_record = Exlibris::Primo::WebService::GetRecord.new(@primo_id, @base_url, {:institution => @institution}) 

data/lib/exlibris/primo/version.rb

@@ -1,5 +1,5 @@
 module Exlibris
   module Primo
-    VERSION = "0.1.1"
+    VERSION = "0.1.4"
   end
-end
+end

data/test/exlibris-primo_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
-class ExlibrisPrimoTest < ActiveSupport::TestCase
-  test "truth" do
+class ExlibrisPrimoTest < Test::Unit::TestCase
+  def test_truth
     assert_kind_of Module, Exlibris::Primo
   end
-end
+end

data/test/test_helper.rb

@@ -1,10 +1,36 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+require 'test/unit'
+require File.expand_path("../../lib/exlibris-primo.rb",  __FILE__)
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
+# VCR is used to 'record' HTTP interactions with
+# third party services used in tests, and play em
+# back. Useful for efficiency, also useful for
+# testing code against API's that not everyone
+# has access to -- the responses can be cached
+# and re-used. 
+require 'vcr'
+require 'webmock'
 
-Rails.backtrace_cleaner.remove_silencers!
+# To allow us to do real HTTP requests in a VCR.turned_off, we
+# have to tell webmock to let us. 
+WebMock.allow_net_connect!(:net_http_connect_on_start => true)
+
+without_ctx_tim = VCR.request_matchers.uri_without_param(:ctx_tim)
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/vcr_cassettes'
+  # webmock needed for HTTPClient testing
+  c.hook_into :webmock 
+  c.register_request_matcher(:uri_without_ctx_tim, &without_ctx_tim)
+  # c.debug_logger = $stderr
+end
+
+# Silly way to not have to rewrite all our tests if we
+# temporarily disable VCR, make VCR.use_cassette a no-op
+# instead of no-such-method. 
+if ! defined? VCR
+  module VCR
+    def self.use_cassette(*args)
+      yield
+    end
+  end
+end
 
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/test/unit/eshelf_test.rb

@@ -1,152 +1,171 @@
 require 'test_helper'
 
-class EShelfTest < ActiveSupport::TestCase
+class EShelfTest < Test::Unit::TestCase
   PNX_NS = {'pnx' => 'http://www.exlibrisgroup.com/xsd/primo/primo_nm_bib'}
   SEARCH_NS = {'search' => 'http://www.exlibrisgroup.com/xsd/jaguar/search'}
   SEAR_NS = {'sear' => 'http://www.exlibrisgroup.com/xsd/jaguar/search'}
   PRIM_NS = {'prim' => 'http://www.exlibris.com/primo/xsd/primoeshelffolder'}
 
   def setup
-      @primo_definition = YAML.load( %{
-          type: PrimoService
-          priority: 2 # After SFX, to get SFX metadata enhancement
-          status: active
-          base_url: http://bobcat.library.nyu.edu
-          resolver_base_url: https://getit.library.nyu.edu/resolve
-          vid: NYU
-          institution: NYU
-          holding_search_institution: NYU
-          holding_search_text: Search for this title in BobCat.
-          suppress_holdings: [ !ruby/regexp '/\$\$LBWEB/', !ruby/regexp '/\$\$LNWEB/', !ruby/regexp '/\$\$LTWEB/', !ruby/regexp '/\$\$LWEB/', !ruby/regexp '/\$\$1Restricted Internet Resources/' ]
-          ez_proxy: !ruby/regexp '/https\:\/\/ezproxy\.library\.nyu\.edu\/login\?url=/'
-          service_types:
-            - primo_source
-            - holding_search
-            - fulltext
-            - table_of_contents
-            - referent_enhance
-            - cover_image
-        })
-
-      @base_url = @primo_definition["base_url"]
-      @vid = @primo_definition["vid"]
-      @valid_user_id = "N18158418"
-      @invalid_user_id = "INVALID_USER"
-      @eshelf_setup = {
-          :base_url => @base_url,
-          :vid => @vid,
-          :resolver_base_url => @primo_definition["resolver_base_url"]
-      }
-      @valid_institute = "NYU"
-      @invalid_institute = "INVALID_INST"
-      @valid_doc_ids = ["nyu_aleph000062856"]
-      @invalid_doc_ids = ["INVALID_DOC_ID"]
-      @valid_basket = "298560007"
-      #@valid_folder = "344619707"
-      @invalid_basket = "INVALID_BASKET"
+    @primo_definition = YAML.load( %{
+      type: PrimoService
+      priority: 2 # After SFX, to get SFX metadata enhancement
+      status: active
+      base_url: http://bobcat.library.nyu.edu
+      resolver_base_url: https://getit.library.nyu.edu/resolve
+      vid: NYU
+      institution: NYU
+      holding_search_institution: NYU
+      holding_search_text: Search for this title in BobCat.
+      suppress_holdings: [ !ruby/regexp '/\$\$LBWEB/', !ruby/regexp '/\$\$LNWEB/', !ruby/regexp '/\$\$LTWEB/', !ruby/regexp '/\$\$LWEB/', !ruby/regexp '/\$\$1Restricted Internet Resources/' ]
+      ez_proxy: !ruby/regexp '/https\:\/\/ezproxy\.library\.nyu\.edu\/login\?url=/'
+      service_types:
+        - primo_source
+        - holding_search
+        - fulltext
+        - table_of_contents
+        - referent_enhance
+        - cover_image })
+    @base_url = @primo_definition["base_url"]
+    @vid = @primo_definition["vid"]
+    @valid_user_id = "N18158418"
+    @invalid_user_id = "INVALID_USER"
+    @eshelf_setup = {
+      :base_url => @base_url,
+      :vid => @vid,
+      :resolver_base_url => @primo_definition["resolver_base_url"] }
+    @valid_institute = "NYU"
+    @invalid_institute = "INVALID_INST"
+    @valid_doc_ids = ["nyu_aleph000062856"]
+    @invalid_doc_ids = ["INVALID_DOC_ID"]
+    @valid_basket = "298560007"
+    #@valid_folder = "344619707"
+    @invalid_basket = "INVALID_BASKET"
   end
 
-  test "new" do
-      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
-      assert_not_nil(eshelf, "#{eshelf.class} returned nil when instantiated.")
-   
-      assert_equal(@base_url, eshelf.instance_variable_get(:@base_url))
-      assert_equal(@vid, eshelf.instance_variable_get(:@vid))
-      assert_equal(@valid_user_id, eshelf.instance_variable_get(:@user_id))
-      assert_equal(@valid_institute, eshelf.instance_variable_get(:@institution))
-    
-      assert_nothing_raised{Exlibris::Primo::EShelf.new({:base_url => @base_url}, @valid_user_id, @valid_institute)}
-      assert_nothing_raised{Exlibris::Primo::EShelf.new({:base_url => @base_url, :vid => @vid}, @valid_user_id, @valid_institute)}
-      
-      assert_raise(ArgumentError){Exlibris::Primo::EShelf.new({}, @valid_user_id, @valid_institute)}
-      assert_raise(ArgumentError){Exlibris::Primo::EShelf.new(@eshelf_setup, nil, nil)}
-      assert_raise(ArgumentError){Exlibris::Primo::EShelf.new(@eshelf_setup, nil, nil)}
-      assert_raise(ArgumentError){Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, nil)}
-
+  def test_new
+    eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+    assert_not_nil(eshelf, "#{eshelf.class} returned nil when instantiated.")
+    assert_equal(@base_url, eshelf.instance_variable_get(:@base_url))
+    assert_equal(@vid, eshelf.instance_variable_get(:@vid))
+    assert_equal(@valid_user_id, eshelf.instance_variable_get(:@user_id))
+    assert_equal(@valid_institute, eshelf.instance_variable_get(:@institution))
+    assert_nothing_raised{Exlibris::Primo::EShelf.new({:base_url => @base_url}, @valid_user_id, @valid_institute)}
+    assert_nothing_raised{Exlibris::Primo::EShelf.new({:base_url => @base_url, :vid => @vid}, @valid_user_id, @valid_institute)}
+    assert_raise(ArgumentError){Exlibris::Primo::EShelf.new({}, @valid_user_id, @valid_institute)}
+    assert_raise(ArgumentError){Exlibris::Primo::EShelf.new(@eshelf_setup, nil, nil)}
+    assert_raise(ArgumentError){Exlibris::Primo::EShelf.new(@eshelf_setup, nil, nil)}
+    assert_raise(ArgumentError){Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, nil)}
   end
 
-  test "valid_eshelf" do
-      eshelf = nil
+  def test_valid_eshelf
+    eshelf = nil
+    assert_nil(eshelf)
+    VCR.use_cassette('eshelf valid eshelf') do
       assert_nothing_raised{eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute).eshelf}
       assert_not_nil(eshelf)
       assert_instance_of(Nokogiri::XML::Document, eshelf)
+    end
   end
 
-  test "valid_eshelf_structure" do
+  def test_valid_eshelf_structure
+    VCR.use_cassette('eshelf valid eshelf structure') do
       eshelfStructure = nil
+      assert_nil(eshelfStructure)
       assert_nothing_raised{eshelfStructure = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute).eshelfStructure}
       assert_not_nil(eshelfStructure)
       assert(eshelfStructure.is_a? Nokogiri::XML::Document)
+    end
   end
-  
-  test "basket_id" do
+
+  def test_basket_id
+    VCR.use_cassette('eshelf valid eshelf structure') do
       assert_equal(@valid_basket, Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute).basket_id)
+    end
   end
 
-  test "invalid_user_eshelf" do
-      ws = nil
-      assert_nothing_raised(){ws = Exlibris::Primo::EShelf.new(@eshelf_setup, @invalid_user_id, @valid_institute)}
-      assert_not_nil(ws)
-      eshelf = nil
+  def test_invalid_user_eshelf
+    ws = nil
+    assert_nil(ws)
+    assert_nothing_raised(){ws = Exlibris::Primo::EShelf.new(@eshelf_setup, @invalid_user_id, @valid_institute)}
+    assert_not_nil(ws)
+    eshelf = nil
+    assert_nil(eshelf)
+    VCR.use_cassette('eshelf invalid eshelf') do
       assert_nothing_raised(){eshelf = ws.eshelf}
       assert_not_nil(eshelf)
       assert_instance_of(Nokogiri::XML::Document, eshelf)
       assert_equal(0, ws.count)
+    end
   end
-  
-  test "invalid_institution_eshelf" do
-      ws = nil
-      assert_nothing_raised(){ws = Exlibris::Primo::EShelf.new(@eshelf_setup, @invalid_user_id, @valid_institute)}
-      assert_not_nil(ws)
-      eshelf = nil
+
+  def test_invalid_institution_eshelf
+    ws = nil
+    assert_nil(ws)
+    assert_nothing_raised(){ws = Exlibris::Primo::EShelf.new(@eshelf_setup, @invalid_user_id, @valid_institute)}
+    assert_not_nil(ws)
+    eshelf = nil
+    assert_nil(eshelf)
+    VCR.use_cassette('eshelf invalid institution') do
       assert_nothing_raised(){eshelf = ws.eshelf}
       assert_not_nil(eshelf)
       assert_instance_of(Nokogiri::XML::Document, eshelf)
       assert_equal(0, ws.count)
+    end
   end
 
-  test "records" do
-      records = nil
+  def test_records
+    records = nil
+    assert_nil(records)
+    VCR.use_cassette('eshelf valid eshelf') do
       assert_nothing_raised(){records = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute).records}
       assert_not_nil(records)
       assert_instance_of(Array, records)
       assert(!records.empty?, "Eshelf records returned empty")
+    end
   end
 
-  test "cant_add_same_record_twice" do
-      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
-      assert_not_nil(eshelf)
+  def test_cant_add_same_record_twice
+    eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+    assert_not_nil(eshelf)
+    VCR.use_cassette('eshelf add same record twice') do
       # Add record
       assert_nothing_raised(){ eshelf.add_records(@valid_doc_ids, @valid_basket) }
       # Add same record again
       assert_raise(RuntimeError){ eshelf.add_records(@valid_doc_ids, @valid_basket) }
       # Remove record
       assert_nothing_raised(){ eshelf.remove_records(@valid_doc_ids, @valid_basket) }
+    end
   end
   
-  test "cant_add_invalid_records" do
-      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
-      assert_not_nil(eshelf)
+  def test_cant_add_invalid_records
+    eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+    assert_not_nil(eshelf)
+    VCR.use_cassette('eshelf add invalid records') do
       # Attempt to add record
       assert_raise(RuntimeError){ eshelf.add_records(@invalid_doc_ids, @valid_basket) }
       # Attempt to remove record which was never added
       assert_raise(RuntimeError){ eshelf.remove_records(@invalid_doc_ids, @valid_basket) }
+    end
   end
   
-  test "cant_add_to_invalid_basket" do
-      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
-      assert_not_nil(eshelf)
+  def test_cant_add_to_invalid_basket
+    eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+    assert_not_nil(eshelf)
+    VCR.use_cassette('eshelf add to invalid basket') do
       # Attempt to add record to basket with invalid folder name
       assert_raise(RuntimeError){ eshelf.add_records(@valid_doc_ids, @invalid_basket) }
+    end
   end
   
-  test "can_add_to_empty_folder" do
-      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
-      assert_not_nil(eshelf)
+  def test_can_add_to_empty_folder
+    eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+    assert_not_nil(eshelf)
+    VCR.use_cassette('eshelf add to empty basket') do
       # Add record to basket with no folder id
       assert_nothing_raised(){ eshelf.add_records(@valid_doc_ids, nil) }
       # Remove record from basket with no folder id
       assert_nothing_raised(){ eshelf.remove_records(@valid_doc_ids, @valid_basket) }
+    end
   end
-  
-end
+end