Snap.Snaplet.Auth.Backends.Persistent

Documentation

data PersistAuthManager

Instances

IAuthBackend PersistAuthManager

Methods

save :: PersistAuthManager -> AuthUser -> IO (Either AuthFailure AuthUser)

lookupByUserId :: PersistAuthManager -> UserId -> IO (Maybe AuthUser)

lookupByLogin :: PersistAuthManager -> Text -> IO (Maybe AuthUser)

lookupByEmail :: PersistAuthManager -> Text -> IO (Maybe AuthUser)

lookupByRememberToken :: PersistAuthManager -> Text -> IO (Maybe AuthUser)

destroy :: PersistAuthManager -> AuthUser -> IO ()

initPersistAuthManager :: SnapletLens b SessionManager -> ConnectionPool -> SnapletInit b (AuthManager b)

Initializer that gets AuthSettings from a config file.

initPersistAuthManager' :: AuthSettings -> SnapletLens b SessionManager -> ConnectionPool -> SnapletInit b (AuthManager b)

Initializer that lets you specify AuthSettings.

authEntityDefs :: [EntityDef]

The list of entity definitions this snaplet exposes. You need them so that you can append to your application's list of entity definitions and perform the migration in one block.

See how this example combined an app's own entity definitions and the auth snaplet's in one migration block:

share [mkMigrate "migrateAll"] $
   authEntityDefs ++
   $(persistFileWith lowerCaseSettings "schema.txt")

Persistent Auth Data Types

Persistent creates its own data types mirroring the database schema, so we have to export this extra layer of types and conversion to AuthUser.

data SnapAuthUser

Constructors

SnapAuthUser

Fields

• snapAuthUserLogin :: !Text
• snapAuthUserEmail :: !Text
• snapAuthUserPassword :: !Text
• snapAuthUserActivatedAt :: !(Maybe UTCTime)
• snapAuthUserSuspendedAt :: !(Maybe UTCTime)
• snapAuthUserRememberToken :: !(Maybe Text)
• snapAuthUserLoginCount :: !Int
• snapAuthUserFailedLoginCount :: !Int
• snapAuthUserLockedOutUntil :: !(Maybe UTCTime)
• snapAuthUserCurrentLoginAt :: !(Maybe UTCTime)
• snapAuthUserLastLoginAt :: !(Maybe UTCTime)
• snapAuthUserCurrentIp :: !(Maybe Text)
• snapAuthUserLastIp :: !(Maybe Text)
• snapAuthUserCreatedAt :: !UTCTime
• snapAuthUserUpdatedAt :: !UTCTime
• snapAuthUserResetToken :: !(Maybe Text)
• snapAuthUserResetRequestedAt :: !(Maybe UTCTime)
• snapAuthUserRoles :: !String
• snapAuthUserMeta :: !String

Instances

PersistFieldSql SnapAuthUser

Methods

sqlType :: Proxy * SnapAuthUser -> SqlType

PersistEntity SnapAuthUser

Associated Types

type PersistEntityBackend SnapAuthUser :: *

data Key SnapAuthUser :: *

data EntityField SnapAuthUser a :: *

data Unique SnapAuthUser :: *

Methods

keyToValues :: Key SnapAuthUser -> [PersistValue]

keyFromValues :: [PersistValue] -> Either Text (Key SnapAuthUser)

persistIdField :: EntityField SnapAuthUser (Key SnapAuthUser)

entityDef :: Monad m => m SnapAuthUser -> EntityDef

persistFieldDef :: EntityField SnapAuthUser typ -> FieldDef

toPersistFields :: SnapAuthUser -> [SomePersistField]

fromPersistValues :: [PersistValue] -> Either Text SnapAuthUser

persistUniqueKeys :: SnapAuthUser -> [Unique SnapAuthUser]

persistUniqueToFieldNames :: Unique SnapAuthUser -> [(HaskellName, DBName)]

persistUniqueToValues :: Unique SnapAuthUser -> [PersistValue]

fieldLens :: EntityField SnapAuthUser field -> forall (f :: * -> *). Functor f => (field -> f field) -> Entity SnapAuthUser -> f (Entity SnapAuthUser)

PersistField SnapAuthUser

Methods

toPersistValue :: SnapAuthUser -> PersistValue

fromPersistValue :: PersistValue -> Either Text SnapAuthUser

ToBackendKey SqlBackend SnapAuthUser

Methods

toBackendKey :: Key SnapAuthUser -> BackendKey SqlBackend

fromBackendKey :: BackendKey SqlBackend -> Key SnapAuthUser

Eq (Key SnapAuthUser)

Methods

(==) :: Key SnapAuthUser -> Key SnapAuthUser -> Bool

(/=) :: Key SnapAuthUser -> Key SnapAuthUser -> Bool

Ord (Key SnapAuthUser)

Methods

compare :: Key SnapAuthUser -> Key SnapAuthUser -> Ordering

(<) :: Key SnapAuthUser -> Key SnapAuthUser -> Bool

(<=) :: Key SnapAuthUser -> Key SnapAuthUser -> Bool

(>) :: Key SnapAuthUser -> Key SnapAuthUser -> Bool

(>=) :: Key SnapAuthUser -> Key SnapAuthUser -> Bool

max :: Key SnapAuthUser -> Key SnapAuthUser -> Key SnapAuthUser

min :: Key SnapAuthUser -> Key SnapAuthUser -> Key SnapAuthUser

Read (Key SnapAuthUser)

Methods

readsPrec :: Int -> ReadS (Key SnapAuthUser)

readList :: ReadS [Key SnapAuthUser]

readPrec :: ReadPrec (Key SnapAuthUser)

readListPrec :: ReadPrec [Key SnapAuthUser]

Show (Key SnapAuthUser)

Methods

showsPrec :: Int -> Key SnapAuthUser -> ShowS

show :: Key SnapAuthUser -> String

showList :: [Key SnapAuthUser] -> ShowS

ToJSON (Key SnapAuthUser)

Methods

toJSON :: Key SnapAuthUser -> Value

toEncoding :: Key SnapAuthUser -> Encoding

toJSONList :: [Key SnapAuthUser] -> Value

toEncodingList :: [Key SnapAuthUser] -> Encoding

FromJSON (Key SnapAuthUser)

Methods

parseJSON :: Value -> Parser (Key SnapAuthUser)

parseJSONList :: Value -> Parser [Key SnapAuthUser]

ToHttpApiData (Key SnapAuthUser)

Methods

toUrlPiece :: Key SnapAuthUser -> Text

toEncodedUrlPiece :: Key SnapAuthUser -> Builder

toHeader :: Key SnapAuthUser -> ByteString

toQueryParam :: Key SnapAuthUser -> Text

FromHttpApiData (Key SnapAuthUser)

Methods

parseUrlPiece :: Text -> Either Text (Key SnapAuthUser)

parseHeader :: ByteString -> Either Text (Key SnapAuthUser)

parseQueryParam :: Text -> Either Text (Key SnapAuthUser)

PathPiece (Key SnapAuthUser)

Methods

fromPathPiece :: Text -> Maybe (Key SnapAuthUser)

toPathPiece :: Key SnapAuthUser -> Text

PersistFieldSql (Key SnapAuthUser)

Methods

sqlType :: Proxy * (Key SnapAuthUser) -> SqlType

PersistField (Key SnapAuthUser)

Methods

toPersistValue :: Key SnapAuthUser -> PersistValue

fromPersistValue :: PersistValue -> Either Text (Key SnapAuthUser)

data Unique SnapAuthUser

data Unique SnapAuthUser

data EntityField SnapAuthUser

data EntityField SnapAuthUser where

• SnapAuthUserId :: EntityField SnapAuthUser typ
• SnapAuthUserLogin :: EntityField SnapAuthUser typ
• SnapAuthUserEmail :: EntityField SnapAuthUser typ
• SnapAuthUserPassword :: EntityField SnapAuthUser typ
• SnapAuthUserActivatedAt :: EntityField SnapAuthUser typ
• SnapAuthUserSuspendedAt :: EntityField SnapAuthUser typ
• SnapAuthUserRememberToken :: EntityField SnapAuthUser typ
• SnapAuthUserLoginCount :: EntityField SnapAuthUser typ
• SnapAuthUserFailedLoginCount :: EntityField SnapAuthUser typ
• SnapAuthUserLockedOutUntil :: EntityField SnapAuthUser typ
• SnapAuthUserCurrentLoginAt :: EntityField SnapAuthUser typ
• SnapAuthUserLastLoginAt :: EntityField SnapAuthUser typ
• SnapAuthUserCurrentIp :: EntityField SnapAuthUser typ
• SnapAuthUserLastIp :: EntityField SnapAuthUser typ
• SnapAuthUserCreatedAt :: EntityField SnapAuthUser typ
• SnapAuthUserUpdatedAt :: EntityField SnapAuthUser typ
• SnapAuthUserResetToken :: EntityField SnapAuthUser typ
• SnapAuthUserResetRequestedAt :: EntityField SnapAuthUser typ
• SnapAuthUserRoles :: EntityField SnapAuthUser typ
• SnapAuthUserMeta :: EntityField SnapAuthUser typ

data Key SnapAuthUser

data Key SnapAuthUser = SnapAuthUserKey {

• unSnapAuthUserKey :: BackendKey SqlBackend

}

type PersistEntityBackend SnapAuthUser

type PersistEntityBackend SnapAuthUser = SqlBackend

type SnapAuthUserId = Key SnapAuthUser

migrateAuth :: Migration

db2au :: Entity SnapAuthUser -> AuthUser

Function to convert a SnapAuthUser entity into the auth snaplet's AuthUser.

dbUserSplices :: Monad n => Splices (RuntimeSplice n (Entity SnapAuthUser) -> Splice n)

Splices for SnapAuthUser that are equivalent to the ones for AuthUser.

userDBKey :: AuthUser -> Maybe SnapAuthUserId

Get the db key from an AuthUser

textPassword :: Password -> Text