RequestRegistry

keeps track of HTTP requests

See also

stub_registry() and StubRegistry

Other request-registry: HashCounter, request_registry()

Public fields

request_signatures

a HashCounter object

Methods

Public methods

• RequestRegistry$print()

• RequestRegistry$reset()

• RequestRegistry$register_request()

• RequestRegistry$times_executed()

• RequestRegistry$clone()

---

Method print()

print method for the RequestRegistry class

Usage

RequestRegistry$print(x, ...)

Arguments

x

self

...

ignored

---

Method reset()

Reset the registry to no registered requests

Usage

RequestRegistry$reset()

Returns

nothing returned; ressets registry to no requests

---

Method register_request()

Register a request

Usage

RequestRegistry$register_request(request)

Arguments

request

a character string of the request, serialized from a RequestSignature$new(...)$to_s()

Returns

nothing returned; registers the request

---

Method times_executed()

How many times has a request been made

Usage

RequestRegistry$times_executed(request_pattern)

Arguments

request_pattern

an object of class RequestPattern

Details

if no match is found for the request pattern, 0 is returned

Returns

integer, the number of times the request has been made

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RequestRegistry$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

x <- RequestRegistry$new()
z1 <- RequestSignature$new("get", "http://scottchamberlain.info")
z2 <- RequestSignature$new("post", "https://httpbin.org/post")
x$register_request(request = z1)
x$register_request(request = z1)
x$register_request(request = z2)
# print method to list requests
x
#> <webmockr request registry> 
#>  Registered Requests
#>   GET:  http://scottchamberlain.info was made 2 times
#> 
#>   POST:  https://httpbin.org/post was made 1 times
#> 

# more complex requests
w <- RequestSignature$new(
  method = "get",
  uri = "https:/httpbin.org/get",
  options = list(headers = list(`User-Agent` = "foobar", stuff = "things"))
)
w$to_s()
#> [1] "GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things}"
x$register_request(request = w)
x
#> <webmockr request registry> 
#>  Registered Requests
#>   GET:  http://scottchamberlain.info was made 2 times
#> 
#>   POST:  https://httpbin.org/post was made 1 times
#> 
#>   GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things} was made 1 times
#> 


# hashes, and number of times each requested
x$request_signatures$hash
#> $`GET:  http://scottchamberlain.info`
#> $`GET:  http://scottchamberlain.info`$key
#> [1] "GET:  http://scottchamberlain.info"
#> 
#> $`GET:  http://scottchamberlain.info`$sig
#> <RequestSignature> 
#>   method: GET
#>   uri: http://scottchamberlain.info
#> 
#> $`GET:  http://scottchamberlain.info`$count
#> [1] 2
#> 
#> 
#> $`POST:  https://httpbin.org/post`
#> $`POST:  https://httpbin.org/post`$key
#> [1] "POST:  https://httpbin.org/post"
#> 
#> $`POST:  https://httpbin.org/post`$sig
#> <RequestSignature> 
#>   method: POST
#>   uri: https://httpbin.org/post
#> 
#> $`POST:  https://httpbin.org/post`$count
#> [1] 1
#> 
#> 
#> $`GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things}`
#> $`GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things}`$key
#> [1] "GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things}"
#> 
#> $`GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things}`$sig
#> <RequestSignature> 
#>   method: GET
#>   uri: https:/httpbin.org/get
#>   headers: 
#>      User-Agent: foobar
#>      stuff: things
#> 
#> $`GET:  https:/httpbin.org/get   with headers {User-Agent: foobar, stuff: things}`$count
#> [1] 1
#> 
#> 

# times_executed method
pat <- RequestPattern$new(
  method = "get",
  uri = "https:/httpbin.org/get",
  headers = list(`User-Agent` = "foobar", stuff = "things")
)
pat$to_s()
#> [1] "GET http://https/httpbin.org%2Fget   with headers user-agent=\"foobar\", stuff=\"things\""
x$times_executed(pat)
#> [1] 1
z <- RequestPattern$new(method = "get", uri = "http://scottchamberlain.info")
x$times_executed(z)
#> [1] 2
w <- RequestPattern$new(method = "post", uri = "https://httpbin.org/post")
x$times_executed(w)
#> [1] 1

## pattern with no matches - returns 0 (zero)
pat <- RequestPattern$new(
  method = "get",
  uri = "http://recology.info/"
)
pat$to_s()
#> [1] "GET http://recology.info"
x$times_executed(pat)
#> [1] 0

# reset the request registry
x$reset()