simple_json_api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d342c421da25b887edeade3d14b1a145bbe3a352
-  data.tar.gz: 2720735c97db2a23d45ac6154460f2c92f8dfa67
+  metadata.gz: 75b1e1d7eab7671430dab2b735ea9b3ce3d0b921
+  data.tar.gz: 04ad4e30da53078764dbafa68edab1ca81f579b5
 SHA512:
-  metadata.gz: 87165f1029afae88c79cae12d06d502ad77fe55c6d2a68cdb02b6446ef757b73cc2ea3e0906418083ba1f358f5a79a88a7348acdb8754227e6d24c65f9182038
-  data.tar.gz: 7f0428e1ab60247971c0ef04ad4a09a156ab62c5c784473024c90da6809ec6656fd77b006025593aa3b021852219830f585cbd004e401544a07a6c905fd2e825
+  metadata.gz: e8eabae974ab4bf5aa7775b59bd2af0ae6a27ca46e72aaf8be3831ad586d040b6f28a2b400e51c78efff351b1168602cf7d4f841c01b202596833f3f840197ea
+  data.tar.gz: 43ff3b97dc119fcf716b5a4890785321bfe7077cbfdbc7e79a9d4d1449fb5b100b6d2defde06de30ab05d1be079b8f71ec74d8328d6c1255d5864da7fadaa159

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - 2.1
-  - 2.2
+  - 2.2.1
 env:
   - 'RAILS_VERSION=4.0'
   - 'RAILS_VERSION=4.1'

data/README.md

@@ -20,6 +20,11 @@ Or install it yourself as:
 
     $ gem install simple_json_api
 
+
+### Rails Integration
+
+Use the gem [simple_json_api-rails](https://github.com/dajacques/simple_json_api-rails)
+
 ## Usage
 
 ### Define serializers
@@ -59,6 +64,7 @@ render json: SimpleJsonApi.render(
 When rendering the model is the AR data to be serialized, if it is an Array the ArraySerializer will be used for the top collection.
 `fields` and `include` follow the jsonapi spec. [Include](http://jsonapi.org/format/#fetching-includes) will be the associations to be included in the generated json. [Fields](http://jsonapi.org/format/#fetching-sparse-fieldsets) is the list of attributes that will be included. The primary key will always be included.
 
+
 ## TODO
 
 0. Better documentation

data/lib/simple_json_api/api_node.rb

@@ -20,6 +20,10 @@ module SimpleJsonApi
       @associations = [] # list of api_nodes
     end
 
+    def collection?
+      @serializer.is_a? ArraySerializer
+    end
+
     def load
       return self unless serializer_actual._associations
       serializer_actual._associations.each do |association|
@@ -29,27 +33,35 @@ module SimpleJsonApi
     end
 
     def serializer_actual
-      @serializer_actual ||= @each_serializer || self.serializer
+      @serializer_actual ||= @each_serializer || serializer
     end
 
     def add_association(association)
       return unless @assoc_list.key? association.plural_name
       resource = serializer.associated_object(association.name)
       Array(resource).each do |object|
-        each_serializer = Serializer.for(object, association)
-        serializer = SerializerFactory.create(
-          object, each_serializer, self.serializer._builder
-        )
-        self <<
-          ApiNode.new(
-            association.plural_name,
-            serializer,
-            @assoc_list[association.plural_name],
-            serializer._each_serializer
-          ).load
+        add_nodes(association, object)
       end
     end
 
+    def add_nodes(association, object)
+      each_serializer = Serializer.for(object, association)
+      serializer = SerializerFactory.create(
+        object, each_serializer, self.serializer._builder
+      )
+      add_node(association, serializer)
+    end
+
+    def add_node(association, serializer)
+      self <<
+        ApiNode.new(
+          association.plural_name,
+          serializer,
+          @assoc_list[association.plural_name],
+          serializer._each_serializer
+        ).load
+    end
+
     def <<(node)
       add_assoc(node)
     end
@@ -59,7 +71,8 @@ module SimpleJsonApi
     end
 
     # def display(offset = '')
-    #   ap "DISPLAY: #{offset}#{@name}, #{@assoc_list}, #{Array(@object).first.class}, #{Array(@object).map(&:id)}"
+    #   ap "DISPLAY: #{offset}#{@name}, #{@assoc_list}, \
+    # #{Array(@object).first.class}, #{Array(@object).map(&:id)}"
     #   @associations.each do |assoc|
     #     assoc.display(offset + '  ')
     #   end

data/lib/simple_json_api/builder.rb

@@ -19,17 +19,20 @@ module SimpleJsonApi
     def_delegators :@field_list, :fields_for
 
     # TODO: sort: nil
-    def initialize(object, wrapper, serializer, fields, include)
+    def initialize(object, wrapper, serializer, fields, include, page)
       @object = object
       @wrapper = wrapper
       @field_list = FieldList.new(fields, serializer)
       @include = IncludeList.new(include).parse
+      @page = page
       @serializer = SerializerFactory.create(object, serializer, self)
     end
 
     def as_json(options = nil)
-      root_node = ApiNode.new(serializer._root_name, serializer, include.include_hash).load
-      wrapper.new(root_node).as_json(options)
+      root_node = ApiNode.new(
+        serializer._root_name, serializer, include.include_hash
+      ).load
+      wrapper.new(root_node, @page).as_json(options)
     end
   end
 end

data/lib/simple_json_api/dsl.rb

@@ -69,14 +69,15 @@ module SimpleJsonApi
       define_assoc_method(association) # unless defined? association.name
     end
 
-    def define_assoc_method(association)
-      if association.type == :has_many
-        define_method association.name do |includes = nil|
-          _object.send(association.name).includes(includes).to_a if _object.respond_to?(association.name)
+    def define_assoc_method(assoc)
+      if assoc.type == :has_many
+        define_method assoc.name do |includes = nil|
+          _object.send(assoc.name).includes(includes).to_a \
+            if _object.respond_to?(assoc.name)
         end
       else
-        define_method association.name do |includes = nil|
-          _object.send(association.name) if _object.respond_to?(association.name)
+        define_method assoc.name do |_includes = nil|
+          _object.send(assoc.name) if _object.respond_to?(assoc.name)
         end
       end
     end

data/lib/simple_json_api/json_api_wrapper.rb

@@ -6,8 +6,9 @@ require 'simple_json_api/member/meta'
 module SimpleJsonApi
   # JSONAPI Wrapper
   class JsonApiWrapper
-    def initialize(root_node)
+    def initialize(root_node, page)
       @root_node = root_node
+      @page = page
       @result = {}
     end
 
@@ -27,7 +28,8 @@ module SimpleJsonApi
     end
 
     def links
-      @result[:links] ||= Member::Links.new.content
+      page = @root_node.collection? ? @page : {}
+      @result[:links] ||= Member::Links.new(page).content
     end
 
     def meta

data/lib/simple_json_api/member/links.rb

@@ -2,7 +2,12 @@ module SimpleJsonApi
   module Member
     # JSONAPI Links top-level member
     class Links
+      def initialize(page)
+        @page = page
+      end
+
       def content
+        { page: @page } if @page.present?
       end
     end
   end

data/lib/simple_json_api/refinements/active_record.rb

@@ -7,7 +7,7 @@ module SimpleJsonApi
     module ActiveRecord
       refine ::ActiveRecord::Base do
         def typed_json_id
-          [self.class.to_s.downcase.pluralize, json_id]
+          { type: self.class.to_s.downcase.pluralize, id: json_id }
         end
 
         def json_id

data/lib/simple_json_api/refinements/array.rb

@@ -4,7 +4,7 @@ module SimpleJsonApi
     # Refinements on Array
     module Array
       refine ::Array do
-        def includes(includes = nil)
+        def includes(_includes = nil)
           self
         end
       end

data/lib/simple_json_api/resource_serializer.rb

@@ -40,10 +40,10 @@ module SimpleJsonApi
       _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)
+      root[:self] = href if self.class.method_defined? :href
       self.class._associations.each do |association|
         root[association.key] = link(association)
       end
@@ -51,14 +51,33 @@ module SimpleJsonApi
 
     def link(association)
       if association.type == :has_many
-        includes = association.polymorphic ? [] : Serializer.includes(association)
-        resource = send(association.name, includes)
-        resource.map do |obj|
-          association[:polymorphic] ? obj.typed_json_id : obj.json_id
-        end
+        link_many(association)
       else
-        resource = send(association.name)
-        resource.json_id if resource
+        link_one(association)
+      end
+    end
+
+    def link_many(association)
+      resource = send(association.name, includes(association))
+      { linkage: linkage_values(resource) }
+    end
+
+    def link_one(association)
+      resource = send(association.name)
+      { linkage: resource.typed_json_id } if resource
+    end
+
+    def linkage_values(resource)
+      resource.map do |obj|
+        obj.typed_json_id
+      end
+    end
+
+    def includes(association)
+      if association.polymorphic
+        []
+      else
+        Serializer.includes(association)
       end
     end
 

data/lib/simple_json_api/serializer.rb

@@ -40,10 +40,10 @@ module SimpleJsonApi
     def builder_fields
       bf = _builder.fields_for(_root_name).presence
       fields = if bf.present?
-        (required_fields + Array(bf)).uniq
-      else
-        default_fields ? default_fields & all_fields : all_fields
-      end
+                 (required_fields + Array(bf)).uniq
+               else
+                 default_fields ? default_fields & all_fields : all_fields
+               end
       (required_fields + Array(fields)).uniq.map(&:to_sym)
     end
 
@@ -67,7 +67,9 @@ module SimpleJsonApi
 
       def includes(association)
         serializer = Serializer.for_regular(association)
-        serializer._associations.reject(&:polymorphic).map { |a| a[:name] } if serializer
+        serializer._associations.reject(&:polymorphic).map do |assoc|
+          assoc[:name]
+        end if serializer
       end
 
       def for_regular(association)

data/lib/simple_json_api/version.rb

@@ -1,4 +1,4 @@
 # SimpleJsonApi
 module SimpleJsonApi
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/simple_json_api.rb

@@ -10,7 +10,7 @@ require 'simple_json_api/helper'
 # SimpleJsonApi
 module SimpleJsonApi
   # Main hook to generate json
-  def self.render(model:, serializer:, fields: nil, include: nil, wrapper: JsonApiWrapper)
-    Builder.new(model, wrapper, serializer, fields, include).to_json
+  def self.render(model:, serializer:, fields: nil, include: nil, page: {}, wrapper: JsonApiWrapper)
+    Builder.new(model, wrapper, serializer, fields, include, page).to_json
   end
 end

data/test/integration/render_basic_test.rb

@@ -25,10 +25,16 @@ module SimpleJsonApi
           'name' => 'First Project',
           'description' => 'The first project',
           'position' => '',
-          'href' => 'http://example.com/projects/100',
           'links' => {
-            'todolist' => '200',
-            'tags' => %w(10)
+            'self' => 'http://example.com/projects/100',
+            'todolist' => {
+              'linkage' => { 'type' => 'todolists', 'id' => '200' }
+            },
+            'tags' => {
+              'linkage' => [
+                { 'type' => 'tags', 'id' => '10' }
+              ]
+            }
           }
         }
       }
@@ -49,10 +55,16 @@ module SimpleJsonApi
             'name' => 'First Project',
             'description' => 'The first project',
             'position' => '',
-            'href' => 'http://example.com/projects/100',
             'links' => {
-              'todolist' => '200',
-              'tags' => %w(10)
+              'self' => 'http://example.com/projects/100',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '200' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' }
+                ]
+              }
             }
           },
           {
@@ -61,10 +73,16 @@ module SimpleJsonApi
             'name' => 'Second Project',
             'description' => 'The second project',
             'position' => '',
-            'href' => 'http://example.com/projects/110',
             'links' => {
-              'todolist' => '210',
-              'tags' => %w(20)
+              'self' => 'http://example.com/projects/110',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '210' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '20' }
+                ]
+              }
             }
           }
         ]

data/test/integration/render_fields_test.rb

@@ -29,10 +29,16 @@ module SimpleJsonApi
           'id' => '100',
           'name' => 'First Project',
           'description' => 'The first project',
-          'href' => 'http://example.com/projects/100',
           'links' => {
-            'todolist' => '200',
-            'tags' => ['10']
+            'self' => 'http://example.com/projects/100',
+            'todolist' => {
+              'linkage' => { 'type' => 'todolists', 'id' => '200' }
+            },
+            'tags' => {
+              'linkage' => [
+                { 'type' => 'tags', 'id' => '10' }
+              ]
+            }
           }
         }
       }
@@ -53,10 +59,16 @@ module SimpleJsonApi
             'id' => '100',
             'name' => 'First Project',
             'description' => 'The first project',
-            'href' => 'http://example.com/projects/100',
             'links' => {
-              'todolist' => '200',
-              'tags' => ['10']
+              'self' => 'http://example.com/projects/100',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '200' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' }
+                ]
+              }
             }
           },
           {
@@ -64,10 +76,16 @@ module SimpleJsonApi
             'id' => '110',
             'name' => 'Second Project',
             'description' => 'The second project',
-            'href' => 'http://example.com/projects/110',
             'links' => {
-              'todolist' => '210',
-              'tags' => ['20']
+              'self' => 'http://example.com/projects/110',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '210' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '20' }
+                ]
+              }
             }
           }
         ]
@@ -86,9 +104,14 @@ module SimpleJsonApi
           'type' => 'todos',
           'id' => '300',
           'action' => 'Milk',
-          'href' => 'http://example.com/todos/300',
           'links' => {
-            'tags' => %w(10 30)
+            'self' => 'http://example.com/todos/300',
+            'tags' => {
+              'linkage' => [
+                { 'type' => 'tags', 'id' => '10' },
+                { 'type' => 'tags', 'id' => '30' }
+              ]
+            }
           }
         }
       }

data/test/integration/render_include_test.rb

@@ -26,10 +26,16 @@ module SimpleJsonApi
           'name' => 'First Project',
           'description' => 'The first project',
           'position' => '',
-          'href' => 'http://example.com/projects/100',
           'links' => {
-            'todolist' => '200',
-            'tags' => ['10']
+            'self' => 'http://example.com/projects/100',
+            'todolist' => {
+              'linkage' => { 'type' => 'todolists', 'id' => '200' }
+            },
+            'tags' => {
+              'linkage' => [
+                { 'type' => 'tags', 'id' => '10' }
+              ]
+            }
           }
         },
         'included' => [
@@ -37,10 +43,19 @@ module SimpleJsonApi
             'type' => 'todolists',
             'id' => '200',
             'description' => 'Groceries',
-            'href' => 'http://example.com/todolists/200',
             'links' => {
-              'todos' => %w(300 301),
-              'tags' => ['30']
+              'self' => 'http://example.com/todolists/200',
+              'todos' => {
+                'linkage' => [
+                  { 'type' => 'todos', 'id' => '300' },
+                  { 'type' => 'todos', 'id' => '301' }
+                ]
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '30' }
+                ]
+              }
             }
           }
         ]
@@ -63,10 +78,16 @@ module SimpleJsonApi
             'name' => 'First Project',
             'description' => 'The first project',
             'position' => '',
-            'href' => 'http://example.com/projects/100',
             'links' => {
-              'todolist' => '200',
-              'tags' => ['10']
+              'self' => 'http://example.com/projects/100',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '200' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' }
+                ]
+              }
             }
           },
           {
@@ -75,10 +96,16 @@ module SimpleJsonApi
             'name' => 'Second Project',
             'description' => 'The second project',
             'position' => '',
-            'href' => 'http://example.com/projects/110',
             'links' => {
-              'todolist' => '210',
-              'tags' => ['20']
+              'self' => 'http://example.com/projects/110',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '210' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '20' }
+                ]
+              }
             }
           }
         ],
@@ -87,10 +114,19 @@ module SimpleJsonApi
             'type' => 'todolists',
             'id' => '200',
             'description' => 'Groceries',
