exlibris-primo 0.1.5 → 1.0.0

data/lib/exlibris/primo/web_service/request/base/soap_action.rb

@@ -0,0 +1,29 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module SoapAction
+          def self.included(klass)
+            klass.class_eval do
+              extend ClassAttributes
+            end
+          end
+
+          module ClassAttributes
+            def soap_action
+              @soap_action ||= name.demodulize.underscore.to_sym
+            end
+
+            attr_writer :soap_action
+            protected :soap_action=
+          end
+
+          def soap_action
+            @soap_action ||= self.class.soap_action
+          end
+          protected :soap_action
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # Abstract class for eshelf interaction
+        # 
+        class Eshelf < User
+          self.add_base_elements :folder_id
+          self.abstract = true
+          self.has_client
+        end
+
+        # 
+        # Abstract class for eshelf record interaction
+        # 
+        class EshelfRecord < Eshelf
+          self.add_base_elements :doc_id
+          self.abstract = true
+        end
+
+        # 
+        # Abstract class for eshelf structure interaction
+        # 
+        class EshelfStructure < Eshelf
+          self.add_base_elements :include_basket_items
+          self.has_client
+          self.abstract = true
+        end
+
+        # 
+        # Get eshelf structure from Primo for a specified user
+        # 
+        class GetEshelfStructure < EshelfStructure; end
+
+        # 
+        # Get eshelf from Primo for a specified user
+        # 
+        class GetEshelf < Eshelf
+          self.add_base_elements :get_delivery
+        end
+
+        # 
+        # Add given record to Primo for a specified user
+        # 
+        class AddToEshelf < EshelfRecord
+          self.add_base_elements :searchkey
+          self.remove_base_elements :folder_id
+        end
+
+        # 
+        # Remove given record from Primo for a specified user
+        # 
+        class RemoveFromEshelf < EshelfRecord; end
+
+        # 
+        # Add given folder name to Primo for a specified user
+        # 
+        class AddFolderToEshelf < Eshelf
+          self.add_base_elements :folder_name, :parent_folder
+          self.remove_base_elements :folder_id
+        end
+
+        # 
+        # Remove given folder from Primo for a specified user
+        # 
+        class RemoveFolderFromEshelf < Eshelf; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # Abstract class for reviews interaction
+        # 
+        class Reviews < UserRecord
+          self.abstract = true
+          self.has_client
+        end
+        
+        # 
+        # Get reviews from from Primo for a specified user
+        # and record
+        # 
+        class GetReviews < Reviews; end
+
+        # 
+        # Get all reviews for a specified user from Primo
+        # 
+        class GetAllMyReviews < Reviews
+          self.remove_base_elements :doc_id
+        end
+
+        # 
+        # Get reviews for a specified record from Primo
+        # 
+        class GetReviewsForRecord < Reviews
+          self.remove_base_elements :user_id
+        end
+
+        # 
+        # Get reviews of a given rating for a specified user from Primo
+        # 
+        class GetReviewsByRating < Reviews
+          self.add_base_elements :rating
+          self.remove_base_elements :doc_id
+        end
+
+        # 
+        # Add given review to Primo for a specified record and user
+        # 
+        class AddReview < Reviews
+          # Add review elements to the base elements
+          self.add_base_elements :value, :rating, :user_display_name, 
+            :allow_user_name, :status
+        end
+
+        # 
+        # Remove review from Primo for a specified record and user
+        # 
+        class RemoveReview < Reviews; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # Search Primo
+        # 
+        class Search < Base
+          self.has_client
+          self.soap_action = :search_brief
+          include DisplayFields
+          include Languages
+          include Locations
+          include QueryTerms
+          include SearchElements
+          include SortBys
+
+          add_default_search_elements :start_index => "1", 
+            :bulk_size => "5", :did_u_mean_enabled => "false"
+
+          add_search_elements :start_index, :bulk_size, :did_u_mean_enabled,
+              :highlighting_enabled, :get_more, :inst_boost
+
+          def to_xml
+            super { |xml|
+              xml.PrimoSearchRequest("xmlns" => "http://www.exlibris.com/primo/xsd/search/request") {
+                query_terms_xml.call xml
+                search_elements_xml.call xml
+                languages_xml.call xml
+                sort_bys_xml.call xml
+                display_fields_xml.call xml
+                locations_xml.call xml
+              }
+            }
+          end
+        end
+
+        # 
+        # Get a specific record from Primo.
+        # 
+        class FullView < Search
+          # Add doc_id to the base elements
+          self.add_base_elements :doc_id
+          self.soap_action = :get_record
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module DisplayFields
+          # 
+          # Returns a lambda that takes a Nokogiri::XML::Builder as an argument
+          # and appends display fields XML to it.
+          # 
+          def display_fields_xml
+            lambda { |xml|
+              display_fields.each do |display_field|
+                xml.DisplayFields display_field
+              end
+            }
+          end
+          protected :display_fields_xml
+
+          def display_fields
+            @display_fields ||= []
+          end
+
+          def add_display_field(display_field)
+            display_fields << display_field
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module Languages
+          # 
+          # Returns a lambda that takes a Nokogiri::XML::Builder as an argument
+          # and appends languages XML to it.
+          # 
+          def languages_xml
+            lambda { |xml|
+              xml.Languages {
+                languages.each do |language|
+                  xml.Language language
+                end
+              } unless languages.empty?
+            }
+          end
+          protected :languages_xml
+
+          def languages
+            @languages ||= []
+          end
+
+          def add_language(language)
+            languages << language
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # 
+        # 
+        class Location
+          include WriteAttributes
+          attr_accessor :kind, :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module Locations
+          # 
+          # Returns a lambda that takes a Nokogiri::XML::Builder as an argument
+          # and appends locations XML to it.
+          # 
+          def locations_xml
+            lambda { |xml|
+              # Specify the uic namespace. Not great, but adequate.
+              xml.Locations {
+                locations.each do |location|
+                  xml['uic'].Location(:type => location.kind, :value => location.value)
+                end
+              } unless locations.empty?
+            }
+          end
+          protected :locations_xml
+
+          def locations
+            @locations ||= []
+          end
+
+          def add_location(kind, value)
+            locations << Location.new(:kind => kind, :value => value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # 
+        # 
+        class QueryTerm
+          include WriteAttributes
+          include XmlUtil
+          attr_accessor :index, :precision, :value
+          attr_writer :include_values, :exclude_values
+          
+          def include_values
+            @include_values ||= []
+          end
+
+          def exclude_values
+            @exclude_values ||= []
+          end
+
+          def to_xml
+            include_values = self.include_values
+            exclude_values = self.exclude_values
+            build_xml do |xml|
+              xml.QueryTerm {
+                xml.IndexField index
+                xml.PrecisionOperator precision
+                xml.Value value
+                include_values.each do |include_value|
+                  xml.includeValue include_value
+                end
+                exclude_values.each do |exclude_value|
+                  xml.excludeValue exclude_value
+                end
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module QueryTerms
+          attr_writer :boolean_operator
+
+          def boolean_operator
+            @boolean_operator ||= "AND"
+          end
+          
+          # 
+          # Returns a lambda that takes a Nokogiri::XML::Builder as an argument
+          # and appends query terms XML to it.
+          # 
+          def query_terms_xml
+            bool_operator = boolean_operator
+            lambda do |xml|
+              xml.QueryTerms {
+                xml.BoolOpeator bool_operator
+                query_terms.each do |query_term|
+                  xml << query_term.to_xml
+                end
+              }
+            end
+          end
+          protected :query_terms_xml
+
+          def query_terms
+            @query_terms ||= []
+          end
+
+          def add_query_term(value, index, precision="contains")
+            query_terms << QueryTerm.new(:value => value, :index => index, :precision => precision)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module SearchElements
+          def self.included(klass)
+            klass.class_eval do
+              extend ClassAttributes
+            end
+          end
+
+          module ClassAttributes
+            def search_elements
+              @search_elements ||= self.superclass.respond_to?(:search_elements) ?
+                self.superclass.search_elements.dup : []
+            end
+
+            def add_search_elements *elements
+              elements.each do |element|
+                search_elements << element unless search_elements.include? element
+              end
+            end
+            protected :add_search_elements
+
+            def remove_search_elements *elements
+              search_elements.delete_if do |element|
+                elements.include? element
+              end
+            end
+            protected :remove_search_elements
+
+            def default_search_elements
+              @default_search_elements ||= self.superclass.respond_to?(:default_search_elements) ?
+                self.superclass.default_search_elements.dup : {}
+            end
+
+            def add_default_search_elements elements
+              default_search_elements.merge! elements
+            end
+            protected :add_default_search_elements
+
+            def remove_default_search_elements *keys
+              keys.each do |key|
+                default_search_elements.delete key
+              end
+            end
+            protected :remove_default_search_elements
+          end
+
+          def search_elements
+            @search_elements ||= self.class.search_elements
+          end
+          protected :search_elements
+
+          def default_search_elements
+            @default_search_elements ||= self.class.default_search_elements
+          end
+          protected :default_search_elements
+
+          # 
+          # Returns a lambda that takes a Nokogiri::XML::Builder as an argument
+          # and appends search elements XML to it.
+          # 
+          def search_elements_xml
+            lambda { |xml|
+              search_elements.each do |element|
+                value = (send element) ? (send element) : default_search_elements[element]
+                name = element.id2name.camelize
+                xml.send(name, value) unless value.nil?
+              end
+            }
+          end
+          protected :search_elements_xml
+
+          #
+          # Dynamically sets attr_accessors for search_elements
+          #
+          def method_missing(method, *args, &block)
+            if search_elements.include?(attributize(method))
+              self.class.send :attr_accessor, attributize(method)
+              send method, *args, &block
+            else
+              super
+            end
+          end
+
+          #
+          # Tell users that we respond to search elements accessors.
+          #
+          def respond_to?(method, include_private = false)
+            (search_elements.include?(attributize method)) ? true : super
+          end
+        end
+      end
+    end
+  end
+end