Copyright	Alexander Krupenkin 2016
License	BSD3
Maintainer	email@something.com
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Web.Bot

Contents

Story & message types
Story makers
Bot monad & configuration classes
Bot platforms
Bot storage
Bot runners
Re-exports

Description

Text message bot framework for creating story like:

     helloStory :: BotConfig a => Story a
     helloStory _ = hello $ question "How your name?"
                          * question "How your surname?"
                          * question "How old are you?"

Synopsis

Story & message types

class ToMessage a where Source #

Convert any data to message

Minimal complete definition

toMessage

Methods

toMessage :: a -> Message Source #

Instances

ToMessage Text Source #
Methods toMessage :: Text -> Message Source #
ToMessage Message Source #
Methods toMessage :: Message -> Message Source #

class Answer a where Source #

User message reply parser.

Minimal complete definition

parse

Methods

parse :: MonadIO m => Message -> ExceptT Text m a Source #

Instances

Answer Double Source #
Methods parse :: MonadIO m => Message -> ExceptT Text m Double Source #
Answer Int Source #
Methods parse :: MonadIO m => Message -> ExceptT Text m Int Source #
Answer Integer Source #
Methods parse :: MonadIO m => Message -> ExceptT Text m Integer Source #
Answer Word Source #
Methods parse :: MonadIO m => Message -> ExceptT Text m Word Source #
Answer Text Source #
Methods parse :: MonadIO m => Message -> ExceptT Text m Text Source #

data Message Source #

Generalized message type

Instances

Eq Message Source #
Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Methods compare :: Message -> Message -> Ordering # (<) :: Message -> Message -> Bool # (<=) :: Message -> Message -> Bool # (>) :: Message -> Message -> Bool # (>=) :: Message -> Message -> Bool # max :: Message -> Message -> Message # min :: Message -> Message -> Message #
Show Message Source #
Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
IsString Message Source #
Methods fromString :: String -> Message #
ToMessage Message Source #
Methods toMessage :: Message -> Message Source #

type StoryT = Pipe Message Message Source #

Story transformer is based on Pipe with fixed Message in/out.

type Story a = User -> StoryT (Bot a) Message Source #

Story is a pipe from user message to bot message and result is a final bot message.

data User Source #

Instances

