exlibris-primo 0.1.5 → 1.0.0

data/lib/exlibris/primo/version.rb

@@ -1,5 +1,5 @@
 module Exlibris
   module Primo
-    VERSION = "0.1.5"
+    VERSION = "1.0.0"
   end
 end

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

@@ -0,0 +1,30 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        class Base
+          extend SavonConfig
+          include Abstract
+          include Config::Attributes
+          include Endpoint
+          include SavonClient
+          include SoapActions
+          include Wsdl
+
+          self.abstract = true
+
+          attr_writer :base_url, :institution
+
+
+          # Returns a new Exlibris::Primo::WebService::Base from the given arguments,
+          # base_url and service.
+          #   base_url: base URL for Primo Web Service
+          def initialize *args
+            super
+            @base_url = args.last.delete(:base_url)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/client/base/endpoint.rb

@@ -0,0 +1,29 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        module Endpoint
+          def self.included(klass)
+            klass.class_eval do
+              extend ClassAttributes
+            end
+          end
+
+          module ClassAttributes
+            def endpoint
+              @endpoint ||= name.demodulize.downcase
+            end
+
+            attr_writer :endpoint
+            protected :endpoint=
+          end
+
+          def endpoint
+            @endpoint ||= "#{base_url}/PrimoWebServices/services/#{self.class.endpoint}"
+          end
+          protected :endpoint
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/client/base/savon_client.rb

@@ -0,0 +1,24 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        module SavonClient
+          require 'savon'
+
+          def client
+            # 
+            # We're not using WSDL at the moment, since
+            # we don't want to make an extra HTTP call.
+            # 
+            # @client ||= Savon.client(wsdl)
+            @client ||= Savon.client do
+              wsdl.endpoint = endpoint
+              wsdl.namespace = endpoint
+            end
+          end
+          protected :client
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/client/base/savon_config.rb

@@ -0,0 +1,19 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        module SavonConfig
+          # Turn off HTTPI logging
+          HTTPI.log = false
+          Savon.configure do |config|
+            # By default, Savon logs each SOAP request and response to $stdout.
+            # Disable logging.
+            config.log = false
+            # The default log level used by Savon is :debug.
+            config.log_level = :warn
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/client/base/soap_actions.rb

@@ -0,0 +1,55 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        module SoapActions
+          def self.included(klass)
+            klass.class_eval do
+              extend ClassAttributes
+            end
+          end
+
+          module ClassAttributes
+            def soap_actions
+              @soap_actions ||= []
+            end
+
+            def add_soap_actions *actions
+              actions.each do |action|
+                soap_actions << action unless soap_actions.include? action
+              end
+            end
+            protected :add_soap_actions
+          end
+
+          def soap_actions
+            @soap_actions ||= self.class.soap_actions #.concat(client.wsdl.soap_actions)
+          end
+          protected :soap_actions
+          
+          # 
+          # Define methods for SOAP actions. SOAP actions take a single String argument, request_xml,
+          # which is set as the body of the SOAP request
+          # 
+          def method_missing(method, *args, &block)
+            if(soap_actions.include? method)
+              self.class.send(:define_method, method) { |request_xml|
+                client.request(method) { soap.body = request_xml }
+              }
+              send method, *args, &block
+            else
+              super
+            end
+          end
+
+          #
+          # Tell users that we respond to SOAP actions.
+          #
+          def respond_to?(method, include_private=false)
+            (soap_actions.include? method) ? true : super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/web_service/client/base/wsdl.rb

