Safe Haskell | None |
---|---|
Language | Haskell98 |
Network.GitLFS
Description
This implementation of the git-lfs API uses http Request and Response, but leaves actually connecting up the http client to the user.
You'll want to use a Manager that supports https, since the protocol uses http basic auth.
Some LFS servers, notably Github's, may require a User-Agent header in some of the requests, in order to allow eg, uploads. No such header is added by default, so be sure to add your own.
Synopsis
- data TransferRequest = TransferRequest {}
- data TransferRequestOperation
- data TransferAdapter = Basic
- data TransferRequestObject = TransferRequestObject {}
- startTransferRequest :: Endpoint -> TransferRequest -> Request
- data TransferResponse op = TransferResponse {
- transfer :: Maybe TransferAdapter
- objects :: [TransferResponseOperation op]
- data TransferResponseOperation op = TransferResponseOperation {
- resp_oid :: SHA256
- resp_size :: Integer
- resp_authenticated :: Maybe Bool
- resp_actions :: Maybe op
- resp_error :: Maybe TransferResponseObjectError
- class (FromJSON op, ToJSON op) => IsTransferResponseOperation op
- data DownloadOperation = DownloadOperation {}
- data UploadOperation = UploadOperation {
- upload :: OperationParams
- verify :: Maybe OperationParams
- data OperationParams = OperationParams {
- href :: Url
- header :: Maybe (Map HTTPHeader HTTPHeaderValue)
- expires_in :: Maybe NumSeconds
- expires_at :: Maybe Text
- data ParsedTransferResponse op
- parseTransferResponse :: IsTransferResponseOperation op => ByteString -> ParsedTransferResponse op
- downloadOperationRequest :: DownloadOperation -> Maybe Request
- uploadOperationRequests :: UploadOperation -> RequestBody -> SHA256 -> Integer -> Maybe [Request]
- data Endpoint
- guessEndpoint :: URI -> Maybe Endpoint
- modifyEndpointRequest :: Endpoint -> (Request -> Request) -> Endpoint
- sshDiscoverEndpointCommand :: FilePath -> TransferRequestOperation -> [String]
- parseSshDiscoverEndpointResponse :: ByteString -> Maybe Endpoint
- data TransferResponseError = TransferResponseError {
- resperr_message :: Text
- resperr_request_id :: Maybe Text
- resperr_documentation_url :: Maybe Url
- data TransferResponseObjectError = TransferResponseObjectError {
- respobjerr_code :: Int
- respobjerr_message :: Text
- type Url = Text
- type SHA256 = Text
- data GitRef = GitRef {
- name :: Text
- type NumSeconds = Integer
- type HTTPHeader = Text
- type HTTPHeaderValue = Text
Transfer requests
data TransferRequest Source #
Constructors
TransferRequest | |
Fields
|
Instances
Show TransferRequest Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> TransferRequest -> ShowS show :: TransferRequest -> String showList :: [TransferRequest] -> ShowS | |
Generic TransferRequest Source # | |
Defined in Network.GitLFS Associated Types type Rep TransferRequest :: Type -> Type Methods from :: TransferRequest -> Rep TransferRequest x to :: Rep TransferRequest x -> TransferRequest | |
ToJSON TransferRequest Source # | |
Defined in Network.GitLFS Methods toJSON :: TransferRequest -> Value Source # toEncoding :: TransferRequest -> Encoding Source # toJSONList :: [TransferRequest] -> Value Source # toEncodingList :: [TransferRequest] -> Encoding Source # | |
FromJSON TransferRequest Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser TransferRequest Source # parseJSONList :: Value -> Parser [TransferRequest] Source # | |
type Rep TransferRequest Source # | |
Defined in Network.GitLFS type Rep TransferRequest = D1 ('MetaData "TransferRequest" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "TransferRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "req_operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TransferRequestOperation) :*: S1 ('MetaSel ('Just "req_transfers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TransferAdapter])) :*: (S1 ('MetaSel ('Just "req_ref") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe GitRef)) :*: S1 ('MetaSel ('Just "req_objects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TransferRequestObject])))) |
data TransferRequestOperation Source #
Constructors
RequestDownload | |
RequestUpload |
Instances
Show TransferRequestOperation Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> TransferRequestOperation -> ShowS show :: TransferRequestOperation -> String showList :: [TransferRequestOperation] -> ShowS | |
ToJSON TransferRequestOperation Source # | |
Defined in Network.GitLFS Methods toJSON :: TransferRequestOperation -> Value Source # toEncoding :: TransferRequestOperation -> Encoding Source # toJSONList :: [TransferRequestOperation] -> Value Source # toEncodingList :: [TransferRequestOperation] -> Encoding Source # | |
FromJSON TransferRequestOperation Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser TransferRequestOperation Source # parseJSONList :: Value -> Parser [TransferRequestOperation] Source # |
data TransferAdapter Source #
Constructors
Basic |
Instances
Show TransferAdapter Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> TransferAdapter -> ShowS show :: TransferAdapter -> String showList :: [TransferAdapter] -> ShowS | |
ToJSON TransferAdapter Source # | |
Defined in Network.GitLFS Methods toJSON :: TransferAdapter -> Value Source # toEncoding :: TransferAdapter -> Encoding Source # toJSONList :: [TransferAdapter] -> Value Source # toEncodingList :: [TransferAdapter] -> Encoding Source # | |
FromJSON TransferAdapter Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser TransferAdapter Source # parseJSONList :: Value -> Parser [TransferAdapter] Source # |
data TransferRequestObject Source #
Constructors
TransferRequestObject | |
Instances
startTransferRequest :: Endpoint -> TransferRequest -> Request Source #
Makes a Request that will start the process of making a transfer to or from the LFS endpoint.
Responses to transfer requests
data TransferResponse op Source #
Constructors
TransferResponse | |
Fields
|
Instances
Show op => Show (TransferResponse op) Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> TransferResponse op -> ShowS show :: TransferResponse op -> String showList :: [TransferResponse op] -> ShowS | |
Generic (TransferResponse op) Source # | |
Defined in Network.GitLFS Associated Types type Rep (TransferResponse op) :: Type -> Type Methods from :: TransferResponse op -> Rep (TransferResponse op) x to :: Rep (TransferResponse op) x -> TransferResponse op | |
IsTransferResponseOperation op => ToJSON (TransferResponse op) Source # | |
Defined in Network.GitLFS Methods toJSON :: TransferResponse op -> Value Source # toEncoding :: TransferResponse op -> Encoding Source # toJSONList :: [TransferResponse op] -> Value Source # toEncodingList :: [TransferResponse op] -> Encoding Source # | |
IsTransferResponseOperation op => FromJSON (TransferResponse op) Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser (TransferResponse op) Source # parseJSONList :: Value -> Parser [TransferResponse op] Source # | |
type Rep (TransferResponse op) Source # | |
Defined in Network.GitLFS type Rep (TransferResponse op) = D1 ('MetaData "TransferResponse" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "TransferResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "transfer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TransferAdapter)) :*: S1 ('MetaSel ('Just "objects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TransferResponseOperation op]))) |
data TransferResponseOperation op Source #
Constructors
TransferResponseOperation | |
Fields
|
Instances
Show op => Show (TransferResponseOperation op) Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> TransferResponseOperation op -> ShowS show :: TransferResponseOperation op -> String showList :: [TransferResponseOperation op] -> ShowS | |
Generic (TransferResponseOperation op) Source # | |
Defined in Network.GitLFS Associated Types type Rep (TransferResponseOperation op) :: Type -> Type Methods from :: TransferResponseOperation op -> Rep (TransferResponseOperation op) x to :: Rep (TransferResponseOperation op) x -> TransferResponseOperation op | |
ToJSON op => ToJSON (TransferResponseOperation op) Source # | |
Defined in Network.GitLFS Methods toJSON :: TransferResponseOperation op -> Value Source # toEncoding :: TransferResponseOperation op -> Encoding Source # toJSONList :: [TransferResponseOperation op] -> Value Source # toEncodingList :: [TransferResponseOperation op] -> Encoding Source # | |
FromJSON op => FromJSON (TransferResponseOperation op) Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser (TransferResponseOperation op) Source # parseJSONList :: Value -> Parser [TransferResponseOperation op] Source # | |
type Rep (TransferResponseOperation op) Source # | |
Defined in Network.GitLFS type Rep (TransferResponseOperation op) = D1 ('MetaData "TransferResponseOperation" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "TransferResponseOperation" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resp_oid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SHA256) :*: S1 ('MetaSel ('Just "resp_size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "resp_authenticated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "resp_actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe op)) :*: S1 ('MetaSel ('Just "resp_error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TransferResponseObjectError)))))) |
class (FromJSON op, ToJSON op) => IsTransferResponseOperation op Source #
Class of types that can be responses to a transfer request, that contain an operation to use to make the transfer.
Instances
data DownloadOperation Source #
Constructors
DownloadOperation | |
Fields |
Instances
data UploadOperation Source #
Constructors
UploadOperation | |
Fields
|
Instances
Show UploadOperation Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> UploadOperation -> ShowS show :: UploadOperation -> String showList :: [UploadOperation] -> ShowS | |
Generic UploadOperation Source # | |
Defined in Network.GitLFS Associated Types type Rep UploadOperation :: Type -> Type Methods from :: UploadOperation -> Rep UploadOperation x to :: Rep UploadOperation x -> UploadOperation | |
ToJSON UploadOperation Source # | |
Defined in Network.GitLFS Methods toJSON :: UploadOperation -> Value Source # toEncoding :: UploadOperation -> Encoding Source # toJSONList :: [UploadOperation] -> Value Source # toEncodingList :: [UploadOperation] -> Encoding Source # | |
FromJSON UploadOperation Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser UploadOperation Source # parseJSONList :: Value -> Parser [UploadOperation] Source # | |
IsTransferResponseOperation UploadOperation Source # | |
Defined in Network.GitLFS | |
type Rep UploadOperation Source # | |
Defined in Network.GitLFS type Rep UploadOperation = D1 ('MetaData "UploadOperation" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "UploadOperation" 'PrefixI 'True) (S1 ('MetaSel ('Just "upload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OperationParams) :*: S1 ('MetaSel ('Just "verify") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe OperationParams)))) |
data OperationParams Source #
Constructors
OperationParams | |
Fields
|
Instances
Show OperationParams Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> OperationParams -> ShowS show :: OperationParams -> String showList :: [OperationParams] -> ShowS | |
Generic OperationParams Source # | |
Defined in Network.GitLFS Associated Types type Rep OperationParams :: Type -> Type Methods from :: OperationParams -> Rep OperationParams x to :: Rep OperationParams x -> OperationParams | |
ToJSON OperationParams Source # | |
Defined in Network.GitLFS Methods toJSON :: OperationParams -> Value Source # toEncoding :: OperationParams -> Encoding Source # toJSONList :: [OperationParams] -> Value Source # toEncodingList :: [OperationParams] -> Encoding Source # | |
FromJSON OperationParams Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser OperationParams Source # parseJSONList :: Value -> Parser [OperationParams] Source # | |
type Rep OperationParams Source # | |
Defined in Network.GitLFS type Rep OperationParams = D1 ('MetaData "OperationParams" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "OperationParams" 'PrefixI 'True) ((S1 ('MetaSel ('Just "href") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Url) :*: S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map HTTPHeader HTTPHeaderValue)))) :*: (S1 ('MetaSel ('Just "expires_in") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NumSeconds)) :*: S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) |
data ParsedTransferResponse op Source #
Constructors
ParsedTransferResponse (TransferResponse op) | |
ParsedTransferResponseError TransferResponseError | |
ParseFailed String |
parseTransferResponse :: IsTransferResponseOperation op => ByteString -> ParsedTransferResponse op Source #
Parse the body of a response to a transfer request.
Making transfers
downloadOperationRequest :: DownloadOperation -> Maybe Request Source #
Builds a http request to perform a download.
uploadOperationRequests :: UploadOperation -> RequestBody -> SHA256 -> Integer -> Maybe [Request] Source #
Builds http request to perform an upload. The content to upload is provided in the RequestBody, along with its SHA256 and size.
When the LFS server requested verification, there will be a second Request that does that; it should be run only after the upload has succeeded.
When the LFS server already contains the object, an empty list may be returned.
Endpoint discovery
The endpoint of a git-lfs server.
guessEndpoint :: URI -> Maybe Endpoint Source #
Guesses the LFS endpoint from the http url of a git remote.
https://github.com/git-lfs/git-lfs/blob/master/docs/api/server-discovery.md
modifyEndpointRequest :: Endpoint -> (Request -> Request) -> Endpoint Source #
When an Endpoint is used to generate a Request, this allows adjusting that Request.
This can be used to add http basic authentication to an Endpoint:
modifyEndpointRequest (guessEndpoint u) (applyBasicAuth "user" "pass")
sshDiscoverEndpointCommand :: FilePath -> TransferRequestOperation -> [String] Source #
Command to run via ssh with to discover an endpoint. The FilePath is the location of the git repository on the ssh server.
Note that, when sshing to the server, you should take care that the hostname you pass to ssh is really a hostname and not something that ssh will parse an an option, such as -oProxyCommand=".
parseSshDiscoverEndpointResponse :: ByteString -> Maybe Endpoint Source #
Parse the json output when doing ssh endpoint discovery.
Errors
data TransferResponseError Source #
This is an error with a TransferRequest as a whole. It's also possible for a TransferRequest to overall succeed, but fail for some objects; such failures use TransferResponseObjectError.
Constructors
TransferResponseError | |
Fields
|
Instances
Show TransferResponseError Source # | |
Defined in Network.GitLFS Methods showsPrec :: Int -> TransferResponseError -> ShowS show :: TransferResponseError -> String showList :: [TransferResponseError] -> ShowS | |
Generic TransferResponseError Source # | |
Defined in Network.GitLFS Associated Types type Rep TransferResponseError :: Type -> Type Methods from :: TransferResponseError -> Rep TransferResponseError x to :: Rep TransferResponseError x -> TransferResponseError | |
ToJSON TransferResponseError Source # | |
Defined in Network.GitLFS Methods toJSON :: TransferResponseError -> Value Source # toEncoding :: TransferResponseError -> Encoding Source # toJSONList :: [TransferResponseError] -> Value Source # toEncodingList :: [TransferResponseError] -> Encoding Source # | |
FromJSON TransferResponseError Source # | |
Defined in Network.GitLFS Methods parseJSON :: Value -> Parser TransferResponseError Source # parseJSONList :: Value -> Parser [TransferResponseError] Source # | |
type Rep TransferResponseError Source # | |
Defined in Network.GitLFS type Rep TransferResponseError = D1 ('MetaData "TransferResponseError" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "TransferResponseError" 'PrefixI 'True) (S1 ('MetaSel ('Just "resperr_message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "resperr_request_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resperr_documentation_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Url))))) |
data TransferResponseObjectError Source #
An error with a single object within a TransferRequest.
Constructors
TransferResponseObjectError | |
Fields
|
Instances
Additional data types
Instances
Show GitRef Source # | |
Generic GitRef Source # | |
ToJSON GitRef Source # | |
FromJSON GitRef Source # | |
type Rep GitRef Source # | |
Defined in Network.GitLFS type Rep GitRef = D1 ('MetaData "GitRef" "Network.GitLFS" "git-lfs-1.1.0-bWRhIqm6Xf8Pxwm37GP3Z" 'False) (C1 ('MetaCons "GitRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
type NumSeconds = Integer Source #
type HTTPHeader = Text Source #
type HTTPHeaderValue = Text Source #