folio_client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7ff536f92f06403a2d47dd9ede2dab90d0f20d8b6ad52f9c2bd047dd7eb0650
-  data.tar.gz: 3ba0ff3343cbf79bfb383254d18f8cad2bd0c74b0251e4c76bf69b26d6d75ed4
+  metadata.gz: e374f053307ee51d65ddfb9ee59796f1544686be6921ee52dbc08a21d570c5f1
+  data.tar.gz: 36fe9cb668791aff197898b78ddf51da0cec7924b5933c33a35a752b8873951b
 SHA512:
-  metadata.gz: 6e5e9f3c4b84168f41b6afaacffebcaba29bc732ea338a3834a01621dec956e568d5863789da54b4df297bda2915e9119164c0fbf3e4de1c703fc5317df0c4fb
-  data.tar.gz: c9bde04bd107cb50213b2beb8019251dd1cf2452ce842f926420576202df65ee3d54ea1a665afb441ff5d47a367fab8230de0612d88767b73bc9454a35cd9218
+  metadata.gz: a45652bb503b98551e65a306512e24410a629056a2f41a9239e3e75c7ef88f4f565e3045e7007d96639e110e0d0a171dbf2a6ca0c311b2ecb0fafb511e3e3568
+  data.tar.gz: cf5cdfd3864e239674dee3654b714d2a7e1b3c2b56b7d7664ec08ae72b92b753f1813228634c80eb0d4330cd32b30dcb01de2a8428f7191f21d0943a4398b4d2

data/.rubocop.yml

@@ -22,6 +22,8 @@ RSpec/MultipleExpectations:
   Max: 3
 RSpec/ExampleLength:
   Max: 15
+RSpec/NestedGroups:
+  Enabled: false
 
 RSpec/BeEq: # new in 2.9.0
   Enabled: true
@@ -53,15 +55,15 @@ RSpecRails/HaveHttpStatus: # new in 2.12
   Enabled: true
 RSpecRails/InferredSpecType: # new in 2.14
   Enabled: true
-Capybara/MatchStyle: # new in 2.17
+Capybara/RSpec/MatchStyle: # new in 2.17
   Enabled: true
-Capybara/NegationMatcher: # new in 2.14
+Capybara/RSpec/NegationMatcher: # new in 2.14
   Enabled: true
 Capybara/SpecificActions: # new in 2.14
   Enabled: true
 Capybara/SpecificFinders: # new in 2.13
   Enabled: true
-Capybara/SpecificMatcher: # new in 2.12
+Capybara/RSpec/SpecificMatcher: # new in 2.12
   Enabled: true
 RSpec/DuplicatedMetadata: # new in 2.16
   Enabled: true
@@ -292,8 +294,6 @@ Style/SwapValues: # new in 1.1
   Enabled: true
 Style/YAMLFileRead: # new in 1.53
   Enabled: true
-Capybara/ClickLinkOrButtonStyle: # new in 2.19
-  Enabled: true
 Capybara/RedundantWithinFind: # new in 2.20
   Enabled: true
 Capybara/RSpec/HaveSelector: # new in 2.19
@@ -441,7 +441,7 @@ RSpec/IncludeExamples: # new in 3.6
   Enabled: true
 Capybara/FindAllFirst: # new in 2.22
   Enabled: true
-Capybara/NegationMatcherAfterVisit: # new in 2.22
+Capybara/RSpec/NegationMatcherAfterVisit: # new in 2.22
   Enabled: true
 Gemspec/AttributeAssignment: # new in 1.77
   Enabled: true
@@ -491,3 +491,6 @@ Style/SelectByRange: # new in 1.85
   Enabled: true
 Style/TallyMethod: # new in 1.85
   Enabled: true
+Capybara/AmbiguousClick: # new in 2.21
+  Enabled: true
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (1.0.0)
+    folio_client (1.2.0)
       activesupport (>= 4.2)
       deprecation
       dry-monads