Show User Source #
Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
PersistFieldSql User Source #
Methods sqlType :: Proxy * User -> SqlType #
PersistEntity User Source #
Associated Types type PersistEntityBackend User :: * # data Key User :: * # data EntityField User a :: * # data Unique User :: * # Methods keyToValues :: Key User -> [PersistValue] # keyFromValues :: [PersistValue] -> Either Text (Key User) # persistIdField :: EntityField User (Key User) # entityDef :: Monad m => m User -> EntityDef # persistFieldDef :: EntityField User typ -> FieldDef # toPersistFields :: User -> [SomePersistField] # fromPersistValues :: [PersistValue] -> Either Text User # persistUniqueKeys :: User -> [Unique User] # persistUniqueToFieldNames :: Unique User -> [(HaskellName, DBName)] # persistUniqueToValues :: Unique User -> [PersistValue] # fieldLens :: EntityField User field -> forall f. Functor f => (field -> f field) -> Entity User -> f (Entity User) #
PersistField User Source #
Methods toPersistValue :: User -> PersistValue # fromPersistValue :: PersistValue -> Either Text User #
ToBackendKey SqlBackend User Source #
Methods toBackendKey :: Key User -> BackendKey SqlBackend # fromBackendKey :: BackendKey SqlBackend -> Key User #
Eq (Key User) Source #
Methods (==) :: Key User -> Key User -> Bool # (/=) :: Key User -> Key User -> Bool #
Ord (Key User) Source #
Methods compare :: Key User -> Key User -> Ordering # (<) :: Key User -> Key User -> Bool # (<=) :: Key User -> Key User -> Bool # (>) :: Key User -> Key User -> Bool # (>=) :: Key User -> Key User -> Bool # max :: Key User -> Key User -> Key User # min :: Key User -> Key User -> Key User #
Read (Key User) Source #
Methods readsPrec :: Int -> ReadS (Key User) # readList :: ReadS [Key User] # readPrec :: ReadPrec (Key User) # readListPrec :: ReadPrec [Key User] #
Show (Key User) Source #
Methods showsPrec :: Int -> Key User -> ShowS # show :: Key User -> String # showList :: [Key User] -> ShowS #
ToJSON (Key User) Source #
Methods toJSON :: Key User -> Value # toEncoding :: Key User -> Encoding # toJSONList :: [Key User] -> Value # toEncodingList :: [Key User] -> Encoding #
FromJSON (Key User) Source #
Methods parseJSON :: Value -> Parser (Key User) # parseJSONList :: Value -> Parser [Key User] #
ToHttpApiData (Key User) Source #
Methods toUrlPiece :: Key User -> Text # toHeader :: Key User -> ByteString # toQueryParam :: Key User -> Text #
FromHttpApiData (Key User) Source #
Methods parseUrlPiece :: Text -> Either Text (Key User) # parseHeader :: ByteString -> Either Text (Key User) # parseQueryParam :: Text -> Either Text (Key User) #
PathPiece (Key User) Source #
Methods fromPathPiece :: Text -> Maybe (Key User) # toPathPiece :: Key User -> Text #
PersistFieldSql (Key User) Source #
Methods sqlType :: Proxy * (Key User) -> SqlType #
PersistField (Key User) Source #
Methods toPersistValue :: Key User -> PersistValue # fromPersistValue :: PersistValue -> Either Text (Key User) #
data Unique User Source #
data Unique User = UserIdentity Text
data EntityField User Source #
data EntityField User where UserId :: EntityField User typ UserChat :: EntityField User typ UserName :: EntityField User typ UserIdent :: EntityField User typ
data Key User Source #
data Key User = UserKey { unUserKey :: BackendKey SqlBackend }
type PersistEntityBackend User Source #
type PersistEntityBackend User = SqlBackend

Story makers

question :: (MonadIO m, Answer a) => Text -> StoryT m a Source #

Bot text question.

replica :: (ToMessage a, MonadIO m, Answer b) => a -> StoryT m b Source #

Generalized story maker. The replica send message to user, when answer isn't parsed the error be sended and wait for correct answer.

select :: (MonadIO m, Answer a) => Text -> [[Text]] -> StoryT m a Source #

Reply keyboard selection

Bot monad & configuration classes

data Bot a b Source #

Message bot monad

Instances

MonadBaseControl IO (Bot a) Source #
Associated Types type StM (Bot a :: * -> ) a :: # Methods liftBaseWith :: (RunInBase (Bot a) IO -> IO a) -> Bot a a # restoreM :: StM (Bot a) a -> Bot a a #
MonadBase IO (Bot a) Source #
Methods liftBase :: IO α -> Bot a α #
Monad (Bot a) Source #
Methods (>>=) :: Bot a a -> (a -> Bot a b) -> Bot a b # (>>) :: Bot a a -> Bot a b -> Bot a b # return :: a -> Bot a a # fail :: String -> Bot a a #
Functor (Bot a) Source #
Methods fmap :: (a -> b) -> Bot a a -> Bot a b # (<$) :: a -> Bot a b -> Bot a a #
Applicative (Bot a) Source #
Methods pure :: a -> Bot a a # (<>) :: Bot a (a -> b) -> Bot a a -> Bot a b # (>) :: Bot a a -> Bot a b -> Bot a b # (<*) :: Bot a a -> Bot a b -> Bot a a #
MonadIO (Bot a) Source #
Methods liftIO :: IO a -> Bot a a #
MonadLogger (Bot a) Source #
Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> Bot a () #
type StM (Bot a) b Source #
type StM (Bot a) b = b

class Platform a where Source #

Message bot platform. Different platforms provide message bot API, e.g. Telegram, Viber, Facebook Messenger etc. This is generalized interface to it.

Minimal complete definition

trySelf, sendMessage, messageHandler, platformName

Methods

trySelf :: APIToken a => Bot a () Source #

Try connection to platform API

sendMessage :: (ToMessage msg, APIToken a) => User -> msg -> Bot a () Source #

Send message to user by platform API

messageHandler :: APIToken a => (User -> Message -> Bot a b) -> Bot a c Source #

Get user updates by platform API

platformName :: a -> Text Source #

Short description of platform

Instances

Platform Telegram Source #
Methods trySelf :: Bot Telegram () Source # sendMessage :: (ToMessage msg, APIToken Telegram) => User -> msg -> Bot Telegram () Source # messageHandler :: APIToken Telegram => (User -> Message -> Bot Telegram b) -> Bot Telegram c Source # platformName :: Telegram -> Text Source #

class Platform a => APIToken a where Source #

Bot authentification in platform Instance of it should be writen by user

Minimal complete definition

apiToken

Methods

apiToken :: Bot a Text Source #

Platform API token

Bot platforms

data Telegram Source #

Telegram Bot API 2.0 platform

Instances

Platform Telegram Source #
Methods trySelf :: Bot Telegram () Source # sendMessage :: (ToMessage msg, APIToken Telegram) => User -> msg -> Bot Telegram () Source # messageHandler :: APIToken Telegram => (User -> Message -> Bot Telegram b) -> Bot Telegram c Source # platformName :: Telegram -> Text Source #

Bot storage

class Platform a => Persist a where Source #

Connection info provider

Minimal complete definition

persist

Methods

persist :: Bot a Connection Source #

data Connection Source #

Database connection information

Constructors

Postgresql ConnectionString
Sqlite Text
MySQL ConnectInfo

Instances

Eq Connection Source #
Methods (==) :: Connection -> Connection -> Bool # (/=) :: Connection -> Connection -> Bool #
Read Connection Source #
Methods readsPrec :: Int -> ReadS Connection # readList :: ReadS [Connection] # readPrec :: ReadPrec Connection # readListPrec :: ReadPrec [Connection] #
Show Connection Source #
Methods showsPrec :: Int -> Connection -> ShowS # show :: Connection -> String # showList :: [Connection] -> ShowS #

data ConnectInfo :: * #

Constructors

ConnectInfo
Fields connectHost :: String connectPort :: Word16 connectUser :: String connectPassword :: String connectDatabase :: String connectOptions :: [Option] connectPath :: FilePath connectSSL :: Maybe SSLInfo

Instances

Eq ConnectInfo
Methods (==) :: ConnectInfo -> ConnectInfo -> Bool # (/=) :: ConnectInfo -> ConnectInfo -> Bool #
Read ConnectInfo
Methods readsPrec :: Int -> ReadS ConnectInfo # readList :: ReadS [ConnectInfo] # readPrec :: ReadPrec ConnectInfo # readListPrec :: ReadPrec [ConnectInfo] #
Show ConnectInfo
Methods showsPrec :: Int -> ConnectInfo -> ShowS # show :: ConnectInfo -> String # showList :: [ConnectInfo] -> ShowS #

Bot runners

storyBot :: (Persist a, APIToken a, ToMessage help) => help -> Map Message (Story a) -> Bot a () Source #

User story handler

forkBot :: APIToken a => Bot a () -> Bot a ThreadId Source #

Fork bot thread

runBot :: (APIToken a, MonadIO m) => Bot a b -> m b Source #

Run bot monad

Re-exports

yield :: Monad m => a -> Producer' a m () #

Produce a value

yield :: Monad m => a -> Pipe x a m ()

await :: Monad m => Consumer' a m a #

Consume a value

await :: Monad m => Pipe a y m a

lift :: MonadTrans t => forall m a. Monad m => m a -> t m a #

Lift a computation from the argument monad to the constructed monad.