api

Documentation

Overview

Package api provides entities for the appilcation.

Index

• type Class
• type Crawler
• type CrawlerConfig
• type Result
• type ResultInfo
• type Results
• type User

Types

type Class

type Class struct {
	ID      string     `json:"id"`
	Name    string     `json:"name"`
	Group   string     `json:"group"`
	Year    string     `json:"year"`
	Results []Result   `json:"results"`
	Total   ResultInfo `json:"total"`
	Final   string     `json:"final"`
}

Class is an entity for a class.

type Crawler

type Crawler interface {
	Refresh(userID string) error
}

The Crawler interface exposes the public crawler api.

type CrawlerConfig

type CrawlerConfig struct {
	UserID            string `json:"userId"`
	Status            bool   `json:"status"`
	Code              string `json:"code"`
	Nip               string `json:"nip"`
	NotificationEmail string `json:"notificationEmail"`
}

CrawlerConfig contains info about the crawler configuration.

type Result

type Result struct {
	Name     string     `json:"name"`
	Normal   ResultInfo `json:"normal"`
	Weighted ResultInfo `json:"weighted"`
}

Result is an entity for storing a result

type ResultInfo

type ResultInfo struct {
	Result      string `json:"result"`
	Average     string `json:"average"`
	StandardDev string `json:"standardDev"`
}

ResultInfo contains normal or weighted grades.

type Results

type Results struct {
	UserID     string    `json:"userId"`
	LastUpdate time.Time `json:"lastUpdate"`
	Classes    []Class   `json:"classes"`
}

Results contains all results for a user organized by class.

type User

type User struct {
	ID        string `json:"id"`
	Email     string `json:"email"`
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
}

User contains info about users.