@@ -31,13 +31,12 @@ GEM
       public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.1.1)
-    concurrent-ruby (1.3.6)
+    bigdecimal (4.1.2)
+    concurrent-ruby (1.3.7)
     connection_pool (3.0.2)
     crack (1.0.1)
       bigdecimal
       rexml
-    date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
@@ -51,66 +50,68 @@ GEM
       concurrent-ruby (~> 1.0)
       logger
       zeitwerk (~> 2.6)
-    dry-monads (1.9.0)
+    dry-monads (1.10.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    erb (6.0.2)
-    faraday (2.14.1)
+    erb (6.0.4)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
     faraday-cookie_jar (0.0.8)
       faraday (>= 0.8.0)
       http-cookie (>= 1.0.0)
-    faraday-net_http (3.4.2)
+    faraday-net_http (3.4.4)
       net-http (~> 0.5)
     hashdiff (1.2.1)
-    http-cookie (1.1.4)
+    http-cookie (1.1.6)
       domain_name (~> 0.5)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
     io-console (0.8.2)
-    irb (1.17.0)
+    irb (1.18.0)
       pp (>= 0.6.0)
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.3)
+    json (2.20.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
     marc (1.4.0)
       nokogiri (~> 1.0)
       rexml
-    minitest (6.0.3)
+    minitest (6.0.6)
       drb (~> 2.0)
       prism (~> 1.5)
     net-http (0.9.1)
       uri (>= 0.11.1)
-    nokogiri (1.19.2-arm64-darwin)
+    nokogiri (1.19.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.2-x86_64-linux-gnu)
+    nokogiri (1.19.4-x86_64-linux-gnu)
       racc (~> 1.4)
     ostruct (0.6.3)
-    parallel (2.0.1)
+    parallel (2.1.0)
     parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
-    pp (0.6.3)
+    pp (0.6.4)
       prettyprint
     prettyprint (0.2.0)
     prism (1.9.0)
-    psych (5.3.1)
-      date
-      stringio
     public_suffix (7.0.5)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.1)
