scotdalton/exlibris-primo

module Exlibris
  module Primo
    #
    # Search Primo using Exlibris::Primo::Search
    #
    #     search = Search.new.base_url!("http://primo.library.edu").
    #       add_query_term("Digital divide", "any", "contains")
    #     search.records #=> Array of Primo records
    #     search.facets #=> Array of Primo facets
    #     search.size #=> Total number of records in the search
    #
    # There are a several configuration setting for the search
    #
    #     search = Search.new.base_url!("http://primo.library.edu").institution!("PRIMO").
    #       enable_did_u_mean.on_campus.page_size!(20).start_index!(21).add_sort_by("stitle")
    #         add_query_term("Digital divide", "any", "contains")
    #     search.records #=> Array of Primo records
    #     search.facets #=> Array of Primo facets
    #     search.size #=> Total number of records in the search
    #
    class Search
      include Config::Attributes
      include ChainGang::Base
      include ChainGang::Record
      include ChainGang::Search
      include RequestAttributes
      include WriteAttributes

      #
      # Returns the Response from the search.
      # Not really intended for public consumption.
      #
      def search
        request.write_attributes request_attributes
        @search ||= request.call
      end

      #
      # Returns the array of Records from the search.
      #
      def records
        @records ||= search.records
      end

      #
      # Returns the array of Facets from the search.
      #
      def facets
        @facets ||= search.facets
      end

      #
      # Returns the total number of records from the search
      #
      def size
        @size ||= search.size
      end

      #
      # Returns "Did U Mean" suggestion for the search.
      #
      def did_u_mean
        @did_u_mean ||= search.did_u_mean
      end

      def full_view_request
        @full_view_request ||= Exlibris::Primo::WebService::Request::FullView.new record_request_attributes
      end
      private :full_view_request

      def search_request
        @search_request ||= Exlibris::Primo::WebService::Request::Search.new
      end
      private :search_request

      def request
        @request ||= (record_id) ? full_view_request : search_request
      end
      private :request
    end
  end
end