-
Notifications
You must be signed in to change notification settings - Fork 33
/
README.Rmd
108 lines (85 loc) · 4.52 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "50%"
)
```
# gargle
<!-- badges: start -->
[](https://cran.r-project.org/package=gargle)
[](https://app.codecov.io/gh/r-lib/gargle?branch=main)
[](https://github.com/r-lib/gargle/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of gargle is to take some of the agonizing pain out of working with Google APIs. This includes functions and classes for handling common credential types and for preparing, executing, and processing HTTP requests.
The target user of gargle is an *R package author* who is wrapping one of the ~250 Google APIs listed in the [APIs Explorer](https://developers.google.com/apis-explorer). gargle aims to play roughly the same role as [Google's official client libraries](https://developers.google.com/api-client-library/), but for R. gargle may also be useful to useRs making direct calls to Google APIs, who are prepared to navigate the details of low-level API access.
gargle's functionality falls into two main domains:
* **Auth.** The `token_fetch()` function calls a series of concrete
credential-fetching functions to obtain a valid access token (or it quietly
dies trying).
- This covers explicit service accounts, application default credentials,
Google Compute Engine, (experimentally) workload identity federation, and
the standard OAuth2 browser flow.
- gargle offers the `Gargle2.0` class, which extends `httr::Token2.0`. It is
the default class for user OAuth 2.0 credentials. There are two main
differences from `httr::Token2.0`: greater emphasis on the user's email
(e.g. Google identity) and default token caching is at the user level.
* **Requests and responses**. A family of functions helps to prepare HTTP
requests, (possibly with reference to an API spec derived from a Discovery
Document), make requests, and process the response.
See the [articles](https://gargle.r-lib.org/articles/) for holistic advice on how to use gargle.
## Installation
You can install the released version of gargle from [CRAN](https://CRAN.R-project.org) with:
```{r eval = FALSE}
install.packages("gargle")
```
And the development version from [GitHub](https://github.com/) with:
```{r eval = FALSE}
# install.packages("pak")
pak::pak("r-lib/gargle")
```
## Basic usage
gargle is a low-level package and does not do anything visibly exciting on its own.
But here's a bit of usage in an interactive scenario where a user confirms they want to use a specific Google identity and loads an OAuth2 token.
```{r eval = FALSE}
library(gargle)
token <- token_fetch()
#> The gargle package is requesting access to your Google account.
#> Enter '1' to start a new auth process or select a pre-authorized account.
#> 1: Send me to the browser for a new auth process.
#> 2: [email protected]
#> 3: [email protected]
#> Selection: 2
token
#> ── <Token (via gargle)> ─────────────────────────────────────────────────────
#> oauth_endpoint: google
#> app: gargle-clio
#> email: [email protected]
#> scopes: ...userinfo.email
#> credentials: access_token, expires_in, refresh_token, scope, token_type, id_token
```
Here's an example of using request and response helpers to make a one-off request to the [Web Fonts Developer API](https://developers.google.com/fonts/docs/developer_api).
We show the most popular web font families served by Google Fonts.
```{r}
library(gargle)
req <- request_build(
method = "GET",
path = "webfonts/v1/webfonts",
params = list(
sort = "popularity"
),
key = gargle_api_key(),
base_url = "https://www.googleapis.com"
)
resp <- request_make(req)
out <- response_process(resp)
out <- out[["items"]][1:8]
sort(vapply(out, function(x) x[["family"]], character(1)))
```
Please note that the 'gargle' project is released with a [Contributor Code of Conduct](https://gargle.r-lib.org/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
[Privacy policy](https://www.tidyverse.org/google_privacy_policy)