FakeHTTP

v0.3.2

FakeHTTP v0.3.2 FakeHTTP.Server View Source

The main interface of a scriptable HTTP server

Link to this section Summary

Types

body()
headers()
on_start()
options()
server()
status_code()

Functions

agent!(server)

Returns a corresponding agent name or raises error.

base_url(server)
child_spec(init_arg)

Returns a specification to start this module under a supervisor.

enqueue(server, raw_response)

Enqueue a new response which will return from the HTTP server.

enqueue(server, status_code, body)
enqueue(server, status_code, body, headers)
reset(server)

Resets the internal states in the server.

start_link(opts \\ [])

Starts a new FakeHTTP.Server process with the given opts options.

stop(server)

Shutdown the server.

take(server)

Link to this section Types

Link to this type

body() View Source 
body() :: map() | binary()

Link to this type

headers() View Source 
headers() :: [{binary(), binary()}] | %{required(binary()) => binary()}

Link to this type

on_start() View Source 
on_start() ::
  {:ok, pid()}
  | {:error, {:already_started, pid()} | {:shutdown, term()} | term()}

Link to this type

options() View Source 
options() :: [GenServer.option()]

Link to this type

server() View Source 
server() :: GenServer.server()

Link to this type

status_code() View Source 
status_code() :: integer() | atom()

Link to this section Functions

Link to this function

agent!(server) View Source 
agent!(server()) :: GenServer.server() | no_return()

Returns a corresponding agent name or raises error.

Link to this function

base_url(server) View Source 
base_url(server()) :: String.t() | no_return()

Link to this function

child_spec(init_arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

enqueue(server, raw_response) View Source 
enqueue(server(), term()) :: :ok | no_return()

Enqueue a new response which will return from the HTTP server.

Examples 

Server.enqueue(server, 200)                            # 200 OK
Server.enqueue(server, :forbidden)                     # 403 Forbidden
Server.enqueue(server, %{"x" => 12345})                # application/json
Server.enqueue(server, "hello, world!")                # text/plain
Server.enqueue(server, 400, %{error: "bad_request"})   # 403 Forbidden + application/json
Link to this function

enqueue(server, status_code, body) View Source 
enqueue(server(), status_code(), body()) :: :ok | no_return()

Link to this function

enqueue(server, status_code, body, headers) View Source 
enqueue(server(), status_code(), body(), headers()) :: :ok | no_return()

Link to this function

reset(server) View Source 
reset(server()) :: :ok

Resets the internal states in the server.

Link to this function

start_link(opts \\ []) View Source 
start_link(options()) :: on_start()

Starts a new FakeHTTP.Server process with the given opts options.

Options

  • port - The port number of a HTTP server (default: 0. It means the underlying OS will assign an available port number)
  • name - Register a started process (supervisor) with gicen name.
Link to this function

stop(server) View Source 
stop(server()) :: :ok

Shutdown the server.

Link to this function

take(server) View Source 
take(server()) :: {:ok, FakeHTTP.Request.t()} | :error