simple_json_api 0.0.2

data/lib/simple_json_api/resource_serializer.rb

@@ -0,0 +1,68 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # The Serializer will serialize a model
+  class ResourceSerializer < Serializer
+    using ActiveRecordRefinements
+
+    def _root_name
+      self.class._root_name
+    end
+
+    def _fields
+      @_fields ||= begin
+        defaults = self.class.default_fields.split(',')
+        builders = _builder.fields_for(_root_name).presence
+        (builders || defaults).map(&:to_sym)
+      end
+    end
+
+    def serialize
+      hash = {}
+      attribute_values(hash)
+      link_values(hash[:links] = {})
+      _association_values
+      hash
+    end
+
+    def attribute_values(hash)
+      _fields.each do |attribute, _attr_opts|
+        hash[attribute] = send(attribute).to_s
+      end
+      hash[:href] = href if self.class.method_defined? :href
+    end
+
+    def link_values(root)
+      self.class._associations.each do |association|
+        root[association.key] = link(association)
+      end
+    end
+
+    def link(association)
+      resource = send(association.name)
+      if association.type == :has_many
+        resource.to_a.map do |obj|
+          association[:polymorphic] ? obj.typed_json_id : obj.json_id
+        end
+      else
+        resource.json_id
+      end
+    end
+
+    def _associations
+      self.class._associations
+    end
+
+    def _association_values
+      _associations.each do |association|
+        name = association[:name]
+        obj = send(name)
+        _builder.add_linked_elem(
+          name,
+          obj,
+          association,
+          @_base
+        )
+      end
+    end
+  end
+end

data/lib/simple_json_api/serializer.rb

@@ -0,0 +1,52 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # The Serializer will serialize a model
+  class Serializer
+    extend Forwardable
+    extend DSL
+
+    attr_reader :_builder
+    attr_reader :_each_serializer
+    attr_reader :_object
+
+    def initialize(object:, builder:, each_serializer: nil, base: nil)
+      @_object = object
+      @_builder = builder
+      @_each_serializer = each_serializer
+      @_base = base
+    end
+
+    class << self
+      attr_reader :registered_serializers
+
+      def register_serializer(serializer_hash, options)
+        options.reverse_merge!(primary_key: :id)
+        @registered_serializers ||= []
+        @registered_serializers << serializer_hash.merge(options)
+      end
+
+      def for(model, association)
+        if association[:polymorphic]
+          for_polymorphic(model)
+        else
+          for_regular(association)
+        end
+      end
+
+      def for_regular(association)
+        resource = association[:name].to_s.pluralize.to_sym
+        serializer = @registered_serializers.find do |entry|
+          entry[:resource] == resource
+        end
+        serializer[:serializer]
+      end
+
+      def for_polymorphic(model)
+        serializer = @registered_serializers.find do |entry|
+          entry[:model] == model.class
+        end
+        serializer[:serializer]
+      end
+    end
+  end
+end

data/lib/simple_json_api/version.rb

@@ -0,0 +1,4 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  VERSION = '0.0.2'
+end

data/simple_json_api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_json_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_json_api'
+  spec.version       = SimpleJsonApi::VERSION
+  spec.authors       = ['Gary Gordon']
+  spec.email         = ['gfgordon@gmail.com']
+  spec.summary       = 'A Simple JSON API Serializer.'
+  spec.description   = 'A basic serializer implementing the JSON API spec.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^test\//)
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_dependency 'activerecord', '>= 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rdoc'
+
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'diffy'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
+end

data/test/fixtures/projects.yml

@@ -0,0 +1,5 @@
+project_1:
+  name: First Project
+
+project_2:
+  name: Second Project

data/test/integration/render_basic_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'RenderBasicTest' do
+    it 'should match json hash for a project with no options' do
+      JSON.parse(actual_project).must_equal expected_project
+    end
+
+    it 'should match json hash for a project array with no options' do
+      JSON.parse(actual_projects).must_equal expected_projects
+    end
+
+    let(:actual_project) do
+      SimpleJsonApi.render(
+        model: Project.first,
+        serializer: ProjectSerializer
+      )
+    end
+    let(:expected_project) do
+      {
+        'projects' => {
+          'id' => '100',
+          'name' => 'First Project',
+          'description' => 'The first project',
+          'position' => '',
+          'href' => 'http://example.com/projects/100',
+          'links' => {
+            'todolist' => '200',
+            'tags' => ['10']
+          }
+        }
+      }
+    end
+
+    let(:actual_projects) do
+      SimpleJsonApi.render(
+        model: Project.all.to_a,
+        serializer: ProjectSerializer
+      )
+    end
+    let(:expected_projects) do
+      {
+        'projects' => [
+          {
+            'id' => '100',
+            'name' => 'First Project',
+            'description' => 'The first project',
+            'position' => '',
+            'href' => 'http://example.com/projects/100',
+            'links' => {
+              'todolist' => '200',
+              'tags' => ['10']
+            }
+          },
+          {
+            'id' => '110',
+            'name' => 'Second Project',
+            'description' => 'The second project',
+            'position' => '',
+            'href' => 'http://example.com/projects/110',
+            'links' => {
+              'todolist' => '210',
+              'tags' => ['20']
+            }
+          }
+        ]
+      }
+    end
+  end
+end

