exlibris-primo 0.1.5 → 1.0.0

data/lib/exlibris/primo/write_attributes.rb

@@ -0,0 +1,38 @@
+module Exlibris
+  module Primo
+    # 
+    # Write passed in arguments to instance attributes
+    # 
+    module WriteAttributes
+
+      def initialize *args
+        # Just call super w/o any args for now.  Eventually, we'll want to check the arity and adjust.
+        # self.class.superclass.instance_method(:initialize).arity.eql? self.class.instance_method(:initialize).arity
+        super()
+        write_attributes args.last unless args.last.nil?
+      end
+
+      def write_attributes attributes
+        attributes.each do |attribute, value|
+          write_attribute attribute, value
+        end
+      end
+
+      def attributize symbol
+        symbol.id2name.sub(/=$/, "").to_sym
+      end
+      protected :attributize
+
+      def write_attribute attribute, value
+        attribute_writer = writify attribute
+        send attribute_writer, value if respond_to? attribute_writer
+      end
+      private :write_attribute
+
+      def writify key
+        "#{key}=".to_sym
+      end
+      private :writify
+    end
+  end
+end

data/lib/exlibris/primo/xml_util.rb

@@ -0,0 +1,63 @@
+module Exlibris
+  module Primo
+    # 
+    # Utility for parsing and building XML
+    # 
+    module XmlUtil
+      require 'nokogiri'
+
+      def self.included(klass)
+        klass.class_eval do
+          extend ClassAttributes
+        end
+      end
+
+      module ClassAttributes
+        def xml_options
+          @xml_options ||= {
+            :encoding => 'UTF-8',
+            :indent => 0,
+            :save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+          }
+        end
+      end
+
+      attr_reader :raw_xml
+      protected :raw_xml
+
+      # Returns an XML string and takes any args that are
+      # understood by Nokogiri::XML::Builder.
+      def build_xml options={}, &block
+        Nokogiri::XML::Builder.new(options.merge(:encoding => 'UTF-8'), &block).to_xml(xml_options).strip
+      end
+      protected :build_xml
+
+      def xml_options
+        @xml_options ||= self.class.xml_options
+      end
+      protected :xml_options
+
+      def xml
+        @xml ||= Nokogiri::XML(raw_xml)
+      end
+      protected :xml
+
+      def xml_without_namespaces
+        xml.clone.remove_namespaces!
+      end
+      protected :xml_without_namespaces
+
+      def to_hash
+        Hash.from_xml(to_xml)
+      end
+
+      def to_xml
+        xml.to_xml(xml_options).strip
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+    end
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+class ConfigTest < Test::Unit::TestCase
+  def test_config
+    reset_primo_configuration
+    Exlibris::Primo.configure do |config|
+      config.base_url = "test_url"
+      config.institution = "TEST_INSTITUTION"
+      config.libraries = { "LIB_CODE1" => "Manually Library Decoded 1", "LIB_CODE2" => "Manually Library Decoded 2",
+        "LIB_CODE3" => "Manually Library Decoded 3" }
+    end
+    assert_equal "test_url", Exlibris::Primo::Config.base_url
+    assert_equal "TEST_INSTITUTION", Exlibris::Primo::Config.institution
+    assert_equal({ "LIB_CODE1" => "Manually Library Decoded 1", "LIB_CODE2" => "Manually Library Decoded 2",
+      "LIB_CODE3" => "Manually Library Decoded 3" }, Exlibris::Primo::Config.libraries)
+    reset_primo_configuration
+  end
+
+  def test_config_from_yaml
+    reset_primo_configuration
+    yaml_primo_configuration
+    assert_equal "yaml_url", Exlibris::Primo::Config.base_url
+    assert_equal "YAML_INSTITUTION", Exlibris::Primo::Config.institution
+    assert_nil(Exlibris::Primo::Config.institutions)
+      assert_equal({ "LIB_CODE1" => "Library Decoded 1", "LIB_CODE2" => "Library Decoded 2",
+        "LIB_CODE3" => "Library Decoded 3" }, Exlibris::Primo::Config.libraries)
+    assert_equal({"processing"=>"In Processing",
+      "offsite"=>"Available Offsite", "in_transit"=>"In Processing",
+      "check_holdings"=>"Check Availability", "unavailable"=>"Unavailable",
+      "available"=>"Available", "requested"=>"Requested", "billed_as_lost"=>"Billed as Lost",
+      "request_ill"=>"Request ILL"}, Exlibris::Primo::Config.availability_statuses)
+    assert_equal({
+      "aleph"=> {"class_name"=>"Aleph", "base_url"=>"http://aleph.library.edu", "rest_url"=>"http://aleph.library.edu:1891/rest-dlf",
+        "local_base"=>"LOCAL01", "requestable_statuses"=>["available"], "sub_library_codes"=> { 
+          "LIB_CODE1"=>"AlephSubLibrary1", "LIB_CODE2"=>"AlephSubLibrary1", "LIB_CODE3"=>"AlephSubLibrary2"}},
+      "source2"=> {"source_config2"=>"Some other source 2 config", "source_config1"=>"Some source 2 config"}, 
+      "source1"=> {"source_config2"=>"Some other 1 source config", "source_config1"=>"Some source 1 config", 
+        "class_name"=>"Source1ClassName"}}, Exlibris::Primo::Config.sources)
+    assert_nil(Exlibris::Primo::Config.facet_labels)
+    assert_nil(Exlibris::Primo::Config.facet_top_level)
+    assert_nil(Exlibris::Primo::Config.facet_collections)
+    assert_nil(Exlibris::Primo::Config.facet_resource_types)
+    reset_primo_configuration
+  end
+
+  def test_config_attributes
+    reset_primo_configuration
+    yaml_primo_configuration
+    search = Exlibris::Primo::Search.new
+    assert_equal "yaml_url", search.base_url
+    assert_equal "YAML_INSTITUTION", search.institution
+    assert_equal({}, search.institutions)
+    assert_equal({ "LIB_CODE1" => "Library Decoded 1", "LIB_CODE2" => "Library Decoded 2",
+      "LIB_CODE3" => "Library Decoded 3" }, search.libraries)
+    assert_equal({"processing"=>"In Processing",
+      "offsite"=>"Available Offsite", "in_transit"=>"In Processing",
+      "check_holdings"=>"Check Availability", "unavailable"=>"Unavailable",
+      "available"=>"Available", "requested"=>"Requested", "billed_as_lost"=>"Billed as Lost",
+      "request_ill"=>"Request ILL"}, search.availability_statuses)
+    assert_equal({
+      "aleph"=> {"class_name"=>"Aleph", "base_url"=>"http://aleph.library.edu", "rest_url"=>"http://aleph.library.edu:1891/rest-dlf",
+        "local_base"=>"LOCAL01", "requestable_statuses"=>["available"], "sub_library_codes"=> { 
+          "LIB_CODE1"=>"AlephSubLibrary1", "LIB_CODE2"=>"AlephSubLibrary1", "LIB_CODE3"=>"AlephSubLibrary2"}},
+      "source2"=> {"source_config2"=>"Some other source 2 config", "source_config1"=>"Some source 2 config"}, 
+      "source1"=> {"source_config2"=>"Some other 1 source config", "source_config1"=>"Some source 1 config", 
+        "class_name"=>"Source1ClassName"}}, search.sources)
+    assert_equal({}, search.facet_labels)
+    assert_equal({}, search.facet_top_level)
+    assert_equal({}, search.facet_collections)
+    assert_equal({}, search.facet_resource_types)
+    reset_primo_configuration
+  end
+end

