Up

haskell-github · andreasabel · Jun 24, 2023 · Jun 22, 2021 · Jul 16, 2022 · Jul 17, 2022
commit f1e951373e7ec7e7f08c0b16c2d917334a6eb61d
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ cabal.sandbox.config
 run.sh
 src/hightlight.js
 src/style.css
+.DS_Store
diff --git a/github.cabal b/github.cabal
@@ -119,6 +119,7 @@ library
     GitHub.Data.Webhooks
     GitHub.Data.Webhooks.Validate
     GitHub.Endpoints.Actions.Artifacts
+    GitHub.Endpoints.Actions.Cache
     GitHub.Endpoints.Activity.Events
     GitHub.Endpoints.Activity.Notifications
     GitHub.Endpoints.Activity.Starring
@@ -201,9 +202,9 @@ library
 
   if flag(openssl)
     build-depends:
-        HsOpenSSL              >=0.11.4.16 && <0.12
-      , HsOpenSSL-x509-system  >=0.1.0.3   && <0.2
-      , http-client-openssl    >=0.2.2.0   && <0.4
+        HsOpenSSL              >=0.11.4.16 && <1.12
+      , HsOpenSSL-x509-system  >=0.1.0.3   && <1.2
+      , http-client-openssl    >=0.2.2.0   && <1.4
 
   else
     build-depends:

diff --git a/hie.yaml b/hie.yaml
@@ -0,0 +1,4 @@
+cradle:
+  stack:
+    - path: "./src"
+      component: "github:lib"
diff --git a/src/GitHub/Data/Actions.hs b/src/GitHub/Data/Actions.hs
@@ -13,6 +13,7 @@ module GitHub.Data.Actions (
     PaginatedWithTotalCount(..),
     WithTotalCount(..),
     WorkflowRun,
+    Cache(..),
     ) where
 
 import GHC.TypeLits
@@ -24,6 +25,32 @@ import Prelude ()
 import           Data.Data (Proxy (..))
 import qualified Data.Text as T
 
+-------------------------------------------------------------------------------
+-- Common
+-------------------------------------------------------------------------------
+
+data PaginatedWithTotalCount a (tag :: Symbol) = PaginatedWithTotalCount
+    { paginatedWithTotalCountItems :: !(Vector a)
+    , paginatedWithTotalCountTotalCount :: !Int
+    }
+
+data WithTotalCount a = WithTotalCount
+    { withTotalCountItems :: !(Vector a)
+    , withTotalCountTotalCount :: !Int
+    } deriving (Show, Data, Typeable, Eq, Ord, Generic)
+
+instance Semigroup (WithTotalCount a) where
+    (WithTotalCount items1 count1) <> (WithTotalCount items2 _) =
+        WithTotalCount (items1 <> items2) count1
+
+instance Foldable WithTotalCount where
+    foldMap f (WithTotalCount items _) = foldMap f items
+
+
+-------------------------------------------------------------------------------
+-- Artifact
+-------------------------------------------------------------------------------
+
 data Artifact = Artifact
     { artifactArchiveDownloadUrl :: !URL
     , artifactCreatedAt :: !UTCTime
@@ -44,23 +71,6 @@ data ArtifactList = ArtifactList
     }
     deriving (Show, Data, Typeable, Eq, Ord, Generic)
 
-data PaginatedWithTotalCount a (tag :: Symbol) = PaginatedWithTotalCount
-    { paginatedWithTotalCountItems :: !(Vector a)
-    , paginatedWithTotalCountTotalCount :: !Int
-    }
-
-data WithTotalCount a = WithTotalCount
-    { withTotalCountItems :: !(Vector a)
-    , withTotalCountTotalCount :: !Int
-    } deriving (Show, Data, Typeable, Eq, Ord, Generic)
-
-instance Semigroup (WithTotalCount a) where
-    (WithTotalCount items1 count1) <> (WithTotalCount items2 _) =
-        WithTotalCount (items1 <> items2) count1
-
-instance Foldable WithTotalCount where
-    foldMap f (WithTotalCount items _) = foldMap f items
-
 data Workflow
 data WorkflowRun
 
