evergreen_holdings 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '099d21142437946323589d61103ee3199d041045'
-  data.tar.gz: cfb387b243746a34c9f8233fa75699be53ff74e0
+SHA256:
+  metadata.gz: b34258835d3686af2107f5ea96b6a3a95f2eca5dc4e19630fe1cc8fecce583d1
+  data.tar.gz: f285caa0b0a3cc693ad27a9b169c540dd3bc30f1cde438967d1b44971a6d97f2
 SHA512:
-  metadata.gz: 0f300bb0e70ff7dfa6942c8ee8da1a138809fd4c2340329ed2fb78e308d42d883bf26fe0bdc3d75367bee1d1b1d6b56f962710981b30ddbd478202a96f96f538
-  data.tar.gz: 77c78a3b402989e81c1a7c942c229fbb0b62e2a52ad819c262b17ef53ca6c51126dc17c2da12eb0a3e87039a294e6f690409aa88015f6ca6e34ce0581001f7b4
+  metadata.gz: 79564fcba394887f6efaeb9046a269a47796d14efc6def71771c22bce4852c6eec148c3e9ef92b4fa408461cde87fa407d2e1fd27e9d9ad4a1c46ea3c575dd90
+  data.tar.gz: defa58f9e2349386a241c9d70bef66764d74d37bc993fd3a09202a6803300e4bf6e9b8501781862e7f8424266a243668e3086d2632054b92f3accab4cd0db7cc

data/lib/evergreen_holdings.rb

