Web.Growler

Running a growler app

growl :: MonadIO m => (forall a. m a -> IO a) -> HandlerT m () -> GrowlerT m () -> IO ()

growler :: MonadIO m => (forall a. m a -> IO a) -> HandlerT m () -> GrowlerT m () -> IO Application

Routing

type Growler = GrowlerT IO

data GrowlerT m a

Instances

Monad m => Monad (GrowlerT m)

Functor m => Functor (GrowlerT m)

(Functor m, Monad m) => Applicative (GrowlerT m)

MonadIO m => MonadIO (GrowlerT m)

get :: MonadIO m => RoutePattern -> HandlerT m () -> GrowlerT m ()

get = addroute GET

post :: MonadIO m => RoutePattern -> HandlerT m () -> GrowlerT m ()

post = addroute POST

put :: MonadIO m => RoutePattern -> HandlerT m () -> GrowlerT m ()

put = addroute PUT

delete :: MonadIO m => RoutePattern -> HandlerT m () -> GrowlerT m ()

delete = addroute DELETE

patch :: MonadIO m => RoutePattern -> HandlerT m () -> GrowlerT m ()

patch = addroute PATCH

matchAny :: MonadIO m => RoutePattern -> HandlerT m () -> GrowlerT m ()

Add a route that matches regardless of the HTTP verb.

notFound :: MonadIO m => HandlerT m ()

Specify an action to take if nothing else is found. Note: this _always_ matches, so should generally be the last route specified.

addRoute :: MonadIO m => StdMethod -> RoutePattern -> HandlerT m () -> GrowlerT m ()

Define a route with a StdMethod, Text value representing the path spec, and a body (Action) which modifies the response.

addroute GET "/" $ text "beam me up!"

The path spec can include values starting with a colon, which are interpreted as captures. These are named wildcards that can be looked up with param.

addroute GET "/foo/:bar" $ do
    v <- param "bar"
    text v

>>> curl http://localhost:3000/foo/something
something

regex :: String -> RoutePattern

Match requests using a regular expression. Named captures are not yet supported.

get (regex "^/f(.*)r$") $ do
   path <- param "0"
   cap <- param "1"
   text $ mconcat ["Path: ", path, "\nCapture: ", cap]

>>> curl http://localhost:3000/foo/bar
Path: /foo/bar
Capture: oo/ba

capture :: String -> RoutePattern

Standard Sinatra-style route. Named captures are prepended with colons. This is the default route type generated by OverloadedString routes. i.e.

get (capture "/foo/:bar") $ ...

and

{-# LANGUAGE OverloadedStrings #-}
...
get "/foo/:bar" $ ...

are equivalent.

function :: (Request -> Text) -> (Request -> MatchResult) -> RoutePattern

Build a route based on a function which can match using the entire Request object. Nothing indicates the route does not match. A Just value indicates a successful match, optionally returning a list of key-value pairs accessible by param.

get (function $ \req -> Just [("version", T.pack $ show $ httpVersion req)]) $ do
    v <- param "version"
    text v

>>> curl http://localhost:3000/
HTTP/1.1

literal :: String -> RoutePattern

Build a route that requires the requested path match exactly, without captures.

mount :: Monad m => RoutePattern -> GrowlerT m () -> GrowlerT m ()

handlerHook :: Monad m => (HandlerT m () -> HandlerT m ()) -> GrowlerT m ()

Handlers

type Handler = HandlerT IO

data HandlerT m a

Instances

MonadTrans HandlerT

MonadTransControl HandlerT

MonadBase b m => MonadBase b (HandlerT m)

MonadBaseControl b m => MonadBaseControl b (HandlerT m)

Monad m => Monad (HandlerT m)

Monad m => Functor (HandlerT m)

Monad m => Applicative (HandlerT m)

MonadIO m => MonadIO (HandlerT m)

data StT HandlerT = StHandlerT {

• unStHandlerT :: Either ResponseState (a, ResponseState)

}

data StM (HandlerT m) = StMHandlerT {

• unStMHandlerT :: StM m (StT HandlerT a)

}

currentResponse :: Monad m => HandlerT m ResponseState

abort :: Monad m => ResponseState -> HandlerT m ()

status :: Monad m => Status -> HandlerT m ()

addHeader :: Monad m => CI ByteString -> ByteString -> HandlerT m ()

setHeader :: Monad m => CI ByteString -> ByteString -> HandlerT m ()

body :: Monad m => BodySource -> HandlerT m ()

html :: Monad m => Text -> HandlerT m ()

json :: Monad m => ToJSON a => a -> HandlerT m ()

file :: Monad m => FilePath -> Maybe FilePart -> HandlerT m ()

formData :: MonadIO m => BackEnd y -> HandlerT m ([(ByteString, ByteString)], [File y])

headers :: Monad m => HandlerT m RequestHeaders

jsonData :: (FromJSON a, MonadIO m) => HandlerT m (Either String a)

params :: Monad m => HandlerT m [Param]

raw :: Monad m => ByteString -> HandlerT m ()

redirect :: Monad m => Text -> HandlerT m ()

request :: Monad m => HandlerT m Request

stream :: Monad m => StreamingBody -> HandlerT m ()

text :: Monad m => Text -> HandlerT m ()

routePattern :: Monad m => HandlerT m (Maybe Text)

Parsable

class Parsable a where

Minimum implemention: parseParam

Minimal complete definition

parseParam

Methods

parseParam :: ByteString -> Either ByteString a

Take a ByteString value and parse it as a, or fail with a message.

parseParamList :: ByteString -> Either ByteString [a]

Default implementation parses comma-delimited lists.

parseParamList t = mapM parseParam (BS.split ',' t)

Instances

Parsable Bool

Parsable Char

Overrides default parseParamList to parse String.

Parsable Double

Parsable Float

Parsable Int

Parsable Integer

Parsable ()

Checks if parameter is present and is null-valued, not a literal '()'. If the URI requested is: '/foo?bar=()&baz' then baz will parse as (), where bar will not.

Parsable ByteString

Parsable Text

Parsable Text

Parsable a => Parsable [a]

readEither :: Read a => ByteString -> Either ByteString a

Useful for creating Parsable instances for things that already implement Read. Ex:

instance Parsable Int where parseParam = readEither

Internals

data BodySource

Constructors

FileSource !(FilePath, Maybe FilePart)

BuilderSource !Builder

LBSSource !ByteString

StreamSource !StreamingBody

RawSource !(IO ByteString -> (ByteString -> IO ()) -> IO ()) !Response

Instances

HasBodySource ResponseState BodySource

data ResponseState

Instances

HasStatus ResponseState Status

HasBodySource ResponseState BodySource

HasHeaders ResponseState (HashMap (CI ByteString) [ByteString])

newtype RoutePattern

Constructors

RoutePattern

Fields

runRoutePattern :: Request -> (Text, Request, MatchResult)

Instances

IsString RoutePattern

Monoid RoutePattern