Network.GitHub

The GitHub monad provides support for:

• Managing the authentication token. It can be Nothing, in which case no Authentication header is sent to the API,
• Setting the User-agent header string. This defaults to "servant-github", but can be set inside the GitHub monad using the setUserAgent, and
• Keeping track of the pagination in the case of calls that return lists of objects.

GitHub API calls

Functions that directly access the GitHub API. These functions all run in the GitHub monad.

userOrganisations :: GitHub [Organisation]

Get list of Organisation records for authorised user

userOrganisationMemberships :: GitHub [OrganisationMember]

Get list of OrganisationMember records for authorised user

organisationTeams :: OrgLogin -> GitHub [Team]

Get list of Team records, given the organisation login

getTeam :: TeamId -> GitHub Team

Get the Team record associated to a TeamId

teamMembers :: TeamId -> GitHub [Member]

Get list of Member records assoctiated to Team given by Team Id

teamRepositories :: TeamId -> GitHub [Repository]

Get list of Repository records assoctiated to Team given by Team Id

user :: GitHub User

Get the current user for the authorised user

userByLogin :: Maybe String -> GitHub User

Lookup user by login

userRepositories :: Maybe String -> GitHub [Repository]

Get repositories for the authorised user

userInstallationRepositories :: Int -> GitHub Repositories

List repositories that are accessible to the authenticated user for an installation.

organisationRepositories :: OrgLogin -> GitHub [Repository]

Get repositories for an organisation login

installationRepositories :: GitHub Repositories

Get repositories for the installation (current token should be an installation token)

appInstallations :: GitHub [Installation]

Get installations for the appliction

userInstallations :: Maybe String -> GitHub Installations

List installations that are accessible to the authenticated user.

repositoryCollaborators :: OrgLogin -> RepoName -> GitHub [Member]

Get repositories for the installation (current token should be an installation token)

getCommit :: OrgLogin -> RepoName -> Sha -> GitHub Commit

Get commit for repo and reference

getContent :: OrgLogin -> RepoName -> String -> Maybe String -> Maybe String -> GitHub Content

Get content for repo and reference and path

getIssues :: GHOptions -> Owner -> RepoName -> GitHub [Issue]

integrationJWT :: (MonadRandom m, MonadError e m, AsError e) => JWK -> Int -> UTCTime -> m Text

reqInstallationAccessToken :: JWK -> Int -> Int -> Maybe InstallationUser -> ClientM InstallationAccessToken

GitHub monad

Use the runGitHub function to execute the GitHub client function.

type GitHub = ReaderT (Maybe AuthToken) (StateT GitHubState ClientM)

The GitHub monad provides execution context

runGitHubClientM :: ClientM a -> IO (Either ServantError a)

runGitHubNotApiClientM :: ClientM a -> IO (Either ServantError a)

Most of the time we must use api.github.com, but calling loginoauthaccess_token only works if sent to github.com.

runGitHub' :: GitHub a -> Maybe AuthToken -> ClientM a

runGitHub :: GitHub a -> Maybe AuthToken -> IO (Either ServantError a)

You need to provide a 'Maybe AuthToken' to lift a GitHub computation into the IO monad.

data AuthToken

Token used to authorize access to the GitHub API. see https://developer.github.com/v3/oauth/

Instances

Eq AuthToken

Methods

(==) :: AuthToken -> AuthToken -> Bool

(/=) :: AuthToken -> AuthToken -> Bool

IsString AuthToken

Methods

fromString :: String -> AuthToken

ToHttpApiData AuthToken

Methods

toUrlPiece :: AuthToken -> Text

toEncodedUrlPiece :: AuthToken -> Builder

toHeader :: AuthToken -> ByteString

toQueryParam :: AuthToken -> Text

HasGitHub (Paginated a)

Instance for the case where we have paginated results

Methods

embedGitHub :: Paginated a -> EmbedGitHub (Paginated a)

HasGitHub (Single a)

Instance for the case where we have single result

Methods

embedGitHub :: Single a -> EmbedGitHub (Single a)

HasGitHub (a -> b -> c -> d -> e -> g -> h -> i -> k -> l -> m -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> g -> h -> i -> k -> l -> m -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> g -> h -> i -> k -> l -> m -> Paginated f)

HasGitHub (a -> b -> c -> d -> e -> g -> h -> i -> k -> l -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> g -> h -> i -> k -> l -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> g -> h -> i -> k -> l -> Paginated f)

HasGitHub (a -> b -> c -> d -> e -> g -> h -> i -> k -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> g -> h -> i -> k -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> g -> h -> i -> k -> Paginated f)

HasGitHub (a -> b -> c -> d -> e -> g -> h -> i -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> g -> h -> i -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> g -> h -> i -> Paginated f)

HasGitHub (a -> b -> c -> d -> e -> g -> h -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> g -> h -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> g -> h -> Paginated f)

HasGitHub (a -> b -> c -> d -> e -> g -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> g -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> g -> Paginated f)

HasGitHub (a -> b -> c -> d -> e -> Paginated f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> Paginated f) -> EmbedGitHub (a -> b -> c -> d -> e -> Paginated f)

HasGitHub (a -> b -> c -> d -> Paginated e)

Methods

embedGitHub :: (a -> b -> c -> d -> Paginated e) -> EmbedGitHub (a -> b -> c -> d -> Paginated e)

HasGitHub (a -> b -> c -> Paginated d)

Methods

embedGitHub :: (a -> b -> c -> Paginated d) -> EmbedGitHub (a -> b -> c -> Paginated d)

HasGitHub (a -> b -> Paginated c)

Methods

embedGitHub :: (a -> b -> Paginated c) -> EmbedGitHub (a -> b -> Paginated c)

HasGitHub (a -> Paginated b)

Methods

embedGitHub :: (a -> Paginated b) -> EmbedGitHub (a -> Paginated b)

HasGitHub (a -> b -> c -> d -> e -> Single f)

Methods

embedGitHub :: (a -> b -> c -> d -> e -> Single f) -> EmbedGitHub (a -> b -> c -> d -> e -> Single f)

HasGitHub (a -> b -> c -> d -> Single e)

Methods

embedGitHub :: (a -> b -> c -> d -> Single e) -> EmbedGitHub (a -> b -> c -> d -> Single e)

HasGitHub (a -> b -> c -> Single d)

Methods

embedGitHub :: (a -> b -> c -> Single d) -> EmbedGitHub (a -> b -> c -> Single d)

HasGitHub (a -> b -> Single c)

Methods

embedGitHub :: (a -> b -> Single c) -> EmbedGitHub (a -> b -> Single c)

HasGitHub (a -> Single b)

Methods

embedGitHub :: (a -> Single b) -> EmbedGitHub (a -> Single b)

setUserAgent :: Text -> GitHub ()

Overide default value for User-agent header. Note, GitHub requires that a User-agent header be set.

Pagination

Functions for managing the pagination features of the GitHub API

resetPagination :: GitHub ()

Set next page back to 1, and remove the links

recurseOff :: GitHub ()

Turn automatic recusive behaviour on and off.

If recursive is on, paginated results will be automatically followed and concated together.

recurseOn :: GitHub ()

Turn automatic recusive behaviour on and off.

If recursive is on, paginated results will be automatically followed and concated together.

pageSize :: Int -> GitHub ()

The default number of records per page is set to 100. Smaller pages can be set, but not bigger than 100.

getLinks :: GitHub (Maybe [Link])

Return the Link header. This is only set when there are futher pages.

module Network.GitHub.API

module Network.GitHub.Types