jsonapi-resources 0.5.9 → 0.6.0

data/lib/jsonapi/resource.rb

@@ -22,7 +22,7 @@ module JSONAPI
                                        :remove_to_one_link,
                                        :replace_fields
 
-    def initialize(model, context = nil)
+    def initialize(model, context)
       @model = model
       @context = context
     end
@@ -111,7 +111,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, _options = {})
+    def records_for(relation_name)
       model.public_send relation_name
     end
 
@@ -180,7 +180,6 @@ module JSONAPI
 
     def _replace_to_many_links(relationship_type, relationship_key_values)
       relationship = self.class._relationships[relationship_type]
-
       send("#{relationship.foreign_key}=", relationship_key_values)
       @save_needed = true
 
@@ -208,9 +207,9 @@ module JSONAPI
     end
 
     def _remove_to_many_link(relationship_type, key)
-      relationship = self.class._relationships[relationship_type]
+      relation_name = self.class._relationships[relationship_type].relation_name(context: @context)
 
-      @model.public_send(relationship.type).delete(key)
+      @model.public_send(relation_name).delete(key)
 
       :completed
     end
@@ -619,11 +618,6 @@ module JSONAPI
         @_relationships.map { |key, _relationship| key }
       end
 
-      def _has_relationship?(type)
-        type = type.to_s
-        @_relationships.key?(type.singularize.to_sym) || @_relationships.key?(type.pluralize.to_sym)
-      end
-
       def _relationship(type)
         type = type.to_sym
         @_relationships[type]
@@ -684,7 +678,7 @@ module JSONAPI
       end
 
       def module_path
-        @module_path ||= name =~ /::[^:]+\Z/ ? ($`.freeze.gsub('::', '/') + '/').downcase : ''
+        @module_path ||= name =~ /::[^:]+\Z/ ? ($`.freeze.gsub('::', '/') + '/').underscore : ''
       end
 
       def construct_order_options(sort_params)
@@ -747,10 +741,9 @@ module JSONAPI
             @model.method("#{foreign_key}=").call(value)
           end unless method_defined?("#{foreign_key}=")
 
-          define_method associated_records_method_name do |options = {}|
-            options = options.merge({context: @context})
-            relation_name = relationship.relation_name(options)
-            records_for(relation_name, options)
+          define_method associated_records_method_name do
+            relation_name = relationship.relation_name(context: @context)
+            records_for(relation_name)
           end unless method_defined?(associated_records_method_name)
 
           if relationship.is_a?(JSONAPI::Relationship::ToOne)

data/lib/jsonapi/resource_serializer.rb

@@ -122,12 +122,17 @@ module JSONAPI
       obj_hash
     end
 
-    def requested_fields(model)
-      @fields[model] if @fields
+    def requested_fields(klass)
+      return if @fields.nil? || @fields.empty?
+      if @fields[klass._type]
+        @fields[klass._type]
+      elsif klass.superclass != JSONAPI::Resource
+        requested_fields(klass.superclass)
+      end
     end
 
     def attribute_hash(source)
-      requested = requested_fields(source.class._type)
+      requested = requested_fields(source.class)
       fields = source.fetchable_fields & source.class._attributes.keys.to_a
       fields = requested & fields unless requested.nil?
 
@@ -141,7 +146,7 @@ module JSONAPI
 
     def relationship_data(source, include_directives)
       relationships = source.class._relationships
-      requested = requested_fields(source.class._type)
+      requested = requested_fields(source.class)
       fields = relationships.keys
       fields = requested & fields unless requested.nil?
 

data/lib/jsonapi/resources/version.rb

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

data/lib/jsonapi/routing_ext.rb

@@ -154,7 +154,7 @@ module ActionDispatch
           end
 
           if methods.include?(:destroy)
-            match "relationships/#{formatted_relationship_name}/:keys", controller: options[:controller],
+            match "relationships/#{formatted_relationship_name}", controller: options[:controller],
                                                                         action: 'destroy_relationship', relationship: link_type.to_s, via: [:delete]
           end
         end

data/test/config/database.yml

@@ -1,6 +1,5 @@
 test:
   adapter: sqlite3
-  database: "test_db"
-#  database: ":memory:"
+  database: test_db
   pool: 5
   timeout: 5000

data/test/controllers/controller_test.rb

@@ -1208,13 +1208,31 @@ class PostsControllerTest < ActionController::TestCase
     p = Post.find(14)
     assert_equal [2, 3], p.tag_ids
 
-    delete :destroy_relationship, {post_id: 14, relationship: 'tags', keys: '3'}
+    delete :destroy_relationship, {post_id: 14, relationship: 'tags', data: [{type: 'tags', id: 3}]}
 
     p.reload
     assert_response :no_content
     assert_equal [2], p.tag_ids
   end
 
+  def test_delete_relationship_to_many_with_relationship_url_not_matching_type
+    set_content_type_header!
+    PostResource.has_many :special_tags, relation_name: :special_tags, class_name: "Tag"
+    post :create_relationship, {post_id: 14, relationship: 'special_tags', data: [{type: 'tags', id: 2}]}
+
+    #check the relationship was created successfully
+    assert_equal 1, Post.find(14).special_tags.count
+    before_tags = Post.find(14).tags.count 
+
+    delete :destroy_relationship, {post_id: 14, relationship: 'special_tags', data: [{type: 'tags', id: 2}]}
+    assert_equal 0, Post.find(14).special_tags.count, "Relationship that matches URL relationship not destroyed"
+
+    #check that the tag association is not affected
+    assert_equal Post.find(14).tags.count, before_tags
+  ensure
+    PostResource.instance_variable_get(:@_relationships).delete(:special_tags)
+  end
+
   def test_delete_relationship_to_many_does_not_exist
     set_content_type_header!
     put :update_relationship, {post_id: 14, relationship: 'tags', data: [{type: 'tags', id: 2}, {type: 'tags', id: 3}]}
@@ -1222,7 +1240,7 @@ class PostsControllerTest < ActionController::TestCase
     p = Post.find(14)
     assert_equal [2, 3], p.tag_ids
 
-    delete :destroy_relationship, {post_id: 14, relationship: 'tags', keys: '4'}
+    delete :destroy_relationship, {post_id: 14, relationship: 'tags', data: [{type: 'tags', id: 4}]}
 
     p.reload
     assert_response :not_found
@@ -2827,6 +2845,54 @@ class Api::V2::BooksControllerTest < ActionController::TestCase
     assert_response :success
     assert_equal 2, json_response['data'].size
   end
+
+  def test_books_create_unapproved_comment_limited_user_using_relation_name
+    set_content_type_header!
+    $test_user = Person.find(1)
+
+    book_comment = BookComment.create(body: 'Not Approved dummy comment', approved: false)
+    post :create_relationship, {book_id: 1, relationship: 'book_comments', data: [{type: 'book_comments', id: book_comment.id}]}
+
+    # Note the not_found response is coming from the BookComment's overridden records method, not the relation
+    assert_response :not_found
+
+  ensure
+    book_comment.delete
+  end
+
+  def test_books_create_approved_comment_limited_user_using_relation_name
+    set_content_type_header!
+    $test_user = Person.find(1)
+
+    book_comment = BookComment.create(body: 'Approved dummy comment', approved: true)
+    post :create_relationship, {book_id: 1, relationship: 'book_comments', data: [{type: 'book_comments', id: book_comment.id}]}
+    assert_response :success
+
+  ensure
+    book_comment.delete
+  end
+
+  def test_books_delete_unapproved_comment_limited_user_using_relation_name
+    $test_user = Person.find(1)
+
+    book_comment = BookComment.create(book_id: 1, body: 'Not Approved dummy comment', approved: false)
+    delete :destroy_relationship, {book_id: 1, relationship: 'book_comments', data: [{type: 'book_comments', id: book_comment.id}]}
+    assert_response :not_found
+
+  ensure
+    book_comment.delete
+  end
+
+  def test_books_delete_approved_comment_limited_user_using_relation_name
+    $test_user = Person.find(1)
+
+    book_comment = BookComment.create(book_id: 1, body: 'Approved dummy comment', approved: true)
+    delete :destroy_relationship, {book_id: 1, relationship: 'book_comments', data: [{type: 'book_comments', id: book_comment.id}]}
+    assert_response :no_content
+
+  ensure
+    book_comment.delete
+  end
 end
 
 class Api::V2::BookCommentsControllerTest < ActionController::TestCase
@@ -2971,6 +3037,18 @@ class Api::V1::MoonsControllerTest < ActionController::TestCase
                                 }
 
    end
+
+   def test_get_related_resources_with_select_some_db_columns
+     PlanetResource.paginator :paged
+     original_config = JSONAPI.configuration.dup
+     JSONAPI.configuration.top_level_meta_include_record_count = true
+     JSONAPI.configuration.json_key_format = :dasherized_key
+     get :get_related_resources, {planet_id: '1', relationship: 'moons', source: 'api/v1/planets'}
+     assert_response :success
+     assert_equal 1, json_response['meta']['record-count']
+   ensure
+     JSONAPI.configuration = original_config
+   end
 end
 
 class Api::V1::CratersControllerTest < ActionController::TestCase

data/test/fixtures/active_record.rb

@@ -38,6 +38,13 @@ ActiveRecord::Schema.define do
     t.timestamps null: false
   end
 
+  create_table :companies, force: true do |t|
+    t.string     :type
+    t.string     :name
+    t.string     :address
+    t.timestamps null: false
+  end
+
   create_table :tags, force: true do |t|
     t.string :name
   end
@@ -51,6 +58,11 @@ ActiveRecord::Schema.define do
   end
   add_index :posts_tags, [:post_id, :tag_id], unique: true
 
+  create_table :special_post_tags, force: true do |t|
+    t.references :post, :tag, index: true
+  end
+  add_index :special_post_tags, [:post_id, :tag_id], unique: true
+
   create_table :comments_tags, force: true do |t|
     t.references :comment, :tag, index: true
   end
@@ -234,18 +246,31 @@ class Post < ActiveRecord::Base
   belongs_to :writer, class_name: 'Person', foreign_key: 'author_id'
   has_many :comments
   has_and_belongs_to_many :tags, join_table: :posts_tags
+  has_many :special_post_tags, source: :tag
+  has_many :special_tags, through: :special_post_tags, source: :tag
   belongs_to :section
 
   validates :author, presence: true
   validates :title, length: { maximum: 35 }
 end
 
+class SpecialPostTag < ActiveRecord::Base
+  belongs_to :tag
+  belongs_to :post
+end
+
 class Comment < ActiveRecord::Base
   belongs_to :author, class_name: 'Person', foreign_key: 'author_id'
   belongs_to :post
   has_and_belongs_to_many :tags, join_table: :comments_tags
 end
 
+class Company < ActiveRecord::Base
+end
+
+class Firm < Company
+end
+
 class Tag < ActiveRecord::Base
   has_and_belongs_to_many :posts, join_table: :posts_tags
   has_and_belongs_to_many :planets, join_table: :planets_tags
@@ -366,6 +391,15 @@ end
 class BookComment < ActiveRecord::Base
   belongs_to :author, class_name: 'Person', foreign_key: 'author_id'
   belongs_to :book
+
+  def self.for_user(current_user)
+    records = self
+    # Hide the unapproved comments from people who are not book admins
+    unless current_user && current_user.book_admin
+      records = records.where(approved: true)
+    end
+    records
+  end
 end
 
 class BreedData
@@ -488,6 +522,9 @@ end
 class CommentsController < JSONAPI::ResourceController
 end
 
+class FirmsController < JSONAPI::ResourceController
+end
+
 class SectionsController < JSONAPI::ResourceController
 end
 
@@ -711,6 +748,13 @@ class CommentResource < JSONAPI::Resource
   filters :body
 end
 
+class CompanyResource < JSONAPI::Resource
+  attributes :name, :address
+end
+
+class FirmResource < CompanyResource
+end
+
 class TagResource < JSONAPI::Resource
   attributes :name
 
