From b9a59111ebcc2f2d8a901757b6e0640f1eb5c5ac Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Thu, 27 Jun 2019 16:29:38 -0700 Subject: [PATCH] fix some spelling --- codemeta.json | 2 +- .../articles/best-practices-api-packages.html | 4 +- docs/articles/curl-options.html | 4 +- docs/index.html | 4 +- docs/news/index.html | 99 +++++++++++-------- docs/reference/HttpClient.html | 2 +- docs/reference/HttpRequest.html | 2 +- docs/reference/crul-options.html | 4 +- inst/vign/curl-options.Rmd | 4 +- inst/vign/curl-options.md | 4 +- man-roxygen/args.R | 2 +- man/HttpClient.Rd | 2 +- man/HttpRequest.Rd | 2 +- vignettes/best-practices-api-packages.Rmd | 4 +- vignettes/curl-options.Rmd | 4 +- 15 files changed, 82 insertions(+), 61 deletions(-) diff --git a/codemeta.json b/codemeta.json index 62aee40..93e808c 100644 --- a/codemeta.json +++ b/codemeta.json @@ -179,7 +179,7 @@ "developmentStatus": "active", "releaseNotes": "https://github.com/ropensci/crul/blob/master/NEWS.md", "readme": "https://github.com/ropensci/crul/blob/master/README.md", - "fileSize": "74.829KB", + "fileSize": "75.019KB", "relatedLink": [ "https://ropenscilabs.github.io/http-testing-book/" ], diff --git a/docs/articles/best-practices-api-packages.html b/docs/articles/best-practices-api-packages.html index 5f3eafc..a3bdb1f 100644 --- a/docs/articles/best-practices-api-packages.html +++ b/docs/articles/best-practices-api-packages.html @@ -163,9 +163,9 @@

webmockr is a package for stubbing and setting expectations on HTTP requests. It has support for working with two HTTP request packages: crul and httr.

There are a variety of use cases for webmockr.

diff --git a/docs/articles/curl-options.html b/docs/articles/curl-options.html index 006e91b..590012c 100644 --- a/docs/articles/curl-options.html +++ b/docs/articles/curl-options.html @@ -114,7 +114,7 @@

adapted in part from a blog post I wrote Curling - exploring web request options

-

Most times you request data from the web, you should have no problem. However, you evenutally will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the advanced stuff category.

+

Most times you request data from the web, you should have no problem. However, you eventually will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the advanced stuff category.

Requests to web resources are served over the http protocol via curl. curl is a command line tool and library for transferring data with URL syntax, supporting (lots of protocols) . curl has many options that you may not know about.

I’ll go over some of the common and less commonly used curl options, and try to explain why you may want to use some of them.

@@ -330,7 +330,7 @@

proxies

-

When behind a proxy, give authentiction details for your proxy.

+

When behind a proxy, give authentication details for your proxy.

relevant commands:

ropensci_footer

diff --git a/docs/news/index.html b/docs/news/index.html index 6cf005f..8c590bd 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -129,21 +129,41 @@

Changelog

Source: NEWS.md -
+

-crul 0.7.4 2019-03-28 +crul 0.8.0 Unreleased

