172 lines
9.2 KiB
Plaintext
172 lines
9.2 KiB
Plaintext
|
This specification aims to formalize the Rack protocol. You
|
||
|
|
can (and should) use Rack::Lint to enforce it.
|
||
|
|
When you develop middleware, be sure to add a Lint before and
|
||
|
|
after to catch all mistakes.
|
||
|
|
= Rack applications
|
||
|
|
A Rack application is a Ruby object (not a class) that
|
||
|
|
responds to +call+.
|
||
|
|
It takes exactly one argument, the *environment*
|
||
|
|
and returns an Array of exactly three values:
|
||
|
|
The *status*,
|
||
|
|
the *headers*,
|
||
|
|
and the *body*.
|
||
|
|
== The Environment
|
||
|
|
The environment must be an instance of Hash that includes
|
||
|
|
CGI-like headers. The application is free to modify the
|
||
|
|
environment.
|
||
|
|
The environment is required to include these variables
|
||
|
|
(adopted from PEP333), except when they'd be empty, but see
|
||
|
|
below.
|
||
|
|
<tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
|
||
|
|
"GET" or "POST". This cannot ever
|
||
|
|
be an empty string, and so is
|
||
|
|
always required.
|
||
|
|
<tt>SCRIPT_NAME</tt>:: The initial portion of the request
|
||
|
|
URL's "path" that corresponds to the
|
||
|
|
application object, so that the
|
||
|
|
application knows its virtual
|
||
|
|
"location". This may be an empty
|
||
|
|
string, if the application corresponds
|
||
|
|
to the "root" of the server.
|
||
|
|
<tt>PATH_INFO</tt>:: The remainder of the request URL's
|
||
|
|
"path", designating the virtual
|
||
|
|
"location" of the request's target
|
||
|
|
within the application. This may be an
|
||
|
|
empty string, if the request URL targets
|
||
|
|
the application root and does not have a
|
||
|
|
trailing slash. This value may be
|
||
|
|
percent-encoded when I originating from
|
||
|
|
a URL.
|
||
|
|
<tt>QUERY_STRING</tt>:: The portion of the request URL that
|
||
|
|
follows the <tt>?</tt>, if any. May be
|
||
|
|
empty, but is always required!
|
||
|
|
<tt>SERVER_NAME</tt>, <tt>SERVER_PORT</tt>:: When combined with <tt>SCRIPT_NAME</tt> and <tt>PATH_INFO</tt>, these variables can be used to complete the URL. Note, however, that <tt>HTTP_HOST</tt>, if present, should be used in preference to <tt>SERVER_NAME</tt> for reconstructing the request URL. <tt>SERVER_NAME</tt> and <tt>SERVER_PORT</tt> can never be empty strings, and so are always required.
|
||
|
|
<tt>HTTP_</tt> Variables:: Variables corresponding to the
|
||
|
|
client-supplied HTTP request
|
||
|
|
headers (i.e., variables whose
|
||
|
|
names begin with <tt>HTTP_</tt>). The
|
||
|
|
presence or absence of these
|
||
|
|
variables should correspond with
|
||
|
|
the presence or absence of the
|
||
|
|
appropriate HTTP header in the
|
||
|
|
request.
|
||
|
|
In addition to this, the Rack environment must include these
|
||
|
|
Rack-specific variables:
|
||
|
|
<tt>rack.version</tt>:: The Array [1,1], representing this version of Rack.
|
||
|
|
<tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the request URL.
|
||
|
|
<tt>rack.input</tt>:: See below, the input stream.
|
||
|
|
<tt>rack.errors</tt>:: See below, the error stream.
|
||
|
|
<tt>rack.multithread</tt>:: true if the application object may be simultaneously invoked by another thread in the same process, false otherwise.
|
||
|
|
<tt>rack.multiprocess</tt>:: true if an equivalent application object may be simultaneously invoked by another process, false otherwise.
|
||
|
|
<tt>rack.run_once</tt>:: true if the server expects (but does not guarantee!) that the application will only be invoked this one time during the life of its containing process. Normally, this will only be true for a server based on CGI (or something similar).
|
||
|
|
Additional environment specifications have approved to
|
||
|
|
standardized middleware APIs. None of these are required to
|
||
|
|
be implemented by the server.
|
||
|
|
<tt>rack.session</tt>:: A hash like interface for storing request session data.
|
||
|
|
The store must implement:
|
||
|
|
store(key, value) (aliased as []=);
|
||
|
|
fetch(key, default = nil) (aliased as []);
|
||
|
|
delete(key);
|
||
|
|
clear;
|
||
|
|
<tt>rack.logger</tt>:: A common object interface for logging messages.
|
||
|
|
The object must implement:
|
||
|
|
info(message, &block)
|
||
|
|
debug(message, &block)
|
||
|
|
warn(message, &block)
|
||
|
|
error(message, &block)
|
||
|
|
fatal(message, &block)
|
||
|
|
The server or the application can store their own data in the
|
||
|
|
environment, too. The keys must contain at least one dot,
|
||
|
|
and should be prefixed uniquely. The prefix <tt>rack.</tt>
|
||
|
|
is reserved for use with the Rack core distribution and other
|
||
|
|
accepted specifications and must not be used otherwise.
|
||
|
|
The environment must not contain the keys
|
||
|
|
<tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
|
||
|
|
(use the versions without <tt>HTTP_</tt>).
|
||
|
|
The CGI keys (named without a period) must have String values.
|
||
|
|
There are the following restrictions:
|
||
|
|
* <tt>rack.version</tt> must be an array of Integers.
|
||
|
|
* <tt>rack.url_scheme</tt> must either be +http+ or +https+.
|
||
|
|
* There must be a valid input stream in <tt>rack.input</tt>.
|
||
|
|
* There must be a valid error stream in <tt>rack.errors</tt>.
|
||
|
|
* The <tt>REQUEST_METHOD</tt> must be a valid token.
|
||
|
|
* The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
|
||
|
|
* The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
|
||
|
|
* The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
|
||
|
|
* One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
|
||
|
|
set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
|
||
|
|
<tt>SCRIPT_NAME</tt> is empty.
|
||
|
|
<tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
|
||
|
|
=== The Input Stream
|
||
|
|
The input stream is an IO-like object which contains the raw HTTP
|
||
|
|
POST data.
|
||
|
|
When applicable, its external encoding must be "ASCII-8BIT" and it
|
||
|
|
must be opened in binary mode, for Ruby 1.9 compatibility.
|
||
|
|
The input stream must respond to +gets+, +each+, +read+ and +rewind+.
|
||
|
|
* +gets+ must be called without arguments and return a string,
|
||
|
|
or +nil+ on EOF.
|
||
|
|
* +read+ behaves like IO#read. Its signature is <tt>read([length, [buffer]])</tt>.
|
||
|
|
If given, +length+ must be a non-negative Integer (>= 0) or +nil+, and +buffer+ must
|
||
|
|
be a String and may not be nil. If +length+ is given and not nil, then this method
|
||
|
|
reads at most +length+ bytes from the input stream. If +length+ is not given or nil,
|
||
|
|
then this method reads all data until EOF.
|
||
|
|
When EOF is reached, this method returns nil if +length+ is given and not nil, or ""
|
||
|
|
if +length+ is not given or is nil.
|
||
|
|
If +buffer+ is given, then the read data will be placed into +buffer+ instead of a
|
||
|
|
newly created String object.
|
||
|
|
* +each+ must be called without arguments and only yield Strings.
|
||
|
|
* +rewind+ must be called without arguments. It rewinds the input
|
||
|
|
stream back to the beginning. It must not raise Errno::ESPIPE:
|
||
|
|
that is, it may not be a pipe or a socket. Therefore, handler
|
||
|
|
developers must buffer the input data into some rewindable object
|
||
|
|
if the underlying input stream is not rewindable.
|
||
|
|
* +close+ must never be called on the input stream.
|
||
|
|
=== The Error Stream
|
||
|
|
The error stream must respond to +puts+, +write+ and +flush+.
|
||
|
|
* +puts+ must be called with a single argument that responds to +to_s+.
|
||
|
|
* +write+ must be called with a single argument that is a String.
|
||
|
|
* +flush+ must be called without arguments and must be called
|
||
|
|
in order to make the error appear for sure.
|
||
|
|
* +close+ must never be called on the error stream.
|
||
|
|
== The Response
|
||
|
|
=== The Status
|
||
|
|
This is an HTTP status. When parsed as integer (+to_i+), it must be
|
||
|
|
greater than or equal to 100.
|
||
|
|
=== The Headers
|
||
|
|
The header must respond to +each+, and yield values of key and value.
|
||
|
|
The header keys must be Strings.
|
||
|
|
The header must not contain a +Status+ key,
|
||
|
|
contain keys with <tt>:</tt> or newlines in their name,
|
||
|
|
contain keys names that end in <tt>-</tt> or <tt>_</tt>,
|
||
|
|
but only contain keys that consist of
|
||
|
|
letters, digits, <tt>_</tt> or <tt>-</tt> and start with a letter.
|
||
|
|
The values of the header must be Strings,
|
||
|
|
consisting of lines (for multiple header values, e.g. multiple
|
||
|
|
<tt>Set-Cookie</tt> values) seperated by "\n".
|
||
|
|
The lines must not contain characters below 037.
|
||
|
|
=== The Content-Type
|
||
|
|
There must be a <tt>Content-Type</tt>, except when the
|
||
|
|
+Status+ is 1xx, 204, 205 or 304, in which case there must be none
|
||
|
|
given.
|
||
|
|
=== The Content-Length
|
||
|
|
There must not be a <tt>Content-Length</tt> header when the
|
||
|
|
+Status+ is 1xx, 204, 205 or 304.
|
||
|
|
=== The Body
|
||
|
|
The Body must respond to +each+
|
||
|
|
and must only yield String values.
|
||
|
|
The Body itself should not be an instance of String, as this will
|
||
|
|
break in Ruby 1.9.
|
||
|
|
If the Body responds to +close+, it will be called after iteration.
|
||
|
|
If the Body responds to +to_path+, it must return a String
|
||
|
|
identifying the location of a file whose contents are identical
|
||
|
|
to that produced by calling +each+; this may be used by the
|
||
|
|
server as an alternative, possibly more efficient way to
|
||
|
|
transport the response.
|
||
|
|
The Body commonly is an Array of Strings, the application
|
||
|
|
instance itself, or a File-like object.
|
||
|
|
== Thanks
|
||
|
|
Some parts of this specification are adopted from PEP333: Python
|
||
|
|
Web Server Gateway Interface
|
||
|
|
v1.0 (http://www.python.org/dev/peps/pep-0333/). I'd like to thank
|
||
|
|
everyone involved in that effort.
|