jei 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea19615f8a84331de1de9c82554319903558736d
+  data.tar.gz: 10de19e392712355a970f2696f4e241f8937828e
+SHA512:
+  metadata.gz: aa5ce85017fe71e8552c92362a71bfcf548516a80fab884bbcb752174b2e6b7aac897f75f92643db3db39ec8b42afa93559849bc466cc4c9bb43dae27e330f25
+  data.tar.gz: 683c3c1b22720d0d1dc0ce20ead770d60664d62dc226c0ad29cf76ccb322d4fbf8477d8ea66eff557d3b228d7a863c661914a11cc77b8aa48f7bdfd621f8cc36

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jei.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Macias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Jei
+
+**Jei** is a simple serializer for Ruby that formats a JSON document described
+by [JSON API][jsonapi].
+
+[jsonapi]: http://jsonapi.org/
+
+## Installation
+
+Add `gem 'jei'` to your application's Gemfile or run `gem install jei` to
+install it manually.
+
+## Usage
+
+### Quickstart
+
+```ruby
+require 'jei'
+
+class ArtistSerializer < Jei::Serializer
+  attribute :name
+  has_many :albums
+end
+
+class AlbumSerializer < Jei::Serializer
+  belongs_to :artist
+end
+
+class Artist < OpenStruct; end
+class Album < OpenStruct; end
+
+artist = Artist.new(id: 1, name: 'FIESTAR', albums: [])
+2.times { |i| artist.albums << Album.new(id: i + 1) }
+
+document = Jei::Document.build(artist)
+document.to_json
+```
+
+This emits
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "artists",
+    "attributes": {
+      "name": "FIESTAR"
+    },
+    "relationships": {
+      "albums": {
+        "data": [
+          { "id": "1", "type": "albums" },
+          { "id": "2", "type": "albums" }
+        ]
+      }
+    }
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jei"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jei.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jei/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jei"
+  spec.version       = Jei::VERSION
+  spec.authors       = ["Michael Macias"]
+  spec.email         = ["zaeleus@gmail.com"]
+
+  spec.summary       = "A simple JSON API serializer"
+  spec.homepage      = "https://github.com/zaeleus/jei"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+end

data/lib/jei.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'set'
+
+require 'jei/builders/attributes_node_builder'
+require 'jei/builders/data_node_builder'
+require 'jei/builders/document_builder'
+require 'jei/builders/included_node_builder'
+require 'jei/builders/links_node_builder'
+require 'jei/builders/relationship_node_builder'
+require 'jei/builders/relationships_node_builder'
+require 'jei/builders/resource_node_builder'
+
+require 'jei/nodes/node'
+
+require 'jei/nodes/attribute_node'
+require 'jei/nodes/attributes_node'
+require 'jei/nodes/document_node'
+require 'jei/nodes/included_node'
+require 'jei/nodes/json_api_node'
+require 'jei/nodes/link_node'
+require 'jei/nodes/links_node'
+require 'jei/nodes/meta_node'
+require 'jei/nodes/relationship_node'
+require 'jei/nodes/relationships_node'
+require 'jei/nodes/resource_identifier_node'
+require 'jei/nodes/resource_node'
+
+require 'jei/nodes/data_node'
+require 'jei/nodes/collection_data_node'
+
+require 'jei/attribute'
+require 'jei/document'
+require 'jei/link'
+require 'jei/path'
+require 'jei/relationship'
+require 'jei/serializer'
+
+require 'jei/version'
+
+module Jei
+end

data/lib/jei/attribute.rb

@@ -0,0 +1,22 @@
+module Jei
+  class Attribute
+    # @return [Symbol]
+    attr_reader :name
+
+    # @param [Symbol] name
+    # @param [Proc, Symbol] value
+    def initialize(name, value = name)
+      @name = name
+      @value = value
+    end
+
+    # @param [Serializer] serializer
+    def evaluate(serializer)
+      if @value.is_a?(Proc)
+        serializer.instance_eval(&@value)
+      else
+        serializer.resource.send(@value)
+      end
+    end
+  end
+end

data/lib/jei/builders/attributes_node_builder.rb

@@ -0,0 +1,17 @@
+module Jei
+  module Builder
+    module AttributesNodeBuilder
+      # @param [Serializer] serializer
+      # @return [AttributesNode]
+      def self.build(serializer)
+        node = AttributesNode.new
+
+        serializer.attributes.values.each do |attribute|
+          node.children << AttributeNode.new(serializer, attribute)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/jei/builders/data_node_builder.rb

