exlibris-primo 0.1.5 → 1.0.0

data/test/web_service/client/savon_client_test.rb

@@ -0,0 +1,17 @@
+module WebService
+  module Client
+    require 'test_helper'
+    class SavonClientTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+      end
+
+      def test_nonexistent_soap_action
+        VCR.use_cassette('client nonexistent soap action') do
+          client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+          assert_kind_of Savon::Client, client.send(:client)
+        end
+      end
+    end
+  end
+end

data/test/web_service/client/search_benchmarks.rb

@@ -0,0 +1,29 @@
+module WebService
+  module Client
+    require 'test_helper'
+    class SearchBenchmarks < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @doc_id = "nyu_aleph000062856"
+        @isbn = "0143039008"
+        @issn = "0090-5720"
+        @title = "Travels with My Aunt"
+        @author = "Graham Greene"
+        @genre = "Book"
+      end
+
+      def test_benchmarks
+        VCR.turn_off!
+        Benchmark.bmbm do |results|
+          results.report("Web Service Search:") {
+            (1..10).each {
+              search = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+              response = search.search_brief "<request><![CDATA[<searchRequest xmlns=\"http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic=\"http://www.exlibris.com/primo/xsd/primoview/uicomponents\"><PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\"><QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm><IndexField>isbn</IndexField><PrecisionOperator>exact</PrecisionOperator><Value>0090-5720</Value></QueryTerm></QueryTerms><StartIndex>1</StartIndex><BulkSize>5</BulkSize><DidUMeanEnabled>false</DidUMeanEnabled></PrimoSearchRequest><institution>NYU</institution></searchRequest>]]></request>"
+            }
+          }
+        end
+        VCR.turn_on!
+      end
+    end
+  end
+end

data/test/web_service/client/search_test.rb

@@ -0,0 +1,44 @@
+module WebService
+  module Client
+    require 'test_helper'
+    class SearchTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @doc_id = "nyu_aleph000062856"
+        @isbn = "0143039008"
+        @issn = "0090-5720"
+        @title = "Travels with My Aunt"
+        @author = "Graham Greene"
+        @genre = "Book"
+        @institution = "NYU"
+      end
+
+      def test_search_brief_by_issn
+        assert_nothing_raised {
+          VCR.use_cassette('client search brief issn') do
+            client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+            response = client.search_brief "<request><![CDATA[<searchRequest xmlns=\"http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic=\"http://www.exlibris.com/primo/xsd/primoview/uicomponents\"><PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\"><QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm><IndexField>isbn</IndexField><PrecisionOperator>exact</PrecisionOperator><Value>0090-5720</Value></QueryTerm></QueryTerms><StartIndex>1</StartIndex><BulkSize>5</BulkSize><DidUMeanEnabled>false</DidUMeanEnabled></PrimoSearchRequest><institution>NYU</institution></searchRequest>]]></request>"
+          end
+        }
+      end
+
+      def test_search_brief_by_isnn
+        assert_nothing_raised {
+          VCR.use_cassette('client search brief isbn') do
+            client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+            response = client.search_brief "<request><![CDATA[<searchRequest xmlns=\"http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic=\"http://www.exlibris.com/primo/xsd/primoview/uicomponents\"><PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\"><QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm><IndexField>isbn</IndexField><PrecisionOperator>exact</PrecisionOperator><Value>0143039008</Value></QueryTerm></QueryTerms><StartIndex>1</StartIndex><BulkSize>5</BulkSize><DidUMeanEnabled>false</DidUMeanEnabled></PrimoSearchRequest><institution>NYU</institution></searchRequest>]]></request>"
+          end
+        }
+      end
+
+      def test_get_record
+        assert_nothing_raised {
+          VCR.use_cassette('client get record') do
+            client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+            response = client.get_record "<request><![CDATA[<fullViewRequest xmlns=\"http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic=\"http://www.exlibris.com/primo/xsd/primoview/uicomponents\"><PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\"><QueryTerms><BoolOpeator>AND</BoolOpeator></QueryTerms><StartIndex>1</StartIndex><BulkSize>5</BulkSize><DidUMeanEnabled>false</DidUMeanEnabled></PrimoSearchRequest><institution>NYU</institution><docId>nyu_aleph000062856</docId></fullViewRequest>]]></request>"
+          end
+        }
+      end
+    end
+  end
+end

data/test/web_service/client/soap_actions_test.rb

