exlibris-primo 0.1.5 → 1.0.0

data/test/web_service/request/build_xml_test.rb

@@ -0,0 +1,23 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class BuildXmlTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @institution = "University"
+        @group = "Department"
+      end
+  
+      def test_request_build_xml
+          search_request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          element = search_request.send :build_xml do |xml|
+            xml.outer {
+              xml.inner "value"
+            }
+          end
+          assert_kind_of String, element
+          assert_equal "<outer><inner>value</inner></outer>", element
+      end
+    end
+  end
+end

data/test/web_service/request/client_test.rb

@@ -0,0 +1,53 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class ClientTest < 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_eshelf_client
+        assert_equal :eshelf_structure, Exlibris::Primo::WebService::Request::GetEshelfStructure.client
+        assert_equal :eshelf, Exlibris::Primo::WebService::Request::AddFolderToEshelf.client
+        assert_equal :eshelf, Exlibris::Primo::WebService::Request::GetEshelf.client
+        assert_equal :eshelf, Exlibris::Primo::WebService::Request::AddToEshelf.client
+        assert_equal :eshelf, Exlibris::Primo::WebService::Request::RemoveFromEshelf.client
+        assert_equal :eshelf, Exlibris::Primo::WebService::Request::GetEshelf.client
+      end
+
+      def test_search_client
+        assert_equal :search, Exlibris::Primo::WebService::Request::Search.client
+        assert_equal :search, Exlibris::Primo::WebService::Request::FullView.client
+      end
+      
+      def test_reviews_client
+        assert_equal :reviews, Exlibris::Primo::WebService::Request::GetReviews.client
+        assert_equal :reviews, Exlibris::Primo::WebService::Request::GetAllMyReviews.client
+        assert_equal :reviews, Exlibris::Primo::WebService::Request::GetReviewsForRecord.client
+        assert_equal :reviews, Exlibris::Primo::WebService::Request::GetReviewsByRating.client
+        assert_equal :reviews, Exlibris::Primo::WebService::Request::AddReview.client
+        assert_equal :reviews, Exlibris::Primo::WebService::Request::RemoveReview.client
+      end
+
+      def test_tags_client
+        assert_equal :tags, Exlibris::Primo::WebService::Request::GetTags.client
+        assert_equal :tags, Exlibris::Primo::WebService::Request::GetAllMyTags.client
+        assert_equal :tags, Exlibris::Primo::WebService::Request::GetTagsForRecord.client
+        assert_equal :tags, Exlibris::Primo::WebService::Request::RemoveTag.client
+        assert_equal :tags, Exlibris::Primo::WebService::Request::RemoveUserTags.client
+      end
+    end
+  end
+end

data/test/web_service/request/eshelf_test.rb

@@ -0,0 +1,26 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class EshelfTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @institution = "NYU"
+        @user_id = "N12162279"
+        @doc_id = "nyu_aleph000062856"
+      end
+
+      def test_get_eshelf
+        request = Exlibris::Primo::WebService::Request::GetEshelf.new :base_url => @base_url,
+          :institution => @institution, :user_id => @user_id
+        assert_request request, "getEshelfRequest",
+          "<institution>NYU</institution>",
+          "<userId>N12162279</userId>"
+        VCR.use_cassette('request get eshelf') do
+          assert_nothing_raised {
+            request.call
+          }
+        end
+      end
+    end
+  end
+end

data/test/web_service/request/location_test.rb

@@ -0,0 +1,25 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class LocationTest < Test::Unit::TestCase
+      def setup
+        @kind = "local"
+        @value = "scope:(VOLCANO)"
+      end
+
+      def test_set_attributes
+        location = Exlibris::Primo::WebService::Request::Location.new()
+        location.kind = @kind
+        location.value = @value
+        assert_equal "local", location.kind
+        assert_equal "scope:(VOLCANO)", location.value
+      end
+
+      def test_write_attributes
+        location = Exlibris::Primo::WebService::Request::Location.new(:kind => @kind, :value => @value)
+        assert_equal "local", location.kind
+        assert_equal "scope:(VOLCANO)", location.value
+      end
+    end
+  end
+end

