jsonapi-resources 0.4.2 → 0.4.3

data/test/fixtures/active_record.rb

@@ -13,7 +13,8 @@ ActiveRecord::Schema.define do
     t.string     :email
     t.datetime   :date_joined
     t.belongs_to :preferences
-    t.integer :hair_cut_id, index: true
+    t.integer    :hair_cut_id, index: true
+    t.boolean    :book_admin, default: false
     t.timestamps null: false
   end
 
@@ -96,7 +97,7 @@ ActiveRecord::Schema.define do
     t.string   :spouse_name
     t.text     :bio
     t.float    :quality_rating
-    t.decimal  :salary, :precision => 12, :scale => 2
+    t.decimal  :salary, precision: 12, scale: 2
     t.datetime :date_time_joined
     t.date     :birthday
     t.time     :bedtime
@@ -107,12 +108,14 @@ ActiveRecord::Schema.define do
   create_table :books, force: true do |t|
     t.string :title
     t.string :isbn
+    t.boolean :banned, default: false
   end
 
   create_table :book_comments, force: true do |t|
     t.text       :body
     t.belongs_to :book, index: true
     t.integer    :author_id
+    t.boolean    :approved, default: true
     t.timestamps null: false
   end
 
@@ -167,6 +170,28 @@ ActiveRecord::Schema.define do
     t.string :name
     t.string :status, limit: 10
   end
+
+  create_table :pictures, force: true do |t|
+    t.string  :name
+    t.integer :imageable_id
+    t.string  :imageable_type
+    t.timestamps null: false
+  end
+
+  create_table :documents, force: true do |t|
+    t.string  :name
+    t.timestamps null: false
+  end
+
+  create_table :products, force: true do |t|
+    t.string  :name
+    t.timestamps null: false
+  end
+
+  create_table :vehicles, force: true do |t|
+    t.string :type
+    t.integer :person_id
+  end
 end
 
 ### MODELS
@@ -174,6 +199,7 @@ class Person < ActiveRecord::Base
   has_many :posts, foreign_key: 'author_id'
   has_many :comments, foreign_key: 'author_id'
   has_many :expense_entries, foreign_key: 'employee_id', dependent: :restrict_with_exception
+  has_many :vehicles
   belongs_to :preferences
   belongs_to :hair_cut
 
@@ -289,6 +315,7 @@ end
 
 class Book < ActiveRecord::Base
   has_many :book_comments
+  has_many :approved_book_comments, -> { where(approved: true) }, class_name: "BookComment"
 end
 
 class BookComment < ActiveRecord::Base
@@ -343,6 +370,28 @@ end
 class Category < ActiveRecord::Base
 end
 
+class Picture < ActiveRecord::Base
+  belongs_to :imageable, polymorphic: true
+end
+
+class Vehicle < ActiveRecord::Base
+  belongs_to :person
+end
+
+class Car < Vehicle
+end
+
+class Boat < Vehicle
+end
+
+class Document < ActiveRecord::Base
+  has_many :pictures, as: :imageable
+end
+
+class Product < ActiveRecord::Base
+  has_one :picture, as: :imageable
+end
+
 ### PORO Data - don't do this in a production app
 $breed_data = BreedData.new
 $breed_data.add(Breed.new(0, 'persian'))
@@ -393,6 +442,18 @@ end
 class CategoriesController < JSONAPI::ResourceController
 end
 
+class PicturesController < JSONAPI::ResourceController
+end
+
+class DocumentsController < JSONAPI::ResourceController
+end
+
+class ProductsController < JSONAPI::ResourceController
+end
+
+class ImageablesController < JSONAPI::ResourceController
+end
+
 ### CONTROLLERS
 module Api
   module V1
@@ -445,9 +506,15 @@ module Api
     end
 
     class BooksController < JSONAPI::ResourceController
+      def context
+        {current_user: $test_user}
+      end
     end
 
     class BookCommentsController < JSONAPI::ResourceController
+      def context
+        {current_user: $test_user}
+      end
     end
   end
 
@@ -525,6 +592,7 @@ class PersonResource < JSONAPI::Resource
 
   has_many :comments
   has_many :posts
+  has_many :vehicles, polymorphic: true
 
   has_one :preferences
   has_one :hair_cut
@@ -544,6 +612,16 @@ class PersonResource < JSONAPI::Resource
   end
 end
 
+class VehicleResource < JSONAPI::Resource
+  has_one :person
+end
+
+class CarResource < VehicleResource
+end
+
+class BoatResource < VehicleResource
+end
+
 class CommentResource < JSONAPI::Resource
   attributes :body
   has_one :post
