alma 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ea295ada19c46e1c3c157ded8cdf0997d62e744913b513a288c45f2239cdce
-  data.tar.gz: 213034074451c8d5388abdf9a6ee6385b56432adab463fa3e9a5d39b8e3dd953
+  metadata.gz: d8abf09ab18832b9e07c6ff3f19f55579799558aeeb94434757f4295d3e15be1
+  data.tar.gz: aa9956de6794d3a2d7e1690aab759e80cb62dd1c6a4c6525132ff57b5f82d5d9
 SHA512:
-  metadata.gz: 3c9d95eb4c80778b3d132ed790a7a615c775a7c650e38936cc588782efabaa1a2e393b39ef94ea90acecee05e514c625b0bace832cbbf6aa9e885ecff77c32bf
-  data.tar.gz: 55060edf008d1ee5c78a5d598daaa03666b3a423960e03fdea668aa7976e839b31385d1f4d2577f945cd4a66d1f40f6a20ca7fd19e0883fb5ced62a8c0fca420
+  metadata.gz: 27a32ba65c33fb1d78dfc9a0cf13b504661667ed4eacf3d80136cb0ad2eeedb1ef20bed4cc5a2109c75984b6f276443aee9de21561e845f5950f6ea0690a337a
+  data.tar.gz: 28b451a986c72c7e9564f0f1933f5ba356863c14871176a0da50a83ad4de9a38da7ec9c9466aeb172408f0331228dc756a66fec6fc7a509e03e5cc9b696d30b4

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby: circleci/ruby@1.2
+  ruby: circleci/ruby@2.0.0
 
 workflows:
   version: 2
@@ -17,7 +17,7 @@ workflows:
 jobs:
   build:
     docker:
-      - image: cimg/ruby:2.7.2-browsers
+      - image: cimg/ruby:3.1-browsers
         auth:
           username: $DOCKERHUB_USER
           password: $DOCKERHUB_PASSWORD
@@ -37,7 +37,7 @@ jobs:
           command: bundle exec rake
   deploy:
     docker:
-      - image: cimg/ruby:2.7.2-browsers
+      - image: cimg/ruby:3.1-browsers
 
     working_directory: ~/repo
 

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-rails
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.2
+ruby-3.1.3

data/README.md

