exlibris-primo 0.1.0 → 0.1.1

data/README.rdoc

@@ -6,7 +6,7 @@ Exlibris::Primo offers a set of libraries for interacting with the ExLibris Prim
 The Exlibris::Primo::Searcher class performs a search against Primo for given parameters
 and exposes the set of holdings (availibrary elements), rsrcs, tocs, and related links (addlink elements).
 
-== Example of Exlibris::Primo::Searcher in action
+=== Example of Exlibris::Primo::Searcher in action
   setup = {
     :base_url => "http://primo.institution.edu", :vid => "VID", :institution => "INSTITUTION",
     :config => {
@@ -29,3 +29,37 @@ and exposes the set of holdings (availibrary elements), rsrcs, tocs, and related
   rsrcs = searcher.rsrcs
   tocs = searcher.tocs
   related_links = searcher.related_links
+
+== Exlibris::Primo::Record
+The Exlibris::Primo::Record class creates an object representation of a Primo record for given parameters
+and exposes the record's primary attributes (format, title, author, url, openurl) and full record Xml (raw_xml)
+as instance variables.
+
+=== Example of Exlibris::Primo::Record in action
+  setup = { 
+    :base_url => "http://primo.institution.edu", 
+    :resolver_base_url => "http://sfx.institution.edu", 
+    :vid => "VID", 
+    :institution => "DEFAULT", 
+    :record_id => "PrimoRecordId" 
+  }
+  record = Exlibris::Primo::Record.new(setup)
+  raw_xml = record.instance_variable_get(:@raw_xml)
+  record_hash = record.to_h
+  openurl = record_hash["openurl"]
+	
+== Exlibris::Primo::EShelf
+The Exlibris::Primo::EShelf class provides methods for reading a given user's Primo eshelf and eshelf structure as well as adding and removing records.
+
+=== Example of Exlibris::Primo::EShelf in action
+  setup = { 
+    :base_url => "http://primo.institution.edu", 
+    :vid => "VID", 
+    :resolver_base_url => "http://sfx.institution.edu"
+  }
+  eshelf = Exlibris::Primo::EShelf.new(setup, "USER_ID", "PRIMO")
+  records = eshelf.records
+  p records.first.class
+  record_count = eshelf.count
+  basket_id = eshelf.basket_id
+  eshelf.add_records(["PrimoRecordId","PrimoRecordId2"], basket_id)

data/lib/exlibris-primo.rb

@@ -1,5 +1,7 @@
-PATH = File.dirname(__FILE__) + "/exlibris/primo/"
+PRIMO_PATH = File.dirname(__FILE__) + "/exlibris/primo/"
 [ 
+  'record',
+  'eshelf',
   'web_service',
   'holding',
   'related_link',
@@ -8,5 +10,5 @@ PATH = File.dirname(__FILE__) + "/exlibris/primo/"
   'searcher',
   'source/aleph'
 ].each do |library|
-  require PATH + library
+  require PRIMO_PATH + library
 end

data/lib/exlibris/primo/eshelf.rb

@@ -0,0 +1,80 @@
+module Exlibris
+  module Primo
+    # == Overview
+    # Exlibris::Primo::EShelf provides access to the Primo Eshelf for a given user.
+    # An instance of Exlibris::Primo::EShelf can be created by passing
+    # in a hash with setup parameters, a user_id and an institution.
+    # Valid setup parameters include:
+    #   :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(@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'}
+      
+      def initialize(setup, user_id, institution)
+        @base_url = setup[:base_url]
+        raise_required_setup_parameter_error :base_url if @base_url.nil?
+        @resolver_base_url = setup[:resolver_base_url]
+        @vid = setup.fetch(:vid, "DEFAULT")
+        raise_required_setup_parameter_error :vid if @vid.nil?
+        @config = setup.fetch(:config, {})
+        raise_required_setup_parameter_error :config if @config.nil?
+        @user_id = user_id
+        raise_required_setup_parameter_error :user_id if @user_id.nil?
+        @institution = institution
+        raise_required_setup_parameter_error :institution if @institution.nil?
+        @records = []
+      end
+    
+      # Call Web Service to get Eshelf contents and return
+      def eshelf
+        @eshelf ||= Exlibris::Primo::WebService::GetEShelf.new(@user_id, @institution, @base_url).response
+      end
+      
+      # Call Web Service to get Eshelf structure and return
+      def eshelfStructure
+        @eshelfStructure ||= Exlibris::Primo::WebService::GetEShelfStructure.new(@user_id, @institution, @base_url).response
+      end
+      
+      # Fetch the number of records in user's Eshelf
+      def count
+        @count ||= Integer(eshelf.at("//sear:DOCSET", SEAR_NS)["TOTALHITS"])
+      end
+    
+      # 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 }))
+        } if @records.empty?
+        return @records
+      end
+      
+      # Fetch default basket id from eshelf structure web service call
+      def basket_id
+        @basket_id ||= eshelfStructure.at(
+          "//prim:eshelf_folders//prim:eshelf_folder[./prim:folder_name='Basket']", PRIM_NS).
+          get_attribute("folder_id") unless eshelfStructure.at("//prim:eshelf_folders//prim:eshelf_folder[./prim:folder_name='Basket']", PRIM_NS).nil?
+      end
+      
+      # Call Web Service to add records to remote Eshelf
+      def add_records(doc_ids, folder_id)
+        Exlibris::Primo::WebService::AddToEShelf.new(doc_ids, folder_id, @user_id, @institution, @base_url) unless doc_ids.empty?
+      end
+
+      # Call Web Service to remove records from remote EShelf
+      def remove_records(doc_ids, folder_id)
+        Exlibris::Primo::WebService::RemoveFromEShelf.new(doc_ids, folder_id, @user_id, @institution, @base_url) unless doc_ids.empty?
+      end
+      
+      private
+      def raise_required_setup_parameter_error(parameter)
+        raise ArgumentError.new("Error in #{self.class}. Missing required setup parameter: #{parameter}.")
+      end
+    end
+  end
+end

data/lib/exlibris/primo/record.rb

@@ -0,0 +1,112 @@
+module Exlibris
+  module Primo
+    # == Overview
+    # Exlibris::Primo::Record is an abstract representation of a Primo record.
+    # An instance of Exlibris::Primo::Record can be created by passing
+    # in a hash with setup parameters.
+    # Valid parameters include:
+    #   :base_url, :resolver_base_url, :vid, :institution, :record_id, :record
+    # A URL to the native record (dlDisplay.do) and an OpenUrl are generated by default. 
+    # If no resolver_base_url is provided, an OpenUrl querystring will be returned.
+    # A raw_xml attribute is generated either by the record XML passed in or by fetching it from the record_id.
+    # By default the raw_xml is not included in the hash representation, but can be overridden to.
+    #
+    # == Tips on Extending
+    # When extending the class, a few basics guidelines should be observed.
+    # 1.  A Exlibris::Primo::Record is initialized from a Hash of parameters.
+    #     These params are used to create instance variables of the record attributes.
+    #
+    # 2.  The following methods are available for overriding:
+    #     to_h -    if a sub class creates more instance variables, these should be added to the hash
+    #     raw  -    cleans up characters and spaces in raw record and wraps in <record /> tag, implementations may differ
+    #
+    # == Examples of usage
+    #   Record.new({ :base_url => @base_url, :vid => @vid, :record => doc.at("//record") })
+    class Record
+      
+      SEAR_NS = {'sear' => 'http://www.exlibrisgroup.com/xsd/jaguar/search'}
+      attr_reader :record_id, :type, :title, :url, :openurl, :creator, :raw_xml
+      
+      def initialize(parameters={})
+          # Get base url of Primo application, required
+          base_url = parameters[:base_url]
+          raise_required_setup_parameter_error :base_url if base_url.nil?
+          # Get base url of link resolver, if blank openurl generates just querystring
+          resolver_base_url = parameters[:resolver_base_url]
+          # Get vid from parameters, required
+          vid = parameters.fetch(:vid, "DEFAULT")
+          raise_required_setup_parameter_error :vid if vid.nil?
+          # Get institution from parameters, required
+          institution = parameters.fetch(:institution, "PRIMO")
+          raise_required_setup_parameter_error :institution if institution.nil?
+          # Get record: either fetch record from Web Service based on DocId or use passed in record xml, required
+          record = (parameters[:record].nil?) ? 
+              (parameters[:record_id].nil?) ? 
+                  nil : record_from_id(parameters.delete(:record_id), base_url, {:institution => institution, :vid => vid}) : parameters.delete(:record)
+          raise_required_setup_parameter_error "record or record_id" if record.nil?
+          # Set instance variables for record
+          @record_id = record.at("control/recordid",record.namespaces).inner_text unless record.at("control/recordid",record.namespaces).nil?
+          @type = record.at("display/type",record.namespaces).inner_text unless record.at("display/type",record.namespaces).nil?
+          @title = record.at("display/title",record.namespaces).inner_text unless record.at("display/title",record.namespaces).nil?
+          @url = construct_url(base_url, @record_id, institution, vid)
+          @openurl = construct_openurl(resolver_base_url, record, @record_id)
+          @creator = record.at("display/creator",record.namespaces).inner_text unless record.at("display/creator",record.namespaces).nil?
+          @raw_xml = raw(record)
+      end
+
+      # Return a hash representation of the primary record attributes
+      def to_h
+          return {
+              "format" => @type.capitalize, 
+              "title" => @title, 
+              "author" => @creator,
+              "url" => @url,
+              "openurl" => @openurl
+          }
+      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
+      end
+
+      private
+      # Method for consturcting openurl from record
+      def construct_openurl(resolver_base_url, record, record_id)
+          raise_required_setup_parameter_error :record if record.nil?
+          raise_required_setup_parameter_error :record_id if record_id.nil?
+          openurl = (resolver_base_url.nil?) ? "?" : "#{resolver_base_url}?"
+          record.search("addata/*",record.namespaces).each do |addata|
+            openurl << "rft.#{addata.name}=#{addata.inner_text}&" unless (addata.inner_text.nil? or addata.inner_text.strip.empty?)
+          end
+          openurl << "rft.primo=#{record_id}"
+          return openurl
+      end
+    
+      # Method for constructing deep link url from record
+      def construct_url(base_url, record_id, institution, vid)
+          raise_required_setup_parameter_error :base_url if base_url.nil?
+          raise_required_setup_parameter_error :record_id if record_id.nil?
+          raise_required_setup_parameter_error :institution if institution.nil?
+          raise_required_setup_parameter_error :vid if vid.nil?
+          url = "#{base_url}/primo_library/libweb/action/dlDisplay.do?dym=false&onCampus=false&docId=#{record_id}&institution=#{institution}&vid=#{vid}"
+          return url
+      end
+
+      # Fetch record from Primo Web Service
+      def record_from_id(record_id, base_url, options={})
+          doc = Exlibris::Primo::WebService::GetRecord.new(record_id, base_url, options).response.at("//sear:DOC", SEAR_NS)
+          return doc.at("//xmlns:record",doc.namespaces)
+      end
+
+      # Raise error wrapper
+      def raise_required_setup_parameter_error(parameter)
+          raise ArgumentError.new("Error in #{self.class}. Missing required setup parameter: #{parameter}.")
+      end
+    end
+  end
+end

data/lib/exlibris/primo/version.rb

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

data/lib/exlibris/primo/web_service.rb

@@ -27,10 +27,18 @@ module Exlibris
           raise "Error making call to Primo web service.  Response from web service is #{@response}." if @response.nil?
           @error = []
           response.search("ERROR").each do |e|
-            @error.push(e.attributes["MESSAGE"]) unless e.nil?
+            # Primo Web Service calls will return an <ERROR MESSAGE="{MESSAGE}" CODE="{CODE}" />
+            # tag even when it succeeds. Key off CODE == 0 which is a successful call.
+            #debugger
+            @error.push(e.attributes["MESSAGE"]) unless e.nil? or e.attributes["CODE"].value.to_i == 0
           end
           raise "Error making call to Primo web service.  #{@error.inspect}" unless @error.empty?
         end
+        
+        private
+        def tag!(name, value)
+          REXML::Element.new(name).add_text(value)
+        end
       end
 
       # Search is the base class for Search web services
@@ -108,10 +116,6 @@ module Exlibris
         def genre_query_term(genre)
           return query_term(genre, "any", "exact")
         end
-
-        def tag!(name, value)
-          REXML::Element.new(name).add_text(value)
-        end
       end
 
       # SearchBrief does a brief result search through the Primo APIs
@@ -138,6 +142,62 @@ module Exlibris
           super("getRecord", "getRecordRequest", "fullViewRequest", primo_search_request, additional_input, base_url, options)
         end
       end
+      
+      # EShelf is the base class for EShelf web services
+      # It can be extended but is not intended for use by itself
+      # Known implementations are GetEShelf, AddToEShelf, RemoveFromEShelf, GetEShelfStructure
+      class EShelf < WebServiceBase
+        def initialize(method_name, param_name, input_root, user_id, institution, additional_input, base_url, options, service_name = nil)
+          input = REXML::Element.new(input_root)
+          input.add_namespace("http://www.exlibris.com/primo/xsd/wsRequest")
+          input.add_element(tag!("userId", user_id)) if !user_id.nil?
+          input.add_element(tag!("institution", institution)) if !institution.nil?
+          additional_input.each do |e|  
+            input.add_element(e)
+          end
+          service_name = "eshelf" if service_name.nil?
+          make_call(base_url, service_name, method_name, param_name, input)
+        end
+
+        private
+        def docs(doc_ids=[], folder_id=nil, folder_name=nil)
+          additional_input = []
+          doc_ids.each { |doc_id| additional_input.push(tag!("docId", doc_id)) }
+          additional_input.push(tag!("folderId", folder_id)) unless folder_id.nil?
+          additional_input.push(tag!("folderName", folder_name)) unless folder_name.nil?
+          return additional_input
+        end
+      end
+
+      # Get EShelf based on user_id and institution
+      class GetEShelf < EShelf
+        def initialize(user_id, institution, base_url, options={})
+          super("getEshelf", "getEshelfRequest", "getEshelfRequest", user_id, institution, [], base_url, options)
+          raise "Error making call to Primo web service.  #{@error.inspect}" unless @error.empty? or @error.attribe
+        end
+      end
+
+      # Get EShelf structure based on user_id and institution
+      class GetEShelfStructure < EShelf
+        def initialize(user_id, institution, base_url, options={})
+          super("getEshelfStructure", "getEshelfStructureRequest", "getEshelfStructureRequest", user_id, institution, [tag!("includeBasketItems","false")], base_url, options, "eshelfstructure")
+          raise "Error making call to Primo web service.  #{@error.inspect}" unless @error.empty? or @error.attribe
+        end
+      end
+
+      # Add document to EShelf based on user_id and institution
+      class AddToEShelf < EShelf
+        def initialize(doc_ids, folder_id, user_id, institution, base_url, options={})
+          super("addToEshelf", "addToEshelfRequest", "addToEshelfRequest", user_id, institution, docs(doc_ids, folder_id), base_url, options)
+        end
+      end
+
+      # Remove document from EShelf based on user_id and institution
+      class RemoveFromEShelf < EShelf
+        def initialize(doc_ids, folder_id, user_id, institution, base_url, options={})
+          super("removeFromEshelf", "removeFromEshelfRequest", "removeFromEshelfRequest", user_id, institution, docs(doc_ids, folder_id), base_url, options)
+        end
+      end
     end
   end
 end

data/test/unit/eshelf_test.rb

@@ -0,0 +1,152 @@
+require 'test_helper'
+
+class EShelfTest < ActiveSupport::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"
+  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)}
+
+  end
+
+  test "valid_eshelf" do
+      eshelf = nil
+      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
+
+  test "valid_eshelf_structure" do
+      eshelfStructure = nil
+      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
+  
+  test "basket_id" do
+      assert_equal(@valid_basket, Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute).basket_id)
+  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
+      assert_nothing_raised(){eshelf = ws.eshelf}
+      assert_not_nil(eshelf)
+      assert_instance_of(Nokogiri::XML::Document, eshelf)
+      assert_equal(0, ws.count)
+  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
+      assert_nothing_raised(){eshelf = ws.eshelf}
+      assert_not_nil(eshelf)
+      assert_instance_of(Nokogiri::XML::Document, eshelf)
+      assert_equal(0, ws.count)
+  end
+
+  test "records" do
+      records = nil
+      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
+
+  test "cant_add_same_record_twice" do
+      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+      assert_not_nil(eshelf)
+      # 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
+  
+  test "cant_add_invalid_records" do
+      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+      assert_not_nil(eshelf)
+      # 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
+  
+  test "cant_add_to_invalid_basket" do
+      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+      assert_not_nil(eshelf)
+      # Attempt to add record to basket with invalid folder name
+      assert_raise(RuntimeError){ eshelf.add_records(@valid_doc_ids, @invalid_basket) }
+  end
+  
+  test "can_add_to_empty_folder" do
+      eshelf = Exlibris::Primo::EShelf.new(@eshelf_setup, @valid_user_id, @valid_institute)
+      assert_not_nil(eshelf)
+      # 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