NEW FEATURES

    -
  • event hooks added to HttpClient. both request and response hooks supported. not supported in async methods for now (#76) (#107)
    • +
  • you can now pass on parameters through the parse() method of an HttpResponse class to the internally called function iconv() to finely control the usage of iconv for cases in which normal encoding conversion doesn’t work (#110)

MINOR IMPROVEMENTS

    +
  • use httpcode package instead of fauxpas package within ok() function (#108) (#109) thanks @maelle !
    • +
  • fix links to http testing book - ropensci -> ropenscilabs (#111)
    • +
+
+
+
+

+crul 0.7.4 2019-03-28 +

+
+

+NEW FEATURES

+
    +
  • event hooks added to HttpClient. both request and response hooks supported. not supported in async methods for now (#76) (#107)
    • +
+
+
+

+MINOR IMPROVEMENTS

+
  • improve $parse() behavior (in the HttpResponse object) when using disk or stream. $parse() was throwing a warning when using disk and an error when using stream. and improves behavior when doing async requests (#104)
  • Paginator gains optional progress bar through the new progress parameter. In addition, the cat() calls inside the method were removed, so as not to insert newlines with each page and to not print “OK” when done (#106) thanks @boshek
    • @@ -162,9 +182,9 @@

    crul 0.7.0 2019-01-04

    -
    +

    -NEW FEATURES

    +NEW FEATURES
    • HttpClient gains a retry method: retries any request verb until successful (HTTP response status < 400) or a condition for giving up is met. (#89) (#95) thanks @hlapp
      • @@ -198,9 +218,9 @@

      crul 0.6.0 2018-07-10

      -
      +

      -NEW FEATURES

      +NEW FEATURES
      -
      +

      -MINOR IMPROVEMENTS

      +MINOR IMPROVEMENTS
      • explicitly import httpcode::http_code (#80)
      • fix vignette names to make them more clear and add numbers to order them (#64)
        • @@ -227,9 +247,9 @@

        crul 0.5.2 2018-02-24

        -
        +

        -MINOR IMPROVEMENTS

        +MINOR IMPROVEMENTS
        • Fixed handling of user agent: you can pass a UA string as a curl option or a header. Previously, we were wrongly overwriting the user input UA if given as a curl option - but were not doing so if given as a header. This is fixed now. (#63) thx to @maelle and @dpprdan
        @@ -247,17 +267,17 @@

        crul 0.5.0 2018-01-22

        -
        +

        -NEW FEATURES

        +NEW FEATURES
        • Gains a new R6 class Paginator to help users automatically paginate through multiple requests. It only supports query parameter based paginating for now. We’ll add support later for other types including cursors (e.g., used in Solr servers), and for link headers (e.g., used in the GitHub API). Please get in touch if you find any problems with Paginator. (#56)
        • Async classes Async and Asyncvaried gain ability to write to disk and stream data (to disk or elsewhere, e.g. R console or to an R object) (#46) thanks @artemklevtsov for the push to do this
        -
        +

        -MINOR IMPROVEMENTS

        +MINOR IMPROVEMENTS
        • Improved documentation for auth to indicate that user and pwd are indeed required - and to further indicate that one can pass in NULL to those parameters (similar to an empty string "" in httr::authenticate) when one e.g. may want to use gssnegotiate method (#43)
        • Fixed query builder so that one can now protect query parameters by wrapping them in I() (#55)
          • @@ -275,16 +295,16 @@

          crul 0.4.0 2017-10-02

          -
          +

          -NEW FEATURES

          +NEW FEATURES
          • file uploads now work, see new function upload() and examples (#25)
          -
          +

          -MINOR IMPROVEMENTS

          +MINOR IMPROVEMENTS
          • fixes to reused curl handles - within a connection object only, not across connection objects (#45)
          • @@ -314,18 +334,18 @@

            • Note: This version gains support for integration with webmockr, which is now on CRAN.
            -
            +

            -NEW FEATURES

            +NEW FEATURES

            • New function auth() to do simple authentication (#33)
            • New function HttpStubbedResponse for making a stubbed response object for the webmockr integration (#4)
            • New function mock() to turn on mocking - it’s off by default. If webmockr is not installed but user attempts to use mocking we error with message to install webmockr (#4)
          -
          +

          -MINOR IMPROVEMENTS

          +MINOR IMPROVEMENTS
          • Use gzip-deflate by deafult for each request to make sure gzip compression is used if the server can do it (#34)
          • Change useragent to User-Agent as default user agent header (#35)
            • @@ -337,16 +357,16 @@

            crul 0.3.4 2017-03-31

            -
            +

            -NEW FEATURES

            +NEW FEATURES
            • New utility functions url_build and url_parse (#31)
            -
            +

            -MINOR IMPROVEMENTS

            +MINOR IMPROVEMENTS
            • Now using markdown for documentation (#32)
            • Better documentation for AsyncVaried (#30)
              • @@ -368,17 +388,17 @@

              crul 0.3.0 2017-02-17

              -
              +

              -NEW FEATURES

              +NEW FEATURES
              • Added support for asynchronous HTTP requests, including two new R6 classes: Async and AsyncVaried. The former being a simpler interface treating all URLs with same options/HTTP method, and the latter allowing any type of request through the new R6 class HttpRequest (#8) (#24)
              • New R6 class HttpRequest to support AsyncVaried - this method only defines a request, but does not execute it. (#8)
              -
              +

              -MINOR IMPROVEMENTS

              +MINOR IMPROVEMENTS
              • Added support for proxies (#22)
              @@ -395,9 +415,9 @@

              crul 0.2.0 2017-01-03

              -
              +

              -MINOR IMPROVEMENTS

              +MINOR IMPROVEMENTS
              • Created new manual files for various tasks to document usage better (#19)
              • URL encode paths - should fix any bugs where spaces between words caused errors previously (#17)
                • @@ -412,9 +432,9 @@

                crul 0.1.6 2016-12-17

                -
                +

                -NEW FEATURES

                +NEW FEATURES
                • Improved options for using curl options. Can manually add to list of curl options or pass in via .... And we check that user doesn’t pass in prohibited options (curl package takes care of checking that options are valid) (#5)
                • Incorporated fauxpas package for dealing with HTTP conditions. It’s a Suggest, so only used if installed (#6)
                  • @@ -422,9 +442,9 @@

                • Added support for streaming via curl::curl_fetch_disk. disk param defaults to NULL (thus ignored), or pass in a path to write to disk instead of use memory. Only one of memory, streaming or disk allowed. (#12)

                -
                +

                -MINOR IMPROVEMENTS

                +MINOR IMPROVEMENTS
                • Added missing raise_for_status() method on the HttpResponse class (#10)
                @@ -442,9 +462,9 @@

                crul 0.1.0 2016-11-09

                -
                +

                -NEW FEATURES

                +NEW FEATURES
                • Released to CRAN.
                @@ -456,6 +476,7 @@

                Contents

                  +
                • 0.8.0
                • 0.7.4
                • 0.7.0
                • 0.6.0
                  • diff --git a/docs/reference/HttpClient.html b/docs/reference/HttpClient.html index 27b8ae6..3d56659 100644 --- a/docs/reference/HttpClient.html +++ b/docs/reference/HttpClient.html @@ -173,7 +173,7 @@

                  Arg progress

                  a function with logic for printing a progress -bar for an HTTP request, ultimiately passed down to curl. +bar for an HTTP request, ultimately passed down to curl. only supports httr::progress() for now

                  diff --git a/docs/reference/HttpRequest.html b/docs/reference/HttpRequest.html index fdfe371..91ce15e 100644 --- a/docs/reference/HttpRequest.html +++ b/docs/reference/HttpRequest.html @@ -173,7 +173,7 @@

                  Arg progress

                  a function with logic for printing a progress -bar for an HTTP request, ultimiately passed down to curl. +bar for an HTTP request, ultimately passed down to curl. only supports httr::progress() for now

                  diff --git a/docs/reference/crul-options.html b/docs/reference/crul-options.html index 4468c7b..059ad18 100644 --- a/docs/reference/crul-options.html +++ b/docs/reference/crul-options.html @@ -244,7 +244,7 @@

                  Examp #> access-control-allow-origin: * #> content-encoding: gzip #> content-type: application/json -#> date: Thu, 27 Jun 2019 21:40:09 GMT +#> date: Thu, 27 Jun 2019 23:29:13 GMT #> referrer-policy: no-referrer-when-downgrade #> server: nginx #> x-content-type-options: nosniff @@ -266,7 +266,7 @@

                  Examp #> access-control-allow-origin: * #> content-encoding: gzip #> content-type: application/json -#> date: Thu, 27 Jun 2019 21:40:09 GMT +#> date: Thu, 27 Jun 2019 23:29:13 GMT #> referrer-policy: no-referrer-when-downgrade #> server: nginx #> x-content-type-options: nosniff diff --git a/inst/vign/curl-options.Rmd b/inst/vign/curl-options.Rmd index b562dbf..2c0f898 100644 --- a/inst/vign/curl-options.Rmd +++ b/inst/vign/curl-options.Rmd @@ -19,7 +19,7 @@ curl options > adapted in part from a blog post I wrote [Curling - exploring web request options][post] -Most times you request data from the web, you should have no problem. However, you evenutally will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the _advanced stuff_ category. +Most times you request data from the web, you should have no problem. However, you eventually will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the _advanced stuff_ category. Requests to web resources are served over the `http` protocol via [curl][]. `curl` _is a command line tool and library for transferring data with URL syntax, supporting (lots of protocols)_ . `curl` has many options that you may not know about. @@ -280,7 +280,7 @@ _Why use this?_ As you could imagine, this is increasingly useful as a request f ## proxies -> When behind a proxy, give authentiction details for your proxy. +> When behind a proxy, give authentication details for your proxy. relevant commands: diff --git a/inst/vign/curl-options.md b/inst/vign/curl-options.md index 8f31c17..9b3225b 100644 --- a/inst/vign/curl-options.md +++ b/inst/vign/curl-options.md @@ -12,7 +12,7 @@ curl options > adapted in part from a blog post I wrote [Curling - exploring web request options][post] -Most times you request data from the web, you should have no problem. However, you evenutally will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the _advanced stuff_ category. +Most times you request data from the web, you should have no problem. However, you eventually will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the _advanced stuff_ category. Requests to web resources are served over the `http` protocol via [curl][]. `curl` _is a command line tool and library for transferring data with URL syntax, supporting (lots of protocols)_ . `curl` has many options that you may not know about. @@ -273,7 +273,7 @@ _Why use this?_ As you could imagine, this is increasingly useful as a request f ## proxies -> When behind a proxy, give authentiction details for your proxy. +> When behind a proxy, give authentication details for your proxy. relevant commands: diff --git a/man-roxygen/args.R b/man-roxygen/args.R index abc0aff..b6a3aa7 100644 --- a/man-roxygen/args.R +++ b/man-roxygen/args.R @@ -8,7 +8,7 @@ #' @param headers (list) a named list of headers #' @param handle A handle, see \code{\link{handle}} #' @param progress a function with logic for printing a progress -#' bar for an HTTP request, ultimiately passed down to \pkg{curl}. +#' bar for an HTTP request, ultimately passed down to \pkg{curl}. #' only supports httr::progress() for now #' @param hooks (list) a named list (accepts: request, response) of functions #' (callbacks) to run on request and response objects. See [hooks] for more diff --git a/man/HttpClient.Rd b/man/HttpClient.Rd index 0c434c9..e758d1b 100644 --- a/man/HttpClient.Rd +++ b/man/HttpClient.Rd @@ -21,7 +21,7 @@ e.g. \code{auth(user = "foo", pwd = "bar")}} \item{handle}{A handle, see \code{\link{handle}}} \item{progress}{a function with logic for printing a progress -bar for an HTTP request, ultimiately passed down to \pkg{curl}. +bar for an HTTP request, ultimately passed down to \pkg{curl}. only supports httr::progress() for now} \item{hooks}{(list) a named list (accepts: request, response) of functions diff --git a/man/HttpRequest.Rd b/man/HttpRequest.Rd index b9ecaa6..bbfd0fd 100644 --- a/man/HttpRequest.Rd +++ b/man/HttpRequest.Rd @@ -21,7 +21,7 @@ e.g. \code{auth(user = "foo", pwd = "bar")}} \item{handle}{A handle, see \code{\link{handle}}} \item{progress}{a function with logic for printing a progress -bar for an HTTP request, ultimiately passed down to \pkg{curl}. +bar for an HTTP request, ultimately passed down to \pkg{curl}. only supports httr::progress() for now} \item{hooks}{(list) a named list (accepts: request, response) of functions diff --git a/vignettes/best-practices-api-packages.Rmd b/vignettes/best-practices-api-packages.Rmd index 098487f..551b175 100644 --- a/vignettes/best-practices-api-packages.Rmd +++ b/vignettes/best-practices-api-packages.Rmd @@ -83,12 +83,12 @@ packages: [crul][] and [httr][]. There are a variety of use cases for `webmockr`. -* Use it in an interactive R sesssion where you're working +* Use it in an interactive R session where you're working on a project and want to mock HTTP requests and set certain responses. * You can be on a plane and still allow requests to work without an internet connection by setting a response to give back. * Test hard to test scenarios in your code or package. `webmockr` -allows you to give back exact reponses just as you describe and +allows you to give back exact responses just as you describe and even fail with certain HTTP conditions. Getting certain failures to happen with a remote server can sometimes be difficult. * Package test suite: you can use `webmockr` in a test suite, diff --git a/vignettes/curl-options.Rmd b/vignettes/curl-options.Rmd index 8f31c17..9b3225b 100644 --- a/vignettes/curl-options.Rmd +++ b/vignettes/curl-options.Rmd @@ -12,7 +12,7 @@ curl options > adapted in part from a blog post I wrote [Curling - exploring web request options][post] -Most times you request data from the web, you should have no problem. However, you evenutally will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the _advanced stuff_ category. +Most times you request data from the web, you should have no problem. However, you eventually will run into problems. In addition, there are advanced things you can do modifying requests to web resources that fall in the _advanced stuff_ category. Requests to web resources are served over the `http` protocol via [curl][]. `curl` _is a command line tool and library for transferring data with URL syntax, supporting (lots of protocols)_ . `curl` has many options that you may not know about. @@ -273,7 +273,7 @@ _Why use this?_ As you could imagine, this is increasingly useful as a request f ## proxies -> When behind a proxy, give authentiction details for your proxy. +> When behind a proxy, give authentication details for your proxy. relevant commands: