jsonapi-serializers 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5be9e7db5c661af3677e1ddc65deccbf2e9aa53
-  data.tar.gz: 27457e4e784106807993d0374de6e131dd890a07
+  metadata.gz: a9515dd14ef21eec5f8fdd5011fa7e53d544c844
+  data.tar.gz: ae4aab29eb1048a70c4a004edd265007a992e991
 SHA512:
-  metadata.gz: 5a936a8f8d1b73c1aca370a7db10440a9ce9fe854828eecf69b7cb98c6b623f5e573e06638e5efee9f471117a38869b5678ef531262fed69d451e28cc882989b
-  data.tar.gz: f35e15687ce5b6038c47f721cbb4e242b57d34bcf7b338b422b46420f685e52bcb1d3fdf56aea399e8dc5815d208984ac8ab58acc8daef14013d67298b48f470
+  metadata.gz: f76752cbe2cdccb810f7ef9e4de4ace4dd97cacc45e841106d40abedd7401dca8b5326650f5c2994286cf9e5d70e9a57609b5cf4e5ac85b8fd92ba25916d0a7b
+  data.tar.gz: cf20e004587f630c21e92a1aa1247a0281df6f97d6d095199abc08f3ee7835ecc4a36bf7cc19d94170eea8409da473ad65ccba3eaf66b5159457e46d0061b501

data/README.md

@@ -77,7 +77,8 @@ Returns a hash:
     },
     "links": {
       "self": "/posts/1"
-    }
+    },
+    "relationships": {}
   }
 }
 ```
@@ -102,7 +103,8 @@ Returns:
       },
       "links": {
         "self": "/posts/1"
-      }
+      },
+      "relationships": {}
     },
     {
       "id": "2",
@@ -113,7 +115,8 @@ Returns:
       },
       "links": {
         "self": "/posts/2"
-      }
+      },
+      "relationships": {}
     }
   ]
 }
@@ -264,7 +267,7 @@ JSONAPI::Serializer.serialize(post, include: ['author', 'comments', 'comments.us
 Returns:
 
 ```json
-
+{
   "data": {
     "id": "1",
     "type": "posts",
@@ -273,7 +276,9 @@ Returns:
       "content": "Your first post"
     },
     "links": {
-      "self": "/posts/1",
+      "self": "/posts/1"
+    },
+    "relationships": {
       "author": {
         "self": "/posts/1/links/author",
         "related": "/posts/1/author",
@@ -303,7 +308,8 @@ Returns:
       },
       "links": {
         "self": "/users/1"
-      }
+      },
+      "relationships": {}
     },
     {
       "id": "1",
@@ -312,7 +318,9 @@ Returns:
         "content": "Have no fear, sers, your king is safe."
       },
       "links": {
-        "self": "/comments/1",
+        "self": "/comments/1"
+      },
+      "relationships": {
         "user": {
           "self": "/comments/1/links/user",
           "related": "/comments/1/user",
@@ -320,6 +328,10 @@ Returns:
             "type": "users",
             "id": "2"
           }
+        },
+        "post": {
+          "self": "/comments/1/links/post",
+          "related": "/comments/1/post"
         }
       }
     },
