Class: Rack::MockRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/mock.rb

Overview

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.

Defined Under Namespace

Classes: FatalWarner, FatalWarning

Constant Summary collapse

DEFAULT_ENV = 
{
  "rack.version" => Rack::VERSION,
  "rack.input" => StringIO.new,
  "rack.errors" => StringIO.new,
  "rack.multithread" => true,
  "rack.multiprocess" => true,
  "rack.run_once" => false,
}

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app) ⇒ MockRequest

Returns a new instance of MockRequest.



52
53
54
 
# File 'lib/rack/mock.rb', line 52

def initialize(app)
  @app = app
end

Class Method Details

.env_for(uri = "", opts = {}) ⇒ Object

Return the Rack environment used for a request to uri.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rack/mock.rb', line 88

def self.env_for(uri="", opts={})
  uri = parse_uri_rfc2396(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

.parse_uri_rfc2396(uri) ⇒ Object

For historical reasons, we’re pinning to RFC 2396. It’s easier for users and we get support from ruby 1.8 to 2.2 using this method.



82
83
84
85
 
# File 'lib/rack/mock.rb', line 82

def self.parse_uri_rfc2396(uri)
  @parser ||= defined?(URI::RFC2396_Parser) ? URI::RFC2396_Parser.new : URI
  @parser.parse(uri)
end

Instance Method Details

#delete(uri, opts = {}) ⇒ Object 



60
 
# File 'lib/rack/mock.rb', line 60

def delete(uri, opts={})  request("DELETE", uri, opts)  end

#get(uri, opts = {}) ⇒ Object 



56
 
# File 'lib/rack/mock.rb', line 56

def get(uri, opts={})     request("GET", uri, opts)     end

#head(uri, opts = {}) ⇒ Object 



61
 
# File 'lib/rack/mock.rb', line 61

def head(uri, opts={})    request("HEAD", uri, opts)    end

#options(uri, opts = {}) ⇒ Object 



62
 
# File 'lib/rack/mock.rb', line 62

def options(uri, opts={}) request("OPTIONS", uri, opts) end

#patch(uri, opts = {}) ⇒ Object 



59
 
# File 'lib/rack/mock.rb', line 59

def patch(uri, opts={})   request("PATCH", uri, opts)   end

#post(uri, opts = {}) ⇒ Object 



57
 
# File 'lib/rack/mock.rb', line 57

def post(uri, opts={})    request("POST", uri, opts)    end

#put(uri, opts = {}) ⇒ Object 



58
 
# File 'lib/rack/mock.rb', line 58

def put(uri, opts={})     request("PUT", uri, opts)     end

#request(method = "GET", uri = "", opts = {}) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rack/mock.rb', line 64

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