Merge pull request #164 from dennisfaust/text-error-codes

Text error codes

Author: lgebhardt

lib/jsonapi/configuration.rb

@@ -9,7 +9,8 @@ class Configuration
                 :allowed_request_params,
                 :default_paginator,
                 :default_page_size,
-                :maximum_page_size
+                :maximum_page_size,
+                :use_text_errors
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -25,6 +26,7 @@ def initialize
 
       self.default_page_size = 10
       self.maximum_page_size = 20
+      self.use_text_errors = false
     end
 
     def json_key_format=(format)
@@ -52,6 +54,10 @@ def default_page_size=(default_page_size)
     def maximum_page_size=(maximum_page_size)
       @maximum_page_size = maximum_page_size
     end
+
+    def use_text_errors=(use_text_errors)
+      @use_text_errors = use_text_errors
+    end
   end
 
   class << self

lib/jsonapi/error.rb

@@ -8,10 +8,14 @@ def initialize(options={})
       @detail         = options[:detail]
       @id             = options[:id]
       @href           = options[:href]
-      @code           = options[:code]
+      @code           = if JSONAPI.configuration.use_text_errors
+                          TEXT_ERRORS[options[:code]]
+                        else
+                          options[:code]
+                        end
       @path           = options[:path]
       @links          = options[:links]
       @status         = options[:status]
     end
   end
-end
+end

lib/jsonapi/error_codes.rb

@@ -23,4 +23,30 @@ module JSONAPI
   RECORD_NOT_FOUND = 404
   UNSUPPORTED_MEDIA_TYPE = 415
   LOCKED = 423
+
+  TEXT_ERRORS =
+    { VALIDATION_ERROR => 'VALIDATION_ERROR',
+      INVALID_RESOURCE => 'INVALID_RESOURCE',
+      FILTER_NOT_ALLOWED => 'FILTER_NOT_ALLOWED',
+      INVALID_FIELD_VALUE => 'INVALID_FIELD_VALUE',
+      INVALID_FIELD => 'INVALID_FIELD',
+      PARAM_NOT_ALLOWED => 'PARAM_NOT_ALLOWED',
+      PARAM_MISSING => 'PARAM_MISSING',
+      INVALID_FILTER_VALUE => 'INVALID_FILTER_VALUE',
+      COUNT_MISMATCH => 'COUNT_MISMATCH',
+      KEY_ORDER_MISMATCH => 'KEY_ORDER_MISMATCH',
+      KEY_NOT_INCLUDED_IN_URL => 'KEY_NOT_INCLUDED_IN_URL',
+      INVALID_INCLUDE => 'INVALID_INCLUDE',
+      RELATION_EXISTS => 'RELATION_EXISTS',
+      INVALID_SORT_CRITERIA => 'INVALID_SORT_CRITERIA',
+      INVALID_LINKS_OBJECT => 'INVALID_LINKS_OBJECT',
+      TYPE_MISMATCH => 'TYPE_MISMATCH',
+      INVALID_PAGE_OBJECT => 'INVALID_PAGE_OBJECT',
+      INVALID_PAGE_VALUE => 'INVALID_PAGE_VALUE',
+      INVALID_SORT_FORMAT => 'INVALID_SORT_FORMAT',
+      INVALID_FIELD_FORMAT => 'INVALID_FIELD_FORMAT',
+      FORBIDDEN => 'FORBIDDEN',
+      RECORD_NOT_FOUND => 'RECORD_NOT_FOUND',
+      UNSUPPORTED_MEDIA_TYPE => 'UNSUPPORTED_MEDIA_TYPE',
+      LOCKED => 'LOCKED' }
 end

test/controllers/controller_test.rb

@@ -4,6 +4,10 @@ def set_content_type_header!
   @request.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
 end
 
+class ConfigControllerTest < ActionController::TestCase
+
+end
+
 class PostsControllerTest < ActionController::TestCase
   def test_index
     get :index
@@ -1388,6 +1392,14 @@ def setup
     JSONAPI.configuration.json_key_format = :camelized_key
   end
 
+  def test_text_error
+    JSONAPI.configuration.use_text_errors = true
+    get :index, {sort: 'not_in_record'}
+    assert_response 400
+    assert_equal 'INVALID_SORT_FORMAT', json_response['errors'][0]['code']
+    JSONAPI.configuration.use_text_errors = false
+  end
+
   def test_expense_entries_index
     get :index
     assert_response :success