simple-json-api-serializer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ba77670aea7fe65f45dd044dd16de898d538b57
-  data.tar.gz: 6b3e6626f0a06154cfe61d992f63cd932593860f
+  metadata.gz: 636cf40e78aeed265d14f599509d00c8758b1e1f
+  data.tar.gz: 5a0032a58ffa31c720e0612ea32257168e682a78
 SHA512:
-  metadata.gz: 203f943f6ba18beb7b1a79a27b4507251f811aeca62bf2b1bc03fa1f30ead13ace20544ee051d502f7f6712649fb293b7b2d3e1235cd8c10da933270aad813a4
-  data.tar.gz: 9f8f084339a487a9c3cfb3a64861b333461d21c31386017700e796b1854599db992a4f2c8f1f7e1a9eb57cfeef05ba1dba74e66a879dff34a73a17f0987a1265
+  metadata.gz: 2b209862422dbcfe07fb35d895cff8e96e55530d3ddda03fb5d5256feead92d07e2932be77baa5d6e869aae6de5436407c1dc694bdf25a99d4aae7b248766b6c
+  data.tar.gz: e4907962aa34d9de5b90d04c3f91e41a1686c22bdb5de55cba63b1e3ef796976e905dbfdc7ea117fbc2dfc34c8799f99720cf4c8d7389f5776389a8cae7fc810

data/README.md

@@ -3,7 +3,7 @@
 * An extremely simple JSON Api serializer.
 * It supports serializing any Ruby object. 
 * It does not target a specific framework.
-* Does not (yet) support links and includes.
+* Does not (yet) support links.
 
 ## Installation
 
@@ -56,6 +56,13 @@ Which generates:
 }
 ```
 
+You can also use the `hashify` function:
+
+```ruby
+MyObjectSerializer.hashify(my_object)
+# { :data => { :type => "my-objects", :id => "1" } }
+```
+
 #### Configuring the output
 
 ```ruby
@@ -143,6 +150,14 @@ you can specify what method should be called to retrieve the foreign key with
 
 You can also specify the type of the related object with: `has_one :author, type: :user`.
 
+#### Includes
+
+You can add includes by adding passing an array of objects to the serialize function:
+
+```ruby
+comments_json_hash = CommentSerializer.hashify(comments)
+PostSerializer.serialize(post, include: comments_json_hash)
+```
 
 ## Development
 

data/lib/json_api.rb

@@ -0,0 +1,5 @@
+module JSONApi
+  require 'json_api/utils'
+  require 'json_api/object_serializer'
+  require 'json_api/object_serializer_definition'
+end

data/lib/json_api/version.rb

@@ -1,3 +1,3 @@
 module JSONApi
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-json-api-serializer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Marten Schilstra
@@ -84,13 +84,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/json_api.rb
 - lib/json_api/object_serializer.rb
 - lib/json_api/object_serializer_definition.rb
 - lib/json_api/relationship_serializer.rb
 - lib/json_api/utils.rb
 - lib/json_api/version.rb
-- lib/simple/json/api/serializer.rb
-- lib/simple/json/api/serializer/version.rb
 - simple-json-api-serializer.gemspec
 homepage: https://github.com/martndemus/simple-json-api-serializer
 licenses:

data/lib/simple/json/api/serializer.rb

@@ -1,11 +0,0 @@
-require "simple/json/api/serializer/version"
-
-module Simple
-  module Json
-    module Api
-      module Serializer
-        # Your code goes here...
-      end
-    end
-  end
-end

data/lib/simple/json/api/serializer/version.rb

@@ -1,9 +0,0 @@
-module Simple
-  module Json
-    module Api
-      module Serializer
-        VERSION = "0.1.0"
-      end
-    end
-  end
-end