crul-package() R function from [crul]

crul: HTTP Client

A simple HTTP client, with tools for making HTTP requests, and mocking HTTP requests. The package is built on R6, and takes inspiration from Ruby's 'faraday' gem (https://rubygems.org/gems/faraday). The package name is a play on curl, the widely used command line tool for HTTP, and this package is built on top of the R package 'curl', an interface to 'libcurl' (https://curl.se/libcurl/). package

Package API

HttpClient() - create a connection client, set all your http options, make http requests
HttpResponse() - mostly for internal use, handles http responses
Paginator() - auto-paginate through requests
Async() - asynchronous requests
AsyncVaried() - varied asynchronous requests
HttpRequest() - generate an HTTP request, mostly for use in building requests to be used in Async or AsyncVaried
mock() - Turn on/off mocking, via webmockr
auth() - Simple authentication helper
proxy() - Proxy helper
upload() - File upload helper
set curl options globally: set_auth(), set_headers(), set_opts(), set_proxy(), and crul_settings()

HTTP verbs (or HTTP request methods)

See verb-GET , verb-POST , verb-PUT , verb-PATCH , verb-DELETE , verb-HEAD for details.

HttpClient is the main interface for making HTTP requests, and includes methods for each HTTP verb
HttpRequest allows you to prepare a HTTP payload for use with AsyncVaried , which provides asynchronous requests for varied HTTP methods
Async provides asynchronous requests for a single HTTP method at a time
the verb() method can be used on all the above to request a specific HTTP verb

Checking HTTP responses

HttpResponse() has helpers for checking and raising warnings/errors.

content-types details the various options for checking content types and throwing a warning or error if the response content type doesn't match what you expect. Mis-matched content-types are typically a good sign of a bad response. There's methods built in for json, xml and html, with the ability to set any custom content type
raise_for_status() is a method on HttpResponse() that checks the HTTP status code, and errors with the appropriate message for the HTTP status code, optionally using the package fauxpas

if it's installed.