jsonapi-resources 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1f659549f6b8804be7a7bed6ca3a359a37fc5e
-  data.tar.gz: 3703986e36f362f348ce463d4977b268171d8f0b
+  metadata.gz: 885923e290e5ac1db4d49ed616f8f93b978edabe
+  data.tar.gz: f9ba1571591967f00bd09b274b2aae34b01153e0
 SHA512:
-  metadata.gz: 7b368231330b4c2a21bcfde117c7c4797a16c3bf145e20525b6fcdff429fde0a276e2b9b95b0e265dee890f37b4862529e7780f4caef90886d99ea36a4877af5
-  data.tar.gz: 4518564dceb728f5a594dd93c9fcf22de5051ad6397a4282513ad8f8f7d27c7bae355cae3bc8a9fd593fc11bdfdb91885f878a17a809d0150d1ef4daa4a7a174
+  metadata.gz: 305b0ae0b9f37ec829b178769044957f12f90c0272b69339b930deabac8f8f34bf310539597eeb01adc911c3bb897fd9aa60b52b3b077c9d925e926fa9fca157
+  data.tar.gz: d9716961f3daeb72d56ae12b37c42960f8dcd99042f8cf6d884d67081ceebfc1ae20510eef1d682fe504e726433ce443dc5007c6cd3da0a1065c1eef708948c3

data/README.md

