Web.Spock.Simple

Since version 0.7 Spock features a new routing system that enables more type-safe code while still being relatively simple and lightweight. You should consider using that (see Web.Spock.Safe) instead of this module. This module is not yet deprecated, but this may happen anytime soon.

Spock's route definition monad

spock :: SpockCfg conn sess st -> SpockM conn sess st () -> IO Middleware

Create a spock application using a given db storageLayer and an initial state. Spock works with database libraries that already implement connection pooling and with those that don't come with it out of the box. For more see the PoolOrConn type. Use runSpock to run the app or spockAsApp to create a Wai.Application

type SpockM conn sess st a = SpockT (WebStateM conn sess st) a

spockT :: MonadIO m => (forall a. m a -> IO a) -> SpockT m () -> IO Middleware

Create a raw spock application with custom underlying monad Use runSpock to run the app or spockAsApp to create a Wai.Application.

spockLimT :: MonadIO m => Maybe Word64 -> (forall a. m a -> IO a) -> SpockT m () -> IO Middleware

Like spockT, but the first argument is request size limit in bytes. Set to Nothing to disable.

data SpockT m a

Instances

MonadTrans SpockT

Monad m => Monad (SpockT m)

Functor m => Functor (SpockT m)

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

MonadIO m => MonadIO (SpockT m)

Defining routes

data SpockRoute

Instances

Eq SpockRoute

Ord SpockRoute

Read SpockRoute

Show SpockRoute

IsString SpockRoute

(<//>) :: SpockRoute -> SpockRoute -> SpockRoute

Combine two route components safely

>>> "/foo" <//> "/bar"
"/foo/bar"

>>> "foo" <//> "bar"
"/foo/bar"

>>> "foo <//> "/bar"
"/foo/bar"

Hooking routes

subcomponent :: Monad m => SpockRoute -> SpockT m () -> SpockT m ()

Define a subcomponent. Usage example:

subcomponent "site" $
  do get "home" homeHandler
     get ("misc" <//> ":param") $ -- ...
subcomponent "/admin" $
  get "home" adminHomeHandler

The request /site/home will be routed to homeHandler and the request /admin/home will be routed to adminHomeHandler

get :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb GET and the given route match

post :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb POST and the given route match

getpost :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb 'GET'/'POST' and the given route match

head :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb HEAD and the given route match

put :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb PUT and the given route match

delete :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb DELETE and the given route match

patch :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when the HTTP verb PATCH and the given route match

hookRoute :: Monad m => StdMethod -> SpockRoute -> ActionT m () -> SpockT m ()

Specify an action that will be run when a HTTP verb and the given route match

hookAny :: Monad m => StdMethod -> ([Text] -> ActionT m ()) -> SpockT m ()

Specify an action that will be run when a HTTP verb matches but no defined route matches. The full path is passed as an argument

data StdMethod :: *

HTTP standard method (as defined by RFC 2616, and PATCH which is defined by RFC 5789).

Constructors

GET

POST

HEAD

PUT

DELETE

TRACE

CONNECT

OPTIONS

PATCH

Instances

Bounded StdMethod

Enum StdMethod

Eq StdMethod

Ord StdMethod

Read StdMethod

Show StdMethod

Ix StdMethod

Hashable StdMethod

Adding Wai.Middleware

middleware :: Monad m => Middleware -> SpockT m ()

Hook wai middleware into Spock

Safe actions

class (Hashable a, Eq a, Typeable a) => SafeAction conn sess st a where

SafeActions are actions that need to be protected from csrf attacks

Methods

runSafeAction :: a -> SpockAction conn sess st ()

The body of the safe action. Either GET or POST

safeActionPath :: forall conn sess st a. (SafeAction conn sess st a, HasSpock (SpockAction conn sess st), SpockConn (SpockAction conn sess st) ~ conn, SpockSession (SpockAction conn sess st) ~ sess, SpockState (SpockAction conn sess st) ~ st) => a -> SpockAction conn sess st Text

Wire up a safe action: Safe actions are actions that are protected from csrf attacks. Here's a usage example:

newtype DeleteUser = DeleteUser Int deriving (Hashable, Typeable, Eq)

instance SafeAction Connection () () DeleteUser where
   runSafeAction (DeleteUser i) =
      do runQuery $ deleteUserFromDb i
         redirect "/user-list"

get ("user-details" <//> ":userId") $
  do userId <- param' "userId"
     deleteUrl <- safeActionPath (DeleteUser userId)
     html $ "Click <a href='" <> deleteUrl <> "'>here</a> to delete user!"

Note that safeActions currently only support GET and POST requests.

module Web.Spock.Shared