Changeset 3777

Timestamp:

03/05/06 18:59:58 (3 years ago)

Author:

xal

Message:

Added new infrastructure support for REST webservices.

By default application/xml posts are handled by creating a XmlNode object with the same name as the root element of the submitted xml. M$

ActionController::Base.param_parsersapplication/atom+xml? = Proc.new do |data|

node = REXML::Document.new(post)

{ node.root.name => node.root }

end

XmlSimple and Yaml web services were retired, ActionController::Base.param_parsers carries an example which shows how to get this functio$
request.[formatted_post?, xml_post?, yaml_post? and post_format] were all deprecated in favor of request.content_type [Tobias Luetke]

Closes #4081

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/base.rb (modified) (2 diffs)
• trunk/actionpack/lib/action_controller/cgi_ext/cgi_methods.rb (modified) (2 diffs)
• trunk/actionpack/lib/action_controller/cgi_process.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/deprecated_request_methods.rb (added)
• trunk/actionpack/lib/action_controller/request.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/vendor/xml_node.rb (added)
• trunk/actionpack/test/abstract_unit.rb (modified) (2 diffs)
• trunk/actionpack/test/controller/webservice_test.rb (added)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
-
+* Added new infrastructure support for REST webservices. 
+  By default application/xml posts are handled by creating a XmlNode object with the same name as the root element of the submitted xml. More handlers can easily be registered like this
+
+ ActionController::Base.param_parsers['application/atom+xml'] = Proc.new do |data| 
+    node = REXML::Document.new(post) 
+   { node.root.name => node.root }
+ end
+ 
+ XmlSimple and Yaml web services were retired, ActionController::Base.param_parsers carries an example which shows how to get this functionality back. 
+ request.[formatted_post?, xml_post?, yaml_post? and post_format] were all deprecated in favor of request.content_type [Tobias Luetke]
+ 
-* Fixed Effect.Appear in effects.js to work with floats in Safari #3524, #3813, #3044 [Thomas Fuchs]
-

trunk/actionpack/lib/action_controller.rb

@@ -37 +37 @@
-require 'action_controller/base'
-require 'action_controller/deprecated_redirects'
+require 'action_controller/request'
+require 'action_controller/deprecated_request_methods'
-require 'action_controller/rescue'
-require 'action_controller/benchmarking'

trunk/actionpack/lib/action_controller/base.rb

@@ -261 +261 @@
-    cattr_accessor :allow_concurrency
-
+    # Modern REST web services often need to submit complex data to the web application. 
+    # the param_parsers hash lets you register handlers wich will process the http body and add parameters to the 
+    # @params hash. These handlers are invoked for post and put requests.
+    #
+    # By default application/xml is enabled. a XmlNode class with the same param name as the root 
+    # will be instanciated in the @params. 
+    # 
+    # Example:
+    #
+    #   ActionController::Base.param_parsers['application/atom+xml'] = Proc.new do |data| 
+    #      node = REXML::Document.new(post) 
+    #     { node.root.name => node.root }
+    #   end
+    #
+    # Note: Up until release 1.1 rails would default to using XmlSimple for such requests. To get the old 
+    # behavior you can re-register XmlSimple as application/xml handler and enable application/x-yaml like 
+    # this:
+    #
+    #   ActionController::Base.param_parsers['application/xml'] = Proc.new do |data| 
+    #     XmlSimple.xml_in(data, 'ForceArray' => false)
+    #   end
+    #
+    #   ActionController::Base.param_parsers['application/x-yaml'] = Proc.new do |data| 
+    #     |post| YAML.load(post)
+    #   end
+    #
+    @@param_parsers = {
+      'application/xml'     => Proc.new { |post| node = XmlNode.from_xml(post); { node.node_name => node } },
+    }
+    cattr_accessor :param_parsers 
+
-    # Template root determines the base from which template references will be made. So a call to render("test/template")
-    # will be converted to "#{template_root}/test/template.rhtml".
-    class_inheritable_accessor :template_root
-
+
-    # The logger is used for generating information on the action run-time (including benchmarking) if available.
-    # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
@@ -303 +334 @@
-    # Returns the name of the action this controller is processing.
-    attr_accessor :action_name
-
+
-    class << self
-      # Factory for the standard create, process loop where the controller is discarded after processing.

trunk/actionpack/lib/action_controller/cgi_ext/cgi_methods.rb

@@ -1 +1 @@
-require 'cgi'
-require 'action_controller/vendor/xml_simple'
+require 'action_controller/vendor/xml_node'
-
-# Static methods for parsing the query and request parameters that can be used in
@@ -59 +60 @@
-
-    def self.parse_formatted_request_parameters(format, raw_post_data)
-
-
-
-
-
-
+
-    rescue Object => e
-      { "exception" => "#{e.message} (#{e.class})", "backtrace" => e.backtrace, 

trunk/actionpack/lib/action_controller/cgi_process.rb

@@ -65 +65 @@
-
-    def request_parameters
-formatted_post?
-post_format
+ActionController::Base.param_parsers.has_key?(content_type)
+content_type
-      else
-        CGIMethods.parse_request_parameters(@cgi.params)

trunk/actionpack/lib/action_controller/request.rb

@@ -43 +43 @@
-    end
-
-
-
-
-
-
-
-
-
-
+
+
-    #
-    # For backward compatibility, the post format is extracted from the
-    # X-Post-Data-Format HTTP header if present.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    end
-

trunk/actionpack/test/abstract_unit.rb

@@ -3 +3 @@
-$:.unshift(File.dirname(__FILE__) + '/fixtures/helpers')
-
+require 'yaml'
-require 'test/unit'
-require 'action_controller'
@@ -12 +13 @@
-ActionController::Base.ignore_missing_templates = false
-ActionController::Routing::Routes.reload rescue nil
-