jsonapi-resources 0.7.0 → 0.7.1.beta1

data/lib/generators/jsonapi/USAGE

@@ -1,8 +1,13 @@
 Description:
     Generator for JSONAPI Resources
 
-Example:
+Examples:
     rails generate jsonapi:resource Post
 
     This will create:
         app/resources/post_resource.rb
+
+    rails generate jsonapi:controller Post
+
+    This will create:
+        app/controllers/posts_controller.rb

data/lib/generators/jsonapi/controller_generator.rb

@@ -0,0 +1,14 @@
+module Jsonapi
+  class ControllerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_resource
+      template_file = File.join(
+        'app/controllers',
+        class_path,
+        "#{file_name.pluralize}_controller.rb"
+      )
+      template 'jsonapi_controller.rb', template_file
+    end
+  end
+end

data/lib/generators/jsonapi/templates/jsonapi_controller.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name.pluralize %>Controller < JSONAPI::ResourceController
+end
+<% end -%>

data/lib/jsonapi/active_record_operations_processor.rb

@@ -18,7 +18,7 @@ class ActiveRecordOperationsProcessor < JSONAPI::OperationsProcessor
   # Catch errors that should be handled before JSONAPI::Exceptions::Error
   # and other unprocessed exceptions
   def process_operation(operation)
-    with_default_handling do 
+    with_default_handling do
       begin
         operation.apply
       rescue ActiveRecord::DeleteRestrictionError => e
@@ -26,9 +26,10 @@ class ActiveRecordOperationsProcessor < JSONAPI::OperationsProcessor
         return JSONAPI::ErrorsOperationResult.new(record_locked_error.errors[0].code, record_locked_error.errors)
 
       rescue ActiveRecord::RecordNotFound
-        record_not_found = JSONAPI::Exceptions::RecordNotFound.new(operation.associated_key)
+        key = operation.respond_to?(:associated_key) ? operation.associated_key : :unavailable
+        record_not_found = JSONAPI::Exceptions::RecordNotFound.new(key)
         return JSONAPI::ErrorsOperationResult.new(record_not_found.errors[0].code, record_not_found.errors)
       end
-    end  
+    end
   end
 end

data/lib/jsonapi/acts_as_resource_controller.rb

@@ -179,9 +179,13 @@ module JSONAPI
       when JSONAPI::Exceptions::Error
         render_errors(e.errors)
       else
-        internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
-        Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
-        render_errors(internal_server_error.errors)
+        if JSONAPI.configuration.exception_class_whitelist.any? { |k| e.class.ancestors.include?(k) }
+          fail e
+        else
+          internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
+          Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
+          render_errors(internal_server_error.errors)
+        end
       end
     end
 

data/lib/jsonapi/error_codes.rb

@@ -1,30 +1,30 @@
 module JSONAPI
