berkeley_library-alma 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab227f94abea9d1275bceb4ed361cf2d75021ae7d9cf49283e6139404e9e327f
-  data.tar.gz: 2370efa8b2bc2b72e6e506cf38271a74ee8a785cbebf7f42b19e49bf84b4a6da
+  metadata.gz: 1c1b867f1a283eccf4a721f805d351af4292624f787ae44477330f39d0579905
+  data.tar.gz: 15abfaec0a2bf5cfab9b096b2636cfebe320a458661b251b095dfdae71c94b4f
 SHA512:
-  metadata.gz: 438181aea5e19163ca57dd7c5c9086fd6d324ac5bb6e05fd33917cc70327ca5682e1f07a9ffc5280104207562f6fdda4443070bdc8ba3163b519ba70f96f2558
-  data.tar.gz: dc9cafbf0b36ee0ac1875d8cc89b0b4a10bdccd37456f67004e0c3abb0097fde7b8d5da31c946ab1eb4f300dd1f14ad5dcaf550ca697aef0de4f8b6d81521bdb
+  metadata.gz: db9c0732aa97dd07877d0b12277d6841c18d501fd4239899fc50b97d6ae15d3467c88a502dae0ac0aaa42504fdc06ab67e5841ceff265819f5b3262acd136ab8
+  data.tar.gz: aa6053bdfd55d475256a8acd05ae0fd23990d8b0269d6ddf7a385ab96ef1d53c011773a96c28a71ee73b25794bebe10abd589e5f95bb5353923139e489df3361

data/.idea/alma.iml

