jsonapi-resources 0.7.0 → 0.7.1.beta1

data/lib/jsonapi/relationship.rb

@@ -25,6 +25,10 @@ module JSONAPI
       @resource_klass = @parent_resource.resource_for(@class_name)
     end
 
+    def table_name
+      @table_name ||= resource_klass._table_name
+    end
+
     def relation_name(options)
       case @relation_name
         when Symbol
@@ -47,6 +51,10 @@ module JSONAPI
       end
     end
 
+    def belongs_to?
+      false
+    end
+
     class ToOne < Relationship
       attr_reader :foreign_key_on
 

data/lib/jsonapi/request.rb

@@ -32,11 +32,9 @@ module JSONAPI
 
       @resource_klass ||= Resource.resource_for(params[:controller]) if params[:controller]
 
-      unless params.nil?
-        setup_action_method_name = "setup_#{params[:action]}_action"
-        if respond_to?(setup_action_method_name)
-          send(setup_action_method_name, params)
-        end
+      setup_action_method_name = "setup_#{params[:action]}_action"
+      if respond_to?(setup_action_method_name)
+        send(setup_action_method_name, params)
       end
     rescue ActionController::ParameterMissing => e
       @errors.concat(JSONAPI::Exceptions::ParameterMissing.new(e.param).errors)
@@ -516,7 +514,7 @@ module JSONAPI
       params.each do |key, value|
         case key.to_s
         when 'relationships'
-          value.each_key do |links_key|
+          value.keys.each do |links_key|
             unless formatted_allowed_fields.include?(links_key.to_sym)
               params_not_allowed.push(links_key)
               unless JSONAPI.configuration.raise_if_parameters_not_allowed

data/lib/jsonapi/resource.rb

@@ -105,8 +105,9 @@ module JSONAPI
       end
     end
 
+    # Override this on a resource instance to override the fetchable keys
     def fetchable_fields
-      self.class.fetchable_fields(context)
+      self.class.fields
     end
 
     # Override this on a resource to customize how the associated records
@@ -119,6 +120,29 @@ module JSONAPI
       _model.errors.messages
     end
 
+    # Add metadata to validation error objects.
+    #
+    # Suppose `model_error_messages` returned the following error messages
+    # hash:
+    #
+    #   {password: ["too_short", "format"]}
+    #
+    # Then to add data to the validation error `validation_error_metadata`
+    # could return:
+    #
+    #   {
+    #     password: {
+    #       "too_short": {"minimum_length" => 6},
+    #       "format": {"requirement" => "must contain letters and numbers"}
+    #     }
+    #   }
+    #
+    # The specified metadata is then be merged into the validation error
+    # object.
+    def validation_error_metadata
+      {}
+    end
+
     # Override this to return resource level meta data
     # must return a hash, and if the hash is empty the meta section will not be serialized with the resource
     # meta keys will be not be formatted with the key formatter for the serializer by default. They can however use the
@@ -173,8 +197,9 @@ module JSONAPI
     end
 
     def _remove
-      @model.destroy
-
+      unless @model.destroy
+        fail JSONAPI::Exceptions::ValidationErrors.new(self)
+      end
       :completed
     end
 
@@ -440,11 +465,6 @@ module JSONAPI
       end
       # :nocov:
 
-      # Override in your resource to filter the fetchable keys
-      def fetchable_fields(_context = nil)
-        fields
-      end
-
       # Override in your resource to filter the updatable keys
       def updatable_fields(_context = nil)
         _updatable_relationships | _attributes.keys - [:id]
@@ -523,11 +543,11 @@ module JSONAPI
         if filters
           filters.each do |filter, value|
             if _relationships.include?(filter)
-              if _relationships[filter].is_a?(JSONAPI::Relationship::ToMany)
-                required_includes.push(filter.to_s)
-                records = apply_filter(records, "#{filter}.#{_relationships[filter].primary_key}", value, options)
+              if _relationships[filter].belongs_to?
+                records = apply_filter(records, _relationships[filter].foreign_key, value, options)
               else
-                records = apply_filter(records, "#{_relationships[filter].foreign_key}", value, options)
+                required_includes.push(filter.to_s)
+                records = apply_filter(records, "#{_relationships[filter].table_name}.#{_relationships[filter].primary_key}", value, options)
               end
             else
               records = apply_filter(records, filter, value, options)
