jsonapi-resources 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcb37444c599cb514483e80217f64409d7745411
-  data.tar.gz: eaeff3c3ee4183273ccb9cc59a1933781426c21f
+  metadata.gz: e9dfa52ac05f532050b9740a884e624b27f40dcc
+  data.tar.gz: 515bc38bde0559a474dcfbc7ec9891a9cc79d1eb
 SHA512:
-  metadata.gz: 829b54dedc77b56e63757c0ea593a98b562d573fc2f1ba221baa036f429e365b21c28f99c846c681d681677f7bca9c240ca617d133f39a1ea1c9292ecaf5b1d4
-  data.tar.gz: dc68f574e96aa495ee6f6da7402869262864d169bdaa476b06948888935701f7601b2cdc9b0092c6a67bd9a89c1df96ae4c55c07a70a3f4223628d36a494588b
+  metadata.gz: c47e723f53c1b0d30ef1ab99f19841b5c1bb6ed808a441739d3d065e3e7ef57513881f7644a579766eb652df57d280a98eaa6c44f3d57c53f7158a5a045e50e5
+  data.tar.gz: 2644748a35a9e4de7554be0627068a044611600f43195ddf41fd28be1f33cd5df4d047605d74f950efccd9df3b48a968f2e42dd3c6846195fb5916cf126a182a

data/README.md

@@ -1282,6 +1282,12 @@ JSONAPI.configure do |config|
   config.allow_sort = true
   config.allow_filter = true
 
+  # How to handle unsupported attributes and relationships which are provided in the request
+  # true => raises an error
+  # false => allows the request to continue. A warning is included in the response meta data indicating
+  # the fields which were ignored. This is useful for client libraries which send extra parameters.
+  config.raise_if_parameters_not_allowed = true
+
   # :none, :offset, :paged, or a custom paginator name
   config.default_paginator = :none
 

data/lib/jsonapi/acts_as_resource_controller.rb

@@ -87,6 +87,7 @@ module JSONAPI
 
     def setup_request
       @request = JSONAPI::Request.new(params, context: context, key_formatter: key_formatter)
+
       render_errors(@request.errors) unless @request.errors.empty?
     rescue => e
       handle_exceptions(e)
@@ -121,6 +122,14 @@ module JSONAPI
       {}
     end
 
+    def base_meta
+      if @request.nil? || @request.warnings.empty?
+        base_response_meta
+      else
+        base_response_meta.merge(warnings: @request.warnings)
+      end
+    end
+
     def base_response_links
       {}
     end
@@ -147,7 +156,7 @@ module JSONAPI
         base_url: base_url,
         key_formatter: key_formatter,
         route_formatter: route_formatter,
-        base_meta: base_response_meta,
+        base_meta: base_meta,
         base_links: base_response_links,
         resource_serializer_klass: resource_serializer_klass,
         request: @request

data/lib/jsonapi/configuration.rb

@@ -8,6 +8,7 @@ module JSONAPI
                 :key_formatter,
                 :route_format,
                 :route_formatter,
+                :raise_if_parameters_not_allowed,
                 :operations_processor,
                 :allow_include,
                 :allow_sort,
@@ -38,6 +39,8 @@ module JSONAPI
       self.allow_sort = true
       self.allow_filter = true
 
+      self.raise_if_parameters_not_allowed = true
+
       # :none, :offset, :paged, or a custom paginator name
       self.default_paginator = :none
 
@@ -105,6 +108,8 @@ module JSONAPI
     attr_writer :always_include_to_one_linkage_data
 
     attr_writer :always_include_to_many_linkage_data
+
+    attr_writer :raise_if_parameters_not_allowed
   end
 
   class << self

data/lib/jsonapi/error.rb

@@ -17,4 +17,17 @@ module JSONAPI
       @status         = options[:status]
     end
   end
+
+  class Warning
+    attr_accessor :title, :detail, :code
+    def initialize(options = {})
+      @title          = options[:title]
+      @detail         = options[:detail]
+      @code           = if JSONAPI.configuration.use_text_errors
+                          TEXT_ERRORS[options[:code]]
+                        else
+                          options[:code]
+                        end
+    end
+  end
 end

