median 0.0.1

data/lib/median/primo/search.rb

@@ -0,0 +1,32 @@
+module Median::Primo
+  module Search
+
+    def search(search_request)
+      raise "the given parameter is not a valid search request" unless search_request.is_a?(SearchRequest)
+
+      # Build the client
+      wsdl_url      = "#{Median.config.primo_base_url}/PrimoWebServices/services/searcher?wsdl"
+      wsdl_filename = File.join(Rails.root, 'tmp', 'cache', 'primo.wsdl.xml')
+      unless File.exists?(wsdl_filename)
+        File.open(wsdl_filename, 'wb') { |f| open(wsdl_url) { |u| f.write(u.read) } }
+      end
+      client = Savon::Client.new do |wsdl, http|
+        wsdl.document = wsdl_filename
+      end
+
+      # Execute a search request
+      begin
+        response = client.request(:search_brief) do |soap|
+          soap.body = {:query => search_request.to_xml.root.to_s}
+        end
+      rescue Exception => e
+        raise Median::ConnectionError.new(e)
+      end
+
+      # Let's get the payload in XML and build the search result
+      payload = Nokogiri::XML(response.to_xml).content
+      SearchResult.new(payload, search_request)
+    end
+
+  end
+end

data/lib/median/primo/search_request.rb

@@ -0,0 +1,218 @@
+class Median::Primo::SearchRequest
+
+  PRECISION_OPTIONS = {contains: 'contains', exact: 'exact', begins_with: 'begins_with'}
+
+  def initialize(request_params)
+    # set search term
+    self.search_term = request_params[:q]
+    # set the index field
+    self.index_field = request_params[:if]
+    # set the precision
+    self.precision   = request_params[:po]
+    # page and page size
+    self.page        = request_params[:p]
+    self.page_size   = request_params[:ps]
+    # set facets
+    self.facets      = request_params[:f]
+    # doc id in case we do a fullview search
+    # for a single record
+    self.doc_id      = request_params[:id]
+    # search scope
+    self.scope       = request_params[:scope]
+  end
+
+  # search term
+  attr_writer :search_term
+  def search_term
+    @search_term || doc_id
+  end
+
+  # index field
+  attr_writer :index_field
+  def index_field
+    @index_field || 'any'
+  end
+
+  # precision
+  def precision=(value)
+    @precision = PRECISION_OPTIONS[value.to_sym] if value.present?
+  end
+
+  def precision
+    @precision || PRECISION_OPTIONS[:contains]
+  end
+
+  # page
+  def page=(value)
+    @page = value.to_i if value.to_i > 0
+  end
+
+  def page
+    @page || 1
+  end
+
+  # page size
+  def page_size=(value)
+    @page_size = value.to_i if value.to_i > 0
+  end
+
+  def page_size
+    @page_size || 25
+  end
+
+  # start index
+  def start_index
+    ((page - 1) * page_size) + 1
+  end
+
+  # doc id
+  def doc_id=(value)
+    @doc_id = value
+  end
+
+  def doc_id
+    @doc_id
+  end
+
+  # search scope
+  attr_writer :scope
+  def scope
+    @scope || 'default'
+  end
+
+  # Facets
+  def facets=(value)
+    @facets = []
+    value.each do |facet_name, facet_values|
+      facet_values.each do |facet_value|
+        # create the facet struct
+        facet       = OpenStruct.new
+        facet.name  = facet_name
+        facet.value = facet_value
+        @facets << facet
+      end if facet_name and facet_values and facet_values.is_a?(Array)
+    end if value and value.is_a?(Hash)
+  end
+
+  def facets
+    @facets || []
+  end
+
+  def include_facet?(name)
+    facets.each do |f|
+      return true if f.name.downcase == name.downcase
+    end if name.present?
+    false
+  end
+
+  # utils
+
+  def to_xml
+    @doc_id.present? ? fullview_request_xml : search_request_xml
+  end
+
+  #def to_s
+  #  to_xml
+  #end
+
+  private
+
+  def search_request_xml
+    Nokogiri::XML <<-xml
+      <searchRequest
+        xmlns="http://www.exlibris.com/primo/xsd/wsRequest"
+        xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">
+        #{common_request_xml}
+      </searchRequest>
+    xml
+  end
+
+  def fullview_request_xml
+    # BUG: The result of the fullview request does not include LINKS and GETIT
+    # information. So we use a normal search request with the recordid.
+
+    @precision = PRECISION_OPTIONS[:exact]
+    Nokogiri::XML <<-xml
+      <searchRequest
+        xmlns="http://www.exlibris.com/primo/xsd/wsRequest"
+        xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">
+        #{common_request_xml}
+      </searchRequest>
+    xml
+
+    #Nokogiri::XML <<-xml
+    #  <fullViewRequest
+    #    xmlns="http://www.exlibris.com/primo/xsd/wsRequest"
+    #    xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">
+    #    #{common_request_xml}
+    #    <docId>#{doc_id}</docId>
+    #  </fullViewRequest>
+    #xml
+  end
+
+  def common_request_xml
+    <<-xml
+      <PrimoSearchRequest
+        xmlns="http://www.exlibris.com/primo/xsd/search/request">
+        <QueryTerms>
+          <BoolOpeator>AND</BoolOpeator>
+          <QueryTerm>
+            <IndexField>#{index_field}</IndexField>
+            <PrecisionOperator>#{precision}</PrecisionOperator>
+            <Value>#{search_term}</Value>
+          </QueryTerm>
+          #{facets_xml}
+        </QueryTerms>
+        <StartIndex>#{start_index}</StartIndex>
+        <BulkSize>#{page_size}</BulkSize>
+        <DidUMeanEnabled>false</DidUMeanEnabled>
+        <HighlightingEnabled>false</HighlightingEnabled>
+        <Languages>
+          <Language>ger</Language>
+          <Language>eng</Language>
+        </Languages>
+        <SortByList>
+          <SortField>rank</SortField>
+        </SortByList>
+        #{scopes_xml}
+      </PrimoSearchRequest>
+      <institution>PAD</institution>
+      <group>GUEST</group>
+      <onCampus>true</onCampus>
+    xml
+  end
+
+  def facets_xml
+    facets.collect do |facet|
+      name  = facet.name
+      value = facet.value
+      # tweek creationdate facet values as the api requires intervals
+      value = "[#{value} TO #{value}]" if name == 'creationdate'
+
+      <<-xml
+        <QueryTerm>
+          <IndexField>facet_#{name}</IndexField>
+          <PrecisionOperator>exact</PrecisionOperator>
+          <Value>#{value}</Value>
+        </QueryTerm>
+      xml
+    end.join('')
+  end
+
+  def scopes_xml
+    if self.scope == 'catalog'
+      return <<-xml
+        <Locations>
+          <uic:Location type="local" value="scope:(PAD_ALEPH_MM)"/>
+        </Locations>
+      xml
+    else
+      return <<-xml
+        <Locations>
+          <uic:Location type="local" value="scope:(PAD_ALEPH_MM)"/>
+          <uic:Location type="adaptor" value="primo_central_multiple_fe" />
+        </Locations>
+      xml
+    end
+  end
+end

data/lib/median/primo/search_result.rb

@@ -0,0 +1,64 @@
+class Median::Primo::SearchResult
+  include Median::XmlSupport
+
+  field :first_hit,  :xpath => './/DOCSET', :attribute => 'FIRSTHIT',  :process => proc{ |v| v.to_i }, :default => 0
+  field :last_hit,   :xpath => './/DOCSET', :attribute => 'LASTHIT',   :process => proc{ |v| v.to_i }, :default => 0
+  field :total_hits, :xpath => './/DOCSET', :attribute => 'TOTALHITS', :process => proc{ |v| v.to_i }, :default => 0
+
+  def initialize(xml, search_request)
+    raise "XML result required. Given parameter was nil." unless xml.present?
+    raise "Request required. Given parameter was nil."    unless search_request.present?
+
+    xml = Nokogiri::XML(xml) if xml.is_a?(String)
+    xml.remove_namespaces!
+    super(xml)
+
+    @xml            = xml
+    @records        = xml.xpath("//DOCSET/DOC").collect       { |xml| Median::Primo::Record.new(xml) }
+    @facets         = xml.xpath("//FACETLIST//FACET").collect { |xml| Median::Primo::Facet.new(xml)  }
+    @search_request = search_request
+  end
+
+  attr_accessor :records, :facets, :search_request
+
+  def to_xml
+    @xml
+  end
+
+  def number_of_pages
+    (total_hits / search_request.page_size) + 1
+  end
+
+  def has_next_page?
+    search_request.page < number_of_pages
+  end
+
+  def has_previous_page?
+    search_request.page > 1
+  end
+
+  def next_page
+    has_next_page? ? search_request.page + 1 : number_of_pages
+  end
+
+  def previous_page
+    has_previous_page? ? search_request.page - 1 : 1
+  end
+
+  protected
+
+  # show only configured facets in the configured order
+  #def filter_facets(facets)
+  #  configured_facets_names = Primo.config.facets
+  #  return facets if configured_facets_names.blank?
+  #
+  #  new_facets = []
+  #  configured_facets_names.each do |facet_name|
+  #    facets.each do |facet|
+  #      new_facets << facet if facet.name == facet_name
+  #    end
+  #  end
+  #  new_facets
+  #end
+
+end

