Network.GitHub.Client

Documentation

github :: (HasClient (AddHeaders api), HasGitHub (Client (AddHeaders api))) => Proxy api -> EmbedGitHub (Client (AddHeaders api))

Wrapper around the servant client function, that takes care of the extra headers that required for the GitHub 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)

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 GitHubState

GitHubState options that control which headers are provided to the API and stores the Link header result

Constructors

GitHubState

Fields

• perPage :: Int

  The number of records returned per page

• page :: Int

  The page number returned

• links :: Maybe [Link]

  Contains the returned Link header, if available.

• recurse :: Bool

  Flag to set the recursive mode on

• useragent :: Text

  Text to send as User-agent

class HasGitHub a where

This class defines how the client code is actually called.

Minimal complete definition

embedGitHub

Methods

embedGitHub :: a -> EmbedGitHub a

Instances

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)

embedGitHub :: HasGitHub a => a -> EmbedGitHub a

type family EmbedGitHub a :: * where ...

Closed type family for recursively defining the GitHub client funciton types

Equations

EmbedGitHub (Single a) = GitHub a

EmbedGitHub (Paginated a) = GitHub [a]

EmbedGitHub (CountedPaginated name a) = GitHub (CountedList name a)

EmbedGitHub (a -> b) = a -> EmbedGitHub b

type family AddHeaders a :: * where ...

Closed type family that adds standard headers to the incoming servant API type. The extra headers are put after any arguments types.

Equations

AddHeaders ((sym :: Symbol) :> last) = (sym :: Symbol) :> AddHeaders last

AddHeaders (first :> last) = first :> AddHeaders last

AddHeaders last = Header "User-Agent" Text :> (Header "Authorization" AuthToken :> ReadHeaders last)

type family ReadHeaders a :: * where ...

Closed type family that adds headers necessary for pagination. In particular, it captures the Link header from the response.

Equations

ReadHeaders (Get cts [res]) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Get cts (Headers '[Header "Link" Text] [res]))

ReadHeaders (Post cts [res]) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Post cts (Headers '[Header "Link" Text] [res]))

ReadHeaders (Delete cts [res]) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Delete cts (Headers '[Header "Link" Text] [res]))

ReadHeaders (Put cts [res]) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Put cts (Headers '[Header "Link" Text] [res]))

ReadHeaders (Patch cts [res]) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Patch cts (Headers '[Header "Link" Text] [res]))

ReadHeaders (Get cts (CountedList name res)) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Get cts (Headers '[Header "Link" Text] (CountedList name res)))

ReadHeaders (Post cts (CountedList name res)) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Post cts (Headers '[Header "Link" Text] (CountedList name res)))

ReadHeaders (Delete cts (CountedList name res)) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Delete cts (Headers '[Header "Link" Text] (CountedList name res)))

ReadHeaders (Put cts (CountedList name res)) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Put cts (Headers '[Header "Link" Text] (CountedList name res)))

ReadHeaders (Patch cts (CountedList name res)) = QueryParam "page" Int :> (QueryParam "per_page" Int :> Patch cts (Headers '[Header "Link" Text] (CountedList name res)))

ReadHeaders otherwise = otherwise

type Single a = Maybe Text -> Maybe AuthToken -> ClientM a

Client function that returns a single result

type Paginated a = Maybe Text -> Maybe AuthToken -> Maybe Int -> Maybe Int -> ClientM (Headers '[Header "Link" Text] [a])

Client function that returns a list of results, and is therefore paginated

setUserAgent :: Text -> GitHub ()

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

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.