simple-json-api-serializer 0.5.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31c823d362c1724ed551195ad91cee3a58aa45a5
-  data.tar.gz: 6c9c9528d78dd58bd850415360a55881107eb501
+  metadata.gz: 73e1d5468c21f1ebba9494d32054c89f112d071b
+  data.tar.gz: abe7e22604cdffa704f3c87a52b8a462880854e6
 SHA512:
-  metadata.gz: 7e66b11275359cd4d252a0e036e73e7a3c27ebcafad2198e5dc4a4ae840298e154564a549fb4c4c5cf51c6c922d31118eeb1266a39428a11154ba0b7e4bd40ba
-  data.tar.gz: 985f81ac44f84ec7f61f971fbe291f986a68b2e6620fafb085450affb1bf5c52f74e4b6dd42595b19c72f0ce6c7a8c9fee5d874054a33a9e64c97cf6483b01db
+  metadata.gz: 75b165c7f5e8930893f1b059b665cc56cf89e99f7a3f06385b55b56429246daaf86666b0b5bb704adcf4397ac1c9331fe40700feb06afce28f4cf0b58570efd3
+  data.tar.gz: ccef0b3e809c4ec57b1ca1d75e246dd613d7637efc11f72c5541cd60ac097b407f2506ed0c2a028378c66eaea8c4e4d6df22989d7be9ab4695903141e535159c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple-json-api-serializer (0.5.4)
+    simple-json-api-serializer (1.0.0)
       activesupport (~> 4.2)
 
 GEM

data/README.md

@@ -1,9 +1,8 @@
 # Simple JSONApi::Serializer
 
 * An extremely simple JSON Api serializer.
-* It supports serializing any Ruby object. 
+* It supports serializing any Ruby object.
 * It does not target a specific framework.
-* Does not (yet) support links.
 
 ## Installation
 
@@ -68,7 +67,7 @@ MyObjectSerializer.hashify(my_object)
 ```ruby
 class PersonSerializer < JSONApi::ObjectSerializerDefinition
   id_attribute :ssn
-  
+
   attributes :first_name, :last_name
 end
 
@@ -98,7 +97,7 @@ Generates:
 ```ruby
 class PostSerializer < JSONApi::ObjectSerializerDefinition
   attributes :title, :content
-  
+
   has_one  :author
   has_many :comments
 end
@@ -107,7 +106,7 @@ Post = Struct.new(:id, :title, :content, :author, :comments) do
   def author_id
     author.id
   end
-  
+
   def comment_ids
     comments.map(&:id)
   end
@@ -134,10 +133,9 @@ Generates:
         "data": { "type": "authors", "id": "42" },
       },
       "comments": {
-        "data": [
-          { "type": "comments", "id": "1" },
-          { "type": "comments", "id": "2" }
-        ]
+        "links": {
+          "related": "/posts/1/comments"
+        }
       }
     }
   }
@@ -146,9 +144,15 @@ Generates:
 
 If your object does not abide by the `_id` or `_ids` convention for relations,
 you can specify what method should be called to retrieve the foreign key with
-`has_one  :author, foreign_key: :username`
+`has_one :author, foreign_key: :username`
+
+You can also specify the type of the related object with:
+`has_one :author, type: :user`.
 
-You can also specify the type of the related object with: `has_one :author, type: :user`.
+By default `has_one` relationships will include a `data` object but not `links`
+and `has_many` relationships will include a `links` object but not `data`. This
+can be customized by setting the `links` and `data` options to `true` or
+`false`.
 
 #### Includes
 

data/lib/json_api/object_serializer.rb

@@ -2,7 +2,6 @@ require 'active_support/json'
 require 'json_api/utils'
 require 'json_api/relationship_serializer'
 
-
 module JSONApi
   class ObjectSerializer
     def serialize(object, **options)
@@ -40,6 +39,10 @@ module JSONApi
         result[:relationships] = relationships_for(object, options)
       end
 
