jsonapi-resources 0.4.4 → 0.5.0

data/test/fixtures/active_record.rb

@@ -18,6 +18,11 @@ ActiveRecord::Schema.define do
     t.timestamps null: false
   end
 
+  create_table :author_details, force: true do |t|
+    t.integer :person_id
+    t.string  :author_stuff
+  end
+
   create_table :posts, force: true do |t|
     t.string     :title
     t.text       :body
@@ -190,6 +195,11 @@ ActiveRecord::Schema.define do
 
   create_table :vehicles, force: true do |t|
     t.string :type
+    t.string :make
+    t.string :vehicle_model
+    t.string :length_at_water_line
+    t.string :drive_layout
+    t.string :serial_number
     t.integer :person_id
   end
 end
@@ -202,12 +212,17 @@ class Person < ActiveRecord::Base
   has_many :vehicles
   belongs_to :preferences
   belongs_to :hair_cut
+  has_one :author_detail
 
   ### Validations
   validates :name, presence: true
   validates :date_joined, presence: true
 end
 
+class AuthorDetail < ActiveRecord::Base
+  belongs_to :author, class_name: 'Person', foreign_key: 'person_id'
+end
+
 class Post < ActiveRecord::Base
   belongs_to :author, class_name: 'Person', foreign_key: 'author_id'
   belongs_to :writer, class_name: 'Person', foreign_key: 'author_id'
@@ -634,12 +649,15 @@ end
 
 class VehicleResource < JSONAPI::Resource
   has_one :person
+  attributes :make, :vehicle_model, :serial_number
 end
 
 class CarResource < VehicleResource
+  attributes :drive_layout
 end
 
 class BoatResource < VehicleResource
+  attributes :length_at_water_line
 end
 
 class CommentResource < JSONAPI::Resource
@@ -655,7 +673,7 @@ class TagResource < JSONAPI::Resource
   attributes :name
 
   has_many :posts
-  # Not including the planets association so they don't get output
+  # Not including the planets relationship so they don't get output
   #has_many :planets
 end
 
@@ -673,6 +691,9 @@ class PostResource < JSONAPI::Resource
   has_many :tags, acts_as_set: true
   has_many :comments, acts_as_set: false
 
+  # Not needed - just for testing
+  primary_key :id
+
   before_save do
     msg = "Before save"
   end
@@ -763,7 +784,6 @@ class HairCutResource < JSONAPI::Resource
 end
 
 class IsoCurrencyResource < JSONAPI::Resource
-  primary_key :code
   attributes :name, :country_name, :minor_unit
 
   filter :country_name
@@ -881,7 +901,7 @@ end
 
 class ProductResource < JSONAPI::Resource
   attribute :name
-  has_one :picture
+  has_one :picture, always_include_linkage_data: true
 
   def picture_id
     model.picture.id
@@ -1080,7 +1100,8 @@ module Api
     class AuthorResource < JSONAPI::Resource
       attributes :name, :email
       model_name 'Person'
-      has_many :posts
+      relationship :posts, to: :many
+      relationship :author_detail, to: :one, foreign_key_on: :related
 
       filter :name
 
@@ -1100,6 +1121,10 @@ module Api
       end
     end
 
+    class AuthorDetailResource < JSONAPI::Resource
+      attributes :author_stuff
+    end
+
     PersonResource = PersonResource.dup
     PostResource = PostResource.dup
     ExpenseEntryResource = ExpenseEntryResource.dup
@@ -1164,11 +1189,19 @@ module Api
   end
 end
 
+module MyEngine
+  module Api
+    module V1
+      class PersonResource < JSONAPI::Resource
+      end
+    end
+  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

data/test/fixtures/author_details.yml

@@ -0,0 +1,9 @@
+a:
+  id: 1
+  person_id: 1
+  author_stuff: blah blah
+
+b:
+  id: 2
+  person_id: 2
+  author_stuff: blah blah blah

data/test/fixtures/vehicles.yml

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

data/test/integration/requests/request_test.rb

@@ -22,18 +22,18 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 200, status
   end
 
-  def test_get_nested_has_one
+  def test_get_nested_to_one
     get '/posts/1/author'
     assert_equal 200, status
   end
 
-  def test_get_nested_has_many
+  def test_get_nested_to_many
     get '/posts/1/comments'
     assert_equal 200, status
   end
 
-  def test_get_nested_has_many_bad_param
-    get '/posts/1/comments?association=books'
+  def test_get_nested_to_many_bad_param
+    get '/posts/1/comments?relationship=books'
     assert_equal 200, status
   end
 
@@ -204,28 +204,28 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 422, status
   end
 
-  def test_update_association_without_content_type
+  def test_update_relationship_without_content_type
     ruby = Section.find_by(name: 'ruby')
     patch '/posts/3/relationships/section', { 'data' => {type: 'sections', id: ruby.id.to_s }}.to_json
 
     assert_equal 415, status
   end
 
-  def test_patch_update_association_has_one
+  def test_patch_update_relationship_to_one
     ruby = Section.find_by(name: 'ruby')
     patch '/posts/3/relationships/section', { 'data' => {type: 'sections', id: ruby.id.to_s }}.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
   end
 
-  def test_put_update_association_has_one
+  def test_put_update_relationship_to_one
     ruby = Section.find_by(name: 'ruby')
     put '/posts/3/relationships/section', { 'data' => {type: 'sections', id: ruby.id.to_s }}.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
   end
 
-  def test_patch_update_association_has_many_acts_as_set
+  def test_patch_update_relationship_to_many_acts_as_set
     # Comments are acts_as_set=false so PUT/PATCH should respond with 403
 
     rogue = Comment.find_by(body: 'Rogue Comment Here')
@@ -234,14 +234,14 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 403, status
   end
 
-  def test_post_update_association_has_many
+  def test_post_update_relationship_to_many
     rogue = Comment.find_by(body: 'Rogue Comment Here')
     post '/posts/5/relationships/comments', { 'data' => [{type: 'comments', id: rogue.id.to_s }]}.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
   end
 
-  def test_put_update_association_has_many_acts_as_set
+  def test_put_update_relationship_to_many_acts_as_set
     # Comments are acts_as_set=false so PUT/PATCH should respond with 403. Note: JR currently treats PUT and PATCH as equivalent
 
     rogue = Comment.find_by(body: 'Rogue Comment Here')
@@ -418,7 +418,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_hash_equals post_1, json_response['data']
   end
 
-  def test_flow_link_has_one_self_link
+  def test_flow_link_to_one_self_link
     get '/posts'
     assert_equal 200, status
     post_1 = json_response['data'][0]
@@ -434,7 +434,7 @@ class RequestTest < ActionDispatch::IntegrationTest
                                     })
   end
 
-  def test_flow_link_has_many_self_link
+  def test_flow_link_to_many_self_link
     get '/posts'
     assert_equal 200, status
     post_1 = json_response['data'][0]
@@ -455,7 +455,7 @@ class RequestTest < ActionDispatch::IntegrationTest
                        })
   end
 
-  def test_flow_link_has_many_self_link_put
+  def test_flow_link_to_many_self_link_put
     get '/posts'
     assert_equal 200, status
     post_1 = json_response['data'][4]
@@ -624,7 +624,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 200, status
   end
 
-  def test_patch_formatted_dasherized_replace_has_many
+  def test_patch_formatted_dasherized_replace_to_many
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/purchase-orders/2?include=line-items,order-flags',
@@ -652,7 +652,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 200, status
   end
 
-  def test_post_has_many_link
+  def test_post_to_many_link
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     post '/api/v6/purchase-orders/3/relationships/line-items',
@@ -666,7 +666,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 204, status
   end
 
-  def test_patch_has_many_link
+  def test_patch_to_many_link
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/purchase-orders/3/relationships/order-flags',
@@ -680,7 +680,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 204, status
   end
 
-  def test_patch_has_one
+  def test_patch_to_one
     JSONAPI.configuration.route_format = :dasherized_route
     JSONAPI.configuration.json_key_format = :dasherized_key
     patch '/api/v6/line-items/5/relationships/purchase-order',

data/test/integration/routes/routes_test.rb

@@ -19,37 +19,37 @@ class RoutesTest < ActionDispatch::IntegrationTest
 
   def test_routing_posts_links_author_show
     assert_routing({path: '/posts/1/relationships/author', method: :get},
-                   {controller: 'posts', action: 'show_association', post_id: '1', association: 'author'})
+                   {controller: 'posts', action: 'show_relationship', post_id: '1', relationship: 'author'})
   end
 
   def test_routing_posts_links_author_destroy
     assert_routing({path: '/posts/1/relationships/author', method: :delete},
-                   {controller: 'posts', action: 'destroy_association', post_id: '1', association: 'author'})
+                   {controller: 'posts', action: 'destroy_relationship', post_id: '1', relationship: 'author'})
   end
 
   def test_routing_posts_links_author_update
     assert_routing({path: '/posts/1/relationships/author', method: :patch},
-                   {controller: 'posts', action: 'update_association', post_id: '1', association: 'author'})
+                   {controller: 'posts', action: 'update_relationship', post_id: '1', relationship: 'author'})
   end
 
   def test_routing_posts_links_tags_show
     assert_routing({path: '/posts/1/relationships/tags', method: :get},
-                   {controller: 'posts', action: 'show_association', post_id: '1', association: 'tags'})
+                   {controller: 'posts', action: 'show_relationship', post_id: '1', relationship: 'tags'})
   end
 
   def test_routing_posts_links_tags_destroy
     assert_routing({path: '/posts/1/relationships/tags/1,2', method: :delete},
-                   {controller: 'posts', action: 'destroy_association', post_id: '1', keys: '1,2', association: 'tags'})
+                   {controller: 'posts', action: 'destroy_relationship', post_id: '1', keys: '1,2', relationship: 'tags'})
   end
 
   def test_routing_posts_links_tags_create
     assert_routing({path: '/posts/1/relationships/tags', method: :post},
-                   {controller: 'posts', action: 'create_association', post_id: '1', association: 'tags'})
+                   {controller: 'posts', action: 'create_relationship', post_id: '1', relationship: 'tags'})
   end
 
   def test_routing_posts_links_tags_update_acts_as_set
     assert_routing({path: '/posts/1/relationships/tags', method: :patch},
-                   {controller: 'posts', action: 'update_association', post_id: '1', association: 'tags'})
+                   {controller: 'posts', action: 'update_relationship', post_id: '1', relationship: 'tags'})
   end
 
   # Polymorphic
@@ -60,7 +60,7 @@ class RoutesTest < ActionDispatch::IntegrationTest
         method: :get
       },
       {
-        association: 'imageable',
+        relationship: 'imageable',
         source: 'pictures',
         controller: 'imageables',
         action: 'get_related_resource',
@@ -76,9 +76,9 @@ class RoutesTest < ActionDispatch::IntegrationTest
         method: :patch
       },
       {
-        association: 'imageable',
+        relationship: 'imageable',
         controller: 'pictures',
-        action: 'update_association',
+        action: 'update_relationship',
         picture_id: '1'
       }
     )
@@ -91,9 +91,9 @@ class RoutesTest < ActionDispatch::IntegrationTest
         method: :delete
       },
       {
-        association: 'imageable',
+        relationship: 'imageable',
         controller: 'pictures',
-        action: 'destroy_association',
+        action: 'destroy_relationship',
         picture_id: '1'
       }
     )
@@ -112,13 +112,13 @@ class RoutesTest < ActionDispatch::IntegrationTest
 
   def test_routing_v1_posts_links_writer_show
     assert_routing({path: '/api/v1/posts/1/relationships/writer', method: :get},
-                   {controller: 'api/v1/posts', action: 'show_association', post_id: '1', association: 'writer'})
+                   {controller: 'api/v1/posts', action: 'show_relationship', post_id: '1', relationship: 'writer'})
   end
 
   # V2
   def test_routing_v2_posts_links_author_show
     assert_routing({path: '/api/v2/posts/1/relationships/author', method: :get},
-                   {controller: 'api/v2/posts', action: 'show_association', post_id: '1', association: 'author'})
+                   {controller: 'api/v2/posts', action: 'show_relationship', post_id: '1', relationship: 'author'})
   end
 
   def test_routing_v2_preferences_show
