rest

README

rest API

Allows accessing functions from the rest api.

method after path?

This library was built based on the original json library, where method was an optional argument. As such it was placed after the path, and this was kept in the golang version. While methods like http.NewRequest take the method followed by the url, remembering that the method is optional in some implementations is a good way to remember the order of the arguments here.

restupload

restupload is a nice tool to upload large files to specific APIs.

Installation:

go install github.com/KarpelesLab/rest/cli/restupload@latest

Documentation

Index

• Variables
• func Apply(ctx context.Context, path, method string, param any, target any) error
• func SpotApply(ctx context.Context, client SpotClient, path, method string, param any, ...) error
• type ContextRequest
• type Error
  • func (r *Error) Error() string
  • func (r *Error) Unwrap() error
• type HttpError
  • func (e *HttpError) Error() string
  • func (e *HttpError) Unwrap() error
• type Param
• type Response
  • func Do(ctx context.Context, path, method string, param any) (*Response, error)
  • func SpotDo(ctx context.Context, client SpotClient, path, method string, param any) (*Response, error)
  • func Upload(ctx context.Context, req, method string, param Param, f io.Reader, ...) (*Response, error)
  • func (r *Response) Apply(v any) error
  • func (r *Response) ApplyContext(ctx context.Context, v any) error
  • func (r *Response) FullRaw() (map[string]any, error)
  • func (r *Response) Get(v string) (any, error)
  • func (r *Response) GetString(v string) (string, error)
  • func (r *Response) OffsetGet(ctx context.Context, key string) (any, error)
  • func (r *Response) ParseData()
  • func (r *Response) Raw() (any, error)
  • func (r *Response) ReadValue(ctx context.Context) (any, error)
  • func (r *Response) Value() (any, error)
  • func (r *Response) ValueContext(ctx context.Context) (any, error)
• type RouterType
  • func (h *RouterType) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type SenderInterface
• type SpotClient
• type Time
  • func (u Time) MarshalContextJSON(ctx context.Context) ([]byte, error)
  • func (u Time) MarshalJSON() ([]byte, error)
  • func (u *Time) UnmarshalContextJSON(ctx context.Context, data []byte) error
  • func (u *Time) UnmarshalJSON(data []byte) error
• type Token
  • func (t *Token) Use(ctx context.Context) context.Context
• type UploadInfo
  • func PrepareUpload(req map[string]any) (*UploadInfo, error)
  • func (u *UploadInfo) Do(ctx context.Context, f io.Reader, mimeType string, ln int64) (*Response, error)
  • func (u *UploadInfo) String() string

Variables

var (
	Debug  = false
	Scheme = "https"
	Host   = "www.atonline.com"
)

var (
	ErrNoClientID     = errors.New("no client_id has been provided for token renewal")
	ErrNoRefreshToken = errors.New("no refresh token is available and access token has expired")
)

var ErrLoginRequired = errors.New("login required")

var RestHttpClient = &http.Client{
	Transport: RestHttpTransport,
	Timeout:   300 * time.Second,
}

var RestHttpTransport = &http.Transport{
	Proxy:                 http.ProxyFromEnvironment,
	MaxIdleConns:          100,
	MaxIdleConnsPerHost:   50,
	MaxConnsPerHost:       200,
	IdleConnTimeout:       90 * time.Second,
	ResponseHeaderTimeout: 90 * time.Second,
	TLSHandshakeTimeout:   10 * time.Second,
	ExpectContinueTimeout: 5 * time.Second,
}

var (
	SystemProxy = &httputil.ReverseProxy{
		Director:  systemProxyDirector,
		Transport: RestHttpClient.Transport,
	}
)

Functions

func Apply

func Apply(ctx context.Context, path, method string, param any, target any) error

func SpotApply

func SpotApply(ctx context.Context, client SpotClient, path, method string, param any, target any) error

Types

type ContextRequest

type ContextRequest int

const (
	BackendURL   ContextRequest = 1
	SkipDebugLog ContextRequest = 2
)

type Error

type Error struct {
	Response *Response
	// contains filtered or unexported fields
}

func (*Error) Error

func (r *Error) Error() string

func (*Error) Unwrap

func (r *Error) Unwrap() error

type HttpError

type HttpError struct {
	Code int
	Body []byte
	// contains filtered or unexported fields
}

func (*HttpError) Error

func (e *HttpError) Error() string

func (*HttpError) Unwrap

func (e *HttpError) Unwrap() error

type Param

type Param map[string]any

type Response

type Response struct {
	Result string           `json:"result"` // "success" or "error" (or "redirect")
	Data   pjson.RawMessage `json:"data,omitempty"`
	Error  string           `json:"error,omitempty"`
	Code   int              `json:"code,omitempty"` // for errors
	Extra  string           `json:"extra,omitempty"`
	Token  string           `json:"token,omitempty"`

	Paging any `json:"paging,omitempty"`
	Job    any `json:"job,omitempty"`
	Time   any `json:"time,omitempty"`
	Access any `json:"access,omitempty"`

	Exception    string `json:"exception,omitempty"`
	RedirectUrl  string `json:"redirect_url,omitempty"`
	RedirectCode int    `json:"redirect_code,omitempty"`
	// contains filtered or unexported fields
}

func Do

func Do(ctx context.Context, path, method string, param any) (*Response, error)

func SpotDo

func SpotDo(ctx context.Context, client SpotClient, path, method string, param any) (*Response, error)

func Upload

func Upload(ctx context.Context, req, method string, param Param, f io.Reader, mimeType string) (*Response, error)

func (*Response) Apply

func (r *Response) Apply(v any) error

func (*Response) ApplyContext

func (r *Response) ApplyContext(ctx context.Context, v any) error

func (*Response) FullRaw

func (r *Response) FullRaw() (map[string]any, error)

FullRaw fetches the whole raw object including "Response" own data

func (*Response) Get

func (r *Response) Get(v string) (any, error)

func (*Response) GetString

func (r *Response) GetString(v string) (string, error)

func (*Response) OffsetGet

func (r *Response) OffsetGet(ctx context.Context, key string) (any, error)

func (*Response) ParseData

func (r *Response) ParseData()

func (*Response) Raw

func (r *Response) Raw() (any, error)

Raw is implemented as r.Value() for compatibility

func (*Response) ReadValue

func (r *Response) ReadValue(ctx context.Context) (any, error)

func (*Response) Value

func (r *Response) Value() (any, error)

func (*Response) ValueContext

func (r *Response) ValueContext(ctx context.Context) (any, error)

type RouterType

type RouterType struct {
}

var Router *RouterType = &RouterType{}

func (*RouterType) ServeHTTP

func (h *RouterType) ServeHTTP(w http.ResponseWriter, req *http.Request)

type SenderInterface

type SenderInterface interface {
	Send(from string, to []string, msg io.WriterTo) error
}

var Sender SenderInterface = restSender{}

type SpotClient

type SpotClient interface {
	Query(ctx context.Context, target string, body []byte) ([]byte, error)
}

SpotClient is an interface fullfilled by spotlib.Client that contains everything we really care about, and helps avoid dependency loops

type Time

type Time struct {
	time.Time
}

func (Time) MarshalContextJSON

func (u Time) MarshalContextJSON(ctx context.Context) ([]byte, error)

func (Time) MarshalJSON

func (u Time) MarshalJSON() ([]byte, error)

func (*Time) UnmarshalContextJSON

func (u *Time) UnmarshalContextJSON(ctx context.Context, data []byte) error

func (*Time) UnmarshalJSON

func (u *Time) UnmarshalJSON(data []byte) error

type Token

type Token struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
	Type         string `json:"token_type"`
	ClientID     string
	Expires      int `json:"expires_in"`
}

func (*Token) Use

func (t *Token) Use(ctx context.Context) context.Context

type UploadInfo

type UploadInfo struct {
	MaxPartSize     int64 // maximum size of a single part in MB, defaults to 1024 (1GB)
	ParallelUploads int   // number of parallel uploads to perform (defaults to 3)
	// contains filtered or unexported fields
}

func PrepareUpload

func PrepareUpload(req map[string]any) (*UploadInfo, error)

upload for platform files

func (*UploadInfo) Do

func (u *UploadInfo) Do(ctx context.Context, f io.Reader, mimeType string, ln int64) (*Response, error)

func (*UploadInfo) String

func (u *UploadInfo) String() string