@@ -106,6 +106,50 @@ class ContactResource < BaseResource
 end
 ```
 
+##### Immutable Resources
+
+Resources that are immutable should be declared as such with the `immutable` method. Immutable resources will only
+generate routes for `index`, `show` and `show_relationship`.
+
+###### Immutable for Readonly
+
+Some resources are read-only and are not to be modified through the API. Declaring a resource as immutable prevents 
+creation of routes that allow modification of the resource.
+
+###### Immutable Heterogeneous Collections
+
+Immutable resources can be used as the basis for a heterogeneous collection. Resources in heterogeneous collections can
+still be mutated through their own type-specific endpoints.
+
+```ruby
+class VehicleResource < JSONAPI::Resource
+  immutable
+
+  has_one :owner
+  attributes :make, :model, :serial_number
+end
+
+class CarResource < VehicleResource
+  attributes :drive_layout
+  has_one :driver
+end
+
+class BoatResource < VehicleResource
+  attributes :length_at_water_line
+  has_one :captain
+end
+
+# routes
+  jsonapi_resources :vehicles
+  jsonapi_resources :cars
+  jsonapi_resources :boats
+
+```
+
+In the above example vehicles are immutable. A call to `/vehicles` or `/vehicles/1` will return vehicles with types
+of either `car` or `boat`. But calls to PUT or POST a `car` must be made to `/cars`. The rails models backing the above
+code use Single Table Inheritance.
+
 #### Attributes
 
 Any of a resource's attributes that are accessible must be explicitly declared. Single attributes can be declared using
@@ -516,7 +560,7 @@ section for additional details on raising errors.
 class BaseResource < JSONAPI::Resource
   def records_for(relation_name)
     context = options[:context]
-    records = model.public_send(relation_name)
+    records = _model.public_send(relation_name)
 
     unless context[:current_user].can_view?(records)
       raise NotAuthorizedError
@@ -779,12 +823,12 @@ Callbacks can be defined for the following `JSONAPI::Resource` events:
 - `:update`
 - `:remove`
 - `:save`
-- `:create_has_many_link`
-- `:replace_has_many_links`
-- `:create_has_one_link`
-- `:replace_has_one_link`
-- `:remove_has_many_link`
-- `:remove_has_one_link`
+- `:create_to_many_link`
+- `:replace_to_many_links`
+- `:create_to_one_link`
+- `:replace_to_one_link`
+- `:remove_to_many_link`
+- `:remove_to_one_link`
 - `:replace_fields`
 
 ##### `JSONAPI::OperationsProcessor` Callbacks
@@ -800,11 +844,11 @@ Callbacks can also be defined for `JSONAPI::OperationsProcessor` events:
 - `:create_resource_operation`: A `create_resource_operation`.
 - `:remove_resource_operation`: A `remove_resource_operation`.
 - `:replace_fields_operation`: A `replace_fields_operation`.
-- `:replace_has_one_relationship_operation`: A `replace_has_one_relationship_operation`.
-- `:create_has_many_relationship_operation`: A `create_has_many_relationship_operation`.
-- `:replace_has_many_relationship_operation`: A `replace_has_many_relationship_operation`.
-- `:remove_has_many_relationship_operation`: A `remove_has_many_relationship_operation`.
-- `:remove_has_one_relationship_operation`: A `remove_has_one_relationship_operation`.
+- `:replace_to_one_relationship_operation`: A `replace_to_one_relationship_operation`.
+- `:create_to_many_relationship_operation`: A `create_to_many_relationship_operation`.
+- `:replace_to_many_relationship_operation`: A `replace_to_many_relationship_operation`.
+- `:remove_to_many_relationship_operation`: A `remove_to_many_relationship_operation`.
+- `:remove_to_one_relationship_operation`: A `remove_to_one_relationship_operation`.
 
 The operation callbacks have access to two meta data hashes, `@operations_meta` and `@operation_meta`, two links hashes,
 `@operations_links` and `@operation_links`, the full list of `@operations`, each individual `@operation` and the

data/lib/jsonapi/exceptions.rb

@@ -297,7 +297,7 @@ module JSONAPI
       attr_reader :error_messages, :resource_relationships
 
       def initialize(resource)
-        @error_messages = resource.model.errors.messages
+        @error_messages = resource._model.errors.messages
         @resource_relationships = resource.class._relationships.keys
         @key_formatter = JSONAPI.configuration.key_formatter
       end

data/lib/jsonapi/paginator.rb

@@ -148,7 +148,7 @@ class PagedPaginator < JSONAPI::Paginator
     }
 
     if @number > 1
-      links_page_params['previous'] = {
+      links_page_params['prev'] = {
         'number' => @number - 1,
         'size' => @size
       }

data/lib/jsonapi/resource.rb

@@ -7,7 +7,6 @@ module JSONAPI
     @@resource_types = {}
 
     attr_reader :context
-    attr_reader :model
 
     define_jsonapi_resources_callbacks :create,
                                        :update,
@@ -27,8 +26,12 @@ module JSONAPI
       @context = context
     end
 
+    def _model
+      @model
+    end
+
     def id
-      model.public_send(self.class._primary_key)
+      _model.public_send(self.class._primary_key)
     end
 
     def is_new?
@@ -112,7 +115,7 @@ module JSONAPI
     # Override this on a resource to customize how the associated records
     # are fetched for a model. Particularly helpful for authorization.
     def records_for(relation_name)
-      model.public_send relation_name
+      _model.public_send relation_name
     end
 
     private
@@ -169,7 +172,7 @@ module JSONAPI
         # TODO: Add option to skip relations that already exist instead of returning an error?
         relation = @model.public_send(relation_name).where(relationship.primary_key => relationship_key_value).first
         if relation.nil?
-          @model.public_send(relation_name) << related_resource.model
+          @model.public_send(relation_name) << related_resource._model
         else
           fail JSONAPI::Exceptions::HasManyRelationExists.new(relationship_key_value)
         end
@@ -198,8 +201,8 @@ module JSONAPI
     def _replace_polymorphic_to_one_link(relationship_type, key_value, key_type)
       relationship = self.class._relationships[relationship_type.to_sym]
 
-      model.public_send("#{relationship.foreign_key}=", key_value)
-      model.public_send("#{relationship.polymorphic_type}=", key_type.to_s.classify)
+      _model.public_send("#{relationship.foreign_key}=", key_value)
+      _model.public_send("#{relationship.polymorphic_type}=", key_type.to_s.classify)
 
       @save_needed = true
 
@@ -258,6 +261,7 @@ module JSONAPI
     class << self
       def inherited(base)
         base.abstract(false)
+        base.immutable(false)
         base._attributes = (_attributes || {}).dup
         base._relationships = (_relationships || {}).dup
         base._allowed_filters = (_allowed_filters || Set.new).dup
@@ -499,7 +503,7 @@ module JSONAPI
 
         resources = []
         records.each do |model|
-          resources.push new(model, context)
+          resources.push resource_for(resource_type_for(model)).new(model, context)
         end
 
         resources
@@ -511,7 +515,11 @@ module JSONAPI
         records = apply_includes(records, options)
         model = records.where({_primary_key => key}).first
         fail JSONAPI::Exceptions::RecordNotFound.new(key) if model.nil?
-        new(model, context)
+        resource_for(resource_type_for(model)).new(model, context)
+      end
+
+      def resource_type_for(model)
+        self.module_path + model.class.to_s.underscore
       end
 
       # Override this method if you want to customize the relation for
@@ -554,40 +562,28 @@ module JSONAPI
 
       def verify_key(key, context = nil)
         key_type = resource_key_type
-        verification_proc = case key_type
 
+        case key_type
         when :integer
-          -> (key, context) {
-            begin
-              return key if key.nil?
-              Integer(key)
-            rescue
-              raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
-            end
-          }
+          return if key.nil?
+          Integer(key)
         when :string
-          -> (key, context) {
-            return key if key.nil?
-            if key.to_s.include?(',')
-              raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
-            else
-              key
-            end
-          }
+          return if key.nil?
+          if key.to_s.include?(',')
+            raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
+          else
+            key
+          end
         when :uuid
-          -> (key, context) {
-            return key if key.nil?
-            if key.to_s.match(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
-              key
-            else
-              raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
-            end
-          }
+          return if key.nil?
+          if key.to_s.match(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
+            key
+          else
+            raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
+          end
         else
-          key_type
+          key_type.call(key, context)
         end
-
-        verification_proc.call(key, context)
       rescue
         raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
       end
@@ -664,6 +660,18 @@ module JSONAPI
         @abstract
       end
 
+      def immutable(val = true)
+        @immutable = val
+      end
+
+      def _immutable
+        @immutable
+      end
+
+      def mutable?
+        !@immutable
+      end
+
       def _model_class
         return nil if _abstract
 
@@ -678,7 +686,7 @@ module JSONAPI
       end
 
       def module_path
-        @module_path ||= name =~ /::[^:]+\Z/ ? ($`.freeze.gsub('::', '/') + '/').underscore : ''
+        name =~ /::[^:]+\Z/ ? ($`.freeze.gsub('::', '/') + '/').underscore : ''
       end
 
       def construct_order_options(sort_params)
@@ -702,13 +710,13 @@ module JSONAPI
       def check_reserved_attribute_name(name)
         # Allow :id since it can be used to specify the format. Since it is a method on the base Resource
         # an attribute method won't be created for it.
-        if [:type, :href, :links, :model].include?(name.to_sym)
+        if [:type].include?(name.to_sym)
           warn "[NAME COLLISION] `#{name}` is a reserved key in #{@@resource_types[_type]}."
         end
       end
 
       def check_reserved_relationship_name(name)
-        if [:id, :ids, :type, :types, :href, :hrefs, :link, :links].include?(name.to_sym)
+        if [:id, :ids, :type, :types].include?(name.to_sym)
           warn "[NAME COLLISION] `#{name}` is a reserved relationship name in #{@@resource_types[_type]}."
         end
       end
@@ -755,7 +763,7 @@ module JSONAPI
               define_method attr do |options = {}|
                 if relationship.polymorphic?
                   associated_model = public_send(associated_records_method_name)
-                  resource_klass = Resource.resource_for(self.class.module_path + associated_model.class.to_s.underscore) if associated_model
+                  resource_klass = Resource.resource_for(self.class.resource_type_for(associated_model)) if associated_model
                   return resource_klass.new(associated_model, @context) if resource_klass
                 else
                   resource_klass = relationship.resource_klass
@@ -808,9 +816,7 @@ module JSONAPI
               end
 
               return records.collect do |record|
-                if relationship.polymorphic?
-                  resource_klass = Resource.resource_for(self.class.module_path + record.class.to_s.underscore)
-                end
+                resource_klass = Resource.resource_for(self.class.resource_type_for(record))
                 resource_klass.new(record, @context)
               end
             end unless method_defined?(attr)

data/lib/jsonapi/resource_serializer.rb

@@ -282,7 +282,7 @@ module JSONAPI
     def foreign_key_types_and_values(source, relationship)
       if relationship.is_a?(JSONAPI::Relationship::ToMany)
         if relationship.polymorphic?
-          source.model.public_send(relationship.name).pluck(:type, :id).map do |type, id|
+          source._model.public_send(relationship.name).pluck(:type, :id).map do |type, id|
             [type.pluralize, IdValueFormatter.format(id)]
           end
         else

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 end

data/lib/jsonapi/routing_ext.rb

@@ -80,6 +80,12 @@ module ActionDispatch
             options[:except] = [:new, :edit]
           end
 
+          if res._immutable
+            options[:except] << :create
+            options[:except] << :update
+            options[:except] << :destroy
+          end
+
           resources @resource_type, options do
             @scope[:jsonapi_resource] = @resource_type
 
@@ -117,14 +123,16 @@ module ActionDispatch
                                                                   action: 'show_relationship', relationship: link_type.to_s, via: [:get]
           end
 
-          if methods.include?(:update)
-            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                                                                  action: 'update_relationship', relationship: link_type.to_s, via: [:put, :patch]
-          end
+          if res.mutable?
+            if methods.include?(:update)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'update_relationship', relationship: link_type.to_s, via: [:put, :patch]
+            end
 
-          if methods.include?(:destroy)
-            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                                                                  action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
+            if methods.include?(:destroy)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
+            end
           end
         end
 
@@ -143,19 +151,21 @@ module ActionDispatch
                                                                   action: 'show_relationship', relationship: link_type.to_s, via: [:get]
           end
 
-          if methods.include?(:create)
-            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                                                                  action: 'create_relationship', relationship: link_type.to_s, via: [:post]
-          end
+          if res.mutable?
+            if methods.include?(:create)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'create_relationship', relationship: link_type.to_s, via: [:post]
+            end
 
-          if methods.include?(:update)
-            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                                                                  action: 'update_relationship', relationship: link_type.to_s, via: [:put, :patch]
-          end
+            if methods.include?(:update)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                    action: 'update_relationship', relationship: link_type.to_s, via: [:put, :patch]
+            end
 
-          if methods.include?(:destroy)
-            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
-                                                                        action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
+            if methods.include?(:destroy)
+              match "relationships/#{formatted_relationship_name}", controller: options[:controller],
+                                                                          action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
+            end
           end
         end
 

data/test/controllers/controller_test.rb

@@ -3069,15 +3069,15 @@ class Api::V1::CratersControllerTest < ActionController::TestCase
                         data: [
                           {id:"A4D3",
                            type:"craters",
-                           links:{self: "http://test.host/craters/A4D3"},
+                           links:{self: "http://test.host/api/v1/craters/A4D3"},
                            attributes:{code: "A4D3", description: "Small crater"},
-                           relationships:{moon: {links: {self: "http://test.host/craters/A4D3/relationships/moon", related: "http://test.host/craters/A4D3/moon"}}}
+                           relationships:{moon: {links: {self: "http://test.host/api/v1/craters/A4D3/relationships/moon", related: "http://test.host/api/v1/craters/A4D3/moon"}}}
                           },
                           {id: "S56D",
                            type: "craters",
-                           links:{self: "http://test.host/craters/S56D"},
+                           links:{self: "http://test.host/api/v1/craters/S56D"},
                            attributes:{code: "S56D", description: "Very large crater"},
-                           relationships:{moon: {links: {self: "http://test.host/craters/S56D/relationships/moon", related: "http://test.host/craters/S56D/moon"}}}
+                           relationships:{moon: {links: {self: "http://test.host/api/v1/craters/S56D/relationships/moon", related: "http://test.host/api/v1/craters/S56D/moon"}}}
                           }
                         ]
                       }
@@ -3091,3 +3091,71 @@ class Api::V1::CratersControllerTest < ActionController::TestCase
     assert_equal "1", json_response['data']['id']
   end
 end
+
+class CarsControllerTest < ActionController::TestCase
+  def setup
+    JSONAPI.configuration.json_key_format = :camelized_key
+  end
+
+  def test_create_sti
+    set_content_type_header!
+    post :create,
+         {
+           data: {
+             type: 'cars',
+             attributes: {
+               make: 'Toyota',
+               model: 'Tercel',
+               serialNumber: 'asasdsdadsa13544235',
+               driveLayout: 'FWD'
+             }
+           }
+         }
+
+    assert_response :created
+    assert json_response['data'].is_a?(Hash)
+    assert_equal 'cars', json_response['data']['type']
+    assert_equal 'Toyota', json_response['data']['attributes']['make']
+    assert_equal 'FWD', json_response['data']['attributes']['driveLayout']
+  end
+end
+
+class VehiclesControllerTest < ActionController::TestCase
+  def setup
+    JSONAPI.configuration.json_key_format = :camelized_key
+  end
+
+  def test_immutable_create_not_supported
+    set_content_type_header!
+
+    assert_raises ActionController::UrlGenerationError do
+      post :create,
+           {
+             data: {
+               type: 'cars',
+               attributes: {
+                 make: 'Toyota',
+                 model: 'Corrola',
+                 serialNumber: 'dsvffsfv',
+                 driveLayout: 'FWD'
+               }
+             }
+           }
+    end
+  end
+
+  def test_immutable_update_not_supported
+    set_content_type_header!
+
+    assert_raises ActionController::UrlGenerationError do
+      patch :update,
+            data: {
+              id: '1',
+              type: 'cars',
+              attributes: {
+                make: 'Toyota',
+              }
+            }
+    end
+  end
+end

