Marvin

Scripts

data Script a

An abstract type describing a marvin script.

This is basically a collection of event handlers.

Internal structure is exposed for people wanting to extend this.

Constructors

Script [WrappedAction a] ScriptId Config a

Instances

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasConfig (Script a0) Config

Methods

config :: Lens' (Script a0) Config

HasAdapter (Script a0) a0

Methods

adapter :: Lens' (Script a0) a0

defineScript :: ScriptId -> ScriptDefinition a () -> ScriptInit a

Define a new script for marvin

You need to provide a ScriptId (which can simple be written as a non-empty string). This id is used as the key for the section in the bot config belonging to this script and in logging output.

Roughly equivalent to "module.exports" in hubot.

data ScriptInit a

Initializer for a script. This gets run by the server during startup and creates a Script

data ScriptId

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

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

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

data ScriptDefinition a r

A monad for gradually defining a Script using respond and hear as well as any IO action.

Instances

Monad (ScriptDefinition a)

Methods

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

(>>) :: ScriptDefinition a a -> ScriptDefinition a b -> ScriptDefinition a b

return :: a -> ScriptDefinition a a

fail :: String -> ScriptDefinition a a

Functor (ScriptDefinition a)

Methods

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

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

Applicative (ScriptDefinition a)

Methods

pure :: a -> ScriptDefinition a a

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

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

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

MonadIO (ScriptDefinition a)

Methods

liftIO :: IO a -> ScriptDefinition a a

IsScript (ScriptDefinition a)

Methods

getScriptId :: ScriptDefinition a ScriptId

HasConfigAccess (ScriptDefinition a)

Methods

getConfigInternal :: ScriptDefinition a Config

class IsAdapter a

Minimal complete definition

adapterId, messageChannel, runWithAdapter, getUsername, getChannelName, resolveChannel

Instances

IsAdapter SlackRTMAdapter

Methods

adapterId :: AdapterId SlackRTMAdapter

messageChannel :: SlackRTMAdapter -> Channel -> String -> IO ()

runWithAdapter :: RunWithAdapter SlackRTMAdapter

getUsername :: SlackRTMAdapter -> User -> IO String

getChannelName :: SlackRTMAdapter -> Channel -> IO String

resolveChannel :: SlackRTMAdapter -> String -> IO (Maybe Channel)

Reacting

hear :: Regex -> BotReacting a MessageReactionData () -> ScriptDefinition a ()

Whenever any message matches the provided regex this handler gets run.

Equivalent to "robot.hear" in hubot

respond :: Regex -> BotReacting a MessageReactionData () -> ScriptDefinition a ()

Runs the handler only if the bot was directly addressed.

Equivalent to "robot.respond" in hubot

customTrigger :: (Event -> Maybe d) -> BotReacting a d () -> ScriptDefinition a ()

Extension point for the user

Allows you to handle the raw event yourself. Returning Nothing from the trigger function means you dont want to react to the event. The value returned inside the Just is available in the handler later using getData.

send :: (IsAdapter a, HasMessage m) => String -> BotReacting a m ()

Send a message to the channel the triggering message came from.

Equivalent to "robot.send" in hubot

reply :: (IsAdapter a, HasMessage m) => String -> BotReacting a m ()

Send a message to the channel the original message came from and address the user that sent the original message.

Equivalent to "robot.reply" in hubot

messageChannel :: (AccessAdapter m, IsAdapter (AdapterT m), IsScript m, MonadIO m) => String -> String -> m ()

Send a message to a Channel (by name)

getData :: BotReacting a d d

Obtain the event reaction data.

The type of this data depends on the reacion function used. For instance hear and respond will contain MessageReactionData. The actual contents comes from the event itself and was put together by the trigger.

getMessage :: HasMessage m => BotReacting a m Message

Get the message that triggered this action Includes sender, target channel, as well as the full, untruncated text of the original message

getMatch :: HasMatch m => BotReacting a m Match

Get the results from matching the regular expression.