@@ -0,0 +1,13 @@
+module Jei
+  module Builder
+    module DataNodeBuilder
+      # @param [Serializer] serializer
+      # @return [DataNode]
+      def self.build(serializer)
+        node = DataNode.new
+        node.children << ResourceNodeBuilder.build(serializer)
+        node
+      end
+    end
+  end
+end

data/lib/jei/builders/document_builder.rb

@@ -0,0 +1,77 @@
+module Jei
+  module Builder
+    module DocumentBuilder
+      # @param [Object] resource
+      # @param [Hash<Symbol, Object>] options
+      # @return [Document]
+      def self.build(resource, options = {})
+        document = Document.new
+        root = document.root
+
+        root.children << JSONAPINode.new if options[:jsonapi]
+        root.children << MetaNode.new(options[:meta]) if options[:meta]
+        root.children << LinksNodeBuilder.build(options[:links]) if options[:links]
+
+        if resource.nil?
+          root.children << DataNode.new
+          return document
+        end
+
+        if resource.is_a?(Enumerable)
+          node = CollectionDataNode.new
+
+          if options[:include]
+            paths = Path.parse(options[:include])
+            included_resources = Set.new
+
+            resource.each do |r|
+              Path.find(paths, r, included_resources)
+
+              serializer =
+                if options[:serializer]
+                  options[:serializer].new(r)
+                else
+                  Serializer.factory(r)
+                end
+
+              node.children << ResourceNodeBuilder.build(serializer)
+            end
+
+            root.children << IncludedNode.build(included_resources)
+          else
+            resource.each do |r|
+              serializer =
+                if options[:serializer]
+                  options[:serializer].new(r)
+                else
+                  Serializer.factory(r)
+                end
+
+              node.children << ResourceNodeBuilder.build(serializer)
+            end
+          end
+
+          root.children << node
+        else
+          serializer =
+            if options[:serializer]
+              options[:serializer].new(resource)
+            else
+              Serializer.factory(resource)
+            end
+
+          root.children << DataNodeBuilder.build(serializer)
+
+          if options[:include]
+            paths = Path.parse(options[:include])
+            included_resources = Set.new
+            Path.find(paths, resource, included_resources)
+            root.children << IncludedNodeBuilder.build(included_resources)
+          end
+        end
+
+        document
+      end
+    end
+  end
+end

data/lib/jei/builders/included_node_builder.rb

@@ -0,0 +1,18 @@
+module Jei
+  module Builder
+    module IncludedNodeBuilder
+      # @param [Set<Object>] resources
+      # @return [IncludedNode]
+      def self.build(resources)
+        node = IncludedNode.new
+
+        resources.each do |resource|
+          serializer = Serializer.factory(resource)
+          node.children << ResourceNodeBuilder.build(serializer)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/jei/builders/links_node_builder.rb

@@ -0,0 +1,17 @@
+module Jei
+  module Builder
+    module LinksNodeBuilder
+      # @param [Array<Link>] links
+      # @return [LinksNode]
+      def self.build(links)
+        links_node = LinksNode.new
+
+        links.each do |link|
+          links_node.children << LinkNode.new(link)
+        end
+
+        links_node
+      end
+    end
+  end
+end

data/lib/jei/builders/relationship_node_builder.rb

@@ -0,0 +1,66 @@
+module Jei
+  module Builder
+    module RelationshipNodeBuilder
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      # @return [RelationshipNode]
+      def self.build(relationship, serializer)
+        node = RelationshipNode.new(relationship)
+
+        if !relationship.options[:no_data]
+          node.children <<
+            case relationship
+            when BelongsToRelationship
+              build_data_node(relationship, serializer)
+            when HasManyRelationship
+              build_collection_data_node(relationship, serializer)
+            else
+              raise ArgumentError, 'invalid relationship type'
+            end
+        end
+
+        if relationship.options[:links]
+          node.children << build_links_node(relationship, serializer)
+        end
+
+        node
+      end
+
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      # @return [DataNode]
+      def self.build_data_node(relationship, serializer)
+        node = DataNode.new
+        resource = relationship.evaluate(serializer)
+
+        serializer = Serializer.factory(resource)
+        node.children << ResourceIdentifierNode.new(serializer)
+
+        node
+      end
+
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      # @return [CollectionDataNode]
+      def self.build_collection_data_node(relationship, serializer)
+        node = CollectionDataNode.new
+        resources = relationship.evaluate(serializer)
+
+        resources.each do |resource|
+          serializer = Serializer.factory(resource)
+          node.children << ResourceIdentifierNode.new(serializer)
+        end
+
+        node
+      end
+
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      # @return [LinksNode]
+      def self.build_links_node(relationship, serializer)
+        links = relationship.links(serializer)
+        LinksNodeBuilder.build(links)
+      end
+    end
+  end
+end

