simple_json_api 0.0.3 → 0.0.4

data/simple_json_api.gemspec

@@ -20,14 +20,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.1'
 
   spec.add_dependency 'activerecord', '>= 4.0'
+  # spec.add_dependency 'activesupport', '>= 4.0'
+  # spec.add_dependency 'railties', '>= 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 'sqlite3'
 end

data/test/generators/simple_json_api/resource_generator_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+require 'rails/generators'
+require 'rails/generators/test_case'
+require 'generators/simple_json_api/resource/resource_generator'
+
+module SimpleJsonApi
+  module Generators
+    # Tests the generation of the resource template files
+    class ResourceGeneratorTest < Rails::Generators::TestCase
+      tests ResourceGenerator
+      destination 'tmp/generators'
+      setup :prepare_destination
+
+      def test_generator_runs
+        # No error raised? It passes.
+        run_generator %w(Project --namespace=Api::V3)
+      end
+
+      def test_bad_model
+        assert_raises(SystemExit) do
+          run_generator \
+          %w(Project --namespace=Api::V3 --model=ProjectSerializer)
+        end
+      end
+
+      def teardown
+        FileUtils.rm_rf('tmp/generators')
+      end
+    end
+  end
+end

data/test/integration/render_basic_test.rb

@@ -4,11 +4,11 @@ require 'test_helper'
 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
+      actual_project.must_match_json expected_project
     end
 
     it 'should match json hash for a project array with no options' do
-      JSON.parse(actual_projects).must_equal expected_projects
+      actual_projects.must_match_json expected_projects
     end
 
     let(:actual_project) do
