skala 0.3.0 → 1.1.0

data/lib/skala/primo_adapter/search/request_transformation/add_queries.rb

@@ -0,0 +1,97 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  AddQueries < Transformator::Transformation::Step
+
+  def call
+    query_terms_node = transformation.inner_search_request.locate("PrimoSearchRequest/QueryTerms").first
+
+    [source.queries, source.facet_queries].flatten.compact.presence.try(:each) do |_query|
+      if primo_query = query_factory(_query)
+        [primo_query].flatten(1).each do |_primo_query|
+          query_terms_node << _primo_query
+        end
+      end
+    end
+  end
+
+  private
+
+  def query_factory(query)
+    case query.type.to_sym
+    when :ids                 then query_from_ids_query(query)
+    when :match               then query_from_match_query(query)
+    when :query_string        then query_from_query_string_query(query)
+    when :range               then query_from_range_query(query)
+    when :simple_query_string then query_from_query_string_query(query) # supports also simple_query_string_query
+    else raise "Unsupported query type!"
+    end
+  end
+
+  def query_from_ids_query(query)
+    query.query.map do |_id|
+      Ox.parse(
+        <<-xml.strip_heredoc
+          <QueryTerm>
+            <IndexField>#{map_query_field("id")}</IndexField>
+            <PrecisionOperator>exact</PrecisionOperator>
+            <Value>#{_id}</Value>
+          </QueryTerm>
+        xml
+      )
+    end
+  end
+
+  def query_from_match_query(query)
+    Ox.parse(
+      <<-xml.strip_heredoc
+        <QueryTerm>
+          <IndexField>#{map_query_field(query.field)}</IndexField>
+          <PrecisionOperator>exact</PrecisionOperator>
+          <Value>#{query.query}</Value>
+        </QueryTerm>
+      xml
+    )
+  end
+
+  def query_from_range_query(query)
+    Ox.parse(
+      <<-xml
+        <QueryTerm>
+          <IndexField>#{query.field}</IndexField>
+          <PrecisionOperator>exact</PrecisionOperator>
+          <Value>[#{query.gte} TO #{query.lte}]</Value>
+        </QueryTerm>
+      xml
+    )
+  end
+
+  def query_from_query_string_query(query)
+    normalized_query =
+    if query.default_operator.upcase == "OR"
+      query.query.split(" ").join(" OR ")
+    else
+      query.query
+    end
+
+    Ox.parse(
+      <<-xml
+        <QueryTerm>
+          <IndexField>#{map_query_field(query.try(:default_field) || query.try(:fields).try(:first))}</IndexField>
+          <PrecisionOperator>contains</PrecisionOperator>
+          <Value>#{normalized_query}</Value>
+        </QueryTerm>
+      xml
+    )
+  end
+
+  def map_query_field(field)
+    case field
+    when 'id' then 'rid'
+    else
+      field
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/add_sort_by_list.rb

@@ -0,0 +1,37 @@
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  AddSortByList < Transformator::Transformation::Step
+
+  #
+  # SortField is optional, so we have to add it on the fly if necessary
+  #
+  def call
+    source.sort.try(:first).try do |_sort_request|
+      primo_search_request = transformation.inner_search_request.locate("PrimoSearchRequest").first
+      insert_sort_by_node(primo_search_request, _sort_request)
+    end
+  end
+
+  private
+
+  def insert_sort_by_node(primo_search_request, sort_request)
+    # Order matters, SortField *must* be inserted after <Languages>
+    index_of_languages = primo_search_request.nodes.index do |_node|
+      _node.value == "Languages"
+    end
+
+    # primo can only handle *one* sort field
+    sort_by_list = Ox.parse(
+      <<-xml
+        <SortByList>
+          <SortField>#{sort_request.field}</SortField>
+        </SortByList>
+      xml
+    )
+
+    # insert the SortByList at the appropriate position
+    primo_search_request.nodes.insert(index_of_languages + 1, sort_by_list)
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/embed_inner_search_request.rb

@@ -0,0 +1,13 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  EmbedInnerSearchRequest < Transformator::Transformation::Step
+
+  def call
+    target.locate("*/searchRequestStr").first.tap do |searchRequestStr|
+      searchRequestStr << Ox::CData.new(Ox.dump(transformation.inner_search_request))
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/serialize_target_as_xml.rb

@@ -0,0 +1,11 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SerializeTargetAsXml < Transformator::Transformation::Step
+
+  def call
+    self.target = Ox.dump(self.target, with_xml: true)
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/set_bulk_size.rb

@@ -0,0 +1,12 @@
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetBulkSize < Transformator::Transformation::Step
+
+  def call
+    transformation.inner_search_request.locate("PrimoSearchRequest/BulkSize").first.tap do |_node|
+      _node << source.size.to_s
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/set_institution.rb

@@ -0,0 +1,12 @@
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetInstitution < Transformator::Transformation::Step
+
+  def call
+    transformation.inner_search_request.locate("institution").first.tap do |node|
+      node << transformation.institution
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/set_languages.rb

@@ -0,0 +1,15 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetLanguages < Transformator::Transformation::Step
+
+  def call
+    transformation.languages.each do |_language|
+      transformation.inner_search_request.locate("PrimoSearchRequest/Languages").first.tap do |_node|
+        _node << Ox.parse("<Language>#{_language}</Language>")
+      end
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/set_locations.rb

@@ -0,0 +1,19 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetLocations < Transformator::Transformation::Step
+
+  def call
+    transformation.locations.each do |_location|
+      transformation.inner_search_request.locate("PrimoSearchRequest/Locations").first.tap do |_node|
+        _node << Ox.parse(
+          <<-xml
+            <uic:Location type="#{_location[:type]}" value="#{_location[:value]}"/>
+          xml
+        )
+      end
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/set_on_campus.rb

@@ -0,0 +1,13 @@
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetOnCampus < Transformator::Transformation::Step
+
+  def call
+    transformation.inner_search_request.locate("onCampus").first.tap do |_node|
+      _node << (transformation.on_campus.try(:to_s) == "true" ? "true" : "false")
+    end
+  end
+
+end

data/lib/skala/primo_adapter/search/request_transformation/set_start_index.rb

@@ -0,0 +1,12 @@
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetStartIndex < Transformator::Transformation::Step
+
+  def call
+    transformation.inner_search_request.locate("PrimoSearchRequest/StartIndex").first.tap do |_node|
+      _node << (source.from + 1).to_s
+    end
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/setup_inner_search_request.rb

@@ -0,0 +1,33 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetupInnerSearchRequest < Transformator::Transformation::Step
+
+  #
+  # setup inner search request that will be wrapped in a cdata element at the end
+  #
+  def call
+    # we setup this skeleton instead of dynamic element creation because order matters with primo
+    transformation.inner_search_request = Ox.parse(
+      <<-xml
+        <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>
+            </QueryTerms>
+            <StartIndex></StartIndex>
+            <BulkSize></BulkSize>
+            <DidUMeanEnabled>false</DidUMeanEnabled>
+            <HighlightingEnabled>false</HighlightingEnabled>
+            <Languages></Languages>
+            <Locations></Locations>
+          </PrimoSearchRequest>
+          <onCampus></onCampus>
+          <institution></institution>
+        </searchRequest>
+      xml
+    )
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/setup_target.rb

@@ -0,0 +1,28 @@
+require "ox"
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  SetupTarget < Transformator::Transformation::Step
+
+  def call
+    # create empty ox document
+    self.target = Ox::Document.new(version: "1.0", encoding: "UTF-8")
+
+    # populate target with soap request skeleton
+    self.target << Ox.parse(
+      <<-xml
+        <env:Envelope
+            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xmlns:impl="http://primo.kobv.de/PrimoWebServices/services/searcher"
+            xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+            xmlns:ins0="http://xml.apache.org/xml-soap">
+          <env:Body>
+            <impl:searchBrief><searchRequestStr></searchRequestStr></impl:searchBrief>
+          </env:Body>
+        </env:Envelope>
+      xml
+    )
+  end
+end

data/lib/skala/primo_adapter/search/request_transformation/toggle_bool_operator.rb

@@ -0,0 +1,13 @@
+require "transformator/transformation/step"
+require_relative "../request_transformation"
+
+class Skala::PrimoAdapter::Search::RequestTransformation::
+  ToggleBoolOperator < Transformator::Transformation::Step
+
+  def call
+    if source.queries.present? && source.queries.all? { |_query| _query.type.to_sym == :ids }
+      bool_opeator_node = transformation.inner_search_request.locate("PrimoSearchRequest/QueryTerms/BoolOpeator").first
+      bool_opeator_node.nodes.clear << "OR"
+    end
+  end
+end

data/lib/skala/primo_adapter/search/result_transformation.rb

@@ -0,0 +1,30 @@
+require "transformator/transformation"
+require_relative "../search"
+
+class Skala::PrimoAdapter::Search::ResultTransformation < Transformator::Transformation
+  require_directory "#{File.dirname(__FILE__)}/result_transformation"
+
+  attr_accessor :search_brief_response
+  attr_accessor :search_request
+
+  def call(source, options = {})
+    options[:target] ||= Skala::Adapter::Search::Result.new(source: source)
+    @search_request = options[:search_request]
+    super(source, options)
+  end
+
+  sequence [
+    ParseSearchBriefResponse,
+    SetTotalHits,
+    [ # facets
+      SetFacets,
+      FixPrimoFacetsBugs,  # requires SetFacets to be run
+      SortTermsFacetsTerms # requires all sanitations to be run
+      #SortFacetsBySearchRequest,
+      #RemoveFacetsIfEmpty,
+      #ChangeFacetCreationdateToHistogramFacet,
+      #SanitizeCreationdateFacet
+    ],
+    AddHits
+  ]
+end

data/lib/skala/primo_adapter/search/result_transformation/add_hits.rb

@@ -0,0 +1,13 @@
+require "transformator/transformation/step"
+require_relative "../result_transformation"
+require_relative "./doc_transformation"
+
+class Skala::PrimoAdapter::Search::ResultTransformation::
+  AddHits < Transformator::Transformation::Step
+
+  def call
+    target.hits = transformation.search_brief_response.xpath("//DOC").map do |_doc|
+      self.class.parent::DocTransformation.new.call(_doc)
+    end
+  end
+end

data/lib/skala/primo_adapter/search/result_transformation/doc_transformation.rb

@@ -0,0 +1,46 @@
+require "transformator/transformation"
+require_relative "../result_transformation"
+
+class Skala::PrimoAdapter::Search::ResultTransformation::
+  DocTransformation < Transformator::Transformation
+
+  require_directory "#{File.dirname(__FILE__)}/doc_transformation"
+
+  def call(source, options = {})
+    options[:target] ||= Skala::Adapter::Search::Result::Hit.new(record: {})
+    super(source, options)
+  end
+
+  sequence [
+    SetMetadata,
+    [ # fields
+      SetId,
+      SetCreator,
+      SetTitle,
+      SetYearOfPublication,
+      SetEdition,
+      SetPublisher,
+      SetSubject,
+      SetLanguage,
+      SetDescription,
+      SetSource,
+      SetIsPartOf,
+      SetIdentifier,
+      SetOpenurl,
+      SetFulltextAvailable
+    ],
+    #AddImage, # needs isbn to be present
+  ]
+
+  def read_source_values(xpath, split: nil)
+    source.xpath(xpath).map do |e|
+      if split
+        e.content.try do |c|
+          c.split(split).map(&:strip)
+        end
+      else
+        e.content
+      end
+    end.flatten.compact
+  end
+end

data/lib/skala/primo_adapter/search/result_transformation/doc_transformation/set_creator.rb

@@ -0,0 +1,10 @@
+require "transformator/transformation/step"
+require_relative "../doc_transformation"
+
+class Skala::PrimoAdapter::Search::ResultTransformation::DocTransformation::
+  SetCreator < Transformator::Transformation::Step
+
+  def call
+    target.record.creator = transformation.read_source_values(".//display/creator", split: ";")
+  end
+end

data/lib/skala/primo_adapter/search/result_transformation/doc_transformation/set_description.rb

@@ -0,0 +1,10 @@
+require "transformator/transformation/step"
+require_relative "../doc_transformation"
+
+class Skala::PrimoAdapter::Search::ResultTransformation::DocTransformation::
+  SetDescription < Transformator::Transformation::Step
+
+  def call
+    target.record.description = transformation.read_source_values(".//display/description")
+  end
+end