jsonapi-serializers 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e698b9154b539960338d5350474f81c77aa0c1e
-  data.tar.gz: 08be38cb9c93ceb3812d05d0ce29e3d4cd318d32
+  metadata.gz: e9cf46e555c07d0768d46875258efd3ca3dbb900
+  data.tar.gz: 7f0939ef5407ab803142ebe688e534efecf4514b
 SHA512:
-  metadata.gz: b2798644c46503bc5ea943cf245b855a132667ef2370219ae32b73be1629bdbb27154154b778d2c5528ae823ef96ce296e9f1e199e447e7ac5936b5ec01fca10
-  data.tar.gz: 8938cae3c0014f386449736e7ba7f5a703948ecb084814dcdafd2c6bc1ec925890d7296d5374845926a547f20f4825b9a5bddcb9ea0c0b8e69f92a36b6149331
+  metadata.gz: df2806a436090f5e99edfbca11524aa142b378e05b89c4977d916a5c77580baf9f91aeec957565e4320414ce462a9a048e60907a26d6035fc04a85342a143e7b
+  data.tar.gz: 394f4d441286ee6ab265c41be01937664ebee6c7541ebfc47d8f1f888f6fc51e8a223ad5d67ca4287bab6d185c26a556a94221264535eabcd0e892eb9c2d0238

data/README.md

@@ -296,6 +296,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.
 
+### Top-level metadata
+
+You can pass a `meta` argument to specify top-level metadata:
+
+```ruby
+JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
+```
+
 ## Relationships
 
 You can easily specify relationships with the `has_one` and `has_many` directives.
@@ -510,6 +518,7 @@ end
 
 ## Release notes
 
+* v0.3.0: Add top-level `meta` support.
 * v0.2.6: Add `base_url` support.
 * v0.2.5: Allow disabling ambiguous collection checks for Sequel support.
 * v0.2.4: Improve handling for nil relationship links.

data/lib/jsonapi-serializers/serializer.rb

@@ -222,6 +222,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[:meta] = options.delete('meta') || options[:meta]
 
       # Normalize includes.
       includes = options[:include]
@@ -273,6 +274,7 @@ module JSONAPI
       result = {
         'data' => primary_data,
       }
+      result['meta'] = options[:meta] if options[:meta]
 
       # If 'include' relationships are given, recursively find and include each object.
       if includes

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.2.6'
+    VERSION = '0.3.0'
   end
 end

data/spec/serializer_spec.rb

@@ -333,6 +333,14 @@ describe JSONAPI::Serializer do
         '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.'}
+      expect(JSONAPI::Serializer.serialize(post, meta: meta)).to eq({
+        'meta' => meta,
+        'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
+      })
+    end
     it 'can serialize a single object with an `each` method by passing skip_collection_check: true' do
       post = create(:post)
       post.define_singleton_method(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Pure Ruby readonly serializers for the JSON:API spec.