@@ -587,7 +607,7 @@ module JSONAPI
       # Override this method if you want to customize the relation for
       # finder methods (find, find_by_key)
       def records(_options = {})
-        _model_class
+        _model_class.all
       end
 
       def verify_filters(filters, context = nil)
@@ -696,6 +716,10 @@ module JSONAPI
         @_primary_key ||= _model_class.respond_to?(:primary_key) ? _model_class.primary_key : :id
       end
 
+      def _table_name
+        @_table_name ||= _model_class.respond_to?(:table_name) ? _model_class.table_name : _model_name.tableize
+      end
+
       def _as_parent_key
         @_as_parent_key ||= "#{_type.to_s.singularize}_id"
       end

data/lib/jsonapi/resource_controller.rb

@@ -1,5 +1,17 @@
 module JSONAPI
-  class ResourceController < ActionController::Base
-    include JSONAPI::ActsAsResourceController
+  class ResourceController < ActionController::Metal
+    MODULES = [
+      AbstractController::Rendering,
+      ActionController::Rendering,
+      ActionController::Renderers::All,
+      ActionController::StrongParameters,
+      ActionController::ForceSSL,
+      ActionController::Instrumentation,
+      JSONAPI::ActsAsResourceController
+    ].freeze
+
+    MODULES.each do |mod|
+      include mod
+    end
   end
 end

data/lib/jsonapi/resource_serializer.rb

@@ -93,14 +93,7 @@ module JSONAPI
     # The fields options controls both fields and included links references.
     def process_primary(source, include_directives)
       if source.respond_to?(:to_ary)
-        source.each do |resource|
-          id = resource.id
-          if already_serialized?(resource.class._type, id)
-            set_primary(@primary_class_name, id)
-          end
-
-          add_included_object(id, object_hash(resource,  include_directives), true)
-        end
+        source.each { |resource| process_primary(resource, include_directives) }
       else
         return {} if source.nil?
 
@@ -278,6 +271,7 @@ module JSONAPI
     end
 
     def link_object_to_many(source, relationship, include_linkage)
+      include_linkage = include_linkage | relationship.always_include_linkage_data
       link_object_hash = {}
       link_object_hash[:links] = {}
       link_object_hash[:links][:self] = self_link(source, relationship)

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.7.0'
+    VERSION = '0.7.1.beta1'
   end
 end

data/lib/jsonapi/routing_ext.rb

@@ -69,7 +69,7 @@ module ActionDispatch
           options[:path] = format_route(@resource_type)
 
           if res.resource_key_type == :uuid
-            options[:constraints] = {id: /[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}(,[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})*/}
+            options[:constraints] = {id: /[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}/}
           end
 
           if options[:except]

data/locales/en.yml

