feat: response construction, status newtype
This commit is contained in:
Orion Kindel
3271
.spec-results
3271
.spec-results
File diff suppressed because it is too large
Load Diff
@@ -5,8 +5,10 @@ import Prelude
|
||||
import Axon.Request.Handler (Handler(..))
|
||||
import Axon.Response (Response)
|
||||
import Axon.Response as Response
|
||||
import Axon.Response.Status as Status
|
||||
import Data.Either (Either(..))
|
||||
import Effect.Aff.Class (class MonadAff)
|
||||
|
||||
notFound :: forall m. MonadAff m => Handler m Response
|
||||
notFound = Handler $ const $ pure $ Right $ Response.fromStatus 404
|
||||
notFound = Handler $ const $ pure $ Right $ Response.fromStatus $
|
||||
Status.notFound
|
||||
|
||||
@@ -2,10 +2,10 @@ module Axon.Response.Body where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Data.Argonaut.Core (Json, stringify)
|
||||
import Effect (Effect)
|
||||
import Node.Buffer (Buffer)
|
||||
import Node.Stream as Stream
|
||||
import Prim.Row (class Cons)
|
||||
import Unsafe.Coerce (unsafeCoerce)
|
||||
|
||||
data Body
|
||||
= BodyEmpty
|
||||
@@ -19,17 +19,19 @@ instance Show Body where
|
||||
show (BodyBuffer _) = "BodyBuffer _"
|
||||
show (BodyReadable _) = "BodyReadable _"
|
||||
|
||||
stringBody :: String -> Body
|
||||
stringBody = BodyString
|
||||
string :: String -> Body
|
||||
string = BodyString
|
||||
|
||||
bufferBody :: Buffer -> Body
|
||||
bufferBody = BodyBuffer
|
||||
buffer :: Buffer -> Body
|
||||
buffer = BodyBuffer
|
||||
|
||||
streamBody :: Stream.Readable () -> Body
|
||||
streamBody = BodyReadable
|
||||
stream :: forall a a'. Cons "read" Stream.Read a' a => Stream.Stream a -> Body
|
||||
stream =
|
||||
let
|
||||
narrow :: Stream.Stream a -> Stream.Readable ()
|
||||
narrow = unsafeCoerce
|
||||
in
|
||||
BodyReadable <<< narrow
|
||||
|
||||
emptyBody :: Body
|
||||
emptyBody = BodyEmpty
|
||||
|
||||
jsonBody :: Json -> Body
|
||||
jsonBody = stringify >>> BodyString
|
||||
empty :: Body
|
||||
empty = BodyEmpty
|
||||
|
||||
664
src/Axon.Response.Construct.purs
Normal file
664
src/Axon.Response.Construct.purs
Normal file
@@ -0,0 +1,664 @@
|
||||
module Axon.Response.Construct where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Axon.Header.Typed (class TypedHeader, headerName, headerValueEncode)
|
||||
import Axon.Header.Typed as Header
|
||||
import Axon.Response (Response)
|
||||
import Axon.Response as Response
|
||||
import Axon.Response.Body as Response.Body
|
||||
import Axon.Response.Status (Status)
|
||||
import Axon.Response.Status as Status
|
||||
import Data.Argonaut.Core (stringifyWithIndent)
|
||||
import Data.Argonaut.Decode (class DecodeJson)
|
||||
import Data.Argonaut.Encode (class EncodeJson, encodeJson)
|
||||
import Data.Generic.Rep (class Generic)
|
||||
import Data.MIME as MIME
|
||||
import Data.Map as Map
|
||||
import Data.Newtype (class Newtype)
|
||||
import Data.Tuple.Nested (type (/\), (/\))
|
||||
import Effect (Effect)
|
||||
import Node.Buffer (Buffer)
|
||||
import Node.Stream as Stream
|
||||
import Prim.Row (class Cons)
|
||||
import Type.MIME as Type.MIME
|
||||
import Unsafe.Coerce (unsafeCoerce)
|
||||
|
||||
newtype Json a = Json a
|
||||
|
||||
derive instance Newtype (Json a) _
|
||||
derive instance Generic (Json a) _
|
||||
derive newtype instance (EncodeJson a) => EncodeJson (Json a)
|
||||
derive newtype instance (DecodeJson a) => DecodeJson (Json a)
|
||||
|
||||
class ToResponse a where
|
||||
toResponse :: a -> Effect Response
|
||||
|
||||
instance ToResponse Response where
|
||||
toResponse = pure
|
||||
|
||||
else instance ToResponse Status where
|
||||
toResponse = pure <<< Response.fromStatus
|
||||
|
||||
else instance ToResponse Response.Body where
|
||||
toResponse = pure <<< flip (Response.response Status.ok) Map.empty
|
||||
|
||||
else instance ToResponse Buffer where
|
||||
toResponse = toResponse <<< Response.BodyBuffer
|
||||
|
||||
else instance (Cons "read" Stream.Read a' a) => ToResponse (Stream.Stream a) where
|
||||
toResponse =
|
||||
let
|
||||
why :: Stream.Stream a -> Stream.Readable ()
|
||||
why = unsafeCoerce
|
||||
in
|
||||
toResponse <<< Response.Body.stream <<< why
|
||||
|
||||
else instance ToResponse String where
|
||||
toResponse = toResponse <<< Response.BodyString
|
||||
|
||||
else instance EncodeJson a => ToResponse (Json a) where
|
||||
toResponse a =
|
||||
let
|
||||
body = Response.BodyString $ stringifyWithIndent 2 $ encodeJson a
|
||||
contentType = (Header.ContentType Type.MIME.Json)
|
||||
in
|
||||
toResponse body <> toResponse contentType
|
||||
|
||||
else instance (ToResponse a) => ToResponse (Status /\ a) where
|
||||
toResponse (status /\ a) = toResponse a <#> Response.withStatus status
|
||||
|
||||
else instance (ToResponse a, ToResponse b) => ToResponse (a /\ b) where
|
||||
toResponse (a /\ b) = pure (<>) <*> toResponse a <*> toResponse b
|
||||
|
||||
else instance ToResponse (Header.Accept String) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept MIME.MIME) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Aac) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Abw) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Arc) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Avif) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Avi) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Azw) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Bin) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Bmp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Bz) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Bz2) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Cda) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Csh) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Css) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Csv) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Doc) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Docx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Eot) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Epub) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Gz) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Gif) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Html) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ico) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ics) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Jar) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Jpeg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Js) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Json) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Jsonld) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Midi) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Mp3) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Mp4) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Mpeg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Mpkg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Odp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ods) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Odt) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Oga) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ogv) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ogx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Opus) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Otf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Png) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Pdf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Php) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ppt) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Pptx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Rar) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Rtf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Sh) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Svg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Tar) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Tif) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ts) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Ttf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Txt) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Vsd) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Wav) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Weba) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Webm) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Webp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Woff) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Woff2) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Xhtml) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Xls) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Xlsx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Xml) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Xul) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Zip) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Video3gp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Video3g2) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.Accept Type.MIME.Archive7z) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType String) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType MIME.MIME) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Aac) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Abw) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Arc) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Avif) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Avi) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Azw) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Bin) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Bmp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Bz) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Bz2) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Cda) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Csh) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Css) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Csv) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Doc) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Docx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Eot) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Epub) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Gz) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Gif) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Html) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ico) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ics) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Jar) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Jpeg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Js) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Json) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Jsonld) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Midi) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Mp3) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Mp4) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Mpeg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Mpkg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Odp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ods) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Odt) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Oga) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ogv) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ogx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Opus) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Otf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Png) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Pdf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Php) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ppt) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Pptx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Rar) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Rtf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Sh) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Svg) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Tar) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Tif) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ts) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Ttf) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Txt) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Vsd) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Wav) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Weba) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Webm) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Webp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Woff) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Woff2) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Xhtml) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Xls) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Xlsx) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Xml) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Xul) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Zip) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Video3gp) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Video3g2) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse (Header.ContentType Type.MIME.Archive7z) where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlAllowCredentials where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlAllowHeaders where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlAllowMethods where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlAllowOrigin where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlExposeHeaders where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlMaxAge where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlRequestHeaders where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.AccessControlRequestMethod where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Age where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Allow where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Authorization where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.BasicAuth where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.BearerAuth where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.CacheControl where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Connection where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ContentDisposition where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ContentEncoding where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ContentLength where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ContentLocation where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ContentRange where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Cookie where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Date where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ETag where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ExpectContinue where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Expires where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Host where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.IfMatch where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.IfNoneMatch where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.IfModifiedSince where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.IfRange where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.IfUnmodifiedSince where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.LastModified where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Origin where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ProxyAuthorization where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Range where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Referer where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.ReferrerPolicy where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.RetryAfter where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.SecWebsocketKey where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.SecWebsocketAccept where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.SecWebsocketVersion where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Server where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.SetCookie where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.StrictTransportSecurity where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.TE where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.TransferEncoding where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Upgrade where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.UserAgent where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
else instance ToResponse Header.Vary where
|
||||
toResponse = typedHeaderToResponse
|
||||
|
||||
typedHeaderToResponse :: forall a. TypedHeader a => a -> Effect Response
|
||||
typedHeaderToResponse =
|
||||
pure
|
||||
<<< Response.response Status.ok Response.BodyEmpty
|
||||
<<< Map.singleton (headerName @a)
|
||||
<<< headerValueEncode
|
||||
398
src/Axon.Response.Status.purs
Normal file
398
src/Axon.Response.Status.purs
Normal file
@@ -0,0 +1,398 @@
|
||||
module Axon.Response.Status where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Data.Generic.Rep (class Generic)
|
||||
import Data.Newtype (class Newtype)
|
||||
|
||||
-- | HTTP response status codes indicate whether a specific [HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP) request has been successfully completed.
|
||||
-- |
|
||||
-- | Responses are grouped in five classes:
|
||||
-- |
|
||||
-- | 1. Informational responses (`100` – `199`)
|
||||
-- | 2. Successful responses (`200` – `299`)
|
||||
-- | 3. Redirection messages (`300` – `399`)
|
||||
-- | 4. Client error responses (`400` – `499`)
|
||||
-- | 5. Server error responses (`500` – `599`)
|
||||
newtype Status = Status Int
|
||||
|
||||
derive instance Generic Status _
|
||||
derive instance Newtype Status _
|
||||
derive newtype instance Show Status
|
||||
derive newtype instance Eq Status
|
||||
derive newtype instance Ord Status
|
||||
|
||||
-- | 100 Continue
|
||||
-- | This interim response indicates that the client should continue the request or ignore the response if the request is already finished.
|
||||
continue :: Status
|
||||
continue = Status 100
|
||||
|
||||
-- | 101 Switching Protocols
|
||||
-- | This code is sent in response to an "Upgrade" request header from the client and indicates the protocol the server is switching to.
|
||||
switchingProtocols :: Status
|
||||
switchingProtocols = Status 101
|
||||
|
||||
-- | 102 Processing
|
||||
processing :: Status
|
||||
processing = Status 102
|
||||
|
||||
-- | 103 Early Hints
|
||||
-- | This status code is primarily intended to be used with the "Link" header, letting the user agent start [preloading](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/preload) resources while the server prepares a response or [preconnect](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/preconnect) to an origin from which the page will need resources.
|
||||
earlyHints :: Status
|
||||
earlyHints = Status 103
|
||||
|
||||
-- | 200 OK
|
||||
-- | The request succeeded. The result and meaning of "success" depends on the HTTP method:
|
||||
-- | - "GET": The resource has been fetched and transmitted in the message body.
|
||||
-- | - "HEAD": Representation headers are included in the response without any message body.
|
||||
-- | - "PUT" or "POST": The resource describing the result of the action is transmitted in the message body.
|
||||
-- | - "TRACE": The message body contains the request as received by the server.
|
||||
ok :: Status
|
||||
ok = Status 200
|
||||
|
||||
-- | 201 Created
|
||||
-- | The request succeeded, and a new resource was created as a result. This is typically the response sent after "POST" requests, or some "PUT" requests.
|
||||
created :: Status
|
||||
created = Status 201
|
||||
|
||||
-- | 202 Accepted
|
||||
-- | The request has been received but not yet acted upon.
|
||||
-- |
|
||||
-- | It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request.
|
||||
-- |
|
||||
-- | It is intended for cases where another process or server handles the request, or for batch processing.
|
||||
accepted :: Status
|
||||
accepted = Status 202
|
||||
|
||||
-- | 203 Non-Authoritative Information
|
||||
-- | This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy.
|
||||
-- |
|
||||
-- | This is mostly used for mirrors or backups of another resource.
|
||||
-- |
|
||||
-- | Except for that specific case, the "200 OK" response is preferred to this status.
|
||||
nonAuthoritativeInformation :: Status
|
||||
nonAuthoritativeInformation = Status 203
|
||||
|
||||
-- | 204 No Content
|
||||
-- | There is no content to send for this request, but the headers are useful.
|
||||
-- |
|
||||
-- | The user agent may update its cached headers for this resource with the new ones.
|
||||
noContent :: Status
|
||||
noContent = Status 204
|
||||
|
||||
-- | 205 Reset Content
|
||||
-- | Tells the user agent to reset the document which sent this request.
|
||||
resetContent :: Status
|
||||
resetContent = Status 205
|
||||
|
||||
-- | 206 Partial Content
|
||||
-- | This response code is used in response to a [range request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) when the client has requested a part or parts of a resource.
|
||||
partialContent :: Status
|
||||
partialContent = Status 206
|
||||
|
||||
multiStatus = Status 207
|
||||
|
||||
-- | 208 Already Reported
|
||||
-- | Used inside a `<dav:propstat>` response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.
|
||||
alreadyReported :: Status
|
||||
alreadyReported = Status 208
|
||||
|
||||
-- | 226 IM Used
|
||||
-- | The server has fulfilled a "GET" request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
|
||||
imUsed :: Status
|
||||
imUsed = Status 226
|
||||
|
||||
-- | 300 Multiple Choices
|
||||
-- | In [agent-driven content negotiation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation#agent-driven_negotiation), the request has more than one possible response and the user agent or user should choose one of them.
|
||||
-- |
|
||||
-- | There is no standardized way for clients to automatically choose one of the responses, so this is rarely used.
|
||||
multipleChoices :: Status
|
||||
multipleChoices = Status 300
|
||||
|
||||
-- | 301 Moved Permanently
|
||||
-- | The URL of the requested resource has been changed permanently. The new URL is given in the response.
|
||||
movedPermanently :: Status
|
||||
movedPermanently = Status 301
|
||||
|
||||
-- | 302 Found
|
||||
-- | This response code means that the URI of requested resource has been changed _temporarily_.
|
||||
-- |
|
||||
-- | Further changes in the URI might be made in the future, so the same URI should be used by the client in future requests.
|
||||
found :: Status
|
||||
found = Status 302
|
||||
|
||||
-- | 303 See Other
|
||||
-- | The server sent this response to direct the client to get the requested resource at another URI with a "GET" request.
|
||||
seeOther :: Status
|
||||
seeOther = Status 303
|
||||
|
||||
-- | 304 Not Modified
|
||||
-- | This is used for caching purposes.
|
||||
-- |
|
||||
-- | It tells the client that the response has not been modified, so the client can continue to use the same [cached](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching) version of the response.
|
||||
notModified :: Status
|
||||
notModified = Status 304
|
||||
|
||||
-- | 307 Temporary Redirect
|
||||
-- | The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request.
|
||||
-- |
|
||||
-- | This has the same semantics as the `302 Found` response code, with the exception that the user agent _must not_ change the HTTP method used: if a "POST" was used in the first request, a `POST` must be used in the redirected request.
|
||||
temporaryRedirect :: Status
|
||||
temporaryRedirect = Status 307
|
||||
|
||||
-- | 308 Permanent Redirect
|
||||
-- | This means that the resource is now permanently located at another URI, specified by the "Location" response header.
|
||||
-- |
|
||||
-- | This has the same semantics as the `301 Moved Permanently` HTTP response code, with the exception that the user agent _must not_ change the HTTP method used: if a "POST" was used in the first request, a `POST` must be used in the second request.
|
||||
permanentRedirect :: Status
|
||||
permanentRedirect = Status 308
|
||||
|
||||
-- | 400 Bad Request
|
||||
-- | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
|
||||
badRequest :: Status
|
||||
badRequest = Status 400
|
||||
|
||||
-- | 401 Unauthorized
|
||||
-- | Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
|
||||
-- |
|
||||
-- | That is, the client must authenticate itself to get the requested response.
|
||||
unauthorized :: Status
|
||||
unauthorized = Status 400
|
||||
|
||||
-- | 402 Payment Required
|
||||
-- | The initial purpose of this code was for digital payment systems, however this status code is rarely used and no standard convention exists.
|
||||
paymentRequired :: Status
|
||||
paymentRequired = Status 402
|
||||
|
||||
-- | 403 Forbidden
|
||||
-- | The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.
|
||||
-- |
|
||||
-- | Unlike `401 Unauthorized`, the client's identity is known to the server.
|
||||
forbidden :: Status
|
||||
forbidden = Status 403
|
||||
|
||||
-- | 404 Not Found
|
||||
-- | The server cannot find the requested resource.
|
||||
-- |
|
||||
-- | In the browser, this means the URL is not recognized.
|
||||
-- |
|
||||
-- | In an API, this can also mean that the endpoint is valid but the resource itself does not exist.
|
||||
-- |
|
||||
-- | Servers may also send this response instead of `403 Forbidden` to hide the existence of a resource from an unauthorized client.
|
||||
-- |
|
||||
-- | This response code is probably the most well known due to its frequent occurrence on the web.
|
||||
notFound :: Status
|
||||
notFound = Status 404
|
||||
|
||||
-- | 405 Method Not Allowed
|
||||
-- | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) is known by the server but is not supported by the target resource.
|
||||
-- |
|
||||
-- | For example, an API may not allow `DELETE` on a resource, or the `TRACE` method entirely.
|
||||
methodNotAllowed :: Status
|
||||
methodNotAllowed = Status 405
|
||||
|
||||
-- | 406 Not Acceptable
|
||||
-- | This response is sent when the web server, after performing [server-driven content negotiation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation#server-driven_content_negotiation), doesn't find any content that conforms to the criteria given by the user agent.
|
||||
notAcceptable :: Status
|
||||
notAcceptable = Status 406
|
||||
|
||||
-- | 407 Proxy Authentication Required
|
||||
-- | This is similar to `401 Unauthorized` but authentication is needed to be done by a proxy.
|
||||
proxyAuthenticationRequired :: Status
|
||||
proxyAuthenticationRequired = Status 407
|
||||
|
||||
-- | 408 Request Timeout
|
||||
-- | This response is sent on an idle connection by some servers, even without any previous request by the client.
|
||||
-- |
|
||||
-- | It means that the server would like to shut down this unused connection.
|
||||
-- |
|
||||
-- | This response is used much more since some browsers use HTTP pre-connection mechanisms to speed up browsing.
|
||||
-- |
|
||||
-- | Some servers may shut down a connection without sending this message.
|
||||
requestTimeout :: Status
|
||||
requestTimeout = Status 408
|
||||
|
||||
-- | 409 Conflict
|
||||
-- | This response is sent when a request conflicts with the current state of the server.
|
||||
-- |
|
||||
-- | In WebDAV remote web authoring, `409` responses are errors sent to the client so that a user might be able to resolve a conflict and resubmit the request.
|
||||
conflict :: Status
|
||||
conflict = Status 409
|
||||
|
||||
-- | 410 Gone
|
||||
-- | This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
||||
-- |
|
||||
-- | Clients are expected to remove their caches and links to the resource.
|
||||
-- |
|
||||
-- | The HTTP specification intends this status code to be used for "limited-time, promotional services".
|
||||
-- |
|
||||
-- | APIs should not feel compelled to indicate resources that have been deleted with this status code.
|
||||
gone :: Status
|
||||
gone = Status 410
|
||||
|
||||
-- | 411 Length Required
|
||||
-- | Server rejected the request because the "Content-Length" header field is not defined and the server requires it.
|
||||
lengthRequired :: Status
|
||||
lengthRequired = Status 411
|
||||
|
||||
-- | 412 Precondition Failed
|
||||
-- | In [conditional requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests), the client has indicated preconditions in its headers which the server does not meet.
|
||||
preconditionFailed :: Status
|
||||
preconditionFailed = Status 412
|
||||
|
||||
-- | 413 Content Too Large
|
||||
-- | The request body is larger than limits defined by server.
|
||||
-- |
|
||||
-- | The server might close the connection or return an "Retry-After" header field.
|
||||
contentTooLarge :: Status
|
||||
contentTooLarge = Status 413
|
||||
|
||||
-- | 414 URI Too Long
|
||||
-- | The URI requested by the client is longer than the server is willing to interpret.
|
||||
uriTooLong :: Status
|
||||
uriTooLong = Status 414
|
||||
|
||||
-- | 415 Unsupported Media Type
|
||||
-- | The media format of the requested data is not supported by the server, so the server is rejecting the request.
|
||||
unsupportedMediaType :: Status
|
||||
unsupportedMediaType = Status 415
|
||||
|
||||
-- | 416 Range Not Satisfiable
|
||||
-- | The [ranges](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests) specified by the `Range` header field in the request cannot be fulfilled.
|
||||
-- |
|
||||
-- | It's possible that the range is outside the size of the target resource's data.
|
||||
rangeNotSatisfiable :: Status
|
||||
rangeNotSatisfiable = Status 416
|
||||
|
||||
-- | 417 Expectation Failed
|
||||
-- | This response code means the expectation indicated by the "Expect" request header field cannot be met by the server.
|
||||
expectationFailed :: Status
|
||||
expectationFailed = Status 417
|
||||
|
||||
-- | 418 I'm a teapot
|
||||
-- | The server refuses the attempt to brew coffee with a teapot.
|
||||
imATeapot :: Status
|
||||
imATeapot = Status 418
|
||||
|
||||
-- | 421 Misdirected Request
|
||||
-- | The request was directed at a server that is not able to produce a response.
|
||||
-- |
|
||||
-- | This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI.
|
||||
misdirectedRequest :: Status
|
||||
misdirectedRequest = Status 421
|
||||
|
||||
-- | 422 Unprocessable Content
|
||||
-- | The request was well-formed but was unable to be followed due to semantic errors.
|
||||
unprocessableContent :: Status
|
||||
unprocessableContent = Status 422
|
||||
|
||||
-- | 423 Locked
|
||||
-- | The resource that is being accessed is locked.
|
||||
locked :: Status
|
||||
locked = Status 423
|
||||
|
||||
-- | 424 Failed Dependency
|
||||
-- | The request failed due to failure of a previous request.
|
||||
failedDependency :: Status
|
||||
failedDependency = Status 424
|
||||
|
||||
-- | 425 Too Early
|
||||
-- | Indicates that the server is unwilling to risk processing a request that might be replayed.
|
||||
tooEarly :: Status
|
||||
tooEarly = Status 425
|
||||
|
||||
-- | 426 Upgrade Required
|
||||
-- | The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
|
||||
-- |
|
||||
-- | The server sends an "Upgrade" header in a 426 response to indicate the required protocol(s).
|
||||
upgradeRequired :: Status
|
||||
upgradeRequired = Status 426
|
||||
|
||||
-- | 428 Precondition Required
|
||||
-- | The origin server requires the request to be [conditional](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests).
|
||||
-- |
|
||||
-- | This response is intended to prevent the 'lost update' problem, where a client "GET"s a resource's state, modifies it and "PUT"s it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.
|
||||
preconditionRequired :: Status
|
||||
preconditionRequired = Status 428
|
||||
|
||||
-- | 429 Too Many Requests
|
||||
-- | The user has sent too many requests in a given amount of time.
|
||||
tooManyRequests :: Status
|
||||
tooManyRequests = Status 429
|
||||
|
||||
-- | 431 Request Header Fields Too Large
|
||||
-- | The server is unwilling to process the request because its header fields are too large.
|
||||
-- |
|
||||
-- | The request may be resubmitted after reducing the size of the request header fields.
|
||||
requestHeaderFieldsTooLarge :: Status
|
||||
requestHeaderFieldsTooLarge = Status 431
|
||||
|
||||
-- | 451 Unavailable For Legal Reasons
|
||||
-- | The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.
|
||||
unavailableForLegalReasons :: Status
|
||||
unavailableForLegalReasons = Status 451
|
||||
|
||||
-- | 500 Internal Server Error
|
||||
-- | The server has encountered a situation it does not know how to handle.
|
||||
-- |
|
||||
-- | This error is generic, indicating that the server cannot find a more appropriate `5XX` status code to respond with.
|
||||
internalServerError :: Status
|
||||
internalServerError = Status 500
|
||||
|
||||
-- | 501 Not Implemented
|
||||
-- | The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are "GET" and "HEAD".
|
||||
notImplemented :: Status
|
||||
notImplemented = Status 501
|
||||
|
||||
-- | 502 Bad Gateway
|
||||
-- | This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
|
||||
badGateway :: Status
|
||||
badGateway = Status 502
|
||||
|
||||
-- | 503 Service Unavailable
|
||||
-- | The server is not ready to handle the request.
|
||||
-- |
|
||||
-- | Common causes are a server that is down for maintenance or that is overloaded.
|
||||
-- |
|
||||
-- | Note that together with this response, a user-friendly page explaining the problem should be sent.
|
||||
-- |
|
||||
-- | This response should be used for temporary conditions and the "Retry-After" HTTP header should, if possible, contain the estimated time before the recovery of the service.
|
||||
-- |
|
||||
-- | The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
|
||||
serviceUnavailable :: Status
|
||||
serviceUnavailable = Status 503
|
||||
|
||||
-- | 504 Gateway Timeout
|
||||
-- | This error response is given when the server is acting as a gateway and cannot get a response in time.
|
||||
gatewayTimeout :: Status
|
||||
gatewayTimeout = Status 504
|
||||
|
||||
-- | 505 HTTP Version Not Supported
|
||||
-- | The HTTP version used in the request is not supported by the server.
|
||||
hTTPVersionNotSupported :: Status
|
||||
hTTPVersionNotSupported = Status 505
|
||||
|
||||
-- | 506 Variant Also Negotiates
|
||||
-- | The server has an internal configuration error: during content negotiation, the chosen variant is configured to engage in content negotiation itself, which results in circular references when creating responses.
|
||||
variantAlsoNegotiates :: Status
|
||||
variantAlsoNegotiates = Status 506
|
||||
|
||||
-- | 507 Insufficient Storage
|
||||
-- | The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
|
||||
insufficientStorage :: Status
|
||||
insufficientStorage = Status 507
|
||||
|
||||
-- | 508 Loop Detected
|
||||
-- | The server detected an infinite loop while processing the request.
|
||||
loopDetected :: Status
|
||||
loopDetected = Status 508
|
||||
|
||||
-- | 510 Not Extended
|
||||
-- | The client request declares an HTTP Extension (RFC2774) that should be used to process the request, but the extension is not supported.
|
||||
notExtended :: Status
|
||||
notExtended = Status 510
|
||||
|
||||
-- | 511 Network Authentication Required
|
||||
-- | Indicates that the client needs to authenticate to gain network access.
|
||||
networkAuthenticationRequired :: Status
|
||||
networkAuthenticationRequired = Status 511
|
||||
@@ -8,7 +8,6 @@ module Axon.Response
|
||||
, withBody
|
||||
, withStatus
|
||||
, fromStatus
|
||||
, ok
|
||||
, module Body
|
||||
) where
|
||||
|
||||
@@ -16,6 +15,7 @@ import Prelude
|
||||
|
||||
import Axon.Response.Body (Body(..))
|
||||
import Axon.Response.Body (Body(..)) as Body
|
||||
import Axon.Response.Status (Status)
|
||||
import Data.FoldableWithIndex (foldlWithIndex)
|
||||
import Data.Generic.Rep (class Generic)
|
||||
import Data.Map (Map)
|
||||
@@ -25,13 +25,20 @@ import Data.String.Lower (StringLower)
|
||||
import Data.String.Lower as String.Lower
|
||||
|
||||
data Response = Response
|
||||
{ body :: Body, headers :: Map StringLower String, status :: Int }
|
||||
{ body :: Body, headers :: Map StringLower String, status :: Status }
|
||||
|
||||
derive instance Generic Response _
|
||||
instance Semigroup Response where
|
||||
append a b = Response
|
||||
{ body: body b
|
||||
, status: status b
|
||||
, headers: Map.union (headers a) (headers b)
|
||||
}
|
||||
|
||||
instance Show Response where
|
||||
show = genericShow
|
||||
|
||||
response :: Int -> Body -> Map String String -> Response
|
||||
response :: Status -> Body -> Map String String -> Response
|
||||
response s b h = Response
|
||||
{ status: s
|
||||
, body: b
|
||||
@@ -40,7 +47,7 @@ response s b h = Response
|
||||
Map.empty
|
||||
}
|
||||
|
||||
status :: Response -> Int
|
||||
status :: Response -> Status
|
||||
status (Response a) = a.status
|
||||
|
||||
body :: Response -> Body
|
||||
@@ -53,14 +60,11 @@ withHeader :: String -> String -> Response -> Response
|
||||
withHeader k v (Response a) = Response $ a
|
||||
{ headers = Map.insert (String.Lower.fromString k) v a.headers }
|
||||
|
||||
withStatus :: Int -> Response -> Response
|
||||
withStatus :: Status -> Response -> Response
|
||||
withStatus s (Response a) = Response $ a { status = s }
|
||||
|
||||
withBody :: Body -> Response -> Response
|
||||
withBody b (Response a) = Response $ a { body = b }
|
||||
|
||||
fromStatus :: Int -> Response
|
||||
fromStatus :: Status -> Response
|
||||
fromStatus s = Response { body: BodyEmpty, headers: Map.empty, status: s }
|
||||
|
||||
ok :: Response
|
||||
ok = fromStatus 200
|
||||
|
||||
@@ -12,6 +12,9 @@ import Axon.Request.Parts.Path (type (/))
|
||||
import Axon.Response (Response)
|
||||
import Axon.Response as Response
|
||||
import Axon.Response.Body as Response.Body
|
||||
import Axon.Response.Construct (toResponse)
|
||||
import Axon.Response.Construct as Response.Construct
|
||||
import Axon.Response.Status as Status
|
||||
import Control.Monad.Error.Class (liftEither)
|
||||
import Data.Bifunctor (lmap)
|
||||
import Data.Either (Either(..))
|
||||
@@ -48,11 +51,9 @@ defaultRequest =
|
||||
getPerson :: Get -> Path ("people" / Int) Int -> Aff Response
|
||||
getPerson _ (Path id) =
|
||||
if id == 1 then
|
||||
pure $ Response.response 200
|
||||
(Response.Body.stringBody "{\"name\": \"Henry\"}")
|
||||
Map.empty
|
||||
liftEffect $ toResponse $ Response.Construct.Json { name: "Henry" }
|
||||
else
|
||||
pure $ Response.fromStatus 404
|
||||
liftEffect $ toResponse $ Status.notFound
|
||||
|
||||
spec :: Spec Unit
|
||||
spec = describe "Handler" do
|
||||
@@ -62,7 +63,7 @@ spec = describe "Handler" do
|
||||
rep <- Handle.invokeHandler (getPerson `Handle.or` notFound) req
|
||||
<#> lmap (error <<< show)
|
||||
>>= liftEither
|
||||
Response.status rep `shouldEqual` 200
|
||||
Response.status rep `shouldEqual` Status.ok
|
||||
it "responds not found" do
|
||||
req <- liftEffect $ Request.make $ defaultRequest
|
||||
{ url = defaultRequest.url `URL.(/)` "people" `URL.(/)` "1"
|
||||
@@ -71,4 +72,4 @@ spec = describe "Handler" do
|
||||
rep <- Handle.invokeHandler (getPerson `Handle.or` notFound) req
|
||||
<#> lmap (error <<< show)
|
||||
>>= liftEither
|
||||
Response.status rep `shouldEqual` 404
|
||||
Response.status rep `shouldEqual` Status.notFound
|
||||
|
||||
Reference in New Issue
Block a user