Module bookish_spork

This is the main interface module.

Description

This is the main interface module

It provides basic functions for using library

Data Types

http_status()

http_status() = non_neg_integer()

stub_request_fun()

stub_request_fun() = fun((bookish_spork_request:t()) -> bookish_spork_response:response())

Function Index

capture_request/0
start_server/0Equivalent to start_server(32002).
start_server/1starts http server on a particular port.
stop_server/0stops http server.
stub_multi/2stub multiple requests with one response.
stub_request/0Equivalent to stub_request(204, #{<<"Server">> => <<"BookishSpork/0.0.1">>, <<"Date">> => <<"Sat, 28 Apr 2018 05:51:50 GMT">>}, <<>>).
stub_request/1stub request with fun or particular status.
stub_request/2stub request with particular status and content/headers.
stub_request/3

Function Details

capture_request/0

capture_request() -> {ok, Request::bookish_spork_request:t()} | {error, ErrorMessage::string()}

start_server/0

start_server() -> {ok, pid()} | {error, Error::term()}

Equivalent to start_server(32002).

start_server/1

start_server(Port::non_neg_integer()) -> {ok, pid()} | {error, Error::term()}

starts http server on a particular port

stop_server/0

stop_server() -> ok

stops http server

stub_multi/2

stub_multi(Response::stub_request_fun() | bookish_spork_response:response(), Times::non_neg_integer()) -> ok

stub multiple requests with one response

Response can be

See also: stub_request/1, bookish_spork_response:new/1.

stub_request/0

stub_request() -> ok

Equivalent to stub_request(204, #{<<"Server">> => <<"BookishSpork/0.0.1">>, <<"Date">> => <<"Sat, 28 Apr 2018 05:51:50 GMT">>}, <<>>).

stub_request/1

stub_request(Fun::stub_request_fun() | bookish_spork_response:response()) -> ok

stub request with fun or particular status

Fun must be fun((bookish_spork_request:t()) -> bookish_spork_response:response())

Example:

  bookish_spork:stub_request(fun(Request) ->
      case bookish_spork_request:uri(Request) of
          "/bookish/spork" ->
              [200, [], <<"Hello">>];
          "/admin/sporks" ->
              [403, [], <<"It is not possible here">>]
      end
  end)

stub_request/2

stub_request(Status::http_status(), ContentOrHeaders::binary() | map()) -> ok

stub request with particular status and content/headers

stub_request/3

stub_request(Status::http_status(), Headers::map() | list(), Content::binary()) -> ok


Generated by EDoc