evergreen_holdings 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5511d7fa326b339080aac864cb223a99d5adc935
+  data.tar.gz: e841a0ae4593c453599c45dc018d4c38e14dacad
+SHA512:
+  metadata.gz: b4545c01d0127a6be4eca3f1e2173431bc58d87a4dda771c18232af34922f76540ea8b589b49e28fa5380da9152440b00653754eb37350b03a66a321879e1f94
+  data.tar.gz: 3c5e4b56a6ca22c7503db5709c6d82e9ea0f78075a7e3e0a93703bd2fe5e5956ab47cdf676253b710a942dd873912293e55c4f8fca3e45aa301bafc873b349c7

data/lib/evergreen_holdings/errors.rb

@@ -0,0 +1,2 @@
+class CouldNotConnectToEvergreenError < StandardError
+end

data/lib/evergreen_holdings.rb

@@ -0,0 +1,136 @@
+require 'net/http'
+require 'json'
+require 'evergreen_holdings/errors'
+
+OSRF_PATH = '/osrf-gateway-v1'
+
+module EvergreenHoldings
+    class Connection
+        # 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
+        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)
+                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]}"
+            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 = Net::HTTP.get_response(@gateway)
+            return Status.new res.body, self if res.is_a?(Net::HTTPSuccess)
+        end
+
+        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 = Net::HTTP.get_response(@gateway)
+            if res.is_a? Net::HTTPSuccess
+                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
+
+        private
+
+        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 = Net::HTTP.get_response(@gateway)
+            if res.is_a?(Net::HTTPSuccess)
+                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
+
+    end
+
+    class Status
+        attr_reader :copies
+        def initialize json_data, connection = nil
+            @connection = connection
+            @raw_data = JSON.parse(json_data)['payload'][0]
+            @copies = 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
+        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|
+                        unless item['__p'][35].nil?
+                            copies.push Item.new barcode: item['__p'][2], call_number: vol['__p'][7], location: item['__p'][24], status: item['__p'][28]
+                        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]
+                            rescue
+                                copies.push Item.new barcode: item['__p'][2], call_number: vol['__p'][7], location: item['__p'][24], status: item['__p'][28]
+                            end
+                        end
+                    end
+                end
+           end
+           return copies
+        end
+
+        def substitute_values_for_ids
+            @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
+            end
+        end
+
+    end
+
+    class Item
+        attr_accessor :location, :status
+        attr_reader :barcode
+        def initialize data = {}
+            data.each do |k,v|
+                instance_variable_set("@#{k}", v) unless v.nil?
+            end
+        end
+    end
+end

data/test/evergreen_holdings_test.rb

@@ -0,0 +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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: evergreen_holdings
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jane Sandberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Access holdings information from Evergreen ILS
+email: sandbej@linnbenton.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/evergreen_holdings.rb
+- lib/evergreen_holdings/errors.rb
+- test/evergreen_holdings_test.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem for getting information about copy availability from Evergreen
+  ILS
+test_files:
+- test/evergreen_holdings_test.rb