Equivalent to "msg.match" in hubot.

getUsername :: (AccessAdapter m, IsAdapter (AdapterT m), MonadIO m) => User -> m String

Get the username of a registered user.

getChannelName :: (AccessAdapter m, IsAdapter (AdapterT m), MonadIO m) => Channel -> m String

Get the human readable name of a channel.

data Message

Constructors

Message

Fields

• sender :: User
• channel :: Channel
• content :: String
• timestamp :: TimeStamp

Instances

HasMessageField MessageReactionData Message

Methods

messageField :: Lens' MessageReactionData Message

data User

Instances

Eq User

Methods

(==) :: User -> User -> Bool

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

IsString User

Methods

fromString :: String -> User

ToJSON User

Methods

toJSON :: User -> Value

toEncoding :: User -> Encoding

FromJSON User

Methods

parseJSON :: Value -> Parser User

Hashable User

Methods

hashWithSalt :: Int -> User -> Int

hash :: User -> Int

data Channel

Instances

Eq Channel

Methods

(==) :: Channel -> Channel -> Bool

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

Show Channel

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

IsString Channel

Methods

fromString :: String -> Channel

ToJSON Channel

Methods

toJSON :: Channel -> Value

toEncoding :: Channel -> Encoding

FromJSON Channel

Methods

parseJSON :: Value -> Parser Channel

Hashable Channel

Methods

hashWithSalt :: Int -> Channel -> Int

hash :: Channel -> Int

getConfigVal :: (Configured a, HasConfigAccess m) => Name -> m (Maybe a)

Get a value out of the config, returns Nothing if the value didn't exist.

This config is the config for this script. Ergo all config vars registered under the config section for the ScriptId of this script.

The HasConfigAccess Constraint means this function can be used both during script definition and when a handler is run.

requireConfigVal :: (Configured a, HasConfigAccess m) => Name -> m a

Get a value out of the config and fail with an error if the specified key is not found.

This config is the config for this script. Ergo all config vars registered under the config section for the ScriptId of this script.

The HasConfigAccess Constraint means this function can be used both during script definition and when a handler is run.

data BotReacting a d r

Monad for reacting in the bot. Allows use of functions like send, reply and messageChannel as well as any arbitrary IO action using liftIO.

The type parameter d is the accessible data provided by the trigger for this action and can be obtained with getData or other custom functions like getMessage and getMatch which typically depend on a particular type of data in d. For message handlers like hear and respond this would be a regex Match and a Message for instance.

For completeness: a is the adapter type and r is the return type of the monadic computation.

This is also a MonadReader instance, there you can inspect the entire state of this reaction. This is typically only used in internal or utility functions and not necessary for the user. To inspect particular pieces of this state refer to the *Lenses* section.

Instances

Monad (BotReacting a d)

Methods

(>>=) :: BotReacting a d a -> (a -> BotReacting a d b) -> BotReacting a d b

(>>) :: BotReacting a d a -> BotReacting a d b -> BotReacting a d b

return :: a -> BotReacting a d a

fail :: String -> BotReacting a d a

Functor (BotReacting a d)

Methods

fmap :: (a -> b) -> BotReacting a d a -> BotReacting a d b

(<$) :: a -> BotReacting a d b -> BotReacting a d a

Applicative (BotReacting a d)

Methods

pure :: a -> BotReacting a d a

(<*>) :: BotReacting a d (a -> b) -> BotReacting a d a -> BotReacting a d b

(*>) :: BotReacting a d a -> BotReacting a d b -> BotReacting a d b

(<*) :: BotReacting a d a -> BotReacting a d b -> BotReacting a d a

MonadIO (BotReacting a d)

Methods

liftIO :: IO a -> BotReacting a d a

IsScript (BotReacting a b)

Methods

getScriptId :: BotReacting a b ScriptId

HasConfigAccess (BotReacting a b)

Methods

getConfigInternal :: BotReacting a b Config

MonadReader (BotActionState a d) (BotReacting a d)

Methods