@@ -148,7 +148,7 @@ class RoutesTest < ActionDispatch::IntegrationTest
                    {action: 'show', controller: 'api/v4/expense_entries', id: '1'})
 
     assert_routing({path: '/api/v4/expenseEntries/1/relationships/isoCurrency', method: :get},
-                   {controller: 'api/v4/expense_entries', action: 'show_association', expense_entry_id: '1', association: 'iso_currency'})
+                   {controller: 'api/v4/expense_entries', action: 'show_relationship', expense_entry_id: '1', relationship: 'iso_currency'})
   end
 
   # V5 dasherized
@@ -167,7 +167,7 @@ class RoutesTest < ActionDispatch::IntegrationTest
                    {action: 'show', controller: 'api/v5/expense_entries', id: '1'})
 
     assert_routing({path: '/api/v5/expense-entries/1/relationships/iso-currency', method: :get},
-                   {controller: 'api/v5/expense_entries', action: 'show_association', expense_entry_id: '1', association: 'iso_currency'})
+                   {controller: 'api/v5/expense_entries', action: 'show_relationship', expense_entry_id: '1', relationship: 'iso_currency'})
   end
 
   def test_routing_authors_show
@@ -177,7 +177,7 @@ class RoutesTest < ActionDispatch::IntegrationTest
 
   def test_routing_author_links_posts_create_not_acts_as_set
     assert_routing({path: '/api/v5/authors/1/relationships/posts', method: :post},
-                   {controller: 'api/v5/authors', action: 'create_association', author_id: '1', association: 'posts'})
+                   {controller: 'api/v5/authors', action: 'create_relationship', author_id: '1', relationship: 'posts'})
   end
 
   #primary_key
@@ -194,14 +194,14 @@ class RoutesTest < ActionDispatch::IntegrationTest
 
   # def test_routing_posts_links_author_except_destroy
   #   assert_routing({ path: '/api/v3/posts/1/relationships/author', method: :delete },
-  #                  { controller: 'api/v3/posts', action: 'destroy_association', post_id: '1', association: 'author' })
+  #                  { controller: 'api/v3/posts', action: 'destroy_relationship', post_id: '1', relationship: 'author' })
   # end
   #
   # def test_routing_posts_links_tags_only_create_show
   #   assert_routing({ path: '/api/v3/posts/1/relationships/tags/1,2', method: :delete },
-  #                  { controller: 'api/v3/posts', action: 'destroy_association', post_id: '1', keys: '1,2', association: 'tags' })
+  #                  { controller: 'api/v3/posts', action: 'destroy_relationship', post_id: '1', keys: '1,2', relationship: 'tags' })
   # end
 
-  # Test that non acts as set has_many association update route is not created
+  # Test that non acts as set to_many relationship update route is not created
 
 end

data/test/test_helper.rb

@@ -14,6 +14,7 @@ require 'rails/all'
 require 'rails/test_help'
 require 'minitest/mock'
 require 'jsonapi-resources'
+require 'pry'
 
 require File.expand_path('../helpers/value_matchers', __FILE__)
 require File.expand_path('../helpers/assertions', __FILE__)
@@ -43,6 +44,12 @@ class TestApp < Rails::Application
   ActiveSupport::JSON::Encoding.time_precision = 0 if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR >= 1
 end
 
+module MyEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace MyEngine
+  end
+end
+
 # Patch RAILS 4.0 to not use millisecond precision
 if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR < 1
   module ActiveSupport
@@ -141,7 +148,7 @@ TestApp.routes.draw do
 
     namespace :v3 do
       jsonapi_resource :preferences do
-        # Intentionally empty block to skip association urls
+        # Intentionally empty block to skip relationship urls
       end
 
       jsonapi_resources :posts, except: [:destroy] do
@@ -198,6 +205,16 @@ TestApp.routes.draw do
       jsonapi_resources :numeros_telefone
     end
   end
+
+  mount MyEngine::Engine => "/boomshaka", as: :my_engine
+end
+
+MyEngine::Engine.routes.draw do
+  namespace :api do
+    namespace :v1 do
+      jsonapi_resources :people
+    end
+  end
 end
 
 # Ensure backward compatibility with Minitest 4