brokeyourbike/veriff-api-client-go

View on GitHub
client.go

Summary

Maintainability
A
35 mins
Test Coverage
B
85%
package veriff

import (
    "bytes"
    "context"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "strings"

    "github.com/sirupsen/logrus"
)

type HttpClient interface {
    Do(req *http.Request) (*http.Response, error)
}

type Client interface {
    CreateSession(ctx context.Context, payload CreateSessionPayload) (CreateSessionResponse, error)
    SessionDecision(ctx context.Context, sessionID string) (SessionDecisionResponse, error)
    SessionMedia(ctx context.Context, sessionID string) (SessionMediaResponse, error)
    DownloadMedia(ctx context.Context, mediaID string, dst io.Writer) error
}

var _ Client = (*client)(nil)

type client struct {
    httpClient HttpClient
    logger     *logrus.Logger
    baseURL    string
    token      string
    secret     string
}

// ClientOption is a function that configures a Client.
type ClientOption func(*client)

// WithHTTPClient sets the HTTP client for the paystack API client.
func WithHTTPClient(c HttpClient) ClientOption {
    return func(target *client) {
        target.httpClient = c
    }
}

// WithLogger sets the *logrus.Logger for the paystack API client.
func WithLogger(l *logrus.Logger) ClientOption {
    return func(target *client) {
        target.logger = l
    }
}

func NewClient(baseURL, token, secret string, options ...ClientOption) *client {
    c := &client{
        baseURL: strings.TrimSuffix(baseURL, "/"),
        token:   token,
        secret:  secret,
    }

    c.httpClient = http.DefaultClient

    for _, option := range options {
        option(c)
    }

    return c
}

func (c *client) newRequest(ctx context.Context, method, url string, body interface{}, hashParam string) (*request, error) {
    req, err := http.NewRequestWithContext(ctx, method, c.baseURL+url, nil)
    if err != nil {
        return nil, fmt.Errorf("failed to create request: %w", err)
    }

    var b []byte

    if body != nil {
        b, err = json.Marshal(body)
        if err != nil {
            return nil, fmt.Errorf("failed to marshal payload: %w", err)
        }

        req.Body = io.NopCloser(bytes.NewReader(b))
        req.ContentLength = int64(len(b))
        req.Header.Set("Content-Type", "application/json")
    }

    if c.logger != nil {
        c.logger.WithContext(ctx).WithFields(logrus.Fields{
            "http.request.method":       req.Method,
            "http.request.url":          req.URL.String(),
            "http.request.body.content": string(b),
        }).Debug("veriff.client -> request")
    }

    switch method {
    case http.MethodPost, http.MethodPatch:
        req.Header.Set("X-HMAC-SIGNATURE", SignPayload(c.secret, string(b)))
    default:
        req.Header.Set("X-HMAC-SIGNATURE", SignPayload(c.secret, hashParam))
    }

    req.Header.Set("X-AUTH-CLIENT", c.token)
    return NewRequest(req), nil
}

func (c *client) do(ctx context.Context, req *request) error {
    resp, err := c.httpClient.Do(req.req)
    if err != nil {
        return fmt.Errorf("failed to send request: %w", err)
    }
    defer resp.Body.Close()

    b, err := io.ReadAll(resp.Body)
    if err != nil {
        return fmt.Errorf("failed to read response body: %w", err)
    }

    if c.logger != nil {
        c.logger.WithContext(ctx).WithFields(logrus.Fields{
            "http.response.status_code":  resp.StatusCode,
            "http.response.body.content": string(b),
            "http.response.headers":      resp.Header,
        }).Debug("veriff.client -> response")
    }

    if req.decodeTo != nil {
        if err := json.Unmarshal(b, req.decodeTo); err != nil {
            return fmt.Errorf("failed to decode response: %w", err)
        }
    }

    if req.pipeTo != nil {
        if _, err := io.Copy(req.pipeTo, bytes.NewReader(b)); err != nil {
            return fmt.Errorf("failed to pipe response: %w", err)
        }
    }

    return nil
}