data/lib/jsonapi/operation.rb

@@ -175,7 +175,7 @@ module JSONAPI
     def options
       opts = {}
       opts.merge!(pagination_params: pagination_params) if JSONAPI.configuration.top_level_links_include_pagination
-      opts.merge!(record_count: pagination_params) if JSONAPI.configuration.top_level_meta_include_record_count
+      opts.merge!(record_count: record_count) if JSONAPI.configuration.top_level_meta_include_record_count
       opts
     end
 

data/lib/jsonapi/request.rb

@@ -5,13 +5,14 @@ module JSONAPI
   class Request
     attr_accessor :fields, :include, :filters, :sort_criteria, :errors, :operations,
                   :resource_klass, :context, :paginator, :source_klass, :source_id,
-                  :include_directives, :params
+                  :include_directives, :params, :warnings
 
     def initialize(params = nil, options = {})
       @params = params
       @context = options[:context]
       @key_formatter = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
       @errors = []
+      @warnings = []
       @operations = []
       @fields = {}
       @filters = {}
@@ -487,11 +488,21 @@ module JSONAPI
         case key.to_s
         when 'relationships'
           value.each_key do |links_key|
-            params_not_allowed.push(links_key) unless formatted_allowed_fields.include?(links_key.to_sym)
+            unless formatted_allowed_fields.include?(links_key.to_sym)
+              params_not_allowed.push(links_key)
+              unless JSONAPI.configuration.raise_if_parameters_not_allowed
+                value.delete links_key
+              end
+            end
           end
         when 'attributes'
-          value.each do |attr_key, _attr_value|
-            params_not_allowed.push(attr_key) unless formatted_allowed_fields.include?(attr_key.to_sym)
+          value.each do |attr_key, attr_value|
+            unless formatted_allowed_fields.include?(attr_key.to_sym)
+              params_not_allowed.push(attr_key)
+              unless JSONAPI.configuration.raise_if_parameters_not_allowed
+                value.delete attr_key
+              end
+            end
           end
         when 'type', 'id'
         else
@@ -499,7 +510,18 @@ module JSONAPI
         end
       end
 
-      fail JSONAPI::Exceptions::ParametersNotAllowed.new(params_not_allowed) if params_not_allowed.length > 0
+      if params_not_allowed.length > 0
+        if JSONAPI.configuration.raise_if_parameters_not_allowed
+          fail JSONAPI::Exceptions::ParametersNotAllowed.new(params_not_allowed)
+        else
+          params_not_allowed_warnings = params_not_allowed.map do |key|
+            JSONAPI::Warning.new(code: JSONAPI::PARAM_NOT_ALLOWED,
+                                 title: 'Param not allowed',
+                                 detail: "#{key} is not allowed.")
+          end
+          self.warnings.concat(params_not_allowed_warnings)
+        end
+      end
     end
 
     # TODO: Please remove after `updateable_fields` is removed

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.5.5'
+    VERSION = '0.5.6'
   end
 end

data/test/controllers/controller_test.rb

@@ -5,6 +5,10 @@ def set_content_type_header!
 end
 
 class PostsControllerTest < ActionController::TestCase
+  def setup
+    JSONAPI.configuration.raise_if_parameters_not_allowed = true
+  end
+
   def test_index
     get :index
     assert_response :success
@@ -401,6 +405,40 @@ class PostsControllerTest < ActionController::TestCase
     assert_match /asdfg is not allowed/, response.body
   end
 
+  def test_create_extra_param_allow_extra_params
+    JSONAPI.configuration.raise_if_parameters_not_allowed = false
+
+    set_content_type_header!
+    post :create,
+         {
+           data: {
+             type: 'posts',
+             attributes: {
+               asdfg: 'aaaa',
+               title: 'JR is Great',
+               body: 'JSONAPIResources is the greatest thing since unsliced bread.'
+             },
+             relationships: {
+               author: {data: {type: 'people', id: '3'}}
+             }
+           },
+           include: 'author'
+         }
+
+    assert_response :created
+    assert json_response['data'].is_a?(Hash)
+    assert_equal '3', json_response['data']['relationships']['author']['data']['id']
+    assert_equal 'JR is Great', json_response['data']['attributes']['title']
+    assert_equal 'JSONAPIResources is the greatest thing since unsliced bread.', json_response['data']['attributes']['body']
+
+    assert_equal 1, json_response['meta']["warnings"].count
+    assert_equal "Param not allowed", json_response['meta']["warnings"][0]["title"]
+    assert_equal "asdfg is not allowed.", json_response['meta']["warnings"][0]["detail"]
+    assert_equal 105, json_response['meta']["warnings"][0]["code"]
+  ensure
+    JSONAPI.configuration.raise_if_parameters_not_allowed = true
+  end
+
   def test_create_with_invalid_data
     set_content_type_header!
     post :create,
@@ -575,6 +613,42 @@ class PostsControllerTest < ActionController::TestCase
     assert_match /subject/, json_response['errors'][0]['detail']
   end
 
+  def test_create_simple_unpermitted_attributes_allow_extra_params
+    JSONAPI.configuration.raise_if_parameters_not_allowed = false
+
+    set_content_type_header!
+    post :create,
+         {
+           data: {
+             type: 'posts',
+             attributes: {
+               title: 'JR is Great',
+               subject: 'JR is SUPER Great',
+               body: 'JSONAPIResources is the greatest thing since unsliced bread.'
+             },
+             relationships: {
+               author: {data: {type: 'people', id: '3'}}
+             }
+           },
+           include: 'author'
+         }
+
+    assert_response :created
+    assert json_response['data'].is_a?(Hash)
+    assert_equal '3', json_response['data']['relationships']['author']['data']['id']
+    assert_equal 'JR is Great', json_response['data']['attributes']['title']
+    assert_equal 'JR is Great', json_response['data']['attributes']['subject']
+    assert_equal 'JSONAPIResources is the greatest thing since unsliced bread.', json_response['data']['attributes']['body']
+
+
+    assert_equal 1, json_response['meta']["warnings"].count
+    assert_equal "Param not allowed", json_response['meta']["warnings"][0]["title"]
+    assert_equal "subject is not allowed.", json_response['meta']["warnings"][0]["detail"]
+    assert_equal 105, json_response['meta']["warnings"][0]["code"]
+  ensure
+    JSONAPI.configuration.raise_if_parameters_not_allowed = true
+  end
+
   def test_create_with_links_to_many_type_ids
     set_content_type_header!
     post :create,
@@ -704,6 +778,48 @@ class PostsControllerTest < ActionController::TestCase
     assert_equal title, post_object.title
   end
 
+  def test_update_with_links_allow_extra_params
+    JSONAPI.configuration.raise_if_parameters_not_allowed = false
+
+    set_content_type_header!
+    javascript = Section.find_by(name: 'javascript')
+
+    put :update,
+        {
+          id: 3,
+          data: {
+            id: '3',
+            type: 'posts',
+            attributes: {
+              title: 'A great new Post',
+              subject: 'A great new Post',
+            },
+            relationships: {
+              section: {data: {type: 'sections', id: "#{javascript.id}"}},
+              tags: {data: [{type: 'tags', id: 3}, {type: 'tags', id: 4}]}
+            }
+          },
+          include: 'tags,author,section'
+        }
+
+    assert_response :success
+    assert json_response['data'].is_a?(Hash)
+    assert_equal '3', json_response['data']['relationships']['author']['data']['id']
+    assert_equal javascript.id.to_s, json_response['data']['relationships']['section']['data']['id']
+    assert_equal 'A great new Post', json_response['data']['attributes']['title']
+    assert_equal 'AAAA', json_response['data']['attributes']['body']
+    assert matches_array?([{'type' => 'tags', 'id' => '3'}, {'type' => 'tags', 'id' => '4'}],
+                          json_response['data']['relationships']['tags']['data'])
+
+
+    assert_equal 1, json_response['meta']["warnings"].count
+    assert_equal "Param not allowed", json_response['meta']["warnings"][0]["title"]
+    assert_equal "subject is not allowed.", json_response['meta']["warnings"][0]["detail"]
+    assert_equal 105, json_response['meta']["warnings"][0]["code"]
+  ensure
+    JSONAPI.configuration.raise_if_parameters_not_allowed = true
+  end
+
   def test_update_remove_links
     set_content_type_header!
     put :update,