+      if options[:links] == true
+        result[:links] = links_for(object, options)
+      end
+
       result
     end
 
@@ -57,9 +60,15 @@ module JSONApi
 
     def relationships_for(object, options)
       relationship_serializer = RelationshipSerializer.new
+
+      defaults = {
+        parent_type: type_for(object, options),
+        base_url:    options[:base_url]
+      }
+
       options[:relationships].each_with_object({}) do |relationship, hash|
         relationship_key = Utils.canonicalize_attribute_name(relationship[:name])
-        data = relationship_serializer.as_json(object, relationship)
+        data = relationship_serializer.as_json(object, defaults.merge(relationship))
         hash[relationship_key] = data unless data.nil?
       end
     end
@@ -71,6 +80,13 @@ module JSONApi
       end
     end
 
+    def links_for(object, **options)
+      id   = id_for(object, options)
+      type = type_for(object, options)
+
+      { self: "#{options[:base_url] || ""}/#{type}/#{id}" }
+    end
+
     def id_for(object, **options)
       id_attribute = options[:id_attribute] || :id
       canonicalize_id(object.send(id_attribute))

data/lib/json_api/object_serializer_definition.rb

@@ -17,6 +17,7 @@ module JSONApi
         specialization.attributes(*attributes)
         specialization.relationships(*relationships)
         specialization.id_attribute(id_attribute)
+        specialization.base_url(base_url)
       end
 
       def attributes(*attrs)
@@ -28,6 +29,10 @@ module JSONApi
         @id_attribute = attr
       end
 
+      def base_url(url = @base_url)
+        @base_url = url
+      end
+
       def relationship(name, **config)
         config[:name] = name
         relationships(config)

data/lib/json_api/relationship_serializer.rb

@@ -3,17 +3,20 @@ require 'json_api/utils'
 module JSONApi
   class RelationshipSerializer
     def as_json(object, **options)
-      data =
-        if options[:to] == :many
-          ToManySerializer.new.data_for(object, options)
-        else
-          ToOneSerializer.new.data_for(object, options)
-        end
-
-      if data.nil? || data == []
+      serializer =
+        (options[:to] == :many ? ToManySerializer : ToOneSerializer).new
+
+      data  = serializer.data_for(object, options)
+      links = serializer.links_for(object, options)
+
+      result = {}
+      result[:data]  = data  unless data.nil?  || data.empty?
+      result[:links] = links unless links.nil? || links.empty?
+
+      if result.empty?
         nil
       else
-        { data: data }
+        result
       end
     end
 
@@ -56,10 +59,21 @@ module JSONApi
       end
 
       def data_for(object, options)
+        return if options[:data] != true
+
         ids = relationship_for(object, options)
         ids.map { |id| resource_identifier_for(type_for(object, options), id) }
            .compact
       end
+
+      def links_for(object, options)
+        return if options[:links] == false
+
+        id   = Utils.canonicalize_id(object.send(options[:id_attribute] || :id))
+        type = options[:type] || options[:name]
+
+        { related: "#{options[:base_url] || ""}/#{options[:parent_type]}/#{id}/#{type}" }
+      end
     end
 
     class ToOneSerializer < RelationshipSerializer
@@ -68,9 +82,20 @@ module JSONApi
       end
 
       def data_for(object, options)
+        return if options[:data] == false
+
         id = relationship_for(object, options)
         resource_identifier_for(type_for(object, options), id)
       end
+
+      def links_for(object, options)
+        return if options[:links] != true
+
+        id   = Utils.canonicalize_id(object.send(options[:id_attribute] || :id))
+        type = (options[:type] || options[:name]).to_s.singularize
+
+        { related: "#{options[:base_url] || ""}/#{options[:parent_type]}/#{id}/#{type}" }
+      end
     end
   end
 end

data/lib/json_api/version.rb

@@ -1,3 +1,3 @@
 module JSONApi
-  VERSION = '0.5.4'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-json-api-serializer
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Marten Schilstra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport