upload

README

Static File Upload Client

Usage

Setup

Local:

c := upload.NewAPIClient("http://localhost:25100")

Remote:

c := upload.NewAPIClient("http://localhost:11850")

Uploading a file

f := io.NopCloser(strings.NewReader("File content"))
m := upload.Metadata{
    CollectionID:  &collectionID, // Collection ID is option. Leave it unset if you do not have it at upload
    FileName:      "test.txt",
    Path:          "testing/docs",
    IsPublishable: true,
    Title:         "A testing file",
    FileSizeBytes: 12,
    FileType:      "text/plain",
    License:       "MIT",
    LicenseURL:    "https://opensource.org/licenses/MIT",
}

err := c.Upload(f, m)

if err != nil {
	...
}

Notes:

• all fields are required, except collection Id
  • but it must be set before publishing
  • see https://github.com/ONSdigital/dp-api-clients-go/tree/main/files
• File name will be part of the AWS S3 object name so should adhere to the S3 object naming guidelines
  • see https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#:~:text=and%20AWS%20SDKs.-,Object%20key%20naming%20guidelines,-You%20can%20use
• Path will be part of the AWS S3 bucket name so should adhere to the S3 bucket naming rules
  • see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
• FileType is the the mime type of the file being uploaded
  • used when file is downloaded

Documentation

Index

• Constants
• Variables
• type ChunkContext
• type Client
  • func NewAPIClient(uploadAPIURL, authToken string) *Client
  • func (c *Client) Checker(ctx context.Context, check *health.CheckState) error
  • func (c *Client) Upload(ctx context.Context, fileContent io.ReadCloser, metadata Metadata) error
• type Metadata

Constants

const (
	MaxFileSize = chunkSize * maxChunks
)

Variables

var (
	ErrFileTooLarge  = fmt.Errorf("file too large, max file size: %d MB", MaxFileSize>>20)
	ErrNotAuthorized = errors.New("you are not authorized for this action")
)

Types

type ChunkContext

type ChunkContext struct {
	Current int
	Total   int
}

type Client

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

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

func NewAPIClient

func NewAPIClient(uploadAPIURL, authToken string) *Client

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

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) Upload

func (c *Client) Upload(ctx context.Context, fileContent io.ReadCloser, metadata Metadata) error

type Metadata

type Metadata struct {
	CollectionID  *string
	FileName      string
	Path          string
	IsPublishable bool
	Title         string
	FileSizeBytes int64
	FileType      string
	License       string
	LicenseURL    string
}