@@ -1150,6 +1266,38 @@ class PostsControllerTest < ActionController::TestCase
     assert_match /asdfg is not allowed/, response.body
   end
 
+  def test_update_extra_param_in_links_allow_extra_params
+    JSONAPI.configuration.raise_if_parameters_not_allowed = false
+    JSONAPI.configuration.use_text_errors = true
+
+    set_content_type_header!
+    javascript = Section.find_by(name: 'javascript')
+
+    put :update,
+        {
+          id: 3,
+          data: {
+            type: 'posts',
+            id: '3',
+            attributes: {
+              title: 'A great new Post'
+            },
+            relationships: {
+              asdfg: 'aaaa'
+            }
+          }
+        }
+
+    assert_response :success
+    assert_equal "A great new Post", json_response["data"]["attributes"]["title"]
+    assert_equal "Param not allowed", json_response["meta"]["warnings"][0]["title"]
+    assert_equal "asdfg is not allowed.", json_response["meta"]["warnings"][0]["detail"]
+    assert_equal "PARAM_NOT_ALLOWED", json_response["meta"]["warnings"][0]["code"]
+  ensure
+    JSONAPI.configuration.raise_if_parameters_not_allowed = true
+    JSONAPI.configuration.use_text_errors = false
+  end
+
   def test_update_missing_param
     set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
@@ -1550,6 +1698,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
     get :index, {sort: 'not_in_record'}
     assert_response 400
     assert_equal 'INVALID_SORT_CRITERIA', json_response['errors'][0]['code']
+  ensure
     JSONAPI.configuration.use_text_errors = false
   end
 
@@ -1605,6 +1754,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
 
   def test_create_expense_entries_underscored
     set_content_type_header!
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
 
     post :create,
@@ -1632,10 +1782,13 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
 
     delete :destroy, {id: json_response['data']['id']}
     assert_response :no_content
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_create_expense_entries_camelized_key
     set_content_type_header!
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :camelized_key
 
     post :create,
@@ -1663,10 +1816,13 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
 
     delete :destroy, {id: json_response['data']['id']}
     assert_response :no_content
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_create_expense_entries_dasherized_key
     set_content_type_header!
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :dasherized_key
 
     post :create,
@@ -1694,6 +1850,8 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
 
     delete :destroy, {id: json_response['data']['id']}
     assert_response :no_content
+  ensure
+    JSONAPI.configuration = original_config
   end
 end
 
@@ -1710,6 +1868,7 @@ class IsoCurrenciesControllerTest < ActionController::TestCase
 
   def test_create_currencies_client_generated_id
     set_content_type_header!
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_route
 
     post :create,
@@ -1733,6 +1892,8 @@ class IsoCurrenciesControllerTest < ActionController::TestCase
 
     delete :destroy, {id: json_response['data']['id']}
     assert_response :no_content
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_currencies_primary_key_sort
@@ -1750,6 +1911,7 @@ class IsoCurrenciesControllerTest < ActionController::TestCase
   end
 
   def test_currencies_json_key_underscored_sort
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
     get :index, {sort: 'country_name'}
     assert_response :success
@@ -1765,9 +1927,12 @@ class IsoCurrenciesControllerTest < ActionController::TestCase
     assert_equal 'United States', json_response['data'][0]['attributes']['country_name']
     assert_equal 'Euro Member Countries', json_response['data'][1]['attributes']['country_name']
     assert_equal 'Canada', json_response['data'][2]['attributes']['country_name']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_currencies_json_key_dasherized_sort
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :dasherized_key
     get :index, {sort: 'country-name'}
     assert_response :success
