exlibris-primo 0.1.5 → 1.0.0

data/lib/exlibris/primo/request_attributes.rb

@@ -0,0 +1,28 @@
+module Exlibris
+  module Primo
+    # 
+    # Common request attributes based on attr_readers.
+    # 
+    module RequestAttributes
+      def request_attributes
+        @request_attributes ||= {:base_url => base_url, :institution => institution}
+      end
+      protected :request_attributes
+
+      def user_request_attributes
+        @user_request_attributes ||= request_attributes.merge :user_id => user_id
+      end
+      protected :user_request_attributes
+
+      def record_request_attributes
+        @record_request_attributes ||= request_attributes.merge :doc_id => record_id
+      end
+      protected :record_request_attributes
+
+      def user_record_request_attributes
+        @user_record_request_attributes ||= user_request_attributes.merge :doc_id => record_id
+      end
+      protected :user_record_request_attributes
+    end
+  end
+end

data/lib/exlibris/primo/review.rb

@@ -0,0 +1,46 @@
+module Exlibris
+  module Primo
+    #
+    # Primo Review
+    #
+    class Review
+      include Config::Attributes
+      include Namespaces
+      include WriteAttributes
+      include XmlUtil
+
+      def initialize *args
+        @raw_xml = args.last.delete(:raw_xml)
+        super
+      end
+
+      def user_id
+        @user_id = xml.root.at_xpath("//userId").inner_text
+      end
+
+      def record_id
+        @record_id = xml.root.at_xpath("//docId").inner_text
+      end
+
+      def rating
+        @rating = xml.root.at_xpath("//rating").inner_text
+      end
+
+      def status
+        @status = xml.root.at_xpath("//status").inner_text
+      end
+
+      def value
+        @value = xml.root.at_xpath("//value").inner_text
+      end
+
+      def user_display_name
+        @user_display_name = xml.root.at_xpath("//userDisplayName").inner_text
+      end
+
+      def allow_user_name?
+        @allow_user_name = (xml.root.at_xpath("//allowUserName").inner_text.eql? "true")
+      end
+    end
+  end
+end

data/lib/exlibris/primo/reviews.rb

@@ -0,0 +1,81 @@
+module Exlibris
+  module Primo
+    #
+    # Manipulate a Primo reviews using Exlibris::Primo::Reviews
+    # 
+    #     reviews = Reviews.new.base_url!("http://primo.library.edu").institution!("PRIMO").
+    #       user_id!("USER_ID").record_id!("aleph0123456789")
+    #     reviews.reviews #=> Array of Primo reviews
+    #
+    class Reviews
+      include Config::Attributes
+      include ChainGang::Base
+      include ChainGang::User
+      include ChainGang::Record
+      include RequestAttributes
+      include WriteAttributes
+
+      attr_reader :user_id, :record_id
+
+      def initialize *args
+        super
+      end
+
+      #
+      # Call web service to get reviews for the specified user and record
+      #
+      def reviews
+        @reviews ||= Exlibris::Primo::WebService::Request::GetReviews.new(
+          user_record_request_attributes).call.reviews
+      end
+
+      # 
+      # Call web service to get all reviews for the specified user
+      # 
+      def user_reviews
+        @user_reviews ||= Exlibris::Primo::WebService::Request::GetAllMyReviews.new(
+          user_request_attributes).call.reviews
+      end
+
+      # 
+      # Call web service to get all reviews for the specified record
+      # 
+      def record_reviews
+        @record_reviews ||= Exlibris::Primo::WebService::Request::GetReviewsForRecord.new(
+          record_request_attributes).call.reviews
+      end
+
+      # 
+      # Get the reviews of a certain rating for the specified user
+      # 
+      def rating_reviews(rating)
+        Exlibris::Primo::WebService::Request::GetReviewsByRating.new(
+          user_request_attributes.merge :rating => rating).call.reviews
+      end
+
+      #
+      # Call web service to add a review to Primo for the specified record
+      #
+      def add_review(value, rating, user_display_name, status=2, allow_user_name = true)
+        Exlibris::Primo::WebService::Request::AddReview.new(user_record_request_attributes.merge :value => value, 
+          :rating => rating, :user_display_name => user_display_name, :status =>status, :allow_user_name => allow_user_name).call
+        reset_reviews
+      end
+
+      #
+      # Call web service to remove review from Primo for the specified record
+      #
+      def remove_review
+        Exlibris::Primo::WebService::Request::RemoveReview.new(user_record_request_attributes).call
+        reset_reviews
+      end
+
+      def reset_reviews
+        @reviews = nil
+        @record_reviews = nil
+        @user_reviews = nil
+      end
+      private :reset_reviews
+    end
+  end
+end

