refactor: split utility functions into utils and helpers

routes/api/diagnostics.go

@@ -2,14 +2,13 @@ package api
 
 import (
 	"encoding/json"
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 
 	"github.com/gorilla/mux"
 	conf "github.com/muety/wakapi/config"
-	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
-
 	"github.com/muety/wakapi/models"
+	"github.com/muety/wakapi/services"
 )
 
 type DiagnosticsApiHandler struct {
@@ -55,5 +54,5 @@ func (h *DiagnosticsApiHandler) Post(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	utils.RespondJSON(w, r, http.StatusCreated, struct{}{})
+	helpers.RespondJSON(w, r, http.StatusCreated, struct{}{})
 }

routes/api/heartbeat.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 
 	"github.com/gorilla/mux"
@@ -120,7 +121,7 @@ func (h *HeartbeatApiHandler) Post(w http.ResponseWriter, r *http.Request) {
 
 	defer func() {}()
 
-	utils.RespondJSON(w, r, http.StatusCreated, constructSuccessResponse(len(heartbeats)))
+	helpers.RespondJSON(w, r, http.StatusCreated, constructSuccessResponse(len(heartbeats)))
 }
 
 // construct weird response format (see https://github.com/wakatime/wakatime/blob/2e636d389bf5da4e998e05d5285a96ce2c181e3d/wakatime/api.py#L288)

routes/api/metrics.go

@@ -5,13 +5,13 @@ import (
 	"github.com/emvi/logbuch"
 	"github.com/gorilla/mux"
 	conf "github.com/muety/wakapi/config"
+	"github.com/muety/wakapi/helpers"
 	"github.com/muety/wakapi/middlewares"
 	"github.com/muety/wakapi/models"
 	v1 "github.com/muety/wakapi/models/compat/wakatime/v1"
 	mm "github.com/muety/wakapi/models/metrics"
 	"github.com/muety/wakapi/repositories"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 	"net/http"
 	"runtime"
 	"sort"
@@ -129,7 +129,7 @@ func (h *MetricsHandler) getUserMetrics(user *models.User) (*mm.Metrics, error)
 		return nil, err
 	}
 
-	from, to := utils.MustResolveIntervalRawTZ("today", user.TZ())
+	from, to := helpers.MustResolveIntervalRawTZ("today", user.TZ())
 
 	summaryToday, err := h.summarySrvc.Aliased(from, to, user, h.summarySrvc.Retrieve, nil, false)
 	if err != nil {

routes/api/summary.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"github.com/muety/wakapi/helpers"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"net/http"
 
@@ -8,7 +9,6 @@ import (
 	conf "github.com/muety/wakapi/config"
 	"github.com/muety/wakapi/middlewares"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 )
 
 type SummaryApiHandler struct {
@@ -58,5 +58,5 @@ func (h *SummaryApiHandler) Get(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	utils.RespondJSON(w, r, http.StatusOK, summary)
+	helpers.RespondJSON(w, r, http.StatusOK, summary)
 }

routes/compat/shields/v1/badge.go

@@ -2,6 +2,7 @@ package v1
 
 import (
 	"fmt"
+	"github.com/muety/wakapi/helpers"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"net/http"
 	"time"
@@ -11,7 +12,6 @@ import (
 	"github.com/muety/wakapi/models"
 	v1 "github.com/muety/wakapi/models/compat/shields/v1"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 	"github.com/patrickmn/go-cache"
 )
 
@@ -63,7 +63,7 @@ func (h *BadgeHandler) Get(w http.ResponseWriter, r *http.Request) {
 
 	cacheKey := fmt.Sprintf("%s_%v_%s", user.ID, *interval.Key, filters.Hash())
 	if cacheResult, ok := h.cache.Get(cacheKey); ok {
-		utils.RespondJSON(w, r, http.StatusOK, cacheResult.(*v1.BadgeData))
+		helpers.RespondJSON(w, r, http.StatusOK, cacheResult.(*v1.BadgeData))
 		return
 	}
 
@@ -83,11 +83,11 @@ func (h *BadgeHandler) Get(w http.ResponseWriter, r *http.Request) {
 
 	vm := v1.NewBadgeDataFrom(summary)
 	h.cache.SetDefault(cacheKey, vm)
-	utils.RespondJSON(w, r, http.StatusOK, vm)
+	helpers.RespondJSON(w, r, http.StatusOK, vm)
 }
 
 func (h *BadgeHandler) loadUserSummary(user *models.User, interval *models.IntervalKey, filters *models.Filters) (*models.Summary, error, int) {
-	err, from, to := utils.ResolveIntervalTZ(interval, user.TZ())
+	err, from, to := helpers.ResolveIntervalTZ(interval, user.TZ())
 	if err != nil {
 		return nil, err, http.StatusBadRequest
 	}

routes/compat/wakatime/v1/all_time.go

@@ -3,12 +3,12 @@ package v1
 import (
 	"github.com/gorilla/mux"
 	conf "github.com/muety/wakapi/config"
+	"github.com/muety/wakapi/helpers"
 	"github.com/muety/wakapi/middlewares"
 	"github.com/muety/wakapi/models"
 	v1 "github.com/muety/wakapi/models/compat/wakatime/v1"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 	"net/http"
 	"time"
 )
@@ -50,7 +50,7 @@ func (h *AllTimeHandler) Get(w http.ResponseWriter, r *http.Request) {
 		return // response was already sent by util function
 	}
 
-	summary, err, status := h.loadUserSummary(user, utils.ParseSummaryFilters(r))
+	summary, err, status := h.loadUserSummary(user, helpers.ParseSummaryFilters(r))
 	if err != nil {
 		w.WriteHeader(status)
 		w.Write([]byte(err.Error()))
@@ -58,7 +58,7 @@ func (h *AllTimeHandler) Get(w http.ResponseWriter, r *http.Request) {
 	}
 
 	vm := v1.NewAllTimeFrom(summary)
-	utils.RespondJSON(w, r, http.StatusOK, vm)
+	helpers.RespondJSON(w, r, http.StatusOK, vm)
 }
 
 func (h *AllTimeHandler) loadUserSummary(user *models.User, filters *models.Filters) (*models.Summary, error, int) {

routes/compat/wakatime/v1/heartbeat.go

@@ -2,6 +2,7 @@ package v1
 
 import (
 	"github.com/duke-git/lancet/v2/datetime"
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 	"time"
 
@@ -11,7 +12,6 @@ import (
 	wakatime "github.com/muety/wakapi/models/compat/wakatime/v1"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 )
 
 type HeartbeatsResult struct {
@@ -82,5 +82,5 @@ func (h *HeartbeatHandler) Get(w http.ResponseWriter, r *http.Request) {
 		End:      rangeTo.UTC().Format(time.RFC3339),
 		Timezone: timezone.String(),
 	}
-	utils.RespondJSON(w, r, http.StatusOK, res)
+	helpers.RespondJSON(w, r, http.StatusOK, res)
 }

routes/compat/wakatime/v1/projects.go

@@ -1,6 +1,7 @@
 package v1
 
 import (
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 	"strings"
 
@@ -11,7 +12,6 @@ import (
 	v1 "github.com/muety/wakapi/models/compat/wakatime/v1"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 )
 
 type ProjectsHandler struct {
@@ -70,5 +70,5 @@ func (h *ProjectsHandler) Get(w http.ResponseWriter, r *http.Request) {
 	}
 
 	vm := &v1.ProjectsViewModel{Data: projects}
-	utils.RespondJSON(w, r, http.StatusOK, vm)
+	helpers.RespondJSON(w, r, http.StatusOK, vm)
 }

routes/compat/wakatime/v1/stats.go

@@ -1,6 +1,7 @@
 package v1
 
 import (
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 	"time"
 
@@ -10,7 +11,6 @@ import (
 	"github.com/muety/wakapi/models"
 	v1 "github.com/muety/wakapi/models/compat/wakatime/v1"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 )
 
 type StatsHandler struct {
@@ -79,7 +79,7 @@ func (h *StatsHandler) Get(w http.ResponseWriter, r *http.Request) {
 		rangeParam = (*models.IntervalPast7Days)[0]
 	}
 
-	err, rangeFrom, rangeTo := utils.ResolveIntervalRawTZ(rangeParam, requestedUser.TZ())
+	err, rangeFrom, rangeTo := helpers.ResolveIntervalRawTZ(rangeParam, requestedUser.TZ())
 	if err != nil {
 		w.WriteHeader(http.StatusBadRequest)
 		w.Write([]byte("invalid range"))
@@ -94,7 +94,7 @@ func (h *StatsHandler) Get(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	summary, err, status := h.loadUserSummary(requestedUser, rangeFrom, rangeTo, utils.ParseSummaryFilters(r))
+	summary, err, status := h.loadUserSummary(requestedUser, rangeFrom, rangeTo, helpers.ParseSummaryFilters(r))
 	if err != nil {
 		w.WriteHeader(status)
 		w.Write([]byte(err.Error()))
@@ -120,7 +120,7 @@ func (h *StatsHandler) Get(w http.ResponseWriter, r *http.Request) {
 		stats.Data.Machines = nil
 	}
 
-	utils.RespondJSON(w, r, http.StatusOK, stats)
+	helpers.RespondJSON(w, r, http.StatusOK, stats)
 }
 
 func (h *StatsHandler) loadUserSummary(user *models.User, start, end time.Time, filters *models.Filters) (*models.Summary, error, int) {

routes/compat/wakatime/v1/statusbar.go

@@ -1,6 +1,7 @@
 package v1
 
 import (
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 	"time"
 
@@ -11,7 +12,6 @@ import (
 	v1 "github.com/muety/wakapi/models/compat/wakatime/v1"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 )
 
 type StatusBarViewModel struct {
@@ -65,7 +65,7 @@ func (h *StatusBarHandler) Get(w http.ResponseWriter, r *http.Request) {
 		rangeParam = (*models.IntervalToday)[0]
 	}
 
-	err, rangeFrom, rangeTo := utils.ResolveIntervalRawTZ(rangeParam, user.TZ())
+	err, rangeFrom, rangeTo := helpers.ResolveIntervalRawTZ(rangeParam, user.TZ())
 	if err != nil {
 		w.WriteHeader(http.StatusBadRequest)
 		w.Write([]byte("invalid range"))
@@ -79,7 +79,7 @@ func (h *StatusBarHandler) Get(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 	summariesView := v1.NewSummariesFrom([]*models.Summary{summary})
-	utils.RespondJSON(w, r, http.StatusOK, StatusBarViewModel{
+	helpers.RespondJSON(w, r, http.StatusOK, StatusBarViewModel{
 		CachedAt: time.Now(),
 		Data:     *summariesView.Data[0],
 	})

routes/compat/wakatime/v1/summaries.go

@@ -3,6 +3,7 @@ package v1
 import (
 	"errors"
 	"github.com/duke-git/lancet/v2/datetime"
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 	"strings"
 	"time"
@@ -76,7 +77,7 @@ func (h *SummariesHandler) Get(w http.ResponseWriter, r *http.Request) {
 	}
 
 	vm := v1.NewSummariesFrom(summaries)
-	utils.RespondJSON(w, r, http.StatusOK, vm)
+	helpers.RespondJSON(w, r, http.StatusOK, vm)
 }
 
 func (h *SummariesHandler) loadUserSummaries(r *http.Request) ([]*models.Summary, error, int) {
@@ -94,24 +95,24 @@ func (h *SummariesHandler) loadUserSummaries(r *http.Request) ([]*models.Summary
 	var start, end time.Time
 	if rangeParam != "" {
 		// range param takes precedence
-		if err, parsedFrom, parsedTo := utils.ResolveIntervalRawTZ(rangeParam, timezone); err == nil {
+		if err, parsedFrom, parsedTo := helpers.ResolveIntervalRawTZ(rangeParam, timezone); err == nil {
 			start, end = parsedFrom, parsedTo
 		} else {
 			return nil, errors.New("invalid 'range' parameter"), http.StatusBadRequest
 		}
-	} else if err, parsedFrom, parsedTo := utils.ResolveIntervalRawTZ(startParam, timezone); err == nil && startParam == endParam {
+	} else if err, parsedFrom, parsedTo := helpers.ResolveIntervalRawTZ(startParam, timezone); err == nil && startParam == endParam {
 		// also accept start param to be a range param
 		start, end = parsedFrom, parsedTo
 	} else {
 		// eventually, consider start and end params a date
 		var err error
 
-		start, err = utils.ParseDateTimeTZ(strings.Replace(startParam, " ", "+", 1), timezone)
+		start, err = helpers.ParseDateTimeTZ(strings.Replace(startParam, " ", "+", 1), timezone)
 		if err != nil {
 			return nil, errors.New("missing required 'start' parameter"), http.StatusBadRequest
 		}
 
-		end, err = utils.ParseDateTimeTZ(strings.Replace(endParam, " ", "+", 1), timezone)
+		end, err = helpers.ParseDateTimeTZ(strings.Replace(endParam, " ", "+", 1), timezone)
 		if err != nil {
 			return nil, errors.New("missing required 'end' parameter"), http.StatusBadRequest
 		}
@@ -133,7 +134,7 @@ func (h *SummariesHandler) loadUserSummaries(r *http.Request) ([]*models.Summary
 	summaries := make([]*models.Summary, len(intervals))
 
 	// filtering
-	filters := utils.ParseSummaryFilters(r)
+	filters := helpers.ParseSummaryFilters(r)
 
 	for i, interval := range intervals {
 		summary, err := h.summarySrvc.Aliased(interval[0], interval[1], user, h.summarySrvc.Retrieve, filters, end.After(time.Now()))

routes/compat/wakatime/v1/users.go

@@ -1,6 +1,7 @@
 package v1
 
 import (
+	"github.com/muety/wakapi/helpers"
 	"net/http"
 
 	"github.com/gorilla/mux"
@@ -9,7 +10,6 @@ import (
 	v1 "github.com/muety/wakapi/models/compat/wakatime/v1"
 	routeutils "github.com/muety/wakapi/routes/utils"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 )
 
 type UsersHandler struct {
@@ -56,5 +56,5 @@ func (h *UsersHandler) Get(w http.ResponseWriter, r *http.Request) {
 		conf.Log().Request(r).Error("%v", err)
 	}
 
-	utils.RespondJSON(w, r, http.StatusOK, v1.UserViewModel{Data: user})
+	helpers.RespondJSON(w, r, http.StatusOK, v1.UserViewModel{Data: user})
 }

routes/routes.go

@@ -2,6 +2,7 @@ package routes
 
 import (
 	"fmt"
+	"github.com/muety/wakapi/helpers"
 	"html/template"
 	"net/http"
 	"strings"
@@ -24,16 +25,16 @@ func Init() {
 func DefaultTemplateFuncs() template.FuncMap {
 	return template.FuncMap{
 		"json":           utils.Json,
-		"date":           utils.FormatDateHuman,
-		"datetime":       utils.FormatDateTimeHuman,
-		"simpledate":     utils.FormatDate,
-		"simpledatetime": utils.FormatDateTime,
-		"duration":       utils.FmtWakatimeDuration,
+		"date":           helpers.FormatDateHuman,
+		"datetime":       helpers.FormatDateTimeHuman,
+		"simpledate":     helpers.FormatDate,
+		"simpledatetime": helpers.FormatDateTime,
+		"duration":       helpers.FmtWakatimeDuration,
 		"floordate":      datetime.BeginOfDay,
 		"ceildate":       utils.CeilDate,
 		"title":          strings.Title,
 		"join":           strings.Join,
-		"add":            utils.Add,
+		"add":            add,
 		"capitalize":     utils.Capitalize,
 		"lower":          strings.ToLower,
 		"toRunes":        utils.ToRunes,
@@ -106,3 +107,7 @@ func loadTemplates() {
 func defaultErrorRedirectTarget() string {
 	return fmt.Sprintf("%s/?error=unauthorized", config.Get().Server.BasePath)
 }
+
+func add(i, j int) int {
+	return i + j
+}

routes/summary.go

@@ -3,6 +3,7 @@ package routes
 import (
 	"github.com/gorilla/mux"
 	conf "github.com/muety/wakapi/config"
+	"github.com/muety/wakapi/helpers"
 	"github.com/muety/wakapi/middlewares"
 	"github.com/muety/wakapi/models/view"
 	su "github.com/muety/wakapi/routes/utils"
@@ -47,7 +48,7 @@ func (h *SummaryHandler) GetIndex(w http.ResponseWriter, r *http.Request) {
 		r.URL.RawQuery = q.Encode()
 	}
 
-	summaryParams, _ := utils.ParseSummaryParams(r)
+	summaryParams, _ := helpers.ParseSummaryParams(r)
 	summary, err, status := su.LoadUserSummary(h.summarySrvc, r)
 	if err != nil {
 		w.WriteHeader(status)

routes/utils/badge_utils.go

@@ -2,8 +2,8 @@ package utils
 
 import (
 	"errors"
+	"github.com/muety/wakapi/helpers"
 	"github.com/muety/wakapi/models"
-	"github.com/muety/wakapi/utils"
 	"net/http"
 	"regexp"
 )
@@ -31,12 +31,12 @@ func GetBadgeParams(r *http.Request, requestedUser *models.User) (*models.KeyedI
 
 	var intervalKey = models.IntervalPast30Days
 	if groups := intervalReg.FindStringSubmatch(r.URL.Path); len(groups) > 1 {
-		if i, err := utils.ParseInterval(groups[1]); err == nil {
+		if i, err := helpers.ParseInterval(groups[1]); err == nil {
 			intervalKey = i
 		}
 	}
 
-	_, rangeFrom, rangeTo := utils.ResolveIntervalTZ(intervalKey, requestedUser.TZ())
+	_, rangeFrom, rangeTo := helpers.ResolveIntervalTZ(intervalKey, requestedUser.TZ())
 	interval := &models.KeyedInterval{
 		Interval: models.Interval{Start: rangeFrom, End: rangeTo},
 		Key:      intervalKey,

routes/utils/summary_utils.go

@@ -1,14 +1,14 @@
 package utils
 
 import (
+	"github.com/muety/wakapi/helpers"
 	"github.com/muety/wakapi/models"
 	"github.com/muety/wakapi/services"
-	"github.com/muety/wakapi/utils"
 	"net/http"
 )
 
 func LoadUserSummary(ss services.ISummaryService, r *http.Request) (*models.Summary, error, int) {
-	summaryParams, err := utils.ParseSummaryParams(r)
+	summaryParams, err := helpers.ParseSummaryParams(r)
 	if err != nil {
 		return nil, err, http.StatusBadRequest
 	}