@@ -19,7 +19,8 @@ module SimpleJsonApi
     end
     let(:expected_project) do
       {
-        'projects' => {
+        'data' => {
+          'type' => 'projects',
           'id' => '100',
           'name' => 'First Project',
           'description' => 'The first project',
@@ -27,7 +28,7 @@ module SimpleJsonApi
           'href' => 'http://example.com/projects/100',
           'links' => {
             'todolist' => '200',
-            'tags' => ['10']
+            'tags' => %w(10)
           }
         }
       }
@@ -41,8 +42,9 @@ module SimpleJsonApi
     end
     let(:expected_projects) do
       {
-        'projects' => [
+        'data' => [
           {
+            'type' => 'projects',
             'id' => '100',
             'name' => 'First Project',
             'description' => 'The first project',
@@ -50,10 +52,11 @@ module SimpleJsonApi
             'href' => 'http://example.com/projects/100',
             'links' => {
               'todolist' => '200',
-              'tags' => ['10']
+              'tags' => %w(10)
             }
           },
           {
+            'type' => 'projects',
             'id' => '110',
             'name' => 'Second Project',
             'description' => 'The second project',
@@ -61,7 +64,7 @@ module SimpleJsonApi
             'href' => 'http://example.com/projects/110',
             'links' => {
               'todolist' => '210',
-              'tags' => ['20']
+              'tags' => %w(20)
             }
           }
         ]

data/test/integration/render_fields_test.rb

@@ -3,35 +3,30 @@ 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
+      actual_project_field_hash.must_match_json expected_project
     end
 
     it 'should match json hash for a project array with fields specified' do
-      JSON.parse(actual_projects).must_equal expected_projects
+      actual_projects.must_match_json expected_projects
     end
 
-    let(:actual_project) do
-      SimpleJsonApi.render(
-        model: Project.first,
-        serializer: ProjectSerializer,
-        options: { fields: 'name,description' }
-      )
+    it 'should match hash for todo with default_fields specified' do
+      actual_todo.must_match_json expected_todo
     end
+
     let(:actual_project_field_hash) do
       SimpleJsonApi.render(
         model: Project.first,
         serializer: ProjectSerializer,
-        options: { fields: { projects: 'name,description' } }
+        fields: { projects: 'name,description' }
       )
     end
     let(:expected_project) do
       {
-        'projects' => {
+        'data' => {
+          'type' => 'projects',
+          'id' => '100',
           'name' => 'First Project',
           'description' => 'The first project',
           'href' => 'http://example.com/projects/100',
@@ -47,13 +42,15 @@ module SimpleJsonApi
       SimpleJsonApi.render(
         model: Project.all.to_a,
         serializer: ProjectSerializer,
-        options: { fields: 'name,description' }
+        fields: { 'projects' => 'name,description' }
       )
     end
     let(:expected_projects) do
       {
-        'projects' => [
+        'data' => [
           {
+            'type' => 'projects',
+            'id' => '100',
             'name' => 'First Project',
             'description' => 'The first project',
             'href' => 'http://example.com/projects/100',
@@ -63,6 +60,8 @@ module SimpleJsonApi
             }
           },
           {
+            'type' => 'projects',
+            'id' => '110',
             'name' => 'Second Project',
             'description' => 'The second project',
             'href' => 'http://example.com/projects/110',
@@ -74,5 +73,25 @@ module SimpleJsonApi
         ]
       }
     end
+
+    let(:actual_todo) do
+      SimpleJsonApi.render(
+        model: Todo.first,
+        serializer: TodoSerializer
+      )
+    end
+    let(:expected_todo) do
+      {
+        'data' => {
+          'type' => 'todos',
+          'id' => '300',
+          'action' => 'Milk',
+          'href' => 'http://example.com/todos/300',
+          'links' => {
+            'tags' => %w(10 30)
+          }
+        }
+      }
+    end
   end
 end

data/test/integration/render_include_test.rb

@@ -4,23 +4,24 @@ require 'test_helper'
 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
+      actual_project.must_match_json expected_project
     end
 
     it 'should match json hash for a project array with include specified' do
-      JSON.parse(actual_projects).must_equal expected_projects
+      actual_projects.must_match_json expected_projects
     end
 
     let(:actual_project) do
       SimpleJsonApi.render(
         model: Project.first,
         serializer: ProjectSerializer,
-        options: { include: 'todolists' }
+        include: 'todolists'
       )
     end
     let(:expected_project) do
       {
-        'projects' => {
+        'data' => {
+          'type' => 'projects',
           'id' => '100',
           'name' => 'First Project',
           'description' => 'The first project',
@@ -31,20 +32,18 @@ module SimpleJsonApi
             'tags' => ['10']
           }
         },
-        'linked' => {
-          'todolists' => [
-            {
-              'id' => '200',
-              'description' => 'Groceries',
-              'href' => 'http://example.com/todolists/200',
-              'links' => {
-                'todos' => ['300'],
-                'tags' => ['30']
-              }
+        'included' => [
+          {
+            'type' => 'todolists',
+            'id' => '200',
+            'description' => 'Groceries',
+            'href' => 'http://example.com/todolists/200',
+            'links' => {
+              'todos' => %w(300 301),
+              'tags' => ['30']
             }
-          ]
-        }
-
+          }
+        ]
       }
     end
 
@@ -52,13 +51,14 @@ module SimpleJsonApi
       SimpleJsonApi.render(
         model: Project.all.to_a,
         serializer: ProjectSerializer,
-        options: { include: 'todolists,tags' }
+        include: 'todolists,tags'
       )
     end
     let(:expected_projects) do
       {
-        'projects' => [
+        'data' => [
           {
+            'type' => 'projects',
             'id' => '100',
             'name' => 'First Project',
             'description' => 'The first project',
@@ -70,6 +70,7 @@ module SimpleJsonApi
             }
           },
           {
+            'type' => 'projects',
             'id' => '110',
             'name' => 'Second Project',
             'description' => 'The second project',
@@ -81,52 +82,54 @@ module SimpleJsonApi
             }
           }
         ],
-        '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' => []
-              }
+        'included' => [
+          {
+            'type' => 'todolists',
+            'id' => '200',
+            'description' => 'Groceries',
+            'href' => 'http://example.com/todolists/200',
+            'links' => {
+              'todos' => %w(300 301),
+              'tags' => ['30']
+            }
+          },
+          {
+            'type' => 'todolists',
+            '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)
-                ]
-              }
+          },
+          {
+            'type' => 'tags',
+            'id' => '10',
+            'guid' => '10',
+            'name' => 'Urgent!',
+            'links' => {
+              'taggables' => [
+                %w(projects 100),
+                %w(todos 300),
+                %w(todos 301),
+                %w(todos 330)
+              ]
             }
-          ]
-        }
+          },
+          {
+            'type' => 'tags',
+            'id' => '20',
+            'guid' => '20',
+            'name' => 'On Hold',
+            'links' => {
+              'taggables' => [
+                %w(projects 110)
+              ]
+            }
+          }
+        ]
       }
     end
   end

data/test/integration/render_nested_include_test.rb

@@ -4,26 +4,25 @@ require 'test_helper'
 module SimpleJsonApi
   describe 'RenderNestedIncludeTest' do
     it 'should match json hash for a project with nested includes specified' do
-      compare_json(actual_project, expected_project.to_json)
-      JSON.parse(actual_project).must_equal expected_project
+      actual_project.must_match_json expected_project
+      # ap '_' * 20
+      # ObjectSpace.each_object(ApiNode).each { |an| ap an.name }
     end
 
     let(:actual_project) do
       SimpleJsonApi.render(
         model: Project.first,
         serializer: ProjectSerializer,
-        options: {
-          include: 'todolists'\
+        include: 'todolists'\
                  ',todolists.todos'\
-                 ',todolists.todos.tags'\
                  ',todolists.todos.tags.taggables',
-          fields: { projects: 'id', todolists: 'id', todos: 'id', tags: 'guid' }
-        }
+        fields: { projects: 'id', todolists: 'id', todos: 'id', tags: 'guid' }
       )
     end
     let(:expected_project) do
       {
-        'projects' => {
+        'data' => {
+          'type' => 'projects',
           'id' => '100',
           'href' => 'http://example.com/projects/100',
           'links' => {
@@ -31,85 +30,41 @@ module SimpleJsonApi
             'tags' => ['10']
           }
         },
-        'linked' => {
-          'todolists' => [
-            {
-              'id' => '200',
-              'href' => 'http://example.com/todolists/200',
-              'links' => {
-                'todos' => ['300'],
-                'tags' => ['30']
-              }
+        'included' => [
+          {
+            'type' => 'todolists',
+            'id' => '200',
+            'href' => 'http://example.com/todolists/200',
+            'links' => {
+              'todos' => %w(300 301),
+              'tags' => ['30']
             }
-          ],
-          'todos' => [
-            {
-              'id' => '300',
-              'href' => 'http://example.com/todos/300',
-              'links' => {
-                'tags' => %w(10 20)
-              }
-            },
-            {
-              'id' => '330',
-              'href' => 'http://example.com/todos/330',
-              'links' => {
-                'tags' => ['10']
-              }
-            },
-            # FIXME: duplicate!!!!!
-            {
-              'id' => '300',
-              'href' => 'http://example.com/todos/300',
-              'links' => {
-                'tags' => %w(10 20)
-              }
+          },
+          {
+            'type' => 'todos',
+            'id' => '300',
+            'href' => 'http://example.com/todos/300',
+            'links' => {
+              'tags' => %w(10 30)
             }
-          ],
-          'tags' => [
-            {
-              'guid' => '10',
-              'links' => {
-                'taggables' => [
-                  %w(projects 100),
-                  %w(todos 300),
-                  %w(todos 330)
-                ]
-              }
-            },
-            {
-              'guid' => '20',
-              'links' => {
-                'taggables' => [
-                  %w(projects 110),
-                  %w(todos 300)
-                ]
-              }
+          },
+          {
+            'type' => 'todos',
+            'id' => '301',
+            'href' => 'http://example.com/todos/301',
+            'links' => {
+              'tags' => %w(10)
             }
-          ],
-          'projects' => [
-            {
-              'id' => '100',
-              'href' => 'http://example.com/projects/100',
-              'links' => {
-                'todolist' => '200',
-                'tags' => [
-                  '10'
-                ]
-              }
-            },
-            {
-              'id' => '110',
-              'href' => 'http://example.com/projects/110',
-              'links' => {
-                'todolist' => '210',
-                'tags' => [
-                  '20'
-                ]
-              }
+          },
+          {
+            'type' => 'todos',
+            'id' => '330',
+            'href' => 'http://example.com/todos/330',
+            'links' => {
+              'tags' => %w(10)
             }
-          ]
-        }
+          }
+        ]
       }
     end
   end