fake_request: Create a fake request to use in testing

View source: R/fake_request.R

fake_requestR Documentation

Create a fake request to use in testing

Description

This function creates a new request for a specific resource defined by a URL. It mimics the format of the requests provided through httpuv, meaning that it can be used in place for the requests send to the before-request, request, and after-request handlers. This is only provided so that handlers can be tested without having to start up a server.

Usage

fake_request(
  url,
  method = "get",
  appLocation = "",
  content = "",
  headers = list(),
  ...
)

Arguments

url

A complete url for the resource the request should ask for

method

The request type (get, post, put, etc). Defaults to "get"

appLocation

A string giving the first part of the url path that should be stripped from the path

content

The content of the request, either a raw vector or a string

headers

A list of name-value pairs that defines the request headers

...

Additional name-value pairs that should be added to the request

Value

A Rook-compliant environment

Examples

req <- fake_request(
    'http://www.my-fake-website.com/path/to/a/query/?key=value&key2=value2',
    content = 'Some important content'
)

# Get the main address of the URL
req[['SERVER_NAME']]

# Get the query string
req[['QUERY_STRING']]

# ... etc.

# Cleaning up connections
rm(req)
gc()


fiery documentation built on March 31, 2023, 6:54 p.m.