gaps

package

v0.5.0 Latest Latest Go to latest Published: Apr 29, 2025 License: LGPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/heig-lherman/gaps-cli

Links

Open Source Insights

Documentation ¶

Index ¶

func GetAllClasses(cfg *TokenClientConfiguration, year uint) []string
type AbsencesAction
- func NewAbsencesAction(config *TokenClientConfiguration, year uint) *AbsencesAction
- func (a *AbsencesAction) FetchAbsences() (*parser.AbsenceReport, error)
type ClientConfiguration
- func (c *ClientConfiguration) Init(baseUrl string)
- func (c *ClientConfiguration) SetToken(token string) *TokenClientConfiguration
type GradesAction
- func NewGradesAction(config *TokenClientConfiguration, year uint) *GradesAction
- func NewSemesterGradesAction(config *TokenClientConfiguration, year uint, semester Semester) *GradesAction
- func (a *GradesAction) FetchGrades() ([]*parser.ClassGrades, error)
type LoginAction
- func NewLoginAction(config *ClientConfiguration, username string, password string) *LoginAction
- func (a *LoginAction) FetchStudentId(token string) (uint, error)
- func (a *LoginAction) FetchToken() (string, error)
type ReportCardAction
- func NewReportCardAction(config *TokenClientConfiguration) *ReportCardAction
- func (a *ReportCardAction) FetchReportCard() ([]*parser.ModuleReport, error)
type ScheduleAction
- func NewRoomScheduleAction(config *TokenClientConfiguration, year uint, semester uint, room uint) *ScheduleAction
- func NewStudentScheduleAction(config *TokenClientConfiguration, year uint, semester uint) *ScheduleAction
- func NewTeacherScheduleAction(config *TokenClientConfiguration, year uint, semester uint, teacher uint) *ScheduleAction
- func (a *ScheduleAction) FetchSchedule() (*ics.Calendar, error)
type Semester
- func (s *Semester) Set(s2 string) error
- func (s Semester) String() string
- func (s Semester) Type() string
type TokenClientConfiguration
- func (tc *TokenClientConfiguration) InitToken(baseUrl string, token string, studentId uint)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetAllClasses ¶ added in v0.3.0

func GetAllClasses(cfg *TokenClientConfiguration, year uint) []string

Types ¶

type AbsencesAction ¶ added in v0.4.0

type AbsencesAction struct {
	// contains filtered or unexported fields
}

func NewAbsencesAction ¶ added in v0.4.0

func NewAbsencesAction(config *TokenClientConfiguration, year uint) *AbsencesAction

func (*AbsencesAction) FetchAbsences ¶ added in v0.4.0

func (a *AbsencesAction) FetchAbsences() (*parser.AbsenceReport, error)

type ClientConfiguration ¶

type ClientConfiguration struct {
	// contains filtered or unexported fields
}

func (*ClientConfiguration) Init ¶

func (c *ClientConfiguration) Init(baseUrl string)

func (*ClientConfiguration) SetToken ¶

func (c *ClientConfiguration) SetToken(token string) *TokenClientConfiguration

type GradesAction ¶

type GradesAction struct {
	ClassFilter string
	// contains filtered or unexported fields
}

func NewGradesAction ¶

func NewGradesAction(config *TokenClientConfiguration, year uint) *GradesAction

func NewSemesterGradesAction ¶ added in v0.5.0

func NewSemesterGradesAction(config *TokenClientConfiguration, year uint, semester Semester) *GradesAction

func (*GradesAction) FetchGrades ¶

func (a *GradesAction) FetchGrades() ([]*parser.ClassGrades, error)

type LoginAction ¶

type LoginAction struct {
	// contains filtered or unexported fields
}

func NewLoginAction ¶

func NewLoginAction(config *ClientConfiguration, username string, password string) *LoginAction

func (*LoginAction) FetchStudentId ¶

func (a *LoginAction) FetchStudentId(token string) (uint, error)

func (*LoginAction) FetchToken ¶

func (a *LoginAction) FetchToken() (string, error)

type ReportCardAction ¶ added in v0.2.0

type ReportCardAction struct {
	// contains filtered or unexported fields
}

func NewReportCardAction ¶ added in v0.2.0

func NewReportCardAction(config *TokenClientConfiguration) *ReportCardAction

func (*ReportCardAction) FetchReportCard ¶ added in v0.2.0

func (a *ReportCardAction) FetchReportCard() ([]*parser.ModuleReport, error)

type ScheduleAction ¶ added in v0.3.0

type ScheduleAction struct {
	// contains filtered or unexported fields
}

func NewRoomScheduleAction ¶ added in v0.3.0

func NewRoomScheduleAction(config *TokenClientConfiguration, year uint, semester uint, room uint) *ScheduleAction

func NewStudentScheduleAction ¶ added in v0.3.0

func NewStudentScheduleAction(config *TokenClientConfiguration, year uint, semester uint) *ScheduleAction

func NewTeacherScheduleAction ¶ added in v0.3.0

func NewTeacherScheduleAction(config *TokenClientConfiguration, year uint, semester uint, teacher uint) *ScheduleAction

func (*ScheduleAction) FetchSchedule ¶ added in v0.3.0

func (a *ScheduleAction) FetchSchedule() (*ics.Calendar, error)

type Semester ¶ added in v0.5.0

type Semester string

const (
	All    Semester = "all"
	First  Semester = "S1"
	Second Semester = "S2"
)

func (*Semester) Set ¶ added in v0.5.0

func (s *Semester) Set(s2 string) error

func (Semester) String ¶ added in v0.5.0

func (s Semester) String() string

func (Semester) Type ¶ added in v0.5.0

func (s Semester) Type() string

type TokenClientConfiguration ¶

type TokenClientConfiguration struct {
	ClientConfiguration
	// contains filtered or unexported fields
}

func (*TokenClientConfiguration) InitToken ¶

func (tc *TokenClientConfiguration) InitToken(baseUrl string, token string, studentId uint)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL