flexirest 1.9.10 → 1.9.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f402c30e90e85f106749a754d7783d2519da5b86cc0caf730799cac8a5f65c72
-  data.tar.gz: 29c6172196d8d09abbf37e2b40b0665d6b7d6498aa923b99c99e95683cf8c9c2
+  metadata.gz: 294f2e24981dde7af931d0bedd578e4eb260538f947f716739a3d4037cd2a6b8
+  data.tar.gz: 5ab2e8babd0e312eea734257e6fdeeb1ccd1701143ec4a953a0ea90b102ed3f4
 SHA512:
-  metadata.gz: 502bdb7fb81e058703485d37c32f01f584ebdbc5a4d9eb37badf492847a9e9070f1705c06aee048397b61c16335b175b0447ccf8b6bf663080d83d84d6b64e8b
-  data.tar.gz: 4a2317aac7ea5adfafe440efb5401a6da26cb1a7a8f58d4d236a5978e8c239cd540d5a45a7c9bebc39d15065d07b75ab6410b3c42a53a8e5af986a984431afa4
+  metadata.gz: ce1125b17e4a41d11bc3cb3be10888d89604beaff46839fe3dbbce1fb663b4d69bbc58f3a8dab9463b2367daae9e182751393c8adc2ed5148e90138ce88ab167
+  data.tar.gz: c4f992e9c9e70b2faabf3384512f6973b6e3f5fb8ebca7515faae48670ec61b630a2c951d908efbf95170506885f19a9e87454ce2bc0caac64a0a6f01a4f9770

data/CHANGELOG.md

@@ -1,11 +1,19 @@
 # Changelog
 
-## 1.9.0
+## 1.9.11
+
+Bugfix:
+
+- Prevent crash when JSONAPI response["data"] is an empty array (thanks to François Ferrandis for the PR).
+
+## 1.9.10
 
 Bugfix:
 
 - Correctly handle errors in JSONAPI calls (thanks to François Ferrandis for the PR).
 
+Important: Note, because a gem was accidentally pushed as version 1.9.10 instead of 1.9.0, there will be no 1.9.0 to 1.9.9, to reduce the risk of someone having updated to the accidental high version increase. Sorry about that
+
 ## 1.8.9
 
 Feature:

data/lib/flexirest/json_api_proxy.rb

@@ -196,9 +196,14 @@ 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?
+
+        # return early if data is an empty array
+        return [] if body['data'] == []
+
         # Retrieve the resource(s) object or array from the data object
         records = body['data']
-        return body['errors'] unless records.present?
 
         # Convert the resource object to an array,
         # because it is easier to work with an array than a single object

data/lib/flexirest/version.rb

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

data/spec/lib/json_api_spec.rb

@@ -239,6 +239,7 @@ module JsonAPIExample
       }
     }
 
+    get(:real_index, '/articles')
     get(:real_find, '/articles/:id')
 
     get(
@@ -311,24 +312,42 @@ describe 'JSON API' do
       expect(subject.find_all).to be_an_instance_of(Flexirest::ResultIterator)
     end
 
-    it 'should raise an error when response has "errors" key and no "data"' do
-      body = {
-        errors: [
-          {
-            title: "Record not found",
-            detail: "The record identified by 123456 could not be found",
-            code: "not_found",
-            status: "404",
-          }
-        ]
-      }
-      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: body.to_json, response_headers: headers, status: 404)))
+    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
+
+      it 'should raise a Flexirest error' do
+        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)))
+
+        expect(-> { JsonAPIExample::Article.real_find(123) }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
+          expect(exception.result.first.title).to eq("Record not found")
+        end
+      end
+    end
+
+    context 'when response has an empty "data" key' do
+      let(:headers) { { "Content-Type" => "application/vnd.api+json" } }
+      let(:response_body) { { data: [] } }
+
+      it 'should return an empty array' do
+        expect_any_instance_of(Flexirest::Connection).
+          to receive(:get).with("/articles", an_instance_of(Hash)).
+          and_return(::FaradayResponseMock.new(OpenStruct.new(body: response_body.to_json, response_headers: headers, status: 200)))
 
-      expect(-> { JsonAPIExample::Article.real_find(123) }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
-        expect(exception.result.first.title).to eq("Record not found")
+        expect(JsonAPIExample::Article.real_index.to_a).to eq([])
       end
     end
   end

metadata

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