harvest

Documentation

Index

• func CheckEnvVariables() error
• func Group(verboseFlag bool, outputFlag string) error
• func HttpGet(url string, account_id string, token string) ([]byte, error)
• type CSVFormatter
  • func NewCSVFormatter(stats *Stats) *CSVFormatter
  • func (f *CSVFormatter) Output()
• type OutputFormat
• type Project
• type Report
  • func NewReport(timeEntries []TimeEntry) Report
  • func (r *Report) Run()
  • func (r *Report) Stats() *Stats
• type ReportInterface
• type Result
• type Stats
  • func NewStats(grouped_by_tags map[string]float64) *Stats
  • func (s *Stats) PercentageForTag(tag string) float64
  • func (s *Stats) TotalHours() float64
• type Task
• type TextFormatter
  • func NewTextFormatter(stats *Stats) *TextFormatter
  • func (f *TextFormatter) Output()
• type TimeEntriesPage
• type TimeEntry
• type User

Functions

func CheckEnvVariables

func CheckEnvVariables() error

func Group

func Group(verboseFlag bool, outputFlag string) error

func HttpGet

func HttpGet(url string, account_id string, token string) ([]byte, error)

Types

type CSVFormatter

type CSVFormatter struct {
	Stats *Stats
}

func NewCSVFormatter

func NewCSVFormatter(stats *Stats) *CSVFormatter

func (*CSVFormatter) Output

func (f *CSVFormatter) Output()

type OutputFormat

type OutputFormat uint32

const (
	TextOutputFormat OutputFormat = iota
	CSVOutputFormat
)

type Project

type Project struct {
	Id   int
	Name string
}

type Report

type Report struct {
	TimeEntries []TimeEntry
	// contains filtered or unexported fields
}

func NewReport

func NewReport(timeEntries []TimeEntry) Report

func (*Report) Run

func (r *Report) Run()

func (*Report) Stats

func (r *Report) Stats() *Stats

type ReportInterface

type ReportInterface interface {
	Output()
}

type Result

type Result struct {
	GroupedByTag map[string]float64
}

type Stats

type Stats struct {
	GroupedByTag map[string]float64
	// contains filtered or unexported fields
}

func NewStats

func NewStats(grouped_by_tags map[string]float64) *Stats

func (*Stats) PercentageForTag

func (s *Stats) PercentageForTag(tag string) float64

Returns percentage for total hours.

The hard part is to calculate percentage values so that the summed up percentages are not higher than 100%. See for example https://revs.runtime-revolution.com/getting-100-with-rounded-percentages-273ffa70252b Let's go with a simple solution that can calculate sum(percentages) > 100%.

func (*Stats) TotalHours

func (s *Stats) TotalHours() float64

type Task

type Task struct {
	Id   int
	Name string
}

type TextFormatter

type TextFormatter struct {
	Stats *Stats
}

func NewTextFormatter

func NewTextFormatter(stats *Stats) *TextFormatter

func (*TextFormatter) Output

func (f *TextFormatter) Output()

type TimeEntriesPage

type TimeEntriesPage struct {
	TimeEntries []TimeEntry `json:"time_entries"`
	NextPage    *int        `json:"next_page"`
}

type TimeEntry

type TimeEntry struct {
	Id        int
	Hours     float64
	Notes     string
	Project   Project
	User      User
	Task      Task
	SpentDate string `json:"spent_date"`
}

type User

type User struct {
	Id   int
	Name string
}