Added ActionM variants for cookie module functions

Web/Scotty.hs

@@ -54,8 +54,8 @@
       -- * Types
     , ScottyM, ActionM, RoutePattern, File, Content(..), Kilobytes, ErrorHandler, Handler(..)
     , ScottyState, defaultScottyState
-    -- ** Functions from Cookie module
-    , setSimpleCookie, getCookie, getCookies, deleteCookie, makeSimpleCookie
+    -- ** Cookie functions
+    , setCookie, setSimpleCookie, getCookie, getCookies, deleteCookie, Cookie.makeSimpleCookie
     -- ** Session Management
     , Session (..), SessionId, SessionJar, SessionStatus
     , createSessionJar, createUserSession, createSession, addSession
@@ -71,6 +71,7 @@
 import qualified Data.ByteString as BS
 import Data.ByteString.Lazy.Char8 (ByteString)
 import Data.Text.Lazy (Text, toStrict)
+import qualified Data.Text as T
 
 import Network.HTTP.Types (Status, StdMethod, ResponseHeaders)
 import Network.Socket (Socket)
@@ -81,7 +82,7 @@
 import Web.FormUrlEncoded (FromForm)
 import Web.Scotty.Internal.Types (ScottyT, ActionT, ErrorHandler, Param, RoutePattern, Options, defaultOptions, File, Kilobytes, ScottyState, defaultScottyState, ScottyException, StatusError(..), Content(..))
 import UnliftIO.Exception (Handler(..), catch)
-import Web.Scotty.Cookie (setSimpleCookie, getCookie, getCookies, deleteCookie, makeSimpleCookie)
+import qualified Web.Scotty.Cookie as Cookie 
 import Web.Scotty.Session (Session (..), SessionId, SessionJar, SessionStatus , createSessionJar,
     createSession, addSession, maintainSessions)
 
@@ -166,14 +167,14 @@
 --
 -- Uncaught exceptions turn into HTTP 500 responses.
 raise :: Text -> ActionM a
 raise = Trans.raise
 {-# DEPRECATED raise "Throw an exception instead" #-}
 
 -- | Throw a 'StatusError' exception that has an associated HTTP error code and can be caught with 'catch'.
 --
 -- Uncaught exceptions turn into HTTP responses corresponding to the given status.
 raiseStatus :: Status -> Text -> ActionM a
 raiseStatus = Trans.raiseStatus
 {-# DEPRECATED raiseStatus "Use status, text, and finish instead" #-}
 
 -- | Throw an exception which can be caught within the scope of the current Action with 'catch'.
@@ -223,7 +224,7 @@
 --
 -- > raise JustKidding `catch` (\msg -> text msg)
 rescue :: E.Exception e => ActionM a -> (e -> ActionM a) -> ActionM a
 rescue = Trans.rescue
 {-# DEPRECATED rescue "Use catch instead" #-}
 
 -- | Like 'liftIO', but catch any IO exceptions and turn them into Scotty exceptions.
@@ -630,3 +631,31 @@
     -> a          -- ^ Content
     -> ActionM (Session a)
 createUserSession = Trans.createUserSession
+
+-- Cookie functions
+
+-- | Set a cookie, with full access to its options (see 'SetCookie')
+setCookie :: Cookie.SetCookie -> ActionM ()
+setCookie = Cookie.setCookie
+
+-- | 'makeSimpleCookie' and 'setCookie' combined.
+setSimpleCookie :: T.Text -- ^ name
+                -> T.Text -- ^ value
+                -> ActionM ()
+setSimpleCookie = Cookie.setSimpleCookie
+
+-- | Lookup one cookie name
+getCookie :: T.Text -- ^ name
+            -> ActionM (Maybe T.Text)
+getCookie = Cookie.getCookie
+
+-- | Returns all cookies
+getCookies :: ActionM Cookie.CookiesText
+getCookies = Cookie.getCookies
+
+-- | Browsers don't directly delete a cookie, but setting its expiry to a past date (e.g. the UNIX epoch) 
+-- ensures that the cookie will be invalidated 
+-- (whether and when it will be actually deleted by the browser seems to be browser-dependent).
+deleteCookie :: T.Text -- ^ name
+             -> ActionM ()
+deleteCookie = Cookie.deleteCookie 

changelog.md

@@ -5,6 +5,7 @@
 * Exposed simple functions of `Cookie` module via `Web.Scotty` & `Web.Scotty.Trans`.
 * Add tests for URL encoding of query parameters and form parameters. Add `formData` action for decoding `FromForm` instances (#321).
 * Add explicit redirect functions for all redirect status codes.
+* Added ActionM variants for cookie module functions (#406).
 
 ### Breaking changes
 * Remove dependency on data-default class (#386). We have been exporting constants for default config values since 0.20, and this dependency was simply unnecessary.