catalog

type APICatalogVersion ¶

type APICatalogVersion struct {
	SemVer   string    `json:"semver"`
	HashVer  string    `json:"hash"`
	Released time.Time `json:"released"`
}

APICatalogVersion contains the version information for an API Catalog

• SemVer: a semantic version v3.22.15 (not useful for machine consumption)
• HashVer: a hash generated from the catalog data, the semver, and the release date
• Released: the time at what this catalog was created or updated

type APIIndexedLimits ¶

type APIIndexedLimits struct {
	Version   APICatalogVersion     `json:"version"`
	Methods   []string              `json:"methods"`
	Paths     []string              `json:"paths"`
	Endpoints []EndpointIndexedDef  `json:"endpoints"`
	APILimits []APIKeyIndexedLimits `json:"apilimits"`
}

APIIndexedLimits contains all the information required to perform per endpoint and api key rate limits

func (ail *APIIndexedLimits) Validate() []error

type APIKeyIndexedLimits ¶

type APIKeyIndexedLimits struct {
	APIKey string                  `json:"key"`
	Limits []EndpointIndexedLimits `json:"limits"`
}

APIKeyIndexedLimits has the limits to be applied to a given API Key. See `EndpointsIndexedLimits` to see how to reference tha endpoints.

type APIKeys ¶

type APIKeys interface {
	GetLimits(apiKey string, method string, endpoint string) APILimits
	BlockUntil(apiKey string, until time.Time)
}

type APILimits ¶

type APILimits struct {
	RateLimitsKeyPrefix string
	BlockedUntil        time.Time
}

type CatalogURLs ¶

type CatalogURLs struct {
	GetLatestVersion  string
	GetDiff           string
	GetIndexedCatalog string
}

CatalogURLs contains all the endpoints to get information from the control server

• GetLatestVersion: an url to get the latest hash for the most recent version of the catalog. (We could get the catalog with an ETag)
• GetDiff: an url to get the difference between two versions with from and to params. If to is not provided, it is assumed to be the most recent one. The diff is always "forward" meaning that from is always before in time than to
• GetIndexedCatalog: to retrieve the full catalog (to be used if there is no existing version in the redis ? or we want a full rebuild)

type CatalogUpdater ¶

type CatalogUpdater struct {
	RequestOnDemandUpdate chan bool
	RequestShutdown       chan bool
	// contains filtered or unexported fields
}

CatalogUpdater holds the information required to keep the catalago updated from the command and control server

• urls: the command and control URL server

• catalogAPIKey: the api to use when requesting updates

• serverCheckSeconds: how often we need to poll the server for new updates

• redisCheckSeconds: we check in redis if some other proxy has already updated to a new version the data in Redis

• redisPool: a pool of connections for redis

• RequestOnDemandUpdate: a channel to be used by the client code to force an update

• RequestShutdown: a channel to notify that we want the poller to stop

func LaunchUpdatesPoller(redisPool *redis.Pool, updateBaseURL string,
	catalogApiKey string, matcher *pathmatcher.SharedPathMatcher,
	redisCheckSeconds int64, serverCheckSeconds int64) (*CatalogUpdater, error)

type DefaultAPIKeys ¶

type DefaultAPIKeys struct {
}

func NewDefaultAPIKeys() *DefaultAPIKeys

func (dak *DefaultAPIKeys) BlockUntil(apiKey string, until time.Time)

func (dak *DefaultAPIKeys) GetLimits(apiKey string, method string, path string) APILimits

func (dak *DefaultAPIKeys) SetLimit(apiKey string, method string, pathDef string)

type EndpointIndexedDef ¶

type EndpointIndexedDef struct {
	PathIdx   int `json:"p"`
	MethodIdx int `json:"m"`
}

EndpointIndexedDef contains the index to the path definition, and an index to the http verb to define an endpoint

type EndpointIndexedLimits ¶

type EndpointIndexedLimits struct {
	EndpointIdx int   `json:"ep"`
	RateLimit   int64 `json:"rl"`
}

EndpointIndexedLimits contains an index to the list of endpoints definitions and the limit to apply to this endpoint.

type RedisCatalogStatus ¶

type RedisCatalogStatus struct {
	LimitsVersion  string
	CatalogVersion string
	UpdateStarted  time.Time
	UpdateFinished time.Time
}

func RedisGetCatalogStatus(conn redis.Conn) (*RedisCatalogStatus, error)