blob: 6d4ff395fd51bb3b872489439b2c27468aa3a45b [file]
/-
Copyright (c) 2025 Lean FRO, LLC. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Authors: Sofia Rodrigues
-/
module
prelude
public import Std.Internal.Http.Internal
public import Std.Internal.Http.Data.Body
public import Std.Internal.Http.Data.Headers
public import Std.Internal.Http.Data.Method
public import Std.Internal.Http.Data.Version
public import Std.Internal.Http.Data.URI
public section
/-!
# Request
This module provides the `Request` type, which represents an HTTP request. It also defines ways
to build a `Request` using functions that make it easier.
-/
namespace Std.Http
set_option linter.all true
open Lean
/--
The main parts of a request containing the HTTP method, version, URI, and headers.
-/
structure Request.Head where
/--
The HTTP method (GET, POST, PUT, DELETE, etc.) for the request
-/
method : Method := .get
/--
The HTTP protocol version (HTTP/1.0, HTTP/1.1, HTTP/2.0, etc.)
-/
version : Version := .v11
/--
The request target/URI indicating the resource being requested
-/
uri : RequestTarget := .asteriskForm
/--
Collection of HTTP headers for the request (Content-Type, Authorization, etc.)
-/
headers : Headers := .empty
deriving Inhabited, Repr
/--
HTTP request structure parameterized by body type
-/
structure Request (t : Type) where
/--
The request headers and metadata
-/
head : Request.Head
/--
The request body content of type t
-/
body : t
deriving Inhabited
/--
Builds a HTTP Request
-/
structure Request.Builder where
/--
The head of the request
-/
head : Head := {}
namespace Request
instance : ToString Head where
toString req :=
toString req.method ++ " " ++
toString req.uri ++ " " ++
toString req.version ++
"\r\n" ++
toString req.headers ++ "\r\n\r\n"
/--
Creates a new HTTP Request builder with default head (method: GET, version: HTTP/1.1, asterisk URI,
empty headers)
-/
def new : Builder := { }
namespace Builder
/--
Creates a new HTTP Request builder with default head (method: GET, version: HTTP/1.1, asterisk URI,
empty headers)
-/
def empty : Builder := { }
/--
Sets the HTTP method for the request being built
-/
def method (builder : Builder) (method : Method) : Builder :=
{ builder with head := { builder.head with method := method } }
/--
Sets the HTTP version for the request being built
-/
def version (builder : Builder) (version : Version) : Builder :=
{ builder with head := { builder.head with version := version } }
/--
Sets the request target/URI for the request being built
-/
def uri (builder : Builder) (uri : RequestTarget) : Builder :=
{ builder with head := { builder.head with uri := uri } }
/--
Sets the request target/URI for the request being built
-/
@[inline]
def uri! (builder : Builder) (uri : String) : Builder :=
let uri := RequestTarget.parse! uri
{ builder with head := { builder.head with uri } }
/--
Adds a single header to the request being built
-/
def header (builder : Builder) (key : Header.Name) (value : Header.Value) : Builder :=
{ builder with head := { builder.head with headers := builder.head.headers.insert key value } }
/--
Adds a single header to the request being built, panics if the header is invalid
-/
def header! (builder : Builder) (key : String) (value : String) : Builder :=
let key := Header.Name.ofString! key
let value := Header.Value.ofString! value
{ builder with head := { builder.head with headers := builder.head.headers.insert key value } }
/--
Adds a header to the request being built only if the Option Header.Value is Some
-/
def headerOpt (builder : Builder) (key : Header.Name) (value : Option Header.Value) : Builder :=
match value with
| some v => builder.header key v
| none => builder
/--
Builds and returns the final HTTP Request with the specified body
-/
def body (builder : Builder) (body : t) : Request t :=
{ head := builder.head, body := body }
/--
Builds and returns the final HTTP Request without a body
-/
def build (builder : Builder) : Request Body :=
{ head := builder.head, body := .empty }
/--
Builds and returns the final HTTP Request with the specified body as binary data
-/
def binary (builder : Builder) (bytes : ByteArray) : Request Body :=
builder
|>.header (.new "content-type") (.new "application/octet-stream")
|>.body (Body.bytes bytes)
/--
Builds and returns the final HTTP Request with the specified body as plain text
-/
def text (builder : Builder) (body : String) : Request Body :=
builder
|>.header (.new "content-type") (.new "text/plain; charset=utf-8")
|>.body (body.toUTF8 |> Body.bytes)
/--
Builds and returns the final HTTP Request with the specified body as HTML
-/
def html (builder : Builder) (body : String) : Request Body :=
builder
|>.header (.new "content-type") (.new "text/html; charset=utf-8")
|>.body (body.toUTF8 |> Body.bytes)
end Builder
/--
Creates a new HTTP GET Request with the specified URI
-/
def get (uri : RequestTarget) : Builder :=
new
|>.method .get
|>.uri uri
/--
Creates a new HTTP POST Request builder with the specified URI.
-/
def post (uri : RequestTarget) : Builder :=
new
|>.method .post
|>.uri uri
/--
Creates a new HTTP PUT Request builder with the specified URI.
-/
def put (uri : RequestTarget) : Builder :=
new
|>.method .put
|>.uri uri
/--
Creates a new HTTP DELETE Request builder with the specified URI
-/
def delete (uri : RequestTarget) : Builder :=
new
|>.method .delete
|>.uri uri
/--
Creates a new HTTP PATCH Request builder with the specified URI
-/
def patch (uri : RequestTarget) : Builder :=
new
|>.method .patch
|>.uri uri
/--
Creates a new HTTP HEAD Request builder with the specified URI.
Named `head'` to avoid conflict with the `head` field accessor.
-/
def head' (uri : RequestTarget) : Builder :=
new
|>.method .head
|>.uri uri
/--
Creates a new HTTP OPTIONS Request builder with the specified URI.
Use `Request.options (RequestTarget.asteriskForm)` for server-wide OPTIONS.
-/
def options (uri : RequestTarget) : Builder :=
new
|>.method .options
|>.uri uri
/--
Creates a new HTTP CONNECT Request builder with the specified URI.
Typically used with `RequestTarget.authorityForm` for tunneling.
-/
def connect (uri : RequestTarget) : Builder :=
new
|>.method .connect
|>.uri uri
/--
Creates a new HTTP TRACE Request builder with the specified URI
-/
def trace (uri : RequestTarget) : Builder :=
new
|>.method .trace
|>.uri uri
end Std.Http.Request