files

README

Static File Upload Client

Usage

Setup

Local:

c := files.NewAPIClient("http://localhost:26900")

If using a healthcheck client, it can be instantiated as follows:

import "github.com/ONSdigital/dp-api-clients-go/v2/health"

hcClient := health.NewClient("api-router", "http://localhost:26900")
c := files.NewWithHealthClient(hcClient)
c.Version = "v1"

Here you will notice that the version has been set for the files client. This is important as it will prepend this to GetFile requests. I.e. /{.Version}/files/*.

Remote:

c := files.NewAPIClient("http://localhost:12700")

Set collection ID

err := c.SetCollectionID(context.Background(), "testing/test.txt", "123456789")

if err != nil {
	...
}

Publish Collection

err := c.PublishCollection(context.Background(), "123456789")

if err != nil {
    ...
}

Get File by Path

result, err := client.GetFile(context.Background(), "test/testing.csv", "AUTH TOKEN")

if err != nil {
    ...
}

if result.IsPublshable {
	...
}

Documentation

Index

• Variables
• type Client
  • func NewAPIClient(filesAPIURL, authToken string) *Client
  • func NewWithHealthClient(hcCli *healthcheck.Client) *Client
  • func (c *Client) Checker(ctx context.Context, check *health.CheckState) error
  • func (c *Client) GetFile(ctx context.Context, path string, authToken string) (FileMetaData, error)
  • func (c *Client) MarkFileDecrypted(ctx context.Context, path string, etag string) error
  • func (c *Client) MarkFilePublished(ctx context.Context, path string, etag string) error
  • func (c *Client) MarkFileUploaded(ctx context.Context, path string, etag string) error
  • func (c *Client) PatchFile(ctx context.Context, path string, patch FilePatch) error
  • func (c *Client) PublishCollection(ctx context.Context, collectionID string) error
  • func (c *Client) RegisterFile(ctx context.Context, metadata FileMetaData) error
  • func (c *Client) SetCollectionID(ctx context.Context, filepath, collectionID string) error
• type FileMetaData
• type FilePatch

Variables

var (
	ErrFileNotFound            = errors.New("file not found on dp-files-api")
	ErrFileAlreadyInCollection = errors.New("file collection ID already set")
	ErrNoFilesInCollection     = errors.New("no file in the collection")
	ErrInvalidState            = errors.New("file is in an invalid state for this action")
	ErrNotPublishable          = errors.New("file is not set as publishable")
	ErrNotAuthorized           = errors.New("you are not authorized for this action")
	ErrServer                  = errors.New("internal server error")
	ErrUnexpectedStatus        = errors.New("unexpected response status code")
	ErrBadRequest              = errors.New("bad request")
	ErrFileAlreadyRegistered   = fmt.Errorf("%w: file already registered", ErrBadRequest)
	ErrValidationError         = fmt.Errorf("%w: validation error", ErrBadRequest)
	ErrUnknown                 = fmt.Errorf("%w: unknown error", ErrBadRequest)
)

Types

type Client

type Client struct {
	Version string
	// contains filtered or unexported fields
}

Client is an files API client which can be used to make requests to the server. It extends the generic healthcheck Client structure.

func NewAPIClient

func NewAPIClient(filesAPIURL, authToken string) *Client

NewAPIClient creates a new instance of files Client with a given image API URL

func NewWithHealthClient

func NewWithHealthClient(hcCli *healthcheck.Client) *Client

NewWithHealthClient creates a new instances of files Client using healthcheck client

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, check *health.CheckState) error

Checker calls image api health endpoint and returns a check object to the caller.

func (*Client) GetFile

func (c *Client) GetFile(ctx context.Context, path string, authToken string) (FileMetaData, error)

func (*Client) MarkFileDecrypted

func (c *Client) MarkFileDecrypted(ctx context.Context, path string, etag string) error

func (*Client) MarkFilePublished

func (c *Client) MarkFilePublished(ctx context.Context, path string, etag string) error

func (*Client) MarkFileUploaded

func (c *Client) MarkFileUploaded(ctx context.Context, path string, etag string) error

func (*Client) PatchFile

func (c *Client) PatchFile(ctx context.Context, path string, patch FilePatch) error

func (*Client) PublishCollection

func (c *Client) PublishCollection(ctx context.Context, collectionID string) error

func (*Client) RegisterFile

func (c *Client) RegisterFile(ctx context.Context, metadata FileMetaData) error

func (*Client) SetCollectionID

func (c *Client) SetCollectionID(ctx context.Context, filepath, collectionID string) error

type FileMetaData

type FileMetaData struct {
	Path          string  `json:"path"`
	IsPublishable bool    `json:"is_publishable"`
	CollectionID  *string `json:"collection_id,omitempty"`
	Title         string  `json:"title"`
	SizeInBytes   uint64  `json:"size_in_bytes"`
	Type          string  `json:"type"`
	Licence       string  `json:"licence"`
	LicenceUrl    string  `json:"licence_url"`
	State         string  `json:"state,omitempty"`
	Etag          string  `json:"etag,omitempty"`
}

type FilePatch

type FilePatch struct {
	State        string `json:"state,omitempty"`
	ETag         string `json:"etag,omitempty"`
	CollectionID string `json:"collection_id,omitempty"`
}