Merge pull request #248 from sul-dlss/delete-and-extensions#244

Author: mjgiarlo

.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

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:

lib/folio_client.rb

@@ -103,6 +103,7 @@ def configure(url:, login_params:, tenant_id: nil, user_agent: nil, timeout: nil
   # @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 @@ def get(path, params = {})
 
     UnexpectedResponse.call(response) unless response.success?
 
+    yield response if block_given?
+
     JSON.parse(response.body) if response.body.present?
   end
 
@@ -121,6 +124,7 @@ def get(path, params = {})
   # @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 @@ def post(path, body = nil, content_type: 'application/json')
 
     UnexpectedResponse.call(response) unless response.success?
 
+    yield response if block_given?
+
     JSON.parse(response.body) if response.body.present?
   end
 
@@ -141,6 +147,7 @@ def post(path, body = nil, content_type: 'application/json')
   # @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 @@ def put(path, body = nil, content_type: 'application/json', **exception_args)
 
     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
 

spec/folio_client_spec.rb

@@ -72,7 +72,7 @@
 
   describe '#get' do
     let(:path) { 'some_path' }
-    let(:response) { { some: 'response' }.to_json }
+    let(:response) { { 'some' => 'response' } }
 
     before do
       stub_request(:get, "#{url}/#{path}?id=5")
@@ -82,11 +82,20 @@
     it 'calls the API with a get' do
       expect(client.get(path, { id: 5 })).to eq(response)
     end
+
+    context 'when block is passed' do
+      it 'calls the API with a get and yields the response' do
+        client.get(path, { id: 5 }) do |resp|
+          expect(resp).to be_a(Faraday::Response)
+          expect(resp.body).to eq(response.to_json)
+        end
+      end
+    end
   end
 
   describe '#post' do
     let(:path) { 'some_path' }
-    let(:response) { { some: 'response' }.to_json }
+    let(:response) { { 'some' => 'response' } }
 
     context 'with a JSON body' do
       before do
@@ -104,6 +113,15 @@
       it 'calls the API with a post' do
         expect(client.post(path, { id: 5 })).to eq(response)
       end
+
+      context 'when block is passed' do
+        it 'calls the API with a post and yields the response' do
+          client.post(path, { id: 5 }) do |resp|
+            expect(resp).to be_a(Faraday::Response)
+            expect(resp.body).to eq(response.to_json)
+          end
+        end
+      end
     end
 
     context 'with no body' do
@@ -144,7 +162,7 @@
 
   describe '#put' do
     let(:path) { 'some_path' }
-    let(:response) { { some: 'response' }.to_json }
+    let(:response) { { 'some' => 'response' } }
 
     context 'with a JSON body' do
       before do
@@ -162,6 +180,15 @@
       it 'calls the API with a put' do
         expect(client.put(path, { id: 5 })).to eq(response)
       end
+
+      context 'when block is passed' do
+        it 'calls the API with a put and yields the response' do
+          client.put(path, { id: 5 }) do |resp|
+            expect(resp).to be_a(Faraday::Response)
+            expect(resp.body).to eq(response.to_json)
+          end
+        end
+      end
     end
 
     context 'with no body' do
@@ -200,6 +227,29 @@
     end
   end
 
+  describe '#delete' do
+    let(:path) { 'some_path' }
+    let(:response) { { 'some' => 'response' } }
+
+    before do
+      stub_request(:delete, "#{url}/#{path}")
+        .to_return(status: 200, body: response.to_json)
+    end
+
+    it 'calls the API with a delete' do
+      expect(client.delete(path)).to eq(response)
+    end
+
+    context 'when block is passed' do
+      it 'calls the API with a delete and yields the response' do
+        client.delete(path) do |resp|
+          expect(resp).to be_a(Faraday::Response)
+          expect(resp.body).to eq(response.to_json)
+        end
+      end
+    end
+  end
+
   describe '.fetch_hrid' do
     let(:barcode) { '123456' }
 

spec/spec_helper.rb

@@ -29,14 +29,100 @@
 # require only the support files necessary.
 Dir[Pathname(Dir.pwd).join('spec/support/**/*.rb')].each { |f| require f }
 
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
   config.example_status_persistence_file_path = '.rspec_status'
 
-  # Disable RSpec exposing methods globally on `Module` and `main`
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
   config.disable_monkey_patching!
 
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
   end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end