@@ -611,6 +689,13 @@ class PostResource < JSONAPI::Resource
     @model.title
   end
 
+  def title=(title)
+    @model.title = title
+    if title == 'BOOM'
+      raise 'The Server just tested going boom. If this was a real emergency you would be really dead right now.'
+    end
+  end
+
   filters :title, :author, :tags, :comments
   filters :id, :ids
 
@@ -689,7 +774,7 @@ class BreedResource < JSONAPI::Resource
   attribute :name, format: :title
 
   # This is unneeded, just here for testing
-  routing_options :param => :id
+  routing_options param: :id
 
   def self.find(filters, options = {})
     breeds = []
@@ -764,6 +849,28 @@ class CategoryResource < JSONAPI::Resource
   filter :status, default: 'active'
 end
 
+class PictureResource < JSONAPI::Resource
+  attribute :name
+  has_one :imageable, polymorphic: true
+end
+
+class DocumentResource < JSONAPI::Resource
+  attribute :name
+  has_many :pictures
+end
+
+class ProductResource < JSONAPI::Resource
+  attribute :name
+  has_one :picture
+
+  def picture_id
+    model.picture.id
+  end
+end
+
+class ImageableResource < JSONAPI::Resource
+end
+
 module Api
   module V1
     class WriterResource < JSONAPI::Resource
@@ -794,7 +901,6 @@ module Api
       filters :writer
     end
 
-    # AuthorResource = AuthorResource.dup
     PersonResource = PersonResource.dup
     CommentResource = CommentResource.dup
     TagResource = TagResource.dup
@@ -809,27 +915,119 @@ module Api
     EmployeeResource = EmployeeResource.dup
     FriendResource = FriendResource.dup
     HairCutResource = HairCutResource.dup
+    VehicleResource = VehicleResource.dup
+    CarResource = CarResource.dup
+    BoatResource = BoatResource.dup
   end
 end
 
 module Api
   module V2
     PreferencesResource = PreferencesResource.dup
-    # AuthorResource = AuthorResource.dup
     PersonResource = PersonResource.dup
     PostResource = PostResource.dup
 
     class BookResource < JSONAPI::Resource
       attribute :title
-      attribute :isbn
+      attributes :isbn, :banned
+
+      has_many :book_comments, relation_name: -> (options = {}) {
+        context = options[:context]
+        current_user = context ? context[:current_user] : nil
 
-      has_many :book_comments
+        unless current_user && current_user.book_admin
+          :approved_book_comments
+        else
+          :book_comments
+        end
+      }
+
+      filters :banned, :book_comments
+
+      class << self
+        def apply_filter(records, filter, value, options)
+          context = options[:context]
+          current_user = context ? context[:current_user] : nil
+
+          case filter
+            when :banned
+              # Only book admins my filter for banned books
+              if current_user && current_user.book_admin
+                return records.where('books.banned = ?', value[0] == 'true')
+              end
+            else
+              return super(records, filter, value)
+          end
+        end
+
+        def books
+          Book.arel_table
+        end
+
+        def not_banned_books
+          books[:banned].eq(false)
+        end
+
+        def records(options = {})
+          context = options[:context]
+          current_user = context ? context[:current_user] : nil
+
+          records = _model_class
+          # Hide the banned books from people who are not book admins
+          unless current_user && current_user.book_admin
+            records = records.where(not_banned_books)
+          end
+          records
+        end
+      end
     end
 
     class BookCommentResource < JSONAPI::Resource
-      attributes :body
+      attributes :body, :approved
+
       has_one :book
       has_one :author, class_name: 'Person'
+
+      filters :approved, :book
+
+      class << self
+        def book_comments
+          BookComment.arel_table
+        end
+
+        def approved_comments(approved = true)
+          book_comments[:approved].eq(approved)
+        end
+
+        def apply_filter(records, filter, value, options)
+          context = options[:context]
+          current_user = context ? context[:current_user] : nil
+
+          case filter
+            when :approved
+              # Only book admins my filter for unapproved comments
+              if current_user && current_user.book_admin
+                records.where(approved_comments(value[0] == 'true'))
+              end
+            else
+              #:nocov:
+              return super(records, filter, value)
+            #:nocov:
+          end
+        end
+
+        def records(options = {})
+          context = options[:context]
+          current_user = context ? context[:current_user] : nil
+
+          records = _model_class
+          # Hide the unapproved comments from people who are not book admins
+          unless current_user && current_user.book_admin
+            records = records.where(approved_comments)
+          end
+          records
+        end
+      end
     end
   end
 end

data/test/fixtures/book_comments.yml