data/lib/jei/builders/relationships_node_builder.rb

@@ -0,0 +1,17 @@
+module Jei
+  module Builder
+    module RelationshipsNodeBuilder
+      # @param [Serializer] serializer
+      # @return [RelationshipsNode]
+      def self.build(serializer)
+        node = RelationshipsNode.new
+
+        serializer.relationships.values.each do |relationship|
+          node.children << RelationshipNodeBuilder.build(relationship, serializer)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/jei/builders/resource_node_builder.rb

@@ -0,0 +1,29 @@
+module Jei
+  module Builder
+    module ResourceNodeBuilder
+      # @param [Serializer] serializer
+      # @return [ResourceNode]
+      def self.build(serializer)
+        node = ResourceNode.new
+
+        node.children << ResourceIdentifierNode.new(serializer)
+
+        if serializer.attributes.any?
+          node.children << AttributesNodeBuilder.build(serializer)
+        end
+
+        if serializer.relationships.any?
+          node.children << RelationshipsNodeBuilder.build(serializer)
+        end
+
+        links = serializer.links
+
+        if links
+          node.children << LinksNodeBuilder.build(links)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/jei/document.rb

@@ -0,0 +1,40 @@
+module Jei
+  class Document
+    # @return [String]
+    VERSION = '1.0'
+
+    # @return [DocumentNode]
+    attr_reader :root
+
+    # @param [Object] resource
+    # @param [Hash<Symbol, Object>] options
+    # @option options [Boolean] :jsonapi Add the top level JSON API object to
+    #   the document.
+    # @option options [Array<Link>] :links Add links related to the primary
+    #   data.
+    # @option options [Hash<Symbol, Object>] :meta Add top level meta
+    #   information to the document.
+    # @option options [Class] :serializer Override the default serializer. For
+    #   collections, this works only if all the resources are of the same type.
+    # @return [Document]
+    def self.build(resource, options = {})
+      Builder::DocumentBuilder.build(resource, options)
+    end
+
+    def initialize
+      @root = DocumentNode.new
+    end
+
+    # @return [Hash<Symbol, Object>]
+    def to_h
+      document = {}
+      root.visit(document)
+      document
+    end
+
+    # @return [String]
+    def to_json
+      to_h.to_json
+    end
+  end
+end

data/lib/jei/link.rb

@@ -0,0 +1,21 @@
+module Jei
+  class Link
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :href
+
+    # @return [Hash<Symbol, Object>]
+    attr_reader :meta
+
+    # @param [Symbol] name
+    # @param [String] href
+    # @param [Hash<Symbol, Object>] meta
+    def initialize(name, href, meta = {})
+      @name = name
+      @href = href
+      @meta = meta
+    end
+  end
+end

data/lib/jei/nodes/attribute_node.rb

@@ -0,0 +1,17 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-resource-object-attributes
+  class AttributeNode < Node
+    # @param [Serializer] serializer
+    # @param [Attribute] attribute
+    def initialize(serializer, attribute)
+      super()
+      @serializer = serializer
+      @attribute = attribute
+    end
+
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[@attribute.name] = @attribute.evaluate(@serializer)
+    end
+  end
+end

data/lib/jei/nodes/attributes_node.rb

@@ -0,0 +1,11 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-resource-object-attributes
+  class AttributesNode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      attributes = {}
+      children.each { |child| child.visit(attributes) }
+      context[:attributes] = attributes
+    end
+  end
+end

data/lib/jei/nodes/collection_data_node.rb

@@ -0,0 +1,13 @@
+module Jei
+  # @see http://jsonapi.org/format/#document-top-level
+  class CollectionDataNode < DataNode
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[:data] = children.map do |child|
+        data = {}
+        child.visit(data)
+        data
+      end
+    end
+  end
+end

data/lib/jei/nodes/data_node.rb

@@ -0,0 +1,16 @@
+module Jei
+  # @see http://jsonapi.org/format/#document-top-level
+  class DataNode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[:data] =
+        if children.empty?
+          nil
+        else
+          data = {}
+          children.each { |child| child.visit(data) }
+          data
+        end
+    end
+  end
+end

data/lib/jei/nodes/document_node.rb

@@ -0,0 +1,9 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-top-level
+  class DocumentNode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      children.each { |child| child.visit(context) }
+    end
+  end
+end

data/lib/jei/nodes/included_node.rb

