Title: | Powerful Classes for HTTP Requests and Responses |
---|---|
Description: | In order to facilitate parsing of http requests and creating appropriate responses this package provides two classes to handle a lot of the housekeeping involved in working with http exchanges. The infrastructure builds upon the 'rook' specification and is thus well suited to be combined with 'httpuv' based web servers. |
Authors: | Thomas Lin Pedersen [cre, aut]
|
Maintainer: | Thomas Lin Pedersen <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.2.5.9000 |
Built: | 2025-03-10 22:21:42 UTC |
Source: | https://github.com/thomasp85/reqres |
This set of functions throws a classed error indicating that the request
should be responded to with an HTTP problem according to the spec defined in
RFC 9457 or a bare response
code. These conditions should be caught and handled by the handle_problem()
function.
abort_http_problem( code, detail, title = NULL, type = NULL, instance = NULL, ..., message = detail, call = caller_env() ) abort_status(code, message = status_phrase(code), ..., call = caller_env()) abort_bad_request( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_unauthorized( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_forbidden( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_not_found( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_method_not_allowed( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_not_acceptable( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_conflict( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_gone(detail, instance = NULL, ..., message = detail, call = caller_env()) abort_internal_error( detail, instance = NULL, ..., message = detail, call = caller_env() ) handle_problem(response, cnd) is_reqres_problem(cnd)
abort_http_problem( code, detail, title = NULL, type = NULL, instance = NULL, ..., message = detail, call = caller_env() ) abort_status(code, message = status_phrase(code), ..., call = caller_env()) abort_bad_request( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_unauthorized( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_forbidden( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_not_found( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_method_not_allowed( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_not_acceptable( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_conflict( detail, instance = NULL, ..., message = detail, call = caller_env() ) abort_gone(detail, instance = NULL, ..., message = detail, call = caller_env()) abort_internal_error( detail, instance = NULL, ..., message = detail, call = caller_env() ) handle_problem(response, cnd) is_reqres_problem(cnd)
code |
The HTTP status code to use |
detail |
A string detailing the problem. Make sure the information given does not pose a security risk |
title |
A human-readable title of the issue. Should not vary from
instance to instance of the specific issue. If |
type |
A URI that uniquely identifies this type of problem. The URI
must resolve to an HTTP document describing the problem in human readable
text. If |
instance |
A unique identifier of the specific instance of this problem that can be used for further debugging. Can be omitted. |
... |
Arguments passed on to
|
message |
A default message to inform the user about the condition when it is signalled. |
call |
A function call to be included in the error message. If an execution environment of a running function, the corresponding function call is retrieved. |
response |
The Response object associated with the request that created the condition |
cnd |
The thrown condition |
This list matches the most normal mime types with their respective formatters
using default arguments. For a no-frills request parsing this can be supplied
directly to Response$format()
. To add or modify to this list simply supply
the additional parsers as second, third, etc, argument and they will
overwrite or add depending on whether it specifies a mime type already
present.
default_formatters
default_formatters
formatters for an overview of the build in formatters in reqres
## Not run: res$format(default_formatters, 'text/plain' = format_plain(sep = ' ')) ## End(Not run)
## Not run: res$format(default_formatters, 'text/plain' = format_plain(sep = ' ')) ## End(Not run)
This list matches the most normal mime types with their respective parsers
using default arguments. For a no-frills request parsing this can be supplied
directly to Request$parse()
. To add or modify to this list simply supply
the additional parsers as second, third, etc, argument and they will
overwrite or add depending on whether it specifies a mime type already
present.
default_parsers
default_parsers
parsers for an overview of the build in parsers in reqres
## Not run: req$parse(default_parsers, 'application/json' = parse_json(flatten = TRUE)) ## End(Not run)
## Not run: req$parse(default_parsers, 'application/json' = parse_json(flatten = TRUE)) ## End(Not run)
This set of functions can be used to construct formatting functions adhering to the Response$format() requirements.
format_json( dataframe = "rows", matrix = "rowmajor", Date = "ISO8601", POSIXt = "string", factor = "string", complex = "string", raw = "base64", null = "list", na = "null", auto_unbox = FALSE, digits = 4, pretty = FALSE, force = FALSE ) format_plain(sep = "\n") format_xml(encoding = "UTF-8", options = "as_xml") format_html(encoding = "UTF-8", options = "as_html") format_table(...)
format_json( dataframe = "rows", matrix = "rowmajor", Date = "ISO8601", POSIXt = "string", factor = "string", complex = "string", raw = "base64", null = "list", na = "null", auto_unbox = FALSE, digits = 4, pretty = FALSE, force = FALSE ) format_plain(sep = "\n") format_xml(encoding = "UTF-8", options = "as_xml") format_html(encoding = "UTF-8", options = "as_html") format_table(...)
dataframe |
how to encode data.frame objects: must be one of 'rows', 'columns' or 'values' |
matrix |
how to encode matrices and higher dimensional arrays: must be one of 'rowmajor' or 'columnmajor'. |
Date |
how to encode Date objects: must be one of 'ISO8601' or 'epoch' |
POSIXt |
how to encode POSIXt (datetime) objects: must be one of 'string', 'ISO8601', 'epoch' or 'mongo' |
factor |
how to encode factor objects: must be one of 'string' or 'integer' |
complex |
how to encode complex numbers: must be one of 'string' or 'list' |
raw |
how to encode raw objects: must be one of 'base64', 'hex' or 'mongo' |
null |
how to encode NULL values within a list: must be one of 'null' or 'list' |
na |
how to print NA values: must be one of 'null' or 'string'. Defaults are class specific |
auto_unbox |
automatically |
digits |
max number of decimal digits to print for numeric values. Use |
pretty |
adds indentation whitespace to JSON output. Can be TRUE/FALSE or a number specifying the number of spaces to indent. See |
force |
unclass/skip objects of classes with no defined JSON mapping |
sep |
The line separator. Plain text will be split into multiple strings based on this. |
encoding |
The character encoding to use in the document. The default encoding is ‘UTF-8’. Available encodings are specified at http://xmlsoft.org/html/libxml-encoding.html#xmlCharEncoding. |
options |
default: ‘format’. Zero or more of
|
... |
parameters passed on to |
A function accepting an R object
parsers for converting Request
bodies into R objects
default_formatters for a list that maps the most common mime types to their respective formatters
fake_rook <- fiery::fake_request( 'http://example.com/test', content = '', headers = list( Content_Type = 'text/plain', Accept = 'application/json, text/csv' ) ) req <- Request$new(fake_rook) res <- req$respond() res$body <- mtcars res$format(json = format_json(), csv = format_table(sep=',')) res$body # Cleaning up connections rm(fake_rook, req, res) gc()
fake_rook <- fiery::fake_request( 'http://example.com/test', content = '', headers = list( Content_Type = 'text/plain', Accept = 'application/json, text/csv' ) ) req <- Request$new(fake_rook) res <- req$respond() res$body <- mtcars res$format(json = format_json(), csv = format_table(sep=',')) res$body # Cleaning up connections rm(fake_rook, req, res) gc()
This set of functions can be used to construct parsing functions adhering to the Request$parse() requirements.
parse_json( simplifyVector = TRUE, simplifyDataFrame = simplifyVector, simplifyMatrix = simplifyVector, flatten = FALSE ) parse_plain(sep = "\n") parse_xml(encoding = "", options = "NOBLANKS", base_url = "") parse_html( encoding = "", options = c("RECOVER", "NOERROR", "NOBLANKS"), base_url = "" ) parse_multiform() parse_queryform(delim = NULL) parse_table(...)
parse_json( simplifyVector = TRUE, simplifyDataFrame = simplifyVector, simplifyMatrix = simplifyVector, flatten = FALSE ) parse_plain(sep = "\n") parse_xml(encoding = "", options = "NOBLANKS", base_url = "") parse_html( encoding = "", options = c("RECOVER", "NOERROR", "NOBLANKS"), base_url = "" ) parse_multiform() parse_queryform(delim = NULL) parse_table(...)
simplifyVector |
coerce JSON arrays containing only primitives into an atomic vector |
simplifyDataFrame |
coerce JSON arrays containing only records (JSON objects) into a data frame |
simplifyMatrix |
coerce JSON arrays containing vectors of equal mode and dimension into matrix or array |
flatten |
automatically |
sep |
The line separator. Plain text will be split into multiple strings based on this. |
encoding |
Specify a default encoding for the document. Unless otherwise specified XML documents are assumed to be in UTF-8 or UTF-16. If the document is not UTF-8/16, and lacks an explicit encoding directive, this allows you to supply a default. |
options |
Set parsing options for the libxml2 parser. Zero or more of
|
base_url |
When loading from a connection, raw vector or literal html/xml, this allows you to specify a base url for the document. Base urls are used to turn relative urls into absolute urls. |
delim |
The delimiter to use for parsing arrays in non-exploded form.
Either |
... |
parameters passed on to |
A function accepting a raw vector and a named list of directives
formatters for converting Response
bodies into compatible types
default_parsers for a list that maps the most common mime types to their respective parsers
fake_rook <- fiery::fake_request( 'http://example.com/test', content = '[1, 2, 3, 4]', headers = list( Content_Type = 'application/json' ) ) req <- Request$new(fake_rook) req$parse(json = parse_json()) req$body # Cleaning up connections rm(fake_rook, req) gc()
fake_rook <- fiery::fake_request( 'http://example.com/test', content = '[1, 2, 3, 4]', headers = list( Content_Type = 'application/json' ) ) req <- Request$new(fake_rook) req$parse(json = parse_json()) req$body # Cleaning up connections rm(fake_rook, req) gc()
This function facilitates the parsing of querystrings, either from the URL or
a POST or PUT body with Content-Type
set to
application/x-www-form-urlencoded
.
query_parser(query = NULL, delim = NULL)
query_parser(query = NULL, delim = NULL)
query |
The query as a single string |
delim |
Optional delimiter of array values. If omitted it is expected
that arrays are provided in exploded form (e.g. |
A named list giving the keys and values of the query. Values fron the same key are combined if given multiple times
# Using delimiter to provide array query_parser("?name=Thomas%20Lin%20Pedersen&numbers=1 2 3", delim = " ") # No delimiter (exploded form) query_parser("?name=Thomas%20Lin%20Pedersen&numbers=1&numbers=2&numbers=3")
# Using delimiter to provide array query_parser("?name=Thomas%20Lin%20Pedersen&numbers=1 2 3", delim = " ") # No delimiter (exploded form) query_parser("?name=Thomas%20Lin%20Pedersen&numbers=1&numbers=2&numbers=3")
The encryption/decryption used in reqres is based on the sodium
package and requires a 32-bit encryption key encoded as hexadecimal values.
While you can craft your own, this function will take care of creating a
compliant key using a cryptographically secure pseudorandom number generator
from sodium::helpers()
.
random_key()
random_key()
Keep your encryption keys safe! Anyone with the key will be able to eavesdrop on your communication and tamper with the information stored in encrypted cookies through man-in-the-middle attacks. The best approach is to use the keyring package to manage your keys, but as an alternative you can store it as environment variables.
NEVER STORE THE KEY IN PLAIN TEXT.
NEVER PUT THE KEY SOMEWHERE WHERE IT CAN ACCIDENTALLY BE COMMITTED TO GIT OR OTHER VERSION CONTROL SOFTWARE
A 32-bit key as a hex-encoded string
# Store a key with keyring and use it keyring::key_set_with_value("reqres_key", random_key()) rook <- fiery::fake_request("http://example.com") Request$new(rook, key = keyring::key_get("reqres_key"))
# Store a key with keyring and use it keyring::key_set_with_value("reqres_key", random_key()) rook <- fiery::fake_request("http://example.com") Request$new(rook, key = keyring::key_get("reqres_key"))
This class wraps all functionality related to extracting information from a
http request. Much of the functionality is inspired by the Request class in
Express.js, so the documentation
for this will complement this document. As reqres
is build on top of the
Rook specifications
the Request
object is initialized from a Rook-compliant object. This will
often be the request object provided by the httpuv
framework. While it
shouldn't be needed, the original Rook object is always accessible and can be
modified, though any modifications will not propagate to derived values in
the Request
object (e.g. changing the HTTP_HOST
element of the Rook
object will not change the host
field of the Request
object). Because of
this, direct manipulation of the Rook object is generally discouraged.
as.Request(x, ...) is.Request(x)
as.Request(x, ...) is.Request(x)
x |
An object coercible to a |
... |
Parameters passed on to |
A Request
object (for as.Request()
) or a logical indicating whether
the object is a Request
(for is.Request()
)
A new 'Request'-object is initialized using the new()
method on the
generator:
Usage
req <- Request$new(rook, trust = FALSE)
|
trust
A logical indicating whether the request is trusted. Mutable
method
A string indicating the request method (in lower case, e.g. 'get', 'put', etc.). Immutable
body
An object holding the body of the request. This is an empty
string by default and needs to be populated using the set_body()
method
(this is often done using a body parser that accesses the Rook$input
stream). Immutable
session
The content of the session cookie. If session cookies has
not been activated it will be an empty write-protected list. If session
cookies are activated but the request did not contain one it will be an
empty list. The content of this field will be send encrypted as part of
the response according to the cookie settings in
$session_cookie_settings
. This field is reflected in the
Response$session
field and using either produces the same result
has_session_cookie
Query whether the request came with a session cookie Immutable
session_cookie_settings
Get the settings for the session cookie as they were provided during initialisation cookie Immutable
has_key
Query whether the request was initialised with an encryption key Immutable
cookies
Access a named list of all cookies in the request. These have been URI decoded. Immutable
headers
Access a named list of all headers in the request. In
order to follow R variable naming standards -
have been substituted
with _
. Use the get_header()
method to lookup based on the correct
header name. Immutable
host
Return the domain of the server given by the "Host" header if
trust == FALSE
. If trust == true
returns the X-Forwarded-Host
instead. Immutable
ip
Returns the remote address of the request if trust == FALSE
.
If trust == TRUE
it will instead return the first value of the
X-Forwarded-For
header. Immutable
ips
If trust == TRUE
it will return the full list of ips in the
X-Forwarded-For
header. If trust == FALSE
it will return an empty
vector. Immutable
protocol
Returns the protocol (e.g. 'http') used for the request.
If trust == TRUE
it will use the value of the X-Forwarded-Proto
header.
Immutable
root
The mount point of the application receiving this request. Can be empty if the application is mounted on the server root. Immutable
path
The part of the url following the root. Defines the local target of the request (independent of where it is mounted). Immutable
url
The full URL of the request. Immutable
query
The query string of the request (anything following "?" in the URL) parsed into a named list. The query has been url decoded and "+" has been substituted with space. Multiple queries are expected to be separated by either "&" or "|". Immutable
query_delim
The delimiter used for specifying multiple values in a
query. If NULL
then queries are expected to contain multiple key-value
pairs for the same key in order to provide an array, e.g.
?arg1=3&arg1=7
. If setting it to ",""
, "|"
, or " "
then an array
can be provided in a single key-value pair, e.g. ?arg1=3|7
querystring
The unparsed query string of the request, including
"?". If no query string exists it will be ""
rather than "?"
xhr
A logical indicating whether the X-Requested-With
header
equals XMLHttpRequest
thus indicating that the request was performed
using JavaScript library such as jQuery. Immutable
secure
A logical indicating whether the request was performed
using a secure connection, i.e. protocol == 'https'
. Immutable
origin
The original object used to create the Request
object. As
reqres
currently only works with rook this will always return the
original rook object. Changing this will force the request to reparse
itself.
response
If a Response
object has been created for this request
it is accessible through this field. Immutable
new()
Create a new request from a rook object
Request$new(rook, trust = FALSE, key = NULL, session_cookie = NULL)
rook
The rook object to base the request on
trust
Is this request trusted blindly. If TRUE
X-Forwarded-*
headers will be returned when querying host, ip, and protocol
key
A 32-bit secret key as a hex encoded string or a raw vector to
use for $encode_string()
and $decode_string()
and by extension to
encrypt a session cookie. It must be given to turn on session cookie
support. A valid key can be generated using random_key()
. NEVER STORE
THE KEY IN PLAIN TEXT. Optimalle use the keyring package to store it or
set it as an environment variable
session_cookie
Settings for the session cookie created using
session_cookie()
. Will be ignored if key
is not provided to ensure
session cookies are properly encrypted
print()
Pretty printing of the object
Request$print(...)
...
ignored
set_body()
Sets the content of the request body. This method should
mainly be used in concert with a body parser that reads the rook$input
stream
Request$set_body(content)
content
An R object representing the body of the request
set_cookies()
Sets the cookies of the request. The cookies are automatically parsed and populated, so this method is mainly available to facilitate cookie signing and encryption
Request$set_cookies(cookies)
cookies
A named list of cookie values
accepts()
Given a vector of response content types it returns the
preferred one based on the Accept
header.
Request$accepts(types)
types
A vector of types
accepts_charsets()
Given a vector of possible character encodings it returns
the preferred one based on the Accept-Charset
header.
Request$accepts_charsets(charsets)
charsets
A vector of charsets
accepts_encoding()
Given a vector of possible content encodings (usually
compression algorithms) it selects the preferred one based on the
Accept-Encoding
header. If there is no match it will return "identity"
signaling no compression.
Request$accepts_encoding(encoding)
encoding
A vector of encoding names
accepts_language()
Given a vector of possible content languages it selects the
best one based on the Accept-Language
header.
Request$accepts_language(language)
language
A vector of languages
is()
Queries whether the body of the request is in a given format
by looking at the Content-Type
header. Used for selecting the best
parsing method.
Request$is(type)
type
A vector of content types to check for. Can be fully qualified MIME types, a file extension, or a mime type with wildcards
get_header()
Get the header of the specified name.
Request$get_header(name)
name
The name of the header to get
respond()
Creates a new Response
object from the request
Request$respond()
parse()
Based on provided parsers it selects the appropriate one by
looking at the Content-Type
header and assigns the result to the
request body. A parser is a function accepting a raw vector, and a named
list of additional directives, and returns an R object of any kind (if
the parser knows the input to be plain text, simply wrap it in
rawToChar()
). If the body is compressed, it will be decompressed based
on the Content-Encoding
header prior to passing it on to the parser.
See parsers for a list of pre-supplied parsers. Parsers are either
supplied in a named list or as named arguments to the parse method. The
names should correspond to mime types or known file extensions. If
autofail = TRUE
the response will be set with the correct error code if
parsing fails. parse()
returns TRUE
if parsing was successful and
FALSE
if not
Request$parse(..., autofail = TRUE)
...
A named set of parser functions
autofail
Automatically populate the response if parsing fails
parse_raw()
This is a simpler version of the parse()
method. It will
attempt to decompress the body and set the body
field to the resulting
raw vector. It is then up to the server to decide how to handle the
payload. It returns TRUE
if successful and FALSE
otherwise.
Request$parse_raw(autofail = TRUE)
autofail
Automatically populate the response if parsing fails
as_message()
Prints a HTTP representation of the request to the output stream.
Request$as_message()
encode_string()
base64-encode a string. If a key has been provided during
initialisation the string is first encrypted and the final result is a
combination of the encrypted text and the nonce, both base64 encoded and
combined with a "_"
.
Request$encode_string(val)
val
A single string to encrypt
decode_string()
base64-decodes a string. If a key has been provided during
initialisation the input is first split by "_"
and then the two parts
are base64 decoded and decrypted. Otherwise the input is base64-decoded
as-is. It will always hold that
val == decode_string(encode_string(val))
.
Request$decode_string(val)
val
A single string to encrypt
forward()
Forward a request to a new url, optionally setting different headers, queries, etc. Uses httr2 under the hood
Request$forward( url, query = NULL, method = NULL, headers = NULL, body = NULL, ... )
url
The url to forward to
query
Optional querystring to append to url
. If NULL
the query
string of the current request will be used
method
The HTTP method to use. If NULL
the method of the current
request will be used
headers
A list of headers to add to the headers of the current
request. You can remove a header from the current request by setting it
to NULL
here
body
The body to send with the forward. If NULL
the body of the
current request will be used
...
Additional arguments passed to httr2::req_options()
clone()
The objects of this class are cloneable with this method.
Request$clone(deep = FALSE)
deep
Whether to make a deep clone.
Response
for handling http responses
fake_rook <- fiery::fake_request( 'http://example.com/test?id=34632&question=who+is+hadley', content = 'This is an elaborate ruse', headers = list( Accept = 'application/json; text/*', Content_Type = 'text/plain' ) ) req <- Request$new(fake_rook) # Get full URL req$url # Get list of query parameters req$query # Test if content is text req$is('txt') # Perform content negotiation for the response req$accepts(c('html', 'json', 'txt')) # Cleaning up connections rm(fake_rook, req) gc()
fake_rook <- fiery::fake_request( 'http://example.com/test?id=34632&question=who+is+hadley', content = 'This is an elaborate ruse', headers = list( Accept = 'application/json; text/*', Content_Type = 'text/plain' ) ) req <- Request$new(fake_rook) # Get full URL req$url # Get list of query parameters req$query # Test if content is text req$is('txt') # Perform content negotiation for the response req$accepts(c('html', 'json', 'txt')) # Cleaning up connections rm(fake_rook, req) gc()
This class handles all functionality involved in crafting a http response.
Much of the functionality is inspired by the Request class in Express.js, so
the documentation for this will
complement this document. As reqres
is build on top of the
Rook specifications
the Response
object can be converted to a compliant list object to be
passed on to e.g. the httpuv
handler. A Response
object is always created
as a response to a Request
object and contains a reference to the
originating Request
object. A Response
is always initialized with a
404 Not Found code, an empty string as body and the Content-Type
header set
to text/plain
. As the Content-Type
header is required for httpuv
to
function, it will be inferred if missing when converting to a list. If the
body is a raw vector it will be set to application/octet-stream
and
otherwise it will be set to text/plain
. It is always advised to consciously
set the Content-Type
header though. The only exception is when attaching a
standard file where the type is inferred from the file extension
automatically. Unless the body is a raw vector it will automatically be
converted to a character vector and collapsed to a single string with "\n"
separating the individual elements before the Response
object is converted
to a list (that is, the body can exist as any type of object up until the
moment where the Response
object is converted to a list). To facilitate
communication between different middleware the Response
object contains
a data store where information can be stored during the lifetime of the
response.
## S3 method for class 'Response' as.list(x, ...) is.Response(x)
## S3 method for class 'Response' as.list(x, ...) is.Response(x)
x |
A |
... |
Ignored |
A rook-compliant list-response (in case of as.list()
) or a logical
indicating whether the object is a Response
(in case of is.Response()
)
A new 'Response'-object is initialized using the new()
method on the
generator:
Usage
res <- Response$new(request)
|
But often it will be provided by the request using the respond()
method,
which will provide the response, creating one if it doesn't exist
Usage
res <- request$respond()
|
Arguments
request |
The Request object that the Response is responding to |
|
The following fields are accessible in a Response
object:
status
Gets or sets the status code of the response. Is initialised
with 404L
body
Set or get he body of the response. If it is a character
vector with a single element named 'file'
it will be interpreted as the
location of a file. It is better to use the file
field for creating a
response referencing a file as it will automatically set the correct
headers.
file
Set or get the location of a file that should be used as the
body of the response. If the body is not referencing a file (but contains
something else) it will return NULL
. The Content-Type
header will
automatically be inferred from the file extension, if known. If unknown it
will defaults to application/octet-stream
. If the file has no extension it
will be text/plain
. Existence of the file will be checked.
type
Get or sets the Content-Type
header of the response based on
a file extension or mime-type.
request
Get the original Request
object that the object is
responding to.
status
Gets or sets the status code of the response. Is
initialised with 404L
body
Set or get he body of the response. If it is a character
vector with a single element named 'file'
it will be interpreted as the
location of a file. It is better to use the file
field for creating a
response referencing a file as it will automatically set the correct
headers.
file
Set or get the location of a file that should be used as the
body of the response. If the body is not referencing a file (but contains
something else) it will return NULL
. The Content-Type
header will
automatically be inferred from the file extension, if known. If unknown
it will defaults to application/octet-stream
. If the file has no
extension it will be text/plain
. Existence of the file will be checked.
type
Get or sets the Content-Type
header of the response based
on a file extension or mime-type.
request
Get the original Request
object that the object is
responding to.
formatter
Get the registered formatter for the response body.
is_formatted
Has the body been formatted
data_store
Access the environment that holds the response data store
session
The content of the session cookie. If session cookies has
not been activated it will be an empty write-protected list. If session
cookies are activated but the request did not contain one it will be an
empty list. The content of this field will be send encrypted as part of
the response according to the cookie settings in
$session_cookie_settings
. This field is reflected in the
Request$session
field and using either produces the same result
session_cookie_settings
Get the settings for the session cookie as they were provided during initialisation of the request cookie Immutable
has_key
Query whether the request was initialised with an encryption key Immutable
new()
Create a new response from a Request object
Response$new(request)
request
The Request
object that the Response
is responding to
print()
Pretty printing of the object
Response$print(...)
...
ignored
set_header()
Sets the header given by name
. value
will be converted
to character. A header will be added for each element in value
. Use
append_header()
for setting headers without overwriting existing ones.
Response$set_header(name, value)
name
The name of the header to set
value
The value to assign to the header
get_header()
Returns the header(s) given by name
Response$get_header(name)
name
The name of the header to retrieve the value for
remove_header()
Removes all headers given by name
Response$remove_header(name)
name
The name of the header to remove
has_header()
Test for the existence of any header given by name
Response$has_header(name)
name
The name of the header to look for
append_header()
Adds an additional header given by name
with the value
given by value
. If the header does not exist yet it will be created.
Response$append_header(name, value)
name
The name of the header to append to
value
The value to assign to the header
set_data()
Adds value
to the internal data store and stores it with
key
Response$set_data(key, value)
key
The identifier of the data you set
value
An R object
get_data()
Retrieves the data stored under key
in the internal data
store.
Response$get_data(key)
key
The identifier of the data you wish to retrieve
remove_data()
Removes the data stored under key
in the internal data
store.
Response$remove_data(key)
key
The identifier of the data you wish to remove
has_data()
Queries whether the data store has an entry given by key
Response$has_data(key)
key
The identifier of the data you wish to look for
timestamp()
Set the Date
header to the current time
Response$timestamp()
attach()
Sets the body to the file given by file
and marks the
response as a download by setting the Content-Disposition
to
attachment; filename=<filename>
. Use the type
argument to overwrite
the automatic type inference from the file extension.
Response$attach(file, filename = basename(file), type = NULL)
file
The path to a file
filename
The name of the file as it will appear to the client
type
The file type. If not given it will be inferred
as_download()
Marks the response as a downloadable file, rather than data to be shown in the browser
Response$as_download(filename = NULL)
filename
Optional filename as hint for the client
status_with_text()
Sets the status to code
and sets the body to the
associated status code description (e.g. Bad Gateway
for 502L
)
Response$status_with_text(code, clear_headers = FALSE)
code
The status code to set
clear_headers
Should all currently set headers be cleared (useful for converting a response to an error halfway through processing)
problem()
Signals an API problem using the HTTP Problems spec RFC 9457. This should only be used in cases where returning a bare response code is insufficient to describe the issue.
Response$problem( code, detail, title = NULL, type = NULL, instance = NULL, clear_headers = TRUE )
code
The HTTP status code to use
detail
A string detailing the problem. Make sure the information given does not pose a security risk
title
A human-readable title of the issue. Should not vary from
instance to instance of the specific issue. If NULL
then the status
code title is used
type
A URI that uniquely identifies this type of problem. The URI
must resolve to an HTTP document describing the problem in human readable
text. If NULL
, the most recent link to the given status code definition
is used
instance
A unique identifier of the specific instance of this problem that can be used for further debugging. Can be omitted.
clear_headers
Should all currently set headers be cleared
set_cookie()
Sets a cookie on the response. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie for a longer description
Response$set_cookie( name, value, encode = TRUE, expires = NULL, http_only = NULL, max_age = NULL, path = NULL, secure = NULL, same_site = NULL )
name
The name of the cookie
value
The value of the cookie
encode
Should value
be url encoded
expires
A POSIXct object given the expiration time of the cookie
http_only
Should the cookie only be readable by the browser
max_age
The number of seconds to elapse before the cookie expires
path
The URL path this cookie is related to
secure
Should the cookie only be send over https
same_site
Either "Lax"
, "Strict"
, or "None"
indicating
how the cookie can be send during cross-site requests. If this is set to
"None"
then secure
must also be set to TRUE
remove_cookie()
Removes the cookie named name
from the response.
Response$remove_cookie(name)
name
The name of the cookie to remove
clear_cookie()
Request the client to delete the given cookie
Response$clear_cookie(name)
name
The name of the cookie to delete
has_cookie()
Queries whether the response contains a cookie named name
Response$has_cookie(name)
name
The name of the cookie to look for
set_links()
Sets the Link
header based on the named arguments passed
to ...
. The names will be used for the rel
directive.
Response$set_links(...)
...
key-value pairs for the links
format()
Based on the formatters passed in through ...
content
negotiation is performed with the request and the preferred formatter is
chosen and applied. The Content-Type
header is set automatically. If
compress = TRUE
the compress()
method will be called after formatting.
If an error is encountered and autofail = TRUE
the response will be set
to 500
. If a formatter is not found and autofail = TRUE
the response
will be set to 406
. If formatting is successful it will return TRUE
,
if not it will return FALSE
Response$format(..., autofail = TRUE, compress = TRUE, default = NULL)
...
A range of formatters
autofail
Automatically populate the response if formatting fails
compress
Should $compress()
be run in the end
default
The name of the default formatter, which will be used if none match. Setting this will avoid autofailing with 406 as a formatter is always selected
set_formatter()
Based on the formatters passed in through ...
content
negotiation is performed with the request and the preferred formatter is
chosen. The Content-Type
header is set automatically. If a formatter is
not found and autofail = TRUE
the response will be set to 406
. The
found formatter is registered with the response and will be applied just
before handing off the response to httpuv, unless the response has been
manually formatted.
Response$set_formatter(..., autofail = TRUE, default = NULL)
...
A range of formatters
autofail
Automatically populate the response if formatting fails
default
The name of the default formatter, which will be used if none match. Setting this will avoid autofailing with 406 as a formatter is always selected
compress()
Based on the provided priority, an encoding is negotiated
with the request and applied. The Content-Encoding
header is set to the
chosen compression algorithm.
Response$compress( priority = c("gzip", "deflate", "br", "identity"), force = FALSE )
priority
A vector of compression types ranked by the servers priority
force
Should compression be done even if the type is known to be uncompressible
content_length()
Calculates the length (in bytes) of the body. This is the
number that goes into the Content-Length
header. Note that the
Content-Length
header is set automatically by httpuv
so this method
should only be called if the response size is needed for other reasons.
Response$content_length()
as_list()
Converts the object to a list for further processing by
a Rook compliant server such as httpuv
. Will set Content-Type
header
if missing and convert a non-raw body to a single character string. Will
apply the formatter set by set_formatter()
unless the body has already
been formatted. Will add a Date header if none exist.
Response$as_list()
as_message()
Prints a HTTP representation of the response to the output stream.
Response$as_message()
encode_string()
base64-encode a string. If a key has been provided during
initialisation the string is first encrypted and the final result is a
combination of the encrypted text and the nonce, both base64 encoded and
combined with a "_"
.
Response$encode_string(val)
val
A single string to encrypt
decode_string()
base64-decodes a string. If a key has been provided during
initialisation the input is first split by "_"
and then the two parts
are base64 decoded and decrypted. Otherwise the input is base64-decoded
as-is. It will always hold that
val == decode_string(encode_string(val))
.
Response$decode_string(val)
val
A single string to encrypt
clone()
The objects of this class are cloneable with this method.
Response$clone(deep = FALSE)
deep
Whether to make a deep clone.
Request
for handling http requests
fake_rook <- fiery::fake_request( 'http://example.com/test?id=34632&question=who+is+hadley', content = 'This is elaborate ruse', headers = list( Accept = 'application/json; text/*', Content_Type = 'text/plain' ) ) req <- Request$new(fake_rook) res <- Response$new(req) res # Set the body to the associated status text res$status_with_text(200L) res$body # Infer Content-Type from file extension res$type <- 'json' res$type # Prepare a file for download res$attach(system.file('DESCRIPTION', package = 'reqres')) res$type res$body res$get_header('Content-Disposition') # Cleaning up connections rm(fake_rook, req, res) gc()
fake_rook <- fiery::fake_request( 'http://example.com/test?id=34632&question=who+is+hadley', content = 'This is elaborate ruse', headers = list( Accept = 'application/json; text/*', Content_Type = 'text/plain' ) ) req <- Request$new(fake_rook) res <- Response$new(req) res # Set the body to the associated status text res$status_with_text(200L) res$body # Infer Content-Type from file extension res$type <- 'json' res$type # Prepare a file for download res$attach(system.file('DESCRIPTION', package = 'reqres')) res$type res$body res$get_header('Content-Disposition') # Cleaning up connections rm(fake_rook, req, res) gc()
A session cookie is just like any other cookie, but reqres treats this one
different, parsing it's value and making it available in the $session
field. However, the same settings as any other cookies applies and can be
given during request initialisation using this function.
session_cookie( name = "reqres", expires = NULL, max_age = NULL, path = NULL, secure = NULL, same_site = NULL ) is_session_cookie_settings(x)
session_cookie( name = "reqres", expires = NULL, max_age = NULL, path = NULL, secure = NULL, same_site = NULL ) is_session_cookie_settings(x)
name |
The name of the cookie |
expires |
A POSIXct object given the expiration time of the cookie |
max_age |
The number of seconds to elapse before the cookie expires |
path |
The URL path this cookie is related to |
secure |
Should the cookie only be send over https |
same_site |
Either |
x |
An object to test |
A session_cookie_settings
object that can be used during request
initialisation. Can be cached and reused for all requests in a server
As opposed to regular cookies the session cookie is forced to be HTTP only which is why this argument is missing.
session_cookie <- session_cookie() rook <- fiery::fake_request("http://example.com") # A key must be provided for session_cookie to be used Request$new(rook, key = random_key(), session_cookie = session_cookie)
session_cookie <- session_cookie() rook <- fiery::fake_request("http://example.com") # A key must be provided for session_cookie to be used Request$new(rook, key = random_key(), session_cookie = session_cookie)
Dates/times in HTTP headers needs a specific format to be valid, and is furthermore always given in GMT time. These two functions aids in converting back and forth between the required format.
to_http_date(time, format = NULL) from_http_date(time)
to_http_date(time, format = NULL) from_http_date(time)
time |
A string or an object coercible to POSIXct |
format |
In case |
to_http_date()
returns a properly formatted string, while
from_http_date()
returns a POSIXct object
time <- to_http_date(Sys.time()) time from_http_date(time)
time <- to_http_date(Sys.time()) time from_http_date(time)