eveapi

README

eveapi

EVE Online API Client

go generate ./... it used to regenerate api from https://esi.evetech.net/_latest/swagger.json , https://esi.evetech.net/swagger.json

SSO package IS SUBJECT OF BREAKING CHANGES

License

   Copyright 2020 Desislav Ivanov and Contributors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Documentation

Index

• Variables
• type APIClient
  • func NewClient(logger *zap.Logger) *APIClient
  • func (o *APIClient) ESI(cache caching.Cache) *esi.EVESwaggerInterface
  • func (o *APIClient) ESISSOBrowserWithCache(pool *redis.Pool, store tokenstores.TokenStore, Character string, ...) (*sso.SSOClient, *esi.EVESwaggerInterface)
  • func (o *APIClient) ESISSOWithCache(pool *redis.Pool, store tokenstores.TokenStore, Character string, ...) (*sso.SSOClient, *esi.EVESwaggerInterface)
  • func (o *APIClient) Meta(cache caching.Cache) *esimeta.ESIMetaSpec
  • func (o *APIClient) SSO(store tokenstores.TokenStore, Character string, config Config, ...) (*sso.SSOClient, error)
  • func (o *APIClient) SSOBrowser(store tokenstores.TokenStore, Character string, config Config, ...) *sso.SSOClient
  • func (o *APIClient) SSOValidator() func(*jwt.Token) (interface{}, error)
• type Config
  • func (c Config) Load(path string, logger *zap.Logger) Config
• type OAuthMetadata

Variables

var MetadataURL = "https://login.eveonline.com/.well-known/oauth-authorization-server"

Types

type APIClient

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

func NewClient

func NewClient(logger *zap.Logger) *APIClient

func (*APIClient) ESI

func (o *APIClient) ESI(cache caching.Cache) *esi.EVESwaggerInterface

Creates Client for ESI endpoints

func (*APIClient) ESISSOBrowserWithCache

func (o *APIClient) ESISSOBrowserWithCache(pool *redis.Pool, store tokenstores.TokenStore, Character string, config Config, scopes ...string) (*sso.SSOClient, *esi.EVESwaggerInterface)

Creates ESI client with caching and SSO Client with browser open for ESI, SSO Client is validated

func (*APIClient) ESISSOWithCache

func (o *APIClient) ESISSOWithCache(pool *redis.Pool, store tokenstores.TokenStore, Character string, config Config, scopes ...string) (*sso.SSOClient, *esi.EVESwaggerInterface)

Creates ESI client with caching and SSO client for ESI , SSO Client is not validated

func (*APIClient) Meta

func (o *APIClient) Meta(cache caching.Cache) *esimeta.ESIMetaSpec

Creates Client for ESI Meta endpoints

func (*APIClient) SSO

func (o *APIClient) SSO(store tokenstores.TokenStore, Character string, config Config, scopes ...string) (*sso.SSOClient, error)

Creates SSO client for ESISSO

func (*APIClient) SSOBrowser

func (o *APIClient) SSOBrowser(store tokenstores.TokenStore, Character string, config Config, scopes ...string) *sso.SSOClient

Creates SSO client for ESISSO , opens a browser for unknown/invalid keys

func (*APIClient) SSOValidator

func (o *APIClient) SSOValidator() func(*jwt.Token) (interface{}, error)

Creates Validator for jwt tokens received from ESI

type Config

type Config struct {
	Key      string
	Secret   string
	Callback string
}

func (Config) Load

func (c Config) Load(path string, logger *zap.Logger) Config

type OAuthMetadata

type OAuthMetadata struct {
	Issuer                                     string   `json:"issuer,omitempty"`
	AuthorizationEndpoint                      string   `json:"authorization_endpoint,omitempty"`
	TokenEndpoint                              string   `json:"token_endpoint,omitempty"`
	ResponseTypesSupported                     []string `json:"response_types_supported,omitempty"`
	JwksURI                                    string   `json:"jwks_uri,omitempty"`
	RevocationEndpoint                         string   `json:"revocation_endpoint,omitempty"`
	RevocationEndpointAuthMethodsSupported     []string `json:"revocation_endpoint_auth_methods_supported,omitempty"`
	TokenEndpointAuthMethodsSupported          []string `json:"token_endpoint_auth_methods_supported,omitempty"`
	TokenEndpointAuthSigningAlgValuesSupported []string `json:"token_endpoint_auth_signing_alg_values_supported,omitempty"`
	CodeChallengeMethodsSupported              []string `json:"code_challenge_methods_supported,omitempty"`
}