Safe Haskell | None |
---|---|
Language | Haskell2010 |
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
- getClientWithManager :: Manager -> Text -> Maybe (Text, Text) -> 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
- data GerritChange = GerritChange {
- id :: Text
- project :: Text
- branch :: Text
- hashtags :: [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
- topic :: Maybe Text
- insertions :: Int
- deletions :: Int
- more_changes :: Maybe Bool
- data GerritChangeStatus
- data ReviewResult = ReviewResult {}
- data GerritAccount = GerritAccount {}
- data GerritAccountQuery
- data GerritProjectQuery
- changeUrl :: GerritClient -> GerritChange -> Text
- serverUrl :: GerritClient -> Text
Client
data GerritClient Source #
The GerritClient record, use withClient
to create
:: 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
getClientWithManager :: Manager -> Text -> Maybe (Text, Text) -> GerritClient Source #
Creates a GerritClient with a provided http manager.
Api
getVersion :: GerritClient -> IO GerritVersion Source #
Get the server version
getChange :: Int -> GerritClient -> IO (Maybe GerritChange) Source #
Get a change by change Id
:: 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
:: 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
:: 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 #
Instances
Show GerritVersion Source # | |
Defined in Gerrit.Data.Review showsPrec :: Int -> GerritVersion -> ShowS # show :: GerritVersion -> String # showList :: [GerritVersion] -> ShowS # | |
Generic GerritVersion Source # | |
Defined in Gerrit.Data.Review type Rep GerritVersion :: Type -> Type # from :: GerritVersion -> Rep GerritVersion x # to :: Rep GerritVersion x -> GerritVersion # | |
FromJSON GerritVersion Source # | |
Defined in Gerrit.Data.Review parseJSON :: Value -> Parser GerritVersion # parseJSONList :: Value -> Parser [GerritVersion] # | |
type Rep GerritVersion Source # | |
Defined in Gerrit.Data.Review type Rep GerritVersion = D1 ('MetaData "GerritVersion" "Gerrit.Data.Review" "gerrit-0.1.5.1-9RJDILYktGdBZMpBZlk3y5" 'True) (C1 ('MetaCons "GerritVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
data GerritQuery Source #
Instances
Eq GerritQuery Source # | |
Defined in Gerrit.Data.Change (==) :: GerritQuery -> GerritQuery -> Bool # (/=) :: GerritQuery -> GerritQuery -> Bool # | |
Show GerritQuery Source # | |
Defined in Gerrit.Data.Change showsPrec :: Int -> GerritQuery -> ShowS # show :: GerritQuery -> String # showList :: [GerritQuery] -> ShowS # |
data GerritChange Source #
GerritChange | |
|
Instances
data GerritChangeStatus Source #
Instances
data ReviewResult Source #
Instances
data GerritAccount Source #
Instances
Eq GerritAccount Source # | |
Defined in Gerrit.Data.Account (==) :: GerritAccount -> GerritAccount -> Bool # (/=) :: GerritAccount -> GerritAccount -> Bool # | |
Show GerritAccount Source # | |
Defined in Gerrit.Data.Account showsPrec :: Int -> GerritAccount -> ShowS # show :: GerritAccount -> String # showList :: [GerritAccount] -> ShowS # | |
FromJSON GerritAccount Source # | |
Defined in Gerrit.Data.Account parseJSON :: Value -> Parser GerritAccount # parseJSONList :: Value -> Parser [GerritAccount] # |
data GerritAccountQuery Source #
Instances
Eq GerritAccountQuery Source # | |
Defined in Gerrit.Data.Account (==) :: GerritAccountQuery -> GerritAccountQuery -> Bool # (/=) :: GerritAccountQuery -> GerritAccountQuery -> Bool # | |
Show GerritAccountQuery Source # | |
Defined in Gerrit.Data.Account showsPrec :: Int -> GerritAccountQuery -> ShowS # show :: GerritAccountQuery -> String # showList :: [GerritAccountQuery] -> ShowS # |
data GerritProjectQuery Source #
Instances
Eq GerritProjectQuery Source # | |
Defined in Gerrit.Data.Project (==) :: GerritProjectQuery -> GerritProjectQuery -> Bool # (/=) :: GerritProjectQuery -> GerritProjectQuery -> Bool # | |
Show GerritProjectQuery Source # | |
Defined in Gerrit.Data.Project showsPrec :: Int -> GerritProjectQuery -> ShowS # show :: GerritProjectQuery -> String # showList :: [GerritProjectQuery] -> ShowS # |
Convenient functions
changeUrl :: GerritClient -> GerritChange -> Text Source #
Return the url of a GerritChange
serverUrl :: GerritClient -> Text Source #
Return the base url of the GerritClient