Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sckott/fauxpas
fauxpas does http errors
https://github.com/sckott/fauxpas
error-handling http r r-package rstats
Last synced: about 1 month ago
JSON representation
fauxpas does http errors
- Host: GitHub
- URL: https://github.com/sckott/fauxpas
- Owner: sckott
- License: other
- Created: 2016-04-13T20:33:33.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-14T18:42:11.000Z (about 1 year ago)
- Last Synced: 2024-11-01T21:51:02.549Z (about 1 month ago)
- Topics: error-handling, http, r, r-package, rstats
- Language: R
- Homepage: https://sckott.github.io/fauxpas
- Size: 284 KB
- Stars: 15
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - sckott/fauxpas - fauxpas does http errors (R)
README
fauxpas
=======
```{r echo=FALSE}
knitr::opts_chunk$set(
warning = FALSE,
message = FALSE,
collapse = TRUE,
comment = "#>",
eval = FALSE
)
```
[](https://github.com/sckott/fauxpas/actions/workflows/R-check.yml)
[](https://github.com/sckott/fauxpas)
[](https://cran.r-project.org/package=fauxpas)
[](https://github.com/r-hub/cranlogs.app)
`fauxpas` does http errors
* HTTP error classes more in line with Ruby/Python/Etc.
* An error class for each HTTP status in case a user wants to
be specific to an HTTP status code, and general purpose handlers
for any error
* Work with any of the major R http clients: `crul`, `curl`, `httr`, (maybe
`RCurl` later)
* Provide flexiblity for what to do on an HTTP error, including
custom functions and message templates
Info Links:
* HTTP on wikipedia:
* HTTP2 on wikipedia:
* HTTP/1.1:
* HTTP/2:
## Install
CRAN version
```{r}
install.packages("fauxpas")
```
Dev version
```{r}
remotes::install_github("sckott/fauxpas")
```
```{r}
library("fauxpas")
```
## use with crul
```{r}
library("crul")
cli <- HttpClient$new("https://httpbin.org/status/414")
res <- cli$get()
http(res)
#> Error: Request-URI Too Long (HTTP 414).
http414(res)
#> Error: Request-URI Too Long (HTTP 414).
```
```{r}
x <- HTTPRequestURITooLong$new()
x$do_verbose(res)
#> Error: Request-URI Too Long (HTTP 414).
#> - The server is refusing to service the request because the Request-URI is
#> longer than the server is willing to interpret. This rare condition is only likely
#> to occur when a client has improperly converted a POST request to a GET request
#> with long query information, when the client has descended into a URI black hole
#> of redirection (e.g., a redirected URI prefix that points to a suffix of itself),
#> or when the server is under attack by a client attempting to exploit security
#> holes present in some servers using fixed-length buffers for reading or
#> manipulating the Request-URI.
```
## use with curl
```{r}
library("curl")
h <- curl::new_handle()
curl::handle_setopt(h)
resp <- curl::curl_fetch_memory("https://httpbin.org/status/404", h)
http(resp)
#> Error: Not Found (HTTP 404).
http404(resp)
#> Error: Not Found (HTTP 404).
```
```{r}
x <- HTTPNotFound$new()
x$do_verbose(resp)
#> Error: Not Found (HTTP 404).
#> - The server has not found anything matching the Request-URI. No indication is
#> given of whether the condition is temporary or permanent. The 410 (Gone) status
#> code SHOULD be used if the server knows, through some internally configurable
#> mechanism, that an old resource is permanently unavailable and has no forwarding
#> address. #> This status code is commonly used when the server does not wish to
#> reveal exactly why the request has been refused, or when no other response is
#> applicable.
```
## use with httr
```{r}
library("httr")
res <- GET("https://httpbin.org/status/405")
http405(res)
#> Error: Method Not Allowed (HTTP 405).
```
```{r}
x <- HTTPMethodNotAllowed$new()
x$do_verbose(res)
#> Error: Method Not Allowed (HTTP 405).
#> - The method specified in the Request-Line is not allowed for the resource
#> identified by the Request-URI. The response MUST include an Allow header
#> containing a list of valid methods for the requested resource.
```
## Meta
* Please [report any issues or bugs](https://github.com/sckott/fauxpas/issues)
* License: MIT
* Get citation information for `fauxpas` in R doing `citation(package = 'fauxpas')`