jsonapi-serializers 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19d15964189040f00001f5a9deca26a44b21cbe6
-  data.tar.gz: a5b09f36c38933a31ca1b13bcb6bed226ee3a2c0
+  metadata.gz: 8b8e2b1a0281f387fc8e6e3ee0c24747ada99067
+  data.tar.gz: 2ce4804f76c29485607f6738bee21dd00dac9db0
 SHA512:
-  metadata.gz: 8e9effdc7369c2d055bf1533ee7d0f45e364b120e32bf13d34b5fa44faab9f64f40c8161d9470a33c945e83db4055674457c3ee213b4d281400c6dd1f2cc2813
-  data.tar.gz: 0aff7329c2ab1d3bb20a87ffd3c78ad24dcfa74c13d4b634331bb6b87546a2823f5c8546bd715697a6eeb18ee0383d406d6149efab5cb990645a958a1583e6b7
+  metadata.gz: d7d32a4701376557f93e848ee32c7a77f80ed1214a4de326a0c8dc85530f6211ed75476b060a8716162391928af36cb7ac6e551fbf29f99c40e3d5a305cf87f3
+  data.tar.gz: bcb13f91e195f15b052d055957e904bd4e4704365292bf36e3c9c76d88bcab74903752b9670fde309169e525ff64389a444e205fed80841fc270f9518c9e8aa7

data/README.md

@@ -18,6 +18,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [Custom attributes](#custom-attributes)
   * [More customizations](#more-customizations)
   * [Base URL](#base-url)
+  * [Root jsonapi object](#root-jsonapi-object)
   * [Root metadata](#root-metadata)
   * [Root links](#root-links)
   * [Root errors](#root-errors)
@@ -230,6 +231,12 @@ def base_url
 end
 ```
 ```ruby
+# Override this to provide a resource-object jsonapi object containing the version in use.
+# http://jsonapi.org/format/#document-jsonapi-object
+def jsonapi
+end
+```
+```ruby
 def self_link
   "#{base_url}/#{type}/#{id}"
 end
@@ -311,6 +318,14 @@ JSONAPI::Serializer.serialize(post, base_url: 'http://example.com')
 
 Note: if you override `self_link` in your serializer and leave out `base_url`, it will not be included.
 
+### Root 'jsonapi' object
+
+You can pass a `jsonapi` argument to specify a [top-level "jsonapi" key](http://jsonapi.org/format/#document-jsonapi-object) containing the version of JSON:API in use:
+
+```ruby
+JSONAPI::Serializer.serialize(post, jsonapi: {version: '1.0'})
+```
+
 ### Root metadata
 
 You can pass a `meta` argument to specify top-level metadata:

data/lib/jsonapi-serializers/serializer.rb

@@ -62,6 +62,11 @@ module JSONAPI
         attribute_name.to_s.underscore
       end
 
+      # Override this to provide resource-object jsonapi object containing the version in use.
+      # http://jsonapi.org/format/#document-jsonapi-object
+      def jsonapi
+      end
+
       # Override this to provide resource-object metadata.
       # http://jsonapi.org/format/#document-structure-resource-objects
       def meta
@@ -244,6 +249,7 @@ module JSONAPI
       options[:context] = options.delete('context') || options[:context] || {}
       options[:skip_collection_check] = options.delete('skip_collection_check') || options[:skip_collection_check] || false
       options[:base_url] = options.delete('base_url') || options[:base_url]
+      options[:jsonapi] = options.delete('jsonapi') || options[:jsonapi]
       options[:meta] = options.delete('meta') || options[:meta]
       options[:links] = options.delete('links') || options[:links]
 
@@ -299,6 +305,7 @@ module JSONAPI
       result = {
         'data' => primary_data,
       }
+      result['jsonapi'] = options[:jsonapi] if options[:jsonapi]
       result['meta'] = options[:meta] if options[:meta]
       result['links'] = options[:links] if options[:links]
       result['errors'] = options[:errors] if options[:errors]
@@ -382,10 +389,12 @@ module JSONAPI
       attributes = serializer.attributes
       links = serializer.links
       relationships = serializer.relationships
+      jsonapi = serializer.jsonapi
       meta = serializer.meta
       data['attributes'] = attributes if !attributes.empty?
       data['links'] = links if !links.empty?
       data['relationships'] = relationships if !relationships.empty?
+      data['jsonapi'] = jsonapi if !jsonapi.nil?
       data['meta'] = meta if !meta.nil?
       data
     end

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.14.0'
+    VERSION = '0.15.0'
   end
 end

data/spec/serializer_spec.rb

@@ -518,6 +518,14 @@ describe JSONAPI::Serializer do
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
       })
     end
+    it 'can include a top level jsonapi node' do
+      post = create(:post)
+      jsonapi_version = {'version' => '1.0'}
+      expect(JSONAPI::Serializer.serialize(post, jsonapi: jsonapi_version)).to eq({
+        'jsonapi' => {'version' => '1.0'},
+        'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
+      })
+    end
     it 'can include a top level meta node' do
       post = create(:post)
       meta = {authors: ['Yehuda Katz', 'Steve Klabnik'], copyright: 'Copyright 2015 Example Corp.'}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport