update news and cran comments, and update readme, bump to v0.3

DESCRIPTION

@@ -6,7 +6,7 @@ Description: A simple HTTP client, with tools for making HTTP requests,
     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>).
-Version: 0.2.8.9100
+Version: 0.3.0
 License: MIT + file LICENSE
 Authors@R: c(
     person("Scott", "Chamberlain", role = c("aut", "cre"), 

NEWS.md

@@ -1,13 +1,34 @@
+crul 0.3.0
+==========
+
+### 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
+
+* Added support for proxies (#22)
+
+### BUG FIXES
+
+* Fixed parsing of headers from FTP servers (#21)
+
+
 crul 0.2.0
 ==========
 
 ### 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 
+* URL encode paths - should fix any bugs where spaces between words
 caused errors previously (#17)
-* URL encode query parameters - should fix any bugs where spaces between words 
+* URL encode query parameters - should fix any bugs where spaces between words
 caused errors previously (#11)
 * request headers now passed correctly to response object (#13)
 * response headers now parsed to a list for easier access (#14)
@@ -21,29 +42,29 @@ crul 0.1.6
 ### 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 
+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 
+* Incorporated `fauxpas` package for dealing with HTTP
 conditions. It's a Suggest, so only used if installed (#6)
-* Added support for streaming via `curl::curl_fetch_stream`. 
-`stream` param defaults to `NULL` (thus ignored), or pass in a 
-function to use streaming. Only one of memory, streaming or 
+* Added support for streaming via `curl::curl_fetch_stream`.
+`stream` param defaults to `NULL` (thus ignored), or pass in a
+function to use streaming. Only one of memory, streaming or
 disk allowed. (#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, 
+* 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
 
-* Added missing `raise_for_status()` method on the 
+* Added missing `raise_for_status()` method on the
 `HttpResponse` class (#10)
 
 ### BUG FIXES
 
-* Was importing `httpcode` but wasn't using it in the package. 
+* Was importing `httpcode` but wasn't using it in the package.
 Now using the package in `HttpResponse`
 
 

README.Rmd

@@ -18,11 +18,15 @@ An HTTP client, taking inspiration from Ruby's [faraday](https://rubygems.org/ge
 
 Package API:
 
-* `HttpClient` - xxx
-* `HttpResponse` - xxx
-* `HttpRequest` - xxx
-* `Async` - xxx
-* `AsyncVaried` - xxx
+* `HttpClient` - Main interface to making HTTP requests. Synchronous requests only.
+* `HttpResponse` - HTTP response object, used for all responses across the
+different clients.
+* `Async` - Asynchronous HTTP requests - a simple interface for many URLS -
+whose interface is similar to `HttpClient` - all URLs are treated the same.
+* `HttpRequest` - HTTP request object, used for `AsyncVaried`
+* `AsyncVaried` - Asynchronous HTTP requests - accepts any number of `HttpRequest`
+objects - with a different interface than `HttpClient`/`Async` due to the nature
+of handling requests with different HTTP methods, options, etc.
 
 ## Installation
 
@@ -138,18 +142,61 @@ jsonlite::fromJSON(res$parse())
 ```{r eval=FALSE}
 res <- HttpClient$new(url = "http://api.gbif.org/v1/occurrence/search")
 res$get(query = list(limit = 100), timeout_ms = 100)
-#> Error in curl::curl_fetch_memory(x$url$url, handle = x$url$handle) : 
+#> Error in curl::curl_fetch_memory(x$url$url, handle = x$url$handle) :
 #>   Timeout was reached
 ```
 
+## Asynchronous requests
+
+The simpler interface allows many requests (many URLs), but they all get the same
+options/headers, etc. and you have to use the same HTTP method on all of them:
+
+```{r}
+(cc <- Async$new(
+  urls = c(
+    'https://httpbin.org/',
+    'https://httpbin.org/get?a=5',
+    'https://httpbin.org/get?foo=bar'
+  )
+))
+res <- cc$get()
+lapply(res, function(z) z$parse("UTF-8"))
+```
+
+The `AsyncVaried` interface accepts any number of `HttpRequest` objects, which
+can define any type of HTTP request of any HTTP method:
+
+```{r}
+req1 <- HttpRequest$new(
+  url = "https://httpbin.org/get",
+  opts = list(verbose = TRUE),
+  headers = list(foo = "bar")
+)$get()
+req2 <- HttpRequest$new(url = "https://httpbin.org/post")$post()
+out <- AsyncVaried$new(req1, req2)
+```
+
+Execute the requests
+
+```{r}
+out$request()
+```
+
+Then functions get applied to all responses:
+
+```{r}
+out$status()
+out$parse()
+```
+
 ## TO DO
 
-### http caching 
+### http caching
 
 Add integration for:
 
 * [webmockr](https://github.com/ropensci/webmockr)
-* [vcr](https://github.com/ropensci/vcr) 
+* [vcr](https://github.com/ropensci/vcr)
 
 for flexible and easy HTTP request caching