Imm.Boot

Getting started

Dynamic reconfiguration

This program is dynamically configured using the dyre library.

You may want to check out this documentation to know how to get started.

Your personal configuration is located at $XDG_CONFIG_HOME/imm/imm.hs.

ReaderT pattern

The behavior of this program can be customized through the ReaderT pattern.

Documentation

imm :: ModulesM IO -> IO ()

Main function, meant to be used in your personal configuration file.

Here is an example:

import           Imm.Boot
import           Imm.Database.JsonFile
import           Imm.Feed
import           Imm.Hooks.SendMail
import           Imm.HTTP.Conduit
import           Imm.Logger.Simple
import           Imm.XML.Simple

main :: IO ()
main = do
  logger   <- defaultLogger
  manager  <- defaultManager
  database <- defaultDatabase

  imm $ mkModulesM manager database logger sendmail defaultXmlParser

sendmail :: SendMailSettings
sendmail = SendMailSettings smtpServer formatMail

formatMail :: FormatMail
formatMail = FormatMail
  (\a b -> (defaultFormatFrom a b) { addressEmail = "user@host" } )
  defaultFormatSubject
  defaultFormatBody
  (\_ _ -> [Address Nothing "user@host"])

smtpServer :: Feed -> FeedElement -> SMTPServer
smtpServer _ _ = SMTPServer
  (Just $ Authentication PLAIN "user" "password")
  (StartTls "smtp.host" defaultSettingsSMTPSTARTTLS)

data Modules httpClient databaseClient logger hooks xmlParser

Modules are independent features of the program which behavior can be controlled by the user.

Constructors

Modules

Fields

• _httpClient :: httpClient

  HTTP client interpreter (cf Imm.HTTP)

• _databaseClient :: databaseClient

  Database interpreter (cf Imm.Database)

• _logger :: logger

  Logging interpreter (cf Imm.Logger)

• _hooks :: hooks

  Hooks interpreter (cf Imm.Hooks)

• _xmlParser :: xmlParser

  XML parsing interpreter (cf Imm.XML)

Instances

(MonadThrow m, MonadDatabase FeedTable (ReaderT * b m)) => MonadDatabase FeedTable (ReaderT * (Modules a b c d e) m)

Methods

_describeDatabase :: FeedTable -> ReaderT * (Modules a b c d e) m (Doc a)

_fetchList :: FeedTable -> [Key FeedTable] -> ReaderT * (Modules a b c d e) m (Map (Key FeedTable) (Entry FeedTable))

_fetchAll :: FeedTable -> ReaderT * (Modules a b c d e) m (Map (Key FeedTable) (Entry FeedTable))

_update :: FeedTable -> Key FeedTable -> (Entry FeedTable -> Entry FeedTable) -> ReaderT * (Modules a b c d e) m ()

_insertList :: FeedTable -> [(Key FeedTable, Entry FeedTable)] -> ReaderT * (Modules a b c d e) m ()

_deleteList :: FeedTable -> [Key FeedTable] -> ReaderT * (Modules a b c d e) m ()

_purge :: FeedTable -> ReaderT * (Modules a b c d e) m ()

_commit :: FeedTable -> ReaderT * (Modules a b c d e) m ()

(MonadIO m, MonadLog (ReaderT * c m)) => MonadLog (ReaderT * (Modules a b c d e) m)

Methods

log :: LogLevel -> Doc AnsiStyle -> ReaderT * (Modules a b c d e) m ()

getLogLevel :: ReaderT * (Modules a b c d e) m LogLevel

setLogLevel :: LogLevel -> ReaderT * (Modules a b c d e) m ()

setColorizeLogs :: Bool -> ReaderT * (Modules a b c d e) m ()

flushLogs :: ReaderT * (Modules a b c d e) m ()

(MonadThrow m, MonadHttpClient (ReaderT * a m)) => MonadHttpClient (ReaderT * (Modules a b c d e) m)

Methods

httpGet :: URI -> ReaderT * (Modules a b c d e) m LByteString

(Monad m, MonadImm (ReaderT * d m)) => MonadImm (ReaderT * (Modules a b c d e) m)

Methods

processNewElement :: Feed -> FeedElement -> ReaderT * (Modules a b c d e) m ()

(MonadThrow m, MonadXmlParser (ReaderT * e m)) => MonadXmlParser (ReaderT * (Modules a b c d e) m)

Methods

parseXml :: URI -> LByteString -> ReaderT * (Modules a b c d e) m Feed

data ModulesM m

Type-erased version of Modules, using existential quantification.

mkModulesM :: (MonadXmlParser (ReaderT e m), MonadImm (ReaderT d m), MonadLog (ReaderT c m), MonadDatabase FeedTable (ReaderT b m), MonadHttpClient (ReaderT a m)) => a -> b -> c -> d -> e -> ModulesM m

Constructor for ModulesM.