Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ooapi

package

Go to main page

Versions in this module

v3

v3.10.1

Aug 18, 2021

v3.10.0

May 19, 2021

v3.10.0-beta.3

May 13, 2021

v3.10.0-beta.2

May 7, 2021

v3.10.0-beta.1

Apr 29, 2021

v3.10.0-beta

Apr 28, 2021

v3.10.0-alpha

Apr 8, 2021

v3.9.2

Apr 7, 2021

v3.9.1

Apr 6, 2021

v3.9.0

Apr 1, 2021

Changes in this version

+ var ErrAPICallFailed = errors.New("ooapi: API call failed")

+ type Client struct

+ BaseURL string

+ GobCodec GobCodec

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ KVStore KVStore

+ RequestMaker RequestMaker

+ UserAgent string

+ func (c *Client) CheckIn(ctx context.Context, req *apimodel.CheckInRequest) (*apimodel.CheckInResponse, error)

+ func (c *Client) CheckReportID(ctx context.Context, req *apimodel.CheckReportIDRequest) (*apimodel.CheckReportIDResponse, error)

+ func (c *Client) MeasurementMeta(ctx context.Context, req *apimodel.MeasurementMetaRequest) (*apimodel.MeasurementMetaResponse, error)

+ func (c *Client) OpenReport(ctx context.Context, req *apimodel.OpenReportRequest) (*apimodel.OpenReportResponse, error)

+ func (c *Client) PsiphonConfig(ctx context.Context, req *apimodel.PsiphonConfigRequest) (apimodel.PsiphonConfigResponse, error)

+ func (c *Client) SubmitMeasurement(ctx context.Context, req *apimodel.SubmitMeasurementRequest) (*apimodel.SubmitMeasurementResponse, error)

+ func (c *Client) TestHelpers(ctx context.Context, req *apimodel.TestHelpersRequest) (apimodel.TestHelpersResponse, error)

+ func (c *Client) TorTargets(ctx context.Context, req *apimodel.TorTargetsRequest) (apimodel.TorTargetsResponse, error)

+ func (c *Client) URLs(ctx context.Context, req *apimodel.URLsRequest) (*apimodel.URLsResponse, error)

v3.8.0

Mar 15, 2021

v3.7.0

Mar 8, 2021

Changes in this version

+ var ErrEmptyField = errors.New("apiclient: empty field")

+ var ErrHTTPFailure = errors.New("apiclient: http request failed")

+ var ErrJSONLiteralNull = errors.New("apiclient: server returned us a literal null")

+ var ErrMissingToken = errors.New("apiclient: missing auth token")

+ var ErrUnauthorized = errors.New("apiclient: not authorized")

+ type CheckInAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *CheckInAPI) Call(ctx context.Context, req *apimodel.CheckInRequest) (*apimodel.CheckInResponse, error)

+ type CheckInCaller interface

+ Call func(ctx context.Context, req *apimodel.CheckInRequest) (*apimodel.CheckInResponse, error)

+ type CheckReportIDAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *CheckReportIDAPI) Call(ctx context.Context, req *apimodel.CheckReportIDRequest) (*apimodel.CheckReportIDResponse, error)

+ type CheckReportIDCaller interface

+ Call func(ctx context.Context, req *apimodel.CheckReportIDRequest) (*apimodel.CheckReportIDResponse, error)

+ type GobCodec interface

+ Decode func(b []byte, v interface{}) error

+ Encode func(v interface{}) ([]byte, error)

+ type HTTPClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type JSONCodec interface

+ Decode func(b []byte, v interface{}) error

+ Encode func(v interface{}) ([]byte, error)

+ type KVStore interface

+ Get func(key string) ([]byte, error)

+ Set func(key string, value []byte) error

+ type LoginAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *LoginAPI) Call(ctx context.Context, req *apimodel.LoginRequest) (*apimodel.LoginResponse, error)

+ type LoginCaller interface

+ Call func(ctx context.Context, req *apimodel.LoginRequest) (*apimodel.LoginResponse, error)

+ type MeasurementMetaAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *MeasurementMetaAPI) Call(ctx context.Context, req *apimodel.MeasurementMetaRequest) (*apimodel.MeasurementMetaResponse, error)

+ type MeasurementMetaCache struct

+ API MeasurementMetaCaller

+ GobCodec GobCodec

+ KVStore KVStore

