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, Text) -> (GerritClient -> IO a) -> IO a
getClient :: Text -> Maybe (Text, Text) -> IO GerritClient
getVersion :: GerritClient -> IO GerritVersion
getChange :: Int -> GerritClient -> IO (Maybe GerritChange)
queryChanges :: Int -> [GerritQuery] -> Maybe Int -> GerritClient -> IO [GerritChange]
postReview :: GerritChange -> Text -> Text -> Int -> GerritClient -> IO ReviewResult
getAccountId :: Int -> NonEmpty GerritAccountQuery -> GerritClient -> IO [GerritAccountId]
getAccount :: Int -> NonEmpty GerritAccountQuery -> GerritClient -> IO [GerritAccount]
getProjects :: Int -> GerritProjectQuery -> Maybe Int -> GerritClient -> IO GerritProjectsMessage
newtype GerritVersion = GerritVersion Text
data GerritQuery
- = Status GerritChangeStatus
- | Owner Text
- | CommitMessage Text
- | Project Text
- | ChangeId Text
- | After UTCTime
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
- messages :: [GerritChangeMessage]
- owner :: GerritAuthor
- created :: GerritTime
- updated :: GerritTime
- submitted :: Maybe GerritTime
- submitter :: Maybe GerritAuthor
- insertions :: Int
- deletions :: Int
- more_changes :: Maybe Bool
}
data GerritChangeStatus
- = NEW
- | MERGED
- | ABANDONED
- | DRAFT
data ReviewResult = ReviewResult {
- rrLabels :: Maybe (Map Text Int)
- rrReady :: Maybe Int
}
data GerritAccount = GerritAccount {
- gerritAccountId :: Int
- gerritAccountName :: Text
- gerritAccountUsername :: Maybe Text
- gerritAccountEmail :: Maybe Text
- gerritAccountHasMore :: Maybe Bool
}
data GerritAccountQuery
- = CanSee Text
- | Email Text
- | Name Text
- | Username Text
- | IsActive
- | IsInactive
data GerritProjectQuery
- = Regexp Text
- | Prefix Text
changeUrl :: GerritClient -> GerritChange -> Text
serverUrl :: GerritClient -> Text

Client

data GerritClient Source #

The GerritClient record, use withClient to create

withClient Source #

Arguments

:: Text	The gerrit api url
-> Maybe (Text, Text)	Credentials (login, password) [Optional]
-> (GerritClient -> IO a)	The callback
-> IO a	withClient performs the IO

Create the GerritClient

getClient :: Text -> Maybe (Text, Text) -> IO GerritClient Source #

Need to be call through withOpenSSL

Api

getVersion :: GerritClient -> IO GerritVersion Source #

Get the server version

getChange :: Int -> GerritClient -> IO (Maybe GerritChange) Source #

Get a change by change Id

queryChanges Source #

Arguments

:: Int	Count of changes to get back
-> [GerritQuery]	The change query
-> Maybe Int	Whether or not to ask result from offset
-> GerritClient	The client
-> IO [GerritChange]

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

getAccountId :: Int -> NonEmpty GerritAccountQuery -> GerritClient -> IO [GerritAccountId] Source #

Get user account id

getAccount :: Int -> NonEmpty GerritAccountQuery -> GerritClient -> IO [GerritAccount] Source #

Get user account details

getProjects Source #

Arguments

:: Int	Count of projects to get back
-> GerritProjectQuery	The project query type
-> Maybe Int	Whether or not to ask result from offset
-> GerritClient	The client
-> IO GerritProjectsMessage

Get projects

Main data types

newtype GerritVersion Source #

Constructors

GerritVersion Text

Instances

Instances details

Show GerritVersion Source #
Instance details Defined in Gerrit.Data.Review Methods showsPrec :: Int -> GerritVersion -> ShowS # show :: GerritVersion -> String # showList :: [GerritVersion] -> ShowS #
Generic GerritVersion Source #
Instance details Defined in Gerrit.Data.Review 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.Review Methods parseJSON :: Value -> Parser GerritVersion # parseJSONList :: Value -> Parser [GerritVersion] #
type Rep GerritVersion Source #
Instance details Defined in Gerrit.Data.Review type Rep GerritVersion = D1 ('MetaData "GerritVersion" "Gerrit.Data.Review" "gerrit-0.1.1.0-7gtYDQhRUQ87FLhfKeQxDK" '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
After UTCTime

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
messages :: [GerritChangeMessage]
owner :: GerritAuthor
created :: GerritTime
updated :: GerritTime
submitted :: Maybe GerritTime
submitter :: Maybe GerritAuthor
insertions :: Int
deletions :: Int
more_changes :: Maybe Bool

Instances

Instances details

Show GerritChange Source #
Instance details Defined in Gerrit.Data.Change Methods showsPrec :: Int -> GerritChange -> ShowS # show :: GerritChange -> String # showList :: [GerritChange] -> ShowS #
Generic GerritChange Source #
Instance details Defined in Gerrit.Data.Change 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.Change Methods parseJSON :: Value -> Parser GerritChange # parseJSONList :: Value -> Parser [GerritChange] #
type Rep GerritChange Source #
Instance details Defined in Gerrit.Data.Change type Rep GerritChange = D1 ('MetaData "GerritChange" "Gerrit.Data.Change" "gerrit-0.1.1.0-7gtYDQhRUQ87FLhfKeQxDK" '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)) :: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [GerritChangeMessage])) :: (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GerritAuthor) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GerritTime) :: S1 ('MetaSel ('Just "updated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GerritTime)))) :: ((S1 ('MetaSel ('Just "submitted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe GerritTime)) :: S1 ('MetaSel ('Just "submitter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe GerritAuthor))) :: (S1 ('MetaSel ('Just "insertions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: (S1 ('MetaSel ('Just "deletions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "more_changes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))))