-  VALIDATION_ERROR = 100
-  INVALID_RESOURCE = 101
-  FILTER_NOT_ALLOWED = 102
-  INVALID_FIELD_VALUE = 103
-  INVALID_FIELD = 104
-  PARAM_NOT_ALLOWED = 105
-  PARAM_MISSING = 106
-  INVALID_FILTER_VALUE = 107
-  COUNT_MISMATCH = 108
-  KEY_ORDER_MISMATCH = 109
-  KEY_NOT_INCLUDED_IN_URL = 110
-  INVALID_INCLUDE = 112
-  RELATION_EXISTS = 113
-  INVALID_SORT_CRITERIA = 114
-  INVALID_LINKS_OBJECT = 115
-  TYPE_MISMATCH = 116
-  INVALID_PAGE_OBJECT = 117
-  INVALID_PAGE_VALUE = 118
-  INVALID_FIELD_FORMAT = 119
-  INVALID_FILTERS_SYNTAX = 120
-  SAVE_FAILED = 121
-  FORBIDDEN = 403
-  RECORD_NOT_FOUND = 404
-  UNSUPPORTED_MEDIA_TYPE = 415
-  LOCKED = 423
-  INTERNAL_SERVER_ERROR = 500
+  VALIDATION_ERROR = '100'
+  INVALID_RESOURCE = '101'
+  FILTER_NOT_ALLOWED = '102'
+  INVALID_FIELD_VALUE = '103'
+  INVALID_FIELD = '104'
+  PARAM_NOT_ALLOWED = '105'
+  PARAM_MISSING = '106'
+  INVALID_FILTER_VALUE = '107'
+  COUNT_MISMATCH = '108'
+  KEY_ORDER_MISMATCH = '109'
+  KEY_NOT_INCLUDED_IN_URL = '110'
+  INVALID_INCLUDE = '112'
+  RELATION_EXISTS = '113'
+  INVALID_SORT_CRITERIA = '114'
+  INVALID_LINKS_OBJECT = '115'
+  TYPE_MISMATCH = '116'
+  INVALID_PAGE_OBJECT = '117'
+  INVALID_PAGE_VALUE = '118'
+  INVALID_FIELD_FORMAT = '119'
+  INVALID_FILTERS_SYNTAX = '120'
+  SAVE_FAILED = '121'
+  FORBIDDEN = '403'
+  RECORD_NOT_FOUND = '404'
+  UNSUPPORTED_MEDIA_TYPE = '415'
+  LOCKED = '423'
+  INTERNAL_SERVER_ERROR = '500'
 
   TEXT_ERRORS =
     { VALIDATION_ERROR => 'VALIDATION_ERROR',

data/lib/jsonapi/exceptions.rb

@@ -18,8 +18,10 @@ module JSONAPI
 
         [JSONAPI::Error.new(code: JSONAPI::INTERNAL_SERVER_ERROR,
                             status: :internal_server_error,
-                            title: 'Internal Server Error',
-                            detail: 'Internal Server Error',
+                            title: I18n.t('jsonapi-resources.exceptions.internal_server_error.title', 
+                                          default: 'Internal Server Error'),
+                            detail: I18n.t('jsonapi-resources.exceptions.internal_server_error.detail', 
+                                           default: 'Internal Server Error'),
                             meta: meta)]
       end
     end
@@ -33,8 +35,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_RESOURCE,
                             status: :bad_request,
-                            title: 'Invalid resource',
-                            detail: "#{resource} is not a valid resource.")]
+                            title: I18n.t('jsonapi-resources.exceptions.invalid_resource.title', 
+                                          default: 'Invalid resource'),
+                            detail: I18n.t('jsonapi-resources.exceptions.invalid_resource.detail', 
+                                           default: "#{resource} is not a valid resource.", resource: resource))]
       end
     end
 
@@ -47,8 +51,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::RECORD_NOT_FOUND,
                             status: :not_found,
-                            title: 'Record not found',
-                            detail: "The record identified by #{id} could not be found.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.record_not_found.title', 
+                                                  default: 'Record not found'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.record_not_found.detail', 
+                                                   default: "The record identified by #{id} could not be found.", id: id))]
       end
     end
 
@@ -61,8 +67,12 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::UNSUPPORTED_MEDIA_TYPE,
                             status: :unsupported_media_type,
-                            title: 'Unsupported media type',
-                            detail: "All requests that create or update resources must use the '#{JSONAPI::MEDIA_TYPE}' Content-Type. This request specified '#{media_type}.'")]
+                            title: I18n.translate('jsonapi-resources.exceptions.unsupported_media_type.title', 
+                                                  default: 'Unsupported media type'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.unsupported_media_type.detail',
+                                                   default: "All requests that create or update must use the '#{JSONAPI::MEDIA_TYPE}' Content-Type. This request specified '#{media_type}'.",
+                                                   needed_media_type: JSONAPI::MEDIA_TYPE,
+                                                   media_type: media_type))]
       end
     end
 
@@ -75,8 +85,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::RELATION_EXISTS,
                             status: :bad_request,
-                            title: 'Relation exists',
-                            detail: "The relation to #{id} already exists.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.has_many_relation.title', 
+                                                  default: 'Relation exists'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.has_many_relation.detail',
+                                                   default: "The relation to #{id} already exists.",
+                                                   id: id))]
       end
     end
 
@@ -84,8 +97,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::FORBIDDEN,
                             status: :forbidden,
-                            title: 'Complete replacement forbidden',
-                            detail: 'Complete replacement forbidden for this relationship')]
+                            title: I18n.translate('jsonapi-resources.exceptions.to_many_set_replacement_forbidden.title', 
+                                                  default: 'Complete replacement forbidden'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.to_many_set_replacement_forbidden.detail',
+                                                   default: 'Complete replacement forbidden for this relationship'))]
       end
     end
 
@@ -98,8 +113,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FILTERS_SYNTAX,
                             status: :bad_request,
-                            title: 'Invalid filters syntax',
-                            detail: "#{filters} is not a valid syntax for filtering.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_filter_syntax.title',
+                                                  default: 'Invalid filters syntax'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_filter_syntax.detail',
+                                                   default: "#{filters} is not a valid syntax for filtering.",
+                                                   filters: filters))]
       end
     end
 
@@ -112,8 +130,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::FILTER_NOT_ALLOWED,
                             status: :bad_request,