-    rdoc (7.2.0)
+    rake (13.4.2)
+    rbs (4.0.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
       erb
-      psych (>= 4.0.0)
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
       tsort
     regexp_parser (2.12.0)
     reline (0.6.3)
@@ -129,7 +130,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.1)
+    rubocop (1.88.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -143,9 +144,9 @@ GEM
     rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
-    rubocop-capybara (2.22.1)
+    rubocop-capybara (3.0.0)
       lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
+      rubocop (~> 1.81)
     rubocop-factory_bot (2.28.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
@@ -153,9 +154,10 @@ GEM
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     rubocop-rspec_rails (2.32.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
@@ -168,7 +170,6 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    stringio (3.2.0)
     tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -180,7 +181,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.5)
+    zeitwerk (2.8.2)
 
 PLATFORMS
   arm64-darwin-23
@@ -203,4 +204,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-  4.0.10
+  4.0.15

data/README.md

@@ -18,7 +18,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-The gem should be configured first, and then you can either call API endpoints directly using GET or POST, or more commonly, use the helper methods provided, as described in the section below.
+The gem should be configured first, and then you can either call API endpoints directly using GET, POST, PUT, and DELETE. It may be more convenient to use the helper methods provided, as described in the section below, if your use case is already covered by what's been implemented already.
 
 ```ruby
 require 'folio_client'
@@ -34,6 +34,12 @@ client = FolioClient.configure(
 response = client.get('/organizations/organizations', {query_string_param: 'abcdef'})
 
 response = client.post('/some/post/endpoint', params_hash.to_json)
+
+# If you want direct access to the response object for your own handling, you can also
+# pass a block to the get, post, put, and delete methods:
+response = client.post('/some/post/endpoint', params_hash.to_json) do |resp|
+  # Do something with resp.status, resp.headers, resp.body, etc.
+end
 ```
 
 Note that the settings will live in the consumer of this gem and would typically be used like this:

data/lib/folio_client/records_editor.rb

@@ -30,9 +30,11 @@ class FolioClient
       record_json['relatedRecordVersion'] = version
       record_json['_actionType'] = 'edit'
 
+      original_record_json = record_json.deep_dup
+
       yield record_json
 
-      client.put("/records-editor/records/#{parsed_record_id}", record_json)
+      client.put("/records-editor/records/#{parsed_record_id}", record_json) unless record_json == original_record_json
     end
 
     private

data/lib/folio_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FolioClient
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/folio_client.rb

@@ -3,6 +3,7 @@
 require 'http/cookie' # Workaround for https://github.com/sparklemotion/http-cookie/issues/62
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/deep_dup'
 require 'deprecation'
 require 'faraday'
 require 'faraday-cookie_jar'
@@ -103,6 +104,7 @@ class FolioClient # rubocop:disable Metrics/ClassLength
   # @param path [String] API path relative to configured +url+
   # @param params [Hash] query parameters
   # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @yield [Faraday::Response] optional block to receive the raw +Faraday::Response+ object
   # @raise [FolioClient::Error] when Folio responds with an unexpected status
   def get(path, params = {})
     response = with_token_refresh_when_unauthorized do
@@ -111,6 +113,8 @@ class FolioClient # rubocop:disable Metrics/ClassLength
 
     UnexpectedResponse.call(response) unless response.success?
 
+    yield response if block_given?
+
     JSON.parse(response.body) if response.body.present?
   end
 
@@ -121,6 +125,7 @@ class FolioClient # rubocop:disable Metrics/ClassLength
   # @param body [Hash, String, nil] request payload
   # @param content_type [String] MIME type of request body
   # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @yield [Faraday::Response] optional block to receive the raw +Faraday::Response+ object
   # @raise [FolioClient::Error] when Folio responds with an unexpected status
   def post(path, body = nil, content_type: 'application/json')
     req_body = content_type == 'application/json' ? body&.to_json : body
@@ -130,6 +135,8 @@ class FolioClient # rubocop:disable Metrics/ClassLength
 
     UnexpectedResponse.call(response) unless response.success?
 
+    yield response if block_given?
+
     JSON.parse(response.body) if response.body.present?
   end
 
@@ -141,6 +148,7 @@ class FolioClient # rubocop:disable Metrics/ClassLength
   # @param content_type [String] MIME type of request body
   # @param exception_args [Hash] supplemental context forwarded to +UnexpectedResponse+
   # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @yield [Faraday::Response] optional block to receive the raw +Faraday::Response+ object
   # @raise [FolioClient::Error] when Folio responds with an unexpected status
   def put(path, body = nil, content_type: 'application/json', **exception_args)
     req_body = content_type == 'application/json' ? body&.to_json : body
@@ -150,6 +158,27 @@ class FolioClient # rubocop:disable Metrics/ClassLength
 
     UnexpectedResponse.call(response, **exception_args) unless response.success?
 
+    yield response if block_given?
+
+    JSON.parse(response.body) if response.body.present?
+  end
+
+  # Send an authenticated DELETE request
+  # @note None of the current FolioClient services use this method, but it's provided
+  #   primarily to accommodate work in folio-tasks
+  # @param path [String] API path relative to configured +url+
+  # @return [Hash, Array, nil] parsed JSON body, or +nil+ for empty body
+  # @yield [Faraday::Response] optional block to receive the raw +Faraday::Response+ object
+  # @raise [FolioClient::Error] when Folio responds with an unexpected status
+  def delete(path)
+    response = with_token_refresh_when_unauthorized do
+      connection.delete(path)
+    end
+
+    UnexpectedResponse.call(response) unless response.success?
+
+    yield response if block_given?
+
     JSON.parse(response.body) if response.body.present?
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: folio_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -309,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Interface for interacting with the Folio ILS API.
 test_files: []