@@ -4,8 +4,9 @@
 book_<%= book_num %>_comment_<%= comment_num %>:
   id: <%= comment_id %>
   body: This is comment <%= comment_num %> on book <%= book_num %>.
-  author_id: 1
+  author_id: <%= book_num.even? ? comment_id % 2 : (comment_id % 2) + 2 %>
   book_id: <%= book_num %>
+  approved: <%= comment_num.even? %>
   <% comment_id = comment_id + 1 %>
   <% end %>
 <% end %>

data/test/fixtures/books.yml

@@ -3,4 +3,5 @@ book_<%= book_num %>:
   id: <%= book_num %>
   title: Book <%= book_num %>
   isbn: 12345-<%= book_num %>-6789
+  banned: <%= book_num > 600 && book_num < 700 %>
 <% end %>

data/test/fixtures/documents.yml

@@ -0,0 +1,3 @@
+document_1:
+  id: 1
+  name: Company Brochure

data/test/fixtures/people.yml

@@ -21,4 +21,11 @@ d:
   id: 4
   name: Tag Crazy Author
   email: taggy@xyz.fake
-  date_joined: <%= DateTime.parse('2013-11-30 4:20:00 UTC +00:00') %>
+  date_joined: <%= DateTime.parse('2013-11-30 4:20:00 UTC +00:00') %>
+
+e:
+  id: 5
+  name: Wilma Librarian
+  email: lib@xyz.fake
+  date_joined: <%= DateTime.parse('2013-11-30 4:20:00 UTC +00:00') %>
+  book_admin: true

data/test/fixtures/pictures.yml

@@ -0,0 +1,15 @@
+picture_1:
+  id: 1
+  name: enterprise_gizmo.jpg
+  imageable_id: 1
+  imageable_type: Product
+
+picture_2:
+  id: 2
+  name: company_brochure.jpg
+  imageable_id: 1
+  imageable_type: Document
+
+picture_3:
+  id: 3
+  name: group_photo.jpg

data/test/fixtures/products.yml

@@ -0,0 +1,3 @@
+product_1:
+  id: 1
+  name: Enterprise Gizmo

data/test/fixtures/vehicles.yml

@@ -0,0 +1,8 @@
+car:
+  id: 1
+  type: Car
+  person_id: 1
+boat:
+  id: 2
+  type: Boat
+  person_id: 1

data/test/helpers/{hash_helpers.rb → assertions.rb}

@@ -1,8 +1,13 @@
 module Helpers
-  module HashHelpers
+  module Assertions
     def assert_hash_equals(exp, act, msg = nil)
       msg = message(msg, '') { diff exp, act }
       assert(matches_hash?(exp, act, {exact: true}), msg)
     end
+
+    def assert_array_equals(exp, act, msg = nil)
+      msg = message(msg, '') { diff exp, act }
+      assert(matches_array?(exp, act, {exact: true}), msg)
+    end
   end
 end

data/test/integration/requests/request_test.rb

@@ -4,6 +4,7 @@ class RequestTest < ActionDispatch::IntegrationTest
   def setup
     JSONAPI.configuration.json_key_format = :underscored_key
     JSONAPI.configuration.route_format = :underscored_route
+    $test_user = Person.find(1)
   end
 
   def after_teardown
@@ -337,7 +338,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     Api::V2::BookResource.paginator :none
     get '/api/v2/books'
     assert_equal 200, status
-    assert_equal 1000, json_response['data'].size
+    assert_equal 901, json_response['data'].size
   end
 
   def test_pagination_offset_style
@@ -385,7 +386,7 @@ class RequestTest < ActionDispatch::IntegrationTest
     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 1.', json_response['data'][9]['attributes']['body']
+    assert_equal 'This is comment 18 on book 1.', json_response['data'][9]['attributes']['body']
   end
 
   def test_pagination_related_resources_data_includes
@@ -394,9 +395,19 @@ class RequestTest < ActionDispatch::IntegrationTest
     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 1.', json_response['data'][9]['attributes']['body']
+    assert_equal 'This is comment 18 on book 1.', json_response['data'][9]['attributes']['body']
   end
 
+  # def test_pagination_related_resources_data_includes
+  #   Api::V2::BookResource.paginator :none
+  #   Api::V2::BookCommentResource.paginator :none
+  #   get '/api/v2/books?filter[]'
+  #   assert_equal 200, status
+  #   assert_equal 10, json_response['data'].size
+  #   assert_equal 'This is comment 18 on book 1.', json_response['data'][9]['attributes']['body']
+  # end
+
+
   def test_flow_self
     get '/posts'
     assert_equal 200, status