eqldb

Documentation

Index

• Constants
• Variables
• type APIError
  • func (e *APIError) Error() string
• type Client
  • func NewClient() *Client
  • func (c *Client) StartConnection(ctx context.Context, deviceName string) (DeviceAuthorization, error)
  • func (c *Client) SubmitDropObservations(ctx context.Context, accessToken string, events []DropObservation) error
  • func (c *Client) SubmitKillObservations(ctx context.Context, accessToken string, events []KillObservation) error
  • func (c *Client) SubmitPlaneOfSkyEvents(ctx context.Context, accessToken, character, server string, ...) error
  • func (c *Client) UploadInventory(ctx context.Context, accessToken, inventoryPath string, ...) (UploadResult, error)
  • func (c *Client) WaitForToken(ctx context.Context, authorization DeviceAuthorization) (Token, error)
• type DeviceAuthorization
• type DropObservation
• type KillObservation
• type PlaneOfSkyEvent
• type State
  • func (s State) HasScope(scope string) bool
• type Store
  • func DefaultStore() (Store, error)
  • func (s Store) AcquireLease(name string, now time.Time, duration time.Duration) (bool, time.Duration, error)
  • func (s Store) AcquireUploadLease(now time.Time, duration time.Duration) (bool, time.Duration, error)
  • func (s Store) Load() (State, error)
  • func (s Store) ReleaseLease(name string) error
  • func (s Store) Save(state State) error
• type Token
• type UploadMetadata
• type UploadResult

Constants

const (
	ClientID       = "eql-log-parser"
	DefaultBaseURL = "https://eqldb.org"
	BaseURLEnv     = "EQDPS_EQLDB_BASE_URL"
)

Variables

var ManualRaces = []string{
	"Human",
	"Barbarian",
	"Erudite",
	"Wood Elf",
	"High Elf",
	"Dark Elf",
	"Half Elf",
	"Dwarf",
	"Troll",
	"Ogre",
	"Halfling",
	"Gnome",
	"Iksar",
	"Froglok",
	"Kerran",
}

ManualRaces mirrors the EQLDB playable-race catalogue. Automatically parsed /who races are intentionally not restricted to this list: unknown races and illusions must still reach the server for classification.

Types

type APIError

type APIError struct {
	Status      int
	Code        string
	Description string
	RetryAfter  time.Duration
}

func (*APIError) Error

func (e *APIError) Error() string

type Client

type Client struct {
	BaseURL string
	HTTP    *http.Client
}

func NewClient

func NewClient() *Client

func (*Client) StartConnection

func (c *Client) StartConnection(ctx context.Context, deviceName string) (DeviceAuthorization, error)

func (*Client) SubmitDropObservations

func (c *Client) SubmitDropObservations(ctx context.Context, accessToken string, events []DropObservation) error

func (*Client) SubmitKillObservations

func (c *Client) SubmitKillObservations(ctx context.Context, accessToken string, events []KillObservation) error

func (*Client) SubmitPlaneOfSkyEvents

func (c *Client) SubmitPlaneOfSkyEvents(ctx context.Context, accessToken, character, server string, events []PlaneOfSkyEvent) error

func (*Client) UploadInventory

func (c *Client) UploadInventory(ctx context.Context, accessToken, inventoryPath string, metadata UploadMetadata) (UploadResult, error)

func (*Client) WaitForToken

func (c *Client) WaitForToken(ctx context.Context, authorization DeviceAuthorization) (Token, error)

type DeviceAuthorization

type DeviceAuthorization struct {
	DeviceCode              string
	UserCode                string
	VerificationURI         string
	VerificationURIComplete string
	ExpiresAt               time.Time
	Interval                time.Duration
}

type DropObservation

type DropObservation struct {
	Timestamp string `json:"timestamp"`
	Zone      string `json:"zone"`
	Mob       string `json:"mob"`
	Item      string `json:"item"`
	Amount    int    `json:"amount"`
}

type KillObservation

type KillObservation struct {
	Timestamp string `json:"timestamp"`
	Zone      string `json:"zone"`
	Mob       string `json:"mob"`
}

type PlaneOfSkyEvent

type PlaneOfSkyEvent struct {
	Type      string `json:"type"`
	Rune      string `json:"rune,omitempty"`
	Amount    int    `json:"amount,omitempty"`
	Quest     string `json:"quest,omitempty"`
	Timestamp string `json:"timestamp"`
}

type State

type State struct {
	IntroductionShown bool   `json:"introduction_shown,omitempty"`
	AccessToken       string `json:"access_token,omitempty"`
	ConnectionID      string `json:"connection_id,omitempty"`
	Scope             string `json:"scope,omitempty"`
}

func (State) HasScope

func (s State) HasScope(scope string) bool

type Store

type Store struct {
	Path string
}

func DefaultStore

func DefaultStore() (Store, error)

func (Store) AcquireLease

func (s Store) AcquireLease(name string, now time.Time, duration time.Duration) (bool, time.Duration, error)

func (Store) AcquireUploadLease

func (s Store) AcquireUploadLease(now time.Time, duration time.Duration) (bool, time.Duration, error)

func (Store) Load

func (s Store) Load() (State, error)

func (Store) ReleaseLease

func (s Store) ReleaseLease(name string) error

func (Store) Save

func (s Store) Save(state State) error

type Token

type Token struct {
	AccessToken  string
	TokenType    string
	Scope        string
	ConnectionID string
}

type UploadMetadata

type UploadMetadata struct {
	Level   int
	Classes []string
	Race    string
}

type UploadResult

type UploadResult struct {
	Status     string `json:"status"`
	Character  string `json:"character"`
	Server     string `json:"server"`
	ProfileURL string `json:"profile_url"`
	Message    string `json:"message"`
}