data/lib/exlibris/primo/search.rb

@@ -0,0 +1,82 @@
+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

data/lib/exlibris/primo/source/aleph.rb

@@ -3,47 +3,93 @@ module Exlibris
     module Source
       # == Overview
       # Exlibris::Primo::Source::Aleph is an Exlibris::Primo::Holding that provides a link to Aleph
-      # and a request button based on config settings in the Primo config file.
+      # and a request link based on config settings in the Primo config file.
+      # 
+      # == Example Config
+      #   source_id:
+      #     base_url: http://aleph.library.edu
+      #     rest_url: http://aleph.library.edu:1891/rest-dlf
+      #     local_base: LOCAL01
+      #     requestable_statuses:
+      #       - available
+      #       - request_ill
+      #     sub_library_codes:
+      #       PrimoLibrary1: AlephSubLibrary1
+      #       PrimoLibrary2: AlephSubLibrary1
+      #       PrimoLibrary3: AlephSubLibrary2
+      # 
       class Aleph < Exlibris::Primo::Holding
-        @attribute_aliases = Exlibris::Primo::Holding.attribute_aliases.merge({
-          :aleph_doc_library => :original_source_id, :aleph_sub_library => :library,
-          :aleph_collection => :collection, :aleph_call_number => :call_number,
-          :aleph_doc_number => :source_record_id
-        })
-        @decode_variables = Exlibris::Primo::Holding.decode_variables.merge({
-          :aleph_sub_library_code => { :code => :library_code }
-        })
 
         # Overwrites Exlibris::Primo::Holding#new
-        def initialize(parameters={})
-          super(parameters)
-          @aleph_local_base = aleph_config["local_base"] unless aleph_config.nil?
-          # Aleph holdings page
-          @url = "#{@source_url}/F?func=item-global&doc_library=#{aleph_doc_library}&local_base=#{@aleph_local_base}&doc_number=#{aleph_doc_number}&sub_library=#{@aleph_sub_library_code}"
-          # Aleph doesn't work right so we have to push the patron to the Aleph holdings page!
-          @request_url = url if requestable?
+        def initialize(attributes={})
+          super attributes
           @source_data.merge!({
-            :aleph_doc_library => aleph_doc_library,
-            :aleph_sub_library => aleph_sub_library,
-            :aleph_sub_library_code => @aleph_sub_library_code,
-            :aleph_collection => aleph_collection,
-            :aleph_call_number => aleph_call_number,
-            :aleph_doc_number => aleph_doc_number
-          })
+            :doc_library => original_source_id,
+            :sub_library_code => sub_library_code,
+            :sub_library => sub_library,
+            :collection => collection,
+            :call_number => call_number,
+            :doc_number => source_record_id,
+            :rest_api_id => ils_api_id })
+        end
+
+        # Aleph base url from config.
+        def aleph_url
+          @aleph_url ||= source_config["base_url"] unless source_config.nil?
+        end
+
+        # Aleph base rest url from config.
+        def aleph_rest_url
+          @aleph_rest_url ||= source_config["rest_url"] unless source_config.nil?
+        end
+
+        # Aleph local base from config.
+        def local_base
+          @local_base ||= source_config["local_base"] unless source_config.nil?
+        end
+
+        # Aleph holdings screen
+        def url
+          @url ||= "#{aleph_url}/F?func=item-global&doc_library=#{original_source_id}&local_base=#{local_base}&doc_number=#{source_record_id}&sub_library=#{sub_library_code}"
+        end
+
+        # Aleph doesn't work right so we have to push the patron to the Aleph holdings page!
+        def request_url
+          @request_url = url if requestable?
+        end
+
+        # Aleph record rest url
+        def rest_url
+          @rest_url ||= "#{aleph_rest_url}/record/#{ils_api_id}"
+        end
+
+        # Aleph sub library code from config based on library code
+        def sub_library_code
+          @sub_library_code ||= sub_library_codes[library_code] unless sub_library_codes.nil?
+        end
+
+        # Aleph sub library
+        def sub_library
+          library
+        end
+
+        # Aleph sub library codes from config to map from Primo libraries to Aleph sub libraries
+        def sub_library_codes
+          @sub_library_codes ||= source_config["sub_library_codes"] unless source_config.nil?
         end