@@ -138,6 +138,20 @@ Alma::User.get_requests({:user_id => 123456789})
 
 ```
 
+##### Get a single user without fees, requests, or loans
+
+By default, this gem fetches a user's fees, requests,
+and loans.  If you don't want these, you can pass the
+`expand` param with only the expansions you need.
+
+```ruby
+# don't request fees or loans
+user = Alma::User.find(123456789, expand: 'requests')
+
+# don't request any of the above
+user = Alma::User.find(123456789, expand: '')
+```
+
 ### Bib Records
 Wrappings for some of the API endpoints described by the [Bibliographic Records and Inventory
 ](https://developers.exlibrisgroup.com/alma/apis/bibs) section of the Ex Libris Developers Network

data/alma.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ezwadl"
   spec.add_dependency "httparty"
   spec.add_dependency "xml-simple"
   spec.add_dependency "activesupport"

data/lib/alma/bib.rb

@@ -13,8 +13,8 @@ module Alma
       response = HTTParty.get(
         self.bibs_base_path,
         query: { mms_id: ids_from_array(ids) }.merge(args),
-        headers: headers,
-        timeout: timeout
+        headers:,
+        timeout:
         )
 
       if response.code == 200

data/lib/alma/bib_holding.rb

@@ -7,7 +7,7 @@ module Alma
 
     def self.find(mms_id:, holding_id:)
       url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}"
-      response = HTTParty.get(url, headers: headers, timeout: timeout)
+      response = HTTParty.get(url, headers:, timeout:)
       new(response)
     end
 

data/lib/alma/bib_item.rb

@@ -18,18 +18,18 @@ module Alma
       holding_id = options.delete(:holding_id) || "ALL"
       options.select! { |k, _| PERMITTED_ARGS.include? k }
       url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}/items"
-      response = HTTParty.get(url, headers: headers, query: options, timeout: timeout)
-      BibItemSet.new(response, options.merge({ mms_id: mms_id, holding_id: holding_id }))
+      response = HTTParty.get(url, headers:, query: options, timeout:)
+      BibItemSet.new(response, options.merge({ mms_id:, holding_id: }))
     end
 
     def self.find_by_barcode(barcode)
-      response = HTTParty.get(items_base_path, headers: headers, query: { item_barcode: barcode }, timeout: timeout, follow_redirects: true)
+      response = HTTParty.get(items_base_path, headers:, query: { item_barcode: barcode }, timeout:, follow_redirects: true)
       new(response)
     end
 
     def self.scan(mms_id:, holding_id:, item_pid:, options: {})
       url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}/items/#{item_pid}"
-      response = HTTParty.post(url, headers: headers, query: options)
+      response = HTTParty.post(url, headers:, query: options)
       new(response)
     end
 

data/lib/alma/bib_item_set.rb

@@ -54,7 +54,7 @@ module Alma
       Enumerator.new do |yielder|
         offset = 0
         while (!@last_page_index || @last_page_index >= offset / items_per_page) do
-          r = (offset == 0) ? self : single_record_class.find(@mms_id, options = @options.merge({ limit: items_per_page, offset: offset }))
+          r = (offset == 0) ? self : single_record_class.find(@mms_id, options = @options.merge({ limit: items_per_page, offset: }))
           unless r.empty?
             r.map { |item| yielder << item }
             @last_page_index = (offset / items_per_page)

data/lib/alma/course.rb

@@ -8,8 +8,8 @@ module Alma
     def self.all_courses(args: {})
       response = HTTParty.get("#{courses_base_path}/courses",
                               query: args,
-                              headers: headers,
-                              timeout: timeout)
+                              headers:,
+                              timeout:)
       if response.code == 200
         Alma::CourseSet.new(get_body_from(response))
       else

data/lib/alma/electronic/batch_utils.rb

@@ -72,7 +72,7 @@ module Alma
         end
 
         if data.present?
-          log(params.merge(data).merge(type: type, start: start, tag: tag))
+          log(params.merge(data).merge(type:, start:, tag:))
 
           notes[id] = data unless data["error"].present?
         end
@@ -81,11 +81,11 @@ module Alma
       end
 
       self.class.new(options.merge(
-                       chain: chain,
-                       ids: ids,
-                       type: type,
-                       tag: tag,
-                       notes: notes,
+                       chain:,
+                       ids:,
+                       type:,
+                       tag:,
+                       notes:,
                        logger: @@logger,
       ))
     end
@@ -97,14 +97,14 @@ module Alma
       make_collection_ids(ids)
         .map { |id| id.merge(type: "services") }
         .inject([]) do |service_ids, params|
-        params.merge!(tag: tag)
+        params.merge!(tag:)
 
         begin
           item = Alma::Electronic.get(params)
 
           if item["errorList"]
             log params.merge(item["errorList"])
-              .merge(start: start)
+              .merge(start:)
           else
             item["electronic_service"].each { |service|
               service_id = { service_id: service["id"].to_s }
@@ -112,13 +112,13 @@ module Alma
                 .merge(service_id)
 
               log params.merge(service_id)
-                .merge(start: start)
+                .merge(start:)
             }
           end
 
         rescue StandardError => e
           log params.merge("error" => e.message)
-            .merge(start: start)
+            .merge(start:)
         end
 
         service_ids
@@ -179,10 +179,10 @@ module Alma
       end
 
       self.class.new(options.merge(
-                       chain: chain,
-                       notes: notes,
-                       type: type,
-                       tag: tag,
+                       chain:,
+                       notes:,
+                       type:,
+                       tag:,
                        logger: @@logger,
       ))
     end

data/lib/alma/electronic.rb

@@ -48,7 +48,7 @@ module Alma
       @ids ||= groups.map { |limit|
         prev_offset = offset
         offset += limit
-        { offset: prev_offset, limit: limit }
+        { offset: prev_offset, limit: }
       }
         .map { |params|  Thread.new { self.get(params) } }
         .map(&:value).map(&:data)
@@ -76,8 +76,8 @@ module Alma
       def initialize(params = {})
         @params = params
         headers = self.class::headers
-        log.info(url: url, query: params)
-        response = self.class::get(url, headers: headers, query: params, timeout: timeout)
+        log.info(url:, query: params)
+        response = self.class::get(url, headers:, query: params, timeout:)
         @data = JSON.parse(response.body) rescue {}
       end
 

data/lib/alma/fine.rb

@@ -5,7 +5,7 @@ module Alma
     extend Alma::ApiDefaults
 
     def self.where_user(user_id, args = {})
-      response = HTTParty.get("#{users_base_path}/#{user_id}/fees", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.get("#{users_base_path}/#{user_id}/fees", query: args, headers:, timeout:)
       if response.code == 200
         Alma::FineSet.new(response)
       else

data/lib/alma/item_request_options.rb

@@ -8,7 +8,7 @@ module Alma
     def self.get(mms_id, holding_id = nil, item_pid = nil, options = {})
       url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}/items/#{item_pid}/request-options"
       options.select! { |k, _|  REQUEST_OPTIONS_PERMITTED_ARGS.include? k }
-      response = HTTParty.get(url, headers: headers, query: options, timeout: timeout)
+      response = HTTParty.get(url, headers:, query: options, timeout:)
       new(response)
     end
 

data/lib/alma/library.rb

@@ -5,7 +5,7 @@ module Alma
     extend Alma::ApiDefaults
 
     def self.all(args: {})
-      response = HTTParty.get("#{configuration_base_path}/libraries", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.get("#{configuration_base_path}/libraries", query: args, headers:, timeout:)
       if response.code == 200
         LibrarySet.new(response)
       else
@@ -14,7 +14,7 @@ module Alma
     end
 
     def self.find(library_code:, args: {})
-      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}", query: args, headers:, timeout:)
       if response.code == 200
         AlmaRecord.new(response)
       else

data/lib/alma/loan.rb

@@ -18,7 +18,7 @@ module Alma
     end
 
     def renew
-      Alma::User.renew_loan({ user_id: user_id, loan_id: loan_id })
+      Alma::User.renew_loan({ user_id:, loan_id: })
     end
 
     def self.where_user(user_id, args = {})
@@ -29,8 +29,8 @@ module Alma
       response = HTTParty.get(
         "#{users_base_path}/#{user_id}/loans",
         query: args,
-        headers: headers,
-        timeout: timeout
+        headers:,
+        timeout:
         )
       Alma::LoanSet.new(response, args)
     end

data/lib/alma/loan_set.rb

@@ -40,12 +40,15 @@ module Alma
       Enumerator.new do |yielder|
         offset = 0
         loop do
-          extra_args = @search_args.merge({ limit: 100, offset: offset })
+          extra_args = @search_args.merge({ limit: 100, offset: })
           r = (offset == 0) ? self : single_record_class.where_user(user_id, extra_args)
+
           unless r.empty?
             r.map { |item| yielder << item }
             offset += 100
-          else
+          end
+
+          if r.empty? || r.count < extra_args[:limit]
             raise StopIteration
           end
         end

data/lib/alma/location.rb

@@ -5,7 +5,7 @@ module Alma
     extend Alma::ApiDefaults
 
     def self.all(library_code:, args: {})
-      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}/locations", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}/locations", query: args, headers:, timeout:)
       if response.code == 200
         LocationSet.new(response)
       else
@@ -14,7 +14,7 @@ module Alma
     end
 
     def self.find(library_code:, location_code:, args: {})
-      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}/locations/#{location_code}", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.get("#{configuration_base_path}/libraries/#{library_code}/locations/#{location_code}", query: args, headers:, timeout:)
       if response.code == 200
         AlmaRecord.new(response)
       else

data/lib/alma/request.rb

@@ -14,7 +14,7 @@ module Alma
       response = HTTParty.post(
         "#{bibs_base_path}/#{request.mms_id}/requests",
         query: { user_id: request.user_id },
-        headers: headers,
+        headers:,
         body: request.body.to_json
         )
       Alma::Response.new(response)
@@ -143,7 +143,7 @@ module Alma
       response = HTTParty.post(
         "#{bibs_base_path}/#{request.mms_id}/holdings/#{request.holding_id}/items/#{request.item_pid}/requests",
         query: { user_id: request.user_id },
-        headers: headers,
+        headers:,
         body: request.body.to_json
         )
       Alma::Response.new(response)

data/lib/alma/request_options.rb

@@ -23,7 +23,7 @@ module Alma
     def self.get(mms_id, options = {})
       url = "#{bibs_base_path}/#{mms_id}/request-options"
       options.select! { |k, _|  REQUEST_OPTIONS_PERMITTED_ARGS.include? k }
-      response = HTTParty.get(url, headers: headers, query: options, timeout: timeout)
+      response = HTTParty.get(url, headers:, query: options, timeout:)
       new(response)
     end
 

data/lib/alma/request_set.rb

@@ -34,12 +34,16 @@ module Alma
     def all
       Enumerator.new do |yielder|
         offset = 0
+        limit = 100
+
         loop do
-          r = (offset == 0) ? self : single_record_class.where_user(user_id, { limit: 100, offset: offset })
+          r = (offset == 0) ? self : single_record_class.where_user(user_id, { limit:, offset: })
           unless r.empty?
             r.map { |item| yielder << item }
             offset += 100
-          else
+          end
+
+          if r.empty? || r.count < limit
             raise StopIteration
           end
         end

data/lib/alma/user.rb

@@ -9,7 +9,7 @@ module Alma
 
     def self.find(user_id, args = {})
       args[:expand] ||= "fees,requests,loans"
-      response = HTTParty.get("#{self.users_base_path}/#{user_id}", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.get("#{self.users_base_path}/#{user_id}", query: args.compact_blank, headers:, timeout:)
 
       Alma::User.new response
     end
@@ -22,7 +22,7 @@ module Alma
     def self.authenticate(args)
       user_id = args.delete(:user_id) { raise ArgumentError }
       args.merge!({ op: "auth" })
-      response = HTTParty.post("#{users_base_path}/#{user_id}", query: args, headers: headers, timeout: timeout)
+      response = HTTParty.post("#{users_base_path}/#{user_id}", query: args, headers:, timeout:)
       response.code == 204
     end
 
@@ -80,7 +80,7 @@ module Alma
 
     # Persist the user in it's current state back to Alma
     def save!
-      response = HTTParty.put("#{users_base_path}/#{id}", timeout: timeout, headers: headers, body: to_json)
+      response = HTTParty.put("#{users_base_path}/#{id}", timeout:, headers:, body: to_json)
       get_body_from(response)
     end
 
@@ -97,7 +97,7 @@ module Alma
     end
 
     def renew_loan(loan_id)
-      response = self.class.send_loan_renewal_request({ user_id: id, loan_id: loan_id })
+      response = self.class.send_loan_renewal_request({ user_id: id, loan_id: })
       if response.renewed?
         @recheck_loans ||= true
       end
@@ -154,7 +154,7 @@ module Alma
         loan_id = args.delete(:loan_id) { raise ArgumentError }
         user_id = args.delete(:user_id) { raise ArgumentError }
         params = { op: "renew" }
-        response = HTTParty.post("#{users_base_path}/#{user_id}/loans/#{loan_id}", query: params, headers: headers)
+        response = HTTParty.post("#{users_base_path}/#{user_id}/loans/#{loan_id}", query: params, headers:)
         RenewalResponse.new(response)
       end
 
@@ -175,7 +175,7 @@ module Alma
       def self.send_payment(args)
         user_id = args.delete(:user_id) { raise ArgumentError }
         params = { op: "pay", amount: "ALL", method: "ONLINE" }
-        response = HTTParty.post("#{users_base_path}/#{user_id}/fees/all", query: params, headers: headers)
+        response = HTTParty.post("#{users_base_path}/#{user_id}/fees/all", query: params, headers:)
         PaymentResponse.new(response)
       end
 

data/lib/alma/user_request.rb

@@ -10,8 +10,8 @@ module Alma
       response = HTTParty.get(
         "#{users_base_path}/#{user_id}/requests",
         query: args,
-        headers: headers,
-        timeout: timeout
+        headers:,
+        timeout:
       )
       Alma::RequestSet.new(response)
     end

data/lib/alma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alma
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jennifer Anton
@@ -10,22 +10,8 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ezwadl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -293,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Client for Ex Libris Alma Web Services