Merge pull request #116 from digitalghost-dev/1.0.2

1.0.2

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.0.1'
+  VERSION_NUMBER: 'v1.0.2'
   DOCKERHUB_REGISTRY_NAME: 'digitalghostdev/poke-cli'
   AWS_REGION: 'us-west-2'
 

.goreleaser.yaml

@@ -14,7 +14,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X main.version=v1.0.1
+      - -s -w -X main.version=v1.0.2
 
 archives:
   - format: tar.gz

Dockerfile

@@ -8,14 +8,26 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.0.1" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.0.2" -o poke-cli .
 
 # build 2
-FROM gcr.io/distroless/static-debian12:nonroot
+FROM --platform=$BUILDPLATFORM alpine:latest
+
+# Install only necessary packages and remove them after use
+RUN apk add --no-cache shadow && \
+    addgroup -S poke_group && adduser -S poke_user -G poke_group && \
+    sed -i 's/^root:.*/root:!*:0:0:root:\/root:\/sbin\/nologin/' /etc/passwd && \
+    apk del shadow
 
 COPY --from=build /app/poke-cli /app/poke-cli
 
 ENV TERM=xterm-256color
 ENV COLOR_OUTPUT=true
 
+# Set correct permissions
+RUN chown -R poke_user:poke_group /app
+
+# Switch to non-root user
+USER poke_user
+
 ENTRYPOINT ["/app/poke-cli"]

README.md

@@ -2,7 +2,7 @@
     <img height="250" width="350" src="pokemon.svg" alt="pokemon-logo"/>
     <h1>Pokémon CLI</h1>
     <img src="https://img.shields.io/github/v/release/digitalghost-dev/poke-cli?style=flat-square&logo=git&logoColor=FFCC00&label=Release%20Version&labelColor=EEE&color=FFCC00" alt="version-label">
-    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.0.1?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
+    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.0.2?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
     <img src="https://img.shields.io/github/actions/workflow/status/digitalghost-dev/poke-cli/ci.yml?branch=main&style=flat-square&logo=github&logoColor=FFCC00&label=CI&labelColor=EEE&color=FFCC00" alt="ci-status-badge">
 </div>
 <div align="center">
@@ -26,7 +26,7 @@ View future plans in the [Roadmap](#roadmap) section.
 ![demo](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/demo-v0.12.0.gif)
 
 ---
-## Install
+## Installation
 
 ### Binary
 _Download a pre-built binary_
@@ -45,7 +45,7 @@ _Download a pre-built binary_
 
 <summary>View Image of Settings</summary>
 
-![settings](https://pokemon-objects.nyc3.digitaloceanspaces.com/macos_settings.png)
+![settings](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/macos_privacy_settings.png)
 
 </details>
 
@@ -70,13 +70,20 @@ _Use a Docker Image_
      * Necessary.
    * `-t`: Allocates a terminal (TTY) for a terminal-like session.
      * Necessary.
-
-```bash
-docker run --rm -i -t digitalghostdev/poke-cli:v1.0.1 <command> [subcommand] flag]
-```
+3. Choose how to interact with the container:
+   * Run a single command and exit:
+    ```bash
+    docker run --rm -it digitalghostdev/poke-cli:v1.0.2 <command> [subcommand] flag]
+    ```
+   * Enter the container and use its shell:
+    ```bash
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.0.2 -c "cd /app && exec sh"
+   # placed into the /app directory, run the program with './poke-cli'
+   # example: ./poke-cli ability swift-swim
+    ```
 
 ### Go Install
-_If you have Go already, install the executable yourself_
+_If you have Go already, install the executable yourself._
 
 1. Run the following command:
    ```bash
@@ -113,6 +120,7 @@ By running `poke-cli [-h | --help]`, it'll display information on how to use the
 ```
 
 ---
+
 ## Roadmap
 Below is a list of the planned/completed commands and flags:
 
@@ -131,3 +139,13 @@ Below is a list of the planned/completed commands and flags:
 - [ ] `search`: search for a resource (`ability`, `berry`, `pokemon`, `move`)
 - [ ] `speed`: compare speed stats between two Pokémon.
 - [x] `types`: get data about a specific typing.
+
+---
+## Tested Terminals
+| OS      | Terminal           | Status | Issues                        |
+|---------|--------------------|:------:|-------------------------------|
+| macOS   | Ghostty            |   ✅    | None                          | 
+| macOS   | Alacritty          |   ✅    | None                          |
+| macOS   | macOS Terminal     |   ⚠️   | Images do not render properly |
+| Windows | Windows Terminal   |   ✅    | None                          |
+| Ubuntu  | Standard Terminal  |   ✅    | None                          |

cli_test.go

@@ -186,7 +186,7 @@ func TestRunCLI(t *testing.T) {
 		{
 			name:           "Latest Flag",
 			args:           []string{"-l"},
-			expectedOutput: "Latest Docker image version: v1.0.0\nLatest release tag: v1.0.0\n",
+			expectedOutput: "Latest Docker image version: v1.0.1\nLatest release tag: v1.0.1\n",
 			expectedCode:   0,
 		},
 	}

cmd/types.go

@@ -58,15 +58,15 @@ func (m model) View() string {
 func displayTypeDetails(typesName string, endpoint string) {
 
 	// Setting up variables to style the list
-	var columnWidth int = 11
+	var columnWidth = 11
 	var subtle = lipgloss.AdaptiveColor{Light: "#D9DCCF", Dark: "#383838"}
 	var list = lipgloss.NewStyle().Border(lipgloss.NormalBorder(), false, true, false, false).BorderForeground(subtle).MarginRight(2).Height(8)
 	var listHeader = lipgloss.NewStyle().BorderStyle(lipgloss.NormalBorder()).BorderBottom(true).BorderForeground(subtle).MarginRight(2).Render
 	var listItem = lipgloss.NewStyle().Render
 	var docStyle = lipgloss.NewStyle().Padding(1, 1, 1, 1)
 
 	baseURL := "https://pokeapi.co/api/v2/"
-	typesStruct, typeName, _, _ := connections.TypesApiCall(endpoint, typesName, baseURL)
+	typesStruct, typeName, _ := connections.TypesApiCall(endpoint, typesName, baseURL)
 
 	// Format selected type
 	selectedType := cases.Title(language.English).String(typeName)

connections/connection.go

@@ -5,20 +5,13 @@ import (
 	"errors"
 	"flag"
 	"fmt"
-	"github.com/charmbracelet/lipgloss"
 	"github.com/digitalghost-dev/poke-cli/structs"
+	"github.com/digitalghost-dev/poke-cli/styling"
 	"io"
 	"net/http"
 	"net/url"
 )
 
-var (
-	errorBorder = lipgloss.NewStyle().
-			BorderStyle(lipgloss.RoundedBorder()).
-			BorderForeground(lipgloss.Color("#F2055C"))
-	errorColor = lipgloss.NewStyle().Foreground(lipgloss.Color("#F2055C"))
-)
-
 // ApiCallSetup Helper function to handle API calls and JSON unmarshalling
 func ApiCallSetup(rawURL string, target interface{}, skipHTTPSCheck bool) error {
 	parsedURL, err := url.Parse(rawURL)
@@ -53,15 +46,16 @@ func ApiCallSetup(rawURL string, target interface{}, skipHTTPSCheck bool) error
 	return nil
 }
 
+// AbilityApiCall function for calling the ability endpoint of the pokeAPI
 func AbilityApiCall(endpoint string, abilityName string, baseURL string) (structs.AbilityJSONStruct, string, error) {
 	fullURL := baseURL + endpoint + "/" + abilityName
 
 	var abilityStruct structs.AbilityJSONStruct
 	err := ApiCallSetup(fullURL, &abilityStruct, false)
 
 	if err != nil {
-		errMessage := errorBorder.Render(
-			errorColor.Render("Error!"),
+		errMessage := styling.ErrorBorder.Render(
+			styling.ErrorColor.Render("Error!"),
 			"\nAbility not found.\n\u2022 Perhaps a typo?\n\u2022 Missing a hyphen instead of a space?",
 		)
 		return structs.AbilityJSONStruct{}, "", fmt.Errorf("%s", errMessage)
@@ -70,15 +64,16 @@ func AbilityApiCall(endpoint string, abilityName string, baseURL string) (struct
 	return abilityStruct, abilityStruct.Name, nil
 }
 
+// PokemonApiCall function for calling the pokemon endpoint of the pokeAPI
 func PokemonApiCall(endpoint string, pokemonName string, baseURL string) (structs.PokemonJSONStruct, string, int, int, int, error) {
 	fullURL := baseURL + endpoint + "/" + pokemonName
 
 	var pokemonStruct structs.PokemonJSONStruct
 	err := ApiCallSetup(fullURL, &pokemonStruct, false)
 
 	if err != nil {
-		errMessage := errorBorder.Render(
-			errorColor.Render("Error!"),
+		errMessage := styling.ErrorBorder.Render(
+			styling.ErrorColor.Render("Error!"),
 			"\nPokémon not found.\n\u2022 Perhaps a typo?\n\u2022 Missing a hyphen instead of a space?",
 		)
 		return structs.PokemonJSONStruct{}, "", 0, 0, 0, fmt.Errorf("%s", errMessage)
@@ -87,19 +82,17 @@ func PokemonApiCall(endpoint string, pokemonName string, baseURL string) (struct
 	return pokemonStruct, pokemonStruct.Name, pokemonStruct.ID, pokemonStruct.Weight, pokemonStruct.Height, nil
 }
 
-func TypesApiCall(endpoint string, typesName string, baseURL string) (structs.TypesJSONStruct, string, int, error) {
+// TypesApiCall function for calling the type endpoint of the pokeAPI
+func TypesApiCall(endpoint string, typesName string, baseURL string) (structs.TypesJSONStruct, string, int) {
 	fullURL := baseURL + endpoint + "/" + typesName
 	var typesStruct structs.TypesJSONStruct
 
 	err := ApiCallSetup(fullURL, &typesStruct, false)
 
 	if err != nil {
-		errMessage := errorBorder.Render(
-			errorColor.Render("Error!"),
-			"\nType not found.\nPerhaps a typo?",
-		)
-		return structs.TypesJSONStruct{}, "", 0, fmt.Errorf("%s", errMessage)
+		fmt.Println(err)
+		return structs.TypesJSONStruct{}, "", 0
 	}
 
-	return typesStruct, typesStruct.Name, typesStruct.ID, nil
+	return typesStruct, typesStruct.Name, typesStruct.ID
 }

connections/connection_test.go

@@ -110,7 +110,7 @@ func TestTypesApiCall(t *testing.T) {
 	}))
 	defer ts.Close()
 
-	typesStruct, name, id, _ := TypesApiCall("/type", "electric", ts.URL)
+	typesStruct, name, id := TypesApiCall("/type", "electric", ts.URL)
 
 	assert.Equal(t, expectedTypes, typesStruct)
 	assert.Equal(t, "electric", name)

flags/version.go

@@ -8,17 +8,37 @@ import (
 	"net/http"
 	"net/url"
 	"os/exec"
+	"runtime"
 )
 
-func latestDockerImage(fullCommand string) {
-	cmd := exec.Command("bash", "-c", fullCommand)
+func latestDockerImage() {
+	var cmd *exec.Cmd
+
+	if runtime.GOOS == "windows" {
+		// Windows PowerShell equivalent
+		cmd = exec.Command("powershell", "-Command", `
+			$tags = Invoke-RestMethod -Uri "https://hub.docker.com/v2/repositories/digitalghostdev/poke-cli/tags/?page_size=1";
+			$tags.results[0].name
+		`)
+	} else {
+		// Check if curl is available
+		_, err := exec.LookPath("curl")
+		if err == nil {
+			// Use curl if available
+			cmd = exec.Command("sh", "-c", `curl -s https://hub.docker.com/v2/repositories/digitalghostdev/poke-cli/tags/?page_size=1 | grep -o '"name":"[^"]*"' | cut -d '"' -f 4`)
+		} else {
+			// Use wget as a fallback
+			cmd = exec.Command("sh", "-c", `wget -qO- https://hub.docker.com/v2/repositories/digitalghostdev/poke-cli/tags/?page_size=1 | grep -o '"name":"[^"]*"' | cut -d '"' -f 4`)
+		}
+	}
+
 	output, err := cmd.Output()
 	if err != nil {
-		fmt.Printf("error running command: %v\n", err)
+		fmt.Printf("Error running command: %v\n", err)
 		return
 	}
 
-	fmt.Print("Latest Docker image version: ", string(output))
+	fmt.Printf("Latest Docker image version: %s", string(output))
 }
 
 func latestRelease(githubAPIURL string) {
@@ -75,6 +95,6 @@ func latestRelease(githubAPIURL string) {
 
 func LatestFlag() {
 	// cmd := exec.Command("git", "describe", "--tags", "--abbrev=0")
-	latestDockerImage(`curl -s https://hub.docker.com/v2/repositories/digitalghostdev/poke-cli/tags/?page_size=1 | grep -o '"name":"[^"]*"' | cut -d '"' -f 4`)
+	latestDockerImage()
 	latestRelease("https://api.github.com/repos/digitalghost-dev/poke-cli/releases/latest")
 }

flags/version_test.go

@@ -7,6 +7,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"os"
+	"runtime"
 	"testing"
 )
 
@@ -35,15 +36,18 @@ func captureOutput(f func()) string {
 }
 
 func TestLatestDockerImage(t *testing.T) {
-	// Test normal execution with a valid command
-	validCommand := `curl -s https://hub.docker.com/v2/repositories/digitalghostdev/poke-cli/tags/?page_size=1 | grep -o '"name":"[^"]*"' | cut -d '"' -f 4`
-	output := captureOutput(func() { latestDockerImage(validCommand) })
+	output := captureOutput(func() { latestDockerImage() })
+
 	assert.Contains(t, output, "Latest Docker image version:")
 
-	// Test command failure with an invalid command
-	invalidCommand := "invalidcommand"
-	output = captureOutput(func() { latestDockerImage(invalidCommand) })
-	assert.Contains(t, output, "error running command:")
+	// Since the actual API response might change, avoid testing the exact version number.
+	// Instead, check if a non-empty version string is printed.
+
+	if runtime.GOOS == "windows" {
+		assert.Contains(t, output, "\n") // Ensure PowerShell prints something
+	} else {
+		assert.Contains(t, output, "\n") // Ensure bash prints something
+	}
 }
 
 func TestLatestRelease(t *testing.T) {