Safe Haskell	None
Language	Haskell2010

Gerrit

Contents

Client
Api
Main data types
Convenient functions

Description

This module contains the gerrit client library

Synopsis

data GerritClient
withClient :: Text -> Maybe Text -> (GerritClient -> IO ()) -> IO ()
getVersion :: GerritClient -> IO GerritVersion
queryChanges :: [GerritQuery] -> GerritClient -> IO [GerritChange]
postReview :: GerritChange -> Text -> Text -> Int -> GerritClient -> IO ReviewResult
newtype GerritVersion = GerritVersion Text
data GerritQuery
- = Status GerritChangeStatus
- | Owner Text
- | CommitMessage Text
- | Project Text
- | ChangeId Text
data GerritChange = GerritChange {
- id :: Text
- project :: Text
- branch :: Text
- subject :: Text
- status :: GerritChangeStatus
- mergeable :: Maybe Bool
- revisions :: Map Text (Maybe GerritRevision)
- current_revision :: Maybe Text
- number :: Int
- labels :: Map Text GerritDetailedLabel
}
data GerritChangeStatus
- = NEW
- | MERGED
- | ABANDONED
- | DRAFT
data ReviewResult = ReviewResult {
- rrLabels :: Maybe (Map Text Int)
- rrReady :: Maybe Int
}
changeUrl :: GerritClient -> GerritChange -> Text
hasLabel :: Text -> Int -> GerritChange -> Bool

Client

data GerritClient Source #

The GerritClient record, use withClient to create

withClient Source #

Arguments

:: Text	The gerrit api url
-> Maybe Text	A username (password is read from GERRIT_PASSWORD environment)
-> (GerritClient -> IO ())	The callback
-> IO ()	withClient performs the IO

Create the GerritClient

Api

getVersion :: GerritClient -> IO GerritVersion Source #

Get the server version

queryChanges :: [GerritQuery] -> GerritClient -> IO [GerritChange] Source #

Search for changes

postReview Source #

Arguments

:: GerritChange	The change to review
-> Text	A message
-> Text	A label
-> Int	A vote
-> GerritClient	The client
-> IO ReviewResult	Returns the ReviewResult

Post a review

Main data types

newtype GerritVersion Source #

Constructors

GerritVersion Text

Instances

Instances details

