alma 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffe7f9e2bafe164f38d89d6ca0c4b97d13eb778e9e59dbe7995aa6622fe0dfb5
-  data.tar.gz: e887790912286f3750b83f34435a2e9870a57ca56f9cb85de971c64682967964
+  metadata.gz: dc037cc120cbf6b68ed5a42c6bfbb15e319f1e6fddea7f66ca93c11be2df5397
+  data.tar.gz: 3627c391a4512585d23fbd97f126fe3ce7e05801fdc927b5dc0dd0c3351cfe2f
 SHA512:
-  metadata.gz: 2e7d1d3246dda68dc81d5ab05356d73969421053b20a830181d937239d3e6446cba8f7e6f9ff805673693b287a0b6549a1f6c54ac0b11b172bcaa85449f844d6
-  data.tar.gz: cf3ba3362fd3809039df685cffe2b4b9d3b8a9f02bbd0968fca761c8d72bf3bb41e0be542574d6acef3bfc81e246b097596db26a974acb1f8fda444cb85a8257
+  metadata.gz: 8d115b3cb161939836de8527c9365619b1399004a12e98ac69fed5a097639fff6c670ac9ddf15e234dd8dcea78665dd6400dfd08891a3b733311757c4e4b94e3
+  data.tar.gz: 30deded89f0cfaf86844ea872ad883f13a248753838998ab10b3bf46cf24c44533d346b7813bd135c20cf181343da0601207b872eb71f5708552804804a63f74

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,24 @@ 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_one(mms_id:, holding_id:, item_pid:, options: {})
+      url = "#{bibs_base_path}/#{mms_id}/holdings/#{holding_id}/items/#{item_pid}"
+      response = Net.get(url, headers:, query: options, timeout:)
+      new(response)
+    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/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.2"
+  VERSION = "0.5.1"
 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.2
+  version: 0.5.1
 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-29 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
@@ -279,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Client for Ex Libris Alma Web Services