flexirest 1.10.1 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89ef0bd6a927d830d9f98f1e4deeee8d26bf68a203a001f2299785386e1365b9
-  data.tar.gz: 3fa35c87cb16df1181207a6393682c6ec003346b4789d8bff30bbedbdba0e753
+  metadata.gz: 8001a7a20f2054fd34a7f09ae350253da96eba3dc4ff8b390e5b07509f1f09ea
+  data.tar.gz: 8f96916235d0f45fa9aa1c3ff5f37502f81c5d2f2a1c5db079d72e63d0de923c
 SHA512:
-  metadata.gz: 520a9f3131d517c00180dd15a9fbd8c03372343bde13474457a37db78b321efa54a756878bd5161253ab6646a6e6ffc24171a3f69fca043c14cfb49630cf7ef8
-  data.tar.gz: 5580fe4c1079b03fb51465550afce7ca4a542051efbd127df0405d113d47955182d88cfc324ff184a36be7eee0d4eaab5fad85efe47f94d5163846aad952df6d
+  metadata.gz: ad2e6dad01ee45f4d0b0540b53e8c6f20329d94cae6364f59d281ede3c45955959d3ecb70762249911cf05cc637840ba7e88a1c2fac49ff329ad3de680f643b3
+  data.tar.gz: de207d3cb3ac7bb243137925217efc0067d7c80950bac1a6a02450f251da0380470866e448ffd5c876e6009ed07b2cf0573ad82ce0782ad07cfb53c839a8e70d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.10.2
+
+Bugfix:
+
+- JSON-API calls do not include linked resources when no other parameter is passed (thanks to Stevo-S for the bug report and François Ferrandis for the PR)
+
 ## 1.10.1
 
 Enhancement:

data/docs/json-api.md

@@ -12,17 +12,26 @@ This proxy translates requests according to the JSON API specifications, parses
 
 It supports lazy loading by default. Unless a compound document is returned from the connected JSON API service, it will make another request to the service for the specified linked resource.
 
+
+## Including associations
+
 To reduce the number of requests to the service, you can ask the service to include the linked resources in the response. Such responses are called "compound documents". To do this, use the `includes` method:
 
 ```ruby
-# Makes a call to /articles with parameters: include=images
+# Makes a call to: /articles?include=images
 Article.includes(:images).all
 
-# For nested resources, the include parameter becomes: include=images.tags,images.photographer
+# Fetch nested resources: /articles?include=images.tags,images.photographer
 Article.includes(:images => [:tags, :photographer]).all
+
+# Note: the `includes` method takes precedence over the passed `:include` parameter.
+# This will result in query: /articles?include=images
+Article.includes(:images).all(include: "author")
 ```
 
-For POST and PATCH requests, the proxy formats a JSON API compliant request, and adds a `Content-Type: application/vnd.api+json` header. It guesses the `type` value in the resource object from the class name, but it can be set specifically with `alias_type`:
+## Resource type
+
+The `type` value is guessed from the class name, but it can be set specifically with `alias_type`:
 
 ```ruby
 class Photographer < Flexirest::Base
@@ -34,7 +43,10 @@ class Photographer < Flexirest::Base
 end
 ```
 
-NB: Updating relationships is not yet supported.
+
+## Notes
+
+Updating relationships is not yet supported.
 
 
 -----

data/docs/plain-requests.md

@@ -7,7 +7,7 @@ class Person < Flexirest::Base
 end
 
 people = Person._plain_request('http://api.example.com/v1/people') # Defaults to get with no parameters
-# people is a normal Flexirest object, implementing iteration, HAL loading, etc.
+# people is a string containing the response
 
 Person._plain_request('http://api.example.com/v1/people', :post, {id:1234,name:"John"}) # Post with parameters
 ```

data/lib/flexirest/json_api_proxy.rb

@@ -50,11 +50,8 @@ module Flexirest
         end
 
         def translate(params, include_associations)
-          # Return to caller if nothing is to be done
-          return params unless params.present? && include_associations.present?
-
           # Format the linked resources array, and assign to include key
-          params[:include] = format_include_params(include_associations)
+          params[:include] = format_include_params(include_associations) if include_associations.present?
         end
 
         private

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.1"
+  VERSION = "1.10.2"
 end

data/spec/lib/json_api_spec.rb

@@ -303,7 +303,7 @@ describe 'JSON API' do
   let(:tags) { JsonAPIExample::Tag }
   let(:author) { JsonAPIExample::Author }
 
-  context 'responses' do
+  describe 'responses' do
     it 'should return the data object if the response contains only one data instance' do
       expect(subject.find(1)).to be_an_instance_of(JsonAPIExampleArticle)
     end
@@ -370,17 +370,17 @@ describe 'JSON API' do
     end
   end
 
-  context 'attributes' do
+  describe 'attributes' do
     it 'should return the attributes as part of the data instance' do
-      expect(subject.find(1).item).to_not be_nil
+      expect(subject.find(1).item).to eq("item one")
     end
 
     it 'should return the association\'s attributes as part of the association instance' do
-      expect(subject.includes(:author).find_single_author(1).author.item).to_not be_nil
+      expect(subject.includes(:author).find_single_author(1).author.item).to eq("item two")
     end
   end
 
-  context 'associations' do
+  describe 'associations' do
     it 'should retrieve the resource\'s associations via its relationships object' do
       expect(subject.includes(:tags).find(1).tags.size).to eq(2)
     end
@@ -415,6 +415,40 @@ describe 'JSON API' do
     end
   end
 
+  describe 'requests' do
+    describe 'the `include=` parameter' do
+      before { stub_request(:get, %r{example\.com/articles}) }
+
+      context 'when using `.includes(:tags)`' do
+        it 'equal "tags"' do
+          JsonAPIExample::Article.includes(:tags).real_index
+          expect(WebMock).to have_requested(:get, 'http://www.example.com/articles?include=tags')
+        end
+      end
+
+      context 'when using `.includes(tags: [:authors, :articles])`' do
+        it 'equal "tags.authors,tags.articles"' do
+          JsonAPIExample::Article.includes(tags: [:authors, :articles]).real_index
+          expect(WebMock).to have_requested(:get, 'http://www.example.com/articles?include=tags.authors,tags.articles')
+        end
+      end
+
+      context 'when using both `.includes(:tags)` and other params in the final call' do
+        it 'uses the values passed to the `includes() method`' do
+          JsonAPIExample::Article.includes(:tags).real_index(filter: { author_id: 4 })
+          expect(WebMock).to have_requested(:get, 'http://www.example.com/articles?filter%5Bauthor_id%5D=4&include=tags')
+        end
+      end
+
+      context 'when using both `.includes(:tags)` and the :include param in final call' do
+        it 'uses the values passed to the `includes() method`' do
+          JsonAPIExample::Article.includes(:tags).real_index(include: "author")
+          expect(WebMock).to have_requested(:get, 'http://www.example.com/articles?include=tags')
+        end
+      end
+    end
+  end
+
   context 'lazy loading' do
     it 'should fetch association lazily' do
       stub_request(:get, /www.example.com\/articles\/1\/tags/)
@@ -434,7 +468,7 @@ describe 'JSON API' do
     end
   end
 
-  context 'client' do
+  describe 'client' do
     it 'should request with json api format, and expect a json api response' do
       expect_any_instance_of(Flexirest::Connection).to receive(:post) { |_, _, _, options|
         expect(options[:headers]).to include('Content-Type' => 'application/vnd.api+json')

metadata

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