@@ -0,0 +1,80 @@
+en:
+  jsonapi-resources:
+    exceptions:
+      internal_server_error:
+        title: 'Internal Server Error'
+        detail: 'Internal Server Error'
+      invalid_resource:
+        title: 'Invalid resource'
+        detail: "%{resource} is not a valid resource."
+      record_not_found:
+        title: 'Record not found'
+        detail: "The record identified by %{id} could not be found."
+      unsupported_media_type:
+        title: 'Unsupported media type'
+        detail: "All requests that create or update must use the '%{needed_media_type}' Content-Type. This request specified '%{media_type}.'"
+      has_many_relation:
+        title: 'Relation exists'
+        detail: "The relation to %{id} already exists."
+      to_many_set_replacement_forbidden:
+        title: 'Complete replacement forbidden'
+        detail: 'Complete replacement forbidden for this relationship'
+      invalid_filter_syntax:
+        title: 'Invalid filters syntax'
+        detail: "%{filters} is not a valid syntax for filtering."
+      filter_not_allowed:
+        title: "Filter not allowed"
+        detail: "%{filter} is not allowed."
+      invalid_filter_value:
+        title: 'Invalid filter value'
+        detail: "%{value} is not a valid value for %{filter}."
+      invalid_field_value:
+        title: 'Invalid field value'
+        detail: "%{value} is not a valid value for %{field}."
+      invalid_field_format:
+        title: 'Invalid field format'
+        detail: 'Fields must specify a type.'
+      invalid_links_object:
+        title: 'Invalid Links Object'
+        detail: 'Data is not a valid Links Object.'
+      type_mismatch:
+        title: 'Type Mismatch'
+        detail: "%{type} is not a valid type for this operation."
+      invalid_field:
+        title: 'Invalid field'
+        detail: "%{field} is not a valid field for %{type}."
+      invalid_include:
+        title: 'Invalid field'
+        detail: "%{relationship} is not a valid relationship of %{resource}"
+      invalid_sort_criteria:
+        title: 'Invalid sort criteria'
+        detail: "%{sort_criteria} is not a valid sort criteria for %{resource}"
+      parameters_not_allowed:
+        title: 'Param not allowed'
+        detail: "%{param} is not allowed."
+      parameter_missing:
+        title: 'Missing Parameter'
+        detail: "The required parameter, %{param}, is missing."
+      count_mismatch:
+        title: 'Count to key mismatch'
+        detail: 'The resource collection does not contain the same number of objects as the number of keys.'
+      key_not_included_in_url:
+        title: 'Key is not included in URL'
+        detail: "The URL does not support the key %{key}"
+      missing_key:
+        title: 'A key is required'
+        detail: 'The resource object does not contain a key.'
+      record_locked:
+        title: 'Locked resource'
+      save_failed:
+        title: 'Save failed or was cancelled'
+        detail: 'Save failed or was cancelled'
+      invalid_page_object:
+        title: 'Invalid Page Object'
+        detail: 'Invalid Page Object.'
+      page_parameters_not_allowed:
+        title: 'Page parameter not allowed'
+        detail: "%{param} is not an allowed page parameter."
+      invalid_page_value:
+        title: 'Invalid page value'
+        detail: "%{value} is not a valid value for %{page} page parameter."

data/test/controllers/controller_test.rb

@@ -485,7 +485,7 @@ class PostsControllerTest < ActionController::TestCase
     assert_equal 1, json_response['meta']["warnings"].count
     assert_equal "Param not allowed", json_response['meta']["warnings"][0]["title"]
     assert_equal "asdfg is not allowed.", json_response['meta']["warnings"][0]["detail"]
-    assert_equal 105, json_response['meta']["warnings"][0]["code"]
+    assert_equal '105', json_response['meta']["warnings"][0]["code"]
   ensure
     JSONAPI.configuration.raise_if_parameters_not_allowed = true
   end
@@ -695,7 +695,7 @@ class PostsControllerTest < ActionController::TestCase
     assert_equal 1, json_response['meta']["warnings"].count
     assert_equal "Param not allowed", json_response['meta']["warnings"][0]["title"]
     assert_equal "subject is not allowed.", json_response['meta']["warnings"][0]["detail"]
-    assert_equal 105, json_response['meta']["warnings"][0]["code"]
+    assert_equal '105', json_response['meta']["warnings"][0]["code"]
   ensure
     JSONAPI.configuration.raise_if_parameters_not_allowed = true
   end
@@ -866,7 +866,7 @@ class PostsControllerTest < ActionController::TestCase
     assert_equal 1, json_response['meta']["warnings"].count
     assert_equal "Param not allowed", json_response['meta']["warnings"][0]["title"]
     assert_equal "subject is not allowed.", json_response['meta']["warnings"][0]["detail"]
-    assert_equal 105, json_response['meta']["warnings"][0]["code"]
+    assert_equal '105', json_response['meta']["warnings"][0]["code"]
   ensure
     JSONAPI.configuration.raise_if_parameters_not_allowed = true
   end
@@ -1653,6 +1653,14 @@ class PostsControllerTest < ActionController::TestCase
     assert_response :bad_request
   end
 
+  def test_delete_with_validation_error
+    post = Post.create!(title: "can't destroy me", author: Person.first)
+    delete :destroy, { id: post.id }
+
+    assert_equal "can't destroy me", json_response['errors'][0]['title']
+    assert_response :unprocessable_entity
+  end
+
   def test_delete_single
     initial_count = Post.count
     delete :destroy, {id: '4'}
@@ -3273,10 +3281,32 @@ class Api::V7::CustomersControllerTest < ActionController::TestCase
 end
 
 class Api::V7::CategoriesControllerTest < ActionController::TestCase
