exlibris-aleph 0.1.6 → 1.0.0

data/lib/exlibris/aleph/rest/base.rb

@@ -0,0 +1,56 @@
+module Exlibris
+  module Aleph
+    module Rest
+      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 Base
+        include HTTParty
+        include Abstract
+        include Config::Attributes
+        include XmlUtil
+        include WriteAttributes
+        self.format :xml
+        self.abstract = true
+
+        attr_writer :rest_url
+        attr_accessor :response
+        protected :response=
+
+        # 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
+
+        def raise_error_if *args, &block
+          message = (args.shift || "Error in the Aleph REST APIs.")
+          block_value = (block_given?) ? yield : false
+          raise "#{message} #{error}" if error or block_value
+        end
+        protected :raise_error_if
+      end
+    end
+  end
+end

data/lib/exlibris/aleph/tab_helper.rb

@@ -2,98 +2,62 @@ module Exlibris
   module Aleph
     require 'singleton'
     require 'yaml'
-    require 'rails'
     # ==Overview
     # Exlibris::Aleph::TabHelper assumes a mount of Aleph tab files and 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), 
+    # 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 
+    # 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.
     # To initialize Exlibris::Aleph::TabHelper call Exlibris::Aleph::TabHelper.init
     # in an initializer.
     class TabHelper
+      extend Config::Attributes
       include Singleton
       attr_reader :updated_at
       @@alephe_tabs = {
         :sub_libraries => :TabSubLibrary
       }
-      @@adm_tabs = { 
-        :patrons => :PcTabExpFieldExtended, 
-        :patron_permissions => :Tab31, 
-        :items => :TabWwwItemDesc, 
-        :item_permissions_by_item_status => :Tab15ByItemStatus, 
-        :item_permissions_by_item_process_status => :Tab15ByItemProcessStatus, 
-        :collections => :Tab40, 
+      @@adm_tabs = {
+        :patrons => :PcTabExpFieldExtended,
+        :patron_permissions => :Tab31,
+        :items => :TabWwwItemDesc,
+        :item_permissions_by_item_status => :Tab15ByItemStatus,
+        :item_permissions_by_item_process_status => :Tab15ByItemProcessStatus,
+        :collections => :Tab40,
         :pickup_locations => :Tab37 }
       @@tabs = @@alephe_tabs.keys + @@adm_tabs.keys
-      @@adms = []
-      @@tab_path = nil
-      @@yml_path = nil
-      @@log_path = nil
-      @@irrelevant_sub_libraries = ["USR00", "HOME", "BOX", "ILLDT", "NYU51", "ALEPH", "USM50", 
-            "MED", "HYL", "HIL", "LAM", "LAW", "LIT", "MUS", "WID", "EXL", "CIRC", "HILR", "HIL01", 
-            "HYL01", "HYL02", "HYL03", "HYL04", "HYL05", "HYL06", "LAM01", "LAM02", "LAM03", "LAW01", 
-            "LAW02", "LAW03", "LIT01", "LIT02", "MED01", "MED02", "MUS01", "MUS02", "WID01", "WID02", 
-            "WID03", "WID04", "WID05", "U60WD", "U60HL", "U60LA", "U70WD", "CBAB", "BCU", "MBAZU", "USM51", 
-            "ELEC5", "GDOC5", "EDUC5", "LINC5", "RRLIN", "OU511", "OR512", "OR513", "OR514", "OR515", "U61ED", 
-            "U61EL", "U61LN", "S61GD", "USM53", "ELEC7", "GDOC7", "EDUC7", "LINC7", "USM54", "ELEC4", "USM55", 
-            "CUN50", "CLEC5", "CDOC5", "CDUC5", "CINC5", "UNI50", "NARCV", "NELEC", "NRLEC", "NGDOC", "NRDOC", 
-            "NEDUC", "NHLTH", "NLINC", "NLAW", "NMUSI", "NSCI", "NUPTN"]
-      
-      # Initialize TabHelper based on path to tabs, path to store yml configs,
-      # path for log file, and the ADMs for the Aleph implementation
-      #   Exlibris::Aleph::TabHelper.init("/mnt/aleph_tab", ["ADM50", "ADM51"])
-      def self.init(tab_path, adms, refresh_time = lambda{1.day.ago})
-        @@tab_path, @@refresh_time = tab_path, refresh_time
-        @@adms = adms.collect{|adm| adm.downcase} unless adms.nil?
-        # Set yml path and log path and make directories.
-        @@yml_path, @@log_path = File.join(Rails.root, "config/aleph"), File.join(Rails.root, "log")
-        Dir.mkdir(@@yml_path) unless @@yml_path.nil? or File.directory?(@@yml_path) 
-        Dir.mkdir(File.join(@@yml_path, "alephe")) unless @@yml_path.nil? or File.directory?(File.join(@@yml_path, "alephe"))
-        @@adms.each { |adm| 
-          Dir.mkdir(File.join(@@yml_path, adm)) unless @@yml_path.nil? or File.directory?(File.join(@@yml_path, adm)) 
-        } unless @@adms.nil?
-        Dir.mkdir(@@log_path) unless @@log_path.nil? or File.directory?(@@log_path)
-        # Make readers for each class variable
-        class_variables.each do |class_variable|
-          define_method "#{class_variable}".sub('@@', '') do
-            self.class.send(:class_variable_get, "#{class_variable}")
-          end 
-        end
-      end
-      
-      # Sets class variable of irrelevant sub libraries to be ignored when building sub_libraries YAML
-      def self.set_irrelevant_sub_libraries(irrelevant_sub_libraries, replace = true)
-        @@irrelevant_sub_libraries |= irrelevant_sub_libraries if replace
-        @@irrelevant_sub_libraries = irrelevant_sub_libraries unless replace
-      end
-      
+
       # Refreshes the yml files that are used to parse the tables.
       def self.refresh_yml
+        mkdirs
         @@alephe_tabs.each do |key, klass|
-          tab = Exlibris::Aleph::Config.const_get(klass).new(:aleph_library => "ALEPHE", :aleph_mnt_path => @@tab_path).to_h
-          File.open( File.join(@@yml_path, "alephe", "#{key}.yml"), 'w' ) { |out| YAML.dump( tab, out ) } unless tab.empty?
+          tab = Exlibris::Aleph::TabParser.const_get(klass).new(:aleph_library => "ALEPHE", :aleph_mnt_path => tab_path).to_h
+          File.open( File.join(yml_path, "alephe", "#{key}.yml"), 'w' ) { |out| YAML.dump( tab, out ) } unless tab.empty?
         end
         @@adm_tabs.each do |key, klass|
-          @@adms.each do |adm|
-            tab = Exlibris::Aleph::Config.const_get(klass).new(:aleph_library => adm, :aleph_mnt_path => @@tab_path).to_h
-            File.open( File.join(@@yml_path, adm, "#{key}.yml"), 'w' ) { |out| YAML.dump( tab, out ) } unless tab.empty?
+          adms.each do |adm|
+            tab = Exlibris::Aleph::TabParser.const_get(klass).new(:aleph_library => adm, :aleph_mnt_path => tab_path).to_h
+            File.open( File.join(yml_path, adm, "#{key}.yml"), 'w' ) { |out| YAML.dump( tab, out ) } unless tab.empty?
           end
         end
       end
-      
+
+      # Make the necessary directories
+      def self.mkdirs
+        FileUtils.mkdir_p File.join(yml_path, "alephe")
+        adms.each do |adm|
+          FileUtils.mkdir_p File.join(yml_path, adm)
+        end
+      end
+
       # Private initialzize method for the singleton.
       def initialize
-        raise ArgumentError.new("No tab path was specified.") if @@tab_path.nil?
-        raise ArgumentError.new("No yml path was specified.") if @@yml_path.nil?
-        raise ArgumentError.new("No log path was specified.") if @@log_path.nil?
-        raise ArgumentError.new("No ADMs were specified.") if @@adms.nil? or @@adms.empty?
-        raise ArgumentError.new("No refresh time was specified.") if @@refresh_time.nil?
+        raise ArgumentError.new("No tab path was specified.") if self.class.tab_path.nil?
+        raise ArgumentError.new("No yml path was specified.") if self.class.yml_path.nil?
+        raise ArgumentError.new("No refresh time was specified.") if self.class.refresh_time.nil?
         self.class.refresh_yml
-        @helper_log = Logger.new(File.join(@@log_path, "tab_helper.log"))
-        @helper_log.level = Logger::WARN
         @@tabs.each { |tab|
           # Default to empty hash
           instance_variable_set("@#{tab}".to_sym, {})
@@ -111,13 +75,13 @@ module Exlibris
         sub_library = @sub_libraries[code]
         return sub_library[:text] unless sub_library.nil?
       end
-  
+
       # Returns the ADM associated with the given sub library code
       def sub_library_adm(code)
         sub_library = @sub_libraries[code]
         return sub_library[:library] unless sub_library.nil?
       end
-  
+
       # Returns an array of pickup locations based on the given params.
       # Available param keys are:
       #   :adm_library_code, :sub_library_code, :item_status_code,
@@ -131,16 +95,16 @@ module Exlibris
         item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil?
         borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil?
         availability_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
-    
+
         # Wild card item status
         item_locations, item_procesing_locations, borrower_locations = nil, nil, nil
         item_locations = sub_locations["##"] unless sub_locations.nil?
         item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil?
         borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
 
@@ -149,7 +113,7 @@ module Exlibris
         item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil?
         item_procesing_locations = item_locations["##"] unless item_locations.nil?
         borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
 
@@ -158,7 +122,7 @@ module Exlibris
         item_locations = sub_locations["##"] unless sub_locations.nil?
         item_procesing_locations = item_locations["##"] unless item_locations.nil?
         borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
 
@@ -167,7 +131,7 @@ module Exlibris
         item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil?
         item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil?
         borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
 
@@ -176,7 +140,7 @@ module Exlibris
         item_locations = sub_locations["##"] unless sub_locations.nil?
         item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil?
         borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
 
@@ -185,7 +149,7 @@ module Exlibris
         item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil?
         item_procesing_locations = item_locations["##"] unless item_locations.nil?
         borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
 
@@ -194,16 +158,16 @@ module Exlibris
         item_locations = sub_locations["##"] unless sub_locations.nil?
         item_procesing_locations = item_locations["##"] unless item_locations.nil?
         borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil?
-        locations = (borrower_locations.has_key?(params[:availability_status])) ? 
+        locations = (borrower_locations.has_key?(params[:availability_status])) ?
           borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil?
         return locations[:pickup_locations] unless locations.nil?
-    
+
         # Set the pickup location to default to the passed in sub library
-        @helper_log.warn(
+        logger.warn(
             "Warning in #{self.class}. "+
             "Pickup locations not found. "+
             "Defaulting to Aleph item sub library, #{params[:sub_library_code]}.\n"+
-            "Additional parameters:\n"+ 
+            "Additional parameters:\n"+
             "\tADM library: #{params[:adm_library_code]}\n"+
             "\tSub library: #{params[:sub_library_code]}\n"+
             "\tItem status: #{params[:item_status_code]}\n"+
@@ -213,7 +177,7 @@ module Exlibris
           )
           return [params[:sub_library_code]]
       end
-  
+
       # Returns collection text for the given params.
       # Available param keys are:
       #   :adm_library_code, :sub_library_code, :collection_code
@@ -223,7 +187,7 @@ module Exlibris
         coll = sub[params[:collection_code]] unless sub.nil?
         return coll[:text] unless coll.nil?
       end
-  
+
       # Returns web display text for the given params.
       # Available param keys are:
       #   :adm_library_code, :sub_library_code, :item_status_code, :item_process_status_code, :item_status, :item_process_status
@@ -235,32 +199,32 @@ module Exlibris
         return item[:web_text] unless item.nil?
         return permissions[:text] unless permissions.nil?
       end
-  
+
       # Returns item permissions for the given params.
       # Available param keys are:
       #   :adm_library_code, :sub_library_code, :item_status_code, :item_process_status_code
       def item_permissions(params)
         unless params[:item_process_status_code].nil?
-          adm_permissions = 
+          adm_permissions =
             item_permissions_by_item_process_status[params[:adm_library_code]]
-          sublibrary_permissions = 
+          sublibrary_permissions =
             adm_permissions[params[:sub_library_code]] unless adm_permissions.nil?
-          item_process_status_permissions = 
+          item_process_status_permissions =
             sublibrary_permissions[params[:item_process_status_code]] unless sublibrary_permissions.nil?
           return item_process_status_permissions unless item_process_status_permissions.nil?
         end
         unless params[:item_status_code].nil?
           adm_permissions = item_permissions_by_item_status[params[:adm_library_code]]
-          sublibrary_permissions = 
+          sublibrary_permissions =
             adm_permissions[params[:sub_library_code]] unless adm_permissions.nil?
-          item_status_permissions = 
+          item_status_permissions =
             sublibrary_permissions[params[:item_status_code]] unless sublibrary_permissions.nil?
           return item_status_permissions unless item_status_permissions.nil?
         end
-        @helper_log.warn(
+        logger.warn(
             "Warning in #{self.class}. "+
             "Item permissions not found. "+
-            "Additional parameters:\n"+ 
+            "Additional parameters:\n"+
             "\tADM library: #{params[:adm_library_code]}\n"+
             "\tSub library: #{params[:sub_library_code]}\n"+
             "\tItem status: #{params[:item_status_code]}\n"+
@@ -268,31 +232,52 @@ module Exlibris
           )
         return {}
       end
-  
-      private
+
       def refresh?
-        return (@updated_at.nil? or @updated_at < @@refresh_time.call)
-      end  
+        return (@updated_at.nil? or @updated_at < refresh_time.call)
+      end
+      private :refresh?
 
       def refresh
         @@alephe_tabs.each_key do |key|
-          instance_variable_set("@#{key}".to_sym, YAML.load_file(File.join(@@yml_path, "alephe", "#{key}.yml")))
+          instance_variable_set("@#{key}".to_sym, YAML.load_file(File.join(yml_path, "alephe", "#{key}.yml")))
         end
         @@adm_tabs.each_key do |key|
-          @@adms.each do |adm|
+          adms.each do |adm|
             tab = instance_variable_get("@#{key}".to_sym)
-            tab[adm] = YAML.load_file(File.join(@@yml_path, adm, "#{key}.yml"))
+            tab[adm] = YAML.load_file(File.join(yml_path, adm, "#{key}.yml"))
             instance_variable_set("@#{key}".to_sym, tab)
           end
         end
         # Delete irrelevant sub libraries from @sub_library
-        @sub_libraries.delete_if {|key,value| @@irrelevant_sub_libraries.include? key }
+        @sub_libraries.delete_if {|key,value| irrelevant_sub_libraries.include? key }
         @updated_at = Time.now()
       end
+      private :refresh?
+
+      def adms
+        @adms ||= self.class.adms
+      end
+
+      def yml_path
+        @yml_path ||= self.class.yml_path
+      end
+      private :yml_path
+
+      def refresh_time
+        @refresh_time ||= self.class.refresh_time
+      end
+      private :refresh_time
+
+      def logger
+        @logger ||= self.class.logger
+      end
+      private :logger
 
-      def raise_required_parameter_error(parameter)
-        raise "Initialization error in #{self.class}. Missing required parameter: #{parameter}."
+      def irrelevant_sub_libraries
+        @irrelevant_sub_libraries ||= self.class.irrelevant_sub_libraries
       end
+      private :irrelevant_sub_libraries
     end
   end
 end

data/lib/exlibris/aleph/{config/config_base.rb → tabs_parser/base.rb}

@@ -1,7 +1,7 @@
 module Exlibris
   module Aleph
-    module Config
-      class ConfigBase
+    module TabParser
+      class Base
         attr_accessor :library, :file_name, :pattern, :pattern_key
         attr_accessor :local_path, :local_file
         attr_accessor :config_array, :config_hash, :hash_key

data/lib/exlibris/aleph/{config → tabs_parser}/pc_tab_exp_field_extended.rb

@@ -1,7 +1,7 @@
 module Exlibris
   module Aleph
-    module Config
-      class PcTabExpFieldExtended < Exlibris::Aleph::Config::ConfigBase
+    module TabParser
+      class PcTabExpFieldExtended < Exlibris::Aleph::TabParser::Base
 
         def initialize(args)
           args[:aleph_file_name] = "pc_tab_exp_field_extended.eng"

data/lib/exlibris/aleph/{config/config_by_sub_library.rb → tabs_parser/sub_library.rb}

@@ -1,7 +1,7 @@
 module Exlibris
   module Aleph
-    module Config
-      class ConfigBySubLibrary < Exlibris::Aleph::Config::ConfigBase
+    module TabParser
+      class SubLibrary < Exlibris::Aleph::TabParser::Base
         def initialize(args)
           super(args)
           @aleph_sub_library_key = :sub_library

data/lib/exlibris/aleph/{config → tabs_parser}/tab15_by_item_process_status.rb

@@ -1,7 +1,7 @@
 module Exlibris
   module Aleph
-    module Config
-      class Tab15ByItemProcessStatus < Exlibris::Aleph::Config::ConfigBySubLibrary
+    module TabParser
+      class Tab15ByItemProcessStatus < Exlibris::Aleph::TabParser::SubLibrary
 
         def initialize(args)
           args[:aleph_file_name] = "tab15.eng"

data/lib/exlibris/aleph/{config → tabs_parser}/tab15_by_item_status.rb

@@ -1,7 +1,7 @@
 module Exlibris
   module Aleph
-    module Config
-      class Tab15ByItemStatus < Exlibris::Aleph::Config::ConfigBySubLibrary
+    module TabParser
+      class Tab15ByItemStatus < Exlibris::Aleph::TabParser::SubLibrary
 
         def initialize(args)
           args[:aleph_file_name] = "tab15.eng"