@@ -0,0 +1,12 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-compound-documents
+  class IncludedNode < Node
+    def visit(context)
+      context[:included] = children.map do |child|
+        data = {}
+        child.visit(data)
+        data
+      end
+    end
+  end
+end

data/lib/jei/nodes/json_api_node.rb

@@ -0,0 +1,9 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-jsonapi-object
+  class JSONAPINode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[:jsonapi] = { version: Document::VERSION }
+    end
+  end
+end

data/lib/jei/nodes/link_node.rb

@@ -0,0 +1,20 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-links
+  class LinkNode < Node
+    # @param [Link] link
+    def initialize(link)
+      super()
+      @link = link
+    end
+
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[@link.name] =
+        if @link.meta.any?
+          { href: @link.href, meta: @link.meta }
+        else
+          @link.href
+        end
+    end
+  end
+end

data/lib/jei/nodes/links_node.rb

@@ -0,0 +1,11 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-links
+  class LinksNode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      data = {}
+      children.each { |child| child.visit(data) }
+      context[:links] = data
+    end
+  end
+end

data/lib/jei/nodes/meta_node.rb

@@ -0,0 +1,15 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-meta
+  class MetaNode < Node
+    # param [Hash<Symbol, Object>] meta
+    def initialize(meta)
+      super()
+      @meta = meta
+    end
+
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[:meta] = @meta
+    end
+  end
+end

data/lib/jei/nodes/node.rb

@@ -0,0 +1,17 @@
+module Jei
+  # @abstract
+  class Node
+    # @return [Array<Node>]
+    attr_reader :children
+
+    def initialize
+      @children = []
+    end
+
+    # @abstract
+    # @param [Hash<Symbol, Object>] _context
+    def visit(_context)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/jei/nodes/relationship_node.rb

@@ -0,0 +1,17 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
+  class RelationshipNode < Node
+    # @param [Relationship] relationship
+    def initialize(relationship)
+      super()
+      @relationship = relationship
+    end
+
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      data = {}
+      children.each { |child| child.visit(data) }
+      context[@relationship.name] = data
+    end
+  end
+end

data/lib/jei/nodes/relationships_node.rb

@@ -0,0 +1,11 @@
+module Jei
+  # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
+  class RelationshipsNode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      relationships = {}
+      children.each { |child| child.visit(relationships) }
+      context[:relationships] = relationships
+    end
+  end
+end

data/lib/jei/nodes/resource_identifier_node.rb

@@ -0,0 +1,16 @@
+module Jei
+  # http://jsonapi.org/format/1.0/#document-resource-identifier-objects
+  class ResourceIdentifierNode < Node
+    # param [Serializer] serializer
+    def initialize(serializer)
+      super()
+      @serializer = serializer
+    end
+
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      context[:id] = @serializer.id
+      context[:type] = @serializer.type
+    end
+  end
+end

data/lib/jei/nodes/resource_node.rb

@@ -0,0 +1,9 @@
+module Jei
+  # http://jsonapi.org/format/1.0/#document-resource-objects
+  class ResourceNode < Node
+    # @param [Hash<Symbol, Object>] context
+    def visit(context)
+      children.each { |child| child.visit(context) }
+    end
+  end
+end

data/lib/jei/path.rb

@@ -0,0 +1,50 @@
+module Jei
+  class Path
+    PATH_SEPARATOR = ','
+    NAME_SEPARATOR = '.'
+
+    # @return [Array<Symbol>]
+    attr_reader :names
+
+    # @param [String] paths
+    # @return [Array<Path>]
+    def self.parse(paths)
+      paths.split(PATH_SEPARATOR).map do |path|
+        new(path.split(NAME_SEPARATOR).map(&:to_sym))
+      end
+    end
+
+    # @param [Array<Path>] paths
+    # @param [Object] resource
+    # @param [Set<Object>] resources
+    def self.find(paths, resource, resources)
+      paths.each do |path|
+        path.walk(resource, resources)
+      end
+    end
+
+    # @param [Array<Symbol>] names
+    def initialize(names)
+      @names = names
+    end
+
+    # @param [Object] root
+    # @param [Set<Object>] set
+    # @param [Integer] level
+    def walk(root, set = Set.new, level = 0)
+      return if level >= @names.length
+
+      serializer = Serializer.factory(root)
+
+      name = @names[level]
+      relationship = serializer.relationships[name]
+      resources = [*relationship.evaluate(serializer)]
+
+      set.merge(resources)
+
+      resources.each do |resource|
+        walk(resource, set, level + 1)
+      end
+    end
+  end
+end

data/lib/jei/relationship.rb

