byapparov/usegs

Allows to save Google Spreadsheet in the working directory

usegs

usegs package allows easy copy of Goolge Sheets to local project files. Acceptance files or other data where Google Sheet is source can be easiliy copied.

Installation

You can install usegs from github with:

# install.packages("devtools")
devtools::install_github("byapparov/usegs")

Example

This is a basic example which shows you how to save acceptance data into testthat data folder:

## This code ran in the working directory of package 
## will create files in `tests/testthat/data/{sheet-name}/` folder
use_gs_acceptance(
  x = "1bkoQYLYAVqgP4bCoqVe-yDB1mdX83cFtOqJ7q8GkT-w",
  extension = "csv"
)

You can also refresh data for all of your acceptance tests if you maintain .acceptance.yml file.

This file contains a simple structure that references Google Sheets and instructs how to save them locally:

# .acceptance.yml file in working directory of the project or package
acceptance_documents:
  - key: '1bkoQYLYAVqgP4bCoqVe-yDB1mdX83cFtOqJ7q8GkT-w' # Google Sheet key
    extension: csv # defines how data will be saved localy
    description: Accceptance file example 1 # you can add other fields for documentation purposes
    story: ST-100
    folder: order/tests

  - key: '2bkoQYLYAVqgP4bCoqVe-yDB1mdX83cFtOqJ7q8GkT-x'
    extension: json
    description: Accceptance file example 2
    story: ST-200

# Running this function will save data from all acceptance 
# Google Sheet files localy in 'tests/testthat/data/{doc title}/' folders
usegs::refresh_project_acceptance()

usegs's Issues

Too Many Requests (RFC 6585) (HTTP 429).

When trying to download several google sheets from a google spreadsheet, I get a HTTP 429 Error.
Some discussion on the issue: jennybc/googlesheets#214
Feels like a little Sys.sleep() would do the job?

Way to document data catalogue in code

library(httr)
url.base <- "https://raw.githubusercontent.com/{organisation}/{repository}/master/"
schema.path <- "purchase-order/schema/purchase-order.json"
url <- paste0(url.base, schema.path)
x <- GET(url, authenticate(Sys.getenv("GITHUB_PAT"), ""))
response <- content(x, as="text", type = "text", encoding = "UTF-8")
schema.table <- fromJSON(response)

# .catalogue

- purchase-order
  - file: schema/purchase-order.json
- sale-order-line
  - file: ...