flexirest 1.9.11 → 1.9.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294f2e24981dde7af931d0bedd578e4eb260538f947f716739a3d4037cd2a6b8
-  data.tar.gz: 5ab2e8babd0e312eea734257e6fdeeb1ccd1701143ec4a953a0ea90b102ed3f4
+  metadata.gz: 3320d5c425f13498cf558c361209bed466565f0b173ebcc2bd3f8e6205fd37dd
+  data.tar.gz: dd621beea4b50068147c70fbf079b7753d32e8a625e080a5803f4904cb757eea
 SHA512:
-  metadata.gz: ce1125b17e4a41d11bc3cb3be10888d89604beaff46839fe3dbbce1fb663b4d69bbc58f3a8dab9463b2367daae9e182751393c8adc2ed5148e90138ce88ab167
-  data.tar.gz: c4f992e9c9e70b2faabf3384512f6973b6e3f5fb8ebca7515faae48670ec61b630a2c951d908efbf95170506885f19a9e87454ce2bc0caac64a0a6f01a4f9770
+  metadata.gz: 8811975e7c20d9b6a69fcb9c11e68883c2950927d2444723872cd302c10cec7802fa732ed50fb7b088a56535beb23d9180d4e717d7884bd7a1901c5fe05295f1
+  data.tar.gz: 9a8db810620535a335d2d94822ba277b5a61fe0963ce19479d53c57c001567afd30c96fb40720d231142ec7fd2dbcc01c8423f0c83d44408f6ea4c231cf6591f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.9.12
+
+Bugfix:
+
+- Prevent crash on JSONAPI invalid error response (thanks to François Ferrandis for the PR).
+
 ## 1.9.11
 
 Bugfix:

data/lib/flexirest/json_api_proxy.rb

@@ -196,8 +196,10 @@ module Flexirest
         # Save resource class for building lazy association loaders
         save_resource_class(object)
 
-        # try to return errors if their is no data
-        return body.fetch("errors", {}) if body['data'].nil?
+        # According to the spec:
+        # "The members data and errors MUST NOT coexist in the same document."
+        # Thus, if the "errors" key is present, we can return it and ignore the "data" key.
+        return body['errors'] if body.include?('errors')
 
         # return early if data is an empty array
         return [] if body['data'] == []

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.9.11"
+  VERSION = "1.9.12"
 end

data/spec/lib/json_api_spec.rb

@@ -312,28 +312,46 @@ describe 'JSON API' do
       expect(subject.find_all).to be_an_instance_of(Flexirest::ResultIterator)
     end
 
-    context 'when response has "errors" key and no "data" key' do
-      let(:headers) { { "Content-Type" => "application/vnd.api+json" } }
-      let(:response_body) do
-        {
-          errors: [
-            {
-              title: "Record not found",
-              detail: "The record identified by 123456 could not be found",
-              code: "not_found",
-              status: "404",
-            }
-          ]
-        }
-      end
+    describe 'error responses' do
+      subject(:make_request) { JsonAPIExample::Article.real_find(123) }
 
-      it 'should raise a Flexirest error' do
+      before do
+        headers = { "Content-Type" => "application/vnd.api+json" }
         expect_any_instance_of(Flexirest::Connection).
           to receive(:get).with("/articles/123", an_instance_of(Hash)).
           and_return(::FaradayResponseMock.new(OpenStruct.new(body: response_body.to_json, response_headers: headers, status: 404)))
+      end
+
+      context 'when no "data" key is present alongside the "errors" key' do
+        let(:response_body) do
+          {
+            errors: [
+              { detail: "The record identified by 123456 could not be found", }
+            ]
+          }
+        end
+
+        it 'should raise the relevant Flexirest error' do
+          expect(-> { make_request }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
+            expect(exception.result.first.detail).to eq("The record identified by 123456 could not be found")
+          end
+        end
+      end
+
+      context 'when a "data" key is present alongside the "errors" key (although this is forbidden by the spec)' do
+        let(:response_body) do
+          {
+            errors: [
+              { detail: "The record identified by 123456 could not be found", }
+            ],
+            data: {}
+          }
+        end
 
-        expect(-> { JsonAPIExample::Article.real_find(123) }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
-          expect(exception.result.first.title).to eq("Record not found")
+        it 'should ignore the "data" key and raise the relevant Flexirest error' do
+          expect(-> { make_request }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
+            expect(exception.result.first.detail).to eq("The record identified by 123456 could not be found")
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.9.11
+  version: 1.9.12
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler