5 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
6 changed files with 145 additions and 32 deletions

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"
@@ -56,7 +57,7 @@ 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
}
@@ -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?")
}
}
}
}

View File

@@ -76,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()}
@@ -304,7 +304,7 @@ 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
}
@@ -346,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{}
@@ -367,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")
}
@@ -378,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")
}
@@ -397,8 +410,8 @@ 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)

View File

@@ -20,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
}
}