Safe Haskell	None
Language	Haskell2010

FunBot.ExtEvents

Synopsis

Documentation

data Repository Source #

A version control repository.

Constructors

Repository

Fields

repoName :: Text
The repository's name. For example, funbot-ext-events.
repoSpace :: Text
The repository's namespace, i.e. username or team name under which the repository is being managed. For example, fr33domlover.
repoHost :: Text
Network location where the repository is hosted. For now this should in most cases be the website URL's host part, but could be something else if/when we have distributed repository sharing. For example, notabug.org.

Instances

Show Repository Source #
Methods showsPrec :: Int -> Repository -> ShowS # show :: Repository -> String # showList :: [Repository] -> ShowS #
ToJSON Repository Source #
Methods toJSON :: Repository -> Value # toEncoding :: Repository -> Encoding # toJSONList :: [Repository] -> Value # toEncodingList :: [Repository] -> Encoding #
FromJSON Repository Source #
Methods parseJSON :: Value -> Parser Repository # parseJSONList :: Value -> Parser [Repository] #

data ProjectObject a Source #

An object that is part of a project, such as a merge request or an issue or a series of commits being pushed.

Constructors

ProjectObject
Fields poRepo :: Repository The project repository. poObj :: a The object itself.

Instances

Show a => Show (ProjectObject a) Source #
Methods showsPrec :: Int -> ProjectObject a -> ShowS # show :: ProjectObject a -> String # showList :: [ProjectObject a] -> ShowS #
ToJSON a => ToJSON (ProjectObject a) Source #
Methods toJSON :: ProjectObject a -> Value # toEncoding :: ProjectObject a -> Encoding # toJSONList :: [ProjectObject a] -> Value # toEncodingList :: [ProjectObject a] -> Encoding #
FromJSON a => FromJSON (ProjectObject a) Source #
Methods parseJSON :: Value -> Parser (ProjectObject a) # parseJSONList :: Value -> Parser [ProjectObject a] #

data Commit Source #

A version control system commit, i.e. a set of changes with a description.

Constructors

Commit

Fields

commitAuthor :: Text
The author name. For example, John Doe.
commitTitle :: Text
The commit title. For example, Support encrypted messages.
commitUrl :: Text
A web view URL at which the commit details can be displayed.
commitAdded :: [Text]
A list of files (relative to the repository top level) added to the repository in this commit. For example, src/FunBot/ExtEvents.hs.
commitModified :: [Text]
A list of files modified in the repository in this commit.
commitRemoved :: [Text]
A list of files removed from the repository in this commit.

Instances

Show Commit Source #
Methods showsPrec :: Int -> Commit -> ShowS # show :: Commit -> String # showList :: [Commit] -> ShowS #
ToJSON Commit Source #
Methods toJSON :: Commit -> Value # toEncoding :: Commit -> Encoding # toJSONList :: [Commit] -> Value # toEncodingList :: [Commit] -> Encoding #
FromJSON Commit Source #
Methods parseJSON :: Value -> Parser Commit # parseJSONList :: Value -> Parser [Commit] #

data Push Source #

A version control push operation, i.e. one or more commits being added to a specific branch or a repsitory. Note that tags can be pushed too, but for that see the Tag type.

Constructors

Push
Fields pushBranch :: Text pushCommits :: [Commit]

Instances

Show Push Source #
Methods showsPrec :: Int -> Push -> ShowS # show :: Push -> String # showList :: [Push] -> ShowS #
ToJSON Push Source #
Methods toJSON :: Push -> Value # toEncoding :: Push -> Encoding # toJSONList :: [Push] -> Value # toEncodingList :: [Push] -> Encoding #
FromJSON Push Source #
Methods parseJSON :: Value -> Parser Push # parseJSONList :: Value -> Parser [Push] #

data Tag Source #

A version control tag. Allows a specific state of the repository to be referred by name.

Constructors

Tag
Fields tagAuthor :: Text Tag author name, for example `John Doe`. tagRef :: Text Tag label, for example `0.3.4.1` (referring to a release version).

Instances

Show Tag Source #
Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
ToJSON Tag Source #
Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
FromJSON Tag Source #
Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #

data Issue Source #

A bug, request or other work item attached to a project.

Constructors

Issue
Fields issueAuthor :: Text Issue author name. For example, `John Doe`. issueId :: Int The issue's unique identifier. issueTitle :: Text Issue title text. issueUrl :: Text A web view URL at which the issue's details can be viewed and perhaps modified. issueAction :: Text An action being applied to the issue, which is causing the event to be sent to the FunBot instance.

Instances

Show Issue Source #
Methods showsPrec :: Int -> Issue -> ShowS # show :: Issue -> String # showList :: [Issue] -> ShowS #
ToJSON Issue Source #
Methods toJSON :: Issue -> Value # toEncoding :: Issue -> Encoding # toJSONList :: [Issue] -> Value # toEncodingList :: [Issue] -> Encoding #
FromJSON Issue Source #
Methods parseJSON :: Value -> Parser Issue # parseJSONList :: Value -> Parser [Issue] #

