exlibris-primo 0.1.5 → 1.0.0

data/lib/exlibris/primo/web_service/request/search/sort_bys.rb

@@ -0,0 +1,32 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module SortBys
+          # 
+          # Returns a lambda that takes a Nokogiri::XML::Builder as an argument
+          # and appends sort bys XML to it.
+          # 
+          def sort_bys_xml
+            lambda { |xml|
+              xml.SortByList {
+                sort_bys.each do |sort_by|
+                  xml.SortField sort_by
+                end
+              } unless sort_bys.empty?
+            }
+          end
+          protected :sort_bys_xml
+
+          def sort_bys
+            @sort_bys ||= []
+          end
+
+          def add_sort_by(sort_by)
+            sort_bys << sort_by
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/request/tags.rb

@@ -0,0 +1,56 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # Abstract class for tags interaction
+        # 
+        class Tags < UserRecord
+          self.abstract = true
+          self.has_client
+        end
+
+        # 
+        # Get tags from from Primo for a specified user
+        # and record
+        # 
+        class GetTags < Tags; end
+
+        # 
+        # Get all tags for a specified user from Primo
+        # 
+        class GetAllMyTags < Tags
+          self.remove_base_elements :doc_id
+        end
+
+        # 
+        # Get tags for a specified record from Primo
+        # 
+        class GetTagsForRecord < Tags
+          self.remove_base_elements :user_id
+        end
+
+        # 
+        # Add given tag to Primo for a specified record and user
+        # 
+        class AddTag < Tags
+          self.add_base_elements :value
+        end
+
+        # 
+        # Remove given tag from Primo for a specified record and user
+        # 
+        class RemoveTag < Tags
+          self.add_base_elements :value
+        end
+
+        # 
+        # Remove all tags from Primo for a specified user
+        # 
+        class RemoveUserTags < Tags
+          self.remove_base_elements :doc_id
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/base.rb

@@ -0,0 +1,28 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        class Base
+          include Abstract
+          include Error
+          include Namespaces
+          include Util
+          include XmlUtil
+          self.abstract = true
+
+          attr_reader :savon_response, :soap_action, :code, :body
+          protected :savon_response, :soap_action
+
+          def initialize savon_response, soap_action
+            super
+            @savon_response = savon_response
+            @code = savon_response.http.code
+            @body = savon_response.http.body
+            @soap_action = soap_action
+            @raw_xml = savon_response.body[response_key][return_key]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/base/error.rb

@@ -0,0 +1,25 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        module Error
+          def error?
+            (error_code && (not error_code.eql? "0"))
+          end
+
+          def error
+            @error ||= xml_without_namespaces.root.at_xpath("//ERROR")
+          end
+
+          def error_code
+            @error_code ||= error["CODE"] if error
+          end
+
+          def error_message
+            @error_message ||= error["MESSAGE"] if error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/base/util.rb

@@ -0,0 +1,19 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        module Util
+          def response_key
+            "#{soap_action}_response".to_sym
+          end
+          protected :response_key
+          
+          def return_key
+            "#{soap_action}_return".to_sym
+          end
+          protected :response_key
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/did_u_mean.rb

@@ -0,0 +1,17 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        module DidUMean
+          def did_u_mean
+            @did_u_mean ||= querytransform["QUERY"].strip unless querytransform.nil?
+          end
+          
+          def querytransform
+            @querytransform ||= xml.at_xpath("//search:QUERYTRANSFORM[@ACTION='did_u_mean']", response_namespaces)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/eshelf.rb

@@ -0,0 +1,68 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        #
+        #
+        #
+        class Eshelf < Base
+          self.abstract = true
+        end
+
+        #
+        #
+        #
+        class GetEshelfStructure < Eshelf
+          def basket_id
+            @basket_id ||= basket_folder["folder_id"]
+          end
+
+          def basket_folder
+            @basket_folder ||= folder("Basket")
+          end
+
+          def folders
+            @folders ||= xml.xpath("//eshelf:eshelf_folders", response_namespaces)
+          end
+
+          def folder_id(folder_name)
+            folder(folder_name)["folder_id"] unless folder(folder_name).nil?
+          end
+
+          def folder(folder_name)
+            folders.at_xpath("//eshelf:eshelf_folder[./eshelf:folder_name='#{folder_name}']", response_namespaces)
+          end
+        end
+
+        #
+        #
+        #
+        class GetEshelf < Eshelf;
+          include DidUMean
+          include Records
+          include SearchStats
+        end
+
+        #
+        #
+        #
+        class AddToEshelf < Eshelf; end
+
+        #
+        #
+        #
+        class RemoveFromEshelf < Eshelf; end
+
+        #
+        #
+        #
+        class AddFolderToEshelf < Eshelf; end
+
+        #
+        #
+        #
+        class RemoveFolderFromEshelf < Eshelf; end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/facets.rb

