Marvin.Adapter

Documentation

type RunWithAdapter a = EventHandler a -> AdapterM a ()

type EventHandler a = Event a -> IO ()

class IsAdapter a where

Basic functionality required of any adapter

Minimal complete definition

adapterId, messageChannel, initAdapter, runWithAdapter, getUsername, getChannelName, resolveChannel, resolveUser

Associated Types

type User a

Concrete, adapter specific representation of a user. Could be an id string or a full object for instance

type Channel a

Concrete, adapter specific representation of a channel. Could be an id string or a full object for instance

Methods

adapterId :: AdapterId a

Used for scoping config and logging

messageChannel :: Channel a -> Text -> AdapterM a ()

Post a message to a channel given the internal channel identifier

initAdapter :: RunnerM a

Initialize the adapter state

runWithAdapter :: RunWithAdapter a

Run the bot

getUsername :: User a -> AdapterM a Text

Resolve a username given the internal user identifier

getChannelName :: Channel a -> AdapterM a Text

Resolve the human readable name for a channel given the internal channel identifier

resolveChannel :: Text -> AdapterM a (Maybe (Channel a))

Resolve to the internal channel structure given a human readable name

resolveUser :: Text -> AdapterM a (Maybe (User a))

Resolve to the internal user structure given a human readable name

Instances

IsAdapter ShellAdapter

Associated Types

type User ShellAdapter :: *

type Channel ShellAdapter :: *

Methods

adapterId :: AdapterId ShellAdapter

messageChannel :: Channel ShellAdapter -> Text -> AdapterM ShellAdapter ()

initAdapter :: RunnerM ShellAdapter

runWithAdapter :: RunWithAdapter ShellAdapter

getUsername :: User ShellAdapter -> AdapterM ShellAdapter Text

getChannelName :: Channel ShellAdapter -> AdapterM ShellAdapter Text

resolveChannel :: Text -> AdapterM ShellAdapter (Maybe (Channel ShellAdapter))

resolveUser :: Text -> AdapterM ShellAdapter (Maybe (User ShellAdapter))

MkTelegram a => IsAdapter (TelegramAdapter a)

Associated Types

type User (TelegramAdapter a) :: *

type Channel (TelegramAdapter a) :: *

Methods

adapterId :: AdapterId (TelegramAdapter a)

messageChannel :: Channel (TelegramAdapter a) -> Text -> AdapterM (TelegramAdapter a) ()

initAdapter :: RunnerM (TelegramAdapter a)

runWithAdapter :: RunWithAdapter (TelegramAdapter a)

getUsername :: User (TelegramAdapter a) -> AdapterM (TelegramAdapter a) Text

getChannelName :: Channel (TelegramAdapter a) -> AdapterM (TelegramAdapter a) Text

resolveChannel :: Text -> AdapterM (TelegramAdapter a) (Maybe (Channel (TelegramAdapter a)))

resolveUser :: Text -> AdapterM (TelegramAdapter a) (Maybe (User (TelegramAdapter a)))

data AdapterId a

A type, basically a String, which identifies an adapter to the config and the logging facilities.

For conversion please use mkAdapterId and unwrapAdapterId. They will perform necessary checks.

Instances

Eq (AdapterId a)

Methods

(==) :: AdapterId a -> AdapterId a -> Bool

(/=) :: AdapterId a -> AdapterId a -> Bool

Show (AdapterId a)

Methods

showsPrec :: Int -> AdapterId a -> ShowS

show :: AdapterId a -> String

showList :: [AdapterId a] -> ShowS

IsString (AdapterId a)

Methods

fromString :: String -> AdapterId a

ShowT (AdapterId a)

Methods

showT :: AdapterId a -> Text

showListT :: [AdapterId a] -> Text

mkAdapterId :: Text -> Either String (AdapterId a)

Attempt to create an adapter id from Text

unwrapAdapterId :: AdapterId a -> Text

data AdapterM a r

Monad in which adapter actions run in

Instances

MonadBaseControl IO (AdapterM a)

Associated Types

type StM (AdapterM a :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase (AdapterM a) IO -> IO a) -> AdapterM a a

restoreM :: StM (AdapterM a) a -> AdapterM a a

MonadBase IO (AdapterM a)

Methods

liftBase :: IO α -> AdapterM a α

Monad (AdapterM a)

Methods

(>>=) :: AdapterM a a -> (a -> AdapterM a b) -> AdapterM a b

(>>) :: AdapterM a a -> AdapterM a b -> AdapterM a b

return :: a -> AdapterM a a

fail :: String -> AdapterM a a

Functor (AdapterM a)

Methods

fmap :: (a -> b) -> AdapterM a a -> AdapterM a b

(<$) :: a -> AdapterM a b -> AdapterM a a

Applicative (AdapterM a)

Methods

pure :: a -> AdapterM a a

(<*>) :: AdapterM a (a -> b) -> AdapterM a a -> AdapterM a b

(*>) :: AdapterM a a -> AdapterM a b -> AdapterM a b

(<*) :: AdapterM a a -> AdapterM a b -> AdapterM a a

MonadIO (AdapterM a)

Methods

liftIO :: IO a -> AdapterM a a

MonadLogger (AdapterM a)

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> AdapterM a ()

MonadLoggerIO (AdapterM a)

Methods

askLoggerIO :: AdapterM a (Loc -> LogSource -> LogLevel -> LogStr -> IO ())

AccessAdapter (AdapterM a)

Associated Types

type AdapterT (AdapterM a :: * -> *) :: *

Methods

getAdapter :: AdapterM a (AdapterT (AdapterM a))

type AdapterT (AdapterM a)

type AdapterT (AdapterM a) = a

type StM (AdapterM a) r

type StM (AdapterM a) r = r

data Event a

Representation for the types of events which can occur

Constructors

MessageEvent (User a) (Channel a) Message TimeStamp

CommandEvent (User a) (Channel a) Message TimeStamp

ChannelJoinEvent (User a) (Channel a) TimeStamp

ChannelLeaveEvent (User a) (Channel a) TimeStamp

TopicChangeEvent (User a) (Channel a) Topic TimeStamp

lookupFromAdapterConfig :: (IsAdapter a, Configured v) => Name -> AdapterM a (Maybe v)

requireFromAdapterConfig :: (IsAdapter a, Configured v) => Name -> AdapterM a v

lookupFromAppConfig :: Configured v => Name -> AdapterM a (Maybe v)

requireFromAppConfig :: Configured v => Name -> AdapterM a v

getBotname :: AdapterM a Text

getAdapterConfig :: forall a. IsAdapter a => AdapterM a Config

getAppConfig :: AdapterM a Config

getAdapter :: AccessAdapter m => m (AdapterT m)

liftAdapterAction :: (MonadIO m, HasConfigAccess m, AccessAdapter m, IsAdapter a, a ~ AdapterT m) => AdapterM a r -> m r