@@ -95,3 +105,62 @@ instance FromJSON (WithTotalCount Artifact) where
     parseJSON = withObject "ArtifactList" $ \o -> WithTotalCount
         <$> o .: "artifacts"
         <*> o .: "total_count"
+
+
+-------------------------------------------------------------------------------
+-- Cache
+-------------------------------------------------------------------------------
+
+data Cache = Cache
+    { cacheId :: !(Id Cache)
+    , cacheRef :: !Text
+    , cacheKey :: !Text
+    , cacheVersion :: !Text
+    , cacheLastAccessedAt :: !UTCTime
+    , cacheCreatedAt :: !UTCTime
+    , cacheSizeInBytes :: !Int
+    }
+  deriving (Show, Data, Typeable, Eq, Ord, Generic)
+
+-- data CacheList = CacheList
+--     { cacheListCaches :: !(Vector Cache)
+--     , cacheListTotalCount :: !Int
+--     }
+--     deriving (Show, Data, Typeable, Eq, Ord, Generic)
+
+-- data Workflow
+-- data WorkflowRun
+
+-- -------------------------------------------------------------------------------
+-- -- JSON instances
+-- -------------------------------------------------------------------------------
+
+instance FromJSON Cache where
+    parseJSON = withObject "Cache" $ \o -> Cache
+        <$> o .: "id"
+        <*> o .: "ref"
+        <*> o .: "key"
+        <*> o .: "version"
+        <*> o .: "last_accessed_at"
+        <*> o .: "created_at"
+        <*> o .: "size_in_bytes"
+
+-- instance FromJSON CacheList where
+--     parseJSON = withObject "CacheList" $ \o -> CacheList
+--         <$> o .: "actions_caches"
+--         <*> o .: "total_count"
+
+instance FromJSON (WithTotalCount Cache) where
+    parseJSON = withObject "CacheList" $ \o -> WithTotalCount
+        <$> o .: "actions_caches"
+        <*> o .: "total_count"
+
+-- instance (FromJSON a, KnownSymbol l) => FromJSON (PaginatedWithTotalCount a l) where
+--     parseJSON = withObject "PaginatedWithTotalCount" $ \o -> PaginatedWithTotalCount
+--         <$> o .: T.pack (symbolVal (Proxy :: Proxy l))
+--         <*> o .: "total_count"
+
+-- instance FromJSON (WithTotalCount Artifact) where
+--     parseJSON = withObject "ArtifactList" $ \o -> WithTotalCount
+--         <$> o .: "artifacts"
+--         <*> o .: "total_count"
diff --git a/src/GitHub/Data/Options.hs b/src/GitHub/Data/Options.hs
@@ -1,4 +1,5 @@
 {-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE LambdaCase #-}
 -----------------------------------------------------------------------------
 -- |
 -- License     :  BSD-3-Clause
@@ -44,6 +45,18 @@ module GitHub.Data.Options (
     optionsIrrelevantAssignee,
     optionsAnyAssignee,
     optionsNoAssignee,
+    -- * Actions cache
+    CacheMod,
+    cacheModToQueryString,
+    optionsRef,
+    optionsNoRef,
+    optionsKey,
+    optionsNoKey,
+    optionsDirectionAsc,
+    optionsDirectionDesc,
+    sortByCreatedAt,
+    sortByLastAccessedAt,
+    sortBySizeInBytes,
     -- * Data
     IssueState (..),
     MergeableState (..),
@@ -180,6 +193,18 @@ data FilterBy a
   deriving
     (Eq, Ord, Show, Generic, Typeable, Data)
 
+-- Actions cache
+
+data SortCache
+    = SortCacheCreatedAt
+    | SortCacheLastAccessedAt
+    | SortCacheSizeInBytes
+  deriving
+    (Eq, Ord, Show, Enum, Bounded, Generic, Typeable, Data)
+
+instance NFData SortCache where rnf = genericRnf
+instance Binary SortCache
+
 -------------------------------------------------------------------------------
 -- Classes
 -------------------------------------------------------------------------------
@@ -607,3 +632,101 @@ optionsAnyAssignee = IssueRepoMod $ \opts ->
 optionsNoAssignee :: IssueRepoMod
 optionsNoAssignee = IssueRepoMod $ \opts ->
     opts { issueRepoOptionsAssignee = FilterNone }
+
+-------------------------------------------------------------------------------
+-- Actions cache
+-------------------------------------------------------------------------------
+
+-- | See <https://docs.github.com/en/rest/actions/cache#list-github-actions-caches-for-a-repository>.
+data CacheOptions = CacheOptions
+    { cacheOptionsRef     :: !(Maybe Text)
+    , cacheOptionsKey      :: !(Maybe Text)
+    , cacheOptionsSort      :: !(Maybe SortCache)
+    , cacheOptionsDirection :: !(Maybe SortDirection)
+    }
+  deriving
+    (Eq, Ord, Show, Generic, Typeable, Data)
+
+defaultCacheOptions :: CacheOptions
+defaultCacheOptions = CacheOptions
+    { cacheOptionsRef = Nothing
+    , cacheOptionsKey  = Nothing
+    , cacheOptionsSort  = Nothing
+    , cacheOptionsDirection = Nothing
+    }
+
+-- | See <https://docs.github.com/en/rest/actions/cache#list-github-actions-caches-for-a-repository>.
+newtype CacheMod = CacheMod (CacheOptions -> CacheOptions)
+
+instance Semigroup CacheMod where
+    CacheMod f <> CacheMod g = CacheMod (g . f)
+
+instance Monoid CacheMod where
+    mempty  = CacheMod id
+    mappend = (<>)
+
+toCacheOptions :: CacheMod -> CacheOptions
+toCacheOptions (CacheMod f) = f defaultCacheOptions
+
+cacheModToQueryString :: CacheMod -> QueryString
+cacheModToQueryString = cacheOptionsToQueryString . toCacheOptions
+
+cacheOptionsToQueryString :: CacheOptions -> QueryString
+cacheOptionsToQueryString (CacheOptions ref key sort dir) =
+    catMaybes
+    [ mk "ref" <$> ref'
+    , mk "key" <$> key'
+    , mk "sort" <$> sort'
+    , mk "directions" <$> direction'
+    ]
+  where
+    mk k v = (k, Just v)
+    sort' = fmap (\case
+        SortCacheCreatedAt     -> "created_at"
+        SortCacheLastAccessedAt     -> "last_accessed_at"
+        SortCacheSizeInBytes  -> "size_in_bytes") sort
+    direction' = fmap (\case
+       SortDescending -> "desc"
+       SortAscending  -> "asc") dir
+    ref' = fmap TE.encodeUtf8 ref
+    key' = fmap TE.encodeUtf8 key
+
+-------------------------------------------------------------------------------
+-- Pull request modifiers
+-------------------------------------------------------------------------------
+
+optionsRef :: Text -> CacheMod
+optionsRef x = CacheMod $ \opts ->
+    opts { cacheOptionsRef = Just x }
+
+optionsNoRef :: CacheMod
+optionsNoRef = CacheMod $ \opts ->
+    opts { cacheOptionsRef = Nothing }
+
+optionsKey :: Text -> CacheMod
+optionsKey x = CacheMod $ \opts ->
+    opts { cacheOptionsKey = Just x }
+
+optionsNoKey :: CacheMod
+optionsNoKey = CacheMod $ \opts ->
+    opts { cacheOptionsKey = Nothing }
+
+optionsDirectionAsc :: CacheMod
+optionsDirectionAsc = CacheMod $ \opts ->
+    opts { cacheOptionsDirection = Just SortAscending }
+
+optionsDirectionDesc :: CacheMod
+optionsDirectionDesc = CacheMod $ \opts ->
+    opts { cacheOptionsDirection = Just SortDescending }
+
+sortByCreatedAt :: CacheMod
+sortByCreatedAt = CacheMod $ \opts ->
+    opts { cacheOptionsSort = Just SortCacheCreatedAt }
+
+sortByLastAccessedAt :: CacheMod
+sortByLastAccessedAt = CacheMod $ \opts ->
+    opts { cacheOptionsSort = Just SortCacheLastAccessedAt }
+
+sortBySizeInBytes :: CacheMod
+sortBySizeInBytes = CacheMod $ \opts ->
+    opts { cacheOptionsSort = Just SortCacheSizeInBytes }
diff --git a/src/GitHub/Endpoints/Actions/Cache.hs b/src/GitHub/Endpoints/Actions/Cache.hs
@@ -0,0 +1,73 @@
+-----------------------------------------------------------------------------
+-- |
+-- License     :  BSD-3-Clause
+-- Maintainer  :  Oleg Grenrus <[email protected]>
+--
+-- The actions API as documented at
+-- <https://docs.github.com/en/rest/reference/actions>.
+module GitHub.Endpoints.Actions.Cache (
+    cachesForRepoR,
+    deleteCacheR,
+    module GitHub.Data
+    ) where
+
+import GitHub.Data
+import GitHub.Internal.Prelude
+import Network.URI             (URI)
+import Prelude ()
+-- import GitHub.Data.Actions (ActionWorkflow, ActionWorkflowResult, ActionWorkflowRun, Workflow, ActionWorkflowRunResult, CreateWorkflowDispatchEvent)
+
+-- -- | List artifacts for repository.
+-- -- See <https://docs.github.com/en/rest/reference/actions#list-artifacts-for-a-repository>
+-- artifactsForR
+--     :: Name Owner
+--     -> Name Repo
+--     -> FetchCount
+--     -> Request k (WithTotalCount Artifact)
+-- artifactsForR user repo  = PagedQuery
+--     ["repos", toPathPart user, toPathPart repo, "actions", "artifacts"]
+--     []
+
+
+-- -- | Query a single artifact.
+-- -- See <https://docs.github.com/en/rest/reference/actions#get-an-artifact>
+-- artifactR :: Name Owner -> Name Repo -> Id Artifact -> Request k Artifact
+-- artifactR user repo artid =
+--     query ["repos", toPathPart user, toPathPart repo, "actions", "artifacts", toPathPart artid] []
+
+
+-- -- | Download an artifact.
+-- -- See <https://docs.github.com/en/rest/reference/actions#download-an-artifact>
+-- downloadArtifactR :: Name Owner -> Name Repo -> Id Artifact -> GenRequest 'MtRedirect 'RW URI
+-- downloadArtifactR user repo artid =
+--     Query ["repos", toPathPart user, toPathPart repo, "actions", "artifacts", toPathPart artid, "zip"] []
+
+-- | List the GitHub Actions caches for a repository.
+-- See <https://docs.github.com/en/rest/actions/cache#list-github-actions-caches-for-a-repository>
+cachesForRepoR
+    :: Name Owner
+    -> Name Repo
+    -> CacheMod
+    -> FetchCount
+    -> GenRequest 'MtJSON 'RA (WithTotalCount Cache) 
+cachesForRepoR user repo opts = PagedQuery
+    ["repos", toPathPart user, toPathPart repo, "actions", "caches"]
+    (cacheModToQueryString opts)
+
+-- | Delete GitHub Actions cache for a repository.
+-- See <https://docs.github.com/en/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key>
+-- TODO: No querystring for Commands???
+-- TODO: return value
+-- deleteCachesKeyR :: Name Owner -> Name Repo -> String -> Maybe String -> GenRequest 'MtUnit 'RW ()
+-- deleteCachesKeyR user repo key ref =
+--     Command Delete parts mempty
+--   where
+--     parts = ["repos", toPathPart user, toPathPart repo, "actions", "caches"]
+
+-- | Delete GitHub Actions cache for a repository.
+-- See <https://docs.github.com/en/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id>
+deleteCacheR :: Name Owner -> Name Repo -> Id Cache -> GenRequest 'MtUnit 'RW ()
+deleteCacheR user repo cacheid =
+    Command Delete parts mempty
+  where
+    parts = ["repos", toPathPart user, toPathPart repo, "actions", "caches", toPathPart cacheid]