restrack 1.2.2 → 1.2.3

data/lib/restrack/resource_controller.rb

@@ -39,8 +39,21 @@ module RESTRack
     # all internal methods are protected rather than private so that calling methods *could* be overriden if necessary.
     protected
 
+    # If called with an array of strings this will return a datastructure which will
+    # automatically be converted by RESTRack into the error format expected by ActiveResource.
+    # ActiveResource expects attribute input errors to be responded to with a status
+    # code of 422, which is a non-standard HTTP code.  Use this to produce the required
+    # format of "<errors><error>...</error><error>...</error></errors>" for the response XML.
+    # This method also will accept any simple data structure when not worried about AR integration.
+    def package_errors(errors)
+      if errors.is_a? Array and errors.count{|e| e.is_a? String} === errors.length
+        # I am AR bound
+        errors = ARFormattedError.new(errors)
+      end
+      @output = @resource_request.package(errors)[0] # TODO: Remove this if change line 97 in resource_request.rb
+    end
     def package_error(error)
-      @output = @resource_request.package(error)[0] # TODO: Remove this if change line 97 in resource_request.rb
+      package_errors(error)
     end
 
     # This method allows one to access a related resource, without providing a direct link to specific relation(s).

data/lib/restrack/support.rb

@@ -59,6 +59,17 @@ class Object
   end
 end
 
+class ARFormattedError < Array
+  # provide this method, as if it is present it will be used to render the xml rather than XmlSimple
+  def to_xml
+    str = '<?xml version="1.0" encoding="UTF-8"?><errors>'
+    self.each do |error|
+      str << "<error>#{error}</error>"
+    end
+    str << "</errors>"
+  end
+end
+
 # We will support ".text" as an extension
 MIME::Types['text/plain'][0].extensions << 'text'
 MIME::Types.index_extensions( MIME::Types['text/plain'][0] )

data/lib/restrack/version.rb

@@ -1,3 +1,3 @@
 module RESTRack
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

data/test/sample_app_1/controllers/errors_controller.rb

@@ -43,6 +43,10 @@ class SampleApp::ErrorsController < RESTRack::ResourceController
     raise HTTP422ResourceInvalid, package_error({:message => 'This is a WebDAV HTTP extension code used by ActiveResource to communicate validation errors, rather than 400.'})
   end
 
+  def resource_invalid_active_resource_format
+    raise HTTP422ResourceInvalid, package_errors(['This is how ActiveResource expects errors to come through.','It has support for multiple errors.'])
+  end
+
   def server_error
     raise HTTP500ServerError, package_error('tester')
   end

data/test/sample_app_1/test/test_errors.rb

@@ -119,6 +119,31 @@ class SampleApp::TestControllerActions < Test::Unit::TestCase
     assert JSON.parse(output[2][0]).has_key?('message')
   end
 
+  def test_resource_invalid_active_record_format
+    response_code = 422
+    env = Rack::MockRequest.env_for('/errors/resource_invalid_active_resource_format.xml', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal response_code, output[0]
+    assert_equal '<?xml version="1.0" encoding="UTF-8"?><errors><error>This is how ActiveResource expects errors to come through.</error><error>It has support for multiple errors.</error></errors>', output[2][0]
+
+    response_code = 422
+    env = Rack::MockRequest.env_for('/errors/resource_invalid_active_resource_format', {
+      :method => 'GET'
+    })
+    output = ''
+    assert_nothing_raised do
+      output = @ws.call(env)
+    end
+    assert_equal response_code, output[0]
+    assert_equal 'This is how ActiveResource expects errors to come through.', JSON.parse(output[2][0])[0]
+    assert_equal 'It has support for multiple errors.', JSON.parse(output[2][0])[1]
+  end
+
   def test_server_error
     response_code = 500
     # This will/should spam the log

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restrack
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-07 00:00:00.000000000Z
+date: 2011-10-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &7009360 !ruby/object:Gem::Requirement
+  requirement: &10448680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7009360
+  version_requirements: *10448680
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &7008920 !ruby/object:Gem::Requirement
+  requirement: &10447720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7008920
+  version_requirements: *10447720
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &7008420 !ruby/object:Gem::Requirement
+  requirement: &10446540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7008420
+  version_requirements: *10446540
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &7007960 !ruby/object:Gem::Requirement
+  requirement: &10445940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7007960
+  version_requirements: *10445940
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &7007360 !ruby/object:Gem::Requirement
+  requirement: &10445300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.13
   type: :runtime
   prerelease: false
-  version_requirements: *7007360
+  version_requirements: *10445300
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &7006900 !ruby/object:Gem::Requirement
+  requirement: &10444560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7006900
+  version_requirements: *10444560
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &7006240 !ruby/object:Gem::Requirement
+  requirement: &10439600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7006240
+  version_requirements: *10439600
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &7005740 !ruby/object:Gem::Requirement
+  requirement: &10438800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7005740
+  version_requirements: *10438800
 description: ! "\nRESTRack is a Rack-based MVC framework that makes it extremely easy
   to develop RESTful data services. It is inspired by\nRails, and follows a few of
   its conventions.  But it has no routes file, routing relationships are done through\nsupplying