@@ -1783,9 +1948,12 @@ class IsoCurrenciesControllerTest < ActionController::TestCase
     assert_equal 'United States', json_response['data'][0]['attributes']['country-name']
     assert_equal 'Euro Member Countries', json_response['data'][1]['attributes']['country-name']
     assert_equal 'Canada', json_response['data'][2]['attributes']['country-name']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_currencies_json_key_custom_json_key_sort
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :upper_camelized_key
     get :index, {sort: 'CountryName'}
     assert_response :success
@@ -1801,30 +1969,41 @@ class IsoCurrenciesControllerTest < ActionController::TestCase
     assert_equal 'United States', json_response['data'][0]['attributes']['CountryName']
     assert_equal 'Euro Member Countries', json_response['data'][1]['attributes']['CountryName']
     assert_equal 'Canada', json_response['data'][2]['attributes']['CountryName']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_currencies_json_key_underscored_filter
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
     get :index, {filter: {country_name: 'Canada'}}
     assert_response :success
     assert_equal 1, json_response['data'].size
     assert_equal 'Canada', json_response['data'][0]['attributes']['country_name']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_currencies_json_key_camelized_key_filter
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :camelized_key
     get :index, {filter: {'countryName' => 'Canada'}}
     assert_response :success
     assert_equal 1, json_response['data'].size
     assert_equal 'Canada', json_response['data'][0]['attributes']['countryName']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_currencies_json_key_custom_json_key_filter
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :upper_camelized_key
     get :index, {filter: {'CountryName' => 'Canada'}}
     assert_response :success
     assert_equal 1, json_response['data'].size
     assert_equal 'Canada', json_response['data'][0]['attributes']['CountryName']
+  ensure
+    JSONAPI.configuration = original_config
   end
 end
 
@@ -1851,6 +2030,7 @@ class PeopleControllerTest < ActionController::TestCase
   end
 
   def test_update_link_with_dasherized_type
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :dasherized_key
     set_content_type_header!
     put :update,
@@ -1870,6 +2050,8 @@ class PeopleControllerTest < ActionController::TestCase
           }
         }
     assert_response :success
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_create_validations_missing_attribute
@@ -1933,6 +2115,7 @@ class PeopleControllerTest < ActionController::TestCase
   end
 
   def test_get_related_resource
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :dasherized_key
     JSONAPI.configuration.route_format = :underscored_key
     get :get_related_resource, {post_id: '2', relationship: 'author', source:'posts'}
@@ -1986,6 +2169,8 @@ class PeopleControllerTest < ActionController::TestCase
       },
       json_response
     )
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_get_related_resource_nil
@@ -2195,6 +2380,7 @@ end
 
 class FactsControllerTest < ActionController::TestCase
   def test_type_formatting
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :camelized_key
     get :show, {id: '1'}
     assert_response :success
@@ -2208,9 +2394,12 @@ class FactsControllerTest < ActionController::TestCase
     assert_equal '2000-01-01T20:00:00Z', json_response['data']['attributes']['bedtime']
     assert_equal 'abc', json_response['data']['attributes']['photo']
     assert_equal false, json_response['data']['attributes']['cool']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_create_with_invalid_data
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :dasherized_key
     set_content_type_header!
     post :create,
@@ -2242,6 +2431,8 @@ class FactsControllerTest < ActionController::TestCase
     assert_equal "/data/attributes/bio", json_response['errors'][1]['source']['pointer']
     assert_equal "can't be blank", json_response['errors'][1]['title']
     assert_equal "bio - can't be blank", json_response['errors'][1]['detail']
+  ensure
+    JSONAPI.configuration = original_config
   end
 end
 
@@ -2447,25 +2638,25 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
   def test_books_banned_non_book_admin
     $test_user = Person.find(1)
     Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
     count_queries do
-      JSONAPI.configuration.top_level_meta_include_record_count = true
       get :index, {page: {offset: 50, limit: 12}}
