Merge pull request rails#4 from jmbejar/rails-api

Rails api - Wrap parameters

Author: spastorino

actionpack/lib/action_controller/api.rb

@@ -128,7 +128,11 @@ def self.without_modules(*modules)
 
       # Add instrumentations hooks at the bottom, to ensure they instrument
       # all the methods properly.
-      Instrumentation
+      Instrumentation,
+
+      # Params wrapper should come before instrumentation so they are
+      # properly showed in logs
+      ParamsWrapper
     ]
 
     MODULES.each do |mod|

actionpack/test/controller/api/params_wrapper_test.rb

@@ -0,0 +1,26 @@
+require 'abstract_unit'
+
+class ParamsWrapperForApiTest < ActionController::TestCase
+  class UsersController < ActionController::API
+    attr_accessor :last_parameters
+
+    wrap_parameters :person, format: [:json]
+
+    def test
+      self.last_parameters = params.except(:controller, :action)
+      head :ok
+    end
+  end
+
+  class Person; end
+
+  tests UsersController
+
+  def test_specify_wrapper_name
+    @request.env['CONTENT_TYPE'] = 'application/json'
+    post :test, params: { 'username' => 'sikachu' }
+
+    expected = { 'username' => 'sikachu', 'person' => { 'username' => 'sikachu' }}
+    assert_equal expected, @controller.last_parameters
+  end
+end

railties/lib/rails/generators/rails/app/templates/config/initializers/wrap_parameters.rb.tt

@@ -1,14 +1,12 @@
 # Be sure to restart your server when you modify this file.
 
-<%- unless options[:api] -%>
 # This file contains settings for ActionController::ParamsWrapper which
 # is enabled by default.
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+  wrap_parameters format: [:json]
 end
-<%- end -%>
 <%- unless options.skip_active_record? -%>
 
 # To enable root element in JSON for ActiveRecord objects.

railties/test/generators/api_app_generator_test.rb

@@ -47,9 +47,7 @@ def test_api_modified_files
 
     assert_file "config/initializers/cors.rb"
 
-    assert_file "config/initializers/wrap_parameters.rb" do |content|
-      assert_no_match(/wrap_parameters/, content)
-    end
+    assert_file "config/initializers/wrap_parameters.rb"
 
     assert_file "app/controllers/application_controller.rb", /ActionController::API/
   end