restructure modules

Holmusk · Aug 4, 2024 · c0bea6a · c0bea6a
1 parent 78bdf69
commit c0bea6a
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 12 deletions.
diff --git a/azure-blob-storage/azure-blob-storage.cabal b/azure-blob-storage/azure-blob-storage.cabal
@@ -51,12 +51,13 @@ common common-options
 
 library
     import:           common-options
-    exposed-modules:  Azure.Blob.Types
-                      Azure.GetBlob
-                      Azure.DeleteBlob
-                      Azure.PutBlob
-                      Azure.UserDelegationKey
-                      Azure.SharedAccessSignature
+    exposed-modules:  Azure.Blob
+                      Azure.Blob.GetBlob
+                      Azure.Blob.DeleteBlob
+                      Azure.Blob.Types
+                      Azure.Blob.UserDelegationKey
+                      Azure.Blob.PutBlob
+                      Azure.Blob.SharedAccessSignature
     build-depends:    azure-auth
                     , aeson
                     , base64-bytestring

diff --git a/azure-blob-storage/src/Azure/Blob.hs b/azure-blob-storage/src/Azure/Blob.hs
@@ -0,0 +1,28 @@
+module Azure.Blob
+    (
+    -- ** Variants to fetch a blob object
+      getBlobObject
+    , getBlobObjectEither
+
+    -- ** Variants to upload a blob to Blob storage
+    , putBlobObject
+    , putBlobObjectEither
+
+    -- ** Variants for deleting a blob object
+    , deleteBlobObject
+    , deleteBlobObjectEither
+
+    -- ** Generating a Shared Access Signature URI
+    , generateSas
+
+    -- ** Types for dealing with Blob storage functions
+    , AccountName (..)
+    , ContainerName (..)
+    , BlobName (..)
+    ) where
+
+import Azure.Blob.PutBlob
+import Azure.Blob.GetBlob
+import Azure.Blob.DeleteBlob
+import Azure.Blob.SharedAccessSignature
+import Azure.Blob.Types
diff --git a/azure-blob-storage/src/Azure/DeleteBlob.hs → ...blob-storage/src/Azure/Blob/DeleteBlob.hs b/azure-blob-storage/src/Azure/DeleteBlob.hs → ...blob-storage/src/Azure/Blob/DeleteBlob.hs
@@ -5,7 +5,7 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeOperators #-}
 
-module Azure.DeleteBlob
+module Azure.Blob.DeleteBlob
     ( deleteBlobObject
     , deleteBlobObjectEither
     ) where

diff --git a/azure-blob-storage/src/Azure/GetBlob.hs → azure-blob-storage/src/Azure/Blob/GetBlob.hs b/azure-blob-storage/src/Azure/GetBlob.hs → azure-blob-storage/src/Azure/Blob/GetBlob.hs
@@ -6,7 +6,7 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeOperators #-}
 
-module Azure.GetBlob
+module Azure.Blob.GetBlob
     ( getBlobObject
     , getBlobObjectEither
     ) where
@@ -74,6 +74,9 @@ type GetBlobApi =
         :> Header' '[Required, Strict] "x-ms-version" Text
         :> Get '[Blob] ByteString
 
+-- TODO: this is more of a test at the moment.
+-- GET endpoint should accept any blob that is available and not just
+-- rely on certain mime types
 instance Accept Blob where
     contentTypes :: Proxy Blob -> NonEmpty MediaType
     contentTypes _ =

diff --git a/azure-blob-storage/src/Azure/PutBlob.hs → azure-blob-storage/src/Azure/Blob/PutBlob.hs b/azure-blob-storage/src/Azure/PutBlob.hs → azure-blob-storage/src/Azure/Blob/PutBlob.hs
@@ -3,7 +3,7 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeOperators #-}
 
-module Azure.PutBlob
+module Azure.Blob.PutBlob
     ( putBlobObjectEither
     , putBlobObject
     ) where

diff --git a/...torage/src/Azure/SharedAccessSignature.hs → ...e/src/Azure/Blob/SharedAccessSignature.hs b/...torage/src/Azure/SharedAccessSignature.hs → ...e/src/Azure/Blob/SharedAccessSignature.hs
@@ -1,7 +1,7 @@
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
 
-module Azure.SharedAccessSignature
+module Azure.Blob.SharedAccessSignature
     ( generateSas
     ) where
 
@@ -19,7 +19,7 @@ import Azure.Blob.Types
     , sasPermissionsToText
     , sasResourceToText
     )
-import Azure.UserDelegationKey (callGetUserDelegationKeyApi, getUserDelegationKeyApi)
+import Azure.Blob.UserDelegationKey (callGetUserDelegationKeyApi, getUserDelegationKeyApi)
 import Crypto.Hash.SHA256 (hmac)
 import Data.Text (Text)
 import Data.Text.Encoding (decodeUtf8, encodeUtf8)
@@ -36,6 +36,7 @@ import qualified Data.Text as Text
 blobStorageResourceUrl :: Text
 blobStorageResourceUrl = "https://storage.azure.com/"
 
+-- TODO: We need to add support for empty fields here. Eg: signedAuthorizedUserObjectId
 generateSas ::
     MonadIO m =>
     AccountName ->

diff --git a/...ob-storage/src/Azure/UserDelegationKey.hs → ...orage/src/Azure/Blob/UserDelegationKey.hs b/...ob-storage/src/Azure/UserDelegationKey.hs → ...orage/src/Azure/Blob/UserDelegationKey.hs
@@ -4,7 +4,7 @@
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeOperators #-}
 
-module Azure.UserDelegationKey
+module Azure.Blob.UserDelegationKey
     ( callGetUserDelegationKeyApi
     , getUserDelegationKeyApi
     ) where