-      JSONAPI.configuration.top_level_meta_include_record_count = false
     end
     assert_response :success
     assert_equal 12, json_response['data'].size
     assert_equal 'Book 50', json_response['data'][0]['attributes']['title']
     assert_equal 901, json_response['meta']['record-count']
     assert_query_count(2)
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
   end
 
   def test_books_banned_non_book_admin_includes_switched
     $test_user = Person.find(1)
     Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
     count_queries do
-      JSONAPI.configuration.top_level_meta_include_record_count = true
       get :index, {page: {offset: 0, limit: 12}, include: 'book-comments'}
-      JSONAPI.configuration.top_level_meta_include_record_count = false
     end
 
     assert_response :success
@@ -2476,15 +2667,16 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
     assert_equal 'book-comments', json_response['included'][0]['type']
     assert_equal 901, json_response['meta']['record-count']
     assert_query_count(3)
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
   end
 
   def test_books_banned_non_book_admin_includes_nested_includes
     $test_user = Person.find(1)
+    JSONAPI.configuration.top_level_meta_include_record_count = true
     Api::V2::BookResource.paginator :offset
     count_queries do
-      JSONAPI.configuration.top_level_meta_include_record_count = true
       get :index, {page: {offset: 0, limit: 12}, include: 'book-comments.author'}
-      JSONAPI.configuration.top_level_meta_include_record_count = false
     end
     assert_response :success
     assert_equal 12, json_response['data'].size
@@ -2492,51 +2684,56 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
     assert_equal 'Book 0', json_response['data'][0]['attributes']['title']
     assert_equal 901, json_response['meta']['record-count']
     assert_query_count(4)
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
   end
 
   def test_books_banned_admin
     $test_user = Person.find(5)
     Api::V2::BookResource.paginator :offset
-    query_count = count_queries do
-      JSONAPI.configuration.top_level_meta_include_record_count = true
+    JSONAPI.configuration.top_level_meta_include_record_count = true
+    count_queries do
       get :index, {page: {offset: 50, limit: 12}, filter: {banned: 'true'}}
-      JSONAPI.configuration.top_level_meta_include_record_count = false
     end
     assert_response :success
     assert_equal 12, json_response['data'].size
     assert_equal 'Book 651', json_response['data'][0]['attributes']['title']
     assert_equal 99, json_response['meta']['record-count']
     assert_query_count(2)
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
   end
 
   def test_books_not_banned_admin
     $test_user = Person.find(5)
     Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
     count_queries do
-      JSONAPI.configuration.top_level_meta_include_record_count = true
       get :index, {page: {offset: 50, limit: 12}, filter: {banned: 'false'}}
-      JSONAPI.configuration.top_level_meta_include_record_count = false
     end
     assert_response :success
     assert_equal 12, json_response['data'].size
     assert_equal 'Book 50', json_response['data'][0]['attributes']['title']
     assert_equal 901, json_response['meta']['record-count']
     assert_query_count(2)
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
   end
 
   def test_books_banned_non_book_admin_overlapped
     $test_user = Person.find(1)
     Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
     count_queries do
-      JSONAPI.configuration.top_level_meta_include_record_count = true
       get :index, {page: {offset: 590, limit: 20}}
-      JSONAPI.configuration.top_level_meta_include_record_count = false
     end
     assert_response :success
     assert_equal 20, json_response['data'].size
     assert_equal 'Book 590', json_response['data'][0]['attributes']['title']
     assert_equal 901, json_response['meta']['record-count']
     assert_query_count(2)
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
   end
 
   def test_books_included_exclude_unapproved
@@ -2625,6 +2822,7 @@ class Api::V4::BooksControllerTest < ActionController::TestCase
   end
 
   def test_books_offset_pagination_meta
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.operations_processor = :counting_active_record
     Api::V4::BookResource.paginator :offset
     get :index, {page: {offset: 50, limit: 12}}
@@ -2632,10 +2830,12 @@ class Api::V4::BooksControllerTest < ActionController::TestCase
     assert_equal 12, json_response['data'].size
     assert_equal 'Book 50', json_response['data'][0]['attributes']['title']
     assert_equal 901, json_response['meta']['totalRecords']
-    JSONAPI.configuration.operations_processor = :active_record
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_books_operation_links
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.operations_processor = :counting_active_record
     Api::V4::BookResource.paginator :offset
     get :index, {page: {offset: 50, limit: 12}}
@@ -2644,7 +2844,8 @@ class Api::V4::BooksControllerTest < ActionController::TestCase
     assert_equal 'Book 50', json_response['data'][0]['attributes']['title']
     assert_equal 5, json_response['links'].size
     assert_equal 'https://test_corp.com', json_response['links']['spec']
-    JSONAPI.configuration.operations_processor = :active_record
+  ensure
+    JSONAPI.configuration = original_config
   end
 end
 

data/test/integration/requests/request_test.rb

@@ -38,37 +38,50 @@ class RequestTest < ActionDispatch::IntegrationTest
   end
 
   def test_get_underscored_key
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
     get '/iso_currencies'
     assert_equal 200, status
     assert_equal 3, json_response['data'].size
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_get_underscored_key_filtered
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
     get '/iso_currencies?filter[country_name]=Canada'
     assert_equal 200, status
     assert_equal 1, json_response['data'].size
     assert_equal 'Canada', json_response['data'][0]['attributes']['country_name']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_get_camelized_key_filtered
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :camelized_key
     get '/iso_currencies?filter[countryName]=Canada'
     assert_equal 200, status
     assert_equal 1, json_response['data'].size
     assert_equal 'Canada', json_response['data'][0]['attributes']['countryName']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_get_camelized_route_and_key_filtered
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :camelized_key
     get '/api/v4/isoCurrencies?filter[countryName]=Canada'
     assert_equal 200, status
     assert_equal 1, json_response['data'].size
     assert_equal 'Canada', json_response['data'][0]['attributes']['countryName']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_get_camelized_route_and_links
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :camelized_key
     JSONAPI.configuration.route_format = :camelized_route
     get '/api/v4/expenseEntries/1/relationships/isoCurrency'
@@ -82,6 +95,8 @@ class RequestTest < ActionDispatch::IntegrationTest
                           'id' => 'USD'
                          }
                        }, json_response)
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_put_single_without_content_type
@@ -398,6 +413,19 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 'http://www.example.com/api/v2/books/1/book_comments?page%5Blimit%5D=10&page%5Boffset%5D=41', json_response['links']['last']
   end
 
+  def test_pagination_related_resources_links_meta
+    Api::V2::BookResource.paginator :offset
+    Api::V2::BookCommentResource.paginator :offset
+    JSONAPI.configuration.top_level_meta_include_record_count = true
+    get '/api/v2/books/1/book_comments?page[limit]=10'
+    assert_equal 51, json_response['meta']['record_count']
+    assert_equal 'http://www.example.com/api/v2/books/1/book_comments?page%5Blimit%5D=10&page%5Boffset%5D=0', json_response['links']['first']
+    assert_equal 'http://www.example.com/api/v2/books/1/book_comments?page%5Blimit%5D=10&page%5Boffset%5D=10', json_response['links']['next']
+    assert_equal 'http://www.example.com/api/v2/books/1/book_comments?page%5Blimit%5D=10&page%5Boffset%5D=41', json_response['links']['last']
+  ensure
+    JSONAPI.configuration.top_level_meta_include_record_count = false
+  end
+
   def test_pagination_related_resources_without_related
     Api::V2::BookResource.paginator :offset
     Api::V2::BookCommentResource.paginator :offset
@@ -511,6 +539,7 @@ class RequestTest < ActionDispatch::IntegrationTest
   end
 
   def test_flow_self_formatted_route_1
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     get '/api/v6/purchase-orders'
@@ -521,9 +550,12 @@ class RequestTest < ActionDispatch::IntegrationTest
     get po_1['links']['self']
     assert_equal 200, status
     assert_hash_equals po_1, json_response['data']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_flow_self_formatted_route_2
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :underscored_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     get '/api/v7/purchase_orders'
@@ -535,9 +567,12 @@ class RequestTest < ActionDispatch::IntegrationTest
     get po_1['links']['self']
     assert_equal 200, status
     assert_hash_equals po_1, json_response['data']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_flow_self_formatted_route_3
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :underscored_route
     JSONAPI.configuration.json_key_format = :underscored_key
     get '/api/v7/purchase_orders'
