Safe Haskell	None
Language	Haskell2010

Network.ScrapeChanges.Domain

Synopsis

Documentation

type CronScheduleString = String Source #

String encoded in the standard cron format

type Url = String Source #

Url to scrape

type HttpBody = ByteString Source #

Body of the HTTP request

type Scraper = HttpBody -> Text Source #

Function extracting Text of HttpBody

type Text = Text Source #

Codomain of Scraper

data MailAddr Source #

Mail address for provided MailConfig

Constructors

MailAddr
Fields _mailAddrName :: Maybe Text Optional name for the given `_mailAddr` _mailAddr :: String Mail address

Instances

Eq MailAddr Source #
Methods (==) :: MailAddr -> MailAddr -> Bool # (/=) :: MailAddr -> MailAddr -> Bool #
Show MailAddr Source #
Methods showsPrec :: Int -> MailAddr -> ShowS # show :: MailAddr -> String # showList :: [MailAddr] -> ShowS #
Generic MailAddr Source #
Associated Types type Rep MailAddr :: * -> * # Methods from :: MailAddr -> Rep MailAddr x # to :: Rep MailAddr x -> MailAddr #
Hashable MailAddr Source #
Methods hashWithSalt :: Int -> MailAddr -> Int # hash :: MailAddr -> Int #
type Rep MailAddr Source #
type Rep MailAddr = D1 (MetaData "MailAddr" "Network.ScrapeChanges.Domain" "scrape-changes-0.1.0.5-GwZntidl1MYCt8WtjBWLoI" False) (C1 (MetaCons "MailAddr" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_mailAddrName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mailAddr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

mailAddrName :: Lens' MailAddr (Maybe Text) Source #

mailAddr :: Lens' MailAddr String Source #

data Mail Source #

Constructors

Mail
Fields _mailFrom :: MailAddr _mailTo :: NonEmpty MailAddr _mailSubject :: Text _mailBody :: Text

Instances

Eq Mail Source #
Methods (==) :: Mail -> Mail -> Bool # (/=) :: Mail -> Mail -> Bool #
Show Mail Source #
Methods showsPrec :: Int -> Mail -> ShowS # show :: Mail -> String # showList :: [Mail] -> ShowS #
Generic Mail Source #
Associated Types type Rep Mail :: * -> * # Methods from :: Mail -> Rep Mail x # to :: Rep Mail x -> Mail #
Hashable Mail Source #
Methods hashWithSalt :: Int -> Mail -> Int # hash :: Mail -> Int #
type Rep Mail Source #
type Rep Mail = D1 (MetaData "Mail" "Network.ScrapeChanges.Domain" "scrape-changes-0.1.0.5-GwZntidl1MYCt8WtjBWLoI" False) (C1 (MetaCons "Mail" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_mailFrom") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MailAddr)) (S1 (MetaSel (Just Symbol "_mailTo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NonEmpty MailAddr)))) ((:*:) (S1 (MetaSel (Just Symbol "_mailSubject") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_mailBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

mailTo :: Lens' Mail (NonEmpty MailAddr) Source #

mailSubject :: Lens' Mail Text Source #

mailFrom :: Lens' Mail MailAddr Source #

mailBody :: Lens' Mail Text Source #

data CallbackConfig Source #

Constructors

MailConfig Mail	Send a mail when there's changed data at your scrape target. This needs sendmail to be configured correctly on the host your program runs.
OtherConfig (Text -> IO ())	Just execute the provided function when there's changed data at your scrape target.

Instances

Eq CallbackConfig Source #
Methods (==) :: CallbackConfig -> CallbackConfig -> Bool # (/=) :: CallbackConfig -> CallbackConfig -> Bool #

_OtherConfig :: Prism' CallbackConfig (Text -> IO ()) Source #

_MailConfig :: Prism' CallbackConfig Mail Source #

data ScrapeConfig Source #

Constructors

ScrapeConfig
Fields _scrapeInfoUrl :: String The url to be called using GET _scrapeInfoCallbackConfig :: CallbackConfig The callback config to be executed when something in `_scrapeInfoUrl` has changed

Instances

Eq ScrapeConfig Source #
Methods (==) :: ScrapeConfig -> ScrapeConfig -> Bool # (/=) :: ScrapeConfig -> ScrapeConfig -> Bool #
Hashable ScrapeConfig Source #
Methods hashWithSalt :: Int -> ScrapeConfig -> Int # hash :: ScrapeConfig -> Int #

scrapeInfoUrl :: Lens' ScrapeConfig String Source #

scrapeInfoCallbackConfig :: Lens' ScrapeConfig CallbackConfig Source #

data ScrapeResult Source #

Constructors

CallbackCalled	Signals that the last execution of the provided `ScrapeConfig` led to execution of `CallbackConfig`
CallbackNotCalled	Signals that the last execution of the provided `ScrapeConfig` didn't lead to execution of `CallbackConfig`

Instances

Show ScrapeResult Source #
Methods showsPrec :: Int -> ScrapeResult -> ShowS # show :: ScrapeResult -> String # showList :: [ScrapeResult] -> ShowS #

data ScrapeSchedule Source #

Constructors

ScrapeSchedule
Fields _scrapeScheduleCron :: CronScheduleString _scrapeScheduleConfig :: ScrapeConfig _scrapeScheduleScraper :: Scraper

scrapeScheduleScraper :: Lens' ScrapeSchedule Scraper Source #

scrapeScheduleCron :: Lens' ScrapeSchedule CronScheduleString Source #

scrapeScheduleConfig :: Lens' ScrapeSchedule ScrapeConfig Source #

data ValidationError Source #

Constructors

UrlNotAbsolute
UrlProtocolInvalid
MailConfigInvalidMailFromAddr String
MailConfigInvalidMailToAddr String
CronScheduleInvalid String

Instances

Eq ValidationError Source #
Methods (==) :: ValidationError -> ValidationError -> Bool # (/=) :: ValidationError -> ValidationError -> Bool #
Show ValidationError Source #
Methods showsPrec :: Int -> ValidationError -> ShowS # show :: ValidationError -> String # showList :: [ValidationError] -> ShowS #

type ScrapeValidation t = AccValidation [ValidationError] t Source #