alma 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8abf09ab18832b9e07c6ff3f19f55579799558aeeb94434757f4295d3e15be1
-  data.tar.gz: aa9956de6794d3a2d7e1690aab759e80cb62dd1c6a4c6525132ff57b5f82d5d9
+  metadata.gz: b6269246a05d81573e9b8037da0f8d4149a51acdf6635951efe80b96c5d30458
+  data.tar.gz: 81d9cbb84cb1c7899b1b60c4b2dc4c5fbafa6f7c8d250b0a960d0fa72b245469
 SHA512:
-  metadata.gz: 27a32ba65c33fb1d78dfc9a0cf13b504661667ed4eacf3d80136cb0ad2eeedb1ef20bed4cc5a2109c75984b6f276443aee9de21561e845f5950f6ea0690a337a
-  data.tar.gz: 28b451a986c72c7e9564f0f1933f5ba356863c14871176a0da50a83ad4de9a38da7ec9c9466aeb172408f0331228dc756a66fec6fc7a509e03e5cc9b696d30b4
+  metadata.gz: 5289a52394d811d85a5fac07224484e4df005e4f14e6854df5326d1bb096279e19991d2a7289f1e268a0d6e66fc76a3f56799460395da1efc1c1539e81fae358
+  data.tar.gz: adcb02a15f418c088f70e933979946e522ceb72417b05c428a499fc500cc793a7caca76c15a0cd02080075e881e4af68184644e17740a253ce90b9b7e7331251

data/.circleci/config.yml

@@ -17,7 +17,7 @@ workflows:
 jobs:
   build:
     docker:
-      - image: cimg/ruby:3.1-browsers
+      - image: cimg/ruby:3.3.0-browsers
         auth:
           username: $DOCKERHUB_USER
           password: $DOCKERHUB_PASSWORD

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-rails
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
   # 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-3.1.3
+ruby-3.3.0

data/README.md