@@ -0,0 +1,45 @@
+module WebService
+  module Client
+    require 'test_helper'
+    class SoapActionsTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+      end
+
+      def test_respond_to
+        VCR.use_cassette('client nonexistent method') do
+          client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+          assert(client.respond_to? :get_record)
+          assert((not client.respond_to?(:nonexistent_action)))
+        end
+      end
+
+      def test_nonexistent_action
+        VCR.use_cassette('client nonexistent method') do
+          client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+          assert_raise(NoMethodError) {
+            client.nonexistent_action
+          }
+        end
+      end
+
+      def test_no_arguments
+        VCR.use_cassette('client action no arguments') do
+          client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+          assert_raise(ArgumentError, Savon::SOAP::Fault) {
+            client.get_record
+          }
+        end
+      end
+
+      def test_too_many_arguments
+        VCR.use_cassette('client too many arguments') do
+          client = Exlibris::Primo::WebService::Client::Search.new :base_url => @base_url
+          assert_raise(ArgumentError, Savon::SOAP::Fault) {
+            client.get_record "1", "2"
+          }
+        end
+      end
+    end
+  end
+end

data/test/web_service/client/tags_test.rb

@@ -0,0 +1,31 @@
+module WebService
+  module Client
+    require 'test_helper'
+    class TagsTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @doc_id = "nyu_aleph000062856"
+        @user_id = "N12162279"
+        @institution = "NYU"
+      end
+
+      def test_get_tags
+        assert_nothing_raised {
+          VCR.use_cassette('client get tags') do
+            client = Exlibris::Primo::WebService::Client::Tags.new :base_url => @base_url
+            response = client.get_tags "<request><![CDATA[<getTagsRequest xmlns=\"http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic=\"http://www.exlibris.com/primo/xsd/primoview/uicomponents\"><institution>NYU</institution><docId>nyu_aleph000062856</docId><userId>N12162279</userId></getTagsRequest>]]></request>"
+          end
+        }
+      end
+
+      def test_get_all_my_tags
+        assert_nothing_raised {
+          VCR.use_cassette('client get all my tags') do
+            client = Exlibris::Primo::WebService::Client::Tags.new :base_url => @base_url
+            response = client.get_all_my_tags "<request><![CDATA[<getAllMyTagsRequest xmlns=\"http://www.exlibris.com/primo/xsd/wsRequest\" xmlns:uic=\"http://www.exlibris.com/primo/xsd/primoview/uicomponents\"><institution>NYU</institution><userId>N12162279</userId></getAllMyTagsRequest>]]></request>"
+          end
+        }
+      end
+    end
+  end
+end

data/test/web_service/request/abstract_test.rb

@@ -0,0 +1,68 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class AbstractTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @user_id = "N12162279"
+        @institution = "NYU"
+        @doc_id = "nyu_aleph000062856"
+        @dedupmgr_id = "dedupmrg17343091"
+      end
+
+      def test_abstract_raise
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::Base.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::User.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::Record.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::UserRecord.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::Eshelf.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::EshelfStructure.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::EshelfRecord.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::Reviews.new
+        }
+        assert_raise(NotImplementedError) {
+          Exlibris::Primo::WebService::Request::Tags.new
+        }
+      end
+
+      def test_non_abstract_nothing_raised
+        assert_nothing_raised {
+          Exlibris::Primo::WebService::Request::AddFolderToEshelf.new
+          Exlibris::Primo::WebService::Request::GetEshelfStructure.new
+          Exlibris::Primo::WebService::Request::GetEshelf.new
+          Exlibris::Primo::WebService::Request::AddToEshelf.new
+          Exlibris::Primo::WebService::Request::RemoveFromEshelf.new
+          Exlibris::Primo::WebService::Request::GetReviews.new
+          Exlibris::Primo::WebService::Request::GetAllMyReviews.new
+          Exlibris::Primo::WebService::Request::GetReviewsForRecord.new
+          Exlibris::Primo::WebService::Request::GetReviewsByRating.new
+          Exlibris::Primo::WebService::Request::AddReview.new
+          Exlibris::Primo::WebService::Request::RemoveReview.new
+          Exlibris::Primo::WebService::Request::GetTags.new
+          Exlibris::Primo::WebService::Request::GetAllMyTags.new
+          Exlibris::Primo::WebService::Request::GetTagsForRecord.new
+          Exlibris::Primo::WebService::Request::AddTag.new
+          Exlibris::Primo::WebService::Request::RemoveTag.new
+          Exlibris::Primo::WebService::Request::RemoveUserTags.new
+          Exlibris::Primo::WebService::Request::Search.new
+          Exlibris::Primo::WebService::Request::FullView.new
+        }
+      end
+    end
+  end
+end

data/test/web_service/request/base_elements_test.rb

