-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Another Haskell web framework for rapid development
--   
--   This toolbox provides everything you need to get a quick start into
--   web hacking with haskell: fast routing, middleware, json, blaze,
--   sessions, cookies, database helper, csrf-protection
@package Spock
@version 0.7.4.0

module Web.Spock.Shared

-- | Run a Spock application. Basically just a wrapper aroung
--   <tt>Warp.run</tt>.
runSpock :: Port -> IO Middleware -> IO ()

-- | Convert a middleware to an application. All failing requests will
--   result in a 404 page
spockAsApp :: IO Middleware -> IO Application

-- | Get the original Wai Request object
request :: MonadIO m => ActionT m Request

-- | Read a header
header :: MonadIO m => Text -> ActionT m (Maybe Text)

-- | Read a cookie
cookie :: MonadIO m => Text -> ActionT m (Maybe Text)

-- | Get the raw request body
body :: MonadIO m => ActionT m ByteString

-- | Parse the request body as json
jsonBody :: (MonadIO m, FromJSON a) => ActionT m (Maybe a)

-- | Parse the request body as json and fails with 500 status code on error
jsonBody' :: (MonadIO m, FromJSON a) => ActionT m a

-- | Get uploaded files
files :: MonadIO m => ActionT m (HashMap Text UploadedFile)
data UploadedFile
UploadedFile :: Text -> Text -> FilePath -> UploadedFile
uf_name :: UploadedFile -> Text
uf_contentType :: UploadedFile -> Text
uf_tempLocation :: UploadedFile -> FilePath

-- | Get all request params
params :: MonadIO m => ActionT m [(Text, Text)]

-- | Read a request param. Spock looks in route captures first, then in
--   POST variables and at last in GET variables
param :: (PathPiece p, MonadIO m) => Text -> ActionT m (Maybe p)

-- | Like <a>param</a>, but outputs an error when a param is missing
param' :: (PathPiece p, MonadIO m) => Text -> ActionT m p

-- | Set a response status
setStatus :: MonadIO m => Status -> ActionT m ()

-- | Set a response header. Overwrites already defined headers
setHeader :: MonadIO m => Text -> Text -> ActionT m ()

-- | Redirect to a given url
redirect :: MonadIO m => Text -> ActionT m a

-- | Abort the current action and jump the next one matching the route
jumpNext :: MonadIO m => ActionT m a

-- | Set a cookie living for a given number of seconds
setCookie :: MonadIO m => Text -> Text -> NominalDiffTime -> ActionT m ()

-- | Set a cookie living until a specific <a>UTCTime</a>
setCookie' :: MonadIO m => Text -> Text -> UTCTime -> ActionT m ()

-- | Send a <tt>ByteString</tt> as response body. Provide your own
--   <a>Content-Type</a>
bytes :: MonadIO m => ByteString -> ActionT m a

-- | Send a lazy <tt>ByteString</tt> as response body. Provide your own
--   <a>Content-Type</a>
lazyBytes :: MonadIO m => ByteString -> ActionT m a

-- | Send text as a response body. Content-Type will be "text/plain"
text :: MonadIO m => Text -> ActionT m a

-- | Send a text as response body. Content-Type will be "text/html"
html :: MonadIO m => Text -> ActionT m a

-- | Send a file as response
file :: MonadIO m => Text -> FilePath -> ActionT m a

-- | Send json as response. Content-Type will be "application/json"
json :: (ToJSON a, MonadIO m) => a -> ActionT m b

-- | Send blaze html as response. Content-Type will be "text/html"
blaze :: MonadIO m => Html -> ActionT m a

-- | If the Spock application is used as a middleware, you can use this to
--   pass request handeling to the underlying application. If Spock is not
--   uses as a middleware, or there is no underlying application this will
--   result in 404 error.
middlewarePass :: MonadIO m => ActionT m a

-- | Modify the vault (useful for sharing data between middleware and app)
modifyVault :: MonadIO m => (Vault -> Vault) -> ActionT m ()

-- | Query the vault
queryVault :: MonadIO m => Key a -> ActionT m (Maybe a)

-- | You can feed Spock with either a connection pool, or instructions on
--   how to build a connection pool. See <a>ConnBuilder</a>
data PoolOrConn a
PCPool :: (Pool a) -> PoolOrConn a
PCConn :: (ConnBuilder a) -> PoolOrConn a

-- | The ConnBuilder instructs Spock how to create or close a database
--   connection.
data ConnBuilder a
ConnBuilder :: IO a -> (a -> IO ()) -> PoolCfg -> ConnBuilder a
cb_createConn :: ConnBuilder a -> IO a
cb_destroyConn :: ConnBuilder a -> a -> IO ()
cb_poolConfiguration :: ConnBuilder a -> PoolCfg

-- | If Spock should take care of connection pooling, you need to configure
--   it depending on what you need.
data PoolCfg
PoolCfg :: Int -> Int -> NominalDiffTime -> PoolCfg
pc_stripes :: PoolCfg -> Int
pc_resPerStripe :: PoolCfg -> Int
pc_keepOpenTime :: PoolCfg -> NominalDiffTime
class HasSpock m where type family SpockConn m :: * type family SpockState m :: * type family SpockSession m :: *
runQuery :: HasSpock m => (SpockConn m -> IO a) -> m a
getState :: HasSpock m => m (SpockState m)

-- | Basic authentification provide a title for the prompt and a function
--   to validate user and password. Usage example:
--   
--   <pre>
--   get "/my-secret-page" $
--     requireBasicAuth "Secret Page" (\user pass -&gt; return (user == "admin" &amp;&amp; pass == "1234")) $
--     do html "This is top secret content. Login using that secret code I provided ;-)"
--   </pre>
requireBasicAuth :: MonadIO m => Text -> (Text -> Text -> m Bool) -> ActionT m a -> ActionT m a

-- | Configuration for the session manager
data SessionCfg a
SessionCfg :: Text -> NominalDiffTime -> Int -> a -> SessionCfg a
sc_cookieName :: SessionCfg a -> Text
sc_sessionTTL :: SessionCfg a -> NominalDiffTime
sc_sessionIdEntropy :: SessionCfg a -> Int
sc_emptySession :: SessionCfg a -> a
type SessionId = Text

-- | Get the current users sessionId. Note that this ID should only be
--   shown to it's owner as otherwise sessions can be hijacked.
getSessionId :: SpockAction conn sess st SessionId

-- | Read the stored session
readSession :: SpockAction conn sess st sess

-- | Write to the current session. Note that all data is stored on the
--   server. The user only reciedes a sessionId to be identified.
writeSession :: sess -> SpockAction conn sess st ()

-- | Modify the stored session
modifySession :: (sess -> sess) -> SpockAction conn sess st ()

-- | Globally delete all existing sessions. This is useful for example if
--   you want to require all users to relogin
clearAllSessions :: SpockAction conn sess st ()

-- | Run a digestive functors form
runForm :: (Functor m, MonadIO m) => Text -> Form v (ActionT m) a -> ActionT m (View v, Maybe a)

-- | Read the heart of Spock. This is useful if you want to construct your
--   own monads that work with runQuery and getState using "runSpockIO"
getSpockHeart :: MonadTrans t => t (WebStateM conn sess st) (WebState conn sess st)

-- | Run an action inside of Spocks core monad. This allows you to use
--   runQuery and getState
runSpockIO :: WebState conn sess st -> WebStateM conn sess st a -> IO a
data WebStateM conn sess st a
data WebState conn sess st

module Web.Spock.Safe

-- | 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 <a>PoolOrConn</a> type. Use
--   <tt>runSpock</tt> to run the app or <tt>spockAsApp</tt> to create a
--   <tt>Wai.Application</tt>
spock :: SessionCfg sess -> PoolOrConn conn -> st -> SpockM conn sess st () -> IO Middleware
type SpockM conn sess st a = SpockT (WebStateM conn sess st) a

-- | The SpockAction is the monad of all route-actions. You have access to
--   the database, session and state of your application.
type SpockAction conn sess st = ActionT (WebStateM conn sess st)

-- | Create a raw spock application with custom underlying monad Use
--   <tt>runSpock</tt> to run the app or <tt>spockAsApp</tt> to create a
--   <tt>Wai.Application</tt>
spockT :: MonadIO m => (forall a. m a -> IO a) -> SpockT m () -> IO Middleware
data SpockT m a
data ActionT m a
data Path (as :: [*]) :: [*] -> *

-- | The root of a path piece. Use to define a handler for "/"
root :: Path ([] *)

-- | A route parameter
var :: (Typeable * a, PathPiece a) => Path ((:) * a ([] *))

-- | A static route piece
static :: String -> Path ([] *)
(</>) :: Path as -> Path bs -> Path (Append as bs)
renderRoute :: Path as -> HVect as -> Text

-- | Define a subcomponent. Usage example:
--   
--   <pre>
--   subcomponent "site" $
--     do get "home" homeHandler
--        get ("misc" &lt;&gt; var) $ -- ...
--   subcomponent "admin" $
--     do get "home" adminHomeHandler
--   </pre>
--   
--   The request "<i>site</i>home" will be routed to homeHandler and the
--   request "<i>admin</i>home" will be routed to adminHomeHandler
subcomponent :: Monad m => Path [] -> SpockT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>GET</a> and
--   the given route match
get :: MonadIO m => Path xs -> HVectElim xs (ActionT m ()) -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>POST</a> and
--   the given route match
post :: MonadIO m => Path xs -> HVectElim xs (ActionT m ()) -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>HEAD</a> and
--   the given route match
head :: MonadIO m => Path xs -> HVectElim xs (ActionT m ()) -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>PUT</a> and
--   the given route match
put :: MonadIO m => Path xs -> HVectElim xs (ActionT m ()) -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>DELETE</a>
--   and the given route match
delete :: MonadIO m => Path xs -> HVectElim xs (ActionT m ()) -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>PATCH</a> and
--   the given route match
patch :: MonadIO m => Path xs -> HVectElim xs (ActionT m ()) -> SpockT m ()