@@ -331,19 +343,20 @@ Returns:
       },
       "links": {
         "self": "/users/2"
-      }
+      },
+      "relationships": {}
     }
   ]
 }
 ```
 
 Notice a few things:
-* The [primary data](http://jsonapi.org/format/#document-structure-top-level) now includes "linkage" information for each relationship that was included.
+* The [primary data](http://jsonapi.org/format/#document-structure-top-level) relationships now include "linkage" information for each relationship that was included.
 * The related objects themselves are loaded in the top-level `included` member.
 * The related objects _also_ include "linkage" information when a deeper relationship is also present in the compound document. This is a very powerful feature of the JSON:API spec, and allows you to deeply link complicated relationships all in the same document and in a single HTTP response. JSONAPI::Serializers automatically includes the correct linkage information for whatever `include` paths you specify. This conforms to this part of the spec:
     
-  > Note: Resource linkage in a compound document allows a client to link together all of the included resource objects without having to GET any relationship URLs.
-  > [JSON:API Resource Relationships](http://jsonapi.org/format/#document-structure-resource-relationships)
+  > Note: Full linkage ensures that included resources are related to either the primary data (which could be resource objects or resource identifier objects) or to each other.
+  > [JSON:API Compound Documents](http://jsonapi.org/format/#document-structure-compound-documents)
 
 #### Relationship path handling
  

data/lib/jsonapi-serializers/serializer.rb

@@ -79,7 +79,10 @@ module JSONAPI
       def links
         data = {}
         data.merge!({'self' => self_link}) if self_link
+      end
 
+      def relationships
+        data = {}
         # Merge in data for has_one relationships.
         has_one_relationships.each do |attribute_name, object|
           formatted_attribute_name = format_name(attribute_name)
@@ -260,7 +263,6 @@ module JSONAPI
         # Given all the primary objects (either the single root object or collection of objects),
         # recursively search and find related associations that were specified as includes.
         objects = options[:is_collection] ? objects.to_a : [objects]
-        serializers = []
         objects.compact.each do |obj|
           # Use the mutability of relationship_data as the return datastructure to take advantage
           # of the internal special merging logic.
@@ -296,6 +298,7 @@ module JSONAPI
       # http://jsonapi.org/format/#document-structure-resource-objects
       data.merge!({'attributes' => serializer.attributes}) if !serializer.attributes.nil?
       data.merge!({'links' => serializer.links}) if !serializer.links.nil?
+      data.merge!({'relationships' => serializer.relationships}) if !serializer.relationships.nil?
       data.merge!({'meta' => serializer.meta}) if !serializer.meta.nil?
       data
     end

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/spec/serializer_spec.rb

@@ -25,6 +25,7 @@ describe JSONAPI::Serializer do
         'links' => {
           'self' => '/posts/1',
         },
+        'relationships' => {},
       })
     end
     it 'can serialize primary data for a simple object with a long name' do
@@ -38,6 +39,8 @@ describe JSONAPI::Serializer do
         },
         'links' => {
           'self' => '/long-comments/1',
+        },
+        'relationships' => {
           'user' => {
             'self' => '/long-comments/1/links/user',
             'related' => '/long-comments/1/user',
@@ -62,6 +65,7 @@ describe JSONAPI::Serializer do
         'links' => {
           'self' => '/posts/1',
         },
+        'relationships' => {},
         'meta' => {
           'copyright' => 'Copyright 2015 Example Corp.',
           'authors' => [
@@ -83,6 +87,8 @@ describe JSONAPI::Serializer do
           },
           'links' => {
             'self' => '/posts/1',
+          },
+          'relationships' => {
             # Both to-one and to-many links are present, but neither include linkage:
             'author' => {
               'self' => '/posts/1/links/author',
@@ -113,6 +119,8 @@ describe JSONAPI::Serializer do
           },
           'links' => {
             'self' => '/posts/1',
+          },
+          'relationships' => {
             'author' => {
               'self' => '/posts/1/links/author',
               'related' => '/posts/1/author',
@@ -145,6 +153,8 @@ describe JSONAPI::Serializer do
           },
           'links' => {
             'self' => '/posts/1',
+          },
+          'relationships' => {
             'author' => {
               'self' => '/posts/1/links/author',
               'related' => '/posts/1/author',
@@ -180,6 +190,8 @@ describe JSONAPI::Serializer do
           },
           'links' => {
             'self' => '/posts/1',
+          },
+          'relationships' => {
             'author' => {
               'self' => '/posts/1/links/author',
               'related' => '/posts/1/author',
@@ -213,6 +225,8 @@ describe JSONAPI::Serializer do
           },
           'links' => {
             'self' => '/posts/1',
+          },
+          'relationships' => {
             'author' => {
               'self' => '/posts/1/links/author',
               'related' => '/posts/1/author',
@@ -414,7 +428,7 @@ describe JSONAPI::Serializer do
         ],
       }
       includes = ['long-comments.post.author']
-      actual_data = JSONAPI::Serializer.serialize(post, include: ['long-comments.post.author'])
+      actual_data = JSONAPI::Serializer.serialize(post, include: includes)
       # Multiple expectations for better diff output for debugging.
       expect(actual_data['data']).to eq(expected_data['data'])
       expect(actual_data['included']).to eq(expected_data['included'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-16 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,3 +132,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/factory.rb
 - spec/support/serializers.rb
+has_rdoc: