exlibris-primo 0.0.1

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

@@ -0,0 +1,50 @@
+# == Overview
+# 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.
+module Exlibris
+  module Primo
+    module Source
+      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?
+          @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
+          })
+        end
+
+        protected
+        # Maps @source config to aleph_config for convenience.
+        def aleph_config
+          return @source_config
+        end
+
+        private
+        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) 
+        end
+      end
+    end
+  end
+end

data/lib/exlibris/primo/toc.rb

@@ -0,0 +1,19 @@
+module Exlibris
+  module Primo
+    # Class for handling Primo TOCs from links/linktotoc
+    class Toc
+      @base_attributes = [ :record_id, :linktotoc, :url, :display,  :notes ]
+      class << self; attr_reader :base_attributes end
+      def initialize(options={})
+        base_attributes = (self.class.base_attributes.nil?) ? 
+          Exlibris::Primo::Toc.base_attributes : self.class.base_attributes
+        base_attributes.each { |attribute|
+          self.class.send(:attr_reader, attribute)
+        }
+        options.each { |option, value| 
+          self.instance_variable_set(('@'+option.to_s).to_sym, value) 
+        }
+      end
+    end
+  end
+end

data/lib/exlibris/primo/version.rb

@@ -0,0 +1,5 @@
+module Exlibris
+  module Primo
+    VERSION = "0.0.1"
+  end
+end

data/lib/exlibris/primo/web_service.rb

@@ -0,0 +1,145 @@
+# Module for calling Primo Web Services
+# Please note the following:
+# * Be sure to configure the Primo Back Office with the relevant IPs to enable interaction via the Web Services
+# * This module does not parse the response but instead stores it as an Nokogiri::XML::Document for the calling classes to parse
+module Exlibris
+  module Primo
+    module WebService
+      require 'nokogiri'
+      require 'rexml/document'
+
+      # WebServiceBase is the base class for all Primo Web Services
+      # It can be extended but is not intended for use by itself
+      # To call a PrimoWebService must explicity call the method make_call.
+      class WebServiceBase
+        attr_reader :response, :error
+
+        # Call to web service is made through make_call
+        # Raise a method not found exception if the method name is not valid
+        def make_call(base_url, service, method_name, param_name, input)
+          require 'soap/rpc/driver'
+          endpoint_url = base_url + "/PrimoWebServices/services/primo/" + service
+          soap_client = SOAP::RPC::Driver.new(endpoint_url, "http://www.exlibris.com/primo/xsd/wsRequest", "")
+          soap_client.add_method(method_name, param_name) unless (respond_to? method_name)
+          @response = Nokogiri::XML(soap_client.method(method_name).call(input.to_s))
+          raise "Error making call to Primo web service.  Response from web service is #{@response}." if @response.nil?
+          @error = []
+          response.search("ERROR").each do |e|
+            @error.push(e.attributes["MESSAGE"]) unless e.nil?
+          end
+          raise "Error making call to Primo web service.  #{@error.inspect}" unless @error.empty?
+        end
+      end
+
+      # Search is the base class for Search web services
+      # It can be extended but is not intended for use by itself
+      # Two known implementations are SearchBrief and GetRecord
+      class Search < WebServiceBase
+        # Search is instantiated by calling Search.new with the following parameters
+        #   String method_name: web service method being called
+        #   String param_name: name of input parameter
+        #   String input_root: input root tag name
+        #   REXML::Element primo_search_request: REXML:Element representation of the search base on ExL Schema
+        #   REXML:Elements[] additional_input: any additional input as an array of REXML::Elements
+        #   String base_url: Primo URL
+        #   Hash option: options NOT USED 
+        def initialize(method_name, param_name, input_root, primo_search_request, additional_input, base_url, options)
+          input = REXML::Element.new(input_root)
+          input.add_namespace("http://www.exlibris.com/primo/xsd/wsRequest")
+          input.add_element(primo_search_request)
+          additional_input.each do |e|  
+            input.add_element(e)
+          end
+          make_call(base_url, "searcher", method_name, param_name, input)
+        end
+
+        private
+        def primo_search_request(search_params={}, start_index="1", bulk_size="5", did_u_mean_enabled="false", highlighting_enabled="false", get_more=nil)
+          xml = REXML::Element.new("PrimoSearchRequest")
+          xml.add_namespace("http://www.exlibris.com/primo/xsd/search/request")
+          xml.add_element(query_terms(search_params))
+          xml.add_element(tag!("StartIndex", start_index)) unless start_index.nil?
+          xml.add_element(tag!("BulkSize", bulk_size)) unless bulk_size.nil?
+          xml.add_element(tag!("DidUMeanEnabled", did_u_mean_enabled))  unless did_u_mean_enabled.nil?
+          xml.add_element(tag!("HighlightingEnabled", highlighting_enabled))  unless highlighting_enabled.nil?
+          xml.add_element(tag!("GetMore", get_more))  unless get_more.nil?
+          return xml
+        end
+
+        def query_terms(search_params, bool_operator="AND")
+          xml = REXML::Element.new("QueryTerms")
+          xml.add_element(tag!("BoolOpeator", bool_operator)) unless bool_operator.nil?
+          search_params.each do |m, v|
+            begin
+              xml.add_element(self.method("#{m}_query_term").call(v))
+            rescue Exception => e
+              raise "Invalid search params.\nSupported search params are\n\t:isbn\n\t:issn\n\t:title\n\t:author\n\t:genre\n\nException: #{e.inspect}"
+            end
+          end
+          return xml
+        end
+
+        def query_term(value=nil, index_field="any", precision_operator="contains")
+          xml = REXML::Element.new("QueryTerm")
+          xml.add_element(tag!("IndexField", index_field)) unless value.nil?
+          xml.add_element(tag!("PrecisionOperator", precision_operator)) unless value.nil?
+          xml.add_element(tag!("Value", value)) unless value.nil?
+          return xml
+        end
+
+        def isbn_query_term(isbn)
+          return query_term(isbn, "isbn", "exact")
+        end
+
+        def issn_query_term(issn)
+          return query_term(issn, "isbn", "exact")
+        end
+
+        def title_query_term(title)
+          return query_term(title, "title")
+        end
+
+        def author_query_term(author)
+          return query_term(author, "creator")
+        end
+
+        def genre_query_term(genre)
+          return query_term(genre, "any", "exact")
+        end
+
+        def tag!(name, value)
+          REXML::Element.new(name).add_text(value)
+        end
+      end
+
+      # SearchBrief does a brief result search through the Primo APIs
+      # Not all options are currently supported
+      # Supported search params are
+      #   :isbn
+      #   :issn
+      #   :title
+      #   :author
+      #   :genre
+      # e.g. {:isbn => "0143039008", :title => "Travels with My Aunt"}
+      # Invalid params will raise an exception
+      class SearchBrief < Search
+        def initialize(search_params, base_url, options={})
+          additional_input=[]
+          additional_input.push(tag!("institution", options.delete(:institution))) if options.has_key?(:institution)
+          super("searchBrief", "searchBriefRequest", "searchRequest", primo_search_request(search_params), additional_input, base_url, options)
+        end
+      end
+
+      # GetRecord get a primo record based on doc id
+      # Not all options are currently supported
+      class GetRecord < Search
+        def initialize(doc_id, base_url, options={})
+          additional_input=[]
+          additional_input.push(tag!("docId", doc_id))
+          additional_input.push(tag!("institution", options.delete(:institution))) if options.has_key?(:institution)
+          super("getRecord", "getRecordRequest", "fullViewRequest", primo_search_request, additional_input, base_url, options)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/exlibris-primo_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :exlibris-primo do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.