-  def test_uncaught_error_in_controller
+  def test_uncaught_error_in_controller_translated_to_internal_server_error
 
     get :show, {id: '1'}
     assert_response 500
     assert_match /Internal Server Error/, json_response['errors'][0]['detail']
   end
-end
+
+  def test_not_whitelisted_error_in_controller
+    original_config = JSONAPI.configuration.dup
+    JSONAPI.configuration.operations_processor = :error_raising
+    JSONAPI.configuration.exception_class_whitelist = []
+    get :show, {id: '1'}
+    assert_response 500
+    assert_match /Internal Server Error/, json_response['errors'][0]['detail']
+  ensure
+    JSONAPI.configuration = original_config
+  end
+
+  def test_whitelisted_error_in_controller
+    original_config = JSONAPI.configuration.dup
+    JSONAPI.configuration.operations_processor = :error_raising
+    JSONAPI.configuration.exception_class_whitelist = [PostsController::SubSpecialError]
+    assert_raises PostsController::SubSpecialError do
+      get :show, {id: '1'}
+    end
+  ensure
+    JSONAPI.configuration = original_config
+  end
+end

data/test/fixtures/active_record.rb

@@ -282,6 +282,15 @@ class Post < ActiveRecord::Base
 
   validates :author, presence: true
   validates :title, length: { maximum: 35 }
+
+  before_destroy :destroy_callback
+
+  def destroy_callback
+    if title == "can't destroy me"
+      errors.add(:title, "can't destroy me")
+      return false
+    end
+  end
 end
 
 class SpecialPostTag < ActiveRecord::Base
@@ -368,8 +377,7 @@ class Crater < ActiveRecord::Base
 end
 
 class Preferences < ActiveRecord::Base
-  has_one :author, class_name: 'Person'
-  has_many :friends, class_name: 'Person'
+  has_one :author, class_name: 'Person', :inverse_of => 'preferences'
 end
 
 class Fact < ActiveRecord::Base
@@ -979,9 +987,6 @@ class EmployeeResource < JSONAPI::Resource
   model_name 'Person'
 end
 
-class FriendResource < JSONAPI::Resource
-end
-
 class BreedResource < JSONAPI::Resource
   attribute :name, format: :title
 
@@ -1053,8 +1058,7 @@ end
 class PreferencesResource < JSONAPI::Resource
   attribute :advanced_mode
 
-  has_one :author, foreign_key: :person_id
-  has_many :friends
+  has_one :author, :foreign_key_on => :related
 
   def self.find_by_key(key, options = {})
     new(Preferences.first, nil)
@@ -1164,7 +1168,6 @@ module Api
     class CraterResource < CraterResource; end
     class PreferencesResource < PreferencesResource; end
     class EmployeeResource < EmployeeResource; end
-    class FriendResource < FriendResource; end
     class HairCutResource < HairCutResource; end
     class VehicleResource < VehicleResource; end
     class CarResource < CarResource; end

data/test/fixtures/comments.yml

@@ -18,4 +18,4 @@ post_2_thanks_man:
 
 rogue_comment:
   body: Rogue Comment Here
-  author_id: 3
+  author_id: 3

data/test/fixtures/preferences.yml

@@ -1,18 +1,14 @@
 a:
   id: 1
-  person_id:
   advanced_mode: false
 
 b:
   id: 2
-  person_id:
   advanced_mode: false
 c:
   id: 3
-  person_id:
   advanced_mode: false
 
 d:
   id: 4
-  person_id:
   advanced_mode: false

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

@@ -0,0 +1,25 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+require 'generators/jsonapi/controller_generator'
+
+module Jsonapi
+  class ControllerGeneratorTest < Rails::Generators::TestCase
+    tests ControllerGenerator
+    destination Rails.root.join('../controllers')
+    setup :prepare_destination
+    teardown :cleanup_destination_root
+
+    def cleanup_destination_root
+      FileUtils.rm_rf destination_root
+    end
+
+    test "controller is created" do
+      run_generator ["post"]
+      assert_file 'app/controllers/posts_controller.rb', /class PostsController < JSONAPI::ResourceController/
+    end
+
+    test "controller is created with namespace" do
+      run_generator ["api/v1/post"]
+      assert_file 'app/controllers/api/v1/posts_controller.rb', /class Api::V1::PostsController < JSONAPI::ResourceController/
+    end
+  end
+end