diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,5 @@ +# Changelog for gitlab-api + +## v0.0.0.1 + +Add general conduit interface. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,30 @@ +Copyright Author name here (c) 2018 + +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + * Neither the name of Author name here nor the names of other + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +# Gitlab V4 API + +This is the gitlab rest API in Haskell. This is extremely underdeveloped and only +supports a couple of functions. Pull requests welcome. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/gitlab-api.cabal b/gitlab-api.cabal new file mode 100644 --- /dev/null +++ b/gitlab-api.cabal @@ -0,0 +1,62 @@ +-- This file has been generated from package.yaml by hpack version 0.28.2. +-- +-- see: https://github.com/sol/hpack +-- +-- hash: 3e6c5e54e5f4e13d5117b62d249b59f54c075b18d71d955717dde58c30b575cd + +name: gitlab-api +version: 0.0.0.1 +synopsis: Gitlab Web API +description: Gitlab Web API V4 +category: Web +author: Daniel Firth +maintainer: locallycompact@gmail.com +copyright: 2018 Daniel Firth +license: BSD3 +license-file: LICENSE +build-type: Simple +cabal-version: >= 1.10 +extra-source-files: + ChangeLog.md + README.md + +source-repository head + type: git + location: https://gitlab.com/locallycompact/gitlab-api + +library + exposed-modules: + Gitlab + Gitlab.Core + Gitlab.Projects + Gitlab.Wikis + other-modules: + Paths_gitlab_api + hs-source-dirs: + src + default-extensions: AutoDeriveTypeable BangPatterns BinaryLiterals ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable DoAndIfThenElse EmptyDataDecls ExistentialQuantification FlexibleContexts FlexibleInstances FunctionalDependencies GADTs GeneralizedNewtypeDeriving InstanceSigs KindSignatures LambdaCase MonadFailDesugaring MultiParamTypeClasses MultiWayIf NamedFieldPuns NoImplicitPrelude OverloadedStrings PartialTypeSignatures PatternGuards PolyKinds RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving TupleSections TypeFamilies TypeSynonymInstances ViewPatterns + build-depends: + aeson + , base >=4.7 && <5 + , http-conduit + , http-types + , microlens-platform + , rio + , yaml + default-language: Haskell2010 + +test-suite gitlab-api-test + type: exitcode-stdio-1.0 + main-is: Spec.hs + other-modules: + Paths_gitlab_api + hs-source-dirs: + test + default-extensions: AutoDeriveTypeable BangPatterns BinaryLiterals ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable DoAndIfThenElse EmptyDataDecls ExistentialQuantification FlexibleContexts FlexibleInstances FunctionalDependencies GADTs GeneralizedNewtypeDeriving InstanceSigs KindSignatures LambdaCase MonadFailDesugaring MultiParamTypeClasses MultiWayIf NamedFieldPuns NoImplicitPrelude OverloadedStrings PartialTypeSignatures PatternGuards PolyKinds RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving TupleSections TypeFamilies TypeSynonymInstances ViewPatterns + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + base >=4.7 && <5 + , gitlab-api + , hspec + , rio + default-language: Haskell2010 diff --git a/src/Gitlab.hs b/src/Gitlab.hs new file mode 100644 --- /dev/null +++ b/src/Gitlab.hs @@ -0,0 +1,10 @@ +module Gitlab + ( module Gitlab.Core + , module Gitlab.Projects + , module Gitlab.Wikis + ) +where + +import Gitlab.Core +import Gitlab.Projects +import Gitlab.Wikis diff --git a/src/Gitlab/Core.hs b/src/Gitlab/Core.hs new file mode 100644 --- /dev/null +++ b/src/Gitlab/Core.hs @@ -0,0 +1,44 @@ +module Gitlab.Core where + +import Data.Yaml +import Network.HTTP.Simple +import Network.HTTP.Conduit +import Network.HTTP.Types +import RIO +import qualified RIO.Text as Text + +class HasGitlabConfig a where + gitlabConfigL :: Lens' a GitlabConfig + +data GitlabConfig = GitlabConfig { + glBaseUrl :: Text +, glToken :: Text +} deriving (Eq, Show) + +instance HasGitlabConfig GitlabConfig where + gitlabConfigL = id + +type MonadGitlab env m = (MonadReader env m, HasGitlabConfig env, MonadIO m, MonadThrow m) + +gitlabRequest + :: (MonadGitlab env m, FromJSON a) + => ByteString + -> ByteString + -> RequestBody + -> m a +gitlabRequest method path body = do + conf <- ask . view $ gitlabConfigL + request' <- parseRequest $ Text.unpack $ glBaseUrl conf + let headers = + [ ("PRIVATE-TOKEN", fromString . Text.unpack $ glToken conf) + , ("Content-Type" , "application/json; charset=utf-8") + ] + let request = + setRequestMethod method + $ setRequestPath ("/api/v4" <> path) + $ setRequestHeaders headers + $ setRequestBody body request' + response <- httpJSON request + return $ getResponseBody response + +rParam x = urlEncode False (fromString . Text.unpack $ x) diff --git a/src/Gitlab/Projects.hs b/src/Gitlab/Projects.hs new file mode 100644 --- /dev/null +++ b/src/Gitlab/Projects.hs @@ -0,0 +1,35 @@ +{-# LANGUAGE TemplateHaskell #-} + +module Gitlab.Projects where + +import Data.Yaml +import Gitlab.Core +import Lens.Micro.Platform +import RIO +import RIO.Time + +data GitlabCommitData = GitlabCommitData { + _authoredDate :: UTCTime, + _authorEmail :: Text, + _authorName :: Text, + _committedDate :: UTCTime, + _committerName :: Text, + _commitId :: Text +} deriving (Eq, Show) + +$(makeLenses ''GitlabCommitData) + +instance FromJSON GitlabCommitData where + parseJSON = withObject "GitlabCommitData" $ \v -> GitlabCommitData + <$> v .: "authored_date" + <*> v .: "author_email" + <*> v .: "author_name" + <*> v .: "committed_date" + <*> v .: "committer_name" + <*> v .: "id" + +getCommitData :: MonadGitlab env m => Text -> Text -> m GitlabCommitData +getCommitData p r = gitlabRequest + "GET" + ("/projects/" <> rParam p <> "/repository/commits/" <> rParam r) + mempty diff --git a/src/Gitlab/Wikis.hs b/src/Gitlab/Wikis.hs new file mode 100644 --- /dev/null +++ b/src/Gitlab/Wikis.hs @@ -0,0 +1,44 @@ +{-# LANGUAGE TemplateHaskell #-} + +module Gitlab.Wikis where + +import Data.Aeson +import Gitlab.Core +import Lens.Micro.Platform hiding ( (.=) ) +import Network.HTTP.Conduit +import RIO + +data GitlabWikiPage = GitlabWikiPage { + _glWikiPageContent :: Text +, _glWikiPageFormat :: Text +, _glWikiPageSlug :: Text +, _glWikiPageTitle :: Text +} deriving (Eq, Show) + +$(makeLenses ''GitlabWikiPage) + +instance FromJSON GitlabWikiPage where + parseJSON = withObject "GitlabWikiPage" $ \v -> GitlabWikiPage + <$> v .: "content" + <*> v .: "format" + <*> v .: "slug" + <*> v .: "title" + +instance ToJSON GitlabWikiPage where + toJSON x = object ["content" .= _glWikiPageContent x, + "format" .= _glWikiPageFormat x, + "slug" .= _glWikiPageSlug x, + "title" .= _glWikiPageTitle x] + +getProjectWiki :: MonadGitlab env m => Text -> m [GitlabWikiPage] +getProjectWiki p = gitlabRequest + "GET" + ("/projects/" <> rParam p <> "/wikis?with_content=1") + mempty + +createWikiPage + :: MonadGitlab env m => Text -> GitlabWikiPage -> m GitlabWikiPage +createWikiPage p o = + gitlabRequest "POST" ("/projects/" <> rParam p <> "/wikis") + $ RequestBodyLBS + $ encode o diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} + +import qualified RIO.Text as Text +import RIO +import Gitlab +import System.Environment +import Test.Hspec + +data GitlabTestApp = GitlabTestApp { + gitlabConfig :: GitlabConfig +, logFunc :: LogFunc +} + +instance HasGitlabConfig GitlabTestApp where + gitlabConfigL = lens gitlabConfig (\x y -> x { gitlabConfig = y }) + +instance HasLogFunc GitlabTestApp where + logFuncL = lens logFunc (\x y -> x { logFunc = y }) + +runLogVanish :: (Show a) => GitlabTestApp -> RIO GitlabTestApp a -> IO () +runLogVanish app f = void $ asIO $ runRIO app $ f >>= logInfo . displayShow + +glproj = "locallycompact/gitlab-api" + +main :: IO () +main = do + envPrivateToken <- liftIO $ getEnv "GITLAB_PRIVATE_TOKEN" + let gconf = GitlabConfig + { glBaseUrl = "https://gitlab.com" + , glToken = Text.pack envPrivateToken + } + + logOptions <- logOptionsHandle stdout True + + withLogFunc logOptions $ \l -> do + let app = GitlabTestApp gconf l + hspec $ do + describe "Gitlab.Projects" + $ it "getCommitData works" + $ runLogVanish app + $ getCommitData glProj "master" + describe "Gitlab.Wikis" $ do + it "getProjectWiki works" $ runLogVanish app $ getProjectWiki glproj + it "createWikiPage works" + $ runLogVanish app + $ createWikiPage glproj + $ GitlabWikiPage "foo" "markdown" "foo" "foo"