exlibris-aleph 0.1.6 → 1.0.0

data/README.rdoc

@@ -1,67 +0,0 @@
-= Exlibris::Aleph
-{<img src="https://api.travis-ci.org/scotdalton/exlibris-aleph.png?branch=master" alt="Build Status" />}[https://secure.travis-ci.org/scotdalton/exlibris-aleph]
-{<img src="https://gemnasium.com/scotdalton/exlibris-aleph.png" alt="Dependency Status" />}[https://gemnasium.com/scotdalton/exlibris-aleph]
-{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/scotdalton/exlibris-aleph]
-
-Exlibris::Aleph offers a set of libraries for interacting with the ExLibris Aleph ILS.
-
-== Exlibris::Aleph::Patron
-Exlibris::Aleph::Patron provides access to the Aleph Patron REST API.
-
-=== Example of Exlibris::Aleph::Patron in action
-  patron = 
-    Exlibris::Aleph::Patron.
-      new("S0M31D", "http://aleph.institution.edu")
-  patron.address # Returns HTTParty::Response of patron's address
-  patron.loans # Returns HTTParty::Response patron's loan
-  patron.renew_loans # Renews all loans
-  patron.renew_loans("ADM5000000001") # Renews loan of item 00000001 in ADM50
-  patron.place_hold("ADM50", "SBLIB", "00000001", "00000001", {:pickup_location => "SBLIB"}) # Places hold on the specified item for pickup at SBLIB
-  
-== Exlibris::Aleph::Record
-Provides access to the Aleph Record REST API.
-
-=== Example of Exlibris::Aleph::Record in action
-  record = 
-    Exlibris::Aleph::Record.
-      new("ADM50", "00000001", "http://aleph.institution.edu")
-  record.bib # Returns HTTParty::Response of record's bibliographic metadata
-  record.holdings # Returns HTTParty::Response of record's holdings
-  record.items # Returns HTTParty::Response of record's items
-
-== Exlibris::Aleph::TabHelper
-Exlibris::Aleph::TabHelper provides a way to access the various tab settings for patrons, patron_permissions, items, item_permission (both by item status and by item processing status), collections and pickup locations. It also provides convenience methods for common tasks like getting the pickup location for a given combination of item status, item process status and borrower status or getting an item's web text.  Support a 
-
-=== Example of Exlibris::Aleph::TabHelper in action
-  # Placed this in an initializer.
-  Exlibris::Aleph::TabHelper.init("/mnt/aleph_tab", ["ADM50", "ADM50"])
-
-  # Rake task to refresh the config yml files
-  rake exlibris:aleph:refresh
-
-  # Get an instance of TabHelper
-  helper = Exlibris::Aleph::TabHelper.instance
-  helper.sub_library_text("SBLIB") # Returns display text for the give code
-  helper.sub_library_adm("SBLIB") # Returns ADM for the give code
-  helper.item_pickup_locations({:adm_library_code => "ADM50", :sub_library_code => "SBLIB", :bor_status => "51"}) # Returns the pickup locations for the given parameters
-  helper.collection_text({:adm_library_code => "ADM50", :sub_library_code => "SBLIB", :collection_code => "MAIN"}) # Returns the collection display text for the give parameters
-  helper.item_web_text({:adm_library_code => "ADM50", :item_process_status => "Item Process Status"}) # Returns the web text for the given parameters
-  helper.item_web_text({:adm_library_code => "ADM50", :sub_library_code => "SBLIB", :item_process_status_code => "DP"}) # Returns the web text for the given parameters
-
-=== Configure irrelevant sub libraries in TabHelper
-To configure the gem to ignore sub libraries pulled from Aleph but not relevant to working with permissions call the following setter with an array of sub library Aleph codes.
-
-  # Place this in an initializer.
-  Exlibris::Aleph::TabHelper.set_irrelevant_sub_libraries(["IRRLIB1", "IRRLIB1"], replace = false)
-
-If the boolean variable _replace_ is true the array passed in will replace the defaults. If it is false the array passed in will merge with the results. The default value is true.
-  
-== Exlibris::Aleph::BorAuth
-Exlibris::Aleph::BorAuth provides access to the BorAuth Aleph XService.
-
-=== Example of Exlibris::Aleph::BorAuth in action
-  bor_auth = 
-    Exlibris::Aleph::BorAuth.
-      new("http://aleph.institution.edu", "ADM50", "SBLIB", "N", "S0M31D", "V3R1F1C@T10N")
-  permissions = bor_auth.permissions # Return a Hash of permissions based on the Exlibris::Aleph::BorAuth instance
-

data/lib/exlibris/aleph/bor_auth.rb

@@ -1,45 +0,0 @@
-module Exlibris
-  module Aleph
-    require 'open-uri'
-    require 'nokogiri'
-    # ==Overview
-    # Exlibris::Aleph::BorAuth provides access to the BorAuth Aleph XService.
-    class BorAuth
-      attr_reader :response, :error, :session_id
-      
-      # Creates an instance of Exlibris::Aleph::BorAuth based on the input parameters.
-      def initialize(aleph_url, library, sub_library, translate, bor_id, bor_verification)
-        url = "#{aleph_url}/X?"
-        url += "op=bor-auth&library=#{library}&"
-        url += "sub_library=#{sub_library}&translate=#{translate}&"
-        url += "bor_id=#{bor_id}&verification=#{bor_verification}&"
-        @response = Nokogiri.XML(open(url))
-        @session_id = @response.at("//session-id").inner_text unless @response.at("//session-id").nil?
-        @error = @response.at("//error").inner_text unless @response.at("//error").nil?
-      end
-      
-      # Returns a Hash of permissions for the Aleph sub library passed into the constructor.
-      def permissions
-        rv = {}
-        return rv unless @response and self.error.nil?
-        rv[:home_sub_library] = @response.at("z303-home-library").inner_text unless @response.at("z303-home-library").nil?
-        rv[:bor_status] = @response.at("z305-bor-status").inner_text unless @response.at("z305-bor-status").nil?
-        rv[:bor_type] = @response.at("z305-bor-type").inner_text unless @response.at("z305-bor-type").nil?
-        rv[:loan_permission] = @response.at("z305-loan-permission").inner_text unless @response.at("z305-loan-permission").nil?
-        rv[:photo_permission] = @response.at("z305-photo-permission").inner_text unless @response.at("z305-photo-permission").nil?
-        rv[:over_permission] = @response.at("z305-over-permission").inner_text unless @response.at("z305-over-permission").nil?
-        rv[:multi_hold] = @response.at("z305-multi-hold").inner_text unless @response.at("z305-multi-hold").nil?
-        rv[:loan_check] = @response.at("z305-loan-check").inner_text unless @response.at("z305-loan-check").nil?
-        rv[:hold_permission] = @response.at("z305-hold-permission").inner_text unless @response.at("z305-hold-permission").nil?
-        rv[:renew_permission] = @response.at("z305-renew-permission").inner_text unless @response.at("z305-renew-permission").nil?
-        rv[:rr_permission] = @response.at("z305-rr-permission").inner_text unless @response.at("z305-rr-permission").nil?
-        rv[:ignore_late_return] = @response.at("z305-ignore-late-return").inner_text unless @response.at("z305-ignore-late-return").nil?
-        rv[:hold_on_shelf] = @response.at("z305-hold-on-shelf").inner_text unless @response.at("z305-hold-on-shelf").nil?
-        rv[:end_block_date] = @response.at("z305-end-block-date").inner_text unless @response.at("z305-end-block-date").nil?
-        rv[:booking_permission] = @response.at("z305-booking-permission").inner_text unless @response.at("z305-booking-permission").nil?
-        rv[:booking_ignore_hours] = @response.at("z305-booking-ignore-hours").inner_text unless @response.at("z305-booking-ignore-hours").nil?
-        return rv
-      end
-    end
-  end
-end

data/lib/exlibris/aleph/railtie.rb

@@ -1,9 +0,0 @@
-module Exlibris
-  module Aleph
-    class Railtie < Rails::Railtie
-      rake_tasks do
-        load "tasks/exlibris-aleph_tasks.rake"
-      end
-    end
-  end
-end

data/lib/exlibris/aleph/rest.rb

@@ -1,43 +0,0 @@
-module Exlibris
-  module Aleph
-    require 'httparty'
-    # ==Overview
-    # Base implementation for Aleph REST APIs.  
-    # Not intended for use on its own, but should
-    # instead be extended by implementing classes.
-    class Rest
-      include HTTParty
-      format :xml
-      # Create and instance of Exlibris::Aleph::Rest for the given Aleph URI.
-      def initialize(uri)
-        @uri = uri
-        raise "Initialization error in #{self.class}. Missing URI." if @uri.nil?
-      end
-
-      # Returns the error associated with the request.
-      # Returns nil if no error.
-      def error
-        return nil if reply_code == "0000" 
-        return "#{reply_text}"
-      end
-
-      # Returns the reply code associate with the request.
-      def reply_code
-        return "No response." if @response.nil?
-        return (not @response.first.last.kind_of?(Hash) or @response.first.last["reply_code"].nil?) ? "Unexpected response hash." : @response.first.last["reply_code"] if @response.instance_of?(Hash)
-        response_match = @response.match(/\<reply-code\>(.+)\<\/reply-code\>/) if @response.instance_of?(String)
-        return (response_match.nil?) ? "Unexpected response string." : response_match[1] if @response.instance_of?(String)
-        return "Unexpected response type."
-      end
-
-      # Returns the reply text associate with the request.
-      def reply_text
-        return "No response." if @response.nil?
-        return (not @response.first.last.kind_of?(Hash) or @response.first.last["reply_text"].nil?) ? "Unexpected response hash." : @response.first.last["reply_text"] if @response.instance_of?(Hash)
-        response_match = @response.match(/\<reply-text\>(.+)\<\/reply-text\>/) if @response.instance_of?(String)
-        return (response_match.nil?) ? "Unexpected response string." : response_match[1] if @response.instance_of?(String)
-        return "Unexpected response type."
-      end
-    end
-  end
-end

data/lib/exlibris/aleph/tasks.rb

@@ -1,25 +0,0 @@
-module Exlibris
-  module Aleph
-    class Tasks
-      class << self
-        def rake_tasks(&blk)
-          @rake_tasks ||= []
-          @rake_tasks << blk if blk
-          @rake_tasks
-        end
-      end
-      rake_tasks do
-        load "tasks/exlibris-aleph_tasks.rake"
-      end
-      require 'rake'
-      extend Rake::DSL
-      self.rake_tasks.each { |block| self.instance_exec(app, &block) }
-      # Also load tasks from all superclasses
-      klass = self.superclass
-      while klass.respond_to?(:rake_tasks)
-        klass.rake_tasks.each { |t| self.instance_exec(app, &t) }
-        klass = klass.superclass
-      end
-    end
-  end
-end

data/test/dummy/README.rdoc

@@ -1,261 +0,0 @@
-== 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.