@@ -250,10 +250,27 @@ item.public_note
 ```
 
 ### Logging
+
+#### Using :enable_loggable
 This gem exposes a loggable interface to responses.  Thus a response will respond to `loggable` and return a hash with state values that may be of use to log.
 
 As a bonus, when we enable this feature using the `enable_loggable` configuration, error messages will contain the loggable values and be formatted as JSON.
 
+#### Using logging configuration.
+You can configure logging via the following configurations:
+* `enable_log_requests`: (`true/false`)
+* `log_level`
+* `log_format`
+* `logger`
+
+The logger can be any logger including the Rails.logger.  This logging feature is provided through [HTTParty](https://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods#logger-instance_method).
+
+### Debugging requests
+You can configure debugging requests by setting the `enable_debug_output` configuration which is false by default. This feature is also provided through [HTTParty](https://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods#debug_output-instance_method).
+
+You can configure the `debug_output_stream` which is set to `$stderr` by default.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/alma/bib.rb

@@ -10,7 +10,7 @@ module Alma
     end
 
     def self.get_bibs(ids, args = {})
-      response = HTTParty.get(
+      response = Net.get(
         self.bibs_base_path,
         query: { mms_id: ids_from_array(ids) }.merge(args),
         headers:,

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:, timeout:)
+      response = Net.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:, query: options, timeout:)
+      response = Net.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:, query: { item_barcode: barcode }, timeout:, follow_redirects: true)
+      response = Net.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:, query: options)
+      response = Net.post(url, headers:, query: options)
       new(response)
     end
 

data/lib/alma/config.rb

@@ -8,11 +8,35 @@ module Alma
   def self.configure()
     self.configuration ||= Configuration.new
     yield(configuration) if block_given?
+    on_configure
+  end
+
+  def self.on_configure
+    _configure_logging
+    _configure_debugging
+  end
+
+  def self._configure_logging
+    if configuration.enable_log_requests
+      primo_logger = configuration.logger
+      log_level = Alma.configuration.log_level
+      log_format = Alma.configuration.log_format
+      Net.logger primo_logger, log_level, log_format
+    end
+  end
+
+  def self._configure_debugging
+    if configuration.enable_debug_output
+      Net.debug_output configuration.debug_output_stream
+    end
   end
 
   class Configuration
     attr_accessor :apikey, :region, :enable_loggable
     attr_accessor :timeout, :http_retries, :logger
+    attr_accessor :timeout, :http_retries, :logger
+    attr_accessor :log_level, :log_format, :debug_output_stream
+    attr_accessor :enable_log_requests, :enable_debug_output
 
     def initialize
       @apikey = "TEST_API_KEY"
@@ -20,7 +44,14 @@ module Alma
       @enable_loggable = false
       @timeout = 5
       @http_retries = 3
+      @log_level = :info
+      @log_format = :logstash
       @logger = Logger.new(STDOUT)
+      @enable_log_requests = false
+      @enable_debug_output = false
+      @log_level = :info
+      @log_format = :logstash
+      @debug_output_stream = $stderr
     end
   end
 end

data/lib/alma/course.rb

@@ -6,7 +6,7 @@ module Alma
     extend Forwardable
 
     def self.all_courses(args: {})
-      response = HTTParty.get("#{courses_base_path}/courses",
+      response = Net.get("#{courses_base_path}/courses",
                               query: args,
                               headers:,
                               timeout:)

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:, timeout:)
+      response = Net.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:, query: options, timeout:)
+      response = Net.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:, timeout:)
+      response = Net.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:, timeout:)
+      response = Net.get("#{configuration_base_path}/libraries/#{library_code}", query: args, headers:, timeout:)
       if response.code == 200
         AlmaRecord.new(response)
       else

data/lib/alma/loan.rb

@@ -26,7 +26,7 @@ module Alma
       args[:expand] ||= "renewable"
       # Default to upper limit
       args[:limit] ||= 100
-      response = HTTParty.get(
+      response = Net.get(
         "#{users_base_path}/#{user_id}/loans",
         query: args,
         headers:,

data/lib/alma/loan_set.rb

@@ -39,8 +39,9 @@ module Alma
     def all
       Enumerator.new do |yielder|
         offset = 0
+        limit = 100
         loop do
-          extra_args = @search_args.merge({ limit: 100, offset: })
+          extra_args = @search_args.merge({ limit:, offset: })
           r = (offset == 0) ? self : single_record_class.where_user(user_id, extra_args)
 
           unless r.empty?
@@ -48,7 +49,11 @@ module Alma
             offset += 100
           end
 
-          if r.empty? || r.count < extra_args[:limit]
+          # TODO: r.count greater than "limit" doesn't make any sense unless the ALMA User/Loan API is broken.
+          # We should remove this qualification in October once Alma fixes the bug they introduced in their
+          # September release.
+          # @see https://developers.exlibrisgroup.com/forums/topic/limit-and-offset-not-being-applied-to-retrieve-user-loans-api/
+          if r.empty? || r.count < limit || r.count > 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:, timeout:)
+      response = Net.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:, timeout:)
+      response = Net.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/net.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module Alma
+  class  Net
+    include HTTParty
+  end
+end

data/lib/alma/request.rb

@@ -11,7 +11,7 @@ module Alma
 
     def self.submit(args)
       request = new(args)
-      response = HTTParty.post(
+      response = Net.post(
         "#{bibs_base_path}/#{request.mms_id}/requests",
         query: { user_id: request.user_id },
         headers:,
@@ -140,7 +140,7 @@ module Alma
   class ItemRequest < BibRequest
     def self.submit(args)
       request = new(args)
-      response = HTTParty.post(
+      response = Net.post(
         "#{bibs_base_path}/#{request.mms_id}/holdings/#{request.holding_id}/items/#{request.item_pid}/requests",
         query: { user_id: request.user_id },
         headers:,
@@ -157,6 +157,8 @@ module Alma
     end
 
     def additional_validation!(args)
+      return unless args.fetch(:request_type) == "DIGITIZATION"
+
       args.fetch(:description) do
         raise ArgumentError.new(
           ":description option must be specified when request_type is DIGITIZATION"

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:, query: options, timeout:)
+      response = Net.get(url, headers:, query: options, timeout:)
       new(response)
     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.compact_blank, headers:, timeout:)
+      response = Net.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:, timeout:)
+      response = Net.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:, headers:, body: to_json)
+      response = Net.put("#{users_base_path}/#{id}", timeout:, headers:, body: to_json)
       get_body_from(response)
     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:)
+        response = Net.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:)
+        response = Net.post("#{users_base_path}/#{user_id}/fees/all", query: params, headers:)
         PaymentResponse.new(response)
       end
 

data/lib/alma/user_request.rb

@@ -7,7 +7,7 @@ module Alma
     def self.where_user(user_id, args = {})
       # Default to upper limit
       args[:limit] ||= 100
-      response = HTTParty.get(
+      response = Net.get(
         "#{users_base_path}/#{user_id}/requests",
         query: args,
         headers:,

data/lib/alma/version.rb

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

data/lib/alma.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "alma/version"
+require "alma/net"
 require "alma/config"
 require "alma/api_defaults"
 require "alma/error"
@@ -34,7 +35,5 @@ require "alma/course_set"
 require "alma/course"
 
 module Alma
-  require "httparty"
-
   ROOT = File.dirname __dir__
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jennifer Anton
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -246,6 +246,7 @@ files:
 - lib/alma/loan_set.rb
 - lib/alma/location.rb
 - lib/alma/location_set.rb
+- lib/alma/net.rb
 - lib/alma/payment_response.rb
 - lib/alma/renewal_response.rb
 - lib/alma/request.rb