@@ -0,0 +1,21 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        module Facets
+          def facets
+            @facets ||= (facet_list) ? facet_list.xpath("//search:FACET", response_namespaces).collect { |facet|
+              accurate = (facet.parent["ACCURATE_COUNTERS"].eql? "true")
+              Exlibris::Primo::Facet.new(:raw_xml => facet.to_xml, :accurate => accurate)
+            } : []
+          end
+
+          def facet_list
+            @facet_list ||= xml.at_xpath("//search:FACETLIST", response_namespaces)
+          end
+          private :facet_list
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/records.rb

@@ -0,0 +1,17 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        module Records
+          def records
+            @records ||= xml.xpath("//pnx:record", response_namespaces).collect { |record|
+                Exlibris::Primo::Record.new(:raw_xml => record.to_xml) }
+            # @records ||= Hash[xml.xpath("//pnx:record", response_namespaces).collect { |record|
+            #   [ record.xpath("//pnx:record_id", response_namespaces).inner_text,
+            #     Exlibris::Primo::Record.new(:raw_xml => record.to_xml) ]}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/reviews.rb

@@ -0,0 +1,49 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        # 
+        # 
+        # 
+        class Reviews < Base
+          self.abstract = true
+        end
+
+        # 
+        # 
+        # 
+        class GetReviews < Reviews
+          def reviews
+            @reviews ||= xml.root.xpath("//tags_reviews:Review", response_namespaces).collect { |review|
+                Exlibris::Primo::Review.new(:raw_xml => review.to_xml) }
+          end
+        end
+
+        # 
+        # 
+        # 
+        class GetAllMyReviews < GetReviews; end
+
+        # 
+        # 
+        # 
+        class GetReviewsForRecord < GetReviews; end
+
+        # 
+        # 
+        # 
+        class GetReviewsByRating < GetReviews; end
+
+        # 
+        # 
+        # 
+        class AddReview < Reviews; end
+
+        # 
+        # 
+        # 
+        class RemoveReview < Reviews; end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/search.rb

@@ -0,0 +1,36 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+
+        #
+        #
+        #
+        class Search < Base
+          include DidUMean
+          include Facets
+          include Records
+          include SearchStats
+        end
+
+        #
+        #
+        #
+        class FullView < Search
+          attr_reader :record
+
+          def initialize *args
+            super
+            @record = records.first
+            # @record = records.first.last
+            @local = parse_local(search_doc["LOCAL"]) if search_doc
+          end
+
+          def search_doc
+            xml.at_xpath("//search:DOC", response_namespaces)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/search_stats.rb

@@ -0,0 +1,48 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        module SearchStats
+          def total_time
+            @total_time ||= search_set["TOTAL_TIME"] if search_set
+          end
+          alias :time :total_time
+
+          def hit_time
+            @hit_time ||= search_set["HIT_TIME"] if search_set
+          end
+          alias :search_time :hit_time
+
+          def total_hits
+            @total_hits ||= Integer(search_set["TOTALHITS"]) if search_set
+          end
+          alias :hits :total_hits
+          alias :count :total_hits
+          alias :size :total_hits
+
+          def first_hit
+            @first_hit ||= search_set["FIRSTHIT"] if search_set
+          end
+
+          def last_hit
+            @last_hit ||= search_set["LASTHIT"] if search_set
+          end
+
+          def local?
+            @local ||= parse_local(search_set["IS_LOCAL"]) if search_set
+          end
+
+          def parse_local local
+            (local.eql? "true") if local
+          end
+          protected :parse_local
+
+          def search_set
+            @search_set ||= xml.at_xpath("//search:DOCSET", response_namespaces)
+          end
+          protected :search_set
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/response/tags.rb

@@ -0,0 +1,54 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Response
+        # 
+        # 
+        # 
+        class Tags < Base
+          self.abstract = true
+        end
+
+        # 
+        # 
+        # 
+        class GetTags < Tags
+          def my_tags
+            @my_tags ||= xml.root.xpath("//tags_reviews:MyTags/tags_reviews:Tag", response_namespaces).collect { |tag|
+                Exlibris::Primo::Tag.new(:raw_xml => tag.to_xml) }
+          end
+
+          def everybody_tags
+            @everybody_tags ||= xml.root.xpath("//tags_reviews:EverybodyTags/tags_reviews:Tag", response_namespaces).collect { |tag|
+                Exlibris::Primo::Tag.new(:raw_xml => tag.to_xml) }
+          end
+        end
+
+        # 
+        # 
+        # 
+        class GetAllMyTags < GetTags; end
+
+        # 
+        # 
+        # 
+        class GetTagsForRecord < GetTags; end
+
+        # 
+        # 
+        # 
+        class AddTag < Tags; end
+
+        # 
+        # 
+        # 
+        class RemoveTag < Tags; end
+
+        # 
+        # 
+        # 
+        class RemoveUserTags < Tags; end
+      end
+    end
+  end
+end