@@ -719,6 +763,12 @@ 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
@@ -733,6 +783,7 @@ 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
 
@@ -874,6 +925,10 @@ class PlanetResource < JSONAPI::Resource
   has_one :planet_type
 
   has_many :tags, acts_as_set: true
+
+  def records_for_moons
+    Moon.joins(:craters).select('moons.*, craters.code').distinct
+  end
 end
 
 class PropertyResource < JSONAPI::Resource
@@ -913,7 +968,7 @@ class PreferencesResource < JSONAPI::Resource
   has_many :friends
 
   def self.find_by_key(key, options = {})
-    new(Preferences.first)
+    new(Preferences.first, nil)
   end
 end
 
@@ -1104,15 +1159,8 @@ module Api
         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
+          current_user = options[:context][:current_user]
+          _model_class.for_user(current_user)
         end
       end
     end
@@ -1132,6 +1180,7 @@ module Api
     ExpenseEntryResource = ExpenseEntryResource.dup
     IsoCurrencyResource = IsoCurrencyResource.dup
 
+
     class BookResource < Api::V2::BookResource
       paginator :paged
     end

data/test/fixtures/companies.yml

@@ -0,0 +1,4 @@
+firm1:
+  type: Firm
+  name: JSON Consulting Services
+  address: 456 1st Ave.

data/test/integration/routes/routes_test.rb

@@ -38,8 +38,8 @@ class RoutesTest < ActionDispatch::IntegrationTest
   end
 
   def test_routing_posts_links_tags_destroy
-    assert_routing({path: '/posts/1/relationships/tags/1,2', method: :delete},
-                   {controller: 'posts', action: 'destroy_relationship', post_id: '1', keys: '1,2', relationship: 'tags'})
+    assert_routing({path: '/posts/1/relationships/tags', method: :delete},
+                   {controller: 'posts', action: 'destroy_relationship', post_id: '1', relationship: 'tags'})
   end
 
   def test_routing_posts_links_tags_create

data/test/integration/sti_fields_test.rb

@@ -0,0 +1,18 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+class StiFieldsTest < ActionDispatch::IntegrationTest
+  def test_index_fields_when_resource_does_not_match_relationship
+    get "/posts", { filter: { id: "1,2" },
+                  include: "author",
+                  fields: { posts: "author", people: "email" } }
+    assert_response :success
+    assert_equal 2, json_response["data"].size
+    assert json_response["data"][0]["relationships"].key?("author")
+    assert json_response["included"][0]["attributes"].keys == ["email"]
+  end
+
+  def test_fields_for_parent_class
+    get "/firms", { fields: { companies: "name" } }
+    assert_equal json_response["data"][0]["attributes"].keys, ["name"]
+  end
+end

data/test/test_helper.rb

@@ -3,7 +3,9 @@ require 'simplecov'
 # To run tests with coverage:
 # COVERAGE=true rake test
 # To Switch rails versions and run a particular test order:
-# export RAILS_VERSION=4.2; bundle update rails; bundle exec rake TESTOPTS="--seed=39333" test
+# export RAILS_VERSION=4.2.0; bundle update rails; bundle exec rake TESTOPTS="--seed=39333" test
+# We are no longer having Travis test Rails 4.0.x. To test on Rails 4.0.x use this:
+# export RAILS_VERSION=4.0.0; bundle update rails; bundle exec rake test
 
 if ENV['COVERAGE']
   SimpleCov.start do
@@ -115,9 +117,11 @@ JSONAPI.configuration.route_format = :underscored_route
 TestApp.routes.draw do
   jsonapi_resources :people
   jsonapi_resources :comments
+  jsonapi_resources :firms
   jsonapi_resources :tags
   jsonapi_resources :posts do
     jsonapi_relationships
+    jsonapi_links :special_tags
   end
   jsonapi_resources :sections
   jsonapi_resources :iso_currencies
@@ -134,6 +138,8 @@ TestApp.routes.draw do
   jsonapi_resources :documents
   jsonapi_resources :products
 
+  
+
   namespace :api do
     namespace :v1 do
       jsonapi_resources :people