data/test/web_service/request/query_term_test.rb

@@ -0,0 +1,29 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class QueryTermTest < Test::Unit::TestCase
+      def setup
+        @isbn = "0143039008"
+        @issn = "0090-5720"
+        @title = "Travels with My Aunt"
+        @author = "Graham Greene"
+        @genre = "Book"
+      end
+
+      def test_set_attributes
+        query_term = Exlibris::Primo::WebService::Request::QueryTerm.new()
+        query_term.value = @isbn
+        query_term.precision = "exact"
+        query_term.index = "isbn"
+        assert_equal "<QueryTerm><IndexField>isbn</IndexField>"+
+          "<PrecisionOperator>exact</PrecisionOperator><Value>0143039008</Value></QueryTerm>", query_term.to_xml
+      end
+
+      def test_write_attributes
+        query_term = Exlibris::Primo::WebService::Request::QueryTerm.new(:value => @isbn, :precision => "exact", :index => "isbn")
+        assert_equal "<QueryTerm><IndexField>isbn</IndexField>"+
+          "<PrecisionOperator>exact</PrecisionOperator><Value>0143039008</Value></QueryTerm>", query_term.to_xml
+      end
+    end
+  end
+end

data/test/web_service/request/reviews_test.rb

@@ -0,0 +1,27 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class ReviewsTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @institution = "NYU"
+        @user_id = "N12162279"
+        @doc_id = "nyu_aleph000062856"
+      end
+
+      def test_get_reviews
+        request = Exlibris::Primo::WebService::Request::GetReviews.new :base_url => @base_url,
+          :institution => @institution, :doc_id => @doc_id, :user_id => @user_id
+        assert_request request, "getReviewsRequest",
+          "<institution>NYU</institution>",
+          "<docId>nyu_aleph000062856</docId>",
+          "<userId>N12162279</userId>"
+        VCR.use_cassette('request get reviews') do
+          assert_nothing_raised {
+            response = request.call
+          }
+        end
+      end
+    end
+  end
+end

data/test/web_service/request/search_test.rb