@@ -1,206 +1,232 @@
-require 'net/http'
-require 'json'
-require 'evergreen_holdings/errors'
-
-OSRF_PATH = '/osrf-gateway-v1'
-
-module EvergreenHoldings
-    class Connection
-        attr_reader :org_units
-        # Create a new object with the evergreen_domain
-        # specified, e.g. http://libcat.linnbenton.edu
-        #
-        # Usage: `conn = EvergreenHoldings::Connection.new 'http://gapines.org'`
-        def initialize evergreen_domain
-            @gateway = URI evergreen_domain+OSRF_PATH
-            unless fetch_statuses
-                raise CouldNotConnectToEvergreenError
-            end
-	    fetch_ou_tree
-        end
-
-        # Fetch holdings data from the Evergreen server
-        # Returns a Status object
-        #
-        # Usage: `stat = conn.get_holdings 23405`
-        # If you just want holdings at a specific org_unit: `my_connection.get_holdings 23405, org_unit: 5`
-        def get_holdings tcn, options = {}
-            if options.key?(:org_unit)
-                if options[:descendants]
-                    params = "format=json&input_format=json&service=open-ils.cat&method=open-ils.cat.asset.copy_tree.retrieve&param=auth_token_not_needed_for_this_call&param=#{tcn}"
-                    if @org_units[options[:org_unit]][:descendants]
-                        @org_units[options[:org_unit]][:descendants].each do |ou|
-                            params <<  + "&param=#{ou}"
-                        end
-                    end
-                else
-                    params = "format=json&input_format=json&service=open-ils.cat&method=open-ils.cat.asset.copy_tree.retrieve&param=auth_token_not_needed_for_this_call&param=#{tcn}&param=#{options[:org_unit]}"
-                end
-            else
-                params = "format=json&input_format=json&service=open-ils.cat&method=open-ils.cat.asset.copy_tree.global.retrieve&param=auth_token_not_needed_for_this_call&param=#{tcn}"
-            end
-            @gateway.query = params
-
-            res = send_query
-            return Status.new res.body, self if res
-        end
-
-	# Given an ID, returns a human-readable name
-        def location_name id
-            params = "format=json&input_format=json&service=open-ils.circ&method=open-ils.circ.copy_location.retrieve&param=#{id}"
-            @gateway.query = params
-            res = send_query
-            if res
-                data = JSON.parse(res.body)['payload'][0]
-                unless data.key? 'stacktrace'
-                    return data['__p'][4]
-                end
-            end
-            return id
-        end
-
-        def status_name id
-            return @possible_item_statuses[id]
-        end
-
-	def ou_name id
-            return @org_units[id][:name]
-        end
-
-        private
-
-	def add_ou_descendants id, parent
-            (@org_units[parent][:descendants] ||= []) << id
-	    if @org_units[parent][:parent]
-	    add_ou_descendants id, @org_units[parent][:parent]
-	    end
-	end
-
-	def take_info_from_ou_tree o
-	    @org_units[o[3]] = {}
-	    @org_units[o[3]][:name] = o[6]
-	    if o[8]
-	        @org_units[o[3]][:parent] = o[8]
-	        add_ou_descendants o[3], o[8]
-            end
-	    o[0].each do |p|
-	        take_info_from_ou_tree p['__p']
-	    end 
-	end
-
-
-        def send_query
-            begin
-                res = Net::HTTP.get_response(@gateway)
-            rescue Errno::ECONNREFUSED, Net::ReadTimeout
-                return nil
-            end
-            return res if res.is_a?(Net::HTTPSuccess)
-            return nil
-        end
-
-        def fetch_statuses
-            @possible_item_statuses = []
-            params = 'format=json&input_format=json&service=open-ils.search&method=open-ils.search.config.copy_status.retrieve.all'
-            @gateway.query = params
-            res = send_query
-            if res
-                stats = JSON.parse(res.body)['payload'][0]
-                stats.each do |stat|
-                    @possible_item_statuses[stat['__p'][1]] = stat['__p'][2]
-                end
-                return true if stats.size > 0
-            end
-            return false
-        end
-
-        def fetch_ou_tree
-            @org_units = {}
-	    params = 'format=json&input_format=json&service=open-ils.actor&method=open-ils.actor.org_tree.retrieve'
-            @gateway.query = params
-            res = send_query
-            if res
-                raw_orgs = JSON.parse(res.body)['payload'][0]['__p']
-		take_info_from_ou_tree raw_orgs
-                return true if @org_units.size > 0
-            end
-            return false
-        end
-
-    end
-
-    # Status objects represent all the holdings attached to a specific tcn
-    class Status
-        attr_reader :copies, :libraries
-        def initialize json_data, connection = nil
-            @connection = connection
-            @raw_data = JSON.parse(json_data)['payload'][0]
-            extract_copies
-            substitute_values_for_ids unless @connection.nil?
-            @available_copies = []
-            @next_copy_available = 'a date'
-        end
-
-        # Determines if any copies are available for your patrons
-        def any_copies_available?
-            @copies.each do |copy|
-                return true if 0 == copy.status
-                return true if 'Available' == copy.status
-            end
-            return false
-        end
-
-        private
-
-        # Look through @raw_data and find the copies
-        def extract_copies 
-            @copies = Array.new
-            @raw_data.each do |vol|
-                if vol['__p'][0].size > 0
-                    vol['__p'][0].each do |item|
-			i = 0
-                        unless item['__p'][35].is_a? Array
-				@copies.push Item.new barcode: item['__p'][2], call_number: vol['__p'][7], location: item['__p'][24], status: item['__p'][28], owning_lib: item['__p'][5]
-                        else
-                            begin
-				    @copies.push Item.new barcode: item['__p'][2], call_number: vol['__p'][7], due_date: item['__p'][35][0]['__p'][6], location: item['__p'][24], status: item['__p'][28], owning_lib: item['__p'][5]
-                            rescue
-				    @copies.push Item.new barcode: item['__p'][2], call_number: vol['__p'][7], location: item['__p'][24], status: item['__p'][28], owning_lib: item['__p'][5]
-                            end
-                        end
-                    end
-                end
-           end
-        end
-
-        def substitute_values_for_ids
-	    @libraries = @connection.org_units.clone
-	    @libraries.each { |key, lib| lib[:copies] = Array.new }
-            @copies.each do |copy|
-                if copy.location.is_a? Numeric
-                    copy.location = @connection.location_name copy.location
-                end
-                if copy.status.is_a? Numeric
-                    copy.status = @connection.status_name copy.status
-                end
-                if copy.owning_lib.is_a? Numeric
-                    ou_id = copy.owning_lib
-                    copy.owning_lib = @connection.ou_name copy.owning_lib
-                    @libraries[ou_id][:copies].push copy
-                end
-            end
-        end
-
-    end
-
-    # A physical copy of an item
-    class Item
-        attr_accessor :location, :status, :owning_lib
-        attr_reader :barcode, :call_number, :due_date
-        def initialize data = {}
-            data.each do |k,v|
-                instance_variable_set("@#{k}", v) unless v.nil?
-            end
-        end
-    end
-end
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'evergreen_holdings/errors'
+require 'evergreen_holdings/idl_parser'
+require 'nokogiri'
+require 'open-uri'
+
+OSRF_PATH = '/osrf-gateway-v1'
+
+module EvergreenHoldings
+  class Connection
+    attr_reader :org_units
+
+    # Create a new object with the evergreen_domain
+    # specified, e.g. http://libcat.linnbenton.edu
+    #
+    # Usage: `conn = EvergreenHoldings::Connection.new 'http://gapines.org'`
+    def initialize(evergreen_domain)
+      @evergreen_domain = evergreen_domain
+      @gateway = URI evergreen_domain + OSRF_PATH
+      @acpl_cache = {}
+      fetch_idl_order
+      raise CouldNotConnectToEvergreenError unless fetch_statuses
+
+      fetch_ou_tree
+    end
+
+    # Fetch holdings data from the Evergreen server
+    # Returns a Status object
+    #
+    # Usage: `stat = conn.get_holdings 23405`
+    # If you just want holdings at a specific org_unit: `my_connection.get_holdings 23405, org_unit: 5`
+    def get_holdings(tcn, options = {})
+      if options.key?(:org_unit)
+        if options[:descendants]
+          params = "format=json&input_format=json&service=open-ils.cat&method=open-ils.cat.asset.copy_tree.retrieve&param=auth_token_not_needed_for_this_call&param=#{tcn}"
+          @org_units[options[:org_unit]][:descendants]&.each do |ou|
+            params << + "&param=#{ou}"
+          end
+        else
+          params = "format=json&input_format=json&service=open-ils.cat&method=open-ils.cat.asset.copy_tree.retrieve&param=auth_token_not_needed_for_this_call&param=#{tcn}&param=#{options[:org_unit]}"
+        end
+      else
+        params = "format=json&input_format=json&service=open-ils.cat&method=open-ils.cat.asset.copy_tree.global.retrieve&param=auth_token_not_needed_for_this_call&param=#{tcn}"
+      end
+      @gateway.query = params
+
+      res = send_query
+      return Status.new res.body, @idl_order, self if res
+    end
+
+    # Given an ID, returns a human-readable name
+    def location_name(id)
+      @acpl_cache.fetch(id) { |id| fetch_new_acpl(id) || id }
+    end
+
+    def status_name(id)
+      @possible_item_statuses[id]
+    end
+
+    def ou_name(id)
+      @org_units[id][:name]
+    end
+
+    private
+
+    def add_ou_descendants(id, parent)
+      (@org_units[parent][:descendants] ||= []) << id
+      add_ou_descendants id, @org_units[parent][:parent] if @org_units[parent][:parent]
+    end
+
+    def take_info_from_ou_tree(o)
+      id = o[@idl_order[:aou]['id']]
+      @org_units[id] = {}
+      @org_units[id][:name] = o[@idl_order[:aou]['name']]
+      if o[@idl_order[:aou]['parent_ou']]
+        @org_units[id][:parent] = o[@idl_order[:aou]['parent_ou']]
+        add_ou_descendants id, o[@idl_order[:aou]['parent_ou']]
+      end
+      o[@idl_order[:aou]['children']].each do |p|
+        take_info_from_ou_tree p['__p']
+      end
+    end
+
+    # Given the ID of a shelving location, this method
+    # finds the name of the location, caches it, and
+    # returns it
+    def fetch_new_acpl(id)
+      params = "format=json&input_format=json&service=open-ils.circ&method=open-ils.circ.copy_location.retrieve&param=#{id}"
+      @gateway.query = params
+      res = send_query
+      if res
+        data = JSON.parse(res.body)['payload'][0]
+        name = data['__p'][@idl_order[:acpl]['name']] unless data.key? 'stacktrace'
+        @acpl_cache[id] = name
+        return name if name
+      end
+      false
+    end
+
+    def send_query
+      begin
+        res = Net::HTTP.get_response(@gateway)
+      rescue Errno::ECONNREFUSED, Net::ReadTimeout
+        return nil
+      end
+      return res if res.is_a?(Net::HTTPSuccess)
+
+      nil
+    end
+
+    def fetch_idl_order
+      begin
+        idl = Nokogiri::XML(URI.parse("#{@evergreen_domain}/reports/fm_IDL.xml").open)
+      rescue Errno::ECONNREFUSED, Net::ReadTimeout, OpenURI::HTTPError
+        raise CouldNotConnectToEvergreenError
+      end
+
+      @idl_order = IDLParser.new(idl).field_order_by_class %i[acn acp acpl aou ccs circ]
+    end
+
+    def fetch_statuses
+      @possible_item_statuses = []
+      params = 'format=json&input_format=json&service=open-ils.search&method=open-ils.search.config.copy_status.retrieve.all'
+      @gateway.query = params
+      res = send_query
+      if res
+        stats = JSON.parse(res.body)['payload'][0]
+        stats.each do |stat|
+          @possible_item_statuses[stat['__p'][@idl_order[:ccs]['id']]] = stat['__p'][@idl_order[:ccs]['name']]
+        end
+        return true unless stats.empty?
+      end
+      false
+    end
+
+    def fetch_ou_tree
+      @org_units = {}
+      params = 'format=json&input_format=json&service=open-ils.actor&method=open-ils.actor.org_tree.retrieve'
+      @gateway.query = params
+      res = send_query
+      if res
+        raw_orgs = JSON.parse(res.body)['payload'][0]['__p']
+        take_info_from_ou_tree raw_orgs
+        return true unless @org_units.empty?
+      end
+      false
+    end
+  end
+
+  # Status objects represent all the holdings attached to a specific tcn
+  class Status
+    attr_reader :copies, :libraries
+
+    def initialize(json_data, idl_order, connection = nil)
+      @idl_order = idl_order
+      @connection = connection
+      @raw_data = JSON.parse(json_data)['payload'][0]
+      extract_copies
+      substitute_values_for_ids unless @connection.nil?
+      @available_copies = []
+      @next_copy_available = 'a date'
+    end
+
+    # Determines if any copies are available for your patrons
+    def any_copies_available?
+      @copies.each do |copy|
+        return true if copy.status.zero?
+        return true if copy.status == 'Available'
+      end
+      false
+    end
+
+    private
+
+    # Look through @raw_data and find the copies
+    def extract_copies
+      @copies = []
+      @raw_data.each do |vol|
+        next if vol['__p'][0].empty?
+
+        vol['__p'][0].each do |item|
+          item_info = {
+            barcode: item['__p'][@idl_order[:acp]['barcode']],
+            call_number: vol['__p'][@idl_order[:acn]['label']],
+            location: item['__p'][@idl_order[:acp]['location']],
+            status: item['__p'][@idl_order[:acp]['status']],
+            owning_lib: item['__p'][@idl_order[:acp]['circ_lib']]
+          }
+          if item['__p'][@idl_order[:acp]['circulations']].is_a? Array
+            begin
+              item_info[:due_date] =
+                item['__p'][@idl_order[:acp]['circulations']][0]['__p'][@idl_order[:circ]['due_date']]
+            rescue StandardError
+            end
+            @copies.push Item.new item_info
+          else
+            @copies.push Item.new item_info
+          end
+        end
+      end
+    end
+
+    def substitute_values_for_ids
+      @libraries = @connection.org_units.clone
+      @libraries.each { |_key, lib| lib[:copies] = [] }
+      @copies.each do |copy|
+        copy.location = @connection.location_name copy.location if copy.location.is_a? Numeric
+        copy.status = @connection.status_name copy.status if copy.status.is_a? Numeric
+        next unless copy.owning_lib.is_a? Numeric
+
+        ou_id = copy.owning_lib
+        copy.owning_lib = @connection.ou_name copy.owning_lib
+        @libraries[ou_id][:copies].push copy
+      end
+    end
+  end
+
+  # A physical copy of an item
+  class Item
+    attr_accessor :location, :status, :owning_lib
+    attr_reader :barcode, :call_number, :due_date
+
+    def initialize(data = {})
+      data.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+end