data/test/unit/record_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+class RecordTest < ActiveSupport::TestCase
+  
+  SEAR_NS = {'sear' => 'http://www.exlibrisgroup.com/xsd/jaguar/search'}
+  
+  def setup
+    @record_definition = YAML.load( %{
+        base_url: http://bobcat.library.nyu.edu
+        resolver_base_url: https://getit.library.nyu.edu/resolve
+        vid: NYU
+        institution: NYU
+        record_id: nyu_aleph000062856
+    })
+      
+    @base_url = @record_definition["base_url"]
+    @resolver_base_url = @record_definition["resolver_base_url"]
+    @vid = @record_definition["vid"]
+    @institution = @record_definition["institution"]
+    @valid_record_id = @record_definition["record_id"]
+    @invalid_record_id = "INVALID_RECORD"
+    @setup_args = { 
+        :base_url => @base_url, 
+        :resolver_base_url => @resolver_base_url, 
+        :vid => @vid, 
+        :institution => @institution, 
+        :record_id => @valid_record_id 
+      }
+  end
+  
+  test "new" do
+    record = nil
+    assert_nothing_raised(){ record = Exlibris::Primo::Record.new(@setup_args) }
+    assert_not_nil(record)
+    assert_not_nil(record.instance_variable_get(:@record_id))
+    assert_not_nil(record.instance_variable_get(:@type))
+    assert_not_nil(record.instance_variable_get(:@title))
+    assert_not_nil(record.instance_variable_get(:@url))
+    assert_not_nil(record.instance_variable_get(:@openurl))
+    assert_not_nil(record.instance_variable_get(:@creator))
+    assert_not_nil(record.instance_variable_get(:@raw_xml))  
+    assert_raise(ArgumentError){ Exlibris::Primo::Record.new(@setup_args.merge({:base_url => nil})) }
+    assert_raise(ArgumentError){ Exlibris::Primo::Record.new(@setup_args.merge({:institution => nil})) }
+    assert_raise(ArgumentError){ Exlibris::Primo::Record.new(@setup_args.merge({:vid => nil})) }
+    assert_raise(ArgumentError){ Exlibris::Primo::Record.new(@setup_args.merge({:record_id => nil})) }
+    assert_raise(RuntimeError){ Exlibris::Primo::Record.new(@setup_args.merge({:record_id => @invalid_record_id})) }
+  end
+  
+  test "to_hash_function" do
+    record = Exlibris::Primo::Record.new(@setup_args)
+    assert((record.to_h.is_a? Hash), "#{record.class} was expected to be a Hash, was #{record.to_h.class}")
+  end
+  
+  test "sub_class" do
+    class SubRecord < Exlibris::Primo::Record
+      def initialize(parameters={})
+        super(parameters)
+      end
+    end
+    record = nil
+    assert_nothing_raised(){ record = SubRecord.new(@setup_args) }    
+    assert_not_nil(record)
+    assert_raise(ArgumentError){ record = SubRecord.new() }
+  end
+  
+  test "raw_xml" do
+    record = Exlibris::Primo::Record.new(@setup_args)
+    raw_xml = record.instance_variable_get(:@raw_xml)
+    assert_not_nil(raw_xml)  
+    assert_instance_of(String, raw_xml)
+    doc = nil
+    assert_nothing_raised(){ doc = Nokogiri::XML.parse(raw_xml) }
+    assert_not_nil(doc)
+    assert_not_empty(doc.xpath("//record", doc.namespaces))
+  end
+  
+end