+ func (c *MeasurementMetaCache) Call(ctx context.Context, req *apimodel.MeasurementMetaRequest) (*apimodel.MeasurementMetaResponse, error)

+ type MeasurementMetaCaller interface

+ Call func(ctx context.Context, req *apimodel.MeasurementMetaRequest) (*apimodel.MeasurementMetaResponse, error)

+ type OpenReportAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *OpenReportAPI) Call(ctx context.Context, req *apimodel.OpenReportRequest) (*apimodel.OpenReportResponse, error)

+ type OpenReportCaller interface

+ Call func(ctx context.Context, req *apimodel.OpenReportRequest) (*apimodel.OpenReportResponse, error)

+ type PsiphonConfigAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ Token string

+ UserAgent string

+ func (api *PsiphonConfigAPI) Call(ctx context.Context, req *apimodel.PsiphonConfigRequest) (apimodel.PsiphonConfigResponse, error)

+ func (api *PsiphonConfigAPI) WithToken(token string) PsiphonConfigCaller

+ type PsiphonConfigAPIWithLogin struct

+ API PsiphonConfigCloner

+ JSONCodec JSONCodec

+ KVStore KVStore

+ LoginAPI LoginCaller

+ RegisterAPI RegisterCaller

+ func (api *PsiphonConfigAPIWithLogin) Call(ctx context.Context, req *apimodel.PsiphonConfigRequest) (apimodel.PsiphonConfigResponse, error)

+ type PsiphonConfigCaller interface

+ Call func(ctx context.Context, req *apimodel.PsiphonConfigRequest) (apimodel.PsiphonConfigResponse, error)

+ type PsiphonConfigCloner interface

+ WithToken func(token string) PsiphonConfigCaller

+ type RegisterAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *RegisterAPI) Call(ctx context.Context, req *apimodel.RegisterRequest) (*apimodel.RegisterResponse, error)

+ type RegisterCaller interface

+ Call func(ctx context.Context, req *apimodel.RegisterRequest) (*apimodel.RegisterResponse, error)

+ type RequestMaker interface

+ NewRequest func(ctx context.Context, method, URL string, body io.Reader) (*http.Request, error)

+ type SubmitMeasurementAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ TemplateExecutor TemplateExecutor

+ UserAgent string

+ func (api *SubmitMeasurementAPI) Call(ctx context.Context, req *apimodel.SubmitMeasurementRequest) (*apimodel.SubmitMeasurementResponse, error)

+ type SubmitMeasurementCaller interface

+ Call func(ctx context.Context, req *apimodel.SubmitMeasurementRequest) (*apimodel.SubmitMeasurementResponse, error)

+ type TemplateExecutor interface

+ Execute func(tmpl string, v interface{}) (string, error)

+ type TestHelpersAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *TestHelpersAPI) Call(ctx context.Context, req *apimodel.TestHelpersRequest) (apimodel.TestHelpersResponse, error)

+ type TestHelpersCaller interface

+ Call func(ctx context.Context, req *apimodel.TestHelpersRequest) (apimodel.TestHelpersResponse, error)

+ type TorTargetsAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ Token string

+ UserAgent string

+ func (api *TorTargetsAPI) Call(ctx context.Context, req *apimodel.TorTargetsRequest) (apimodel.TorTargetsResponse, error)

+ func (api *TorTargetsAPI) WithToken(token string) TorTargetsCaller

+ type TorTargetsAPIWithLogin struct

+ API TorTargetsCloner

+ JSONCodec JSONCodec

+ KVStore KVStore

+ LoginAPI LoginCaller

+ RegisterAPI RegisterCaller

+ func (api *TorTargetsAPIWithLogin) Call(ctx context.Context, req *apimodel.TorTargetsRequest) (apimodel.TorTargetsResponse, error)

+ type TorTargetsCaller interface

+ Call func(ctx context.Context, req *apimodel.TorTargetsRequest) (apimodel.TorTargetsResponse, error)

+ type TorTargetsCloner interface

+ WithToken func(token string) TorTargetsCaller

+ type URLsAPI struct

+ BaseURL string

+ HTTPClient HTTPClient

+ JSONCodec JSONCodec

+ RequestMaker RequestMaker

+ UserAgent string

+ func (api *URLsAPI) Call(ctx context.Context, req *apimodel.URLsRequest) (*apimodel.URLsResponse, error)

+ type URLsCaller interface

+ Call func(ctx context.Context, req *apimodel.URLsRequest) (*apimodel.URLsResponse, error)