timetracker

type Calendar interface {

	// GetHolidays returns a list of holiday for given year and month.
	GetHolidays(int, int) ([]Holiday, error)
}

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

type Date struct {

	// Year this date belongs to.
	Year int

	// Month this date belongs to.
	Month int

	// Day this date belongs to.
	Day int
}

type Day struct {

	// Date of this day.
	Date

	// Type of a time tracking event.
	Type RecordType

	// WorkingTime is the total time of work for a day.
	WorkingTime time.Duration

	// BreakTime is total time of breaks for a day.
	BreakTime time.Duration

	// Events is a list of captured time tracking events.
	Events []TimeTrackingRecord
}

type EMailPublisher struct {
	Source, Destination, Subject, Message string
}

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

type FilePublisher struct {
	FileMode os.FileMode
	Path     string
	// contains filtered or unexported fields
}

type Holiday struct {

	// Date of this day.
	Date

	// Description of a public holiday.
	Description string
}

type LocaLRepository struct {
	Records map[string]map[Date][]TimeTrackingRecord
}

type Locale struct {

	// ISO 3166-1 country code.
	Country string

	// Timezone, used to format time in reports.
	Timezone *string

	// DateFormat, used tp write dates in given format to report outputs.
	DateFormat *string

	// DefaultWorkTime is used if there's no end of work for a day, including breaks.
	DefaultWorkTime time.Duration

	// Breaks is a map of working durations and breaks which have to be applied for this time.
	Breaks map[time.Duration]time.Duration
}

type MonthlyReport struct {

	// Year this report belongs to.
	Year int

	// Month this reprt has been created for.
	Month int

	// Location a report should be generated for.
	Location Locale

	// Days is the list of days in a momth.
	Days []Day

	// TotalWorkingTine is the entire working time of a month.
	TotalWorkingTime time.Duration
}

type RecordType string

type ReportCalculator interface {

	// WithTimeTrackingRecords applies a list of reords for report calculation.
	WithTimeTrackingRecords([]TimeTrackingRecord)

	// MonthlyReport calculates a report for given year and month.
	MonthlyReport(int, int, RecordType) (*MonthlyReport, error)
}

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

type ReportFormatter interface {

	// WithHolidays will assign give list of holidays for output formatting.
	WithHolidays(holidays []Holiday)

	// WriteMonthlyReportToFile will generate a report outout an writes it to given file.
	WriteMonthlyReportToFile(*MonthlyReport, string) error

	// WriteMonthlyReportToBuffer returns a buffer for gemerated report output.
	WriteMonthlyReportToBuffer(*MonthlyReport) (*bytes.Buffer, error)

	// FileExtension returns an extenstion for a report file.
	FileExtension() string
}

type ReportPublisher interface {

	// Send publishes given report data to a target.
	Send([]byte, string) error
}

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

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

type TimeTracker interface {

	// Capture will create a time tracking record with passed type at time this method has been called.
	Capture(string, RecordType) error

	// Captured creates a time tracking record for passed point in time.
	Captured(string, RecordType, time.Time) error

	// ListRecords returns available time tracking records for given range.
	ListRecords(string, time.Time, time.Time) ([]TimeTrackingRecord, error)
}

type TimeTrackingRecord struct {

	// Key is an unique identifier of a time tracking record.
	Key string

	// DeviceId is an identifier of a device which captures a time tracking record.
	DeviceId string

	// Type of a time tracking event.
	Type RecordType

	// Timestamp is the point in time a time tracking event has occurred.
	Timestamp time.Time

	// Estimated time tracking report a used to fill missing events. e.g. workday end if it not has been captured.
	Estimated bool
}

type TimeTrackingRecordManager interface {

	// Add creates a new time tracking record with given values. Same time tacking record will be
	// returned together with a generated key.
	Add(TimeTrackingRecord) (TimeTrackingRecord, error)

	// Delete will remove time tracking record by passed key.
	Delete(string) error
}