files_list_files.go

package pubnub

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
	"net/url"
	"strconv"

	"github.com/pubnub/go/v7/pnerr"
)

var emptyListFilesResponse *PNListFilesResponse

const listFilesPath = "/v1/files/%s/channels/%s/files"

const listFilesLimit = 100

type listFilesBuilder struct {
	opts *listFilesOpts
}

func newListFilesBuilder(pubnub *PubNub) *listFilesBuilder {
	return newListFilesBuilderWithContext(pubnub, pubnub.ctx)
}

func newListFilesOpts(pubnub *PubNub, ctx Context) *listFilesOpts {
	return &listFilesOpts{
		endpointOpts: endpointOpts{pubnub: pubnub, ctx: ctx},
		Limit:        listFilesLimit,
	}
}
func newListFilesBuilderWithContext(pubnub *PubNub,
	context Context) *listFilesBuilder {
	builder := listFilesBuilder{
		opts: newListFilesOpts(pubnub, context)}
	return &builder
}

func (b *listFilesBuilder) Limit(limit int) *listFilesBuilder {
	b.opts.Limit = limit

	return b
}

func (b *listFilesBuilder) Next(next string) *listFilesBuilder {
	b.opts.Next = next

	return b
}

func (b *listFilesBuilder) Channel(channel string) *listFilesBuilder {
	b.opts.Channel = channel

	return b
}

// QueryParam accepts a map, the keys and values of the map are passed as the query string parameters of the URL called by the API.
func (b *listFilesBuilder) QueryParam(queryParam map[string]string) *listFilesBuilder {
	b.opts.QueryParam = queryParam

	return b
}

// Transport sets the Transport for the listFiles request.
func (b *listFilesBuilder) Transport(tr http.RoundTripper) *listFilesBuilder {
	b.opts.Transport = tr
	return b
}

// Execute runs the listFiles request.
func (b *listFilesBuilder) Execute() (*PNListFilesResponse, StatusResponse, error) {
	rawJSON, status, err := executeRequest(b.opts)
	if err != nil {
		return emptyListFilesResponse, status, err
	}

	return newPNListFilesResponse(rawJSON, b.opts, status)
}

type listFilesOpts struct {
	endpointOpts

	Limit      int
	Next       string
	Channel    string
	QueryParam map[string]string

	Transport http.RoundTripper
}

func (o *listFilesOpts) validate() error {
	if o.config().SubscribeKey == "" {
		return newValidationError(o, StrMissingSubKey)
	}

	return nil
}

func (o *listFilesOpts) buildPath() (string, error) {
	return fmt.Sprintf(listFilesPath,
		o.pubnub.Config.SubscribeKey, o.Channel), nil
}

func (o *listFilesOpts) buildQuery() (*url.Values, error) {

	q := defaultQuery(o.pubnub.Config.UUID, o.pubnub.telemetryManager)

	q.Set("limit", strconv.Itoa(o.Limit))

	if o.Next != "" {
		q.Set("next", o.Next)
	}

	SetQueryParam(q, o.QueryParam)

	return q, nil
}

func (o *listFilesOpts) operationType() OperationType {
	return PNListFilesOperation
}

// PNListFilesResponse is the File Upload API Response for Get Spaces
type PNListFilesResponse struct {
	status int          `json:"status"`
	Data   []PNFileInfo `json:"data"`
	Count  int          `json:"count"`
	Next   string       `json:"next"`
}

func newPNListFilesResponse(jsonBytes []byte, o *listFilesOpts,
	status StatusResponse) (*PNListFilesResponse, StatusResponse, error) {

	resp := &PNListFilesResponse{}

	err := json.Unmarshal(jsonBytes, &resp)
	if err != nil {
		e := pnerr.NewResponseParsingError("Error unmarshalling response",
			ioutil.NopCloser(bytes.NewBufferString(string(jsonBytes))), err)

		return emptyListFilesResponse, status, e
	}

	return resp, status, nil
}