jsonapi-serializers 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9515dd14ef21eec5f8fdd5011fa7e53d544c844
-  data.tar.gz: ae4aab29eb1048a70c4a004edd265007a992e991
+  metadata.gz: 0218413bec5edb7e7793360856d93a507c4ff6a3
+  data.tar.gz: 6a363b7e853a348168aa9bb8d6f6018254d88ee6
 SHA512:
-  metadata.gz: f76752cbe2cdccb810f7ef9e4de4ace4dd97cacc45e841106d40abedd7401dca8b5326650f5c2994286cf9e5d70e9a57609b5cf4e5ac85b8fd92ba25916d0a7b
-  data.tar.gz: cf20e004587f630c21e92a1aa1247a0281df6f97d6d095199abc08f3ee7835ecc4a36bf7cc19d94170eea8409da473ad65ccba3eaf66b5159457e46d0061b501
+  metadata.gz: af9bb1074fe08168f70b1c5ecb1907aa34683fea230609e3334d974a4c45e9add97fb8492271cb3b488eb11ae2a5ca71528456f1437289a5302905de767c6bcf
+  data.tar.gz: 8eebd11b6ae280466788c87836156dcfe15b078b4eb27a24b3f3568cc90d0e8d460226045edaf5958bcee9f025ee01274fd926a6bad1650de609d21d9bf3ae62

data/README.md