data/test/integration/render_fields_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'RenderFieldsTest' do
+    it 'should match json hash for a project with fields specified' do
+      JSON.parse(actual_project).must_equal expected_project
+    end
+
+    it 'should match json hash for a project with fields specified as hash' do
+      JSON.parse(actual_project_field_hash).must_equal expected_project
+    end
+
+    it 'should match json hash for a project array with fields specified' do
+      JSON.parse(actual_projects).must_equal expected_projects
+    end
+
+    let(:actual_project) do
+      SimpleJsonApi.render(
+        model: Project.first,
+        serializer: ProjectSerializer,
+        options: { fields: 'name,description' }
+      )
+    end
+    let(:actual_project_field_hash) do
+      SimpleJsonApi.render(
+        model: Project.first,
+        serializer: ProjectSerializer,
+        options: { fields: { projects: 'name,description' } }
+      )
+    end
+    let(:expected_project) do
+      {
+        'projects' => {
+          'name' => 'First Project',
+          'description' => 'The first project',
+          'href' => 'http://example.com/projects/100',
+          'links' => {
+            'todolist' => '200',
+            'tags' => ['10']
+          }
+        }
+      }
+    end
+
+    let(:actual_projects) do
+      SimpleJsonApi.render(
+        model: Project.all.to_a,
+        serializer: ProjectSerializer,
+        options: { fields: 'name,description' }
+      )
+    end
+    let(:expected_projects) do
+      {
+        'projects' => [
+          {
+            'name' => 'First Project',
+            'description' => 'The first project',
+            'href' => 'http://example.com/projects/100',
+            'links' => {
+              'todolist' => '200',
+              'tags' => ['10']
+            }
+          },
+          {
+            'name' => 'Second Project',
+            'description' => 'The second project',
+            'href' => 'http://example.com/projects/110',
+            'links' => {
+              'todolist' => '210',
+              'tags' => ['20']
+            }
+          }
+        ]
+      }
+    end
+  end
+end

data/test/integration/render_include_test.rb

@@ -0,0 +1,133 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'RenderIncludeTest' do
+    it 'should match json hash for a project with include specified' do
+      JSON.parse(actual_project).must_equal expected_project
+    end
+
+    it 'should match json hash for a project array with include specified' do
+      JSON.parse(actual_projects).must_equal expected_projects
+    end
+
+    let(:actual_project) do
+      SimpleJsonApi.render(
+        model: Project.first,
+        serializer: ProjectSerializer,
+        options: { include: 'todolists' }
+      )
+    end
+    let(:expected_project) do
+      {
+        'projects' => {
+          'id' => '100',
+          'name' => 'First Project',
+          'description' => 'The first project',
+          'position' => '',
+          'href' => 'http://example.com/projects/100',
+          'links' => {
+            'todolist' => '200',
+            'tags' => ['10']
+          }
+        },
+        'linked' => {
+          'todolists' => [
+            {
+              'id' => '200',
+              'description' => 'Groceries',
+              'href' => 'http://example.com/todolists/200',
+              'links' => {
+                'todos' => ['300'],
+                'tags' => ['30']
+              }
+            }
+          ]
+        }
+
+      }
+    end
+
+    let(:actual_projects) do
+      SimpleJsonApi.render(
+        model: Project.all.to_a,
+        serializer: ProjectSerializer,
+        options: { include: 'todolists,tags' }
+      )
+    end
+    let(:expected_projects) do
+      {
+        'projects' => [
+          {
+            'id' => '100',
+            'name' => 'First Project',
+            'description' => 'The first project',
+            'position' => '',
+            'href' => 'http://example.com/projects/100',
+            'links' => {
+              'todolist' => '200',
+              'tags' => ['10']
+            }
+          },
+          {
+            'id' => '110',
+            'name' => 'Second Project',
+            'description' => 'The second project',
+            'position' => '',
+            'href' => 'http://example.com/projects/110',
+            'links' => {
+              'todolist' => '210',
+              'tags' => ['20']
+            }
+          }
+        ],
+        'linked' => {
+          'todolists' => [
+            {
+              'id' => '200',
+              'description' => 'Groceries',
+              'href' => 'http://example.com/todolists/200',
+              'links' => {
+                'todos' => ['300'],
+                'tags' => ['30']
+              }
+            },
+            {
+              'id' => '210',
+              'description' => 'Groceries',
+              'description' => 'Work',
+              'href' => 'http://example.com/todolists/210',
+              'links' => {
+                'todos' => %w(310 320 330),
+                'tags' => []
+              }
+            }
+          ],
+          'tags' => [
+            {
+              'guid' => '10',
+              'name' => 'Urgent!',
+              'links' => {
+                'taggables' => [
+                  %w(projects 100),
+                  %w(todos 300),
+                  %w(todos 330)
+                ]
+              }
+            },
+            {
+              'guid' => '20',
+              'name' => 'On Hold',
+              'links' => {
+                'taggables' => [
+                  %w(projects 110),
+                  %w(todos 300)
+                ]
+              }
+            }
+          ]
+        }
+      }
+    end
+  end
+end