From b715438fccbc3804e1379913182247588c247de1 Mon Sep 17 00:00:00 2001 From: froge Date: Tue, 11 Feb 2025 15:48:29 +1000 Subject: [PATCH] Initial commit --- .gitignore | 1 + README.md | 2 ++ auth.go | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++ go.mod | 33 ++++++++++++++++++ go.sum | 78 +++++++++++++++++++++++++++++++++++++++++ main.go | 35 +++++++++++++++++++ routes.go | 84 ++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 333 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 auth.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main.go create mode 100644 routes.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4c49bd7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.env diff --git a/README.md b/README.md new file mode 100644 index 0000000..0389c24 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Basic spotify API in golang +This API supports simple artist read operations for spotify data, as well as using a simple caching database and handling client authentication automatically. diff --git a/auth.go b/auth.go new file mode 100644 index 0000000..0f3b884 --- /dev/null +++ b/auth.go @@ -0,0 +1,100 @@ +package main + +import ( + "github.com/gin-gonic/gin" + "encoding/base64" + "encoding/json" + "net/http" + "log/slog" + "strings" + "time" + "fmt" + "io" +) + +// Used to unmarshal response data into type safe struct +type SpotifyToken struct { + AccessToken string `json:"access_token"` + TokenType string `json:"token_type"` + ExpiresIn int `json:"expires_in"` +} + +// Makes a HTTP request to grab a short lived access token from Spotify +func getSpotifyToken(clientID string, clientSecret string) (SpotifyToken, error) { + + // See spotify API docs for details on parameters/urls required here + // https://developer.spotify.com/documentation/web-api/tutorials/client-credentials-flow + spotifyAuthURL := "https://accounts.spotify.com/api/token" + reqBody := strings.NewReader("grant_type=client_credentials") + authData := []byte(fmt.Sprintf("%s:%s", clientID, clientSecret)) + b64AuthData := base64.StdEncoding.EncodeToString(authData) + + req, err := http.NewRequest("POST", spotifyAuthURL, reqBody) + if err != nil { + slog.Error("[GOMUSIC] Failed to build HTTP request", "Error", err) + return SpotifyToken{}, fmt.Errorf("Failed to authenticate with spotify: %w", err) + } + + req.Header.Add("Content-Type", "application/x-www-form-urlencoded") + req.Header.Add("Authorization", fmt.Sprintf("Basic %s", b64AuthData)) + + // Send request and grab response data + resp, err := http.DefaultClient.Do(req) + if err != nil { + slog.Error("[GOMUSIC] Failed to send authentication request to spotify", "Error", err) + return SpotifyToken{}, fmt.Errorf("Failed to authenticate with spotify: %w", err) + + } else if resp.StatusCode != 200 { + slog.Error("[GOMUSIC] Failed to authenticate with spotify", "Error", resp.Status) + return SpotifyToken{}, fmt.Errorf("Failed to authenticate with spotify: %s", resp.Status) + } + respData, err := io.ReadAll(resp.Body) + if err != nil { + slog.Error("[GOMUSIC] Failed to read response body data from spotify", "Error", err) + return SpotifyToken{}, fmt.Errorf("Failed to authenticate with spotify") + } + // Close this immediately since it's unused now + resp.Body.Close() + + var spotifyToken SpotifyToken + err = json.Unmarshal(respData, &spotifyToken) + if err != nil { + slog.Error("[GOMUSIC] Failed to parse spotify authentication response", "Error", err) + return SpotifyToken{}, fmt.Errorf("Failed to parse spotify JSON response: %w", err) + } + + return spotifyToken, nil +} + +// Authentication middleware to handle spotify for us +func spotifyAuth(clientID string, clientSecret string) gin.HandlerFunc { + // Setup a per-instance variable to safely store/update + // Short lived spotify access tokens during execution + spotifyToken, err := getSpotifyToken(clientID, clientSecret) + if err != nil { + slog.Error("[GOMUSIC] Failed to get spotify access token", "Error", err) + } + + // Calculate the future expiry time + expDuration := time.Duration(spotifyToken.ExpiresIn) * time.Second + expireTime := time.Now().Add(expDuration) + + return func(c *gin.Context) { + if time.Now().After(expireTime) { + // Token expired so we grab a new one + slog.Info("[GOMUSIC] Replacing expired Spotify access token") + spotifyToken, err = getSpotifyToken(clientID, clientSecret) + if err != nil { + slog.Error("[GOMUSIC] Failed to get new spotify access token", "Error", err) + } + expDuration := time.Duration(spotifyToken.ExpiresIn) * time.Second + expireTime = time.Now().Add(expDuration) + } + + // Pass the authorization header into context + c.Set("spotifyAuthToken", fmt.Sprintf("Bearer %s", spotifyToken.AccessToken)) + + // Process the request + c.Next() + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..eb043e6 --- /dev/null +++ b/go.mod @@ -0,0 +1,33 @@ +module git.repo.cafe/froge/gomusic + +go 1.23.5 + +require ( + github.com/bytedance/sonic v1.12.8 // indirect + github.com/bytedance/sonic/loader v0.2.3 // indirect + github.com/cloudwego/base64x v0.1.5 // indirect + github.com/cloudwego/iasm v0.2.0 // indirect + github.com/gabriel-vasile/mimetype v1.4.8 // indirect + github.com/gin-contrib/sse v1.0.0 // indirect + github.com/gin-gonic/gin v1.10.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.24.0 // indirect + github.com/goccy/go-json v0.10.5 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/klauspost/cpuid/v2 v2.2.9 // indirect + github.com/leodido/go-urn v1.4.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.3 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.2.12 // indirect + golang.org/x/arch v0.14.0 // indirect + golang.org/x/crypto v0.33.0 // indirect + golang.org/x/net v0.34.0 // indirect + golang.org/x/sys v0.30.0 // indirect + golang.org/x/text v0.22.0 // indirect + google.golang.org/protobuf v1.36.5 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..d60e044 --- /dev/null +++ b/go.sum @@ -0,0 +1,78 @@ +github.com/bytedance/sonic v1.12.8 h1:4xYRVRlXIgvSZ4e8iVTlMF5szgpXd4AfvuWgA8I8lgs= +github.com/bytedance/sonic v1.12.8/go.mod h1:uVvFidNmlt9+wa31S1urfwwthTWteBgG0hWuoKAXTx8= +github.com/bytedance/sonic/loader v0.1.1/go.mod h1:ncP89zfokxS5LZrJxl5z0UJcsk4M4yY2JpfqGeCtNLU= +github.com/bytedance/sonic/loader v0.2.3 h1:yctD0Q3v2NOGfSWPLPvG2ggA2kV6TS6s4wioyEqssH0= +github.com/bytedance/sonic/loader v0.2.3/go.mod h1:N8A3vUdtUebEY2/VQC0MyhYeKUFosQU6FxH2JmUe6VI= +github.com/cloudwego/base64x v0.1.5 h1:XPciSp1xaq2VCSt6lF0phncD4koWyULpl5bUxbfCyP4= +github.com/cloudwego/base64x v0.1.5/go.mod h1:0zlkT4Wn5C6NdauXdJRhSKRlJvmclQ1hhJgA0rcu/8w= +github.com/cloudwego/iasm v0.2.0 h1:1KNIy1I1H9hNNFEEH3DVnI4UujN+1zjpuk6gwHLTssg= +github.com/cloudwego/iasm v0.2.0/go.mod h1:8rXZaNYT2n95jn+zTI1sDr+IgcD2GVs0nlbbQPiEFhY= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gabriel-vasile/mimetype v1.4.8 h1:FfZ3gj38NjllZIeJAmMhr+qKL8Wu+nOoI3GqacKw1NM= +github.com/gabriel-vasile/mimetype v1.4.8/go.mod h1:ByKUIKGjh1ODkGM1asKUbQZOLGrPjydw3hYPU2YU9t8= +github.com/gin-contrib/sse v1.0.0 h1:y3bT1mUWUxDpW4JLQg/HnTqV4rozuW4tC9eFKTxYI9E= +github.com/gin-contrib/sse v1.0.0/go.mod h1:zNuFdwarAygJBht0NTKiSi3jRf6RbqeILZ9Sp6Slhe0= +github.com/gin-gonic/gin v1.10.0 h1:nTuyha1TYqgedzytsKYqna+DfLos46nTv2ygFy86HFU= +github.com/gin-gonic/gin v1.10.0/go.mod h1:4PMNQiOhvDRa013RKVbsiNwoyezlm2rm0uX/T7kzp5Y= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.24.0 h1:KHQckvo8G6hlWnrPX4NJJ+aBfWNAE/HH+qdL2cBpCmg= +github.com/go-playground/validator/v10 v10.24.0/go.mod h1:GGzBIJMuE98Ic/kJsBXbz1x/7cByt++cQ+YOuDM5wus= +github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= +github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= +github.com/klauspost/cpuid/v2 v2.2.9 h1:66ze0taIn2H33fBvCkXuv9BmCwDfafmiIVpKV9kKGuY= +github.com/klauspost/cpuid/v2 v2.2.9/go.mod h1:rqkxqrZ1EhYM9G+hXH7YdowN5R5RGN6NK4QwQ3WMXF8= +github.com/knz/go-libedit v1.10.1/go.mod h1:MZTVkCWyz0oBc7JOWP3wNAzd002ZbM/5hgShxwh4x8M= +github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= +github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M= +github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65EE= +github.com/ugorji/go/codec v1.2.12/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= +golang.org/x/arch v0.14.0 h1:z9JUEZWr8x4rR0OU6c4/4t6E6jOZ8/QBS2bBYBm4tx4= +golang.org/x/arch v0.14.0/go.mod h1:FEVrYAQjsQXMVJ1nsMoVVXPZg6p2JE2mx8psSWTDQys= +golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus= +golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M= +golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0= +golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= +golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM= +golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY= +google.golang.org/protobuf v1.36.5 h1:tPhr+woSbjfYvY6/GPufUoYizxw1cF/yFoxJ2fmpwlM= +google.golang.org/protobuf v1.36.5/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYmp6pbG50= +rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= diff --git a/main.go b/main.go new file mode 100644 index 0000000..9cabfdb --- /dev/null +++ b/main.go @@ -0,0 +1,35 @@ +package main + +import ( + "github.com/gin-gonic/gin" + "os" + "log/slog" +) + +// Grab some required spotify credentials from the environment +var spotifyClientID = os.Getenv("SPOTIFY_ID") +var spotifyClientSecret = os.Getenv("SPOTIFY_SECRET") + +// DB related setup +var db = make(map[string]string) + +func main() { + // If the auth/ID variables are empty something is probably misconfigured + if spotifyClientID == "" { + slog.Warn("[GOMUSIC] No Spotify ID configured in 'SPOTIFY_ID' environment variable") + } + if spotifyClientSecret == "" { + slog.Warn("[GOMUSIC] No Spotify secret configured in 'SPOTIFY_SECRET' environment variable") + } + + // API server setup + var r *gin.Engine = gin.Default() + + // Add middleware to handle spotify auth for us + r.Use(spotifyAuth(spotifyClientID, spotifyClientSecret)) + + r.GET("/ping", ping) + r.GET("/artists/:artistID", getArtistByID) + + r.Run(":8080") +} diff --git a/routes.go b/routes.go new file mode 100644 index 0000000..c0744dc --- /dev/null +++ b/routes.go @@ -0,0 +1,84 @@ +package main + +import ( + "github.com/gin-gonic/gin" + "net/http" + "log/slog" + "encoding/json" + "fmt" + "io" +) + +type ArtistInfo struct { + ID string + Name string + Popularity int + Genres []string +} + +// Define our route functions here +func ping(c *gin.Context) { + c.String(http.StatusOK, "pong") +} + +func getArtistByID(c *gin.Context) { + artistID := c.Params.ByName("artistID") + spotifyAuthToken := c.GetString("spotifyAuthToken") + + if artistID == "" || spotifyAuthToken == "Bearer " { + c.JSON(http.StatusBadRequest, gin.H{"Error": "Could not find required parameters and/or required authentication tokens"}) + return + } + + // Make a request to spotify API to grab artist data + artistEndpoint := fmt.Sprintf("https://api.spotify.com/v1/artists/%s", artistID) + req, err := http.NewRequest("GET", artistEndpoint, nil) + if err != nil { + slog.Error("[GOMUSIC] Failed to build HTTP request", "Error", err) + c.JSON(http.StatusInternalServerError, gin.H{"Error": "Failed to request latest spotify data"}) + return + } + req.Header.Add("Authorization", spotifyAuthToken) + + // Send request and save the response into DB + resp, err := http.DefaultClient.Do(req) + if err != nil { + slog.Error("[GOMUSIC] Failed to get artist data from spotify API", "Error", err) + c.JSON(http.StatusInternalServerError, gin.H{"Error": "Failed to request latest spotify data"}) + return + } else if resp.StatusCode != 200 { + slog.Error("[GOMUSIC] Failed to get artist data from spotify API", "Error", resp.Status) + c.JSON(http.StatusInternalServerError, gin.H{"Error": "Failed to request latest spotify data"}) + return + + } + respData, err := io.ReadAll(resp.Body) + if err != nil { + slog.Error("[GOMUSIC] Failed to read response data from spotify API", "Error", resp.Status) + c.JSON(http.StatusInternalServerError, gin.H{"Error": "Failed to request latest spotify data"}) + return + + } + + // Close this immediately since it's unused now + resp.Body.Close() + + var artistInfo ArtistInfo + err = json.Unmarshal(respData, &artistInfo) + if err != nil { + slog.Error("[GOMUSIC] Failed to read response body data from spotify", "Error", err) + c.JSON(http.StatusInternalServerError, gin.H{"Error": "Failed to request latest spotify data"}) + return + } + + // Send back our response + c.JSON(http.StatusOK, artistInfo) + + // Update DB here + //value, ok := db[artistID] + //if ok { + // c.JSON(http.StatusOK, gin.H{"artistID": artistID, "value": value}) + //} else { + // c.JSON(http.StatusOK, gin.H{"artistID": artistID, "status": "no value"}) + //} +}