Module: Merb::Test::RequestHelper
- Included in:
- ControllerHelper, RouteHelper
- Defined in:
- lib/merb-core/test/helpers/request_helper.rb
Defined Under Namespace
Classes: CookieJar, FakeRequest
Instance Method Summary collapse
-
#build_request(params = {}, env = {}) ⇒ Object
Prepares and returns a request suitable for dispatching with dispatch_request.
-
#check_request_for_route(request) ⇒ Object
Checks to see that a request is routable.
-
#delete(path, params = {}, env = {}, &block) ⇒ Object
An HTTP DELETE request that operates through the router.
-
#dispatch_request(request, controller_klass, action) {|controller| ... } ⇒ Object
The workhorse for the dispatch*to helpers.
-
#dispatch_to(controller_klass, action, params = {}, env = {}, &blk) ⇒ Object
Dispatches an action to the given class.
-
#dispatch_with_basic_authentication_to(controller_klass, action, username, password, params = {}, env = {}, &blk) ⇒ Object
Dispatches an action to the given class and using HTTP Basic Authentication This bypasses the router and is suitable for unit testing of controllers.
-
#fake_request(env = {}, opt = {}) ⇒ Object
Parameters env<Hash>:: A hash of environment keys to be merged into the default list.
-
#get(path, params = {}, env = {}, &block) ⇒ Object
An HTTP GET request that operates through the router.
- #merge_controller_and_action(controller_klass, action, params) ⇒ Object
-
#post(path, params = {}, env = {}, &block) ⇒ Object
An HTTP POST request that operates through the router.
-
#put(path, params = {}, env = {}, &block) ⇒ Object
An HTTP PUT request that operates through the router.
-
#request(path, params = {}, env = {}, &block) ⇒ Object
A generic request that checks the router for the controller and action.
-
#with_cookies(*controller_classes, &blk) ⇒ Object
Keep track of cookie values in CookieJar within the context of the block; you need to set this up for secific controllers.
Instance Method Details
#build_request(params = {}, env = {}) ⇒ Object
Prepares and returns a request suitable for dispatching with dispatch_request. If you don’t need to modify the request object before dispatching (e.g. to add cookies), you probably want to use dispatch_to instead.
Parameters
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see
fake_request
), including :req or :post_body for setting the request body itself.
Example
req = build_request(:id => 1)
req.['app_cookie'] = "testing"
dispatch_request(req, MyController, :edit)
Notes
Does not use routes.
208 209 210 211 212 213 214 215 216 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 208 def build_request(params = {}, env = {}) params = Merb::Request.params_to_query_string(params) query_string = env[:query_string] || env['QUERY_STRING'] env[:query_string] = query_string ? "#{query_string}&#{params}" : params post_body = env[:post_body] || env['POST_BODY'] fake_request(env, { :post_body => post_body, :req => env[:req] }) end |
#check_request_for_route(request) ⇒ Object
Checks to see that a request is routable.
Parameters
- request<Merb::Test::RequestHelper::FakeRequest, Merb::Request>
-
The request object to inspect.
Raises
- Merb::ControllerExceptions::BadRequest
-
No matching route was found.
Returns
- Hash
-
The parameters built based on the matching route.
@semi-public
383 384 385 386 387 388 389 390 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 383 def check_request_for_route(request) match = ::Merb::Router.match(request) if match[0].nil? && match[1].empty? raise ::Merb::ControllerExceptions::BadRequest, "No routes match the request" else match[1] end end |
#delete(path, params = {}, env = {}, &block) ⇒ Object
An HTTP DELETE request that operates through the router
Parameters
- path<String>
-
The path that should go to the router as the request uri.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see fake_request).
- &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
289 290 291 292 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 289 def delete(path, params = {}, env = {}, &block) env[:request_method] = "DELETE" request(path, params, env, &block) end |
#dispatch_request(request, controller_klass, action) {|controller| ... } ⇒ Object
The workhorse for the dispatch*to helpers.
Parameters
- request<Merb::Test::RequestHelper::FakeRequest, Merb::Request>
-
A request object that has been setup for testing.
- controller_klass<Merb::Controller>
-
The class object off the controller to dispatch the action to.
- action<Symbol>
-
The action to dispatch the request to.
- &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
Returns
An instance of controller_klass
based on the parameters.
Notes
Does not use routes.
357 358 359 360 361 362 363 364 365 366 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 357 def dispatch_request(request, controller_klass, action, &blk) controller = controller_klass.new(request) yield controller if block_given? controller._dispatch(action) Merb.logger.info controller._benchmarks.inspect Merb.logger.flush controller end |
#dispatch_to(controller_klass, action, params = {}, env = {}, &blk) ⇒ Object
Dispatches an action to the given class. This bypasses the router and is suitable for unit testing of controllers.
Parameters
- controller_klass<Controller>
-
The controller class object that the action should be dispatched to.
- action<Symbol>
-
The action name, as a symbol.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see
fake_request
), including :req or :post_body for setting the request body itself. - &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
Example
dispatch_to(MyController, :create, :name => 'Homer' ) do |controller|
controller.stub!(:current_user).and_return(@user)
end
Notes
Does not use routes.
116 117 118 119 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 116 def dispatch_to(controller_klass, action, params = {}, env = {}, &blk) params = merge_controller_and_action(controller_klass, action, params) dispatch_request(build_request(params, env), controller_klass, action.to_s, &blk) end |
#dispatch_with_basic_authentication_to(controller_klass, action, username, password, params = {}, env = {}, &blk) ⇒ Object
Dispatches an action to the given class and using HTTP Basic Authentication This bypasses the router and is suitable for unit testing of controllers.
Parameters
- controller_klass<Controller>
-
The controller class object that the action should be dispatched to.
- action<Symbol>
-
The action name, as a symbol.
- username<String>
-
The username.
- password<String>
-
The password.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see
fake_request
), including :req or :post_body for setting the request body itself. - &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
Example
dispatch_with_basic_authentication_to(MyController, :create, 'Fred', 'secret', :name => 'Homer' ) do |controller|
controller.stub!(:current_user).and_return(@user)
end
Notes
Does not use routes.
171 172 173 174 175 176 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 171 def dispatch_with_basic_authentication_to(controller_klass, action, username, password, params = {}, env = {}, &blk) env["X_HTTP_AUTHORIZATION"] = "Basic #{Base64.encode64("#{username}:#{password}")}" params = merge_controller_and_action(controller_klass, action, params) dispatch_request(build_request(params, env), controller_klass, action.to_s, &blk) end |
#fake_request(env = {}, opt = {}) ⇒ Object
Parameters
- env<Hash>
-
A hash of environment keys to be merged into the default list.
- opt<Hash>
-
A hash of options (see below).
Options (opt)
- :post_body<String>
-
The post body for the request.
- :req<String>
-
The request string. This will only be used if :post_body is left out.
Returns
- FakeRequest
-
A Request object that is built based on the parameters.
Notes
If you pass a post body, the content-type will be set to URL-encoded.
79 80 81 82 83 84 85 86 87 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 79 def fake_request(env = {}, opt = {}) if opt[:post_body] req = opt[:post_body] env[:content_type] ||= "application/x-www-form-urlencoded" else req = opt[:req] end FakeRequest.new(env, StringIO.new(req || '')) end |
#get(path, params = {}, env = {}, &block) ⇒ Object
An HTTP GET request that operates through the router.
Parameters
- path<String>
-
The path that should go to the router as the request uri.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see
fake_request
). - &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
232 233 234 235 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 232 def get(path, params = {}, env = {}, &block) env[:request_method] = "GET" request(path, params, env, &block) end |
#merge_controller_and_action(controller_klass, action, params) ⇒ Object
178 179 180 181 182 183 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 178 def merge_controller_and_action(controller_klass, action, params) params[:controller] = controller_klass.name.to_const_path params[:action] = action.to_s params end |
#post(path, params = {}, env = {}, &block) ⇒ Object
An HTTP POST request that operates through the router.
Parameters
- path<String>
-
The path that should go to the router as the request uri.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see fake_request).
- &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
251 252 253 254 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 251 def post(path, params = {}, env = {}, &block) env[:request_method] = "POST" request(path, params, env, &block) end |
#put(path, params = {}, env = {}, &block) ⇒ Object
An HTTP PUT request that operates through the router.
Parameters
- path<String>
-
The path that should go to the router as the request uri.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see fake_request).
- &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
270 271 272 273 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 270 def put(path, params = {}, env = {}, &block) env[:request_method] = "PUT" request(path, params, env, &block) end |
#request(path, params = {}, env = {}, &block) ⇒ Object
A generic request that checks the router for the controller and action. This request goes through the Merb::Router and finishes at the controller.
Parameters
- path<String>
-
The path that should go to the router as the request uri.
- params<Hash>
-
An optional hash that will end up as params in the controller instance.
- env<Hash>
-
An optional hash that is passed to the fake request. Any request options should go here (see
fake_request
). - &blk
-
The controller is yielded to the block provided for actions prior to the action being dispatched.
Example
request(path, { :name => 'Homer' }, { :request_method => "PUT" }) do |controller|
controller.stub!(:current_user).and_return(@user)
end
Notes
Uses Routes.
@semi-public
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 318 def request(path, params = {}, env= {}, &block) env[:request_method] ||= "GET" env[:request_uri], env[:query_string] = path.split('?') multipart = env.delete(:test_with_multipart) request = build_request(params, env) opts = check_request_for_route(request) # Check that the request will be routed correctly controller_name = (opts[:namespace] ? opts.delete(:namespace) + '/' : '') + opts.delete(:controller) klass = Object.full_const_get(controller_name.snake_case.to_const_string) action = opts.delete(:action).to_s params.merge!(opts) multipart.nil? ? dispatch_to(klass, action, params, env, &block) : dispatch_multipart_to(klass, action, params, env, &block) end |
#with_cookies(*controller_classes, &blk) ⇒ Object
Keep track of cookie values in CookieJar within the context of the block; you need to set this up for secific controllers.
Parameters
- *controller_classes
-
Controller classes to operate on in the context of the block.
- &blk
-
The context to operate on; optionally accepts the cookie jar as an argument.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/merb-core/test/helpers/request_helper.rb', line 127 def (*controller_classes, &blk) = CookieJar.new before_cb = lambda { |c| c..update() } after_cb = lambda { |c| .update_from_request(c.request) } controller_classes.each do |klass| klass._before_dispatch_callbacks << before_cb klass._after_dispatch_callbacks << after_cb end blk.arity == 1 ? blk.call() : blk.call controller_classes.each do |klass| klass._before_dispatch_callbacks.delete before_cb klass._after_dispatch_callbacks.delete after_cb end end |