Merge branch 'master' into feature/fix_pagination_issues

Author: gaorlov

CHANGELOG.md

@@ -4,6 +4,14 @@
 
 - [#348](https://github.com/JsonApiClient/json_api_client/pull/348) - add NestedParamPaginator to address inconsistency in handling of pagination query string params (issue [#347](https://github.com/JsonApiClient/json_api_client/issues/347)).
 
+## 1.12.2
+
+- [#350](https://github.com/JsonApiClient/json_api_client/pull/350) - fix resource including with blank `relationships` response data
+
+## 1.12.1
+
+- [#349](https://github.com/JsonApiClient/json_api_client/pull/349) - fix resource including for STI objects
+
 ## 1.12.0
 
 - [#345](https://github.com/JsonApiClient/json_api_client/pull/345) - track the real HTTP reason of ApiErrors

lib/json_api_client/included_data.rb

@@ -4,20 +4,30 @@ class IncludedData
 
     def initialize(result_set, data)
       record_class = result_set.record_class
-      included_set = data.map do |datum|
-        type = datum["type"]
+      grouped_data = data.group_by{|datum| datum["type"]}
+      grouped_included_set = grouped_data.each_with_object({}) do |(type, records), h|
         klass = Utils.compute_type(record_class, record_class.key_formatter.unformat(type).singularize.classify)
-        params = klass.parser.parameters_from_resource(datum)
-        resource = klass.load(params)
-        resource.last_result_set = result_set
-        resource
+        h[type] = records.map do |record|
+          params = klass.parser.parameters_from_resource(record)
+          klass.load(params).tap do |resource|
+            resource.last_result_set = result_set
+          end
+        end
       end
 
-      included_set.concat(result_set) if record_class.search_included_in_result_set
-      @data = included_set.group_by(&:type).inject({}) do |h, (type, resources)|
-        h[type] = resources.index_by(&:id)
-        h
+      if record_class.search_included_in_result_set
+        # deep_merge overrides the nested Arrays o_O
+        # {a: [1,2]}.deep_merge(a: [3,4]) # => {a: [3,4]}
+        grouped_included_set.merge!(result_set.group_by(&:type)) do |_, resources1, resources2|
+          resources1 + resources2
+        end
       end
+
+      grouped_included_set.each do |type, resources|
+        grouped_included_set[type] = resources.index_by(&:id)
+      end
+
+      @data = grouped_included_set
     end
 
     def data_for(method_name, definition)

lib/json_api_client/resource.rb

@@ -546,12 +546,10 @@ def relationship_data_for(name, relationship_definition)
         end
       end
 
-      url = relationship_definition["links"]["related"]
-      if relationship_definition["links"] && url
-        return association_for(name).data(url)
-      end
+      return unless links = relationship_definition["links"]
+      return unless url = links["related"]
 
-      nil
+      association_for(name).data(url)
     end
 
     def relation_objects_for(name, relationship_definition)

lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.12.0"
+  VERSION = "1.12.2"
 end

test/unit/association_test.rb

@@ -854,6 +854,70 @@ def test_get_with_defined_relationship_for_model_with_custom_type
     assert user.files.first.is_a?(DocumentFile)
   end
 
+  def test_get_with_type_attribute
+    stub_request(:get, "http://example.com/document_users/1?include=file")
+        .to_return(headers: {content_type: "application/vnd.api+json"}, body: {
+            data: [
+                {
+                    id: '1',
+                    type: 'document_users',
+                    attributes: {
+                        name: 'John Doe'
+                    },
+                    relationships: {
+                        file: {
+                            links: {
+                                self: 'http://example.com/document_users/1/relationships/file',
+                                related: 'http://example.com/document_users/1/file'
+                            },
+                            data: {
+                                id: '2',
+                                type: 'document--files'
+                            }
+                        }
+                    }
+                }
+            ],
+            included: [
+                {
+                    id: '2',
+                    type: 'document--files',
+                    attributes: {
+                        type: 'STIDocumentFile',
+                        url: 'http://example.com/downloads/2.pdf'
+                    }
+                }
+            ]
+        }.to_json)
+
+    user = DocumentUser.includes('file').find(1).first
+
+    assert_equal 'STIDocumentFile', user.file.type
+    assert user.file.is_a?(DocumentFile)
+  end
+
+  def test_include_with_blank_relationships
+    stub_request(:get, "http://example.com/document_users/1?include=file")
+        .to_return(headers: {content_type: "application/vnd.api+json"}, body: {
+            data: [
+                {
+                    id: '1',
+                    type: 'document_users',
+                    attributes: {
+                        name: 'John Doe'
+                    },
+                    relationships: {
+                        file: {
+                        }
+                    }
+                }
+            ],
+        }.to_json)
+
+    user = DocumentUser.includes('file').find(1).first
+    assert_nil user.file
+  end
+
   def test_load_include_from_dataset
     stub_request(:get, 'http://example.com/employees?include=chief&page[per_page]=2')
         .to_return(