data/test/fixtures/active_record.rb

@@ -214,12 +214,34 @@ ActiveRecord::Schema.define do
   create_table :vehicles, force: true do |t|
     t.string :type
     t.string :make
-    t.string :vehicle_model
+    t.string :model
     t.string :length_at_water_line
     t.string :drive_layout
     t.string :serial_number
     t.integer :person_id
   end
+
+  create_table :makes, force: true do |t|
+    t.string :model
+  end
+
+  # special cases - fields that look like they should be reserved names
+  create_table :hrefs, force: true do |t|
+    t.string :name
+  end
+
+  create_table :links, force: true do |t|
+    t.string :name
+  end
+
+  create_table :web_pages, force: true do |t|
+    t.string :href
+    t.string :link
+  end
+
+  create_table :questionables, force: true do |t|
+  end
+  # special cases
 end
 
 ### MODELS
@@ -474,6 +496,12 @@ class Product < ActiveRecord::Base
   has_one :picture, as: :imageable
 end
 
+class Make < ActiveRecord::Base
+end
+
+class WebPage < ActiveRecord::Base
+end
+
 ### OperationsProcessor
 class CountingActiveRecordOperationsProcessor < ActiveRecordOperationsProcessor
   after_find_operation do
@@ -558,6 +586,15 @@ end
 class ImageablesController < JSONAPI::ResourceController
 end
 
