{"Package":"webmockr","Title":"Stubbing and Setting Expectations on 'HTTP' Requests","Description":"Stubbing and setting expectations on 'HTTP' requests.\nIncludes tools for stubbing 'HTTP' requests, including expected\nrequest conditions and response conditions. Match on\n'HTTP' method, query parameters, request body, headers and\nmore.","Version":"0.1.0","Authors@R":"person(\"Scott\", \"Chamberlain\", role = c(\"aut\", \"cre\"), email =\n\"myrmecocystus+r@gmail.com\")","License":"MIT + file LICENSE","URL":"https://github.com/ropensci/webmockr","BugReports":"https://github.com/ropensci/webmockr/issues","LazyData":"true","Imports":"curl, jsonlite, magrittr (>= 1.5), lazyeval (>= 0.2.0), R6 (>=\n2.1.3), urltools (>= 1.6.0)","Suggests":"roxygen2 (>= 6.0.1), testthat, crul (>= 0.3.4)","RoxygenNote":"6.0.1","NeedsCompilation":"no","Packaged":"2017-05-20 05:58:16 UTC; sacmac","Author":"Scott Chamberlain [aut, cre]","Maintainer":"Scott Chamberlain ","Repository":"CRAN","Date/Publication":"2017-05-20 07:09:44 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/webmockr_0.1.0.tar.gz","jsonAuthors":[{"name":"Scott Chamberlain","email":"myrmecocystus+r@gmail.com","maintainer":true}],"readme":"webmockr\n========\n\n\n\n[![Build Status](https://travis-ci.org/ropensci/webmockr.svg?branch=master)](https://travis-ci.org/ropensci/webmockr)\n[![codecov](https://codecov.io/gh/ropensci/webmockr/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/webmockr)\n\nR library for stubbing and setting expectations on HTTP requests.\n\nPort of the Ruby gem [webmock](https://github.com/bblimke/webmock)\n\n\n## Features\n\n* Stubbing HTTP requests at low http client lib level\n* Setting and verifying expectations on HTTP requests\n* Matching requests based on method, URI, headers and body\n* Support for `testthat` coming soon via [vcr](https://github.com/ropenscilabs/vcr)\n\n## Supported HTTP libraries\n\n* [crul](https://github.com/ropensci/crul)\n\n> more to come\n\n## Install\n\nfrom cran\n\n\n```r\ninstall.packages(\"webmockr\")\n```\n\nDev version\n\n\n```r\ndevtools::install_github(\"ropensci/webmockr\")\n```\n\n\n```r\nlibrary(webmockr)\n```\n\n## Turn on webmockr\n\n\n```r\nwebmockr::enable()\n#> CrulAdapter enabled!\n#> [1] TRUE\ncrul::mock()\n```\n\n## Outside a test framework\n\n\n```r\nlibrary(crul)\n```\n\n### Stubbed request based on uri only and with the default response\n\n\n```r\nstub_request(\"any\", \"https://httpbin.org/get\")\n#> \n#> method: any\n#> uri: https://httpbin.org/get\n#> with: \n#> query: \n#> body: \n#> request_headers: \n#> to_return: \n#> status: \n#> body: \n#> response_headers:\n```\n\n\n```r\nx <- HttpClient$new(url = \"https://httpbin.org\")\nx$get('get')\n#> $url\n#> $url$url\n#> [1] \"https://httpbin.org/get\"\n#> \n#> $url$handle\n#> (empty)\n#> \n#> \n#> $method\n#> [1] \"get\"\n#> \n#> $options\n#> $options$httpget\n#> [1] TRUE\n#> \n#> \n#> $headers\n#> $headers$`User-Agent`\n#> [1] \"libcurl/7.51.0 r-curl/2.6 crul/0.3.5.9313\"\n#> \n#> $headers$`Accept-Encoding`\n#> [1] \"gzip, deflate\"\n```\n\nset return objects\n\n\n```r\nstub_request(\"get\", \"https://httpbin.org/get\") %>%\n wi_th(\n query = list(hello = \"world\")) %>%\n to_return(status = 418)\n#> \n#> method: get\n#> uri: https://httpbin.org/get\n#> with: \n#> query: hello=world\n#> body: \n#> request_headers: \n#> to_return: \n#> status: 418\n#> body: \n#> response_headers:\n```\n\n\n```r\nx$get('get', query = list(hello = \"world\"))\n#> $url\n#> $url$url\n#> [1] \"https://httpbin.org/get?hello=world\"\n#> \n#> $url$handle\n#> (empty)\n#> \n#> \n#> $method\n#> [1] \"get\"\n#> \n#> $options\n#> $options$httpget\n#> [1] TRUE\n#> \n#> \n#> $headers\n#> $headers$`User-Agent`\n#> [1] \"libcurl/7.51.0 r-curl/2.6 crul/0.3.5.9313\"\n#> \n#> $headers$`Accept-Encoding`\n#> [1] \"gzip, deflate\"\n```\n\n### Stubbing requests based on method, uri and query params\n\n\n```r\nstub_request(\"get\", \"https://httpbin.org/get\") %>%\n wi_th(query = list(hello = \"world\"), \n headers = list('User-Agent' = 'libcurl/7.51.0 r-curl/2.6 crul/0.3.6', \n 'Accept-Encoding' = \"gzip, deflate\"))\n#> \n#> method: get\n#> uri: https://httpbin.org/get\n#> with: \n#> query: hello=world\n#> body: \n#> request_headers: User-Agent=libcurl/7.51.0 r-curl/2.6 crul/0.3.6, Accept-Encoding=gzip, deflate\n#> to_return: \n#> status: \n#> body: \n#> response_headers:\n```\n\n\n```r\nstub_registry()\n#> \n#> Registered Stubs\n#> any: https://httpbin.org/get \n#> get: https://httpbin.org/get?hello=world | to_return: with status 418 \n#> get: https://httpbin.org/get?hello=world with headers {\"User-Agent\":\"libcurl/7.51.0 r-curl/2.6 crul/0.3.6\",\"Accept-Encoding\":\"gzip, deflate\"}\n```\n\n\n```r\nx <- HttpClient$new(url = \"https://httpbin.org\")\nx$get('get', query = list(hello = \"world\"))\n#> $url\n#> $url$url\n#> [1] \"https://httpbin.org/get?hello=world\"\n#> \n#> $url$handle\n#> (empty)\n#> \n#> \n#> $method\n#> [1] \"get\"\n#> \n#> $options\n#> $options$httpget\n#> [1] TRUE\n#> \n#> \n#> $headers\n#> $headers$`User-Agent`\n#> [1] \"libcurl/7.51.0 r-curl/2.6 crul/0.3.5.9313\"\n#> \n#> $headers$`Accept-Encoding`\n#> [1] \"gzip, deflate\"\n```\n\n## Meta\n\n* Please [report any issues or bugs](https://github.com/ropensci/webmockr/issues).\n* License: MIT\n* Get citation information for `webmockr` in R doing `citation(package = 'webmockr')`\n* Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md).\nBy participating in this project you agree to abide by its terms.\n\n[![ropensci_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)"}

Description

Usage

Arguments

Value

See Also

Examples