@@ -3,10 +3,9 @@
 [![Build Status](https://travis-ci.org/fotinakis/jsonapi-serializers.svg?branch=master)](https://travis-ci.org/fotinakis/jsonapi-serializers)
 [![Gem Version](https://badge.fury.io/rb/jsonapi-serializers.svg)](http://badge.fury.io/rb/jsonapi-serializers)
 
-
 JSONAPI::Serializers is a simple library for serializing Ruby objects and their relationships into the [JSON:API format](http://jsonapi.org/format/).
 
-As of writing, the JSON:API spec is approaching v1 and still undergoing changes. This library supports RC3+ and aims to keep up with the continuing development changes.
+This library is up-to-date with the finalized v1 JSON API spec.
 
 * [Features](#features)
 * [Installation](#installation)
@@ -53,7 +52,7 @@ require 'jsonapi-serializers'
 
 class PostSerializer
   include JSONAPI::Serializer
-  
+
   attribute :title
   attribute :content
 end
@@ -280,17 +279,21 @@ Returns:
     },
     "relationships": {
       "author": {
-        "self": "/posts/1/links/author",
-        "related": "/posts/1/author",
-        "linkage": {
+        "links": {
+          "self": "/posts/1/links/author",
+          "related": "/posts/1/author"
+        },
+        "data": {
           "type": "users",
           "id": "1"
         }
       },
       "comments": {
-        "self": "/posts/1/links/comments",
-        "related": "/posts/1/comments",
-        "linkage": [
+        "links": {
+          "self": "/posts/1/links/comments",
+          "related": "/posts/1/comments"
+        },
+        "data": [
           {
             "type": "comments",
             "id": "1"
@@ -322,16 +325,20 @@ Returns:
       },
       "relationships": {
         "user": {
-          "self": "/comments/1/links/user",
-          "related": "/comments/1/user",
-          "linkage": {
+          "links": {
+            "self": "/comments/1/links/user",
+            "related": "/comments/1/user"
+          },
+          "data": {
             "type": "users",
             "id": "2"
           }
         },
         "post": {
-          "self": "/comments/1/links/post",
-          "related": "/comments/1/post"
+          "links": {
+            "self": "/comments/1/links/post",
+            "related": "/comments/1/post"
+          }
         }
       }
     },
@@ -353,13 +360,13 @@ Returns:
 Notice a few things:
 * 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:
-    
+* The related objects _also_ include "linkage" data 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 data for whatever `include` paths you specify. This conforms to this part of the spec:
+
   > 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)
+  > [JSON:API Compound Documents](http://jsonapi.org/format/#document-compound-documents)
 
 #### Relationship path handling
- 
+
 The `include` param also accepts a string of [relationship paths](http://jsonapi.org/format/#fetching-includes), ie. `include: 'author,comments,comments.user'` so you can pass an `?include` query param directly through to the serialize method. Be aware that letting users pass arbitrary relationship paths might introduce security issues depending on your authorization setup, where a user could `include` a relationship they might not be authorized to see directly. Be aware of what you allow API users to include.
 
 ## Rails example
@@ -425,6 +432,10 @@ end
 * Support for the `fields` spec is planned, would love a PR contribution for this.
 * Support for pagination/sorting is unlikely to be supported because it would likely involve coupling to ActiveRecord, but please open an issue if you have ideas of how to support this generically.
 
+## Release notes
+
+* v0.2.0: Initial release with support for the final v1 JSON API spec.
+
 ## Contributing
 
 1. Fork it ( https://github.com/fotinakis/jsonapi-serializers/fork )
@@ -432,3 +443,5 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+Throw a ★ on it! :)

data/lib/jsonapi-serializers/serializer.rb

@@ -87,19 +87,21 @@ module JSONAPI
         has_one_relationships.each do |attribute_name, object|
           formatted_attribute_name = format_name(attribute_name)
           data[formatted_attribute_name] = {
-            'self' => relationship_self_link(attribute_name),
-            'related' => relationship_related_link(attribute_name),
+            'links' => {
+              'self' => relationship_self_link(attribute_name),
+              'related' => relationship_related_link(attribute_name),
+            },
           }
           if @_include_linkages.include?(formatted_attribute_name)
             if object.nil?
               # Spec: Resource linkage MUST be represented as one of the following:
               # - null for empty to-one relationships.
               # http://jsonapi.org/format/#document-structure-resource-relationships
-              data[formatted_attribute_name].merge!({'linkage' => nil})
+              data[formatted_attribute_name].merge!({'data' => nil})
             else
               related_object_serializer = JSONAPI::Serializer.find_serializer(object)
               data[formatted_attribute_name].merge!({
-                'linkage' => {
+                'data' => {
                   'type' => related_object_serializer.type.to_s,
                   'id' => related_object_serializer.id.to_s,
                 },
@@ -112,19 +114,21 @@ module JSONAPI
         has_many_relationships.each do |attribute_name, objects|
           formatted_attribute_name = format_name(attribute_name)
           data[formatted_attribute_name] = {
-            'self' => relationship_self_link(attribute_name),
-            'related' => relationship_related_link(attribute_name),
+            'links' => {
+              'self' => relationship_self_link(attribute_name),
+              'related' => relationship_related_link(attribute_name),
+            },
           }
           # Spec: Resource linkage MUST be represented as one of the following:
           # - an empty array ([]) for empty to-many relationships.
           # - an array of linkage objects for non-empty to-many relationships.
           # http://jsonapi.org/format/#document-structure-resource-relationships
           if @_include_linkages.include?(formatted_attribute_name)
-            data[formatted_attribute_name].merge!({'linkage' => []})
+            data[formatted_attribute_name].merge!({'data' => []})
             objects = objects || []
             objects.each do |obj|
               related_object_serializer = JSONAPI::Serializer.find_serializer(obj)
-              data[formatted_attribute_name]['linkage'] << {
+              data[formatted_attribute_name]['data'] << {
                 'type' => related_object_serializer.type.to_s,
                 'id' => related_object_serializer.id.to_s,
               }

data/lib/jsonapi-serializers/version.rb

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

data/spec/serializer_spec.rb

@@ -42,12 +42,16 @@ describe JSONAPI::Serializer do
         },
         'relationships' => {
           'user' => {
-            'self' => '/long-comments/1/links/user',
-            'related' => '/long-comments/1/user',
+            'links' => {
+              'self' => '/long-comments/1/links/user',
+              'related' => '/long-comments/1/user',
+            },
           },
           'post' => {
-            'self' => '/long-comments/1/links/post',
-            'related' => '/long-comments/1/post',
+            'links' => {
+              'self' => '/long-comments/1/links/post',
+              'related' => '/long-comments/1/post',
+            },
           },
         },
       })
@@ -91,12 +95,16 @@ describe JSONAPI::Serializer do
           'relationships' => {
             # Both to-one and to-many links are present, but neither include linkage:
             'author' => {
-              'self' => '/posts/1/links/author',
-              'related' => '/posts/1/author',
+              'links' => {
+                'self' => '/posts/1/links/author',
+                'related' => '/posts/1/author',
+              },
             },
             'long-comments' => {
-              'self' => '/posts/1/links/long-comments',
-              'related' => '/posts/1/long-comments',
+              'links' => {
+                'self' => '/posts/1/links/long-comments',
+                'related' => '/posts/1/long-comments',
+              },
             },
           },
         })
@@ -122,17 +130,21 @@ describe JSONAPI::Serializer do
           },
           'relationships' => {
             'author' => {
-              'self' => '/posts/1/links/author',
-              'related' => '/posts/1/author',
+              'links' => {
+                'self' => '/posts/1/links/author',
+                'related' => '/posts/1/author',
+              },
               # Spec: Resource linkage MUST be represented as one of the following:
               # - null for empty to-one relationships.
               # http://jsonapi.org/format/#document-structure-resource-relationships
-              'linkage' => nil,
+              'data' => nil,
             },
             'long-comments' => {
-              'self' => '/posts/1/links/long-comments',
-              'related' => '/posts/1/long-comments',
-              'linkage' => [],
+              'links' => {
+                'self' => '/posts/1/links/long-comments',
+                'related' => '/posts/1/long-comments',
+              },
+              'data' => [],
             },
           },
         })
@@ -156,20 +168,24 @@ describe JSONAPI::Serializer do
           },
           'relationships' => {
             'author' => {
-              'self' => '/posts/1/links/author',
-              'related' => '/posts/1/author',
+              'links' => {
+                'self' => '/posts/1/links/author',
+                'related' => '/posts/1/author',
+              },
               # Spec: Resource linkage MUST be represented as one of the following:
               # - a 'linkage object' (defined below) for non-empty to-one relationships.
               # http://jsonapi.org/format/#document-structure-resource-relationships
-              'linkage' => {
+              'data' => {
                 'type' => 'users',
                 'id' => '1',
               },
             },
             'long-comments' => {
-              'self' => '/posts/1/links/long-comments',
-              'related' => '/posts/1/long-comments',
-              'linkage' => [],
+              'links' => {
+                'self' => '/posts/1/links/long-comments',
+                'related' => '/posts/1/long-comments',
+              },
+              'data' => [],
             },
           },
         })
@@ -193,17 +209,21 @@ describe JSONAPI::Serializer do
           },
           'relationships' => {
             'author' => {
-              'self' => '/posts/1/links/author',
-              'related' => '/posts/1/author',
-              'linkage' => nil,
+              'links' => {
+                'self' => '/posts/1/links/author',
+                'related' => '/posts/1/author',
+              },
+              'data' => nil,
             },
             'long-comments' => {
-              'self' => '/posts/1/links/long-comments',
-              'related' => '/posts/1/long-comments',
+              'links' => {
+                'self' => '/posts/1/links/long-comments',
+                'related' => '/posts/1/long-comments',
+              },
               # Spec: Resource linkage MUST be represented as one of the following:
               # - an empty array ([]) for empty to-many relationships.
               # http://jsonapi.org/format/#document-structure-resource-relationships
-              'linkage' => [],
+              'data' => [],
             },
           },
         })
@@ -228,17 +248,21 @@ describe JSONAPI::Serializer do
           },
           'relationships' => {
             'author' => {
-              'self' => '/posts/1/links/author',
-              'related' => '/posts/1/author',
-              'linkage' => nil,
+              'links' => {
+                'self' => '/posts/1/links/author',
+                'related' => '/posts/1/author',
+              },
+              'data' => nil,
             },
             'long-comments' => {
-              'self' => '/posts/1/links/long-comments',
-              'related' => '/posts/1/long-comments',
+              'links' => {
+                'self' => '/posts/1/links/long-comments',
+                'related' => '/posts/1/long-comments',
+              },
               # Spec: Resource linkage MUST be represented as one of the following:
               # - an array of linkage objects for non-empty to-many relationships.
               # http://jsonapi.org/format/#document-structure-resource-relationships
-              'linkage' => [
+              'data' => [
                 {
                   'type' => 'long-comments',
                   'id' => '1',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport