Merge branch 'refactor/frontend'

Author: ItsNotGoodName

assets/desktop-demo.png

@@ -1,4 +1,34 @@
+# API
+
+## Example Responses
+
+```json
+{
+  "ok": true,
+  "code": 200
+}
+```
+
+```json
+{
+  "ok": true,
+  "code": 200,
+  "result": {
+    "uuid": "fb38cb47-a74b-42d5-bb9c-89dcc6a3d960"
+  }
+}
+```
+
+```json
+{
+  "ok": false,
+  "code": 404,
+  "error": "radio not found"
+}
+```
+
 ## Radio API
+
 ### Discover radios
 
 ```
@@ -19,7 +49,7 @@ GET http://localhost:8080/v1/radio/:uuid
 
 ### Get radio state via websocket
 
-Client must send `uuid` after they connect or specify it in the `GET` parameter in order to receive state. The first message sent to client is always the full state. After that, only state changes are sent to the client. The `uuid` is always sent to the client. The connection will terminate if the client sends an invalid `uuid`.
+Client must send `uuid` after they connect or specify it in the `GET` url parameter in order to start receiving state. The first message sent to client is always the full state. After that, only state changes are sent to the client. The `uuid` is always sent to the client in each message. The connection will terminate if the client sends an invalid `uuid`.
 
 ```
 GET ws://localhost:8080/v1/radio/ws?uuid=:uuid
@@ -53,6 +83,7 @@ POST http://localhost:8080/v1/radio/:uuid/volume
 ```
 POST http://localhost:8080/v1/radio/:uuid
 ```
+
 ## Preset API
 
 ### Get presets
@@ -78,4 +109,4 @@ content-type: application/json
 	"newName": "Good Music"
 	"newUrl" : "http://differentm3u.example.com/08.m3u"
 }
-```
+```

docs/api.md

@@ -20,7 +20,7 @@ func handlePresetGet(presetStore core.PresetStore) gin.HandlerFunc {
 			return
 		}
 
-		c.JSON(http.StatusOK, preset)
+		renderJSON(c, http.StatusOK, preset)
 	}
 }
 
@@ -33,7 +33,9 @@ func handlePresetList(presetStore core.PresetStore) gin.HandlerFunc {
 			return
 		}
 
-		c.JSON(http.StatusOK, presets)
+		sortPresets(presets)
+
+		renderJSON(c, http.StatusOK, presets)
 	}
 }
 
@@ -56,7 +58,7 @@ func handlePresetUpdate(presetStore core.PresetStore) gin.HandlerFunc {
 			return
 		}
 
-		c.JSON(http.StatusOK, preset)
+		renderJSON(c, http.StatusOK, preset)
 	}
 }
 

server/preset.go

@@ -22,13 +22,13 @@ func handleRadioGet() func(c *gin.Context) {
 		}
 
 		// Return Radio
-		c.JSON(http.StatusOK, state)
+		renderJSON(c, http.StatusOK, state)
 	}
 }
 
 func handleRadioList(h *radio.Hub) func(c *gin.Context) {
 	return func(c *gin.Context) {
-		c.JSON(http.StatusOK, h.GetRadioStates(c))
+		renderJSON(c, http.StatusOK, h.GetRadioStates(c))
 	}
 }
 
@@ -95,6 +95,8 @@ func handleRadioPatch() func(c *gin.Context) {
 				return
 			}
 		}
+
+		renderJSON(c, http.StatusOK, nil)
 	}
 }
 
@@ -104,6 +106,8 @@ func handleRadioRefresh() func(c *gin.Context) {
 		rd := c.MustGet("radio").(*radio.Radio)
 
 		rd.Refresh()
+
+		renderJSON(c, http.StatusOK, nil)
 	}
 }
 
@@ -117,6 +121,8 @@ func handleRadioVolumeRefresh() func(c *gin.Context) {
 			renderError(c, http.StatusServiceUnavailable, err)
 			return
 		}
+
+		renderJSON(c, http.StatusOK, nil)
 	}
 }
 
@@ -126,5 +132,7 @@ func handleRadioDiscover(h *radio.Hub) func(c *gin.Context) {
 			renderError(c, http.StatusConflict, err)
 			return
 		}
+
+		renderJSON(c, http.StatusOK, nil)
 	}
 }

server/radio.go

@@ -3,13 +3,34 @@ package server
 import (
 	"context"
 	"log"
+	"sort"
+	"strings"
 
 	"github.com/ItsNotGoodName/reciva-web-remote/core"
 	"github.com/gin-gonic/gin"
 )
 
+type RenderJSON struct {
+	Ok     bool        `json:"ok"`
+	Code   int         `json:"code"`
+	Result interface{} `json:"result,omitempty"`
+	Error  string      `json:"error,omitempty"`
+}
+
 func renderError(c *gin.Context, code int, err error) {
-	c.JSON(code, gin.H{"err": err.Error()})
+	c.JSON(code, RenderJSON{
+		Ok:    false,
+		Code:  code,
+		Error: err.Error(),
+	})
+}
+
+func renderJSON(c *gin.Context, code int, result interface{}) {
+	c.JSON(code, RenderJSON{
+		Ok:     true,
+		Code:   code,
+		Result: result,
+	})
 }
 
 // getPresetURLS returns all urls for presets.
@@ -26,3 +47,9 @@ func getPresetURLS(p core.PresetStore) []string {
 
 	return urls
 }
+
+func sortPresets(presets []core.Preset) {
+	sort.Slice(presets, func(i, j int) bool {
+		return strings.Compare(presets[i].URL, presets[j].URL) < 0
+	})
+}

server/util.go

@@ -2,20 +2,20 @@
 <html lang="en">
 
 <head>
-	<meta charset="UTF-8" />
-	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
-	<title>Reciva Web Remote</title>
-	<meta name="description" content="Control Reciva based radios">
-	<link rel="icon" href="/favicon.svg" type="image/svg+xml">
-	<link rel="alternate icon" href="/favicon.ico" type="image/png" sizes="16x16">
-	<link rel="apple-touch-icon" href="/apple-touch-icon.png" sizes="180x180">
-	<link rel="mask-icon" href="/favicon.svg" color="#FFFFFF">
-	<meta name="theme-color" content="#ffffff">
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Reciva Web Remote</title>
+  <meta name="description" content="Control your legacy Reciva based internet radios">
+  <link rel="icon" href="/favicon.svg" type="image/svg+xml">
+  <link rel="alternate icon" href="/favicon.ico" type="image/png" sizes="16x16">
+  <link rel="apple-touch-icon" href="/apple-touch-icon.png" sizes="180x180">
+  <link rel="mask-icon" href="/favicon.svg" color="#FFFFFF">
+  <meta name="theme-color" content="#ffffff">
 </head>
 
-<body>
-	<div id="app"></div>
-	<script type="module" src="/src/main.js"></script>
+<body class="has-navbar-fixed-top has-navbar-fixed-bottom">
+  <div id="app"></div>
+  <script type="module" src="/src/main.js"></script>
 </body>
 
 </html>