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

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

GitHub monad

Use the runGitHub function to execute the GitHub client function.

type GitHub = ReaderT (Maybe AuthToken) (StateT GitHubState (EitherT ServantError IO))

The GitHub monad provides execution context

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

IsString AuthToken

ToText AuthToken

HasGitHub (Paginated a)

Instance for the case where we have paginated results

HasGitHub (Single a)

Instance for the case where we have single result

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

HasGitHub (a -> b -> Paginated c)

HasGitHub (a -> Paginated b)

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

HasGitHub (a -> b -> Single c)

HasGitHub (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