data/test/eshelf_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+class EshelfTest < Test::Unit::TestCase
+  def setup
+    @base_url = "http://bobcatdev.library.nyu.edu"
+    @isbn = "0143039008"
+    @user_id = "N12162279"
+    @institution = "NYU"
+    @eshelf_records = ["nyu_aleph000980206", "nyu_aleph000864162", "dedupmrg35761381"]
+    @eshelf_record = "nyu_aleph003531438"
+    @folder_name = "New Folder Eshelf"
+  end
+
+  def test_eshelf
+    eshelf = Exlibris::Primo::EShelf.new(:user_id => @user_id, 
+      :base_url => @base_url, :institution => @institution)
+    basket_id = ""
+    size = 0
+    VCR.use_cassette('eshelf records') do
+      assert_not_nil eshelf.records
+      assert((not eshelf.records.empty?))
+      assert_not_nil eshelf.size
+      size = eshelf.size
+    end
+    VCR.use_cassette('eshelf basket id') do
+      basket_id = eshelf.basket_id
+      assert_not_nil basket_id
+    end
+    VCR.use_cassette('eshelf add records') do
+      eshelf.add_records(@eshelf_records, basket_id)
+      assert_not_nil eshelf.records
+      assert((not eshelf.records.empty?))
+      assert_not_nil eshelf.size
+      assert_equal(size+3, eshelf.size)
+    end
+    VCR.use_cassette('eshelf add record') do
+      eshelf.add_record(@eshelf_record, basket_id)
+      assert_not_nil eshelf.records
+      assert((not eshelf.records.empty?))
+      assert_not_nil eshelf.size
+      assert_equal(size+4, eshelf.size)
+    end
+    VCR.use_cassette('eshelf remove records') do
+      eshelf.remove_records(@eshelf_records, basket_id)
+      assert_not_nil eshelf.records
+      assert_not_nil eshelf.size
+      assert_equal(size+1, eshelf.size)
+    end
+    VCR.use_cassette('eshelf remove record') do
+      eshelf.remove_record(@eshelf_record, basket_id)
+      assert_not_nil eshelf.records
+      assert_not_nil eshelf.size
+      assert_equal(size, eshelf.size)
+    end
+    VCR.use_cassette('eshelf add folder') do
+      assert_nil eshelf.folder_id(@folder_name)
+      eshelf.add_folder(@folder_name, basket_id)
+      assert_not_nil eshelf.folder_id(@folder_name)
+    end
+    VCR.use_cassette('eshelf remove folder') do
+      assert_not_nil eshelf.folder_id(@folder_name)
+      folder_id = eshelf.folder_id(@folder_name)
+      eshelf.remove_folder(folder_id)
+      assert_nil eshelf.folder_id(@folder_name)
+    end
+  end
+end