@@ -0,0 +1,29 @@
+module Jei
+  class Relationship < Attribute
+    # @return [Hash<Symbol, Object>] options
+    attr_reader :options
+
+    # @param [Symbol] name
+    # @param [Proc, Symbol] value
+    # @param [Hash<Symbol, Object>] options
+    # @option options [Boolean] :no_data Whether to exclude data from the
+    #   relationship.
+    # @option options [Proc] :links A Proc that evaulates to a list of links.
+    def initialize(name, value = name, options = {})
+      super(name, value)
+      @options = options
+    end
+
+    # @param [Serializer] serializer
+    # @return [Array<Link>]
+    def links(serializer)
+      serializer.instance_eval(&options[:links])
+    end
+  end
+
+  class BelongsToRelationship < Relationship
+  end
+
+  class HasManyRelationship < Relationship
+  end
+end

data/lib/jei/serializer.rb

@@ -0,0 +1,75 @@
+module Jei
+  class Serializer
+    # @return [#id]
+    attr_reader :resource
+
+    # @return [Hash<Symbol, Attribute>]
+    def self.serialization_map
+      @serialization_map ||= Hash.new { |h, k| h[k] = {} }
+    end
+
+    # @overload attributes(name, ...)
+    #   @param [Symbol] name
+    #   @param [Symbol] ...
+    def self.attributes(*names)
+      names.each { |name| attribute(name) }
+    end
+
+    # @param [Symbol] name
+    def self.attribute(name, &blk)
+      value = block_given? ? blk : name
+      serialization_map[:attributes][name] = Attribute.new(name, value)
+    end
+
+    # @param [Symbol] name
+    def self.belongs_to(name, options = {}, &blk)
+      value = block_given? ? blk : name
+      serialization_map[:relationships][name] =
+        BelongsToRelationship.new(name, value, options)
+    end
+
+    # @param [Symbol] name
+    def self.has_many(name, options = {}, &blk)
+      value = block_given? ? blk : name
+      serialization_map[:relationships][name] =
+        HasManyRelationship.new(name, value, options)
+    end
+
+    # @return [Serializer]
+    def self.factory(resource)
+      name = resource.class.name
+      klass = const_get("#{name}Serializer")
+      klass.new(resource)
+    end
+
+    # @param [#id] resource
+    def initialize(resource)
+      @resource = resource
+    end
+
+    # @return [String]
+    def id
+      resource.id.to_s
+    end
+
+    # @return [String]
+    def type
+      "#{resource.class.name.downcase}s"
+    end
+
+    # @return [Hash<Symbol, Attribute>]
+    def attributes
+      self.class.serialization_map[:attributes]
+    end
+
+    # @return [Hash<Symbol, Relationship>]
+    def relationships
+      self.class.serialization_map[:relationships]
+    end
+
+    # @return [Array<Link>, nil]
+    def links
+      nil
+    end
+  end
+end

data/lib/jei/version.rb

@@ -0,0 +1,3 @@
+module Jei
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: jei
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Macias
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: 
+email:
+- zaeleus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jei.gemspec
+- lib/jei.rb
+- lib/jei/attribute.rb
+- lib/jei/builders/attributes_node_builder.rb
+- lib/jei/builders/data_node_builder.rb
+- lib/jei/builders/document_builder.rb
+- lib/jei/builders/included_node_builder.rb
+- lib/jei/builders/links_node_builder.rb
+- lib/jei/builders/relationship_node_builder.rb
+- lib/jei/builders/relationships_node_builder.rb
+- lib/jei/builders/resource_node_builder.rb
+- lib/jei/document.rb
+- lib/jei/link.rb
+- lib/jei/nodes/attribute_node.rb
+- lib/jei/nodes/attributes_node.rb
+- lib/jei/nodes/collection_data_node.rb
+- lib/jei/nodes/data_node.rb
+- lib/jei/nodes/document_node.rb
+- lib/jei/nodes/included_node.rb
+- lib/jei/nodes/json_api_node.rb
+- lib/jei/nodes/link_node.rb
+- lib/jei/nodes/links_node.rb
+- lib/jei/nodes/meta_node.rb
+- lib/jei/nodes/node.rb
+- lib/jei/nodes/relationship_node.rb
+- lib/jei/nodes/relationships_node.rb
+- lib/jei/nodes/resource_identifier_node.rb
+- lib/jei/nodes/resource_node.rb
+- lib/jei/path.rb
+- lib/jei/relationship.rb
+- lib/jei/serializer.rb
+- lib/jei/version.rb
+homepage: https://github.com/zaeleus/jei
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple JSON API serializer
+test_files: []
+has_rdoc: