feeder

Documentation

Index

• Variables
• type ConventionReader
• type Conventions
• type CsvConventions
  • func NewCsvConventions(r ConventionReader, promotions []string) *CsvConventions
  • func (f *CsvConventions) Import() ([]schema.Convention, *ImportError)
• type HTTPConventionReader
  • func NewHTTPConventionReader(url, login, password string) *HTTPConventionReader
  • func (h *HTTPConventionReader) Reader(year int, promotion string) (io.Reader, error)
• type ImportError
  • func NewImportError() *ImportError
  • func (e *ImportError) Error() string
  • func (e *ImportError) NewWarning(err ...string)

Variables

var (
	//ErrUnsupportedEncoding signals an encoding that cannot be converted
	ErrUnsupportedEncoding = errors.New("Unsupported encoding")
	//ErrAuthorization declares a permission issue
	ErrAuthorization = errors.New("Permission denied")
	//ErrTimeout indicates a timeout
	ErrTimeout = errors.New("Timeout")
	//ErrNotFound states there is no convention file
	ErrNotFound = errors.New("No convention file")
)

var (
	//Integer is a regex to express the integer part for a possible real number.
	//We just ignore the floating part
	Integer = regexp.MustCompile(`^(\d+)`)
)

Types

type ConventionReader

type ConventionReader interface {
	Reader(year int, promotion string) (io.Reader, error)
}

ConventionReader interfaces the source where to read conventions

type Conventions

type Conventions interface {
	Import() ([]schema.Convention, *ImportError)
}

Conventions allows to import conventions

type CsvConventions

type CsvConventions struct {
	Reader ConventionReader
	Year   int
	// contains filtered or unexported fields
}

CsvConventions parses conventions from CSV files

func NewCsvConventions

func NewCsvConventions(r ConventionReader, promotions []string) *CsvConventions

NewCsvConventions creates an importer from a given reader By default, the parsed year is the current year

func (*CsvConventions) Import

func (f *CsvConventions) Import() ([]schema.Convention, *ImportError)

Import imports all the conventions by requesting in parallel the conventions for each registered promotions

type HTTPConventionReader

type HTTPConventionReader struct {
	Encoding string
	// contains filtered or unexported fields
}

HTTPConventionReader reads conventions that are made available from the Http server

func NewHTTPConventionReader

func NewHTTPConventionReader(url, login, password string) *HTTPConventionReader

NewHTTPConventionReader creates a new reader. Default encoding is "windows-1252"

func (*HTTPConventionReader) Reader

func (h *HTTPConventionReader) Reader(year int, promotion string) (io.Reader, error)

Reader read all the conventions for a given year and promotion

type ImportError

type ImportError struct {
	Warnings []string
	Fatal    error
}

ImportError to report a critical error and multiple warnings

func NewImportError

func NewImportError() *ImportError

NewImportError creates a new error

func (*ImportError) Error

func (e *ImportError) Error() string

Error reports the critical errors and the possible warnings.

func (*ImportError) NewWarning

func (e *ImportError) NewWarning(err ...string)

NewWarning signal a new warning to report