@@ -0,0 +1,234 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class SearchTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @institution = "NYU"
+        @isbn = "0143039008"
+        @issn = "0090-5720"
+        @title = "Travels with My Aunt"
+        @author = "Graham Greene"
+        @genre = "Book"
+        @doc_id = "nyu_aleph000062856"
+      end
+
+      def test_full_view
+        request = Exlibris::Primo::WebService::Request::FullView.new :base_url => @base_url,
+          :institution => @institution, :doc_id => @doc_id
+        assert_request request, "fullViewRequest",
+          "<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>"
+        VCR.use_cassette('request full view') do
+          assert_nothing_raised {
+            response = request.call
+          }
+        end
+      end
+
+      def test_request_search_issn
+          request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          request.institution = @institution
+          request.add_query_term @issn, "isbn", "exact"
+          assert_request request, "searchRequest",
+            "<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>"
+          VCR.use_cassette('request search issn') do
+            assert_nothing_raised {
+              response = request.call
+            }
+          end
+      end
+
+      def test_request_search_isbn
+          request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          request.institution = @institution
+          request.add_query_term @isbn, "isbn", "exact"
+          assert_request request, "searchRequest",
+            "<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>"
+          VCR.use_cassette('request search isbn') do
+            assert_nothing_raised {
+              response = request.call
+            }
+          end
+      end
+
+      def test_request_search_title
+          request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          request.institution = @institution
+          request.add_query_term @title, "title"
+          assert_request request, "searchRequest",
+            "<PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\">"+
+            "<QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm>"+
+            "<IndexField>title</IndexField>"+
+            "<PrecisionOperator>contains</PrecisionOperator>"+
+            "<Value>Travels with My Aunt</Value>"+
+            "</QueryTerm></QueryTerms>"+
+            "<StartIndex>1</StartIndex>"+
+            "<BulkSize>5</BulkSize>"+
+            "<DidUMeanEnabled>false</DidUMeanEnabled>"+
+            "</PrimoSearchRequest>", "<institution>NYU</institution>"
+          VCR.use_cassette('request search title') do
+            assert_nothing_raised {
+              response = request.call
+            }
+          end
+      end
+
+      def test_request_search_did_u_mean
+          request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          request.institution = @institution
+          request.did_u_mean_enabled = true
+          request.add_query_term "Digital dvide", "title"
+          assert_request request, "searchRequest",
+            "<PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\">"+
+            "<QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm>"+
+            "<IndexField>title</IndexField>"+
+            "<PrecisionOperator>contains</PrecisionOperator>"+
+            "<Value>Digital dvide</Value>"+
+            "</QueryTerm></QueryTerms>"+
+            "<StartIndex>1</StartIndex>"+
+            "<BulkSize>5</BulkSize>"+
+            "<DidUMeanEnabled>true</DidUMeanEnabled>"+
+            "</PrimoSearchRequest>", "<institution>NYU</institution>"
+          VCR.use_cassette('request search did u mean') do
+            assert_nothing_raised {
+              response = request.call
+            }
+          end
+      end
+
+      def test_request_search_author
+          request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          request.institution = @institution
+          request.add_query_term @author, "creator"
+          assert_request request, "searchRequest",
+            "<PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\">"+
+            "<QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm>"+
+            "<IndexField>creator</IndexField>"+
+            "<PrecisionOperator>contains</PrecisionOperator>"+
+            "<Value>Graham Greene</Value>"+
+            "</QueryTerm></QueryTerms>"+
+            "<StartIndex>1</StartIndex>"+
+            "<BulkSize>5</BulkSize>"+
+            "<DidUMeanEnabled>false</DidUMeanEnabled>"+
+            "</PrimoSearchRequest>", "<institution>NYU</institution>"
+          VCR.use_cassette('request search author') do
+            assert_nothing_raised {
+              response = request.call
+            }
+          end
+      end
+
+      def test_request_search_genre
+          request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+          request.institution = @institution
+          request.add_query_term @genre, "any", "exact"
+          assert_request request, "searchRequest",
+            "<PrimoSearchRequest xmlns=\"http://www.exlibris.com/primo/xsd/search/request\">"+
+            "<QueryTerms><BoolOpeator>AND</BoolOpeator><QueryTerm>"+
+            "<IndexField>any</IndexField>"+
+            "<PrecisionOperator>exact</PrecisionOperator>"+
+            "<Value>Book</Value>"+
+            "</QueryTerm></QueryTerms>"+
+            "<StartIndex>1</StartIndex>"+
+            "<BulkSize>5</BulkSize>"+
+            "<DidUMeanEnabled>false</DidUMeanEnabled>"+
+            "</PrimoSearchRequest>", "<institution>NYU</institution>"
+          VCR.use_cassette('request search genre') do
+            assert_nothing_raised {
+              response = request.call
+            }
+          end
+      end
+      
+      def test_search_locations
+        request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+        request.institution = @institution
+        request.add_query_term @isbn, "isbn", "exact"
+        request.add_location "local", "scope:(NYU)"
+        assert_request request, "searchRequest",
+          "<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>"+
+          "<Locations><uic:Location type=\"local\" value=\"scope:(NYU)\"/></Locations>"+
+          "</PrimoSearchRequest>", "<institution>NYU</institution>"
+        VCR.use_cassette('request search locations') do
+          assert_nothing_raised {
+            response = request.call
+          }
+        end
+      end
+
+      def test_request_search_title_author_genre
+        request = Exlibris::Primo::WebService::Request::Search.new :base_url => @base_url
+        request.institution = @institution
+        request.add_query_term @title, "title"
+        request.add_query_term @author, "creator"
+        request.add_query_term @genre, "any", "exact"
+        assert_request_children(request, "searchRequest") do |child|
+          if child.children.size > 1
+            assert_nil child.namespace.prefix
+            assert_equal "http://www.exlibris.com/primo/xsd/search/request", child.namespace.href
+            child.children.each do |grand_child|
+              if grand_child.children.size > 1
+                assert_equal 4, grand_child.children.size
+                grand_child.children.each do |great_grand_child|
+                  assert [
+                    "<BoolOpeator>AND</BoolOpeator>",
+                    "<QueryTerm><IndexField>title</IndexField>"+
+                    "<PrecisionOperator>contains</PrecisionOperator>"+
+                    "<Value>Travels with My Aunt</Value></QueryTerm>",
+                    "<QueryTerm><IndexField>creator</IndexField>"+
+                    "<PrecisionOperator>contains</PrecisionOperator>"+
+                    "<Value>Graham Greene</Value></QueryTerm>",
+                    "<QueryTerm><IndexField>any</IndexField>"+
+                    "<PrecisionOperator>exact</PrecisionOperator>"+
+                    "<Value>Book</Value></QueryTerm>"].include? xmlize(great_grand_child)
+                end
+              else
+                assert ["<StartIndex>1</StartIndex>", "<BulkSize>5</BulkSize>", 
+                  "<DidUMeanEnabled>false</DidUMeanEnabled>"].include? xmlize(grand_child)
+              end
+            end
+          else
+            assert_equal "<institution>NYU</institution>", xmlize(child)
+          end
+        end
+        VCR.use_cassette('request search title author genre') do
+          assert_nothing_raised {
+            response = request.call
+          }
+        end
+      end
+    end
+  end
+end

