Maintainer	Brandon Chinn <brandon@leapyear.io>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

GitHub.REST.Monad

Description

Defines GitHubT and MonadGitHubREST, a monad transformer and type class that gives a monad m the capability to query the GitHub REST API.

Synopsis

class Monad m => MonadGitHubREST m where
- queryGitHubPage' :: FromJSON a => GHEndpoint -> m (Either (Text, Text) (a, PageLinks))
- queryGitHubPage :: FromJSON a => GHEndpoint -> m (a, PageLinks)
- queryGitHub :: FromJSON a => GHEndpoint -> m a
- queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> m a
- queryGitHub_ :: GHEndpoint -> m ()
data GitHubT m a
data GitHubState = GitHubState {
- token :: Maybe Token
- userAgent :: ByteString
- apiVersion :: ByteString
}
runGitHubT :: MonadIO m => GitHubState -> GitHubT m a -> m a

Documentation

class Monad m => MonadGitHubREST m where Source #

A type class for monads that can query the GitHub REST API.

Example:

-- create the "foo" branch
queryGitHub GHEndpoint
  { method = POST
  , endpoint = "/repos/:owner/:repo/git/refs"
  , endpointVals =
    [ "owner" := "alice"
    , "repo" := "my-project"
    ]
  , ghData =
    [ "ref" := "refs/heads/foo"
    , "sha" := "1234567890abcdef"
    ]
  }

It's recommended that you create functions for the API endpoints you're using:

deleteBranch branch = queryGitHub GHEndpoint
  { method = DELETE
  , endpoint = "/repos/:owner/:repo/git/refs/:ref"
  , endpointVals =
    [ "owner" := "alice"
    , "repo" := "my-project"
    , "ref" := "heads/" <> branch
    ]
  , ghData = []
  }

Minimal complete definition

queryGitHubPage'

Methods

queryGitHubPage' :: FromJSON a => GHEndpoint -> m (Either (Text, Text) (a, PageLinks)) Source #

Query GitHub, returning Right (payload, links) if successful, where payload is the response that GitHub sent back and links containing any pagination links GitHub may have sent back. If the response could not be decoded as JSON, returns Left (error message, response from server).

Errors on network connection failures or if GitHub sent back an error message. Use githubTry if you wish to handle GitHub errors.

queryGitHubPage :: FromJSON a => GHEndpoint -> m (a, PageLinks) Source #

queryGitHubPage', except calls fail if JSON decoding fails.

queryGitHub :: FromJSON a => GHEndpoint -> m a Source #

queryGitHubPage, except ignoring pagination links.

queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> m a Source #

Repeatedly calls queryGitHubPage for each page returned by GitHub and concatenates the results.

queryGitHub_ :: GHEndpoint -> m () Source #

queryGitHub, except ignores the result.

Instances

