doma_chaperon v0.3.2

View Source Chaperon.Action.HTTP (doma_chaperon v0.3.2)

HTTP based actions to be run in a Chaperon.Scenario module for a given Chaperon.Session.

This supports GET, POST, PUT, PATCH, DELETE & HEAD requests with support for optional headers & query params.

Link to this section Summary

Types

method()
options()
t()

Functions

add_options(action, opts)
delete(path, opts \\ [])
full_path(map)
full_url(action, session)
get(path, opts)
is_full_url?(arg1)
metrics_url(action, session)
options(action, session)
patch(path, opts)
post(path, opts)
put(path, opts)
query_params_string(params)
url(map, arg2)

Link to this section Types

Link to this type

method()

View Source 
@type method() :: :get | :post | :put | :patch | :delete | :head
Link to this type

options()

View Source 
@type options() :: [
  form: map() | Keyword.t(),
  json: map() | Keyword.t(),
  headers: map() | Keyword.t(),
  params: map() | Keyword.t(),
  decode: :json | (HTTPoison.Response.t() -> any()),
  with_result: Chaperon.Session.result_callback(),
  metrics_url: String.t()
]
Link to this type

t()

View Source 
@type t() :: %Chaperon.Action.HTTP{
  body: binary(),
  callback: Chaperon.Session.result_callback(),
  decode: :json | (HTTPoison.Response.t() -> any()),
  headers: map(),
  method: method(),
  metrics_url: String.t(),
  params: map(),
  path: String.t()
}

Link to this section Functions

Link to this function

add_options(action, opts)

View Source 
@spec add_options(any(), options()) :: t()
Link to this function

delete(path, opts \\ [])

View Source 
@spec delete(String.t(), options()) :: t()
Link to this function

full_path(map)

View Source
Link to this function

full_url(action, session)

View Source
Link to this function

get(path, opts)

View Source 
@spec get(String.t(), options()) :: t()
Link to this function

is_full_url?(arg1)

View Source
Link to this function

metrics_url(action, session)

View Source
Link to this function

options(action, session)

View Source
Link to this function

patch(path, opts)

View Source 
@spec patch(String.t(), options()) :: t()
Link to this function

post(path, opts)

View Source 
@spec post(String.t(), options()) :: t()
Link to this function

put(path, opts)

View Source 
@spec put(String.t(), options()) :: t()
Link to this function

query_params_string(params)

View Source
Link to this function

url(map, arg2)

View Source