ask :: BotReacting a d (BotActionState a d)

local :: (BotActionState a d -> BotActionState a d) -> BotReacting a d a -> BotReacting a d a

reader :: (BotActionState a d -> a) -> BotReacting a d a

class HasMessage m where

Class which says that there is a way to get to a Message from this type m.

Minimal complete definition

messageLens

Methods

messageLens :: Lens' m Message

Instances

HasMessageField m Message => HasMessage m

Methods

messageLens :: Lens' m Message

class HasMatch m where

Class which says that there is a way to get to a Match from this type m.

Minimal complete definition

matchLens

Methods

matchLens :: Lens' m Match

Instances

HasMatchField m Match => HasMatch m

Methods

matchLens :: Lens' m Match

Advanced actions

extractAction :: BotReacting a () o -> ScriptDefinition a (IO o)

Take an action and produce an IO action with the same effect. Useful for creating actions which can be scheduled to execute a certain time or asynchronous. The idea is that one can conveniently send messages from inside a schedulable action.

extractReaction :: BotReacting a s o -> BotReacting a s (IO o)

Take a reaction and produce an IO action with the same effect. Useful for creating actions which can be scheduled to execute a certain time or asynchronous. The idea is that one can conveniently send messages from inside a schedulable action.

Lenses and internal types

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 HasConfig s a | s -> a where

Minimal complete definition

config

Methods

config :: Lens' s a

Instances

HasConfig (Script a0) Config

Methods

config :: Lens' (Script a0) Config

HasConfig (BotActionState a0 d0) Config

Methods

config :: Lens' (BotActionState a0 d0) Config

class HasAdapter s a | s -> a where

Minimal complete definition

adapter

Methods

adapter :: Lens' s a

Instances

HasAdapter (Script a0) a0

Methods

adapter :: Lens' (Script a0) a0

HasAdapter (BotActionState a0 d0) a0

Methods

adapter :: Lens' (BotActionState a0 d0) a0

class HasMessageField s a | s -> a where

Minimal complete definition

messageField

Methods

messageField :: Lens' s a

Instances

HasMessageField MessageReactionData Message

Methods

messageField :: Lens' MessageReactionData Message

class HasMatchField s a | s -> a where

Minimal complete definition

matchField

Methods

matchField :: Lens' s a

Instances

HasMatchField MessageReactionData Match

Methods

matchField :: Lens' MessageReactionData Match

class HasVariable s a | s -> a where

Minimal complete definition

variable

Methods

variable :: Lens' s a

Instances

HasVariable (BotActionState a0 d0) d0

Methods

variable :: Lens' (BotActionState a0 d0) d0

data BotActionState a d

Read only data available to a handler when the bot reacts to an event.

Constructors

BotActionState ScriptId Config a d

Instances

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

HasVariable (BotActionState a0 d0) d0

Methods

variable :: Lens' (BotActionState a0 d0) d0

HasConfig (BotActionState a0 d0) Config

Methods

config :: Lens' (BotActionState a0 d0) Config

HasAdapter (BotActionState a0 d0) a0

Methods

adapter :: Lens' (BotActionState a0 d0) a0

MonadReader (BotActionState a d) (BotReacting a d)

Methods

ask :: BotReacting a d (BotActionState a d)

local :: (BotActionState a d -> BotActionState a d) -> BotReacting a d a -> BotReacting a d a

reader :: (BotActionState a d -> a) -> BotReacting a d a

data MessageReactionData

Payload in the reaction Monad when triggered by a message. Contains a field for the Message and a field for the Match from the Regex.

Both fields are accessible directly via the getMessage and getMatch functions or this data via getData.

Constructors

MessageReactionData Message Match

Instances

HasMessageField MessageReactionData Message

Methods

messageField :: Lens' MessageReactionData Message

HasMatchField MessageReactionData Match

Methods

matchField :: Lens' MessageReactionData Match

class HasActions s a | s -> a where

Minimal complete definition

actions

Methods

actions :: Lens' s a