Show GerritVersion Source #
Instance details Defined in Gerrit.Data Methods showsPrec :: Int -> GerritVersion -> ShowS # show :: GerritVersion -> String # showList :: [GerritVersion] -> ShowS #
Generic GerritVersion Source #
Instance details Defined in Gerrit.Data Associated Types type Rep GerritVersion :: Type -> Type # Methods from :: GerritVersion -> Rep GerritVersion x # to :: Rep GerritVersion x -> GerritVersion #
FromJSON GerritVersion Source #
Instance details Defined in Gerrit.Data Methods parseJSON :: Value -> Parser GerritVersion # parseJSONList :: Value -> Parser [GerritVersion] #
type Rep GerritVersion Source #
Instance details Defined in Gerrit.Data type Rep GerritVersion = D1 ('MetaData "GerritVersion" "Gerrit.Data" "gerrit-0.0.0.0-HeaHw1VGRFr3asNCEgawPp" 'True) (C1 ('MetaCons "GerritVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data GerritQuery Source #

Constructors

Status GerritChangeStatus
Owner Text
CommitMessage Text
Project Text
ChangeId Text

data GerritChange Source #

Constructors

GerritChange
Fields id :: Text project :: Text branch :: Text subject :: Text status :: GerritChangeStatus mergeable :: Maybe Bool revisions :: Map Text (Maybe GerritRevision) current_revision :: Maybe Text number :: Int labels :: Map Text GerritDetailedLabel

Instances

Instances details

Show GerritChange Source #
Instance details Defined in Gerrit.Data Methods showsPrec :: Int -> GerritChange -> ShowS # show :: GerritChange -> String # showList :: [GerritChange] -> ShowS #
Generic GerritChange Source #
Instance details Defined in Gerrit.Data Associated Types type Rep GerritChange :: Type -> Type # Methods from :: GerritChange -> Rep GerritChange x # to :: Rep GerritChange x -> GerritChange #
FromJSON GerritChange Source #
Instance details Defined in Gerrit.Data Methods parseJSON :: Value -> Parser GerritChange # parseJSONList :: Value -> Parser [GerritChange] #
type Rep GerritChange Source #
Instance details Defined in Gerrit.Data type Rep GerritChange = D1 ('MetaData "GerritChange" "Gerrit.Data" "gerrit-0.0.0.0-HeaHw1VGRFr3asNCEgawPp" 'False) (C1 ('MetaCons "GerritChange" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "branch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GerritChangeStatus)))) :: ((S1 ('MetaSel ('Just "mergeable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "revisions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text (Maybe GerritRevision)))) :: (S1 ('MetaSel ('Just "current_revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "number") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text GerritDetailedLabel)))))))

data GerritChangeStatus Source #

Constructors

NEW
MERGED
ABANDONED
DRAFT

Instances

Instances details

Eq GerritChangeStatus Source #
Instance details Defined in Gerrit.Data Methods (==) :: GerritChangeStatus -> GerritChangeStatus -> Bool # (/=) :: GerritChangeStatus -> GerritChangeStatus -> Bool #
Show GerritChangeStatus Source #
Instance details Defined in Gerrit.Data Methods showsPrec :: Int -> GerritChangeStatus -> ShowS # show :: GerritChangeStatus -> String # showList :: [GerritChangeStatus] -> ShowS #
Generic GerritChangeStatus Source #
Instance details Defined in Gerrit.Data Associated Types type Rep GerritChangeStatus :: Type -> Type # Methods from :: GerritChangeStatus -> Rep GerritChangeStatus x # to :: Rep GerritChangeStatus x -> GerritChangeStatus #
FromJSON GerritChangeStatus Source #
Instance details Defined in Gerrit.Data Methods parseJSON :: Value -> Parser GerritChangeStatus # parseJSONList :: Value -> Parser [GerritChangeStatus] #
type Rep GerritChangeStatus Source #
Instance details Defined in Gerrit.Data type Rep GerritChangeStatus = D1 ('MetaData "GerritChangeStatus" "Gerrit.Data" "gerrit-0.0.0.0-HeaHw1VGRFr3asNCEgawPp" 'False) ((C1 ('MetaCons "NEW" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MERGED" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ABANDONED" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DRAFT" 'PrefixI 'False) (U1 :: Type -> Type)))

data ReviewResult Source #

Constructors

ReviewResult
Fields rrLabels :: Maybe (Map Text Int) rrReady :: Maybe Int

Instances

Instances details

Eq ReviewResult Source #
Instance details Defined in Gerrit.Data Methods (==) :: ReviewResult -> ReviewResult -> Bool # (/=) :: ReviewResult -> ReviewResult -> Bool #
Ord ReviewResult Source #
Instance details Defined in Gerrit.Data Methods compare :: ReviewResult -> ReviewResult -> Ordering # (<) :: ReviewResult -> ReviewResult -> Bool # (<=) :: ReviewResult -> ReviewResult -> Bool # (>) :: ReviewResult -> ReviewResult -> Bool # (>=) :: ReviewResult -> ReviewResult -> Bool # max :: ReviewResult -> ReviewResult -> ReviewResult # min :: ReviewResult -> ReviewResult -> ReviewResult #
Show ReviewResult Source #
Instance details Defined in Gerrit.Data Methods showsPrec :: Int -> ReviewResult -> ShowS # show :: ReviewResult -> String # showList :: [ReviewResult] -> ShowS #
Generic ReviewResult Source #
Instance details Defined in Gerrit.Data Associated Types type Rep ReviewResult :: Type -> Type # Methods from :: ReviewResult -> Rep ReviewResult x # to :: Rep ReviewResult x -> ReviewResult #
ToJSON ReviewResult Source #
Instance details Defined in Gerrit.Data Methods toJSON :: ReviewResult -> Value # toEncoding :: ReviewResult -> Encoding # toJSONList :: [ReviewResult] -> Value # toEncodingList :: [ReviewResult] -> Encoding #
FromJSON ReviewResult Source #
Instance details Defined in Gerrit.Data Methods parseJSON :: Value -> Parser ReviewResult # parseJSONList :: Value -> Parser [ReviewResult] #
type Rep ReviewResult Source #
Instance details Defined in Gerrit.Data type Rep ReviewResult = D1 ('MetaData "ReviewResult" "Gerrit.Data" "gerrit-0.0.0.0-HeaHw1VGRFr3asNCEgawPp" 'False) (C1 ('MetaCons "ReviewResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "rrLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Int))) :*: S1 ('MetaSel ('Just "rrReady") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))

Convenient functions

changeUrl :: GerritClient -> GerritChange -> Text Source #

Return the url of a GerritChange

hasLabel :: Text -> Int -> GerritChange -> Bool Source #

Check if a gerrit change as a label