data/test/exlibris-primo_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-
 class ExlibrisPrimoTest < Test::Unit::TestCase
   def test_truth
     assert_kind_of Module, Exlibris::Primo

data/test/facet_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+class FacetTest < Test::Unit::TestCase
+  def test_new
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"creator\" COUNT=\"3\">"+
+      "<FACET_VALUES KEY=\"Author1, FirstName\" VALUE=\"3\"/>"+
+      "<FACET_VALUES KEY=\"Author2, FirstName\" VALUE=\"1\"/>"+
+      "</FACET>")
+    assert_equal "creator", facet.name
+    assert_equal "creator", facet.display_name
+    assert_equal 3, facet.size
+    assert_equal 2, facet.facet_values.size
+  end
+
+  def test_facet_label
+    Exlibris::Primo.configure do |config|
+      config.facet_labels = {"lcc" => "LC Subject Headings"}
+    end
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"lcc\" COUNT=\"3\">"+
+      "<FACET_VALUES KEY=\"A. Some Value\" VALUE=\"3\"/>"+
+      "<FACET_VALUES KEY=\"B. Some Other Value\" VALUE=\"1\"/>"+
+      "</FACET>")
+    assert_equal "lcc", facet.name
+    assert_equal "LC Subject Headings", facet.display_name
+    assert_equal 3, facet.size
+    assert_equal 2, facet.facet_values.size
+  end
+end

data/test/facet_value_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+class FacetValueTest < Test::Unit::TestCase
+  def test_new
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"creator\" COUNT=\"3\" />")
+    facet_value = Exlibris::Primo::FacetValue.new(:raw_xml => "<FACET_VALUES KEY=\"Greene, G\" VALUE=\"1\"/>", :facet => facet)
+    assert_equal "Greene, G", facet_value.name
+    assert_equal "Greene, G", facet_value.display_name
+    assert_equal 1, facet_value.count
+  end
+
+  def test_facet_lang
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"lang\" COUNT=\"3\" />")
+    facet_value = Exlibris::Primo::FacetValue.new(:raw_xml => "<FACET_VALUES KEY=\"en\" VALUE=\"1\"/>", :facet => facet)
+    assert_equal "en", facet_value.name
+    assert_equal "English", facet_value.display_name
+    assert_equal 1, facet_value.count
+  end
+
+  def test_facet_library
+    Exlibris::Primo.configure do |config|
+      config.libraries = {"LIB" => "Library Display"}
+    end
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"library\" COUNT=\"3\" />")
+    facet_value = Exlibris::Primo::FacetValue.new(:raw_xml => "<FACET_VALUES KEY=\"LIB\" VALUE=\"1\"/>", :facet => facet)
+    assert_equal "LIB", facet_value.name
+    assert_equal "Library Display", facet_value.display_name
+    assert_equal 1, facet_value.count
+  end
+
+  def test_facet_domain
+    Exlibris::Primo.configure do |config|
+      config.facet_collections = {"DOM" => "Library Domain"}
+    end
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"domain\" COUNT=\"3\" />")
+    facet_value = Exlibris::Primo::FacetValue.new(:raw_xml => "<FACET_VALUES KEY=\"DOM\" VALUE=\"1\"/>", :facet => facet)
+    assert_equal "DOM", facet_value.name
+    assert_equal "Library Domain", facet_value.display_name
+    assert_equal 1, facet_value.count
+  end
+
+  def test_facet_top_level
+    Exlibris::Primo.configure do |config|
+      config.facet_top_level = {"available" => "Available Online"}
+    end
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"tlevel\" COUNT=\"3\" />")
+    facet_value = Exlibris::Primo::FacetValue.new(:raw_xml => "<FACET_VALUES KEY=\"available\" VALUE=\"1\"/>", :facet => facet)
+    assert_equal "available", facet_value.name
+    assert_equal "Available Online", facet_value.display_name
+    assert_equal 1, facet_value.count
+  end
+
+  def test_facet_resource_type
+    Exlibris::Primo.configure do |config|
+      config.facet_resource_types = {"books" => "Manuscripts"}
+    end
+    facet = Exlibris::Primo::Facet.new(:raw_xml => "<FACET NAME=\"rtype\" COUNT=\"3\" />")
+    facet_value = Exlibris::Primo::FacetValue.new(:raw_xml => "<FACET_VALUES KEY=\"books\" VALUE=\"1\"/>", :facet => facet)
+    assert_equal "books", facet_value.name
+    assert_equal "Manuscripts", facet_value.display_name
+    assert_equal 1, facet_value.count
+  end
+end

