Module bookish_spork

Data Types

http_status()

http_status() = non_neg_integer()

Function Index

capture_request/0
start_server/0starts http server on a default port.
start_server/1starts http server on a particular port.
stop_server/0stops http server.
stub_request/0stubs request with default response Defult response is 204 No Content without body.
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() -> bookish_spork_request:bookish_spork_request()

start_server/0

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

starts http server on a default port

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_request/0

stub_request() -> {ok, Acceptor::pid()}

stubs request with default response Defult response is 204 No Content without body. With just two headers: Server and Date

stub_request/1

stub_request(Fun::function() | http_status()) -> {ok, Acceptor::pid()}

stub request with fun or particular status

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

Example:

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

stub_request/2

stub_request(Status::http_status(), ContentOrHeaders::binary() | map()) -> {ok, Acceptor::pid()}

stub request with particular status and content/headers

stub_request/3

stub_request(Status::http_status(), Headers::map(), Content::binary()) -> {ok, Acceptor::pid()}


Generated by EDoc