data Note Source #

A comment made on some project object.

Constructors

Note

Fields

noteAuthor :: Text
Note author name, e.g. John Doe.
noteContent :: Text
Note content for the bot to display. Since notes can be long, this should be only the portion for the bot to display. The bot should examine this field and shorten long notes, but you shouldn't rely on it and provide the right short part here.
noteTarget :: Text
The project object being commented on, e.g. issue #419.
noteUrl :: Text
A web view URL at which the note can be viewed.

Instances

Show Note Source #
Methods showsPrec :: Int -> Note -> ShowS # show :: Note -> String # showList :: [Note] -> ShowS #
ToJSON Note Source #
Methods toJSON :: Note -> Value # toEncoding :: Note -> Encoding # toJSONList :: [Note] -> Value # toEncodingList :: [Note] -> Encoding #
FromJSON Note Source #
Methods parseJSON :: Value -> Parser Note # parseJSONList :: Value -> Parser [Note] #

data MergeRequest Source #

A request from a user to merge their code changes into the project.

Constructors

MergeRequest
Fields mrAuthor :: Text Merge request author name, e.g. `John Doe`. mrId :: Int Merge request unique identifier. mrTitle :: Text Merge request title. mrUrl :: Text A web view URL at which the merge request can be viewed and perhaps edited. mrAction :: Text An action being applied to the merge request, which is causing the event to be sent to the FunBot instance.

Instances

Show MergeRequest Source #
Methods showsPrec :: Int -> MergeRequest -> ShowS # show :: MergeRequest -> String # showList :: [MergeRequest] -> ShowS #
ToJSON MergeRequest Source #
Methods toJSON :: MergeRequest -> Value # toEncoding :: MergeRequest -> Encoding # toJSONList :: [MergeRequest] -> Value # toEncodingList :: [MergeRequest] -> Encoding #
FromJSON MergeRequest Source #
Methods parseJSON :: Value -> Parser MergeRequest # parseJSONList :: Value -> Parser [MergeRequest] #

data NewsItem Source #

A news feed item.

Constructors

NewsItem
Fields itemFeedLabel :: Text Short label identifying the new feed to which the item belongs. itemFeedTitle :: Maybe Text The name of the feed to which the item belongs. itemTitle :: Text Item title. itemAuthor :: Maybe Text Item author name. itemUrl :: Maybe Text URL at which the item's content can be viewed.

Instances

Show NewsItem Source #
Methods showsPrec :: Int -> NewsItem -> ShowS # show :: NewsItem -> String # showList :: [NewsItem] -> ShowS #
ToJSON NewsItem Source #
Methods toJSON :: NewsItem -> Value # toEncoding :: NewsItem -> Encoding # toJSONList :: [NewsItem] -> Value # toEncodingList :: [NewsItem] -> Encoding #
FromJSON NewsItem Source #
Methods parseJSON :: Value -> Parser NewsItem # parseJSONList :: Value -> Parser [NewsItem] #

data Paste Source #

A piece of text uploaded to a website for quick sharing.

Constructors

Paste
Fields pasteAuthor :: Text Paste author name or IRC nickname. pasteVerb :: Text Verb indicating the action done with the paste. pasteTitle :: Text Paste title. pasteUrl :: Text URL at which the paste content can be viewed. pasteChannel :: Text An IRC channel into which to announce the paste.

Instances

Show Paste Source #
Methods showsPrec :: Int -> Paste -> ShowS # show :: Paste -> String # showList :: [Paste] -> ShowS #
ToJSON Paste Source #
Methods toJSON :: Paste -> Value # toEncoding :: Paste -> Encoding # toJSONList :: [Paste] -> Value # toEncodingList :: [Paste] -> Encoding #
FromJSON Paste Source #
Methods parseJSON :: Value -> Parser Paste # parseJSONList :: Value -> Parser [Paste] #

data ExtEvent Source #

An event coming from one of the external event sources.

Constructors

GitPushEvent (ProjectObject Push)	Git commits pushed into a repo.
GitTagEvent (ProjectObject Tag)	A git tag pushed into a repo.
IssueEvent (ProjectObject Issue)	An issue related event.
MergeRequestEvent (ProjectObject MergeRequest)	A merge request related event.
NoteEvent (ProjectObject Note)	A comment made on an issue or MR or some other object.
NewsEvent NewsItem	New news item published.
PasteEvent Paste	Paste related event in a paste server.
WelcomeEvent Text Text	A new IRC user needs to be welcomed to a channel.

Instances

Show ExtEvent Source #
Methods showsPrec :: Int -> ExtEvent -> ShowS # show :: ExtEvent -> String # showList :: [ExtEvent] -> ShowS #
ToJSON ExtEvent Source #
Methods toJSON :: ExtEvent -> Value # toEncoding :: ExtEvent -> Encoding # toJSONList :: [ExtEvent] -> Value # toEncodingList :: [ExtEvent] -> Encoding #
FromJSON ExtEvent Source #
Methods parseJSON :: Value -> Parser ExtEvent # parseJSONList :: Value -> Parser [ExtEvent] #