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>).
An HTTP client, taking inspiration from Ruby's faraday and Python's
Package documentation: https://docs.ropensci.org/crul/
HttpClient- Main interface to making HTTP requests. Synchronous requests only.
HttpResponse- HTTP response object, used for all responses across the different clients.
Paginator- Auto-paginate through requests - supports a subset of all possible pagination scenarios - will fill out more scenarios soon
Async- Asynchronous HTTP requests - a simple interface for many URLS - whose interface is similar to
HttpClient- all URLs are treated the same.
AsyncVaried- Asynchronous HTTP requests - accepts any number of
HttpRequestobjects - with a different interface than
Asyncdue to the nature of handling requests with different HTTP methods, options, etc.
- set curl options globally:
set_headers(), and more
- Writing to disk and streaming: available with both synchronous requests as well as async requests
- Hooks on requests and responses are available in the
HttpClientmethod only, and allow you to trigger functions to run on requests or responses, or both. See
?hooksfor the details and examples
crulintegrates with webmockr to mock HTTP requests. Checkout the http testing book
- Test caching:
crulalso integrates with vcr to cache http requests/responses. Checkout the http testing book
Latest binaries from rOpenSci
install.packages("crul", repos = "https://dev.ropensci.org")
Dev version from GitHub
- Please report any issues or bugs.
- License: MIT
- Get citation information for
crulin R doing
citation(package = 'crul')
- Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
- Where does the package name come from? It was a play on "curl", the popular command line client.
- Where does the sticker design come from? The sticker idea arose from a tweet - crul is close (ish) to Krull, a 1980's movie with a "mystical five-pointed weapon". The association with Krull was not known before naming the package.
Functions in crul
|content-types||Working with content types|
|Async||Simple async client|
|cookies||Working with cookies|
|HttpResponse||Base HTTP response object|
|AsyncVaried||Async client for different request types|
|HttpRequest||HTTP request object|
|handle||Make a handle|
|verb-DELETE||HTTP verb info: DELETE|
|url_build||Build and parse URLs|
|crul-options||Set curl options, proxy, and basic auth|
|verb-HEAD||HTTP verb info: HEAD|
|verb-GET||HTTP verb info: GET|
|ok||check if a url is okay|
|http-headers||Working with HTTP headers|
|mock||Mocking HTTP requests|
|curl_verbose||curl verbose method|
|verb-POST||HTTP verb info: POST|
|verb-PATCH||HTTP verb info: PATCH|
|verb-PUT||HTTP verb info: PUT|
|writing-options||Writing data options|
Vignettes of crul
Last month downloads
|License||MIT + file LICENSE|
|URL||https://docs.ropensci.org/crul (website) https://github.com/ropensci/crul (devel) https://books.ropensci.org/http-testing/ (user manual)|
|X-schema.org-keywords||http, https, API, web-services, curl, download, libcurl, async, mocking, caching|
|Packaged||2020-07-30 21:22:31 UTC; sckott|
|Date/Publication||2020-07-30 21:50:03 UTC|
Include our badge in your README