fix: fixed issue with download cache

Author: rawnly

cmd/root.go

@@ -21,7 +21,6 @@ import (
 	"github.com/rawnly/splash-cli/lib/blurhash"
 	"github.com/rawnly/splash-cli/lib/keys"
 	"github.com/rawnly/splash-cli/lib/terminal"
-	"github.com/rawnly/splash-cli/unsplash"
 	"github.com/rawnly/splash-cli/unsplash/models"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -32,7 +31,7 @@ type photoFlags struct {
 	Day         bool   `json:"day" description:"Get a the photo of the day"`
 	Orientation string `json:"orientation" default:"landscape" description:"Specifies the photo orientation"`
 	Query       string `json:"query" description:"Search for a photo"`
-	Id          string `json:"id" description:"Get a photo by id"`
+	ID          string `json:"id" description:"Get a photo by id"`
 	Save        bool   `json:"save" description:"Save the photo without setting it as wallpaper"`
 	Scale       string `json:"scale" default:"auto" description:"Set wallpaper scale"`
 	IgnoreCache bool   `json:"ignore-cache" default:"false" description:"Ignore cache and download image again"`
@@ -88,10 +87,10 @@ var rootCmd = &cobra.Command{
 		var err error
 
 		ctx := cmd.Context()
-		api := ctx.Value("api").(unsplash.Api)
+		api := keys.GetAPIInstance(ctx)
 		analytics := keys.GetAnalyticsInstance(ctx)
 
-		photoOfTheDayId := viper.GetString("photo-of-the-day.id")
+		photoOfTheDayID := viper.GetString("photo-of-the-day.id")
 
 		ConnectionSpinnerSuffix := []string{" Connecting to Unsplash...", "Failed to connect\n", "✔ Connected"}
 		DownloadSpinnerSuffix := []string{" Downloading photo...", "Failed to download\n", "✔ Downloaded"}
@@ -136,8 +135,8 @@ var rootCmd = &cobra.Command{
 		if dayFlag {
 			analytics.Capture("photo_of_the_day", nil)
 
-			if photoOfTheDayId != "" && !ignoreCacheFlag {
-				photo, err = api.GetPhoto(photoOfTheDayId)
+			if photoOfTheDayID != "" && !ignoreCacheFlag {
+				photo, err = api.GetPhoto(photoOfTheDayID)
 			} else {
 				photo, err = api.GetPhotoOfTheDay()
 				if err != nil {
@@ -161,7 +160,7 @@ var rootCmd = &cobra.Command{
 
 			handleSpinnerError(err, connectionSpinner, cmd, ConnectionSpinnerSuffix[1])
 		} else if idFlag != "" {
-			idFlag = lib.ParsePhotoIDFromUrl(idFlag)
+			idFlag = lib.ParsePhotoIDFromURL(idFlag)
 
 			analytics.Capture("photo_by_id", map[string]any{
 				"photo_id": idFlag,
@@ -172,7 +171,8 @@ var rootCmd = &cobra.Command{
 		} else {
 			analytics.Capture("random_photo", nil)
 
-			photos, err := api.GetRandomPhoto(models.RandomPhotoParams{
+			var photos []models.Photo
+			photos, err = api.GetRandomPhoto(models.RandomPhotoParams{
 				Orientation: orientationFlag,
 				Query:       queryFlag,
 				Count:       1,
@@ -199,7 +199,8 @@ var rootCmd = &cobra.Command{
 		downloadFolder := viper.GetString("download_dir")
 
 		if downloadFolder == "" {
-			folder, err := lib.HomePath("Pictures")
+			var folder string
+			folder, err = lib.HomePath("Pictures")
 			handleSpinnerError(err, downloadSpinner, cmd, DownloadSpinnerSuffix[1])
 
 			downloadFolder = folder
@@ -213,6 +214,11 @@ var rootCmd = &cobra.Command{
 
 		var location string
 
+		// debug printing
+		fmt.Println("Download location:", downloadLocation)
+		fmt.Println("Ignore cache:", ignoreCacheFlag)
+		fmt.Println("File exists:", lib.FileExists(downloadLocation))
+
 		if lib.FileExists(downloadLocation) && !ignoreCacheFlag {
 			location = downloadLocation
 
@@ -235,10 +241,11 @@ var rootCmd = &cobra.Command{
 				fmt.Println("Would you like to set it from the URL?")
 				fmt.Println("")
 
-				_, key, err := keyboard.GetSingleKey()
+				var key keyboard.Key
+				_, key, err = keyboard.GetSingleKey()
 				if err != nil {
-					evtId := sentry.CaptureException(err)
-					logrus.WithField("event_id", evtId).Fatal(err)
+					eventID := sentry.CaptureException(err)
+					logrus.WithField("event_id", eventID).Fatal(err)
 				}
 
 				switch key {

go.mod

@@ -22,6 +22,7 @@ require (
 	github.com/spf13/cobra v1.8.0
 	github.com/spf13/viper v1.18.2
 	github.com/voxelite-ai/env v0.0.1
+	github.com/zalando/go-keyring v0.2.6
 )
 
 require (
@@ -44,7 +45,6 @@ require (
 	github.com/spf13/afero v1.11.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
-	github.com/zalando/go-keyring v0.2.6 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/exp v0.0.0-20231226003508-02704c960a9b // indirect
 	golang.org/x/sys v0.33.0 // indirect

go.sum

@@ -41,6 +41,8 @@ github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
 github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
@@ -120,6 +122,8 @@ github.com/spf13/viper v1.18.2/go.mod h1:EKmWIqdnk5lOcmR72yw6hS+8OPYcwD0jteitLMV
 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 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
+github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 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=
@@ -158,8 +162,6 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
-golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
 golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=

lib/file_util.go

@@ -1,8 +1,10 @@
 package lib
 
 import (
+	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"net/http"
 	"os"
 	"regexp"
@@ -29,7 +31,7 @@ func HomePath(path string) (string, error) {
 	return fmt.Sprintf("%s/%s", homedir, path), nil
 }
 
-func InsertHomeIfNeeded(path string) (string, error) {
+func expandPath(path string) (string, error) {
 	if len(path) > 0 && path[0] != '~' {
 		return path, nil
 	}
@@ -48,14 +50,22 @@ func InsertHomeIfNeeded(path string) (string, error) {
 }
 
 func FileExists(filename string) bool {
-	_, err := os.Stat(filename)
+	p, err := expandPath(filename)
+	if err != nil {
+		return false
+	}
+
+	info, err := os.Stat(p)
+	if err != nil {
+		return !errors.Is(err, fs.ErrNotExist)
+	}
 
-	return err != nil
+	return !info.IsDir()
 }
 
 // DownloadFile / Download a file from a URL and returns the path as string
 func DownloadFile(url string, filename string) (string, error) {
-	path, err := InsertHomeIfNeeded(filename)
+	path, err := expandPath(filename)
 	if err != nil {
 		return "", err
 	}

lib/file_util_test.go

@@ -0,0 +1,27 @@
+package lib
+
+import (
+	"os"
+	"testing"
+)
+
+func TestFileExists(t *testing.T) {
+	// 1. create a temporary file
+	tmpFile, err := os.CreateTemp("", "testfile")
+	if err != nil {
+		t.Fatalf("Failed to create temp file: %v", err)
+	}
+
+	defer os.Remove(tmpFile.Name()) // clean up
+
+	// 2. test that FileExists returns true for the existing file
+	if !FileExists(tmpFile.Name()) {
+		t.Errorf("FileExists returned false for an existing file: %s", tmpFile.Name())
+	}
+
+	// 3. test that FileExists returns false for a non-existing file
+	nonExistentFile := tmpFile.Name() + "_nonexistent"
+	if FileExists(nonExistentFile) {
+		t.Errorf("FileExists returned true for a non-existing file: %s", nonExistentFile)
+	}
+}

lib/util.go

@@ -20,6 +20,7 @@ func GetHomeDir() string {
 	return usr.HomeDir
 }
 
+// ExpandPath expands a path starting with ~ to the user's home directory
 func ExpandPath(path string) string {
 	if path[:2] == "~/" {
 		return GetHomeDir() + path[1:]
@@ -46,12 +47,12 @@ func ParseStringValue(value string) any {
 	return val
 }
 
-func ParsePhotoIDFromUrl(urlOrId string) string {
-	if expressions.IsPhotoUrl(urlOrId) {
-		return expressions.CleanupUrl(urlOrId)
+func ParsePhotoIDFromURL(urlOrID string) string {
+	if expressions.IsPhotoUrl(urlOrID) {
+		return expressions.CleanupUrl(urlOrID)
 	}
 
-	return urlOrId
+	return urlOrID
 }
 
 func ParseCollections(collections []string) []string {