W3cubDocs

class ActionDispatch::Integration::Session

Parent:: Object
Included modules:: ActionDispatch::TestProcess, ActionDispatch::Integration::RequestHelpers, ActionDispatch::Assertions, ActionDispatch::Routing::UrlFor

An instance of this class represents a set of requests and responses performed sequentially by a test process. Because you can instantiate multiple sessions and run them side-by-side, you can also mimic (to some limited extent) multiple simultaneous users interacting with your system.

Typically, you will instantiate a new session using IntegrationTest#open_session, rather than instantiating Integration::Session directly.

Constants

DEFAULT_HOST

Attributes

accept[RW]

The Accept header to send.

controller[R]

A reference to the controller instance used by the last request.

host[W]

host![W]

remote_addr[RW]

The #remote_addr used in the last request.

request[R]

A reference to the request instance used by the last request.

request_count[RW]

A running counter of the number of requests processed.

response[R]

A reference to the response instance used by the last request.

Public Class Methods

new(app) Show source

Create and initialize a new Session instance.

Calls superclass method ActionDispatch::Routing::UrlFor.new

# File actionpack/lib/action_dispatch/testing/integration.rb, line 184
def initialize(app)
  super()
  @app = app

  # If the app is a Rails app, make url_helpers available on the session
  # This makes app.url_for and app.foo_path available in the console
  if app.respond_to?(:routes)
    singleton_class.class_eval do
      include app.routes.url_helpers
      include app.routes.mounted_helpers
    end
  end

  reset!
end

Public Instance Methods

cookies() Show source

A map of the cookies returned by the last response, and which will be sent with the next request.

# File actionpack/lib/action_dispatch/testing/integration.rb, line 165
def cookies
  _mock_session.cookie_jar
end

host() Show source

The hostname used in the last request.

# File actionpack/lib/action_dispatch/testing/integration.rb, line 152
def host
  @host || DEFAULT_HOST
end

https!(flag = true) Show source

Specify whether or not the session should mimic a secure HTTPS request.

session.https!
session.https!(false)

# File actionpack/lib/action_dispatch/testing/integration.rb, line 241
def https!(flag = true)
  @https = flag
end

https?() Show source

Returns true if the session is mimicking a secure HTTPS request.

if session.https?
  ...
end

# File actionpack/lib/action_dispatch/testing/integration.rb, line 250
def https?
  @https
end

reset!() Show source

Resets the instance. This can be used to reset the state information in an existing session instance, so it can be used from a clean-slate condition.

session.reset!

# File actionpack/lib/action_dispatch/testing/integration.rb, line 217
def reset!
  @https = false
  @controller = @request = @response = nil
  @_mock_session = nil
  @request_count = 0
  @url_options = nil

  self.host        = DEFAULT_HOST
  self.remote_addr = "127.0.0.1"
  self.accept      = "text/xml,application/xml,application/xhtml+xml," +
                     "text/html;q=0.9,text/plain;q=0.8,image/png," +
                     "*/*;q=0.5"

  unless defined? @named_routes_configured
    # the helpers are made protected by default--we make them public for
    # easier access during testing and troubleshooting.
    @named_routes_configured = true
  end
end

url_options() Show source

# File actionpack/lib/action_dispatch/testing/integration.rb, line 200
def url_options
  @url_options ||= default_url_options.dup.tap do |url_options|
    url_options.reverse_merge!(controller.url_options) if controller

    if @app.respond_to?(:routes)
      url_options.reverse_merge!(@app.routes.default_url_options)
    end

    url_options.reverse_merge!(:host => host, :protocol => https? ? "https" : "http")
  end
end