-                            title: 'Filter not allowed',
-                            detail: "#{filter} is not allowed.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.filter_not_allowed.title',
+                                                  default: 'Filter not allowed'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.filter_not_allowed.detail',
+                                                   default: "#{filter} is not allowed.", filter: filter))]
       end
     end
 
@@ -127,8 +147,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FILTER_VALUE,
                             status: :bad_request,
-                            title: 'Invalid filter value',
-                            detail: "#{value} is not a valid value for #{filter}.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_filter_value.title',
+                                                  default: 'Invalid filter value'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_filter_value.detail',
+                                                   default: "#{value} is not a valid value for #{filter}.",
+                                                   value: value, filter: filter))]
       end
     end
 
@@ -142,8 +165,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FIELD_VALUE,
                             status: :bad_request,
-                            title: 'Invalid field value',
-                            detail: "#{value} is not a valid value for #{field}.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_field_value.title',
+                                                  default: 'Invalid field value'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_field_value.detail',
+                                                   default: "#{value} is not a valid value for #{field}.",
+                                                   value: value, field: field))]
       end
     end
 
@@ -151,8 +177,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FIELD_FORMAT,
                             status: :bad_request,
-                            title: 'Invalid field format',
-                            detail: 'Fields must specify a type.')]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_field_format.title',
+                                                  default: 'Invalid field format'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_field_format.detail',
+                                                   default: 'Fields must specify a type.'))]
       end
     end
 
@@ -160,8 +188,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_LINKS_OBJECT,
                             status: :bad_request,
-                            title: 'Invalid Links Object',
-                            detail: 'Data is not a valid Links Object.')]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_links_object.title',
+                                                  default: 'Invalid Links Object'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_links_object.detail',
+                                                   default: 'Data is not a valid Links Object.'))]
       end
     end
 
@@ -174,8 +204,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::TYPE_MISMATCH,
                             status: :bad_request,
-                            title: 'Type Mismatch',
-                            detail: "#{type} is not a valid type for this operation.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.type_mismatch.title',
+                                                  default: 'Type Mismatch'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.type_mismatch.detail',
+                                                   default: "#{type} is not a valid type for this operation.", type: type))]
       end
     end
 
@@ -189,8 +221,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FIELD,
                             status: :bad_request,
-                            title: 'Invalid field',
-                            detail: "#{field} is not a valid field for #{type}.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_field.title',
+                                                  default: 'Invalid field'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_field.detail',
+                                                   default: "#{field} is not a valid field for #{type}.",
+                                                   field: field, type: type))]
       end
     end
 
@@ -204,8 +239,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_INCLUDE,
                             status: :bad_request,
-                            title: 'Invalid field',
-                            detail: "#{relationship} is not a valid relationship of #{resource}")]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_include.title',
+                                                  default: 'Invalid field'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_include.detail',
+                                                   default: "#{relationship} is not a valid relationship of #{resource}",
+                                                   relationship: relationship, resource: resource))]
       end
     end
 
@@ -219,8 +257,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_SORT_CRITERIA,
                             status: :bad_request,
-                            title: 'Invalid sort criteria',
-                            detail: "#{sort_criteria} is not a valid sort criteria for #{resource}")]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_sort_criteria.title',
+                                                  default: 'Invalid sort criteria'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_sort_criteria.detail',
+                                                   default: "#{sort_criteria} is not a valid sort criteria for #{resource}",
+                                                   sort_criteria: sort_criteria, resource: resource))]
       end
     end
 
@@ -234,8 +275,11 @@ module JSONAPI
         params.collect do |param|
           JSONAPI::Error.new(code: JSONAPI::PARAM_NOT_ALLOWED,
                              status: :bad_request,
-                             title: 'Param not allowed',
-                             detail: "#{param} is not allowed.")
+                             title: I18n.translate('jsonapi-resources.exceptions.parameters_not_allowed.title',
+                                                   default: 'Param not allowed'),
+                             detail: I18n.translate('jsonapi-resources.exceptions.parameters_not_allowed.detail',
+                                                    default: "#{param} is not allowed.", param: param))
+
         end
       end
     end
@@ -249,8 +293,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::PARAM_MISSING,
                             status: :bad_request,
-                            title: 'Missing Parameter',
-                            detail: "The required parameter, #{param}, is missing.")]
+                            title: I18n.translate('jsonapi-resources.exceptions.parameter_missing.title',
+                                                  default: 'Missing Parameter'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.parameter_missing.detail',
+                                                   default: "The required parameter, #{param}, is missing.", param: param))]
       end
     end
 
@@ -258,8 +304,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::COUNT_MISMATCH,
                             status: :bad_request,
