Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document examples of path defined with params #127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document examples of path defined with params #127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions lib/bypass.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,17 +172,19 @@ defmodule Bypass do
def expect(%Bypass{pid: pid}, fun),
do: Bypass.Instance.call(pid, {:expect, fun})

@doc """
@doc ~S"""
Expects the passed function to be called at least once for the specified route (method and path).

- `method` is one of `["GET", "POST", "HEAD", "PUT", "PATCH", "DELETE", "OPTIONS", "CONNECT"]`

- `path` is the endpoint.
- `path` is the endpoint. It can also specify parameters which will then be available in the function body.

```elixir
Bypass.expect(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
Bypass.expect(bypass, "POST", "/1.1/:resource/statuses/update.json", fn conn ->
Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no + 1} end)
Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)

resource = conn.params["resource"]
Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit for #{resource} exceeded"}]}>)
end)
```
"""
Expand All @@ -205,35 +207,39 @@ defmodule Bypass do
def expect_once(%Bypass{pid: pid}, fun),
do: Bypass.Instance.call(pid, {:expect_once, fun})

@doc """
@doc ~S"""
Expects the passed function to be called exactly once for the specified route (method and path).

- `method` is one of `["GET", "POST", "HEAD", "PUT", "PATCH", "DELETE", "OPTIONS", "CONNECT"]`

- `path` is the endpoint.
- `path` is the endpoint. It can also specify parameters which will then be available in the function body.

```elixir
Bypass.expect_once(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
Bypass.expect_once(bypass, "POST", "/1.1/:resource/statuses/update.json", fn conn ->
Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no + 1} end)
Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)

resource = conn.params["resource"]
Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit for #{resource} exceeded"}]}>)
end)
```
"""
@spec expect_once(Bypass.t(), String.t(), String.t(), (Plug.Conn.t() -> Plug.Conn.t())) :: :ok
def expect_once(%Bypass{pid: pid}, method, path, fun),
do: Bypass.Instance.call(pid, {:expect_once, method, path, fun})

@doc """
@doc ~S"""
Allows the function to be invoked zero or many times for the specified route (method and path).

- `method` is one of `["GET", "POST", "HEAD", "PUT", "PATCH", "DELETE", "OPTIONS", "CONNECT"]`

- `path` is the endpoint.
- `path` is the endpoint. It can also specify parameters which will then be available in the function body.

```elixir
Bypass.stub(bypass, "POST", "/1.1/statuses/update.json", fn conn ->
Bypass.stub(bypass, "POST", "/1.1/:resource/statuses/update.json", fn conn ->
Agent.get_and_update(AgentModule, fn step_no -> {step_no, step_no + 1} end)
Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit exceeded"}]}>)

resource = conn.params["resource"]
Plug.Conn.resp(conn, 429, ~s<{"errors": [{"code": 88, "message": "Rate limit for #{resource} exceeded"}]}>)
end)
```
"""
Expand Down