-            'href' => 'http://example.com/todolists/200',
             'links' => {
-              'todos' => %w(300 301),
-              'tags' => ['30']
+              'self' => 'http://example.com/todolists/200',
+              'todos' => {
+                'linkage' => [
+                  { 'type' => 'todos', 'id' => '300' },
+                  { 'type' => 'todos', 'id' => '301' }
+                ]
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '30' }
+                ]
+              }
             }
           },
           {
@@ -98,10 +134,18 @@ module SimpleJsonApi
             'id' => '210',
             'description' => 'Groceries',
             'description' => 'Work',
-            'href' => 'http://example.com/todolists/210',
             'links' => {
-              'todos' => %w(310 320 330),
-              'tags' => []
+              'self' => 'http://example.com/todolists/210',
+              'todos' => {
+                'linkage' => [
+                  { 'type' => 'todos', 'id' => '310' },
+                  { 'type' => 'todos', 'id' => '320' },
+                  { 'type' => 'todos', 'id' => '330' }
+                ]
+              },
+              'tags' => {
+                'linkage' => []
+              }
             }
           },
           {
@@ -110,12 +154,14 @@ module SimpleJsonApi
             'guid' => '10',
             'name' => 'Urgent!',
             'links' => {
-              'taggables' => [
-                %w(projects 100),
-                %w(todos 300),
-                %w(todos 301),
-                %w(todos 330)
-              ]
+              'taggables' => {
+                'linkage' => [
+                  { 'type' => 'projects', 'id' => '100' },
+                  { 'type' => 'todos', 'id' => '300' },
+                  { 'type' => 'todos', 'id' => '301' },
+                  { 'type' => 'todos', 'id' => '330' }
+                ]
+              }
             }
           },
           {
@@ -124,9 +170,11 @@ module SimpleJsonApi
             'guid' => '20',
             'name' => 'On Hold',
             'links' => {
-              'taggables' => [
-                %w(projects 110)
-              ]
+              'taggables' => {
+                'linkage' => [
+                  { 'type' => 'projects', 'id' => '110' }
+                ]
+              }
             }
           }
         ]

data/test/integration/render_nested_include_test.rb

@@ -24,44 +24,72 @@ module SimpleJsonApi
         'data' => {
           'type' => 'projects',
           'id' => '100',
-          'href' => 'http://example.com/projects/100',
           'links' => {
-            'todolist' => '200',
-            'tags' => ['10']
+            'self' => 'http://example.com/projects/100',
+            'todolist' => {
+              'linkage' => { 'type' => 'todolists', 'id' => '200' }
+            },
+            'tags' => {
+              'linkage' => [
+                { 'type' => 'tags', 'id' => '10' }
+              ]
+            }
           }
         },
         'included' => [
           {
             'type' => 'todolists',
             'id' => '200',
-            'href' => 'http://example.com/todolists/200',
             'links' => {
-              'todos' => %w(300 301),
-              'tags' => ['30']
+              'self' => 'http://example.com/todolists/200',
+              'todos' => {
+                'linkage' => [
+                  { 'type' => 'todos', 'id' => '300' },
+                  { 'type' => 'todos', 'id' => '301' }
+                ]
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '30' }
+                ]
+              }
             }
           },
           {
             'type' => 'todos',
             'id' => '300',
-            'href' => 'http://example.com/todos/300',
             'links' => {
-              'tags' => %w(10 30)
+              'self' => 'http://example.com/todos/300',
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' },
+                  { 'type' => 'tags', 'id' => '30' }
+                ]
+              }
             }
           },
           {
             'type' => 'todos',
             'id' => '301',
-            'href' => 'http://example.com/todos/301',
             'links' => {
-              'tags' => %w(10)
+              'self' => 'http://example.com/todos/301',
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' }
+                ]
+              }
             }
           },
           {
             'type' => 'todos',
             'id' => '330',
-            'href' => 'http://example.com/todos/330',
             'links' => {
-              'tags' => %w(10)
+              'self' => 'http://example.com/todos/330',
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' }
+                ]
+              }
             }
           }
         ]

data/test/integration/render_pagination_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  describe 'RenderPaginationTest' do
+    it 'should match json hash for a project with no options' do
+      actual_project.must_match_json expected_project
+    end
+
+    it 'should match json hash for a project array with no options' do
+      actual_projects.must_match_json expected_projects
+    end
+
+    let(:actual_project) do
+      SimpleJsonApi.render(
+        model: Project.first,
+        serializer: ProjectSerializer,
+        page: { number: 5, size: 20, total: 19 }
+      )
+    end
+    let(:expected_project) do
+      {
+        'data' => {
+          'type' => 'projects',
+          'id' => '100',
+          'name' => 'First Project',
+          'description' => 'The first project',
+          'position' => '',
+          'links' => {
+            'self' => 'http://example.com/projects/100',
+            'todolist' => {
+              'linkage' => { 'type' => 'todolists', 'id' => '200' }
+            },
+            'tags' => {
+              'linkage' => [
+                { 'type' => 'tags', 'id' => '10' }
+              ]
+            }
+          }
+        }
+      }
+    end
+
+    let(:actual_projects) do
+      SimpleJsonApi.render(
+        model: Project.all.to_a,
+        serializer: ProjectSerializer,
+        page: { number: 5, size: 20, total: 19 }
+      )
+    end
+    let(:expected_projects) do
+      {
+        'links' => {
+          'page' => {
+            'number' => 5,
+            'size' => 20,
+            'total' => 19
+          }
+        },
+        'data' => [
+          {
+            'type' => 'projects',
+            'id' => '100',
+            'name' => 'First Project',
+            'description' => 'The first project',
+            'position' => '',
+            'links' => {
+              'self' => 'http://example.com/projects/100',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '200' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '10' }
+                ]
+              }
+            }
+          },
+          {
+            'type' => 'projects',
+            'id' => '110',
+            'name' => 'Second Project',
+            'description' => 'The second project',
+            'position' => '',
+            'links' => {
+              'self' => 'http://example.com/projects/110',
+              'todolist' => {
+                'linkage' => { 'type' => 'todolists', 'id' => '210' }
+              },
+              'tags' => {
+                'linkage' => [
+                  { 'type' => 'tags', 'id' => '20' }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    end
+  end
+end

data/test/setup/data.rb

@@ -20,7 +20,6 @@ todo1.tags << tag3
 todo2 = list1.todos.create(id: 301, action: 'Bread')
 todo2.tags << tag1
 
-
 list2 = project2.create_todolist(id: 210, description: 'Work')
 list2.todos.create(id: 310, action: 'Timesheet')
 list2.todos.create(id: 320, action: 'Meeting')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_json_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Gary Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -68,10 +68,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/simple_json_api/resource/USAGE
-- lib/generators/simple_json_api/resource/resource_generator.rb
-- lib/generators/simple_json_api/resource/templates/controller_template.rb.erb
-- lib/generators/simple_json_api/resource/templates/serializer_template.rb.erb
 - lib/simple_json_api.rb
 - lib/simple_json_api/api_node.rb
 - lib/simple_json_api/array_serializer.rb
@@ -97,11 +93,11 @@ files:
 - lib/simple_json_api/version.rb
 - simple_json_api.gemspec
 - test/fixtures/projects.yml
-- test/generators/simple_json_api/resource_generator_test.rb
 - test/integration/render_basic_test.rb
 - test/integration/render_fields_test.rb
 - test/integration/render_include_test.rb
 - test/integration/render_nested_include_test.rb
+- test/integration/render_pagination_test.rb
 - test/integration/serializers_test.rb
 - test/setup/data.rb
 - test/setup/models.rb
@@ -135,17 +131,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Simple JSON API Serializer.
 test_files:
 - test/fixtures/projects.yml
-- test/generators/simple_json_api/resource_generator_test.rb
 - test/integration/render_basic_test.rb
 - test/integration/render_fields_test.rb
 - test/integration/render_include_test.rb
 - test/integration/render_nested_include_test.rb
+- test/integration/render_pagination_test.rb
 - test/integration/serializers_test.rb
 - test/setup/data.rb
 - test/setup/models.rb

data/lib/generators/simple_json_api/resource/USAGE

@@ -1,8 +0,0 @@
-Description:
-    Explain the generator
-
-Example:
-    rails generate simple_json_api:resource resource
-
-    This will create:
-        what/will/it/create

data/lib/generators/simple_json_api/resource/resource_generator.rb

@@ -1,73 +0,0 @@
-module SimpleJsonApi
-  module Generators
-    # Generates the resource template files
-    class ResourceGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('../templates', __FILE__)
-
-      argument :name, type: :string, required: true, banner: 'ResourceName'
-
-      class_option :model,
-                   desc: 'Model class if different than Resource',
-                   type: :string
-      class_option :namespace,
-                   desc: 'Namespace for the generated files',
-                   type: :string
-      class_option :controller,
-                   desc: 'Base controller for resources',
-                   type: :string
-      class_option :skip_serializer,
-                   desc: "Don't generate a serializer file.",
-                   type: :boolean
-      class_option :skip_controller,
-                   desc: "Don't generate a controller file.",
-                   type: :boolean
-      class_option :skip_service,
-                   desc: "Don't generate a service file.",
-                   type: :boolean
-      class_option :root_dir,
-                   desc: "Root dir for generated code, default: '.'.",
-                   type: :string
-
-      def create_resource
-        @namespace = options[:namespace]
-        @model = options[:model] || class_name
-        namespaced_name = [@namespace, class_name].compact.join('::')
-        @serializer_name = "#{namespaced_name}Serializer"
-        @controller_name = "#{namespaced_name.pluralize}Controller"
-        @base_controller = options[:controller] || 'ApplicationController'
-        @root_dir = options[:root_dir] || '.'
-        file_path = "#{@namespace.underscore}/#{class_name.underscore}"
-
-        check_model
-
-        unless options[:skip_serializer]
-          template 'serializer_template.rb.erb',
-                   "#{@root_dir}/app/serializers/#{file_path}_serializer.rb"
-          # TODO: create serializer test
-        end
-
-        unless options[:skip_controller]
-          template 'controller_template.rb.erb',
-                   "#{@root_dir}/app/controllers/#{file_path.pluralize}_controller.rb"
-          # TODO: create controller test
-        end
-
-        unless options[:skip_service]
-          # TODO: create service
-          # TODO: create service test
-        end
-      end
-
-      private
-
-      def check_model
-        unless @model.constantize.ancestors.include?(ActiveRecord::Base)
-          fail NameError
-        end
-      rescue NameError
-        puts "Error: '#{@model}' is not an AR model"
-        exit
-      end
-    end
-  end
-end

data/lib/generators/simple_json_api/resource/templates/controller_template.rb.erb

@@ -1,34 +0,0 @@
-class <%= @controller_name -%> < <%= @base_controller %>
-  include SimpleJsonApi::Helper
-
-  def index
-    @<%= class_name.underscore.gsub('/', '__').pluralize %> = <%= @model -%>.paginate(page: params[:page], per_page: params[:per_page]).to_a
-    render json: SimpleJsonApi.render(
-                   model: @<%= class_name.underscore.gsub('/', '__').pluralize %>,
-                   serializer: <%= @serializer_name %>,
-                   fields: options_hash.fetch(:fields, nil),
-                   include: options_hash.fetch(:include, nil)
-                 ),
-           status: 200
-  end
-
-  def show
-    @<%= class_name.underscore.gsub('/', '__') %> = <%= @model -%>.find(params[:id])
-    render json: SimpleJsonApi.render(
-                   model: @<%= class_name.underscore.gsub('/', '__') %>,
-                   serializer: <%= @serializer_name %>,
-                   fields: options_hash.fetch(:fields, nil),
-                   include: options_hash.fetch(:include, nil)
-                 ),
-           status: 200
-  end
-
-  private
-
-  def options_hash
-    {
-      fields: params[:fields],
-      include: params[:include]
-    }
-  end
-end

data/lib/generators/simple_json_api/resource/templates/serializer_template.rb.erb

@@ -1,14 +0,0 @@
-class <%= @serializer_name -%> < SimpleJsonApi::ResourceSerializer
-  serializes :<%= class_name.underscore.gsub('/', '__').pluralize %>, model: <%= "::#{@model}" -%>, primary_key: :<%= @model.constantize.primary_key %>
-
-  <%- @model.constantize.column_names.each do |col| -%>
-  attribute :<%= col %>
-  <%- end -%>
-
-  <%- @model.constantize.reflect_on_all_associations.each do |assoc| -%>
-    <%- klass_name = assoc.options[:class_name] -%>
-    <%- serializer = [@namespace, klass_name].compact.join('::') + 'Serializer' if klass_name -%>
-  <%= assoc.macro %> :<%= assoc.name %><%= ', polymorphic: true' if assoc.options[:polymorphic] %><%= ', serializer: ' + serializer if serializer %>
-  <%- end -%>
-end
-

data/test/generators/simple_json_api/resource_generator_test.rb

@@ -1,31 +0,0 @@
-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