@@ -45,7 +45,6 @@
     <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.4.1, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2022.0105, RVM: ruby-2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mini_portile2 (v2.8.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.15.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="netrc (v0.11.0, RVM: ruby-2.7.5) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.5, RVM: ruby-2.7.5) [gem]" level="application" />

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 0.0.7 (6 May 2022)
+
+- `SRU#get_marc_records` now accepts a `max_records` parameter corresponding to the SRU
+  `maximumRecords` query parameter for page size.
+- `BerkeleyLibrary::Alma::Config.default!` now returns the `Config` singleton rather than
+  an arbitrary config value.
+
 # 0.0.6 (5 May 2022)
 
 - `SRU#get_marc_records` now supports paginated results. 

data/lib/berkeley_library/alma/config.rb

@@ -118,10 +118,12 @@ module BerkeleyLibrary
 
         def default!
           BerkeleyLibrary::Alma.configure do
-            config.alma_sru_host = ENV.fetch('LIT_ALMA_SRU_HOST', 'berkeley.alma.exlibrisgroup.com')
-            config.alma_institution_code = ENV.fetch('LIT_ALMA_INSTITUTION_CODE', '01UCS_BER')
-            config.alma_primo_host = ENV.fetch('LIT_ALMA_PRIMO_HOST', 'search.library.berkeley.edu')
-            config.alma_permalink_key = ENV.fetch('LIT_ALMA_PERMALINK_KEY', 'iqob43')
+            config.tap do |c|
+              c.alma_sru_host = ENV.fetch('LIT_ALMA_SRU_HOST', 'berkeley.alma.exlibrisgroup.com')
+              c.alma_institution_code = ENV.fetch('LIT_ALMA_INSTITUTION_CODE', '01UCS_BER')
+              c.alma_primo_host = ENV.fetch('LIT_ALMA_PRIMO_HOST', 'search.library.berkeley.edu')
+              c.alma_permalink_key = ENV.fetch('LIT_ALMA_PERMALINK_KEY', 'iqob43')
+            end
           end
         end
 

data/lib/berkeley_library/alma/module_info.rb

@@ -7,7 +7,7 @@ module BerkeleyLibrary
       SUMMARY = 'Alma/Primo utilities for the UC Berkeley Library'.freeze
       DESCRIPTION = 'A gem providing Alma/Primo-related utility code for the UC Berkeley Library'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.0.6'.freeze
+      VERSION = '0.0.7'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/alma'.freeze
     end
   end

data/lib/berkeley_library/alma/record_id.rb

@@ -48,7 +48,7 @@ module BerkeleyLibrary
       #
       # @return [URI] the MARC URI
       def marc_uri
-        SRU.sru_query_uri(sru_query_value)
+        SRU.sru_query_uri(sru_query_value, max_records: 1)
       end
 
       # Makes an SRU query for this record and returns a MARC record, or nil if the
@@ -60,7 +60,7 @@ module BerkeleyLibrary
       # @return [MARC::Record, nil] the MARC record
       # rubocop:disable Naming/AccessorMethodName
       def get_marc_record
-        records = SRU.marc_records_for(sru_query_value)
+        records = SRU.marc_records_for(sru_query_value, max_records: 1)
         logger.warn("GET #{marc_uri} did not return a MARC record") unless (marc_record = records.first)
         marc_record
       end
@@ -72,7 +72,7 @@ module BerkeleyLibrary
       # @return [String, nil] the SRU query response body, or nil in the event of an error.
       # rubocop:disable Naming/AccessorMethodName
       def get_marc_xml
-        SRU.make_sru_query(sru_query_value)
+        SRU.make_sru_query(sru_query_value, max_records: 1)
       end
       # rubocop:enable Naming/AccessorMethodName
 

data/lib/berkeley_library/alma/sru/sru.rb

@@ -11,6 +11,8 @@ module BerkeleyLibrary
       include BerkeleyLibrary::Logging
       include Constants
 
+      DEFAULT_MAX_RECORDS = 10
+
       class << self
         include SRU
       end
@@ -20,37 +22,40 @@ module BerkeleyLibrary
       #
       # @param record_ids [Array<String, RecordId>] the record IDs to look up
       # @param freeze [Boolean] whether to freeze the records
+      # @param max_records the number of records per SRU page.
       # @return [Enumerator::Lazy<MARC::Record>] the records
-      def get_marc_records(*record_ids, freeze: false)
+      def get_marc_records(*record_ids, max_records: DEFAULT_MAX_RECORDS, freeze: false)
         # noinspection RubyMismatchedReturnType
         parsed_ids = record_ids.filter_map { |id| RecordId.parse(id) }
         raise ArgumentError, "Argument #{record_ids.inspect} contain no valid record IDs" if parsed_ids.empty?
 
         sru_query_value = parsed_ids.map(&:sru_query_value).join(' or ')
-        SRU.marc_records_for(sru_query_value, freeze: freeze)
+        SRU.marc_records_for(sru_query_value, max_records: max_records, freeze: freeze)
       end
 
       # Returns a URI for retrieving records for the specified query
       # via SRU. Requires {Config#alma_sru_base_uri} to be set.
       #
       # @return [URI] the MARC URI
-      def sru_query_uri(sru_query_value)
+      # @param max_records the number of records per SRU page
+      def sru_query_uri(sru_query_value, max_records: DEFAULT_MAX_RECORDS)
         query_string = URI.encode_www_form(
           'version' => '1.2',
           'operation' => 'searchRetrieve',
           'query' => sru_query_value
         )
 
-        Util::URIs.append(Config.alma_sru_base_uri, '?', query_string)
+        Util::URIs.append(Config.alma_sru_base_uri, '?', query_string, '&', "maximumRecords=#{max_records}")
       end
 
       # Makes an SRU query for the specified query value and returns the query response
       # as a string.
       #
       # @param query_value [String] the value of the SRU query parameter
+      # @param max_records the number of records per SRU page
       # @return [String, nil] the SRU query response body, or nil in the event of an error.
-      def make_sru_query(query_value)
-        uri = sru_query_uri(query_value)
+      def make_sru_query(query_value, max_records: DEFAULT_MAX_RECORDS)
+        uri = sru_query_uri(query_value, max_records: max_records)
         do_get(uri)
       end
 
@@ -59,10 +64,11 @@ module BerkeleyLibrary
       #
       # @param query_value [String] the value of the SRU query parameter
       # @param freeze [Boolean] whether to freeze the records
+      # @param max_records the number of records per SRU page
       # @return [Enumerator::Lazy<MARC::Record>] the records
-      def marc_records_for(query_value, freeze: false)
+      def marc_records_for(query_value, max_records: DEFAULT_MAX_RECORDS, freeze: false)
         Enumerator.new do |y|
-          uri = sru_query_uri(query_value)
+          uri = sru_query_uri(query_value, max_records: max_records)
           perform_query(uri, freeze: freeze) { |rec| y << rec }
         end.lazy
       end

data/spec/spec_helper.rb

@@ -31,17 +31,17 @@ require 'berkeley_library/alma'
 # ------------------------------------------------------------
 # Utility methods
 
-def sru_url_for(index, value)
-  "https://berkeley.alma.exlibrisgroup.com/view/sru/01UCS_BER?version=1.2&operation=searchRetrieve&query=#{index}%3D#{value}"
+def sru_url_for(index, value, max_records: 1)
+  "https://berkeley.alma.exlibrisgroup.com/view/sru/01UCS_BER?version=1.2&operation=searchRetrieve&query=#{index}%3D#{value}&maximumRecords=#{max_records}"
 end
 
 def sru_data_path_for(record_id)
   "spec/data/#{record_id}-sru.xml"
 end
 
-def stub_sru_request(index, value)
-  sru_url_ = sru_url_for(index, value)
+def stub_sru_request(index, value, max_records: 1)
+  sru_url = sru_url_for(index, value, max_records: max_records)
   marc_xml_path = sru_data_path_for(value)
 
-  stub_request(:get, sru_url_).to_return(status: 200, body: File.read(marc_xml_path))
+  stub_request(:get, sru_url).to_return(status: 200, body: File.read(marc_xml_path))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-alma
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging