jsonapi-resources 0.1.1 → 0.2.0

data/test/fixtures/active_record.rb

@@ -105,6 +105,18 @@ ActiveRecord::Schema.define do
     t.binary   :photo, limit: 1.kilobyte
     t.boolean  :cool
   end
+
+  create_table :books, force: true do |t|
+    t.string :title
+    t.string :isbn
+  end
+
+  create_table :book_comments, force: true do |t|
+    t.text       :body
+    t.belongs_to :book, index: true
+    t.integer    :author_id
+    t.timestamps
+  end
 end
 
 ### MODELS
@@ -202,6 +214,15 @@ class Breed
   end
 end
 
+class Book < ActiveRecord::Base
+  has_many :book_comments
+end
+
+class BookComment < ActiveRecord::Base
+  belongs_to :author, class_name: 'Person', foreign_key: 'author_id'
+  belongs_to :book
+end
+
 class BreedData
   def initialize
     @breeds = {}
@@ -234,16 +255,20 @@ $breed_data.add(Breed.new(3, 'to_delete'))
 
 ### CONTROLLERS
 class AuthorsController < JSONAPI::ResourceController
-
 end
 
 class PeopleController < JSONAPI::ResourceController
-
 end
 
 class PostsController < JSONAPI::ResourceController
 end
 
+class CommentsController < JSONAPI::ResourceController
+end
+
+class SectionsController < JSONAPI::ResourceController
+end
+
 class TagsController < JSONAPI::ResourceController
 end
 
@@ -308,6 +333,12 @@ module Api
 
     class PreferencesController < JSONAPI::ResourceController
     end
+
+    class BooksController < JSONAPI::ResourceController
+    end
+
+    class BookCommentsController < JSONAPI::ResourceController
+    end
   end
 
   module V3
@@ -324,6 +355,9 @@ module Api
 
     class IsoCurrenciesController < JSONAPI::ResourceController
     end
+
+    class BooksController < JSONAPI::ResourceController
+    end
   end
 
   module V5
@@ -362,7 +396,7 @@ class PersonResource < JSONAPI::Resource
 end
 
 class AuthorResource < JSONAPI::Resource
-  attributes :id, :name, :email
+  attributes :name, :email
   model_name 'Person'
   has_many :posts
 
@@ -385,14 +419,14 @@ class AuthorResource < JSONAPI::Resource
 end
 
 class CommentResource < JSONAPI::Resource
-  attributes :id, :body
+  attributes :body
   has_one :post
   has_one :author, class_name: 'Person'
   has_many :tags
 end
 
 class TagResource < JSONAPI::Resource
-  attributes :id, :name
+  attributes :name
 
   has_many :posts
   # Not including the planets association so they don't get output
@@ -404,7 +438,6 @@ class SectionResource < JSONAPI::Resource
 end
 
 class PostResource < JSONAPI::Resource
-  attribute :id
   attribute :title
   attribute :body
   attribute :subject
@@ -451,7 +484,7 @@ class PostResource < JSONAPI::Resource
   end
 
   filters :title, :author, :tags, :comments
-  filter :id
+  filters :id, :ids
 
   def self.updateable_fields(context)
     super(context) - [:author, :subject]
@@ -469,6 +502,9 @@ class PostResource < JSONAPI::Resource
     case filter
       when :id
         verify_keys(values, context)
+      when :ids #coerce :ids to :id
+        verify_keys(values, context)
+        return :id, values
     end
     return filter, values
   end
@@ -490,19 +526,27 @@ end
 
 class IsoCurrencyResource < JSONAPI::Resource
   primary_key :code
-  attributes :id, :name, :country_name, :minor_unit
+  attributes :name, :country_name, :minor_unit
 
   filter :country_name
 end
 
 class ExpenseEntryResource < JSONAPI::Resource
-  attributes :id, :cost
+  attributes :cost
   attribute :transaction_date, format: :date
 
   has_one :iso_currency, foreign_key: 'currency_code'
   has_one :employee, class_name: 'Person'
 end
 
+class EmployeeResource < JSONAPI::Resource
+  attributes :name, :email
+  model_name 'Person'
+end
+
+class FriendResource < JSONAPI::Resource
+end
+
 class BreedResource < JSONAPI::Resource
   attribute :id, format_misspelled: :does_not_exist
   attribute :name, format: :title
@@ -528,7 +572,6 @@ class BreedResource < JSONAPI::Resource
 end
 
 class PlanetResource < JSONAPI::Resource
-  attribute :id
   attribute :name
   attribute :description
 
@@ -539,18 +582,17 @@ class PlanetResource < JSONAPI::Resource
 end
 
 class PropertyResource < JSONAPI::Resource
-  attributes :id, :name
+  attributes :name
 
   has_many :planets
 end
 
 class PlanetTypeResource < JSONAPI::Resource
-  attributes :id, :name
+  attributes :name
   has_many :planets
 end
 
 class MoonResource < JSONAPI::Resource
-  attribute :id
   attribute :name
   attribute :description
 
@@ -558,11 +600,10 @@ class MoonResource < JSONAPI::Resource
 end
 
 class PreferencesResource < JSONAPI::Resource
-  attribute :id
   attribute :advanced_mode
 
   has_one :author, foreign_key: :person_id
-  has_many :friends
+  has_many :friends, class_name: 'Person'
 
   def self.find_by_key(key, options = {})
     new(Preferences.first)
@@ -570,7 +611,6 @@ class PreferencesResource < JSONAPI::Resource
 end
 
 class FactResource < JSONAPI::Resource
-  attribute :id
   attribute :spouse_name
   attribute :bio
   attribute :quality_rating
@@ -585,7 +625,7 @@ end
 module Api
   module V1
     class WriterResource < JSONAPI::Resource
-      attributes :id, :name, :email
+      attributes :name, :email
       model_name 'Person'
       has_many :posts
 
@@ -597,7 +637,6 @@ module Api
 
     class PostResource < JSONAPI::Resource
       # V1 no longer supports tags and now calls author 'writer'
-      attribute :id
       attribute :title
       attribute :body
       attribute :subject
@@ -625,6 +664,8 @@ module Api
     PlanetTypeResource = PlanetTypeResource.dup
     MoonResource = MoonResource.dup
     PreferencesResource = PreferencesResource.dup
+    EmployeeResource = EmployeeResource.dup
+    FriendResource = FriendResource.dup
   end
 end
 
@@ -632,7 +673,21 @@ module Api
   module V2
     PreferencesResource = PreferencesResource.dup
     AuthorResource = AuthorResource.dup
+    PersonResource = PersonResource.dup
     PostResource = PostResource.dup
+
+    class BookResource < JSONAPI::Resource
+      attribute :title
+      attribute :isbn
+
+      has_many :book_comments
+    end
+
+    class BookCommentResource < JSONAPI::Resource
+      attributes :body
+      has_one :book
+      has_one :author, class_name: 'Person'
+    end
   end
 end
 
@@ -648,14 +703,20 @@ module Api
     PostResource = PostResource.dup
     ExpenseEntryResource = ExpenseEntryResource.dup
     IsoCurrencyResource = IsoCurrencyResource.dup
+
+    class BookResource < Api::V2::BookResource
+      paginator :paged
+    end
   end
 end
 
 module Api
   module V5
+    AuthorResource = AuthorResource.dup
     PostResource = PostResource.dup
     ExpenseEntryResource = ExpenseEntryResource.dup
     IsoCurrencyResource = IsoCurrencyResource.dup
+    EmployeeResource = EmployeeResource.dup
   end
 end
 
@@ -841,3 +902,14 @@ fact = Fact.create(spouse_name: 'Jane Author',
                    photo: "abc",
                    cool: false
 )
+
+for book_num in 0..999
+  Book.create(title: "Book #{book_num}", isbn: "12345-#{book_num}-67890") do |book|
+    book.save
+    if book_num < 5
+      for comment_num in 0..50
+        book.book_comments.create(body: "This is comment #{comment_num} on book #{book_num}.", author_id: a.id, book_id: book.id)
+      end
+    end
+  end
+end

data/test/integration/requests/request_test.rb

@@ -3,56 +3,87 @@ require File.expand_path('../../../fixtures/active_record', __FILE__)
 
 class RequestTest < ActionDispatch::IntegrationTest
 
+  def setup
+    JSONAPI.configuration.json_key_format = :underscored_key
+  end
+
+  def after_teardown
+    Api::V2::BookResource.paginator :offset
+    JSONAPI.configuration.route_format = :underscored_route
+  end
+
   def test_get
     get '/posts'
     assert_equal 200, status
   end
 
+  def test_get_nested_has_one
+    get '/posts/1/author'
+    assert_equal 200, status
+  end
+
+  def test_get_nested_has_many
+    get '/posts/1/comments'
+    assert_equal 200, status
+  end
+
+  def test_get_nested_has_many_bad_param
+    get '/posts/1/comments?association=books'
+    assert_equal 200, status
+  end
+
   def test_get_underscored_key
     JSONAPI.configuration.json_key_format = :underscored_key
     get '/iso_currencies'
     assert_equal 200, status
-    assert_equal 3, json_response['iso_currencies'].size
+    assert_equal 3, json_response['data'].size
   end
 
   def test_get_underscored_key_filtered
     JSONAPI.configuration.json_key_format = :underscored_key
-    get '/iso_currencies?country_name=Canada'
+    get '/iso_currencies?filter[country_name]=Canada'
     assert_equal 200, status
-    assert_equal 1, json_response['iso_currencies'].size
-    assert_equal 'Canada', json_response['iso_currencies'][0]['country_name']
+    assert_equal 1, json_response['data'].size
+    assert_equal 'Canada', json_response['data'][0]['country_name']
   end
 
   def test_get_camelized_key_filtered
     JSONAPI.configuration.json_key_format = :camelized_key
-    get '/iso_currencies?countryName=Canada'
+    get '/iso_currencies?filter[countryName]=Canada'
     assert_equal 200, status
-    assert_equal 1, json_response['isoCurrencies'].size
-    assert_equal 'Canada', json_response['isoCurrencies'][0]['countryName']
+    assert_equal 1, json_response['data'].size
+    assert_equal 'Canada', json_response['data'][0]['countryName']
   end
 
   def test_get_camelized_route_and_key_filtered
-    get '/api/v4/isoCurrencies?countryName=Canada'
+    JSONAPI.configuration.json_key_format = :camelized_key
+    get '/api/v4/isoCurrencies?filter[countryName]=Canada'
     assert_equal 200, status
-    assert_equal 1, json_response['isoCurrencies'].size
-    assert_equal 'Canada', json_response['isoCurrencies'][0]['countryName']
+    assert_equal 1, json_response['data'].size
+    assert_equal 'Canada', json_response['data'][0]['countryName']
   end
 
   def test_get_camelized_route_and_links
     JSONAPI.configuration.json_key_format = :camelized_key
+    JSONAPI.configuration.route_format = :camelized_route
     get '/api/v4/expenseEntries/1/links/isoCurrency'
     assert_equal 200, status