+        private :sub_library_codes
 
-        protected
-        # Maps @source config to aleph_config for convenience.
-        def aleph_config
-          return @source_config
+        # Aleph requestable statuses from config
+        def requestable_statuses
+          source_config["requestable_statuses"] unless source_config.nil?
         end
+        private :requestable_statuses
 
-        private
+        # Is this holding requestable?
         def requestable?
-          # Default to nothing is requestable
-          return false if aleph_config.nil? or aleph_config["requestable_statuses"].nil?
-          return aleph_config["requestable_statuses"].include?(@status_code) 
+          (requestable_statuses.nil?) ? false : requestable_statuses.include?(@availability_status_code)
         end
+        private :requestable?
       end
     end
   end

data/lib/exlibris/primo/tag.rb

@@ -0,0 +1,34 @@
+module Exlibris
+  module Primo
+    #
+    # Primo Tag
+    #
+    class Tag
+      include Config::Attributes
+      include Namespaces
+      include WriteAttributes
+      include XmlUtil
+
+      def initialize *args
+        @raw_xml = args.last.delete(:raw_xml)
+        super
+      end
+
+      def user_id
+        @user_id = xml.root.at_xpath("//userId").inner_text
+      end
+
+      def record_id
+        @record_id = xml.root.at_xpath("//docId").inner_text
+      end
+
+      def status
+        @status = xml.root.at_xpath("//status").inner_text
+      end
+
+      def value
+        @value = xml.root.at_xpath("//value").inner_text
+      end
+    end
+  end
+end

data/lib/exlibris/primo/tags.rb

@@ -0,0 +1,103 @@
+module Exlibris
+  module Primo
+    #
+    # Manipulate a Primo tags using Exlibris::Primo::Tags
+    # 
+    #     tags = Tags.new.base_url!("http://primo.library.edu").institution!("PRIMO").
+    #       user_id!("USER_ID").record_id!("aleph0123456789")
+    #     tag.my_tags #=> Array of Primo tags
+    #
+    class Tags
+      include Config::Attributes
+      include ChainGang::Base
+      include ChainGang::User
+      include ChainGang::Record
+      include RequestAttributes
+      include WriteAttributes
+
+      attr_reader :user_id, :record_id
+
+      def initialize *args
+        super
+      end
+
+      #
+      # Get tags for the specified user and record
+      #
+      def tags
+        @tags ||= get_tags.my_tags
+      end
+
+      #
+      # Get all tags for the specified user
+      #
+      def record_tags
+        @record_tags ||= get_tags.everybody_tags
+      end
+
+      #
+      # Get all tags for the specified user
+      #
+      def user_tags
+        @user_tags ||= 
+          Exlibris::Primo::WebService::Request::GetAllMyTags.new(user_request_attributes).call.my_tags
+      end
+
+      #
+      # Call web service to add tags to Primo for the specified record
+      #
+      def add_tags(tags)
+        tags.each do |tag|
+          add_tag tag
+        end
+      end
+
+      #
+      # Call web service to add a tag to Primo for the specified record
+      #
+      def add_tag(tag)
+        Exlibris::Primo::WebService::Request::AddTag.new(user_record_request_attributes.merge :value => tag).call
+        reset_tags
+      end
+
+      #
+      # Call web service to remove tags from Primo for the specified record
+      #
+      def remove_tags(tags)
+        tags.each do |tag|
+          remove_tag tag
+        end
+      end
+
+      #
+      # Call web service to remove tag from Primo for the specified record
+      #
+      def remove_tag(tag)
+        Exlibris::Primo::WebService::Request::RemoveTag.new(user_record_request_attributes.merge :value => tag).call
+        reset_tags
+      end
+
+      # 
+      # Remove all users tags
+      # 
+      def remove_user_tags
+        Exlibris::Primo::WebService::Request::RemoveUserTags.new(user_request_attributes).call
+        reset_tags
+      end
+
+      def get_tags
+        @get_tags ||= 
+          Exlibris::Primo::WebService::Request::GetTags.new(user_record_request_attributes).call
+      end
+      private :get_tags
+
+      def reset_tags
+        @tags = nil
+        @record_tags = nil
+        @user_tags = nil
+        @get_tags = nil
+      end
+      private :reset_tags
+    end
+  end
+end