data/test/holding_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+class HoldingTest < Test::Unit::TestCase
+  def setup
+    @record_id = "aleph002895625"
+  end
+
+  def test_new_holding
+    assert_nothing_raised {
+      holding = Exlibris::Primo::Holding.new :record_id => @record_id,
+        :original_id => @record_id, :title => "Holding Title", :author => "Holding Author", 
+        :display_type => "Book"
+      assert_equal "aleph002895625", holding.record_id
+      assert_equal "aleph002895625", holding.original_id
+      assert_equal "Holding Title", holding.title
+      assert_equal "Holding Author", holding.author
+      assert_equal "Book", holding.display_type
+      assert_equal([], holding.coverage)
+      assert_nil(holding.source_config)
+      assert_nil(holding.source_class)
+      assert_equal({}, holding.source_data)
+      assert_equal(holding, holding.to_source)
+      assert_equal([holding], holding.expand)
+      assert((not holding.dedup?))
+    }
+  end
+end

data/test/link_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+class LinkTest < Test::Unit::TestCase
+  def setup
+    @record_id = "aleph002895625"
+    @url = "http://example.com"
+  end
+
+  def test_new_base
+    assert_raise(NotImplementedError) {
+      Exlibris::Primo::Link.new
+    }
+  end
+
+  def test_new_fulltext
+    assert_nothing_raised {
+      link = Exlibris::Primo::Fulltext.new :record_id => @record_id,
+        :original_id => @record_id, :url => @url, :display => "Fulltext Instance"
+      assert_equal "aleph002895625", link.record_id
+      assert_equal "aleph002895625", link.original_id
+      assert_equal "http://example.com", link.url
+      assert_equal "Fulltext Instance", link.display
+    }
+  end
+
+  def test_new_table_of_contents
+    link = Exlibris::Primo::TableOfContents.new :record_id => @record_id,
+      :original_id => @record_id, :url => @url, :display => "Table of Contents Instance"
+    assert_equal "aleph002895625", link.record_id
+    assert_equal "aleph002895625", link.original_id
+    assert_equal "http://example.com", link.url
+    assert_equal "Table of Contents Instance", link.display
+  end
+
+  def test_new_related_link
+    link = Exlibris::Primo::RelatedLink.new :record_id => @record_id,
+      :original_id => @record_id, :url => @url, :display => "Related Link Instance"
+    assert_equal "aleph002895625", link.record_id
+    assert_equal "aleph002895625", link.original_id
+    assert_equal "http://example.com", link.url
+    assert_equal "Related Link Instance", link.display
+  end
+end

data/test/pnx/dedup_mgr_test.rb

@@ -0,0 +1,16 @@
+module Pnx
+  require 'test_helper'
+  class DedupMgrTest < Test::Unit::TestCase
+    def test_dedupmrg
+      record = Exlibris::Primo::Record.new(:raw_xml => dedupmgr_record_xml)
+      assert record.respond_to? :display_title
+      assert record.respond_to? :recordid
+      assert_equal "The New York times", record.display_title
+      assert_equal "dedupmrg17343091", record.recordid
+      assert((not record.sourceids.keys.include?("dedupmrg17343091")))
+      assert_raise(NoMethodError) {
+        record.non_existent_method
+      }
+    end
+  end
+end

data/test/pnx/elements_test.rb

@@ -0,0 +1,16 @@
+module Pnx
+  require 'test_helper'
+  class ElementsTest < Test::Unit::TestCase
+    def test_elements
+      record = Exlibris::Primo::Record.new(:raw_xml => record_xml)
+      assert record.respond_to? :display_title
+      assert record.respond_to? :recordid
+      assert record.respond_to? :all_search_isbn
+      assert_equal "Travels with my aunt", record.display_title
+      assert_equal "nyu_aleph000062856", record.recordid
+      assert_kind_of Array, record.all_search_isbn
+      assert_equal ["0143039008", "9780143039006", "9780143\"0390069"], 
+        record.all_search_isbn
+    end
+  end
+end