@@ -0,0 +1,14 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        module Wsdl
+          def wsdl
+            @wsdl ||= "#{endpoint}?wsdl"
+          end
+          protected :wsdl
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        # 
+        # 
+        # 
+        class Eshelf < Base
+          self.add_soap_actions :get_eshelf, :add_to_eshelf, :remove_from_eshelf, 
+            :add_folder_to_eshelf, :remove_folder_from_eshelf
+        end
+
+        # 
+        # 
+        # 
+        class EshelfStructure < Base
+          self.add_soap_actions :get_eshelf_structure
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        # 
+        # 
+        # 
+        class Reviews < Base
+          self.add_soap_actions :get_reviews, :get_all_my_reviews, :get_reviews_for_record, 
+            :get_reviews_by_rating, :add_review, :remove_review
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        # 
+        # 
+        # 
+        class Search < Base
+          self.endpoint = :searcher
+          self.add_soap_actions :search_brief, :get_record
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Client
+        # 
+        # 
+        # 
+        class Tags < Base
+          self.add_soap_actions :get_tags, :get_all_my_tags, :get_tags_for_record, :add_tag, :remove_tag, :remove_user_tags
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        # 
+        # Abstract base class for Primo interactions
+        # 
+        class Base
+          include Abstract
+          include BaseElements
+          include Client
+          include Call
+          include Config::Attributes
+          include Namespaces
+          include SoapAction
+          include WriteAttributes
+          include XmlUtil
+          self.abstract = true
+          self.add_base_elements :institution, :ip, :group, 
+            :on_campus, :is_logged_in, :pds_handle
+
+          DEFAULT_WRAPPER = :request
+          attr_reader :root, :wrapper
+          protected :root, :wrapper
+          attr_writer :base_url, :institution
+
+          def initialize *args
+            super
+            @root = "#{self.class.name.demodulize}Request".camelize(:lower).to_sym
+            @wrapper = DEFAULT_WRAPPER.id2name.camelize(:lower).to_sym
+          end
+
+          def to_xml &block
+            namespaces = request_namespaces
+            build_xml { |xml|
+              xml.send(wrapper) {
+                xml.cdata build_xml { |xml|
+                  xml.send(root, namespaces) {
+                    yield xml if block
+                    xml << base_elements_xml
+                  }
+                }
+              }
+            }
+          end
+        end
+
+        # 
+        # Abstract class for Primo user interactions
+        # 
+        class User < Base
+          # Add user_id to the base elements
+          self.add_base_elements :user_id
+          self.abstract = true
+        end
+
+        # 
+        # Abstract class for Primo record interactions
+        # 
+        class Record < Base
+          # Add doc_id to the base elements
+          self.add_base_elements :doc_id
+          self.abstract = true
+        end
+
+        # 
+        # Abstract class for Primo user/record interactions
+        # 
+        class UserRecord < Record
+          # Add user_id to the base elements
+          self.add_base_elements :user_id
+          self.abstract = true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module BaseElements
+          def self.included(klass)
+            klass.class_eval do
+              extend ClassAttributes
+            end
+          end
+
+          module ClassAttributes
+            def base_elements
+              @base_elements ||= self.superclass.respond_to?(:base_elements) ?
+                self.superclass.base_elements.dup : []
+            end
+
+            def add_base_elements *elements
+              elements.each do |element|
+                base_elements << element unless base_elements.include? element
+              end
+            end
+            protected :add_base_elements
+
+            def remove_base_elements *elements
+              base_elements.delete_if do |element|
+                elements.include? element
+              end
+            end
+            protected :remove_base_elements
+          end
+
+          def base_elements
+            @base_element ||= self.class.base_elements
+          end
+          protected :base_elements
+
+          def base_elements_xml
+            (base_elements.collect { |opt|
+              value = send(opt)
+              name = opt.id2name.camelize(:lower)
+              build_xml do |xml|
+                xml.send(name, value) unless value.nil?
+              end
+            }).join
+          end
+          protected :base_elements_xml
+
+          #
+          # Dynamically sets attr_accessors for base_elements
+          #
+          def method_missing(method, *args, &block)
+            if base_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 base elements accessors.
+          #
+          def respond_to?(method, include_private = false)
+            (base_elements.include?(attributize method)) ? true : super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module Call
+          # 
+          # Returns an response Exlibris::Primo::WebService::Response that corresponds
+          # to the request.
+          # 
+          def call
+            # Get the Response class that matches the Request class.
+            response_klass = "Exlibris::Primo::WebService::Response::#{self.class.name.demodulize}".constantize
+            response_klass.new(client.send(soap_action, to_xml), soap_action)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Exlibris
+  module Primo
+    module WebService
+      module Request
+        module Client
+          def self.included(klass)
+            klass.class_eval do
+              extend ClassAttributes
+            end
+          end
+
+          module ClassAttributes
+            def client
+              @client ||= (has_client?) ? name.demodulize.underscore.to_sym :
+                (self.superclass.respond_to? :client) ?
+                  self.superclass.client : nil
+            end
+
+            # Returns whether this class has a client symbol
+            def has_client?
+              @has_client ||= false
+            end
+            protected :has_client?
+
+            # Tell the class it hold the client symbol
+            def has_client
+              @has_client = true
+            end
+            protected :has_client
+          end
+
+          def client
+            @client ||= client_klass.new :base_url => base_url
+          end
+          protected :client
+
+          def client_klass
+            "Exlibris::Primo::WebService::Client::#{self.class.client.to_s.camelize}".constantize
+          end
+          private :client_klass
+        end
+      end
+    end
+  end
+end