Merge branch 'master' of https://github.com/kondr1/wakapi into kondr1-master

main.go

@@ -176,6 +176,7 @@ func main() {
 	diagnosticsHandler := api.NewDiagnosticsApiHandler(userService, diagnosticsService)
 
 	// Compat Handlers
+	wakatimeV1StatusBarHandler := wtV1Routes.NewStatusBarHandler(userService, summaryService)
 	wakatimeV1AllHandler := wtV1Routes.NewAllTimeHandler(userService, summaryService)
 	wakatimeV1SummariesHandler := wtV1Routes.NewSummariesHandler(userService, summaryService)
 	wakatimeV1StatsHandler := wtV1Routes.NewStatsHandler(userService, summaryService)
@@ -225,6 +226,7 @@ func main() {
 	heartbeatApiHandler.RegisterRoutes(apiRouter)
 	metricsHandler.RegisterRoutes(apiRouter)
 	diagnosticsHandler.RegisterRoutes(apiRouter)
+	wakatimeV1StatusBarHandler.RegisterRoutes(apiRouter)
 	wakatimeV1AllHandler.RegisterRoutes(apiRouter)
 	wakatimeV1SummariesHandler.RegisterRoutes(apiRouter)
 	wakatimeV1StatsHandler.RegisterRoutes(apiRouter)

postman/Wakapi.postman_collection.json

@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "46168002-34d8-48a5-95fa-4a8600450cbd",
+		"_postman_id": "728a2979-6cb3-4b46-9be9-3273f3d20a3d",
 		"name": "Wakapi",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
@@ -342,6 +342,36 @@
 						}
 					},
 					"response": []
+				},
+				{
+					"name": "Get statusbar",
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "Authorization",
+								"value": "Basic {{TOKEN}}",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{BASE_URL}}/api/compat/wakatime/v1/users/current/statusbar/today",
+							"host": [
+								"{{BASE_URL}}"
+							],
+							"path": [
+								"api",
+								"compat",
+								"wakatime",
+								"v1",
+								"users",
+								"current",
+								"statusbar",
+								"today"
+							]
+						}
+					},
+					"response": []
 				}
 			]
 		}

routes/compat/wakatime/v1/statusbar.go

@@ -0,0 +1,107 @@
+package v1
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/gorilla/mux"
+	conf "github.com/muety/wakapi/config"
+	"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"
+)
+
+type StatusBarViewModel struct {
+	CachedAt time.Time        `json:"cached_at"`
+	Data     v1.SummariesData `json:"data"`
+}
+
+type StatusBarHandler struct {
+	config      *conf.Config
+	userSrvc    services.IUserService
+	summarySrvc services.ISummaryService
+}
+
+func NewStatusBarHandler(userService services.IUserService, summaryService services.ISummaryService) *StatusBarHandler {
+	return &StatusBarHandler{
+		userSrvc:    userService,
+		summarySrvc: summaryService,
+		config:      conf.Get(),
+	}
+}
+
+func (h *StatusBarHandler) RegisterRoutes(router *mux.Router) {
+	r := router.PathPrefix("").Subrouter()
+
+	r.Use(
+		middlewares.NewAuthenticateMiddleware(h.userSrvc).Handler,
+	)
+	r.Path("/users/{user}/statusbar/{range}").Methods(http.MethodGet).HandlerFunc(h.Get)
+	r.Path("/v1/users/{user}/statusbar/{range}").Methods(http.MethodGet).HandlerFunc(h.Get)
+	r.Path("/compat/wakatime/v1/users/{user}/statusbar/{range}").Methods(http.MethodGet).HandlerFunc(h.Get)
+}
+
+// @Summary Retrieve summary for statusbar
+// @Description Mimics https://wakatime.com/api/v1/users/current/statusbar/today. Have no official documentation
+// @ID statusbar
+// @Tags wakatime
+// @Produce json
+// @Param user path string true "User ID to fetch data for (or 'current')"
+// @Security ApiKeyAuth
+// @Success 200 {object} v1.StatusBarViewModel
+// @Router /users/{user}/statusbar/today [get]
+func (h *StatusBarHandler) Get(w http.ResponseWriter, r *http.Request) {
+	user, err := routeutils.CheckEffectiveUser(w, r, h.userSrvc, "current")
+	if err != nil {
+		return // response was already sent by util function
+	}
+	var vars = mux.Vars(r)
+
+	rangeParam := vars["range"]
+	if rangeParam == "" {
+		rangeParam = (*models.IntervalToday)[0]
+	}
+
+	err, rangeFrom, rangeTo := utils.ResolveIntervalRawTZ(rangeParam, user.TZ())
+	if err != nil {
+		w.WriteHeader(http.StatusBadRequest)
+		w.Write([]byte("invalid range"))
+		return
+	}
+
+	summary, status, err := h.loadUserSummary(user, rangeFrom, rangeTo)
+	if err != nil {
+		w.WriteHeader(status)
+		w.Write([]byte(err.Error()))
+		return
+	}
+	summariesView := v1.NewSummariesFrom([]*models.Summary{summary}, &models.Filters{})
+	utils.RespondJSON(w, r, http.StatusOK, StatusBarViewModel{
+		CachedAt: time.Now(),
+		Data:     *summariesView.Data[0],
+	})
+}
+
+func (h *StatusBarHandler) loadUserSummary(user *models.User, start, end time.Time) (*models.Summary, int, error) {
+	summaryParams := &models.SummaryParams{
+		From:      start,
+		To:        end,
+		User:      user,
+		Recompute: false,
+	}
+
+	var retrieveSummary services.SummaryRetriever = h.summarySrvc.Retrieve
+	if summaryParams.Recompute {
+		retrieveSummary = h.summarySrvc.Summarize
+	}
+
+	summary, err := h.summarySrvc.Aliased(summaryParams.From, summaryParams.To, summaryParams.User, retrieveSummary, summaryParams.Recompute)
+	if err != nil {
+		return nil, http.StatusInternalServerError, err
+	}
+
+	return summary, http.StatusOK, nil
+}

testing/Wakapi API Tests.postman_collection.json

@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "7ce36cea-e702-40c6-8056-2cb6149f34f7",
+		"_postman_id": "36595622-81dc-4f4a-826e-345ae63fc83b",
 		"name": "Wakapi API Tests",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
@@ -1869,6 +1869,62 @@
 					},
 					"response": []
 				},
+				{
+					"name": "Get statusbar (curent)",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"pm.test(\"Status code is 200\", function () {",
+									"    pm.response.to.have.status(200);",
+									"});",
+									"",
+									"pm.test(\"Correct content\", function () {",
+									"    const jsonData = pm.response.json();",
+									"    pm.expect(jsonData.data.grand_total.text).to.contains(\"0 hrs\");",
+									"    pm.expect(jsonData.data.categories).to.instanceOf(Array);",
+									"});"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"protocolProfileBehavior": {
+						"disableCookies": true
+					},
+					"request": {
+						"auth": {
+							"type": "bearer",
+							"bearer": [
+								{
+									"key": "token",
+									"value": "{{WRITEUSER_TOKEN}}",
+									"type": "string"
+								}
+							]
+						},
+						"method": "GET",
+						"header": [],
+						"url": {
+							"raw": "{{BASE_URL}}/api/compat/wakatime/v1/users/current/statusbar/today",
+							"host": [
+								"{{BASE_URL}}"
+							],
+							"path": [
+								"api",
+								"compat",
+								"wakatime",
+								"v1",
+								"users",
+								"current",
+								"statusbar",
+								"today"
+							]
+						}
+					},
+					"response": []
+				},
 				{
 					"name": "Get stats (by user)",
 					"event": [