data GerritChangeStatus Source #

Constructors

NEW
MERGED
ABANDONED
DRAFT

Instances

Instances details

Eq GerritChangeStatus Source #
Instance details Defined in Gerrit.Data.Change Methods (==) :: GerritChangeStatus -> GerritChangeStatus -> Bool # (/=) :: GerritChangeStatus -> GerritChangeStatus -> Bool #
Show GerritChangeStatus Source #
Instance details Defined in Gerrit.Data.Change Methods showsPrec :: Int -> GerritChangeStatus -> ShowS # show :: GerritChangeStatus -> String # showList :: [GerritChangeStatus] -> ShowS #
Generic GerritChangeStatus Source #
Instance details Defined in Gerrit.Data.Change 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.Change Methods parseJSON :: Value -> Parser GerritChangeStatus # parseJSONList :: Value -> Parser [GerritChangeStatus] #
type Rep GerritChangeStatus Source #
Instance details Defined in Gerrit.Data.Change type Rep GerritChangeStatus = D1 ('MetaData "GerritChangeStatus" "Gerrit.Data.Change" "gerrit-0.1.1.0-7gtYDQhRUQ87FLhfKeQxDK" '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.Review Methods (==) :: ReviewResult -> ReviewResult -> Bool # (/=) :: ReviewResult -> ReviewResult -> Bool #
Ord ReviewResult Source #
Instance details Defined in Gerrit.Data.Review 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.Review Methods showsPrec :: Int -> ReviewResult -> ShowS # show :: ReviewResult -> String # showList :: [ReviewResult] -> ShowS #
Generic ReviewResult Source #
Instance details Defined in Gerrit.Data.Review 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.Review Methods toJSON :: ReviewResult -> Value # toEncoding :: ReviewResult -> Encoding # toJSONList :: [ReviewResult] -> Value # toEncodingList :: [ReviewResult] -> Encoding #
FromJSON ReviewResult Source #
Instance details Defined in Gerrit.Data.Review Methods parseJSON :: Value -> Parser ReviewResult # parseJSONList :: Value -> Parser [ReviewResult] #
type Rep ReviewResult Source #
Instance details Defined in Gerrit.Data.Review type Rep ReviewResult = D1 ('MetaData "ReviewResult" "Gerrit.Data.Review" "gerrit-0.1.1.0-7gtYDQhRUQ87FLhfKeQxDK" '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))))

data GerritAccount Source #

Constructors

GerritAccount
Fields gerritAccountId :: Int gerritAccountName :: Text gerritAccountUsername :: Maybe Text gerritAccountEmail :: Maybe Text gerritAccountHasMore :: Maybe Bool

Instances

Instances details

Eq GerritAccount Source #
Instance details Defined in Gerrit.Data.Account Methods (==) :: GerritAccount -> GerritAccount -> Bool # (/=) :: GerritAccount -> GerritAccount -> Bool #
Show GerritAccount Source #
Instance details Defined in Gerrit.Data.Account Methods showsPrec :: Int -> GerritAccount -> ShowS # show :: GerritAccount -> String # showList :: [GerritAccount] -> ShowS #
FromJSON GerritAccount Source #
Instance details Defined in Gerrit.Data.Account Methods parseJSON :: Value -> Parser GerritAccount # parseJSONList :: Value -> Parser [GerritAccount] #

data GerritAccountQuery Source #

Constructors

CanSee Text
Email Text
Name Text
Username Text
IsActive
IsInactive

data GerritProjectQuery Source #

Constructors

Regexp Text
Prefix Text

Convenient functions

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

Return the url of a GerritChange

serverUrl :: GerritClient -> Text Source #

Return the base url of the GerritClient