data/lib/median/version.rb

@@ -0,0 +1,3 @@
+module Median
+  VERSION = "0.0.1"
+end

data/lib/median/xml_support.rb

@@ -0,0 +1,91 @@
+module Median::XmlSupport
+
+  def initialize(xml)
+    fields = self.class.fields
+
+    fields.each do |name, options|
+      xpath           = options[:xpath]
+      wants_attribute = options[:attribute] || false
+      multiple        = options[:multiple]  || false
+      autosplit       = options[:autosplit] || false
+      process         = options[:process]   || false
+      default         = options[:default]   || false
+
+      raise "xpath option is missing" unless xpath
+      raise "boolean required for option 'multiple'" unless !!multiple == multiple
+
+      set_field_value(name, default) if default.present?
+      set_field_value(name, []) if multiple
+
+      nodes = xml.xpath(options[:xpath])
+      nodes.each do |node|
+        if wants_attribute
+          value = setup_value_for_field(node.attribute(wants_attribute).try(:value), process, default, autosplit)
+          set_field_value(name, value)
+          break;
+        else
+          if multiple
+            values = get_field_value(name) || []
+
+            value = setup_value_for_field(node.content, process, default, autosplit)
+            if value
+              if value.is_a?(Array)
+                values = values + value
+              else
+                values << value
+              end
+            end
+
+            set_field_value(name, values)
+          else
+            value = setup_value_for_field(node.content, process, default, autosplit)
+            set_field_value(name, value)
+            break;
+          end
+        end
+      end if nodes.present?
+    end if fields.present?
+  end
+
+  private
+
+  def setup_value_for_field(value, process, default, autosplit)
+    new_value = value
+    if process.present?
+      if process.is_a?(Symbol) or process.is_a?(String)
+        new_value = send(process.to_sym, new_value)
+      else
+        new_value = process.call(new_value)
+      end
+    end
+
+    if autosplit.present? and autosplit.is_a?(String)
+      temp = new_value.is_a?(Array) ? new_value : [new_value]
+      new_value = temp.map{|v| v.split(autosplit).map{|v| v.strip}}.flatten.compact
+    end
+
+    new_value
+  end
+
+  def set_field_value(name, value)
+    self.instance_variable_set("@#{name.to_s}".to_sym, value)
+  end
+
+  def get_field_value(name)
+    self.instance_variable_get("@#{name.to_s}".to_sym)
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def field(name, options = {}, &block)
+      attr_accessor name.to_sym
+      cattr_accessor :fields
+      self.fields ||= {}
+      self.fields[name.to_sym] = options
+    end
+  end
+
+end

data/lib/tasks/median_tasks.rake

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

data/median.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "median/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["René Sprotte"]
+  gem.email         = ["r.sprotte@ub.uni-paderborn.de"]
+  gem.description   = %q{Median is a simple Ruby API wrapper for the Library System Aleph and the Discovery Tool Primo.}
+  gem.summary       = %q{A simple Ruby API wrapper for the library system Aleph and the discovery tool Primo.}
+  gem.homepage      = "http://github.com/renspr/median"
+
+  gem.name          = "median"
+  gem.version       = Median::VERSION
+  gem.require_paths = ["lib"]
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.add_dependency('savon', '~> 0.9.9')
+  gem.add_dependency('nokogiri', '~> 1.5.2')
+  gem.add_dependency('activesupport', '~> 3.2.3')
+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.