Distribution.Hup

Bits and pieces for building and uploading source or documentation .tar files for Hackage, intended to make it easy to write your own Haskell programs/scripts for managing uploads.

This is the main entry-point to look at, and more low-level functions are available in the other modules.

Finding and parsing Cabal files

findCabal :: IO (Maybe FilePath)

if there's a .cabal file in the current dir, return its file name.

from NDM's neil-0.10, https://hackage.haskell.org/package/neil-0.10

readCabal :: IO String

find & read contents of Cabal file from current dir, if it exists. else returns empty string.

from NDM's neil-0.10, https://hackage.haskell.org/package/neil-0.10

extractCabal :: String -> String -> String

extractCabal fieldName cabalConts: extract contents of field named fieldName from a Cabal file string.

field name is case-insensitive [folded to lowercase]

from NDM's neil-0.10, https://hackage.haskell.org/package/neil-0.10

Parsing .tgz file names

parseTgzFilename :: (IsString s, MonadError s m) => FilePath -> m (IsDocumentation, Package)

Inspect the name of a .tar.gz file to work out the package name and version it's for, and whether it is for documentation or a package.

parseTgzFilename' :: IsString s => FilePath -> Either s (IsDocumentation, Package)

parseTgzFilename' specialized to Either.

Building tar files

buildTar :: FilePath -> FilePath -> [FilePath] -> IO ()

buildTar tarFileName baseDir paths - create a gz-compressed tar file with name tarFileName, with files in it from baseDir, "paths" being the files & directories to archive, relative to baseDir.

Uploading

getUploadUrl :: String -> Upload -> String

work out what URL to upload a .tgz file to. getUploadUrl server upload returns a URL.

>>> getUploadUrl "http://localhost:8080/" $ Upload (Package "foo" "0.1.0.0") "./hup-0.1.0.0.tar.gz" IsDocumentation CandidatePkg
"http://localhost:8080/package/foo-0.1.0.0/candidate/docs"

mkAuth :: String -> String -> Maybe Auth

pack a name and password into an Auth structure

>>> mkAuth "myname" "mypassword"

mkResponse :: WResponse ByteString -> Response

adapt wreq's Response type into a Response

postPkg :: String -> FilePath -> Maybe Auth -> IO (WResponse ByteString)

Do a POST request to upload a package.

postPkg url fileName userAuth will try to upload the file given by fileName to the URL at url, using the user authentication userAuth.

putDocs :: String -> FilePath -> Maybe Auth -> IO (WResponse ByteString)

Do a PUT request to upload package documentation.

postPkg url fileName userAuth will try to upload the file given by fileName to the URL at url, using the user authentication userAuth.

upload :: String -> Upload -> Maybe Auth -> IO (WResponse ByteString)

upload serverUrl upl userAuth - upload some package (details packed into upl to the server at serverUrl, using the credentials in userAuth.

Types

data IsCandidate

whether a package is a normal one or a candidate

Constructors

NormalPkg

CandidatePkg

Instances

Eq IsCandidate

Methods

(==) :: IsCandidate -> IsCandidate -> Bool

(/=) :: IsCandidate -> IsCandidate -> Bool

Show IsCandidate

Methods

showsPrec :: Int -> IsCandidate -> ShowS

show :: IsCandidate -> String

showList :: [IsCandidate] -> ShowS

data IsDocumentation

are we uploading a package or just docs

Constructors

IsPackage

IsDocumentation

Instances

Eq IsDocumentation

Methods

(==) :: IsDocumentation -> IsDocumentation -> Bool

(/=) :: IsDocumentation -> IsDocumentation -> Bool

Show IsDocumentation

Methods

showsPrec :: Int -> IsDocumentation -> ShowS

show :: IsDocumentation -> String

showList :: [IsDocumentation] -> ShowS

data Package

name and version of a package

Constructors

Package

Fields

• packageName :: String
• packageVersion :: String

Instances

Eq Package

Methods

(==) :: Package -> Package -> Bool

(/=) :: Package -> Package -> Bool

Show Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

data Upload

Bundle together information useful for an upload.

Constructors

Upload

Fields

• package :: Package

  package name & version

• fileToUpload :: FilePath

  file being uploaded

• uploadType :: IsDocumentation

  docco or package

• isCandidate :: IsCandidate

  candidate or not

Instances

Eq Upload

Methods

(==) :: Upload -> Upload -> Bool

(/=) :: Upload -> Upload -> Bool

Show Upload

Methods

showsPrec :: Int -> Upload -> ShowS

show :: Upload -> String

showList :: [Upload] -> ShowS

data Auth :: *

Supported authentication types.

Do not use HTTP authentication unless you are using TLS encryption. These authentication tokens can easily be captured and reused by an attacker if transmitted in the clear.

Constructors

BasicAuth ByteString ByteString

Basic authentication. This consists of a plain username and password.

OAuth2Bearer ByteString

An OAuth2 bearer token. This is treated by many services as the equivalent of a username and password.

OAuth2Token ByteString

A not-quite-standard OAuth2 bearer token (that seems to be used only by GitHub). This is treated by whoever accepts it as the equivalent of a username and password.

AWSAuth AWSAuthVersion ByteString ByteString

Amazon Web Services request signing AWSAuthVersion key secret

OAuth1 ByteString ByteString ByteString ByteString

OAuth1 request signing OAuth1 consumerToken consumerSecret token secret

Instances

Eq Auth

Methods

(==) :: Auth -> Auth -> Bool

(/=) :: Auth -> Auth -> Bool

Show Auth

Methods

showsPrec :: Int -> Auth -> ShowS

show :: Auth -> String

showList :: [Auth] -> ShowS