@@ -549,9 +584,12 @@ class RequestTest < ActionDispatch::IntegrationTest
     get po_1['links']['self']
     assert_equal 200, status
     assert_hash_equals po_1, json_response['data']
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_post_formatted_keys
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     post '/api/v6/purchase-orders',
@@ -565,9 +603,12 @@ class RequestTest < ActionDispatch::IntegrationTest
          }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 201, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_post_formatted_keys_different_route_key_1
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :underscored_key
     post '/api/v6/purchase-orders',
@@ -581,9 +622,12 @@ class RequestTest < ActionDispatch::IntegrationTest
          }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 201, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_post_formatted_keys_different_route_key_2
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :underscored_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     post '/api/v7/purchase_orders',
@@ -597,9 +641,12 @@ class RequestTest < ActionDispatch::IntegrationTest
          }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 201, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_post_formatted_keys_wrong_format
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     post '/api/v6/purchase-orders',
@@ -613,9 +660,12 @@ class RequestTest < ActionDispatch::IntegrationTest
          }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 400, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_patch_formatted_dasherized
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/purchase-orders/1',
@@ -633,6 +683,7 @@ class RequestTest < ActionDispatch::IntegrationTest
   end
 
   def test_patch_formatted_dasherized_links
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/line-items/1',
@@ -652,9 +703,12 @@ class RequestTest < ActionDispatch::IntegrationTest
           }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 200, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_patch_formatted_dasherized_replace_to_many
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/purchase-orders/2?include=line-items,order-flags',
@@ -680,9 +734,12 @@ class RequestTest < ActionDispatch::IntegrationTest
           }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 200, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_post_to_many_link
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     post '/api/v6/purchase-orders/3/relationships/line-items',
@@ -694,9 +751,12 @@ class RequestTest < ActionDispatch::IntegrationTest
           }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_patch_to_many_link
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/purchase-orders/3/relationships/order-flags',
@@ -708,9 +768,12 @@ class RequestTest < ActionDispatch::IntegrationTest
          }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_patch_to_one
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/line-items/5/relationships/purchase-order',
@@ -719,6 +782,8 @@ class RequestTest < ActionDispatch::IntegrationTest
          }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_include_parameter_allowed

data/test/unit/serializer/serializer_test.rb

@@ -964,6 +964,7 @@ class SerializerTest < ActionDispatch::IntegrationTest
       JSONAPI::ResourceSerializer.new(PostResource,
                                       include: ['comments', 'comments.tags']).serialize_to_hash(posts)
     )
+  ensure
     JSONAPI.configuration.always_include_to_one_linkage_data = false
   end
 
@@ -1410,9 +1411,6 @@ class SerializerTest < ActionDispatch::IntegrationTest
   end
 
   def test_serializer_camelized_with_value_formatters
-    # JSONAPI.configuration.json_key_format = :camelized_key
-    # JSONAPI.configuration.route_format = :camelized_route
-
     assert_hash_equals(
       {
         data: {
@@ -1618,6 +1616,7 @@ class SerializerTest < ActionDispatch::IntegrationTest
   end
 
   def test_serializer_booleans
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
 
     preferences = PreferencesResource.new(Preferences.find(1))
@@ -1651,9 +1650,12 @@ class SerializerTest < ActionDispatch::IntegrationTest
       },
       JSONAPI::ResourceSerializer.new(PreferencesResource).serialize_to_hash(preferences)
     )
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_serializer_data_types
+    original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.json_key_format = :underscored_key
 
     facts = FactResource.new(Fact.find(1))
@@ -1681,6 +1683,8 @@ class SerializerTest < ActionDispatch::IntegrationTest
       },
       JSONAPI::ResourceSerializer.new(FactResource).serialize_to_hash(facts)
     )
+  ensure
+    JSONAPI.configuration = original_config
   end
 
   def test_serializer_to_one

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler