chore: rename keymap package

pkg/keyboard/keyboard.go → pkg/infojson/infojson.go

@@ -1,22 +1,26 @@
-package keyboard
+/*
+ * infojson - Fetches and parses the info.json file from the QMK API or a local file.
+ *
+ * See https://docs.qmk.fm/#/reference_info_json for more information.
+ */
+
+package infojson
 
 import (
 	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
 	"os"
-	"time"
 
 	"github.com/rs/zerolog/log"
 )
 
 type Key struct {
-	X     float64  `json:"x"`
-	Y     float64  `json:"y"`
-	W     *float64 `json:"w"`
-	H     *float64 `json:"h"`
-	Label string   `json:"label"`
+	X float64  `json:"x"`
+	Y float64  `json:"y"`
+	W *float64 `json:"w"`
+	H *float64 `json:"h"`
 }
 
 type Layout struct {
@@ -35,45 +39,21 @@ type file struct {
 	Keyboards map[string]Keyboard `json:"keyboards"`
 }
 
-func fetch(url string) (*file, error) {
-	log.Info().Msg("Fetching keyboard layout.")
-	log.Debug().Str("url", url).Send()
-
-	client := http.Client{
-		Timeout: time.Second * 5, // Timeout after 2 seconds
-	}
-
-	req, err := http.NewRequest(http.MethodGet, url, http.NoBody)
-	if err != nil {
-		return nil, err
-	}
-
-	req.Header.Set("User-Agent", "zmk-layout-viewer")
-
-	res, getErr := client.Do(req)
-	if getErr != nil {
-		return nil, getErr
-	}
-
-	if res.Body != nil {
-		defer res.Body.Close()
-	}
-
-	body, readErr := io.ReadAll(res.Body)
-	if readErr != nil {
-		return nil, readErr
-	}
+func FromName(name string) (Layouts, error) {
+	log.Debug().Str("name", name).Send()
+	url := "https://keyboards.qmk.fm/v1/keyboards/%v/info.json"
 
-	f := file{}
-	err = json.Unmarshal(body, &f)
+	f, err := fetch(fmt.Sprintf(url, name))
 	if err != nil {
 		return nil, err
 	}
 
-	return &f, nil
+	l := f.Keyboards[name].Layouts
+	return l, nil
 }
 
-func loadFile(path string) (*Keyboard, error) {
+func FromFile(name, path string) (Layouts, error) {
+	log.Debug().Str("name", name).Str("path", path).Send()
 	data, err := os.ReadFile(path)
 	if err != nil {
 		return nil, err
@@ -83,29 +63,30 @@ func loadFile(path string) (*Keyboard, error) {
 	if err != nil {
 		return nil, err
 	}
-	return &f, nil
+	return f.Layouts, nil
 }
 
-func Fetch(name string) (Layouts, error) {
-	log.Debug().Str("name", name).Send()
-	url := "https://keyboards.qmk.fm/v1/keyboards/%v/info.json"
+func fetch(url string) (*file, error) {
+	log.Info().Msg("Fetching keyboard layout.")
+	log.Debug().Str("url", url).Send()
+
+	resp, err := http.Get(url)
 
-	f, err := fetch(fmt.Sprintf(url, name))
 	if err != nil {
 		return nil, err
 	}
+	defer resp.Body.Close()
 
-	l := f.Keyboards[name].Layouts
-	return l, nil
-}
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, err
+	}
 
-func LoadFile(name, path string) (Layouts, error) {
-	log.Debug().Str("name", name).Send()
-	log.Debug().Str("path", path).Send()
-	f, err := loadFile(path)
+	f := file{}
+	err = json.Unmarshal(body, &f)
 	if err != nil {
 		return nil, err
 	}
-	l := f.Layouts
-	return l, nil
+
+	return &f, nil
 }

pkg/keyboard/keyboard_test.go → pkg/infojson/infojson_test.go

@@ -1,4 +1,4 @@
-package keyboard
+package infojson
 
 import (
 	"net/http"