9 Commits

Author SHA1 Message Date
c6d8fee715 Add a unit test for Time Trackers
Some checks failed
CI / test (push) Has been cancelled
2025-06-20 16:13:22 +02:00
34a94fa269 Refactor APIClient, start to add support for time trackers 2025-06-20 16:12:48 +02:00
163e7abf47 No longer needed
All checks were successful
CI / test (push) Successful in 41s
2025-06-20 12:47:00 +02:00
d51f409497 Add basic docco
All checks were successful
CI / test (push) Successful in 36s
2025-06-20 12:17:39 +02:00
e7fa789b2b Clean up display, add focus indication
All checks were successful
CI / test (push) Successful in 1m33s
2025-06-20 12:11:17 +02:00
d7f0ac16d4 Show version info
All checks were successful
CI / test (push) Successful in 1m10s
2025-06-19 10:34:35 +02:00
f9fddf496a Show how long the fetches took
All checks were successful
CI / test (push) Successful in 58s
2025-06-19 10:04:43 +02:00
f6a92bc99e Allow empty project submission, remove redundant customer list
All checks were successful
CI / test (push) Successful in 1m44s
2025-06-19 09:56:54 +02:00
1bf7aa8a66 Using goreleaser now, no need for the workflow build
All checks were successful
CI / test (push) Successful in 2m4s
2025-06-18 14:43:47 +02:00
7 changed files with 258 additions and 199 deletions

View File

@@ -40,83 +40,3 @@ jobs:
with:
name: coverage.html
path: ./cover.html
build:
needs: test
runs-on: ubuntu-22.04
env:
RUNNER_TOOL_CACHE: /toolcache # Runner Tool Cache
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v4
with:
go-version: '1.24.4' # The Go version to download (if necessary) and use.
- uses: https://gitea.com/actions/go-hashfiles@v0.0.1
id: hash-go
with:
patterns: |
go.mod
go.sum
- name: Echo hash
run: echo ${{ steps.hash-go.outputs.hash }}
- name: Cache go
id: cache-go
uses: https://github.com/actions/cache@v3 # Action cache
with: # specify with your GOMODCACHE and GOCACHE
path: |-
/root/go/pkg/mod
/root/.cache/go-build
key: go_cache-${{ steps.hash-go.outputs.hash }}
restore-keys: |-
go_cache-${{ steps.hash-go.outputs.hash }}
# build all binaries
- name: build binaries
run: |
GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 go build -o charmite_darwin_amd64 .
GOOS=darwin GOARCH=arm64 CGO_ENABLED=0 go build -o charmite_darwin_arm64 .
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o charmite_linux_amd64 .
GOOS=windows GOARCH=amd64 CGO_ENABLED=0 go build -o charmite_windows_amd64.exe .
# upload
- name: Upload artifacts to Gitea package repository
env:
GITEA_API_URL: https://code.ppl.town/api
GITEA_TOKEN: ${{ secrets.PACKAGE_API_KEY }}
OWNER: justin
VERSION: 0.0.1
run: |
# charmite_darwin_amd64
curl -D- -s -X DELETE "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_darwin_amd64" \
-H "Authorization: token $GITEA_TOKEN"
curl -D- -s -X PUT "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_darwin_amd64" \
-H "Authorization: token $GITEA_TOKEN" \
-H "Content-Type: application/octet-stream" \
--data-binary @charmite_darwin_amd64
curl -D- -s -X DELETE "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_darwin_arm64" \
-H "Authorization: token $GITEA_TOKEN"
curl -D- -s -X PUT "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_darwin_arm64" \
-H "Authorization: token $GITEA_TOKEN" \
-H "Content-Type: application/octet-stream" \
--data-binary @charmite_darwin_arm64
curl -D- -s -X DELETE "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_linux_amd64" \
-H "Authorization: token $GITEA_TOKEN"
curl -D- -s -X PUT "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_linux_amd64" \
-H "Authorization: token $GITEA_TOKEN" \
-H "Content-Type: application/octet-stream" \
--data-binary @charmite_linux_amd64
curl -D- -s -X DELETE "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_windows_amd64.exe" \
-H "Authorization: token $GITEA_TOKEN"
curl -D- -s -X PUT "$GITEA_API_URL/packages/$OWNER/generic/charmite/$VERSION/charmite_windows_amd64.exe" \
-H "Authorization: token $GITEA_TOKEN" \
-H "Content-Type: application/octet-stream" \
--data-binary @charmite_windows_amd64.exe

View File

@@ -0,0 +1,23 @@
# charmite
Charmite is a simple TUI to add/view time entries in the [Mite](https://mite.de/en/)
time tracking tool.
## Installation
Download the appropriate binary from https://code.ppl.town/justin/charmite/releases
Or compile from the source code with:
go build .
## Using
You'll need to set the environment variables:
* MITE_API
* MITE_DOMAIN
To appropriate values.
See the [Mite FAQ](https://mite.de/en/faq.html) under "How do I allow API access for my account? Where can I get an API key?" for details on how to obtain your API key.

View File

@@ -1,10 +0,0 @@
#!/bin/sh
GOOS=linux GOARCH=amd64 go build -o cal_linux_amd64
GOOS=darwin GOARCH=arm64 go build -o cal_darwin_arm64
GOOS=windows GOARCH=amd64 go build -o cal_windows_lol_amd64
zip cal.zip cal_linux_amd64 cal_darwin_arm64 cal_windows_lol_amd64
open .

View File

@@ -3,6 +3,7 @@ package mite
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"net/http"
"time"
@@ -51,12 +52,12 @@ func (p Project) String() string {
return fmt.Sprintf("%d: %s (%s)", p.ID, p.Name, p.CustomerName)
}
func (p Project) GetID() int { return p.ID }
func (p Project) GetName() string { return p.Name }
func (p Project) GetName() string { return p.Name + " (" + p.CustomerName + ")" }
func (a APIClient) GetProjects() (Projects, error) {
// GET /projects.json
p := APIProjects{}
err := get(a.domain, a.apiKey, "/projects.json", &p)
err := a.get("/projects.json", &p)
if err != nil {
return nil, err
}
@@ -98,7 +99,7 @@ func (c Customer) GetName() string { return c.Name }
func (a APIClient) GetCustomers() (Customers, error) {
// GET /customers.json
p := apiCustomers{}
err := get(a.domain, a.apiKey, "/customers.json", &p)
err := a.get("/customers.json", &p)
if err != nil {
return nil, err
}
@@ -142,7 +143,7 @@ func (s Service) GetName() string {
func (a APIClient) GetServices() (Services, error) {
// GET /services.json
p := apiServices{}
err := get(a.domain, a.apiKey, "/services.json", &p)
err := a.get("/services.json", &p)
if err != nil {
return nil, err
}
@@ -215,7 +216,7 @@ func (a APIClient) GetTimeEntries(from, to time.Time) (TimeEntries, error) {
p := apiTimeEntry{}
u := fmt.Sprintf("/time_entries.json?from=%s&to=%s", from.Format(time.DateOnly), to.Format(time.DateOnly))
err := get(a.domain, a.apiKey, u, &p)
err := a.get(u, &p)
if err != nil {
return nil, err
}
@@ -231,8 +232,8 @@ type requestAddTimeEntry struct {
RequestTimeEntryHolder struct {
DateAt string `json:"date_at"`
Minutes int `json:"minutes"`
ProjectID int `json:"project_id,omit_empty"`
ServiceID int `json:"service_id,omit_empty"`
ProjectID int `json:"project_id,omitempty"`
ServiceID int `json:"service_id,omitempty"`
Note string `json:"note"`
} `json:"time_entry"`
}
@@ -253,23 +254,62 @@ func (a APIClient) AddTimeEntry(date string, minutes int, notes string, projectI
req.RequestTimeEntryHolder.ProjectID = projectId
req.RequestTimeEntryHolder.ServiceID = serviceId
err := post(a.domain, a.apiKey, "/time_entries.json", req)
err := a.post("/time_entries.json", req)
return err
}
func post(domain, apiKey, path string, data any) error {
type apiTimeTrackerEntry struct {
TimeTrackerHolder timeTrackerHolder `json:"tracker"`
}
type timeTrackerHolder struct {
TrackingTimeEntry *TrackingTimeEntry `json:"tracking_time_entry"`
}
type TrackingTimeEntry struct {
ID int `json:"id"`
Minutes int `json:"minutes"`
Since time.Time `json:"since"`
}
// {
// "tracker": {
// "tracking_time_entry": {
// "id": 36135321,
// "minutes": 247,
// "since": "2015-10-15T17:05:04+02:00"
// }
// }
// }
var ErrNoTracker = errors.New("no time tracker running")
// GetTimeTracker gets the current running time tracker. If no tracker is
// running, the error returned will be ErrNoTracker
func (a APIClient) GetTimeTracker() (TrackingTimeEntry, error) {
r := apiTimeTrackerEntry{}
err := a.get("/tracker.json", &r)
if err != nil {
return TrackingTimeEntry{}, err
}
if r.TimeTrackerHolder.TrackingTimeEntry == nil {
return TrackingTimeEntry{}, ErrNoTracker
}
return *r.TimeTrackerHolder.TrackingTimeEntry, nil
}
func (a APIClient) post(path string, data any) error {
b, err := json.Marshal(data)
if err != nil {
return err
}
req, err := http.NewRequest("POST", baseurl(domain, path), bytes.NewBuffer(b))
req, err := http.NewRequest("POST", baseurl(a.domain, path), bytes.NewBuffer(b))
if err != nil {
return err
}
req.Header.Add("X-MiteApiKey", apiKey)
req.Header.Add("X-MiteApiKey", a.apiKey)
req.Header.Add("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
@@ -285,12 +325,12 @@ func post(domain, apiKey, path string, data any) error {
}
func get(domain, apiKey, path string, data any) error {
req, err := http.NewRequest("GET", baseurl(domain, path), nil)
func (a APIClient) get(path string, data any) error {
req, err := http.NewRequest("GET", baseurl(a.domain, path), nil)
if err != nil {
return err
}
req.Header.Add("X-MiteApiKey", apiKey)
req.Header.Add("X-MiteApiKey", a.apiKey)
resp, err := http.DefaultClient.Do(req)
if err != nil {
@@ -305,7 +345,6 @@ func get(domain, apiKey, path string, data any) error {
return err
}
return nil
}
func baseurl(domain, path string) string {

46
mite/mite_test.go Normal file
View File

@@ -0,0 +1,46 @@
package mite
import (
"encoding/json"
"testing"
)
func TestUnmarshalTimeTracking(t *testing.T) {
trackerOn := []byte(`
{
"tracker": {
"tracking_time_entry": {
"id": 36135321,
"minutes": 247,
"since": "2015-10-15T17:05:04+02:00"
}
}
}`)
trackerOff := []byte(`{
"tracker": {}
}`)
off := apiTimeTrackerEntry{}
err := json.Unmarshal(trackerOff, &off)
if err != nil {
t.Error(err)
} else {
if off.TimeTrackerHolder.TrackingTimeEntry != nil {
t.Error("expected nil, but is not")
}
}
on := apiTimeTrackerEntry{}
err = json.Unmarshal(trackerOn, &on)
if err != nil {
t.Error(err)
} else {
if on.TimeTrackerHolder.TrackingTimeEntry == nil {
t.Error("expected note nil, but is not")
} else {
if on.TimeTrackerHolder.TrackingTimeEntry.ID != 36135321 {
t.Error("bad unmarshal?")
}
}
}
}

137
model.go
View File

@@ -4,7 +4,7 @@ import (
"charmcal/mite"
"errors"
"fmt"
"strconv"
"slices"
"strings"
"time"
@@ -32,6 +32,8 @@ const MODE_CAL tuiMode = "MODE_CAL"
const MODE_TIMEENTRIES tuiMode = "MODE_TIMEENTRIES"
const MODE_FORMENTRY tuiMode = "MODE_FORMENTRY"
var version = "dev"
type model struct {
miteAPI mite.APIClient
start calendarTime
@@ -54,6 +56,7 @@ type model struct {
}
statusBarMessage string
windowWidth int
windowHeight int
}
func initialModel(miteDomain, miteApiKey string) model {
@@ -73,10 +76,10 @@ func initialModel(miteDomain, miteApiKey string) model {
tab.SetStyles(s)
tab.SetColumns([]table.Column{
table.Column{Title: "min", Width: 5},
table.Column{Title: "lck", Width: 4},
table.Column{Title: "customer", Width: 10},
table.Column{Title: "description", Width: 40},
{Title: " min", Width: 4},
{Title: "🔐", Width: 2},
{Title: "customer", Width: 10},
{Title: "description", Width: 40},
})
m.start = calendarTime{time.Now()}
@@ -92,86 +95,6 @@ func initialModel(miteDomain, miteApiKey string) model {
return m
}
func (m model) buildForm() *huh.Form {
clOptions := []huh.Option[string]{}
for _, cust := range m.formData.customers {
op := miteToHuhOption(cust)
clOptions = append(clOptions, op)
}
svcOptions := []huh.Option[string]{}
for _, svc := range m.formData.services {
op := miteToHuhOption(svc)
svcOptions = append(svcOptions, op)
}
cl := huh.NewSelect[string]().
Key("client").
Options(clOptions...).
Title("Client").Height(5).Value(&m.formData.selected.customer)
sl := huh.NewSelect[string]().
Key("service").
Options(svcOptions...).
Title("Service").Height(5)
pl := huh.NewSelect[string]().
Key("project").
Title("Project").Height(3).
OptionsFunc(func() []huh.Option[string] {
out := []huh.Option[string]{}
for _, proj := range m.formData.projects {
if fmt.Sprint(proj.CustomerID) == m.formData.selected.customer {
out = append(out, miteToHuhOption(proj))
}
}
return out
}, &m.formData.selected.customer)
form := huh.NewForm(
huh.NewGroup(
cl,
sl,
pl,
),
huh.NewGroup(
huh.NewText().
Key("description").
Title("description").
Validate(func(s string) error {
if s == "" {
return errors.New("must enter a description")
}
return nil
}),
huh.NewInput().
Key("minutes").
CharLimit(5).
Validate(
func(s string) error {
h, err := strconv.ParseInt(s, 10, 64)
if err != nil {
return err
}
if h < 0 {
return errors.New("must be positive")
}
return err
}).
Title("Minutes"),
),
)
return form
}
func miteToHuhOption[T mite.APIObject](i T) huh.Option[string] {
return huh.Option[string]{
Key: i.GetName(),
Value: fmt.Sprint(i.GetID()),
}
}
func (m model) Init() tea.Cmd {
return m.fetchMiteData()
}
@@ -188,13 +111,17 @@ func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
m.fetchedData = false
} else {
m.statusBarMessage = fmt.Sprintf("Fetched %d time entries", len(msg.TimeEntries))
m.statusBarMessage = fmt.Sprintf("Fetched %d time entries in %s", len(msg.TimeEntries), time.Since(msg.start).Truncate(time.Millisecond))
m.timeData.entries = msg.TimeEntries
m.formData.customers = msg.Customers
m.formData.services = msg.Services
m.formData.projects = msg.Projects
m.fetchedData = true
slices.SortFunc(m.formData.customers, func(a, b mite.Customer) int { return strings.Compare(a.GetName(), b.GetName()) })
slices.SortFunc(m.formData.services, func(a, b mite.Service) int { return strings.Compare(a.GetName(), b.GetName()) })
slices.SortFunc(m.formData.projects, func(a, b mite.Project) int { return strings.Compare(a.GetName(), b.GetName()) })
// just in case there is data for the currently focused day
m.timeData.table.SetRows(m.tableDataForDate(m.dest.Time))
}
@@ -275,6 +202,7 @@ func (m model) updateCal(msg tea.Msg) (tea.Model, tea.Cmd) {
switch msg := msg.(type) {
case tea.WindowSizeMsg:
m.windowWidth = msg.Width
m.windowHeight = msg.Height
// Is it a key press?
case tea.KeyMsg:
@@ -376,12 +304,13 @@ func (m model) tableDataForDate(t time.Time) []table.Row {
if entry.Locked {
lock = "🔐"
}
rows = append(rows, table.Row{fmt.Sprint(entry.Minutes), lock, entry.CustomerName, entry.Note})
rows = append(rows, table.Row{fmt.Sprintf("%4d", entry.Minutes), lock, entry.CustomerName, entry.Note})
}
return rows
}
type miteDataFetchedMsg struct {
start time.Time
TimeEntries mite.TimeEntries
Customers mite.Customers
Services mite.Services
@@ -391,6 +320,7 @@ type miteDataFetchedMsg struct {
func (m model) fetchMiteData() tea.Cmd {
return func() tea.Msg {
t0 := time.Now()
from := time.Now().Add(-time.Hour * 24 * 30 * 6) // about 6 months
to := time.Now().Add(time.Hour * 20 * 30) // about 1 month
te, err1 := m.miteAPI.GetTimeEntries(from, to)
@@ -404,6 +334,7 @@ func (m model) fetchMiteData() tea.Cmd {
Services: svc,
Projects: pjt,
Error: errors.Join(err1, err2, err3, err4),
start: t0,
}
}
}
@@ -415,6 +346,12 @@ func (m model) View() string {
lhs := strings.Builder{}
rhs := strings.Builder{}
nb := lipgloss.NewStyle().Border(lipgloss.NormalBorder())
db := lipgloss.NewStyle().Border(lipgloss.DoubleBorder())
lhsS := nb
rhsS := nb
// if any entries are not "locked", we always use that
// regular colour in preference
styles := map[string]lipgloss.Style{}
@@ -436,6 +373,7 @@ func (m model) View() string {
if m.tuiMode == MODE_CAL {
lhs.WriteString("(f)etch time data\n")
lhsS = db
} else {
lhs.WriteString("\n")
}
@@ -447,18 +385,24 @@ func (m model) View() string {
if m.tuiMode == MODE_FORMENTRY {
lhs.WriteString("(esc) abort form\n")
lhs.WriteString("\n")
rhsS = db
} else {
lhs.WriteString("(tab) switch panes\n")
lhs.WriteString("(q)uit\n")
}
if m.tuiMode == MODE_TIMEENTRIES {
rhsS = db
}
calendarWidth := 25
tableWidth := m.windowWidth - calendarWidth
lhsWidth := 25
rhsWidth := m.windowWidth - lhsWidth - 4
if m.tuiMode == MODE_FORMENTRY {
rhs.WriteString(m.formData.form.View())
} else {
if m.fetchedData {
m.timeData.table.Columns()[3].Width = rhsWidth - 30
m.timeData.table.SetHeight(14)
rhs.WriteString(m.timeData.table.View())
rhs.WriteString("\n")
}
@@ -466,14 +410,23 @@ func (m model) View() string {
out := lipgloss.JoinHorizontal(
lipgloss.Top,
lipgloss.NewStyle().Width(calendarWidth).Render(lhs.String()),
lipgloss.NewStyle().Width(tableWidth).Render(rhs.String()),
lhsS.Render(lipgloss.NewStyle().Width(lhsWidth).Render(lhs.String())),
rhsS.Render(lipgloss.NewStyle().Width(rhsWidth).Render(rhs.String())),
)
sofar := lipgloss.Height(out)
statusMsg := strings.ReplaceAll(m.statusBarMessage, "\n", " ")
out += styleStatusBar.MarginTop(19 - sofar).Width(m.windowWidth).Render(statusMsg)
mainMsg := styleStatusBar.Width(m.windowWidth - len(version)).MarginTop(m.windowHeight - sofar).Render(statusMsg)
versionMsg := styleStatusBar.MarginTop(m.windowHeight - sofar).Render(version)
bar := lipgloss.JoinHorizontal(lipgloss.Top,
mainMsg,
versionMsg,
)
out += bar
return out
}

View File

@@ -1,7 +1,9 @@
package main
import (
"charmcal/mite"
"errors"
"fmt"
"strconv"
"time"
@@ -18,6 +20,8 @@ func (m model) updateForm(msg tea.Msg) (tea.Model, tea.Cmd) {
case "esc":
m.tuiMode = MODE_CAL
return m, nil
case "ctrl+c":
return m, tea.Quit
}
}
@@ -43,7 +47,7 @@ func (m model) updateForm(msg tea.Msg) (tea.Model, tea.Cmd) {
err := m.miteAPI.AddTimeEntry(m.dest.Format(time.DateOnly), int(minutesInt), description, int(projectIDInt), int(serviceIDInt))
if err != nil {
m.statusBarMessage = errors.Join(err1, err2, err3).Error()
m.statusBarMessage = err.Error()
m.tuiMode = MODE_CAL
} else {
m.statusBarMessage = "Successfully logged time"
@@ -56,3 +60,87 @@ func (m model) updateForm(msg tea.Msg) (tea.Model, tea.Cmd) {
return m, formCmd
}
func (m model) buildForm() *huh.Form {
clOptions := []huh.Option[string]{}
for _, cust := range m.formData.customers {
op := miteToHuhOption(cust)
clOptions = append(clOptions, op)
}
svcOptions := []huh.Option[string]{}
for _, svc := range m.formData.services {
op := miteToHuhOption(svc)
svcOptions = append(svcOptions, op)
}
projOptions := []huh.Option[string]{
{
Key: "[no project]",
Value: "0",
},
}
for _, proj := range m.formData.projects {
op := miteToHuhOption(proj)
projOptions = append(projOptions, op)
}
// cl := huh.NewSelect[string]().
// Key("client").
// Options(clOptions...).
// Title("Client").Height(5).Value(&m.formData.selected.customer)
sl := huh.NewSelect[string]().
Key("service").
Options(svcOptions...).
Title("Service").
Height(6)
pl := huh.NewSelect[string]().
Key("project").
Title("Project").
Options(projOptions...).
Height(10)
form := huh.NewForm(
huh.NewGroup(
pl,
sl,
),
huh.NewGroup(
huh.NewText().
Key("description").
Title("description").
Validate(func(s string) error {
if s == "" {
return errors.New("must enter a description")
}
return nil
}),
huh.NewInput().
Key("minutes").
CharLimit(5).
Validate(
func(s string) error {
h, err := strconv.ParseInt(s, 10, 64)
if err != nil {
return err
}
if h < 0 {
return errors.New("must be positive")
}
return err
}).
Title("Minutes"),
),
)
return form
}
func miteToHuhOption[T mite.APIObject](i T) huh.Option[string] {
return huh.Option[string]{
Key: i.GetName(),
Value: fmt.Sprint(i.GetID()),
}
}