config

Documentation

Index

• Constants
• type Config
  • func New() (*Config, error)
  • func (c *Config) CachePath() string
  • func (c *Config) DeviceFile() string
  • func (c *Config) Exists() bool
  • func (c *Config) FilePath() string
  • func (c *Config) HelpString() string
  • func (c *Config) Load() error
  • func (c *Config) Path() string
• type Credentials
  • func (c *Credentials) Valid() (bool, error)

Constants

const (
	APPNAME          = "spogo"
	CONFIGFILE       = "config.yaml"
	ACCESSTOKENFILE  = "access-token.json"
	REQUESTTOKENFILE = "refresh-token.json"
	DEVICEFILE       = "device.json"
)

Types

type Config

type Config struct {
	Spotify Credentials `yaml:"spotify"`
	// contains filtered or unexported fields
}

The struct that holds configuration options from "config.yaml", including spotify client information, and all information about directory locations.

func New

func New() (*Config, error)

Creates spogo config root directory, "config.yaml", and spogo cache directory.

func (*Config) CachePath

func (c *Config) CachePath() string

Returns the config file, ".cache/spogo" for unix.

func (*Config) DeviceFile

func (c *Config) DeviceFile() string

Returns the config file, ".cache/spogo/device.json" for unix.

func (*Config) Exists

func (c *Config) Exists() bool

Returns true if the config file, "config.yaml", exists.

func (*Config) FilePath

func (c *Config) FilePath() string

Returns the config file, ".config/spogo/config.yaml" for unix.

func (*Config) HelpString

func (c *Config) HelpString() string

func (*Config) Load

func (c *Config) Load() error

Loads all config options and client ID & client secret from "config.yaml".

func (*Config) Path

func (c *Config) Path() string

Returns the config path, ".config/spogo" for unix.

type Credentials

type Credentials struct {
	ClientID     string `yaml:"client_id"`
	ClientSecret string `yaml:"client_secret"`
}

func (*Credentials) Valid

func (c *Credentials) Valid() (bool, error)

Attempts to do the "client credentials" authentication flow to test validity of spotify client ID and client secret.