Marvin.Internal.Types

Documentation

type Topic = Text

type Message = Text

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

Instances

HasCustoms (Handlers a0) (Vector (Event a0 -> Maybe (RunnerM ())))

Methods

customs :: Lens' (Handlers a0) (Vector (Event a0 -> Maybe (RunnerM ())))

newtype AdapterM a r

Constructors

AdapterM

Fields

• runAdapterAction :: ReaderT (Config, a) RunnerM r

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

type EventHandler a = Event a -> IO ()

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

class IsAdapter a where

Basic functionality required of any adapter

Minimal complete definition

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

Associated Types

type User a

type Channel a

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

Initialize and 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 identifier 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))

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)))

MkSlack a => IsAdapter (SlackAdapter a)

Associated Types

type User (SlackAdapter a) :: *

type Channel (SlackAdapter a) :: *

Methods

adapterId :: AdapterId (SlackAdapter a)

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

initAdapter :: RunnerM (SlackAdapter a)

runWithAdapter :: RunWithAdapter (SlackAdapter a)

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

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

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

newtype User' a

Constructors

User'

Fields

• unwrapUser' :: User a

Instances

HasTopicChange (Handlers a0) (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ()))

Methods

topicChange :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ()))

HasResponds (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

Methods

responds :: Lens' (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

HasLeaves (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

Methods

leaves :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

HasJoins (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

Methods

joins :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

HasHears (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

Methods

hears :: Lens' (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

HasTopicChangeIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ())))

Methods

topicChangeIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ())))

HasLeavesFrom (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Methods

leavesFrom :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

HasJoinsIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Methods

joinsIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Get (User' a, b, c) (User' a)

Methods

getLens :: Lens' (User' a, b, c) (User' a)

Get (User' a, b, c, d) (User' a)

Methods

getLens :: Lens' (User' a, b, c, d) (User' a)

Get (User' a, b, c, d, e) (User' a)

Methods

getLens :: Lens' (User' a, b, c, d, e) (User' a)

newtype Channel' a

Constructors

Channel'

Fields

• unwrapChannel' :: Channel a

Instances

HasTopicChange (Handlers a0) (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ()))

Methods

topicChange :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ()))

HasResponds (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

Methods

responds :: Lens' (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

HasLeaves (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

Methods

leaves :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

HasJoins (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

Methods

joins :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

HasHears (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

Methods

hears :: Lens' (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

HasTopicChangeIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ())))

Methods

topicChangeIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ())))

HasLeavesFrom (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Methods

leavesFrom :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

HasJoinsIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Methods

joinsIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Get (a, Channel' b, c) (Channel' b)

Methods

getLens :: Lens' (a, Channel' b, c) (Channel' b)

Get (a, Channel' b, c, d) (Channel' b)

Methods

getLens :: Lens' (a, Channel' b, c, d) (Channel' b)

Get (a, Channel' b, c, d, e) (Channel' b)

Methods

getLens :: Lens' (a, Channel' b, c, d, e) (Channel' b)

newtype TimeStamp

Constructors

TimeStamp

Fields

• unwrapTimeStamp :: UTCTime

Instances

Show TimeStamp

Methods

showsPrec :: Int -> TimeStamp -> ShowS

show :: TimeStamp -> String

showList :: [TimeStamp] -> ShowS

HasTopicChange (Handlers a0) (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ()))

Methods

topicChange :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ()))

HasResponds (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

Methods

responds :: Lens' (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

HasLeaves (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

Methods

leaves :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

HasJoins (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

Methods

joins :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ()))

HasHears (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

Methods

hears :: Lens' (Handlers a0) (Vector (Regex, (User' a0, Channel' a0, Match, Message, TimeStamp) -> RunnerM ()))

HasTopicChangeIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ())))

Methods

topicChangeIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, Topic, TimeStamp) -> RunnerM ())))

HasLeavesFrom (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Methods

leavesFrom :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

HasJoinsIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Methods

joinsIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0, TimeStamp) -> RunnerM ())))

Get (a, b, TimeStamp) TimeStamp

Methods

getLens :: Lens' (a, b, TimeStamp) TimeStamp

Get (a, b, c, TimeStamp) TimeStamp

Methods

getLens :: Lens' (a, b, c, TimeStamp) TimeStamp

Get (a, b, c, d, TimeStamp) TimeStamp

Methods

getLens :: Lens' (a, b, c, d, TimeStamp) TimeStamp

timestampFromNumber :: Value -> Parser TimeStamp

newtype ScriptId

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

Constructors

ScriptId

Fields

• unwrapScriptId :: Text

Instances

Eq ScriptId

Methods

(==) :: ScriptId -> ScriptId -> Bool

(/=) :: ScriptId -> ScriptId -> Bool

Show ScriptId

Methods

showsPrec :: Int -> ScriptId -> ShowS

show :: ScriptId -> String

showList :: [ScriptId] -> ShowS

IsString ScriptId

Methods

fromString :: String -> ScriptId

ShowT ScriptId

Methods

showT :: ScriptId -> Text

showListT :: [ScriptId] -> Text

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

newtype AdapterId a

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

Constructors

AdapterId

Fields

• unwrapAdapterId :: Text

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

applicationScriptId :: ScriptId

type RunnerM = LoggingT IO

verifyIdString :: String -> (String -> a) -> String -> a

class HasScriptId s a | s -> a where

Minimal complete definition

scriptId

Methods

scriptId :: Lens' s a

Instances

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

class (IsScript m, MonadIO m) => HasConfigAccess m where

Denotes a place from which we may access the configuration.

During script definition or when handling a request we can obtain the config with getConfigVal or requireConfigVal.

Minimal complete definition

getConfigInternal

Methods

getConfigInternal :: m Config

INTERNAL USE WITH CARE

Obtain the entire config structure

Instances

HasConfigAccess (ScriptDefinition a)

Methods

getConfigInternal :: ScriptDefinition a Config

HasConfigAccess (BotReacting a b)

Methods

getConfigInternal :: BotReacting a b Config

class IsScript m where

Minimal complete definition

getScriptId

Methods

getScriptId :: m ScriptId

Instances

IsScript (ScriptDefinition a)

Methods

getScriptId :: ScriptDefinition a ScriptId

IsScript (BotReacting a b)

Methods

getScriptId :: BotReacting a b ScriptId

class AccessAdapter m where

Minimal complete definition

getAdapter

Associated Types

type AdapterT m

Methods

getAdapter :: m (AdapterT m)

Instances

AccessAdapter (AdapterM a)

Associated Types

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

Methods

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

AccessAdapter (ScriptDefinition a)

Associated Types

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

Methods

getAdapter :: ScriptDefinition a (AdapterT (ScriptDefinition a))

AccessAdapter (BotReacting a b)

Associated Types

type AdapterT (BotReacting a b :: * -> *) :: *

Methods

getAdapter :: BotReacting a b (AdapterT (BotReacting a b))

Orphan instances

Configured LogLevel

Methods

convert :: Value -> Maybe LogLevel

convertList :: Value -> Maybe [LogLevel]