@@ -0,0 +1,231 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class BaseElementsTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @institution = "University"
+        @ip = "127.0.0.1"
+        @group = "Department"
+        @on_campus = "true"
+        @is_logged_in = "true"
+        @pds_handle = "pds_handle_dummy"
+        @user_id = "user_id_dummy"
+        @folder_id = "folder_id_dummy"
+        @doc_id = "doc_id_dummy"
+        @folder_name = "new folder, dummy"
+        @parent_folder = "parent_folder_dummy"
+        @search_key = "search_key_dummy"
+      end
+
+      def test_base_base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle],
+          Exlibris::Primo::WebService::Request::Base.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id],
+          Exlibris::Primo::WebService::Request::User.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id],
+          Exlibris::Primo::WebService::Request::Record.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id],
+          Exlibris::Primo::WebService::Request::UserRecord.base_elements
+      end
+
+      def test_eshelf_base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_id],
+          Exlibris::Primo::WebService::Request::Eshelf.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_id, :doc_id],
+          Exlibris::Primo::WebService::Request::EshelfRecord.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_id, :include_basket_items],
+          Exlibris::Primo::WebService::Request::GetEshelfStructure.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_name, :parent_folder],
+          Exlibris::Primo::WebService::Request::AddFolderToEshelf.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_id, :get_delivery],
+          Exlibris::Primo::WebService::Request::GetEshelf.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :doc_id, :searchkey],
+          Exlibris::Primo::WebService::Request::AddToEshelf.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_id, :doc_id],
+          Exlibris::Primo::WebService::Request::RemoveFromEshelf.base_elements
+      end
+      
+      def test_new_eshelf_base_elements
+        # 
+        # The eshelf structure action is not specified in Primo's WSDL and 
+        # is therefore not supported for the time being.
+        # 
+        # assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :folder_id, :include_basket_items],
+        #   Exlibris::Primo::WebService::Request::GetEshelfStructure.base_elements
+        assert_nothing_raised {
+          request = Exlibris::Primo::WebService::Request::AddFolderToEshelf.new(
+            :institution => @institution, 
+            :ip => @ip, 
+            :group => @group, 
+            :on_campus => @on_campus, 
+            :is_logged_in => @is_logged_in, 
+            :pds_handle => @pds_handle, 
+            :user_id => @user_id, 
+            :folder_name => @folder_name, 
+            :parent_folder => @parent_folder
+          )
+          assert_equal "<institution>University</institution>"+
+            "<ip>127.0.0.1</ip>"+
+            "<group>Department</group>"+
+            "<onCampus>true</onCampus>"+
+            "<isLoggedIn>true</isLoggedIn>"+
+            "<pdsHandle>pds_handle_dummy</pdsHandle>"+
+            "<userId>user_id_dummy</userId>"+
+            "<folderName>new folder, dummy</folderName>"+
+            "<parentFolder>parent_folder_dummy</parentFolder>", request.send(:base_elements_xml)
+        }
+        assert_nothing_raised {
+          request = Exlibris::Primo::WebService::Request::GetEshelf.new(
+            :institution => @institution, 
+            :ip => @ip, 
+            :group => @group, 
+            :on_campus => @on_campus, 
+            :is_logged_in => @is_logged_in, 
+            :pds_handle => @pds_handle, 
+            :user_id => @user_id, 
+            :folder_id => @folder_id
+          )
+          assert_equal "<institution>University</institution>"+
+            "<ip>127.0.0.1</ip>"+
+            "<group>Department</group>"+
+            "<onCampus>true</onCampus>"+
+            "<isLoggedIn>true</isLoggedIn>"+
+            "<pdsHandle>pds_handle_dummy</pdsHandle>"+
+            "<userId>user_id_dummy</userId>"+
+            "<folderId>folder_id_dummy</folderId>", request.send(:base_elements_xml)
+        }
+        assert_nothing_raised {
+          request = Exlibris::Primo::WebService::Request::AddToEshelf.new(
+            :institution => @institution, 
+            :ip => @ip, 
+            :group => @group, 
+            :on_campus => @on_campus, 
+            :is_logged_in => @is_logged_in, 
+            :pds_handle => @pds_handle, 
+            :user_id => @user_id, 
+            :doc_id => @doc_id, 
+            :searchkey => @search_key
+          )
+          assert_equal "<institution>University</institution>"+
+            "<ip>127.0.0.1</ip>"+
+            "<group>Department</group>"+
+            "<onCampus>true</onCampus>"+
+            "<isLoggedIn>true</isLoggedIn>"+
+            "<pdsHandle>pds_handle_dummy</pdsHandle>"+
+            "<userId>user_id_dummy</userId>"+
+            "<docId>doc_id_dummy</docId>"+
+            "<searchkey>search_key_dummy</searchkey>", request.send(:base_elements_xml)
+        }
+        assert_nothing_raised {
+          request = Exlibris::Primo::WebService::Request::RemoveFromEshelf.new(
+            :institution => @institution, 
+            :ip => @ip, 
+            :group => @group, 
+            :on_campus => @on_campus, 
+            :is_logged_in => @is_logged_in, 
+            :pds_handle => @pds_handle, 
+            :user_id => @user_id, 
+            :folder_id => @folder_id, 
+            :doc_id => @doc_id
+          )
+          assert_equal "<institution>University</institution>"+
+            "<ip>127.0.0.1</ip>"+
+            "<group>Department</group>"+
+            "<onCampus>true</onCampus>"+
+            "<isLoggedIn>true</isLoggedIn>"+
+            "<pdsHandle>pds_handle_dummy</pdsHandle>"+
+            "<userId>user_id_dummy</userId>"+
+            "<folderId>folder_id_dummy</folderId>"+
+            "<docId>doc_id_dummy</docId>", request.send(:base_elements_xml)
+        }
+      end
+
+      def test_search_base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle],
+          Exlibris::Primo::WebService::Request::Search.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id],
+          Exlibris::Primo::WebService::Request::FullView.base_elements
+      end
+      
+      def test_new_search_base_elements
+        assert_nothing_raised {
+          request = Exlibris::Primo::WebService::Request::Search.new(
+            :institution => @institution, 
+            :ip => @ip, 
+            :group => @group, 
+            :on_campus => @on_campus, 
+            :is_logged_in => @is_logged_in, 
+            :pds_handle => @pds_handle
+          )
+          assert_equal "<institution>University</institution>"+
+            "<ip>127.0.0.1</ip>"+
+            "<group>Department</group>"+
+            "<onCampus>true</onCampus>"+
+            "<isLoggedIn>true</isLoggedIn>"+
+            "<pdsHandle>pds_handle_dummy</pdsHandle>", request.send(:base_elements_xml)
+        }
+        assert_nothing_raised {
+          request = Exlibris::Primo::WebService::Request::FullView.new(
+            :institution => @institution, 
+            :ip => @ip, 
+            :group => @group, 
+            :on_campus => @on_campus, 
+            :is_logged_in => @is_logged_in, 
+            :pds_handle => @pds_handle, 
+            :doc_id => @doc_id
+          )
+          assert_equal "<institution>University</institution>"+
+            "<ip>127.0.0.1</ip>"+
+            "<group>Department</group>"+
+            "<onCampus>true</onCampus>"+
+            "<isLoggedIn>true</isLoggedIn>"+
+            "<pdsHandle>pds_handle_dummy</pdsHandle>"+
+            "<docId>doc_id_dummy</docId>", request.send(:base_elements_xml)
+        }
+      end
+
+      def test_reviews_base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id],
+          Exlibris::Primo::WebService::Request::Reviews.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id],
+          Exlibris::Primo::WebService::Request::GetReviews.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id],
+          Exlibris::Primo::WebService::Request::GetAllMyReviews.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id],
+          Exlibris::Primo::WebService::Request::GetReviewsForRecord.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id, :rating],
+          Exlibris::Primo::WebService::Request::GetReviewsByRating.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id, :value, :rating, :user_display_name, :allow_user_name, :status],
+          Exlibris::Primo::WebService::Request::AddReview.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id],
+          Exlibris::Primo::WebService::Request::RemoveReview.base_elements
+      end
+
+      def test_tags_base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id],
+          Exlibris::Primo::WebService::Request::Tags.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id],
+          Exlibris::Primo::WebService::Request::GetTags.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id],
+          Exlibris::Primo::WebService::Request::GetAllMyTags.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id],
+          Exlibris::Primo::WebService::Request::GetTagsForRecord.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :doc_id, :user_id, :value],
+          Exlibris::Primo::WebService::Request::RemoveTag.base_elements
+        assert_equal [:institution, :ip, :group, :on_campus, :is_logged_in, :pds_handle, :user_id],
+          Exlibris::Primo::WebService::Request::RemoveUserTags.base_elements
+      end
+      
+      def test_undefined_base_elements
+        assert_nothing_raised {
+          Exlibris::Primo::WebService::Request::GetEshelf.new(:not_a_base_element => "")
+        }
+        request = Exlibris::Primo::WebService::Request::GetEshelf.new
+        assert_raise(NoMethodError) {
+          request.not_a_base_element = ""
+        }
+      end
+    end
+  end
+end