+class VehiclesController < JSONAPI::ResourceController
+end
+
+class CarsController < JSONAPI::ResourceController
+end
+
+class BoatsController < JSONAPI::ResourceController
+end
+
 ### CONTROLLERS
 module Api
   module V1
@@ -701,7 +738,7 @@ class BaseResource < JSONAPI::Resource
 end
 
 class PersonResource < BaseResource
-  attributes :id, :name, :email
+  attributes :name, :email
   attribute :date_joined, format: :date_with_timezone
 
   has_many :comments
@@ -727,8 +764,10 @@ class PersonResource < BaseResource
 end
 
 class VehicleResource < JSONAPI::Resource
+  immutable
+
   has_one :person
-  attributes :make, :vehicle_model, :serial_number
+  attributes :make, :model, :serial_number
 end
 
 class CarResource < VehicleResource
@@ -763,12 +802,6 @@ class TagResource < JSONAPI::Resource
   #has_many :planets
 end
 
-class SpecialTagResource < JSONAPI::Resource
-  attributes :name
-
-  has_many :posts
-end
-
 class SectionResource < JSONAPI::Resource
   attributes 'name'
 end
@@ -893,7 +926,6 @@ class FriendResource < JSONAPI::Resource
 end
 
 class BreedResource < JSONAPI::Resource
-  attribute :id, format_misspelled: :does_not_exist
   attribute :name, format: :title
 
   # This is unneeded, just here for testing
@@ -1003,13 +1035,22 @@ class ProductResource < JSONAPI::Resource
   has_one :picture, always_include_linkage_data: true
 
   def picture_id
-    model.picture.id
+    _model.picture.id
   end
 end
 
 class ImageableResource < JSONAPI::Resource
 end
 
+class MakeResource < JSONAPI::Resource
+  attribute :model
+end
+
+class WebPageResource < JSONAPI::Resource
+  attribute :href
+  attribute :link
+end
+
 module Api
   module V1
     class WriterResource < JSONAPI::Resource
@@ -1328,22 +1369,6 @@ module MyEngine
   end
 end
 
-warn 'start testing Name Collisions'
-# The name collisions only emmit warnings. Exceptions would change the flow of the tests
-
-class LinksResource < JSONAPI::Resource
-end
-
-class BadlyNamedAttributesResource < JSONAPI::Resource
-  attributes :type, :href, :links
-
-  has_many :links
-  has_one :href
-  has_one :id
-  has_many :types
-end
-warn 'end testing Name Collisions'
-
 ### PORO Data - don't do this in a production app
 $breed_data = BreedData.new
 $breed_data.add(Breed.new(0, 'persian'))

data/test/fixtures/makes.yml

@@ -0,0 +1,2 @@
+make1:
+  model: A model attribute

data/test/fixtures/vehicles.yml

@@ -2,15 +2,16 @@ Miata:
   id: 1
   type: Car
   make: Mazda
-  vehicle_model: Miata MX5
+  model: Miata MX5
   drive_layout: Front Engine RWD
   serial_number: 32432adfsfdysua
   person_id: 1
+
 Launch20:
   id: 2
   type: Boat
   make: Chris-Craft
-  vehicle_model: Launch 20
+  model: Launch 20
   length_at_water_line: 15.5ft
   serial_number: 434253JJJSD
   person_id: 1

data/test/fixtures/web_pages.yml

@@ -0,0 +1,3 @@
+web_page1:
+  href: http://example.com
+  link: http://link.example.com

data/test/integration/requests/request_test.rb

@@ -910,4 +910,17 @@ class RequestTest < ActionDispatch::IntegrationTest
   ensure
     JSONAPI.configuration.allow_sort = true
   end
+
+  def test_getting_different_resources_when_sti
+    get '/vehicles'
+    assert_equal 200, status
+    types = json_response['data'].map{|r| r['type']}.sort
+    assert_array_equals ['boats', 'cars'], types
+  end
+
+  def test_getting_resource_with_correct_type_when_sti
+    get '/vehicles/1'
+    assert_equal 200, status
+    assert_equal 'cars', json_response['data']['type']
+  end
 end

data/test/lib/generators/jsonapi/resource_generator_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.expand_path('../../../../test_helper', __FILE__)
 require 'generators/jsonapi/resource_generator'
 
 module Jsonapi

data/test/test_helper.rb

@@ -39,6 +39,7 @@ class TestApp < Rails::Application
   #Raise errors on unsupported parameters
   config.action_controller.action_on_unpermitted_parameters = :raise
 
+  ActiveRecord::Schema.verbose = false
   config.active_record.schema_format = :none
   config.active_support.test_order = :random
 
@@ -104,7 +105,6 @@ module Pets
     end
 
     class CatResource < JSONAPI::Resource
-      attribute :id
       attribute :name
       attribute :breed
 
@@ -137,8 +137,9 @@ TestApp.routes.draw do
   jsonapi_resources :pictures
   jsonapi_resources :documents
   jsonapi_resources :products
-
-  
+  jsonapi_resources :vehicles
+  jsonapi_resources :cars
+  jsonapi_resources :boats
 
   namespace :api do
     namespace :v1 do

data/test/unit/jsonapi_request/jsonapi_request_test.rb

@@ -1,7 +1,6 @@
 require File.expand_path('../../../test_helper', __FILE__)
 
 class CatResource < JSONAPI::Resource
-  attribute :id
   attribute :name
   attribute :breed
 

data/test/unit/pagination/paged_paginator_test.rb

@@ -184,8 +184,8 @@ class PagedPaginatorTest < ActiveSupport::TestCase
     assert_equal 5, links_params['first']['size']
     assert_equal 1, links_params['first']['number']
 
-    assert_equal 5, links_params['previous']['size']
-    assert_equal 3, links_params['previous']['number']
+    assert_equal 5, links_params['prev']['size']
+    assert_equal 3, links_params['prev']['number']
 
     assert_equal 5, links_params['next']['size']
     assert_equal 5, links_params['next']['number']
@@ -210,8 +210,8 @@ class PagedPaginatorTest < ActiveSupport::TestCase
     assert_equal 5, links_params['first']['size']
     assert_equal 1, links_params['first']['number']
 
-    assert_equal 5, links_params['previous']['size']
-    assert_equal 9, links_params['previous']['number']
+    assert_equal 5, links_params['prev']['size']
+    assert_equal 9, links_params['prev']['number']
 
     assert_equal 5, links_params['last']['size']
     assert_equal 10, links_params['last']['number']
@@ -233,8 +233,8 @@ class PagedPaginatorTest < ActiveSupport::TestCase
     assert_equal 5, links_params['first']['size']
     assert_equal 1, links_params['first']['number']
 
-    assert_equal 5, links_params['previous']['size']
-    assert_equal 10, links_params['previous']['number']
+    assert_equal 5, links_params['prev']['size']
+    assert_equal 10, links_params['prev']['number']
 
     assert_equal 5, links_params['last']['size']
     assert_equal 10, links_params['last']['number']

data/test/unit/resource/resource_test.rb

@@ -16,7 +16,6 @@ class NoMatchAbstractResource < JSONAPI::Resource
 end
 
 class CatResource < JSONAPI::Resource
-  attribute :id
   attribute :name
   attribute :breed
 
@@ -111,7 +110,7 @@ class ResourceTest < ActiveSupport::TestCase
 
   def test_find_with_customized_base_records
     author = Person.find(1)
-    posts = ArticleResource.find([], context: author).map(&:model)
+    posts = ArticleResource.find([], context: author).map(&:_model)
 
     assert(posts.include?(Post.find(1)))
     refute(posts.include?(Post.find(3)))
@@ -123,10 +122,10 @@ class ResourceTest < ActiveSupport::TestCase
     refute(preferences == nil)
     author.update! preferences: preferences
     author_resource = PersonResource.new(author, nil)
-    assert_equal(author_resource.preferences.model, preferences)
+    assert_equal(author_resource.preferences._model, preferences)
 
     author_resource = PersonWithCustomRecordsForResource.new(author, nil)
-    assert_equal(author_resource.preferences.model, :records_for)
+    assert_equal(author_resource.preferences._model, :records_for)
 
     author_resource = PersonWithCustomRecordsForErrorResource.new(author, nil)
     assert_raises PersonWithCustomRecordsForErrorResource::AuthorizationError do
@@ -165,11 +164,11 @@ class ResourceTest < ActiveSupport::TestCase
   def test_find_by_key_with_customized_base_records
     author = Person.find(1)
 
-    post = ArticleResource.find_by_key(1, context: author).model
+    post = ArticleResource.find_by_key(1, context: author)._model
     assert_equal(post, Post.find(1))
 
     assert_raises JSONAPI::Exceptions::RecordNotFound do
-      ArticleResource.find_by_key(3, context: author).model
+      ArticleResource.find_by_key(3, context: author)._model
     end
   end
 
@@ -221,7 +220,7 @@ class ResourceTest < ActiveSupport::TestCase
 
   def test_to_many_relationship_sorts
     post_resource = PostResource.new(Post.find(1), nil)
-    comment_ids = post_resource.comments.map{|c| c.model.id }
+    comment_ids = post_resource.comments.map{|c| c._model.id }
     assert_equal [1,2], comment_ids
 
     # define apply_filters method on post resource to not respect filters
@@ -233,7 +232,7 @@ class ResourceTest < ActiveSupport::TestCase
       end
     end
 
-    sorted_comment_ids = post_resource.comments(sort_criteria: [{ field: 'id', direction: :desc}]).map{|c| c.model.id }
+    sorted_comment_ids = post_resource.comments(sort_criteria: [{ field: 'id', direction: :desc}]).map{|c| c._model.id }
     assert_equal [2,1], sorted_comment_ids
 
   ensure
@@ -362,4 +361,90 @@ class ResourceTest < ActiveSupport::TestCase
       key_type nil
     end
   end
+
+  def test_id_attr_deprecation
+    _out, err = capture_io do
+      eval <<-CODE
+        class ProblemResource < JSONAPI::Resource
+          attribute :id
+        end
+      CODE
+    end
+    assert_match /DEPRECATION WARNING: Id without format is no longer supported. Please remove ids from attributes, or specify a format./, err
+  end
+
+  def test_id_attr_with_format
+    _out, err = capture_io do
+      eval <<-CODE
+        class NotProblemResource < JSONAPI::Resource
+          attribute :id, format: :string
+        end
+      CODE
+    end
+    assert_equal "", err
+  end
+
+  def test_links_resource_warning
+    _out, err = capture_io do
+      eval "class LinksResource < JSONAPI::Resource; end"
+    end
+    assert_match /LinksResource` is a reserved resource name/, err
+  end
+
+  def test_reserved_key_warnings
+    _out, err = capture_io do
+      eval <<-CODE
+        class BadlyNamedAttributesResource < JSONAPI::Resource
+          attributes :type
+        end
+      CODE
+    end
+    assert_match /`type` is a reserved key in ./, err
+  end
+
+  def test_reserved_relationship_warnings
+    %w(id type).each do |key|
+      _out, err = capture_io do
+        eval <<-CODE
+          class BadlyNamedAttributesResource < JSONAPI::Resource
+            has_one :#{key}
+          end
+        CODE
+      end
+      assert_match /`#{key}` is a reserved relationship name in ./, err
+    end
+    %w(types ids).each do |key|
+      _out, err = capture_io do
+        eval <<-CODE
+          class BadlyNamedAttributesResource < JSONAPI::Resource
+            has_many :#{key}
+          end
+        CODE
+      end
+      assert_match /`#{key}` is a reserved relationship name in ./, err
+    end
+  end
+
+  def test_abstract_warning
+    _out, err = capture_io do
+      eval <<-CODE
+        class NoModelResource < JSONAPI::Resource
+        end
+        NoModelResource._model_class
+      CODE
+    end
+    assert_match "[MODEL NOT FOUND] Model could not be found for ResourceTest::NoModelResource. If this a base Resource declare it as abstract.\n", err
+  end
+
+  def test_no_warning_when_abstract
+    _out, err = capture_io do
+      eval <<-CODE
+        class NoModelAbstractResource < JSONAPI::Resource
+          abstract
+        end
+        NoModelAbstractResource._model_class
+      CODE
+    end
+    assert_match "", err
+  end
 end

data/test/unit/serializer/polymorphic_serializer_test.rb

@@ -88,7 +88,7 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
             },
             attributes: {
               make: 'Mazda',
-              vehicleModel: 'Miata MX5',
+              model: 'Miata MX5',
               driveLayout: 'Front Engine RWD',
               serialNumber: '32432adfsfdysua'
             },
@@ -109,7 +109,7 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
             },
             attributes: {
               make: 'Chris-Craft',
-              vehicleModel: 'Launch 20',
+              model: 'Launch 20',
               lengthAtWaterLine: '15.5ft',
               serialNumber: '434253JJJSD'
             },

data/test/unit/serializer/serializer_test.rb

@@ -1736,4 +1736,139 @@ class SerializerTest < ActionDispatch::IntegrationTest
       serialized
     )
   end
+
+  def test_serialize_model_attr
+    @make = Make.first
+    serialized = JSONAPI::ResourceSerializer.new(
+      MakeResource,
+    ).serialize_to_hash(MakeResource.new(@make, nil))
+
+    assert_hash_equals(
+      {
+        "model" => "A model attribute"
+      },
+      serialized[:data]["attributes"]
+    )
+  end
+
+  def test_confusingly_named_attrs
+    @wp = WebPage.first
+    serialized = JSONAPI::ResourceSerializer.new(
+      WebPageResource,
+    ).serialize_to_hash(WebPageResource.new(@wp, nil))
+
+    assert_hash_equals(
+      {
+        :data=>{
+          "id"=>"#{@wp.id}",
+          "type"=>"webPages",
+          "links"=>{
+            :self=>"/webPages/#{@wp.id}"
+          },
+          "attributes"=>{
+            "href"=>"http://example.com",
+            "link"=>"http://link.example.com"
+          }
+        }
+      },
+      serialized
+    )
+  end
+
+  def test_questionable_has_one
+    # has_one
+    out, err = capture_io do
+      eval <<-CODE
+          class ::Questionable < ActiveRecord::Base
+            has_one :link
+            has_one :href
+          end
+          class ::QuestionableResource < JSONAPI::Resource
+            model_name '::Questionable'
+            has_one :link
+            has_one :href
+          end
+          cn = ::Questionable.new id: 1
+          puts JSONAPI::ResourceSerializer.new(
+            ::QuestionableResource,
+          ).serialize_to_hash(::QuestionableResource.new(cn, nil))
+      CODE
+    end
+    assert err.blank?
+    assert_equal(
+      {
+        :data=>{
+          "id"=>"1",
+          "type"=>"questionables",
+          "links"=>{
+            :self=>"/questionables/1"
+          },
+          "relationships"=>{
+            "link"=>{
+              :links=>{
+                :self=>"/questionables/1/relationships/link",
+                :related=>"/questionables/1/link"
+              }
+            },
+            "href"=>{
+              :links=>{
+                :self=>"/questionables/1/relationships/href",
+                :related=>"/questionables/1/href"
+              }
+            }
+          }
+        }
+      }.to_s,
+      out.strip
+    )
+  end
+
+  def test_questionable_has_many
+    # has_one
+    out, err = capture_io do
+      eval <<-CODE
+          class ::Questionable2 < ActiveRecord::Base
+            self.table_name = 'questionables'
+            has_many :links
+            has_many :hrefs
+          end
+          class ::Questionable2Resource < JSONAPI::Resource
+            model_name '::Questionable2'
+            has_many :links
+            has_many :hrefs
+          end
+          cn = ::Questionable2.new id: 1
+          puts JSONAPI::ResourceSerializer.new(
+            ::Questionable2Resource,
+          ).serialize_to_hash(::Questionable2Resource.new(cn, nil))
+      CODE
+    end
+    assert err.blank?
+    assert_equal(
+      {
+        :data=>{
+          "id"=>"1",
+          "type"=>"questionable2s",
+          "links"=>{
+            :self=>"/questionable2s/1"
+          },
+          "relationships"=>{
+            "links"=>{
+              :links=>{
+                :self=>"/questionable2s/1/relationships/links",
+                :related=>"/questionable2s/1/links"
+              }
+            },
+            "hrefs"=>{
+              :links=>{
+                :self=>"/questionable2s/1/relationships/hrefs",
+                :related=>"/questionable2s/1/hrefs"
+              }
+            }
+          }
+        }
+      }.to_s,
+      out.strip
+    )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,6 +171,7 @@ files:
 - test/fixtures/hair_cuts.yml
 - test/fixtures/iso_currencies.yml
 - test/fixtures/line_items.yml
+- test/fixtures/makes.yml
 - test/fixtures/moons.yml
 - test/fixtures/numeros_telefone.yml
 - test/fixtures/order_flags.yml
@@ -186,6 +187,7 @@ files:
 - test/fixtures/sections.yml
 - test/fixtures/tags.yml
 - test/fixtures/vehicles.yml
+- test/fixtures/web_pages.yml
 - test/helpers/assertions.rb
 - test/helpers/functional_helpers.rb
 - test/helpers/value_matchers.rb
@@ -248,6 +250,7 @@ test_files:
 - test/fixtures/hair_cuts.yml
 - test/fixtures/iso_currencies.yml
 - test/fixtures/line_items.yml
+- test/fixtures/makes.yml
 - test/fixtures/moons.yml
 - test/fixtures/numeros_telefone.yml
 - test/fixtures/order_flags.yml
@@ -263,6 +266,7 @@ test_files:
 - test/fixtures/sections.yml
 - test/fixtures/tags.yml
 - test/fixtures/vehicles.yml
+- test/fixtures/web_pages.yml
 - test/helpers/assertions.rb
 - test/helpers/functional_helpers.rb
 - test/helpers/value_matchers.rb