MonadGitHubREST m => MonadGitHubREST (MaybeT m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> MaybeT m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> MaybeT m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> MaybeT m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> MaybeT m a Source # queryGitHub_ :: GHEndpoint -> MaybeT m () Source #
MonadIO m => MonadGitHubREST (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> GitHubT m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> GitHubT m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> GitHubT m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> GitHubT m a Source # queryGitHub_ :: GHEndpoint -> GitHubT m () Source #
MonadGitHubREST m => MonadGitHubREST (ExceptT e m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> ExceptT e m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> ExceptT e m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> ExceptT e m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> ExceptT e m a Source # queryGitHub_ :: GHEndpoint -> ExceptT e m () Source #
MonadGitHubREST m => MonadGitHubREST (IdentityT m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> IdentityT m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> IdentityT m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> IdentityT m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> IdentityT m a Source # queryGitHub_ :: GHEndpoint -> IdentityT m () Source #
MonadGitHubREST m => MonadGitHubREST (StateT s m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> StateT s m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> StateT s m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> StateT s m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> StateT s m a Source # queryGitHub_ :: GHEndpoint -> StateT s m () Source #
MonadGitHubREST m => MonadGitHubREST (StateT s m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> StateT s m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> StateT s m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> StateT s m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> StateT s m a Source # queryGitHub_ :: GHEndpoint -> StateT s m () Source #
(Monoid w, MonadGitHubREST m) => MonadGitHubREST (WriterT w m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> WriterT w m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> WriterT w m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> WriterT w m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> WriterT w m a Source # queryGitHub_ :: GHEndpoint -> WriterT w m () Source #
(Monoid w, MonadGitHubREST m) => MonadGitHubREST (WriterT w m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> WriterT w m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> WriterT w m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> WriterT w m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> WriterT w m a Source # queryGitHub_ :: GHEndpoint -> WriterT w m () Source #
MonadGitHubREST m => MonadGitHubREST (ReaderT r m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> ReaderT r m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> ReaderT r m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> ReaderT r m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> ReaderT r m a Source # queryGitHub_ :: GHEndpoint -> ReaderT r m () Source #
(Monoid w, MonadGitHubREST m) => MonadGitHubREST (RWST r w s m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> RWST r w s m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> RWST r w s m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> RWST r w s m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> RWST r w s m a Source # queryGitHub_ :: GHEndpoint -> RWST r w s m () Source #
(Monoid w, MonadGitHubREST m) => MonadGitHubREST (RWST r w s m) Source #
Instance details Defined in GitHub.REST.Monad.Class Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> RWST r w s m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> RWST r w s m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> RWST r w s m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> RWST r w s m a Source # queryGitHub_ :: GHEndpoint -> RWST r w s m () Source #

data GitHubT m a Source #

A simple monad that can run REST calls.

Instances

MonadTrans GitHubT Source #
Instance details Defined in GitHub.REST.Monad Methods lift :: Monad m => m a -> GitHubT m a #
Monad m => Monad (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods (>>=) :: GitHubT m a -> (a -> GitHubT m b) -> GitHubT m b # (>>) :: GitHubT m a -> GitHubT m b -> GitHubT m b # return :: a -> GitHubT m a # fail :: String -> GitHubT m a #
Functor m => Functor (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods fmap :: (a -> b) -> GitHubT m a -> GitHubT m b # (<$) :: a -> GitHubT m b -> GitHubT m a #
MonadFail m => MonadFail (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods fail :: String -> GitHubT m a #
Applicative m => Applicative (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods pure :: a -> GitHubT m a # (<>) :: GitHubT m (a -> b) -> GitHubT m a -> GitHubT m b # liftA2 :: (a -> b -> c) -> GitHubT m a -> GitHubT m b -> GitHubT m c # (>) :: GitHubT m a -> GitHubT m b -> GitHubT m b # (<*) :: GitHubT m a -> GitHubT m b -> GitHubT m a #
MonadIO m => MonadIO (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods liftIO :: IO a -> GitHubT m a #
MonadUnliftIO m => MonadUnliftIO (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods withRunInIO :: ((forall a. GitHubT m a -> IO a) -> IO b) -> GitHubT m b #
MonadIO m => MonadGitHubREST (GitHubT m) Source #
Instance details Defined in GitHub.REST.Monad Methods queryGitHubPage' :: FromJSON a => GHEndpoint -> GitHubT m (Either (Text, Text) (a, PageLinks)) Source # queryGitHubPage :: FromJSON a => GHEndpoint -> GitHubT m (a, PageLinks) Source # queryGitHub :: FromJSON a => GHEndpoint -> GitHubT m a Source # queryGitHubAll :: (FromJSON a, Monoid a) => GHEndpoint -> GitHubT m a Source # queryGitHub_ :: GHEndpoint -> GitHubT m () Source #

data GitHubState Source #

Constructors

GitHubState

Fields

token :: Maybe Token
The token to use to authenticate with the API.
userAgent :: ByteString
The user agent to use when interacting with the API: https://developer.github.com/v3/#user-agent-required
apiVersion :: ByteString
The media type will be sent as: application/vnd.github.VERSION+json. For the standard API endpoints, "v3" should be sufficient here. See https://developer.github.com/v3/media/

runGitHubT :: MonadIO m => GitHubState -> GitHubT m a -> m a Source #

Run the given GitHubT action with the given token and user agent.

The token will be sent with each API request -- see Token. The user agent is also required for each API request -- see https://developer.github.com/v3/#user-agent-required.