jsonapi-serializable 0.1.1.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 366782323070f412105463eeffabe870128e49c6
+  data.tar.gz: d80674ddfaa130ea341f286c3f12c87ef5e75016
+SHA512:
+  metadata.gz: 1bb696480c7e20a3dbe1b4d1525301bb0203b7fbe444268a7fd96bb8d684cdc8bddf8e9ed74161b261375f88e1962f8d1f7363647a544f7b040a9aa73aafdd2f
+  data.tar.gz: 9d17c652fc934460c7d1ef1249d1c32336671ce3fd26ade2acb0d430c98b24f40b56086d719ac481e77a6b6744f1225071564c5101f74b72b2e65b47d3f42160

data/README.md

@@ -0,0 +1,80 @@
+# jsonapi-serializable
+Ruby gem for building and rendering [JSON API](http://jsonapi.org) resources.
+Built upon the [jsonapi-renderer](https://github.com/beauby/jsonapi) gem.
+
+## Installation
+```ruby
+# In Gemfile
+gem 'jsonapi-serializable'
+```
+then
+```
+$ bundle
+```
+or manually via
+```
+$ gem install jsonapi-serializable
+```
+
+## Usage
+
+First, require the gem:
+```ruby
+require 'jsonapi/serializable'
+```
+
+Then, define some resource classes:
+```ruby
+class PostResource < JSONAPI::Serializable::Resource
+  type 'posts'
+
+  id do
+    @post.id.to_s
+  end
+
+  attribute :title do
+    @post.title
+  end
+
+  attribute :date do
+    @post.date
+  end
+
+  relationship :author do
+    link(:self) do
+      href @url_helper.link_for_rel('posts', @post.id, 'author')
+      meta link_meta: 'some meta'
+    end
+    link(:related) { @url_helper.link_for_res('users', @post.author.id) }
+    data do
+      if @post.author.nil?
+        nil
+      else
+        UserResource.new(user: @post.author, url_helper: @url_helper)
+      end
+    end
+    meta do
+      { relationship_meta: 'some meta' }
+    end
+  end
+
+  meta do
+    { resource_meta: 'some meta' }
+  end
+
+  link(:self) do
+    @url_helper.link_for_res('posts', @post.id)
+  end
+end
+```
+Finally, build your resources from your models and render them:
+```ruby
+# post = some post model
+# UrlHelper is some helper class
+resource = PostResource.new(post: post, url_helper: UrlHelper)
+document = JSONAPI.render(resource)
+```
+
+## License
+
+jsonapi-serializable is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/jsonapi/serializable/error.rb

@@ -0,0 +1,82 @@
+require 'jsonapi/serializable/link'
+require 'jsonapi/serializable/error_dsl'
+
+module JSONAPI
+  module Serializable
+    class ErrorSource
+      def self.as_jsonapi(params = {})
+        self.class.new(params).as_jsonapi
+      end
+
+      def initialize(params = {})
+        params.each { |k, v| instance_variable_set("@#{k}", v) }
+        @_data = {}
+      end
+
+      def as_jsonapi
+        @_data
+      end
+
+      private
+
+      def method_missing(name, arg)
+        @_data[name] = arg
+      end
+    end
+
+    class Error
+      include ErrorDSL
+
+      class << self
+        attr_accessor :id, :id_block, :status, :status_block, :code,
+                      :code_block, :title, :title_block, :detail, :detail_block,
+                      :meta, :meta_block, :source_block, :link_blocks
+      end
+
+      self.link_blocks = {}
+
+      def self.inherited(klass)
+        super
+        klass.link_blocks = self.class.link_blocks.dup
+      end
+
+      def initialize(params = {})
+        @_param_hash = params
+        params.each { |k, v| instance_variable_set("@#{k}", v) }
+      end
+
+      def as_jsonapi
+        hash = links.any? ? { links: links } : {}
+        [:id, :status, :code, :title, :detail, :meta, :source]
+          .each_with_object(hash) do |key, h|
+          value = send(key)
+          h[key] = value unless value.nil?
+        end
+      end
+
+      private
+
+      def links
+        @_links ||= self.class.link_blocks.each_with_object({}) do |(k, v), h|
+          h[k] = Link.as_jsonapi(@_param_hash, v)
+        end
+      end
+
+      def source
+        @_source ||= ErrorSource.as_jsonapi(@_param_hash,
+                                            self.class.source_block)
+      end
+
+      [:id, :status, :code, :title, :detail, :meta].each do |key|
+        define_method(key) do
+          unless instance_variable_defined?("@#{key}")
+            value = self.class.send(key) ||
+                    instance_eval(self.class.send("#{key}_block"))
+            instance_variable_set("@#{key}", value)
+          end
+          instance_variable_get("@#{key}")
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/error_dsl.rb

@@ -0,0 +1,26 @@
+module JSONAPI
+  module Serializable
+    module ErrorDSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        [:id, :status, :code, :title, :detail, :meta].each do |key|
+          define_method(key) do |*args, &block|
+            send("@#{key}=", args[0])
+            send("@#{key}_block=", block)
+          end
+        end
+
+        def link(name, &block)
+          link_blocks[name] = block
+        end
+
+        def source(&block)
+          self.source_block = block
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/link.rb

@@ -0,0 +1,65 @@
+module JSONAPI
+  module Serializable
+    class Link
+      def self.as_jsonapi(param_hash = {}, &block)
+        new(param_hash, &block).as_jsonapi
+      end
+
+      def initialize(param_hash = {}, &block)
+        param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+        static_value = instance_eval(&block)
+        if static_value.is_a?(Hash)
+          @_hash = static_value
+        elsif static_value.is_a?(String)
+          @_href = static_value
+        end
+      end
+
+      # @overload href(value)
+      #   Declare the href for this link.
+      #   @param [String] value The value of href.
+      #
+      #   @example
+      #     href "http://api.example.com/users/#{@user.id}"
+      #
+      # @overload href(&block)
+      #   Declare the href for this link.
+      #   @yieldreturn [String] The value of href.
+      #
+      #   @example
+      #     href do
+      #       "http://api.example.com/users/#{@user.id}"
+      #     end
+      def href(value = nil, &block)
+        @_href = block.nil? ? value : instance_eval(&block)
+      end
+
+      # @overload meta(value)
+      #   Declare the meta information for this link.
+      #   @param [Hash] value The meta information hash.
+      #
+      #   @example
+      #     meta paginated: true
+      #
+      # @overload meta(&block)
+      #   Declare the meta information for this link.
+      #   @yieldreturn [String] The meta information hash.
+      #   @example
+      #     meta do
+      #       { paginated: true }
+      #     end
+      def meta(value = nil, &block)
+        @_meta = block.nil? ? value : instance_eval(&block)
+      end
+
+      def as_jsonapi
+        @_hash ||=
+          if @_meta.nil?
+            @_href
+          else
+            { href: @_href, meta: @_meta }
+          end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/relationship.rb

@@ -0,0 +1,42 @@
+require 'jsonapi/serializable/link'
+require 'jsonapi/serializable/relationship_dsl'
+
+module JSONAPI
+  module Serializable
+    class Relationship
+      include RelationshipDSL
+
+      def initialize(param_hash = {}, &block)
+        param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+        @_param_hash = param_hash
+        @_links = {}
+        instance_eval(&block)
+      end
+
+      def as_jsonapi(included)
+        hash = {}
+        hash[:links] = @_links if @_links.any?
+        hash[:meta] = @_meta unless @_meta.nil?
+        hash[:data] = eval_linkage_data if included && (@_linkage_data_block ||
+                                                        @_data_block)
+
+        hash
+      end
+
+      private
+
+      def eval_linkage_data
+        @_linkage_data ||=
+          if @_linkage_data_block
+            @_linkage_data_block.call
+          elsif data.respond_to?(:each)
+            data.map { |res| { type: res.jsonapi_type, id: res.jsonapi_id } }
+          elsif data.nil?
+            nil
+          else
+            { type: data.jsonapi_type, id: data.jsonapi_id }
+          end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/relationship_dsl.rb

@@ -0,0 +1,82 @@
+module JSONAPI
+  module Serializable
+    module RelationshipDSL
+      # Declare/access the data for this relationship.
+      #
+      # @yieldreturn [JSONAPI::Serializable::Resource,
+      #               Array<JSONAPI::Serializable::Resource>,
+      #               nil] The data for this relationship.
+      #
+      # @example
+      #   data :posts do
+      #     @user.posts.map { |p| PostResource.new(post: p) }
+      #   end
+      #
+      # @example
+      #   data :author do
+      #     @user.author && UserResource.new(user: @user.author)
+      #   end
+      def data(&block)
+        if block.nil?
+          @_data ||= (@_data_block && @_data_block.call)
+        else
+          @_data_block = block
+        end
+      end
+
+      # Declare the linkage data for this relationship. Useful when linkage
+      #   can be computed in a more efficient way than the data itself.
+      #
+      # @yieldreturn [Hash] The block to compute linkage data.
+      #
+      # @example
+      #   linkage_data do
+      #     { id: @post.author_id.to_s, type: 'users' }
+      #   end
+      def linkage_data(&block)
+        @_linkage_data_block = block
+      end
+
+      # @overload meta(value)
+      #   Declare the meta information for this relationship.
+      #   @param [Hash] value The meta information hash.
+      #
+      #   @example
+      #     meta paginated: true
+      #
+      # @overload meta(&block)
+      #   Declare the meta information for this relationship.
+      #   @yieldreturn [Hash] The meta information hash.
+      #
+      #   @example
+      #     meta do
+      #       { paginated: true }
+      #     end
+      def meta(value = nil)
+        @_meta = value || yield
+      end
+
+      # Declare a link for this relationship. The properties of the link are set
+      #   by providing a block in which the DSL methods of
+      #   +JSONAPI::Serializable::Link+ are called.
+      # @see JSONAPI::Serialiable::Link
+      #
+      # @param [Symbol] name The key of the link.
+      # @yieldreturn [Hash, String, nil] The block to compute the value, if any.
+      #
+      # @example
+      #   link(:self) do
+      #     "http://api.example.com/users/#{@user.id}/relationships/posts"
+      #   end
+      #
+      # @example
+      #    link(:related) do
+      #      href "http://api.example.com/users/#{@user.id}/posts"
+      #      meta authorization_needed: true
+      #    end
+      def link(name, &block)
+        @_links[name] = Link.as_jsonapi(@_param_hash, &block)
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/resource.rb

@@ -0,0 +1,92 @@
+require 'jsonapi/serializable/link'
+require 'jsonapi/serializable/relationship'
+require 'jsonapi/serializable/resource_dsl'
+
+module JSONAPI
+  module Serializable
+    class Resource
+      include ResourceDSL
+
+      class << self
+        attr_accessor :type_val, :type_block, :id_block, :attribute_blocks,
+                      :relationship_blocks, :link_blocks, :meta_val, :meta_block
+      end
+
+      self.attribute_blocks = {}
+      self.relationship_blocks = {}
+      self.link_blocks = {}
+
+      def self.inherited(klass)
+        super
+        klass.attribute_blocks = attribute_blocks.dup
+        klass.relationship_blocks = relationship_blocks.dup
+        klass.link_blocks = link_blocks.dup
+      end
+
+      def initialize(param_hash = {})
+        param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+        @_id = instance_eval(&self.class.id_block)
+        @_type = self.class.type_val || instance_eval(&self.class.type_block)
+        @_meta = if self.class.meta_val
+                   self.class.meta_val
+                 elsif self.class.meta_block
+                   instance_eval(&self.class.meta_block)
+                 end
+        @_attributes = {}
+        @_relationships = self.class.relationship_blocks
+                              .each_with_object({}) do |(k, v), h|
+          h[k] = Relationship.new(param_hash, &v)
+        end
+        @_links = self.class.link_blocks.each_with_object({}) do |(k, v), h|
+          h[k] = Link.as_jsonapi(param_hash, &v)
+        end
+      end
+
+      def as_jsonapi(params = {})
+        hash = {}
+        hash[:id] = @_id
+        hash[:type] = @_type
+        attr = attributes(params[:fields] || self.class.attribute_blocks.keys)
+        hash[:attributes] = attr if attr.any?
+        rels = relationships(params[:fields] || @_relationships.keys,
+                             params[:include] || [])
+        hash[:relationships] = rels if rels.any?
+        hash[:links] = @_links if @_links.any?
+        hash[:meta] = @_meta unless @_meta.nil?
+
+        hash
+      end
+
+      def jsonapi_type
+        @_type
+      end
+
+      def jsonapi_id
+        @_id
+      end
+
+      def jsonapi_related(include)
+        @_relationships
+          .select { |k, _| include.include?(k) }
+          .each_with_object({}) { |(k, v), h| h[k] = Array(v.data) }
+      end
+
+      private
+
+      def attributes(fields)
+        self.class.attribute_blocks
+            .select { |k, _| !@_attributes.key?(k) && fields.include?(k) }
+            .each { |k, v| @_attributes[k] = instance_eval(&v) }
+        @_attributes.select { |k, _| fields.include?(k) }
+      end
+
+      def relationships(fields, include)
+        @_relationships
+          .select { |k, _| fields.include?(k) }
+          .each_with_object({}) do |(k, v), h|
+          h[k] = v.as_jsonapi(include.include?(k))
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/resource_dsl.rb

@@ -0,0 +1,127 @@
+module JSONAPI
+  module Serializable
+    module ResourceDSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # @overload type(value)
+        #   Declare the JSON API type of this resource.
+        #   @param [String] value The value of the type.
+        #
+        #   @example
+        #     type 'users'
+        #
+        # @overload type(value)
+        #   Declare the JSON API type of this resource.
+        #   @yieldreturn [String] The value of the type.
+        #
+        #   @example
+        #     type { @user.admin? ? "admin" : "users" }
+        def type(value = nil, &block)
+          self.type_val = value
+          self.type_block = block
+        end
+
+        # Declare the JSON API id of this resource.
+        #
+        # @yieldreturn [String] The id of the resource.
+        #
+        # @example
+        #   id { @user.id.to_s }
+        def id(&block)
+          self.id_block = block
+        end
+
+        # @overload meta(value)
+        #   Declare the meta information for this resource.
+        #   @param [Hash] value The meta information hash.
+        #
+        #   @example
+        #     meta key: value
+        #
+        # @overload meta(&block)
+        #   Declare the meta information for this resource.
+        #   @yieldreturn [String] The meta information hash.
+        #   @example
+        #     meta do
+        #       { key: value }
+        #     end
+        def meta(value = nil, &block)
+          self.meta_val = value
+          self.meta_block = block
+        end
+
+        # Declare an attribute for this resource.
+        #
+        # @param [Symbol] name The key of the attribute.
+        # @yieldreturn [Hash, String, nil] The block to compute the value.
+        #
+        # @example
+        #   attribute(:name) { @user.name }
+        def attribute(name, &block)
+          attribute_blocks[name] = block
+        end
+
+        # Declare a relationship for this resource. The properties of the
+        #   relationship are set by providing a block in which the DSL methods
+        #   of +JSONAPI::Serializable::Relationship+ are called.
+        # @see JSONAPI::Serializable::Relationship
+        #
+        # @param [Symbol] name The key of the relationship.
+        #
+        # @example
+        #   relationship :posts do
+        #     data { @user.posts.map { |p| PostResource.new(post: p) } }
+        #   end
+        #
+        # @example
+        #   relationship :author do
+        #     data do
+        #       @post.author && UserResource.new(user: @post.author)
+        #     end
+        #     linkage_data do
+        #       { type: 'users', id: @post.author_id }
+        #     end
+        #     link(:self) do
+        #       "http://api.example.com/posts/#{@post.id}/relationships/author"
+        #     end
+        #     link(:related) do
+        #       "http://api.example.com/posts/#{@post.id}/author"
+        #     end
+        #     meta do
+        #       { author_online: @post.author.online? }
+        #     end
+        #   end
+        def relationship(name, &block)
+          relationship_blocks[name] = block
+        end
+
+        # Declare a link for this resource. The properties of the link are set
+        #   by providing a block in which the DSL methods of
+        #   +JSONAPI::Serializable::Link+ are called, or the value of the link
+        #   is returned directly.
+        # @see JSONAPI::Serialiable::Link
+        #
+        # @param [Symbol] name The key of the link.
+        # @yieldreturn [Hash, String, nil] The block to compute the value, if
+        #   any.
+        #
+        # @example
+        #   link(:self) do
+        #     "http://api.example.com/users/#{@user.id}"
+        #   end
+        #
+        # @example
+        #    link(:self) do
+        #      href "http://api.example.com/users/#{@user.id}"
+        #      meta is_self: true
+        #    end
+        def link(name, &block)
+          link_blocks[name] = block
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable.rb

@@ -0,0 +1,2 @@
+require 'jsonapi/serializable/error'
+require 'jsonapi/serializable/resource'

data/lib/jsonapi/serializable_error.rb

@@ -0,0 +1,93 @@
+require 'jsonapi/serializable_link'
+
+module JSONAPI
+  class SerializableErrorSource
+    def self.as_jsonapi(params = {})
+      self.class.new(params).as_jsonapi
+    end
+
+    def initialize(params = {})
+      params.each { |k, v| instance_variable_set("@#{k}", v) }
+      @_data = {}
+    end
+
+    def as_jsonapi
+      @_data
+    end
+
+    private
+
+    def method_missing(name, arg)
+      @_data[name] = arg
+    end
+  end
+
+  class SerializableError
+    class << self
+      attr_accessor :id, :id_block, :status, :status_block, :code, :code_block,
+                    :title, :title_block, :detail, :detail_block, :meta,
+                    :meta_block, :source_block, :link_blocks
+
+      [:id, :status, :code, :title, :detail, :meta].each do |key|
+        define_method(key) do |*args, &block|
+          send("@#{key}=", args[0])
+          send("@#{key}_block=", block)
+        end
+      end
+
+      def link(name, &block)
+        link_blocks[name] = block
+      end
+
+      def source(&block)
+        self.source_block = block
+      end
+    end
+
+    self.link_blocks = {}
+
+    def self.inherited(klass)
+      super
+      klass.link_blocks = self.class.link_blocks.dup
+    end
+
+    def initialize(params = {})
+      @_param_hash = params
+      params.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+
+    def as_jsonapi
+      hash = links.any? ? { links: links } : {}
+      [:id, :status, :code, :title, :detail, :meta, :source]
+        .each_with_object(hash) do |key, h|
+        value = send(key)
+        h[key] = value unless value.nil?
+      end
+    end
+
+    private
+
+    def links
+      @_links ||= self.class.link_blocks.each_with_object({}) do |(k, v), h|
+        h[k] = JSONAPI::SerializableLink.as_jsonapi(@_param_hash, v)
+      end
+    end
+
+    def source
+      @_source ||=
+        JSONAPI::SerializableErrorSource.as_jsonapi(@_param_hash,
+                                                    self.class.source_block)
+    end
+
+    [:id, :status, :code, :title, :detail, :meta].each do |key|
+      define_method(key) do
+        unless instance_variable_defined?("@#{key}")
+          instance_variable_set("@#{key}",
+                                self.class.send(key) ||
+                                instance_eval(self.class.send("#{key}_block")))
+        end
+        instance_variable_get("@#{key}")
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable_link.rb

@@ -0,0 +1,34 @@
+module JSONAPI
+  class SerializableLink
+    def self.as_jsonapi(param_hash = {}, &block)
+      new(param_hash, &block).as_jsonapi
+    end
+
+    def initialize(param_hash = {}, &block)
+      param_hash.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+      str_value = instance_eval(&block)
+      @_href ||= str_value
+    end
+
+    def as_jsonapi
+      @_hash ||=
+        if @_meta.nil?
+          @_href
+        else
+          { href: @_href, meta: @_meta }
+        end
+    end
+
+    private
+
+    def href(value = nil, &block)
+      @_href = block.nil? ? value : instance_eval(&block)
+    end
+
+    def meta(value = nil, &block)
+      @_meta = block.nil? ? value : instance_eval(&block)
+    end
+  end
+end

data/lib/jsonapi/serializable_relationship.rb

@@ -0,0 +1,56 @@
+require 'jsonapi/serializable_link'
+
+module JSONAPI
+  class SerializableRelationship
+    def initialize(param_hash = {}, &block)
+      @_param_hash = param_hash
+      @_param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+      @_links = {}
+      instance_eval(&block)
+    end
+
+    def data(&block)
+      if block.nil?
+        @_data ||= @_data_block.call
+      else
+        @_data_block = block
+      end
+    end
+
+    def as_jsonapi(included)
+      hash = {}
+      hash[:links] = @_links if @_links.any?
+      hash[:meta] = @_meta unless @_meta.nil?
+      hash[:data] = eval_linkage_data if included
+
+      hash
+    end
+
+    private
+
+    def eval_linkage_data
+      @_linkage_data ||=
+        if @_linkage_data_block
+          @_linkage_data_block.call
+        elsif data.respond_to?(:each)
+          data.map { |res| { type: res.jsonapi_type, id: res.jsonapi_id } }
+        elsif data.nil?
+          nil
+        else
+          { type: data.jsonapi_type, id: data.jsonapi_id }
+        end
+    end
+
+    def linkage_data(&block)
+      @_linkage_data_block = block
+    end
+
+    def meta(value = nil)
+      @_meta = value || yield
+    end
+
+    def link(name, &block)
+      @_links[name] = JSONAPI::SerializableLink.as_jsonapi(@_param_hash, &block)
+    end
+  end
+end

data/lib/jsonapi/serializable_resource.rb

@@ -0,0 +1,114 @@
+require 'jsonapi/serializable_link'
+require 'jsonapi/serializable_relationship'
+
+module JSONAPI
+  class SerializableResource
+    class << self
+      attr_accessor :type_val, :type_block, :id_block, :attribute_blocks,
+                    :relationship_blocks, :link_blocks, :meta_val, :meta_block
+
+      def type(value = nil, &block)
+        self.type_val = value
+        self.type_block = block
+      end
+
+      def id(&block)
+        self.id_block = block
+      end
+
+      def meta(value = nil, &block)
+        self.meta_val = value
+        self.meta_block = block
+      end
+
+      def attribute(name, &block)
+        attribute_blocks[name] = block
+      end
+
+      def relationship(name, &block)
+        relationship_blocks[name] = block
+      end
+
+      def link(name, &block)
+        link_blocks[name] = block
+      end
+    end
+
+    self.attribute_blocks = {}
+    self.relationship_blocks = {}
+    self.link_blocks = {}
+
+    def self.inherited(klass)
+      super
+      klass.attribute_blocks = attribute_blocks.dup
+      klass.relationship_blocks = relationship_blocks.dup
+      klass.link_blocks = link_blocks.dup
+    end
+
+    def initialize(param_hash = {})
+      param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+      @_id = instance_eval(&self.class.id_block)
+      @_type = self.class.type_val || instance_eval(&self.class.type_block)
+      @_meta = if self.class.meta_val
+                 self.class.meta_val
+               elsif self.class.meta_block
+                 instance_eval(&self.class.meta_block)
+               end
+      @_attributes = {}
+      @_relationships = self.class.relationship_blocks
+                            .each_with_object({}) do |(k, v), h|
+        h[k] = JSONAPI::SerializableRelationship.new(param_hash, &v)
+      end
+      @_links = self.class.link_blocks
+                    .each_with_object({}) do |(k, v), h|
+        h[k] = JSONAPI::SerializableLink.as_jsonapi(param_hash, &v)
+      end
+    end
+
+    def as_jsonapi(params = {})
+      hash = {}
+      hash[:id] = @_id
+      hash[:type] = @_type
+      attr = attributes(params[:fields] || @_attributes.keys)
+      hash[:attributes] = attr if attr.any?
+      rels = relationships(params[:field] || @_relationships.keys,
+                           params[:include] || [])
+      hash[:relationships] = rels if rels.any?
+      hash[:links] = @_links if @_links.any?
+      hash[:meta] = @_meta unless @_meta.nil?
+
+      hash
+    end
+
+    def jsonapi_type
+      @_type
+    end
+
+    def jsonapi_id
+      @_id
+    end
+
+    def jsonapi_related(include)
+      @_relationships
+        .select { |k, _| include.include?(k) }
+        .each_with_object({}) { |(k, v), h| h[k] = Array(v.data) }
+    end
+
+    private
+
+    def attributes(fields)
+      self.class.attribute_blocks
+          .select { |k, _| !@_attributes.key?(k) && fields.include?(k) }
+          .each { |k, v| @_attributes[k] = instance_eval(&v) }
+      @_attributes.select { |k, _| fields.include?(k) }
+    end
+
+    def relationships(fields, include)
+      @_relationships
+        .select { |k, _| fields.include?(k) }
+        .each_with_object({}) do |(k, v), h|
+        h[k] = v.as_jsonapi(include.include?(k))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-serializable
+version: !ruby/object:Gem::Version
+  version: 0.1.1.beta1
+platform: ruby
+authors:
+- Lucas Hosseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: DSL for building resource classes to be rendered by jsonapi-renderer.
+email: lucas.hosseini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jsonapi/serializable.rb
+- lib/jsonapi/serializable/error.rb
+- lib/jsonapi/serializable/error_dsl.rb
+- lib/jsonapi/serializable/link.rb
+- lib/jsonapi/serializable/relationship.rb
+- lib/jsonapi/serializable/relationship_dsl.rb
+- lib/jsonapi/serializable/resource.rb
+- lib/jsonapi/serializable/resource_dsl.rb
+- lib/jsonapi/serializable_error.rb
+- lib/jsonapi/serializable_link.rb
+- lib/jsonapi/serializable_relationship.rb
+- lib/jsonapi/serializable_resource.rb
+homepage: https://github.com/beauby/jsonapi-serializable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Build and render JSON API resources.
+test_files: []