data/lib/evergreen_holdings/errors.rb

@@ -1,2 +1,4 @@
+# frozen_string_literals: true
+
 class CouldNotConnectToEvergreenError < StandardError
 end

data/lib/evergreen_holdings/idl_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literals: true
+
+module EvergreenHoldings
+  class IDLParser
+    def initialize(idl)
+      @idl = idl
+    end
+
+    def field_order_by_class(classes)
+      classes.map do |idl_class|
+        fields = @idl.xpath("//idl:class[@id='#{idl_class}']/idl:fields/idl:field", 'idl' => 'http://opensrf.org/spec/IDL/base/v1')
+                     .map.with_index { |field, index| [field['name'], index] }
+        [idl_class, fields.to_h]
+      end.to_h
+    end
+  end
+end

data/test/evergreen_holdings_test.rb

@@ -1,21 +1,21 @@
-require 'coveralls'
-Coveralls.wear!
-require 'minitest/autorun'
-require 'evergreen_holdings'
-
-class EvergreenHoldingsTest < Minitest::Test
-    def test_connecting_to_eg_returns_a_connection_object
-        conn = EvergreenHoldings::Connection.new 'http://gapines.org'
-        assert_instance_of EvergreenHoldings::Connection, conn
-    end
-    def test_connecting_to_a_404_throws_an_error
-        assert_raises('CouldNotConnectToEvergreenError') {
-            EvergreenHoldings::Connection.new('http://httpstat.us/404')
-        }
-    end
-    def test_connecting_to_a_non_evergreen_server_throws_an_error
-        assert_raises('CouldNotConnectToEvergreenError') {
-            EvergreenHoldings::Connection.new('http://libfind.linnbenton.edu')
-        }
-    end
-end
+require 'minitest/autorun'
+require 'evergreen_holdings'
+
+class EvergreenHoldingsTest < Minitest::Test
+  def test_connecting_to_eg_returns_a_connection_object
+    conn = EvergreenHoldings::Connection.new 'https://gapines.org'
+    assert_instance_of EvergreenHoldings::Connection, conn
+  end
+
+  def test_connecting_to_a_404_throws_an_error
+    assert_raises(CouldNotConnectToEvergreenError) do
+      EvergreenHoldings::Connection.new('http://httpstat.us/404')
+    end
+  end
+
+  def test_connecting_to_a_non_evergreen_server_throws_an_error
+    assert_raises(CouldNotConnectToEvergreenError) do
+      EvergreenHoldings::Connection.new('http://libfind.linnbenton.edu')
+    end
+  end
+end

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: evergreen_holdings
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jane Sandberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,19 +53,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '2'
 description: Access holdings information from Evergreen ILS
 email: sandbej@linnbenton.edu
 executables: []
@@ -46,8 +80,9 @@ extra_rdoc_files: []
 files:
 - lib/evergreen_holdings.rb
 - lib/evergreen_holdings/errors.rb
+- lib/evergreen_holdings/idl_parser.rb
 - test/evergreen_holdings_test.rb
-homepage: 
+homepage: https://github.com/sandbergja/evergreen_holdings_gem
 licenses:
 - MIT
 metadata: {}
@@ -66,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A ruby gem for getting information about copy availability from Evergreen