data/test/web_service/request/soap_action_test.rb

@@ -0,0 +1,120 @@
+module WebService
+  module Request
+    require 'test_helper'
+    class ActionTest < Test::Unit::TestCase
+      def setup
+        @base_url = "http://bobcatdev.library.nyu.edu"
+        @isbn = "0143039008"
+        @user_id = "N12162279"
+        @institution = "NYU"
+        @doc_id = "nyu_aleph000062856"
+        @dedupmgr_id = "dedupmrg17343091"
+        @basket_id ="210075761"
+        @new_folder_name = "new folder"
+        @folder_to_remove = "377473116"
+      end
+
+      def test_eshelf_soap_action
+        assert_equal :get_eshelf_structure,
+          Exlibris::Primo::WebService::Request::GetEshelfStructure.soap_action
+        assert_equal :get_eshelf,
+          Exlibris::Primo::WebService::Request::GetEshelf.soap_action
+        assert_equal :add_to_eshelf,
+          Exlibris::Primo::WebService::Request::AddToEshelf.soap_action
+        assert_equal :remove_from_eshelf,
+          Exlibris::Primo::WebService::Request::RemoveFromEshelf.soap_action
+        assert_equal :add_folder_to_eshelf,
+          Exlibris::Primo::WebService::Request::AddFolderToEshelf.soap_action
+        assert_equal :remove_folder_from_eshelf,
+          Exlibris::Primo::WebService::Request::RemoveFolderFromEshelf.soap_action
+      end
+
+      def test_call_eshelf_soap_action
+        assert_nothing_raised {
+          VCR.use_cassette('request get eshelf structure') do
+            Exlibris::Primo::WebService::Request::GetEshelfStructure.new(:base_url => @base_url,
+              :institution => @institution, :user_id => @user_id).call
+          end
+          VCR.use_cassette('request get eshelf') do
+            Exlibris::Primo::WebService::Request::GetEshelf.new(:base_url => @base_url,
+              :institution => @institution, :user_id => @user_id, :folder_id => @basket_id).call
+          end
+          VCR.use_cassette('request add to eshelf') do
+            Exlibris::Primo::WebService::Request::AddToEshelf.new(:base_url => @base_url,
+              :institution => @institution, :user_id => @user_id, :doc_id => @doc_id, :folder_id => @basket_id).call
+          end
+          VCR.use_cassette('request remove from eshelf') do
+            Exlibris::Primo::WebService::Request::RemoveFromEshelf.new(:base_url => @base_url,
+              :institution => @institution, :user_id => @user_id, :doc_id => @doc_id, :folder_id => @basket_id).call
+          end
+          VCR.use_cassette('request add folder to eshelf') do
+            Exlibris::Primo::WebService::Request::AddFolderToEshelf.new(:base_url => @base_url,
+              :institution => @institution, :user_id => @user_id, :folder_name => @new_folder_name, :parent_folder => @basket_id).call
+          end
+          VCR.use_cassette('request remove folder from eshelf') do
+            Exlibris::Primo::WebService::Request::RemoveFolderFromEshelf.new(:base_url => @base_url,
+              :institution => @institution, :user_id => @user_id, :folder_id => @folder_to_remove).call
+          end
+        }
+      end
+
+      def test_search_soap_action
+        assert_equal :search_brief,
+          Exlibris::Primo::WebService::Request::Search.soap_action
+        assert_equal :get_record,
+          Exlibris::Primo::WebService::Request::FullView.soap_action
+      end
+
+      def test_call_search_soap_action
+        assert_nothing_raised {
+          VCR.use_cassette('request search isbn') do
+            request = Exlibris::Primo::WebService::Request::Search.new(:base_url => @base_url, :institution => @institution)
+            request.add_query_term @isbn, "isbn", "exact"
+            request.call
+          end
+          VCR.use_cassette('request full view') do
+            Exlibris::Primo::WebService::Request::FullView.new(:base_url => @base_url, :doc_id => @doc_id).call
+          end
+        }
+      end
+
+      def test_reviews_soap_action
+        assert_equal :get_reviews,
+          Exlibris::Primo::WebService::Request::GetReviews.soap_action
+        assert_equal :get_all_my_reviews,
+          Exlibris::Primo::WebService::Request::GetAllMyReviews.soap_action
+        assert_equal :get_reviews_for_record,
+          Exlibris::Primo::WebService::Request::GetReviewsForRecord.soap_action
+        assert_equal :get_reviews_by_rating,
+          Exlibris::Primo::WebService::Request::GetReviewsByRating.soap_action
+        assert_equal :add_review,
+          Exlibris::Primo::WebService::Request::AddReview.soap_action
+        assert_equal :remove_review,
+          Exlibris::Primo::WebService::Request::RemoveReview.soap_action
+      end
+
+      def test_tags_soap_action
+        assert_equal :get_tags,
+          Exlibris::Primo::WebService::Request::GetTags.soap_action
+        assert_equal :get_all_my_tags,
+          Exlibris::Primo::WebService::Request::GetAllMyTags.soap_action
+        assert_equal :get_tags_for_record,
+          Exlibris::Primo::WebService::Request::GetTagsForRecord.soap_action
+        assert_equal :remove_tag,
+          Exlibris::Primo::WebService::Request::RemoveTag.soap_action
+        assert_equal :remove_user_tags,
+          Exlibris::Primo::WebService::Request::RemoveUserTags.soap_action
+      end
+
+      def test_undefined_action
+        Exlibris::Primo::WebService::Request::Search.send(:soap_action=, :undefined_action)
+        assert_raise(NoMethodError) {
+          VCR.use_cassette('request undefined action call') do
+            Exlibris::Primo::WebService::Request::Search.new(:base_url => @base_url).call
+          end
+        }
+        Exlibris::Primo::WebService::Request::Search.send(:soap_action=, :search_brief)
+      end
+    end
+  end
+end