client

Documentation

Index

• type Client
  • func NewClient(host, endpoint, token string) *Client
  • func (cl *Client) Run(ctx context.Context, log *logger.Logger, request *Request, resp interface{}) error
• type Request
  • func NewAuthorizedRequest(query string, token string) (*Request, error)
  • func NewUnauthorizedRequest(query string) *Request
  • func (request *Request) Encode() (bytes.Buffer, error)
  • func (request *Request) Var(key string, value interface{})
• type Response
• type ResponseError
• type ResponseErrorsCollection
  • func (errs ResponseErrorsCollection) Error() string

Types

type Client

type Client struct {
	Endpoint string
	Host     string
	Token    string
	// contains filtered or unexported fields
}

A Client is an HTTP client for our GraphQL endpoint.

func NewClient

func NewClient(host, endpoint, token string) *Client

NewClient returns a reference to a Client.

func (*Client) Run

func (cl *Client) Run(ctx context.Context, log *logger.Logger, request *Request, resp interface{}) error

Run sends an HTTP request to the GraphQL server and deserializes the response or returns an error.

type Request

type Request struct {
	Query     string                 `json:"query"`
	Variables map[string]interface{} `json:"variables"`

	// Header represent any request headers that will be set
	// when the request is made.
	Header http.Header `json:"-"`
}

Request is a GraphQL request.

func NewAuthorizedRequest

func NewAuthorizedRequest(query string, token string) (*Request, error)

NewAuthorizedRequest returns a new GraphQL request with the authorization headers set for CircleCI auth.

func NewUnauthorizedRequest

func NewUnauthorizedRequest(query string) *Request

NewUnauthorizedRequest returns a new GraphQL request without any authorization header.

func (*Request) Encode

func (request *Request) Encode() (bytes.Buffer, error)

Encode will return a buffer of the JSON encoded request body

func (*Request) Var

func (request *Request) Var(key string, value interface{})

Var sets a variable.

type Response

type Response struct {
	Data   interface{}
	Errors ResponseErrorsCollection
}

Response wraps the result from our GraphQL server response including out-of-band errors and the data itself.

type ResponseError

type ResponseError struct {
	Message string
}

ResponseError represents the key-value pair of data returned by the GraphQL server to represent errors.

type ResponseErrorsCollection

type ResponseErrorsCollection []ResponseError

ResponseErrorsCollection represents a slice of errors returned by the GraphQL server out-of-band from the actual data.

func (ResponseErrorsCollection) Error

func (errs ResponseErrorsCollection) Error() string

Error turns a ResponseErrorsCollection into an acceptable error string that can be printed to the user.