-                            title: 'Count to key mismatch',
-                            detail: 'The resource collection does not contain the same number of objects as the number of keys.')]
+                            title: I18n.translate('jsonapi-resources.exceptions.count_mismatch.title',
+                                                  default: 'Count to key mismatch'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.count_mismatch.detail',
+                                                   default: 'The resource collection does not contain the same number of objects as the number of keys.'))]
       end
     end
 
@@ -272,8 +320,11 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::KEY_NOT_INCLUDED_IN_URL,
                             status: :bad_request,
-                            title: 'Key is not included in URL',
-                            detail: "The URL does not support the key #{key}")]
+                            title: I18n.translate('jsonapi-resources.exceptions.key_not_included_in_url.title',
+                                                  default: 'Key is not included in URL'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.key_not_included_in_url.detail',
+                                                   default: "The URL does not support the key #{key}",
+                                                   key: key))]
       end
     end
 
@@ -281,8 +332,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::KEY_ORDER_MISMATCH,
                             status: :bad_request,
-                            title: 'A key is required',
-                            detail: 'The resource object does not contain a key.')]
+                            title: I18n.translate('jsonapi-resources.exceptions.missing_key.title',
+                                                  default: 'A key is required'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.missing_key.detail',
+                                                   default: 'The resource object does not contain a key.'))]
       end
     end
 
@@ -295,16 +348,18 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::LOCKED,
                             status: :locked,
-                            title: 'Locked resource',
+                            title: I18n.translate('jsonapi-resources.exceptions.record_locked.title',
+                                                  default: 'Locked resource'),
                             detail: "#{message}")]
       end
     end
 
     class ValidationErrors < Error
-      attr_reader :error_messages, :resource_relationships
+      attr_reader :error_messages, :error_metadata, :resource_relationships
 
       def initialize(resource)
         @error_messages = resource.model_error_messages
+        @error_metadata = resource.validation_error_metadata
         @resource_relationships = resource.class._relationships.keys
         @key_formatter = JSONAPI.configuration.key_formatter
       end
@@ -326,7 +381,13 @@ module JSONAPI
                            status: :unprocessable_entity,
                            title: message,
                            detail: "#{format_key(attr_key)} - #{message}",
-                           source: { pointer: pointer(attr_key) })
+                           source: { pointer: pointer(attr_key) },
+                           meta: metadata_for(attr_key, message))
+      end
+
+      def metadata_for(attr_key, message)
+        return if error_metadata.nil?
+        error_metadata[attr_key] ?  error_metadata[attr_key][message] : nil
       end
 
       def pointer(attr_or_relationship_name)
@@ -343,8 +404,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::SAVE_FAILED,
                             status: :unprocessable_entity,
-                            title: 'Save failed or was cancelled',
-                            detail: 'Save failed or was cancelled')]
+                            title: I18n.translate('jsonapi-resources.exceptions.save_failed.title',
+                                                  default: 'Save failed or was cancelled'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.save_failed.detail',
+                                                   default: 'Save failed or was cancelled'))]
       end
     end
 
@@ -352,8 +415,10 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_PAGE_OBJECT,
                             status: :bad_request,
-                            title: 'Invalid Page Object',
-                            detail: 'Invalid Page Object.')]
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_page_object.title',
+                                                  default: 'Invalid Page Object'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_page_object.detail',
+                                                   default: 'Invalid Page Object.'))]
       end
     end
 
@@ -367,8 +432,11 @@ module JSONAPI
         params.collect do |param|
           JSONAPI::Error.new(code: JSONAPI::PARAM_NOT_ALLOWED,
                              status: :bad_request,
-                             title: 'Page parameter not allowed',
-                             detail: "#{param} is not an allowed page parameter.")
+                             title: I18n.translate('jsonapi-resources.exceptions.page_parameters_not_allowed.title',
+                                                   default: 'Page parameter not allowed'),
+                             detail: I18n.translate('jsonapi-resources.exceptions.page_parameters_not_allowed.detail',
+                                                    default: "#{param} is not an allowed page parameter.",
+                                                    param: param))
         end
       end
     end
@@ -378,13 +446,16 @@ module JSONAPI
       def initialize(page, value, msg = nil)
         @page = page
         @value = value
-        @msg = msg || "#{value} is not a valid value for #{page} page parameter."
+        @msg = msg || I18n.translate('jsonapi-resources.exceptions.invalid_page_value.detail',
+                                     default: "#{value} is not a valid value for #{page} page parameter.",
+                                     value: value, page: page)
       end
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_PAGE_VALUE,
                             status: :bad_request,
-                            title: 'Invalid page value',
+                            title: I18n.translate('jsonapi-resources.exceptions.invalid_page_value.title',
+                                                  default: 'Invalid page value'),
                             detail: @msg)]
       end
     end