In Files

Parent

Rack::MockRequest

Rack::MockRequest helps testing your Rack application without actually using HTTP.

After performing a request on a URL with get/post/put/patch/delete, it returns a MockResponse with useful helper methods for effective testing.

You can pass a hash with additional configuration to the get/post/put/patch/delete.

:input

A String or IO-like to be used as rack.input.

:fatal

Raise a FatalWarning if the app writes to rack.errors.

:lint

If true, wrap the application in a Rack::Lint.

Constants

DEFAULT_ENV

Public Class Methods

env_for(uri="", opts={}) click to toggle source

Return the Rack environment used for a request to uri.

# File lib/rack/mock.rb, line 80
def self.env_for(uri="", opts={})
  uri = URI(uri)
  uri.path = "/#{uri.path}" unless uri.path[0] == //

  env = DEFAULT_ENV.dup

  env["REQUEST_METHOD"] = opts[:method] ? opts[:method].to_s.upcase : "GET"
  env["SERVER_NAME"] = uri.host || "example.org"
  env["SERVER_PORT"] = uri.port ? uri.port.to_s : "80"
  env["QUERY_STRING"] = uri.query.to_s
  env["PATH_INFO"] = (!uri.path || uri.path.empty?) ? "/" : uri.path
  env["rack.url_scheme"] = uri.scheme || "http"
  env["HTTPS"] = env["rack.url_scheme"] == "https" ? "on" : "off"

  env["SCRIPT_NAME"] = opts[:script_name] || ""

  if opts[:fatal]
    env["rack.errors"] = FatalWarner.new
  else
    env["rack.errors"] = StringIO.new
  end

  if params = opts[:params]
    if env["REQUEST_METHOD"] == "GET"
      params = Utils.parse_nested_query(params) if params.is_a?(String)
      params.update(Utils.parse_nested_query(env["QUERY_STRING"]))
      env["QUERY_STRING"] = Utils.build_nested_query(params)
    elsif !opts.has_key?(:input)
      opts["CONTENT_TYPE"] = "application/x-www-form-urlencoded"
      if params.is_a?(Hash)
        if data = Utils::Multipart.build_multipart(params)
          opts[:input] = data
          opts["CONTENT_LENGTH"] ||= data.length.to_s
          opts["CONTENT_TYPE"] = "multipart/form-data; boundary=#{Utils::Multipart::MULTIPART_BOUNDARY}"
        else
          opts[:input] = Utils.build_nested_query(params)
        end
      else
        opts[:input] = params
      end
    end
  end

  empty_str = ""
  empty_str.force_encoding("ASCII-8BIT") if empty_str.respond_to? :force_encoding
  opts[:input] ||= empty_str
  if String === opts[:input]
    rack_input = StringIO.new(opts[:input])
  else
    rack_input = opts[:input]
  end

  rack_input.set_encoding(Encoding::BINARY) if rack_input.respond_to?(:set_encoding)
  env['rack.input'] = rack_input

  env["CONTENT_LENGTH"] ||= env["rack.input"].length.to_s

  opts.each { |field, value|
    env[field] = value  if String === field
  }

  env
end
new(app) click to toggle source
# File lib/rack/mock.rb, line 52
def initialize(app)
  @app = app
end

Public Instance Methods

delete(uri, opts={}) click to toggle source
# File lib/rack/mock.rb, line 60
def delete(uri, opts={}) request("DELETE", uri, opts) end
get(uri, opts={}) click to toggle source
# File lib/rack/mock.rb, line 56
def get(uri, opts={})    request("GET", uri, opts)    end
head(uri, opts={}) click to toggle source
# File lib/rack/mock.rb, line 61
def head(uri, opts={})   request("HEAD", uri, opts)   end
patch(uri, opts={}) click to toggle source
# File lib/rack/mock.rb, line 59
def patch(uri, opts={})  request("PATCH", uri, opts)    end
post(uri, opts={}) click to toggle source
# File lib/rack/mock.rb, line 57
def post(uri, opts={})   request("POST", uri, opts)   end
put(uri, opts={}) click to toggle source
# File lib/rack/mock.rb, line 58
def put(uri, opts={})    request("PUT", uri, opts)    end
request(method="GET", uri="", opts={}) click to toggle source
# File lib/rack/mock.rb, line 63
def request(method="GET", uri="", opts={})
  env = self.class.env_for(uri, opts.merge(:method => method))

  if opts[:lint]
    app = Rack::Lint.new(@app)
  else
    app = @app
  end

  errors = env["rack.errors"]
  status, headers, body  = app.call(env)
  MockResponse.new(status, headers, body, errors)
ensure
  body.close if body.respond_to?(:close)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.