cx

Documentation

Index

• Constants
• func NewOptions(ctx context.Context) context.Context
• type DBOptions
• type Key
• type Options

Constants

const (

	// Opts is our global server runtime (*cx.Options)
	Opts = Key("Opts")

	// Provider holds the oidc provider
	Provider = Key("Provider")

	// Verifier verifies JWTs
	Verifier = Key("Verifier")

	// DB is our pg connection (*sqlx.DB)
	DB = Key("DB")

	// Cache is our httpCache object
	Cache = Key("Cache")

	// Adapter is our http-cache adapter
	Adapter = Key("Adapter")

	// Prices is our in-memory cache of market prices
	Prices = Key("Prices")

	// Statements is our map of prepared statements (map[Key]sqlx.Stmt)
	Statements = Key("Statements")

	// StateStore is our in-memory auth state store (*api.StateStore)
	StateStore = Key("StateStore")

	// SSOClient is XXX HACK REMOVE ME
	SSOClient = Key("SSOClient")

	// Client is the goesi client
	Client = Key("Client")

	// HTTPClient is the http.Client the goesi API Client is using
	HTTPClient = Key("HTTPClient")

	// Authenticator is the global goesi SSO authenticator
	Authenticator = Key("Authenticator")

	// StmtTopReceived pulls the top character_id and receiver totals
	StmtTopReceived = Key("TestStatement")

	// StmtTopDonated pulls the top character_id and donation totals
	StmtTopDonated = Key("StmtTopDonated")

	// StmtCharDetails pulls details for a specific character
	StmtCharDetails = Key("StmtCharDetails")

	// StmtCharDonations pulls the donations to a character
	StmtCharDonations = Key("StmtCharDonations")

	// StmtCharContracts pulls the contracts to a character
	StmtCharContracts = Key("StmtCharContracts")

	// StmtCharDonated pulls the donations from a character
	StmtCharDonated = Key("StmtCharDonated")

	// StmtCharContracted pulls the contracts from a character
	StmtCharContracted = Key("StmtCharContracted")

	// StmtContractItems pulls the items for a contract
	StmtContractItems = Key("StmtContractItems")

	// StmtUserChars pulls the character ids for a userID
	StmtUserChars = Key("StmtUserChars")

	// StmtCreateUser creates a new user with a paired character
	StmtCreateUser = Key("StmtCreateUser")

	// StmtGetUser pulls a user by ID
	StmtGetUser = Key("StmtGetUser")

	// StmtGetUsers pulls users needing an update (up to 100)
	StmtGetUsers = Key("StmtGetUsers")

	// StmtGetNullUsers pulls users with null last processed timestamps
	StmtGetNullUsers = Key("StmtGetNullUsers")

	// StmtUpdateUser updates a user's character (auth updates)
	StmtUpdateUser = Key("StmtUpdateUser")

	// StmtDeleteUser deletes a user
	StmtDeleteUser = Key("StmtDeleteUser")

	// StmtAddDonation inserts a donation into the donations table
	StmtAddDonation = Key("StmtAddDonation")

	// StmtGetName returns the name for an ID
	StmtGetName = Key("StmtGetName")

	// StmtNewName creates a new mapping of ID<->name
	StmtNewName = Key("StmtNewName")

	// StmtUpdateName updates a mapping of ID<->name
	StmtUpdateName = Key("StmtUpdateName")

	// StmtCreateCharacter creates a new character
	StmtCreateCharacter = Key("StmtCreateCharacter")

	// StmtUpdateCharacter updates a known character
	StmtUpdateCharacter = Key("StmtUpdateCharacter")

	// StmtAddContract creates a new contract
	StmtAddContract = Key("StmtAddContract")

	// StmtAddContractItems creates a new contract item row
	StmtAddContractItems = Key("StmtAddContractItems")

	// StmtCharStandingISK queries donations towards standings
	StmtCharStandingISK = Key("StmtCharStandingISK")

	// StmtCreatePreferences creates a new preferences row for the user
	StmtCreatePreferences = Key("StmtCreatePreferences")

	// StmtGetPreferences gets the preferences for the user
	StmtGetPreferences = Key("StmtGetPreferences")

	// StmtSetDonationPreferences updates the donation preferences for the user
	StmtSetDonationPreferences = Key("StmtSetDonationPreferences")

	// StmtSetContractPreferences updates the contract preferences for the user
	StmtSetContractPreferences = Key("StmtSetContractPreferences")

	// StmtGetOutstandingContracts retrieves the outstanding contracts for a user
	StmtGetOutstandingContracts = Key("StmtGetOutstandingContracts")

	// StmtAcceptContract updates a contract status to accepted
	StmtAcceptContract = Key("StmtAcceptContract")

	// StmtSetCombinedPreferences updates the combined preferences
	StmtSetCombinedPreferences = Key("StmtSetCombinedPreferences")

	// StmtGetStaleContracts returns contracts older than 30 days
	StmtGetStaleContracts = Key("StmtGetStaleContracts")

	// StmtGetStaleDonations returns donations older than 30 days
	StmtGetStaleDonations = Key("StmtGetStaleDonations")

	// StmtRemoveContract removes a contract by ID
	StmtRemoveContract = Key("StmtRemoveContract")

	// StmtRemoveContractItems removes contract items by ID
	StmtRemoveContractItems = Key("StmtRemoveContractItems")

	// StmtRemoveDonation removes a donation by ID
	StmtRemoveDonation = Key("StmtRemoveDonation")
)

Functions

func NewOptions

func NewOptions(ctx context.Context) context.Context

NewOptions returns a new Options struct from cmd line flags

Types

type DBOptions

type DBOptions struct {
	Host, User, Password, Name, Mode string
}

DBOptions describes our database connection

type Key

type Key string

Key describes any context key used in ESI ISK

type Options

type Options struct {
	Production, Debug, HTTPS                bool
	Port, CacheTime, CacheResp, MaxPrefRows int
	CharacterID, MaxPrefLen, MaxPatternLen  int32
	Hostname, ESI, AppSecret                string
	DB                                      *DBOptions
	Auth                                    *oauth2.Config
}

Options describes all runtime options for the API