Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add support for errors in JSON format.

[#1956 state:committed]

Signed-off-by: Jeremy Kemper <jeremy@bitsweat.net>
  • Loading branch information...
commit c3da22c042d083b788fd35ce7a25e3d8933bcae6 1 parent 9341655
Fabien Jakimowicz jakimowicz authored jeremy committed
2  activeresource/CHANGELOG
View
@@ -1,5 +1,7 @@
*2.3.4 (pending)*
+* Add support for errors in JSON format. #1956 [Fabien Jakimowicz]
+
* Recognizes 410 as Resource Gone. #2316 [Jordan Brough, Jatinder Singh]
* More thorough SSL support. #2370 [Roy Nicholson]
6 activeresource/lib/active_resource/base.rb
View
@@ -174,7 +174,7 @@ module ActiveResource
#
# Active Resource supports validations on resources and will return errors if any these validations fail
# (e.g., "First name can not be blank" and so on). These types of errors are denoted in the response by
- # a response code of <tt>422</tt> and an XML representation of the validation errors. The save operation will
+ # a response code of <tt>422</tt> and an XML or JSON representation of the validation errors. The save operation will
# then fail (with a <tt>false</tt> return value) and the validation errors can be accessed on the resource in question.
#
# ryan = Person.find(1)
@@ -183,10 +183,14 @@ module ActiveResource
#
# # When
# # PUT http://api.people.com:3000/people/1.xml
+ # # or
+ # # PUT http://api.people.com:3000/people/1.json
# # is requested with invalid values, the response is:
# #
# # Response (422):
# # <errors type="array"><error>First cannot be empty</error></errors>
+ # # or
+ # # {"errors":["First cannot be empty"]}
# #
#
# ryan.errors.invalid?(:first) # => true
24 activeresource/lib/active_resource/validations.rb
View
@@ -199,11 +199,10 @@ def size
alias_method :count, :size
alias_method :length, :size
- # Grabs errors from the XML response.
- def from_xml(xml)
+ # Grabs errors from an array of messages (like ActiveRecord::Validations)
+ def from_array(messages)
clear
humanized_attributes = @base.attributes.keys.inject({}) { |h, attr_name| h.update(attr_name.humanize => attr_name) }
- messages = Array.wrap(Hash.from_xml(xml)['errors']['error']) rescue []
messages.each do |message|
attr_message = humanized_attributes.keys.detect do |attr_name|
if message[0, attr_name.size + 1] == "#{attr_name} "
@@ -214,6 +213,18 @@ def from_xml(xml)
add_to_base message if attr_message.nil?
end
end
+
+ # Grabs errors from the json response.
+ def from_json(json)
+ array = ActiveSupport::JSON.decode(json)['errors'] rescue []
+ from_array array
+ end
+
+ # Grabs errors from the XML response.
+ def from_xml(xml)
+ array = Array.wrap(Hash.from_xml(xml)['errors']['error']) rescue []
+ from_array array
+ end
end
# Module to support validation and errors with Active Resource objects. The module overrides
@@ -248,7 +259,12 @@ def save_with_validation
save_without_validation
true
rescue ResourceInvalid => error
- errors.from_xml(error.response.body)
+ case error.response['Content-Type']
+ when 'application/xml'
+ errors.from_xml(error.response.body)
+ when 'application/json'
+ errors.from_json(error.response.body)
+ end
false
end
75 activeresource/test/base_errors_test.rb
View
@@ -4,45 +4,82 @@
class BaseErrorsTest < Test::Unit::TestCase
def setup
ActiveResource::HttpMock.respond_to do |mock|
- mock.post "/people.xml", {}, "<?xml version=\"1.0\" encoding=\"UTF-8\"?><errors><error>Age can't be blank</error><error>Name can't be blank</error><error>Name must start with a letter</error><error>Person quota full for today.</error></errors>", 422
+ mock.post "/people.xml", {}, %q(<?xml version="1.0" encoding="UTF-8"?><errors><error>Age can't be blank</error><error>Name can't be blank</error><error>Name must start with a letter</error><error>Person quota full for today.</error></errors>), 422, {'Content-Type' => 'application/xml'}
+ mock.post "/people.json", {}, %q({"errors":["Age can't be blank","Name can't be blank","Name must start with a letter","Person quota full for today."]}), 422, {'Content-Type' => 'application/json'}
end
@person = Person.new(:name => '', :age => '')
assert_equal @person.save, false
end
def test_should_mark_as_invalid
- assert !@person.valid?
+ [ :json, :xml ].each do |format|
+ invalid_user_using_format(format) do
+ assert !@person.valid?
+ end
+ end
end
def test_should_parse_xml_errors
- assert_kind_of ActiveResource::Errors, @person.errors
- assert_equal 4, @person.errors.size
+ [ :json, :xml ].each do |format|
+ invalid_user_using_format(format) do
+ assert_kind_of ActiveResource::Errors, @person.errors
+ assert_equal 4, @person.errors.size
+ end
+ end
end
def test_should_parse_errors_to_individual_attributes
- assert @person.errors.invalid?(:name)
- assert_equal "can't be blank", @person.errors.on(:age)
- assert_equal ["can't be blank", "must start with a letter"], @person.errors[:name]
- assert_equal "Person quota full for today.", @person.errors.on_base
+ [ :json, :xml ].each do |format|
+ invalid_user_using_format(format) do
+ assert @person.errors[:name].any?
+ assert_equal "can't be blank", @person.errors[:age]
+ assert_equal ["can't be blank", "must start with a letter"], @person.errors[:name]
+ assert_equal "Person quota full for today.", @person.errors[:base]
+ end
+ end
end
def test_should_iterate_over_errors
- errors = []
- @person.errors.each { |attribute, message| errors << [attribute, message] }
- assert errors.include?(["name", "can't be blank"])
+ [ :json, :xml ].each do |format|
+ invalid_user_using_format(format) do
+ errors = []
+ @person.errors.each { |attribute, message| errors << [attribute, message] }
+ assert errors.include?(['name', "can't be blank"])
+ end
+ end
end
def test_should_iterate_over_full_errors
- errors = []
- @person.errors.each_full { |message| errors << message }
- assert errors.include?("Name can't be blank")
+ [ :json, :xml ].each do |format|
+ invalid_user_using_format(format) do
+ errors = []
+ @person.errors.to_a.each { |message| errors << message }
+ assert errors.include?(["name", "can't be blank"])
+ end
+ end
end
def test_should_format_full_errors
- full = @person.errors.full_messages
- assert full.include?("Age can't be blank")
- assert full.include?("Name can't be blank")
- assert full.include?("Name must start with a letter")
- assert full.include?("Person quota full for today.")
+ [ :json, :xml ].each do |format|
+ invalid_user_using_format(format) do
+ full = @person.errors.full_messages
+ assert full.include?("Age can't be blank")
+ assert full.include?("Name can't be blank")
+ assert full.include?("Name must start with a letter")
+ assert full.include?("Person quota full for today.")
+ end
+ end
+ end
+
+ private
+ def invalid_user_using_format(mime_type_reference)
+ previous_format = Person.format
+ Person.format = mime_type_reference
+ @person = Person.new(:name => '', :age => '')
+ assert_equal false, @person.save
+
+ yield
+ ensure
+ Person.format = previous_format
end
end
Please sign in to comment.
Something went wrong with that request. Please try again.