data/test/unit/web_service_test.rb

@@ -3,6 +3,8 @@ require 'test_helper'
 class WebServiceTest < ActiveSupport::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( %{
@@ -25,6 +27,9 @@ class WebServiceTest < ActiveSupport::TestCase
           - cover_image
       })
     
+    @valid_user_id = "N18158418"
+    @invalid_user_id = "INVALID_USER"
+    @default_institution = "NYU"
     @base_url = @primo_definition["base_url"]
     @bogus_404_url = "http://library.nyu.edu/bogus"
     @bogus_200_url = "http://library.nyu.edu"
@@ -121,4 +126,21 @@ class WebServiceTest < ActiveSupport::TestCase
     assert_instance_of( Nokogiri::XML::Document, ws.response, "#{ws.class} response is an unexpected object: #{ws.response.class}")
     assert_equal([], ws.error, "#{ws.class} encountered errors: #{ws.error}")
   end 
+  
+  test "get_new_eshelf" do
+    ws = Exlibris::Primo::WebService::GetEShelf.new(@valid_user_id, @default_institution, @base_url)
+    assert_not_nil(ws, "#{ws.class} returned nil when instantiated.")
+    assert_instance_of( Nokogiri::XML::Document, ws.response, "#{ws.class} response is an unexpected object: #{ws.response.class}")
+    assert_equal([], ws.error, "#{ws.class} encountered errors: #{ws.error}")
+    assert_not_nil(ws.response.at("//sear:DOC", SEAR_NS), "#{ws.class} response returned a nil document")
+  end
+  
+  test "get_new_eshelf_structure" do
+    ws = Exlibris::Primo::WebService::GetEShelfStructure.new(@valid_user_id, @default_institution, @base_url)
+    assert_not_nil(ws, "#{ws.class} returned nil when instantiated.")
+    assert_instance_of( Nokogiri::XML::Document, ws.response, "#{ws.class} response is an unexpected object: #{ws.response.class}")
+    assert_equal([], ws.error, "#{ws.class} encountered errors: #{ws.error}")
+    assert_not_nil(ws.response.at("//prim:eshelf_folders", PRIM_NS), "#{ws.class} response returned a nil document")
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exlibris-primo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152708140 !ruby/object:Gem::Requirement
+  requirement: &2152674040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152708140
+  version_requirements: *2152674040
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152707580 !ruby/object:Gem::Requirement
+  requirement: &2152673580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152707580
+  version_requirements: *2152673580
 - !ruby/object:Gem::Dependency
   name: soap4r-ruby1.9
