crul-package

crul

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.haxx.se/libcurl>).

Scott Chamberlain

HTTP Client

crul-package function

<ul>
<li><code><a rd-options="=HttpClient" href="/link/HttpClient()?package=crul&version=0.5.0&to=%3DHttpClient" data-mini-rdoc="=HttpClient::HttpClient()">HttpClient()</a></code> - create a connection client, set all
your http options, make http requests</li>
<li><code><a rd-options="=HttpResponse" href="/link/HttpResponse()?package=crul&version=0.5.0&to=%3DHttpResponse" data-mini-rdoc="=HttpResponse::HttpResponse()">HttpResponse()</a></code> - mostly for internal use, handles
http responses</li>
<li><code><a rd-options="=Paginator" href="/link/Paginator()?package=crul&version=0.5.0&to=%3DPaginator" data-mini-rdoc="=Paginator::Paginator()">Paginator()</a></code> - auto-paginate through requests</li>
<li><code><a rd-options="=Async" href="/link/Async()?package=crul&version=0.5.0&to=%3DAsync" data-mini-rdoc="=Async::Async()">Async()</a></code> - asynchronous requests</li>
<li><code><a rd-options="=AsyncVaried" href="/link/AsyncVaried()?package=crul&version=0.5.0&to=%3DAsyncVaried" data-mini-rdoc="=AsyncVaried::AsyncVaried()">AsyncVaried()</a></code> - varied asynchronous requests</li>
<li><code><a rd-options="=HttpRequest" href="/link/HttpRequest()?package=crul&version=0.5.0&to=%3DHttpRequest" data-mini-rdoc="=HttpRequest::HttpRequest()">HttpRequest()</a></code> - generate an HTTP request, mostly for
use in building requests to be used in <code>Async</code> or <code>AsyncVaried</code></li>
<li><code><a rd-options="=mock" href="/link/mock()?package=crul&version=0.5.0&to=%3Dmock" data-mini-rdoc="=mock::mock()">mock()</a></code> - Turn on/off mocking, via <code>webmockr</code></li>
<li><code><a rd-options="=auth" href="/link/auth()?package=crul&version=0.5.0&to=%3Dauth" data-mini-rdoc="=auth::auth()">auth()</a></code> - Simple authentication helper</li>
<li><code><a rd-options="=proxy" href="/link/proxy()?package=crul&version=0.5.0&to=%3Dproxy" data-mini-rdoc="=proxy::proxy()">proxy()</a></code> - Proxy helper</li>
</ul>

Package API

We use <code>fauxpas</code> if you have it installed for handling HTTP
conditions but if it's not installed we use httpcode

HTTP conditions

Mocking HTTP requests is supported via the webmockr
package. See <a rd-options="" href="/link/mock?package=crul&version=0.5.0" data-mini-rdoc="crul::mock">mock</a> for guidance.

crul-package: HTTP R client

Description

Arguments

Package API

HTTP conditions

Mocking