aicra/api/response.go

package api

import (
	"encoding/json"
	"net/http"
)

// ResponseData defines format for response parameters to return
type ResponseData map[string]interface{}

// Response represents an API response to be sent
type Response struct {
	Data    ResponseData
	Status  int
	Headers http.Header
	err     Error
}

// EmptyResponse creates an empty response.
func EmptyResponse() *Response {
	return &Response{
		Status:  http.StatusOK,
		Data:    make(ResponseData),
		err:     ErrorFailure,
		Headers: make(http.Header),
	}
}

// WithError sets the error from a base error with error arguments.
func (res *Response) WithError(err Error) *Response {
	res.err = err
	return res
}

// Error implements the error interface and dispatches to internal error.
func (res *Response) Error() string {
	return res.err.Error()
}

// SetData adds/overrides a new response field
func (res *Response) SetData(name string, value interface{}) {
	res.Data[name] = value
}

// GetData gets a response field
func (res *Response) GetData(name string) interface{} {
	value, _ := res.Data[name]

	return value
}

// MarshalJSON implements the 'json.Marshaler' interface and is used
// to generate the JSON representation of the response
func (res *Response) MarshalJSON() ([]byte, error) {
	fmt := make(map[string]interface{})

	for k, v := range res.Data {
		fmt[k] = v
	}

	fmt["error"] = res.err

	return json.Marshal(fmt)
}

// ServeHTTP implements http.Handler and writes the API response.
func (res *Response) ServeHTTP(w http.ResponseWriter, r *http.Request) error {
	w.WriteHeader(res.Status)

	encoded, err := json.Marshal(res)
	if err != nil {
		return err
	}
	w.Write(encoded)

	return nil
}