sdk

dp-files-api SDK

Overview

This SDK provides a client for interacting with the dp-files-api. It is intended to be consumed by services that require endpoints from the dp-files-api. It also provides healthcheck functionality, mocks and structs for easy integration, testing and error handling.

Available client methods

Note: CreateFileEvent does not support the APIError return type yet.

Instantiation

Note: An auth token is required to instantiate the client. All SDK methods send requests with this token for authorization.

Example using New:

package main

import "github.com/ONSdigital/dp-files-api/sdk"

func main() {
    client := sdk.New("http://localhost:26900", "example-auth-token")
}

Example using NewWithHealthClient:

package main

import (
    "github.com/ONSdigital/dp-api-clients-go/v2/health"
    "github.com/ONSdigital/dp-files-api/sdk"
)

func main() {
    existingHealthClient := health.NewClient("existing-service-name", "http://localhost:8080")

    client := sdk.NewWithHealthClient(existingHealthClient, "example-auth-token")
}

Example usage of client

This example demonstrates how the GetFile() function could be used:

package main

import (
    "context"

    "github.com/ONSdigital/dp-files-api/sdk"
)

func main() {
    client := sdk.New("http://localhost:26900", "example-auth-token")

    fileMetadata, err := client.GetFile(context.Background(), "/path/to/file.csv")
    if err != nil {
        // Distinguish between API errors and other errors
        apiErr, ok := err.(*sdk.APIError)
        if ok {
            // Type is *sdk.APIError so we can access all the following fields:
            // apiErr.StatusCode
            // apiErr.Errors // This is an array that can be looped through
            // apiErr.Errors.Error[0].Code
            // apiErr.Errors.Error[0].Description
            // apiErr.Error()
        } else {
            // Handle non-API errors
        }
    }
}

Available Functionality

Checker

import "github.com/ONSdigital/dp-healthcheck/healthcheck"

check := &healthcheck.CheckState{}
err := client.Checker(ctx, check)

Health

healthClient := client.Health()

URL

url := client.URL()

DeleteFile

err := client.DeleteFile(ctx, "/path/to/delete.csv")

CreateFileEvent

import "github.com/ONSdigital/dp-files-api/files"

fileEvent := files.FileEvent{
    RequestedBy: &files.RequestedBy{
        ID:    "user",
        Email: "user@email.com",
    },
    Action:   files.ActionRead,
    Resource: "/path/to/file.csv",
    File: &files.FileMetaData{
        Path: "/path/to/file.csv",
        // Add additional fields
    },
}

createdFileEvent, err := client.CreateFileEvent(ctx, fileEvent)

GetFile

fileMetadata, err := client.GetFile(ctx, "/path/to/file.csv")

MarkFilePublished

err := client.MarkFilePublished(ctx, "/path/to/file.csv")

Additional Information

Errors

The APIError struct allows the user to distinguish if an error is a generic error or an API error, therefore allowing access to more detailed fields. This is shown in the Example usage of client section.

Mocks

To simplify testing, all functions provided by the client have been defined in the Clienter interface. This allows the user to use auto-generated mocks within unit tests.

Example of how to define a mock clienter:

import (
    "context"
    "testing"

    "github.com/ONSdigital/dp-files-api/files"
    "github.com/ONSdigital/dp-files-api/sdk/mocks"
)

func Test(t *testing.T) {
    mockClient := mocks.ClienterMock{
        GetFileFunc: func(ctx context.Context, filePath string) (*files.StoredRegisteredMetaData, error) {
            // Setup mock behaviour here
            return &files.StoredRegisteredMetaData{}, nil
        },
        // Other methods can be mocked if needed
    }
}