config

Documentation

Index

• Variables
• type Config
  • func GetConfigProvider() (Config, error)
  • func NewFileConfig() (Config, error)
  • func NewPostgresConfig() (Config, error)
• type Feed
  • func (f *Feed) Validate() error
• type User

Variables

var (
	// ErrConfigFileNotGiven Error
	ErrConfigFileNotGiven = errors.New("Config file path not provided")

	// ErrFeedNotFound Error
	ErrFeedNotFound = errors.New("Feed not found")

	// ErrUnknownConfigBackend Error
	ErrUnknownConfigBackend = errors.New("unknown config backend")
)

Types

type Config

type Config interface {
	// Authentication management
	SaveUser(user User) error
	GetUser() (User, error)
	// Feed management
	GetFeeds() ([]Feed, error)
	AddFeed(feed Feed) error
	RemoveFeed(url string) error
	// Scrape management
	AddScrapedURL(url string) error
	IsScrapedURL(url string) (bool, error)
	// Close config provider after use
	Close() error
}

Config defines the required methods for a config backend

func GetConfigProvider

func GetConfigProvider() (Config, error)

GetConfigProvider returns the current config provider used for this session. Depends in the cli flags used when calling the program.

func NewFileConfig

func NewFileConfig() (Config, error)

NewFileConfig returns a new config backend based on a file (yaml)

func NewPostgresConfig

func NewPostgresConfig() (Config, error)

NewPostgresConfig creates a new config backend where postgres is used for storage

type Feed

type Feed struct {
	URL  string   `json:"url"`
	Name string   `json:"name"`
	Tags []string `json:"tags"`
}

Feed defines the feed structure stored on disk

func (*Feed) Validate

func (f *Feed) Validate() error

Validate validates the feed content

type User

type User struct {
	ConsumerKey string `json:"consumerKey"`
	Token       string `json:"token"`
}

User stores the user credential used when contacting pocket