vk

README

go-vk

Simple golang client for vk.com api

Features

• Rate limiting
• Auto retry on rate limit
• Concurrent execution
• Context support

Usage

Make client with client := vk.NewClient("5.103", "ru") Send request and read from channel

requests := []*vk.Request{{
	Method: "users.get",
	Params: url.Values{"access_token":  {"foo"}},
}}
resultChannel := p.client.Send(ctx, requests, 1)
response := <- resultChannel

Documentation

Index

• type ApiError
• type Client
  • func NewClient(v string, lang string, retryAttempts uint, retryDelay time.Duration) *Client
  • func (c *Client) SendMany(ctx context.Context, requests []*Request, concurrency int) (<-chan string, <-chan *FailedRequest)
  • func (c *Client) SendSingle(ctx context.Context, request *Request) (string, error)
  • func (c *Client) SetRateLimiter(rateLimiter ratelimit.Limiter)
• type FailedRequest
  • func (r *FailedRequest) Error() string
• type Request
  • func (r *Request) ToRequest(accessToken string) *Request
• type Requester
• type ResponseError
  • func (r *ResponseError) HasErrorCode(value string) bool
  • func (r *ResponseError) HasResponse(value string) bool
  • func (r *ResponseError) HasRetryErrorCode() bool

Types

type ApiError

type ApiError struct {
	ErrorCode     int    `json:"error_code"`
	ErrorMsg      string `json:"error_msg"`
	RequestParams []struct {
		Key   string `json:"key"`
		Value string `json:"value"`
	} `json:"request_params"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(v string, lang string, retryAttempts uint, retryDelay time.Duration) *Client

func (*Client) SendMany

func (c *Client) SendMany(ctx context.Context, requests []*Request, concurrency int) (<-chan string, <-chan *FailedRequest)

func (*Client) SendSingle

func (c *Client) SendSingle(ctx context.Context, request *Request) (string, error)

func (*Client) SetRateLimiter

func (c *Client) SetRateLimiter(rateLimiter ratelimit.Limiter)

type FailedRequest

type FailedRequest struct {
	// contains filtered or unexported fields
}

func (*FailedRequest) Error

func (r *FailedRequest) Error() string

type Request

type Request struct {
	Method string
	Params url.Values
}

func (*Request) ToRequest

func (r *Request) ToRequest(accessToken string) *Request

type Requester

type Requester interface {
	ToRequest(accessToken string) *Request
}

type ResponseError

type ResponseError struct {
	Error *ApiError `json:"error"`
}

func (*ResponseError) HasErrorCode

func (r *ResponseError) HasErrorCode(value string) bool

func (*ResponseError) HasResponse

func (r *ResponseError) HasResponse(value string) bool

func (*ResponseError) HasRetryErrorCode

func (r *ResponseError) HasRetryErrorCode() bool