-  requirement: &2152706900 !ruby/object:Gem::Requirement
+  requirement: &2152672900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152706900
+  version_requirements: *2152672900
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152706260 !ruby/object:Gem::Requirement
+  requirement: &2152672320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152706260
+  version_requirements: *2152672320
 description: Library to work with Exlibris' Primo discovery system.
 email:
 - scotdalton@gmail.com
@@ -62,7 +62,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/exlibris/primo/eshelf.rb
 - lib/exlibris/primo/holding.rb
+- lib/exlibris/primo/record.rb
 - lib/exlibris/primo/related_link.rb
 - lib/exlibris/primo/rsrc.rb
 - lib/exlibris/primo/searcher.rb
@@ -108,6 +110,8 @@ files:
 - test/dummy/script/rails
 - test/exlibris-primo_test.rb
 - test/test_helper.rb
+- test/unit/eshelf_test.rb
+- test/unit/record_test.rb
 - test/unit/searcher_benchmarks.rb
 - test/unit/searcher_test.rb
 - test/unit/web_service_benchmarks.rb
@@ -170,6 +174,8 @@ test_files:
 - test/dummy/script/rails
 - test/exlibris-primo_test.rb
 - test/test_helper.rb
+- test/unit/eshelf_test.rb
+- test/unit/record_test.rb
 - test/unit/searcher_benchmarks.rb
 - test/unit/searcher_test.rb
 - test/unit/web_service_benchmarks.rb