folio_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7ff536f92f06403a2d47dd9ede2dab90d0f20d8b6ad52f9c2bd047dd7eb0650
-  data.tar.gz: 3ba0ff3343cbf79bfb383254d18f8cad2bd0c74b0251e4c76bf69b26d6d75ed4
+  metadata.gz: 38e080519e200ca466c29ce2aff8f3e1d9940a7d6f4ea0b5eb559e6a75b4b44c
+  data.tar.gz: a92ff5b5fa997ab8515cab2669914c4c283e323db39bb3c2ae2c3c1ee7a6aac4
 SHA512:
-  metadata.gz: 6e5e9f3c4b84168f41b6afaacffebcaba29bc732ea338a3834a01621dec956e568d5863789da54b4df297bda2915e9119164c0fbf3e4de1c703fc5317df0c4fb
-  data.tar.gz: c9bde04bd107cb50213b2beb8019251dd1cf2452ce842f926420576202df65ee3d54ea1a665afb441ff5d47a367fab8230de0612d88767b73bc9454a35cd9218
+  metadata.gz: 27b02c487f0179288265f738c2ba674b7670e0f1a0859152ffff5a934b10a1bfdf6a1152b235126ce6e60a71584b333d5b19c8f792fc3aa3015bdbb1d810551e
+  data.tar.gz: 43b31dccad99d032255cd3376d281e558674baf69f6bb486cc118a621f0453dba652f969e610c931a7ddb0903ce6578c8bf455d37842aceafd91a4659fe1ea69

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    folio_client (1.0.0)
+    folio_client (1.1.0)
       activesupport (>= 4.2)
       deprecation
       dry-monads

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/version.rb

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

data/lib/folio_client.rb

@@ -103,6 +103,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 +112,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 +124,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 +134,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 +147,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 +157,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.1.0
 platform: ruby
 authors:
 - Peter Mangiafico