-- | Specify an action that will be run when a HTTP verb and the given
--   route match
hookRoute :: Monad m => StdMethod -> Path xs -> HVectElim xs (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
hookAny :: Monad m => StdMethod -> ([Text] -> ActionT m ()) -> SpockT m ()

-- | HTTP standard method (as defined by RFC 2616, and PATCH which is
--   defined by RFC 5789).
data StdMethod :: *
GET :: StdMethod
POST :: StdMethod
HEAD :: StdMethod
PUT :: StdMethod
DELETE :: StdMethod
TRACE :: StdMethod
CONNECT :: StdMethod
OPTIONS :: StdMethod
PATCH :: StdMethod

-- | Hook wai middleware into Spock
middleware :: Monad m => Middleware -> SpockT m ()

-- | SafeActions are actions that need to be protected from csrf attacks
class (Hashable a, Eq a, Typeable a) => SafeAction conn sess st a
runSafeAction :: SafeAction conn sess st a => a -> SpockAction conn sess st ()

-- | Wire up a safe action: Safe actions are actions that are protected
--   from csrf attacks. Here's a usage example:
--   
--   <pre>
--   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 &lt;- param' "userId"
--        deleteUrl &lt;- safeActionPath (DeleteUser userId)
--        html $ "Click &lt;a href='" &lt;&gt; deleteUrl &lt;&gt; "'&gt;here&lt;/a&gt; to delete user!"
--   </pre>
--   
--   Note that safeActions currently only support GET and POST requests.
safeActionPath :: (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
instance Monad m => Monad (SpockT m)
instance Functor m => Functor (SpockT m)
instance (Monad m, Functor m) => Applicative (SpockT m)
instance MonadIO m => MonadIO (SpockT m)
instance MonadTrans SpockT

module Web.Spock.Simple

-- | 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 <a>PoolOrConn</a> type. Use
--   <tt>runSpock</tt> to run the app or <tt>spockAsApp</tt> to create a
--   <tt>Wai.Application</tt>
spock :: SessionCfg sess -> PoolOrConn conn -> st -> SpockM conn sess st () -> IO Middleware
type SpockM conn sess st a = SpockT (WebStateM conn sess st) a

-- | The SpockAction is the monad of all route-actions. You have access to
--   the database, session and state of your application.
type SpockAction conn sess st = ActionT (WebStateM conn sess st)

-- | Create a raw spock application with custom underlying monad Use
--   <tt>runSpock</tt> to run the app or <tt>spockAsApp</tt> to create a
--   <tt>Wai.Application</tt>
spockT :: MonadIO m => (forall a. m a -> IO a) -> SpockT m () -> IO Middleware
data SpockT m a
data ActionT m a
data SpockRoute

-- | Combine two route components safely "<i>foo" <a>#</a> "</i>bar"
--   ===&gt; "<i>foo</i>bar" "foo" <a>#</a> "bar" ===&gt; "<i>foo</i>bar"
--   "foo <a>#</a> "<i>bar" ===&gt; "</i>foo/bar"
(<#>) :: SpockRoute -> SpockRoute -> SpockRoute

-- | Define a subcomponent. Usage example:
--   
--   <pre>
--   subcomponent "/site" $
--     do get "/home" homeHandler
--        get "/misc/:param" $ -- ...
--   subcomponent "/admin" $
--     do get "/home" adminHomeHandler
--   </pre>
--   
--   The request <i>site</i>home will be routed to homeHandler and the
--   request <i>admin</i>home will be routed to adminHomeHandler
subcomponent :: Monad m => SpockRoute -> SpockT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>GET</a> and
--   the given route match
get :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>POST</a> and
--   the given route match
post :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>HEAD</a> and
--   the given route match
head :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>PUT</a> and
--   the given route match
put :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>DELETE</a>
--   and the given route match
delete :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

-- | Specify an action that will be run when the HTTP verb <a>PATCH</a> and
--   the given route match
patch :: MonadIO m => SpockRoute -> ActionT m () -> SpockT m ()

-- | Specify an action that will be run when a HTTP verb 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 matches but no
--   defined route matches. The full path is passed as an argument
hookAny :: Monad m => StdMethod -> ([Text] -> ActionT m ()) -> SpockT m ()

-- | HTTP standard method (as defined by RFC 2616, and PATCH which is
--   defined by RFC 5789).
data StdMethod :: *
GET :: StdMethod
POST :: StdMethod
HEAD :: StdMethod
PUT :: StdMethod
DELETE :: StdMethod
TRACE :: StdMethod
CONNECT :: StdMethod
OPTIONS :: StdMethod
PATCH :: StdMethod

-- | Hook wai middleware into Spock
middleware :: Monad m => Middleware -> SpockT m ()

-- | SafeActions are actions that need to be protected from csrf attacks
class (Hashable a, Eq a, Typeable a) => SafeAction conn sess st a
runSafeAction :: SafeAction conn sess st a => a -> SpockAction conn sess st ()

-- | Wire up a safe action: Safe actions are actions that are protected
--   from csrf attacks. Here's a usage example:
--   
--   <pre>
--   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 &lt;- param' "userId"
--        deleteUrl &lt;- safeActionPath (DeleteUser userId)
--        html $ "Click &lt;a href='" &lt;&gt; deleteUrl &lt;&gt; "'&gt;here&lt;/a&gt; to delete user!"
--   </pre>
--   
--   Note that safeActions currently only support GET and POST requests.
safeActionPath :: (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
instance Monad m => Monad (SpockT m)
instance Functor m => Functor (SpockT m)
instance (Monad m, Functor m) => Applicative (SpockT m)
instance MonadIO m => MonadIO (SpockT m)
instance Eq SpockRoute
instance Ord SpockRoute
instance Show SpockRoute
instance Read SpockRoute
instance IsString SpockRoute
instance MonadTrans SpockT