-    assert_equal 'USD', json_response['isoCurrency']
+    assert_hash_equals({'data' => {
+                          'type' => 'isoCurrencies',
+                          'id' => 'USD',
+                          'self' => 'http://www.example.com/api/v4/expenseEntries/1/links/isoCurrency',
+                          'resource' => 'http://www.example.com/api/v4/expenseEntries/1/isoCurrency'}}, json_response)
   end
 
   def test_put_single_without_content_type
     put '/posts/3',
         {
-          'posts' => {
+          'data' => {
+            'type' => 'posts',
             'id' => '3',
             'title' => 'A great new Post',
             'links' => {
-              'tags' => [3, 4]
+              'tags' => {type: 'tags', ids: [3, 4]}
             }
           }
         }.to_json, "CONTENT_TYPE" => "application/json"
@@ -63,11 +94,12 @@ class RequestTest < ActionDispatch::IntegrationTest
   def test_put_single
     put '/posts/3',
         {
-          'posts' => {
+          'data' => {
+            'type' => 'posts',
             'id' => '3',
             'title' => 'A great new Post',
             'links' => {
-              'tags' => [3, 4]
+              'tags' => {type: 'tags', ids: [3, 4]}
             }
           }
         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
@@ -92,11 +124,12 @@ class RequestTest < ActionDispatch::IntegrationTest
   def test_post_single
     post '/posts',
       {
-        'posts' => {
+        'data' => {
+          'type' => 'posts',
           'title' => 'A great new Post',
           'body' => 'JSONAPIResources is the greatest thing since unsliced bread.',
           'links' => {
-            'author' => '3'
+            'author' => {type: 'people', id: '3'}
           }
         }
       }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
@@ -104,16 +137,16 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 201, status
   end
 
-  def test_create_association_without_content_type
+  def test_update_association_without_content_type
     ruby = Section.find_by(name: 'ruby')
-    put '/posts/3/links/section', { 'sections' => ruby.id.to_s }.to_json
+    put '/posts/3/links/section', { 'sections' => {type: 'sections', id: ruby.id.to_s }}.to_json
 
     assert_equal 415, status
   end
 
-  def test_create_association
+  def test_update_association_has_one
     ruby = Section.find_by(name: 'ruby')
-    put '/posts/3/links/section', { 'sections' => ruby.id.to_s }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+    put '/posts/3/links/section', { 'data' => {type: 'sections', id: ruby.id.to_s }}.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
 
     assert_equal 204, status
   end
@@ -131,11 +164,12 @@ class RequestTest < ActionDispatch::IntegrationTest
   def test_put_content_type
     put '/posts/3',
         {
-          'posts' => {
+          'data' => {
+            'type' => 'posts',
             'id' => '3',
             'title' => 'A great new Post',
             'links' => {
-              'tags' => [3, 4]
+              'tags' => {type: 'tags', ids: [3, 4]}
             }
           }
         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
@@ -146,10 +180,11 @@ class RequestTest < ActionDispatch::IntegrationTest
   def test_post_correct_content_type
     post '/posts',
       {
-       'posts' => {
+       'data' => {
+         'type' => 'posts',
          'title' => 'A great new Post',
          'links' => {
-           'author' => '3'
+           'author' => {type: 'people', id: '3'}
          }
        }
      }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
@@ -167,4 +202,127 @@ class RequestTest < ActionDispatch::IntegrationTest
     delete '/posts/8,9'
     assert_equal 204, status
   end
+
+  def test_pagination_none
+    Api::V2::BookResource.paginator :none
+    get '/api/v2/books'
+    assert_equal 200, status
+    assert_equal 1000, json_response['data'].size
+  end
+
+  def test_pagination_offset_style
+    Api::V2::BookResource.paginator :offset
+    get '/api/v2/books'
+    assert_equal 200, status
+    assert_equal JSONAPI.configuration.default_page_size, json_response['data'].size
+    assert_equal 'Book 0', json_response['data'][0]['title']
+  end
+
+  def test_pagination_offset_style_offset
+    Api::V2::BookResource.paginator :offset
+    get '/api/v2/books?page[offset]=50'
+    assert_equal 200, status
+    assert_equal JSONAPI.configuration.default_page_size, json_response['data'].size
+    assert_equal 'Book 50', json_response['data'][0]['title']
+  end
+
+  def test_pagination_offset_style_offset_limit
+    Api::V2::BookResource.paginator :offset
+    get '/api/v2/books?page[offset]=50&page[limit]=20'
+    assert_equal 200, status
+    assert_equal 20, json_response['data'].size
+    assert_equal 'Book 50', json_response['data'][0]['title']
+  end
+
+  def test_pagination_offset_bad_param
+    Api::V2::BookResource.paginator :offset
+    get '/api/v2/books?page[irishsetter]=50&page[limit]=20'
+    assert_equal 400, status
+  end
+
+  def test_pagination_related_resources_link
+    Api::V2::BookResource.paginator :offset
+    get '/api/v2/books?page[limit]=2'
+    assert_equal 200, status
+    assert_equal 2, json_response['data'].size
+    assert_equal 'http://www.example.com/api/v2/books/1/book_comments',
+                 json_response['data'][0]['links']['book_comments']['resource']
+  end
+
+  def test_pagination_related_resources_data
+    Api::V2::BookResource.paginator :offset
+    Api::V2::BookCommentResource.paginator :offset
+    get '/api/v2/books/1/book_comments?page[limit]=10'
+    assert_equal 200, status
+    assert_equal 10, json_response['data'].size
+    assert_equal 'This is comment 9 on book 0.', json_response['data'][9]['body']
+  end
+
+  def test_pagination_related_resources_data_includes
+    Api::V2::BookResource.paginator :offset
+    Api::V2::BookCommentResource.paginator :offset
+    get '/api/v2/books/1/book_comments?page[limit]=10&include=author,book'
+    assert_equal 200, status
+    assert_equal 10, json_response['data'].size
+    assert_equal 'This is comment 9 on book 0.', json_response['data'][9]['body']
+  end
+
+  def test_flow_self
+    get '/posts'
+    assert_equal 200, status
+    post_1 = json_response['data'][0]
+
+    get post_1['links']['self']
+    assert_equal 200, status
+    assert_hash_equals post_1, json_response['data']
+  end
+
+  def test_flow_link_has_one_self_link
+    get '/posts'
+    assert_equal 200, status
+    post_1 = json_response['data'][0]
+
+    get post_1['links']['author']['self']
+    assert_equal 200, status
+    assert_hash_equals(json_response, {'data' => post_1['links']['author']})
+  end
+
+  def test_flow_link_has_many_self_link
+    get '/posts'
+    assert_equal 200, status
+    post_1 = json_response['data'][0]
+
+    get post_1['links']['tags']['self']
+    assert_equal 200, status
+    assert_hash_equals(json_response,
+                       {'data' => {
+                          'self' => 'http://www.example.com/posts/1/links/tags',
+                          'resource' => 'http://www.example.com/posts/1/tags',
+                          'type' => 'tags', 'ids'=>['1', '2', '3']
+                         }
+                       })
+  end
+
+  def test_flow_link_has_many_self_link_put
+    get '/posts'
+    assert_equal 200, status
+    post_1 = json_response['data'][0]
+
+    post post_1['links']['tags']['self'],
+         {'data' => {'type' => 'tags', 'ids' => ['5']}}.to_json,
+         "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 204, status
+
+    get post_1['links']['tags']['self']
+    assert_equal 200, status
+    assert_hash_equals(json_response,
+                       {'data' => {
+                         'self' => 'http://www.example.com/posts/1/links/tags',
+                         'resource' => 'http://www.example.com/posts/1/tags',
+                         'type' => 'tags', 'ids'=>['1', '2', '3', '5']
+                       }
+                       })
+  end
+
 end