feat: add toon formatting

Author: JammingBen

README.md

@@ -5,9 +5,9 @@ An OpenCloud CLI application that can be used by local AI assistants and agents
 ### Features
 
 - Seamless integration with local AI assistants and agents via skills.
-- Efficient agent token usage, especially compared to tools from MCP servers.
+- Efficient agent token usage thanks to TOON and skill reference data.
 - Fetching and managing OpenCloud resources.
-- Authentication with OpenCloud using OAuth2.
+- Authentication with OpenCloud using OIDC.
 - Single binary application for easy installation and usage.
 
 ### Requirements

cmd/opencloud-cli/api.go

@@ -15,6 +15,8 @@ var path string
 var method string
 var body string
 var verbose bool
+var statusOnly bool
+var jsonFormat bool
 
 var apiCmd = &cobra.Command{
 	Use:   "api",
@@ -55,8 +57,30 @@ var apiCmd = &cobra.Command{
 			return fmt.Errorf("error making request: %w", err)
 		}
 
+		// Set up encoder
+		encodingFormat := client.TOON
+		if jsonFormat {
+			encodingFormat = client.JSON
+		}
+		e := client.NewEncoder(encodingFormat)
+
 		// Print output
-		fmt.Println(resp)
+		if statusOnly {
+			output, err := e.EncodeStatusCode(resp.StatusCode)
+			if err != nil {
+				return fmt.Errorf("failed to encode status code: %w", err)
+			}
+
+			fmt.Println(output)
+			return nil
+		}
+
+		output, err := e.EncodeBody(resp.Body)
+		if err != nil {
+			return fmt.Errorf("failed to encode response body: %w", err)
+		}
+
+		fmt.Println(output)
 		return nil
 	},
 }
@@ -67,5 +91,7 @@ func init() {
 	apiCmd.Flags().StringVarP(&method, "method", "m", "GET", "HTTP method to use")
 	apiCmd.Flags().StringVarP(&body, "body", "b", "", "JSON body to send with the request")
 	apiCmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "Enable verbose output")
+	apiCmd.Flags().BoolVar(&statusOnly, "status-only", false, "Only return the status code")
+	apiCmd.Flags().BoolVar(&jsonFormat, "json-format", false, "Encode the output in JSON format")
 	apiCmd.MarkFlagRequired("path")
 }

go.mod

@@ -3,6 +3,7 @@ module github.com/JammingBen/opencloud-skill-cli
 go 1.25.0
 
 require (
+	github.com/alpkeskin/gotoon v0.1.1
 	github.com/fatih/color v1.18.0
 	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
 	github.com/spf13/cobra v1.10.2

go.sum

@@ -1,3 +1,5 @@
+github.com/alpkeskin/gotoon v0.1.1 h1:GQOVwMfWKINnfEA6slrXHJaJYDwnUFmrPlXOtnuja1w=
+github.com/alpkeskin/gotoon v0.1.1/go.mod h1:XRTz8RM4tz8M2nB37MNRN8rHF4YgeYd8nIXmoU0B0+M=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
 github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=

internal/client/client.go

@@ -3,7 +3,6 @@ package client
 import (
 	"bytes"
 	"crypto/tls"
-	"encoding/json"
 	"fmt"
 	"io"
 	"log/slog"
@@ -19,6 +18,11 @@ type Client struct {
 	tokenSource oauth2.TokenSource
 }
 
+type Response struct {
+	StatusCode int
+	Body       string
+}
+
 func NewClient(baseURL string, insecure bool, ts oauth2.TokenSource) *Client {
 	return &Client{
 		baseURL:     baseURL,
@@ -27,16 +31,16 @@ func NewClient(baseURL string, insecure bool, ts oauth2.TokenSource) *Client {
 	}
 }
 
-// MakeRequest makes an HTTP request to the specified URL with the given method and returns the response
-func (c *Client) MakeRequest(path string, method string, body string) (string, error) {
+// MakeRequest makes an HTTP request to the specified URL with the given method and body and returns the response
+func (c *Client) MakeRequest(path string, method string, body string) (*Response, error) {
 	fullURL, err := url.JoinPath(c.baseURL, "graph", path)
 	if err != nil {
-		return "", fmt.Errorf("failed to join path: %w", err)
+		return nil, fmt.Errorf("failed to join path: %w", err)
 	}
 
 	req, err := http.NewRequest(method, fullURL, nil)
 	if err != nil {
-		return "", fmt.Errorf("failed to create request: %w", err)
+		return nil, fmt.Errorf("failed to create request: %w", err)
 	}
 
 	// Set up http transport
@@ -48,7 +52,7 @@ func (c *Client) MakeRequest(path string, method string, body string) (string, e
 	if c.tokenSource != nil {
 		token, err := c.tokenSource.Token()
 		if err != nil {
-			return "", fmt.Errorf("failed to get token: %w", err)
+			return nil, fmt.Errorf("failed to get token: %w", err)
 		}
 		req.Header.Set("Authorization", "Bearer "+token.AccessToken)
 	}
@@ -65,36 +69,39 @@ func (c *Client) MakeRequest(path string, method string, body string) (string, e
 	client := &http.Client{Transport: tr}
 	resp, err := client.Do(req)
 	if err != nil {
-		return "", fmt.Errorf("failed to execute request: %w", err)
+		return nil, fmt.Errorf("failed to execute request: %w", err)
 	}
 
 	slog.Debug("Received response", "status", resp.StatusCode)
 
-	// Read and return response body
+	if resp.StatusCode >= 400 {
+		return nil, fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+
 	return readBody(resp)
 }
 
-// readBody reads the response body and returns it as a string.
-// It also checks for HTTP errors and returns an error if the status code is 400 or above.
-func readBody(resp *http.Response) (string, error) {
+// readBody reads the response and returns a Response struct containing the status code and body as a string
+func readBody(resp *http.Response) (*Response, error) {
 	defer resp.Body.Close()
 
-	if resp.StatusCode >= 400 {
-		return "", fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	r := &Response{
+		StatusCode: resp.StatusCode,
 	}
 
 	if resp.Body == nil {
-		return "", nil
+		return r, nil
 	}
 
 	bodyBytes, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return "", fmt.Errorf("failed to read response body: %w", err)
+		return r, fmt.Errorf("failed to read response body: %w", err)
 	}
-	dst := &bytes.Buffer{}
-	if err := json.Indent(dst, bodyBytes, "", "  "); err != nil {
-		return "", err
+
+	if len(bodyBytes) == 0 {
+		return r, nil
 	}
 
-	return dst.String(), nil
+	r.Body = string(bodyBytes)
+	return r, nil
 }

internal/client/encoder.go

@@ -0,0 +1,73 @@
+package client
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/alpkeskin/gotoon"
+)
+
+type Format int
+
+const (
+	TOON Format = iota
+	JSON
+)
+
+// Encoder is responsible for encoding the response body and status code in the specified format (TOON or JSON)
+type Encoder struct {
+	format Format
+}
+
+func NewEncoder(format Format) *Encoder {
+	return &Encoder{format: format}
+}
+
+// EncodeBody encodes the response body in the specified format (TOON or JSON)
+func (e *Encoder) EncodeBody(body string) (string, error) {
+	var data any
+	if err := json.Unmarshal([]byte(body), &data); err != nil {
+		return "", fmt.Errorf("failed to unmarshal response body: %w", err)
+	}
+
+	switch e.format {
+	case JSON:
+		encoded, err := json.MarshalIndent(data, "", "  ")
+		if err != nil {
+			return "", fmt.Errorf("failed to marshal response body: %w", err)
+		}
+		return string(encoded), nil
+	case TOON:
+		encoded, err := gotoon.Encode(data)
+		if err != nil {
+			return "", fmt.Errorf("failed to encode response body: %w", err)
+		}
+
+		return encoded, nil
+	default:
+		return "", fmt.Errorf("unsupported format: %d", e.format)
+	}
+}
+
+// EncodeStatusCode encodes only the status code in the specified format (TOON or JSON)
+func (e *Encoder) EncodeStatusCode(statusCode int) (string, error) {
+	output := map[string]int{"status": statusCode}
+
+	switch e.format {
+	case JSON:
+		encoded, err := json.MarshalIndent(output, "", "  ")
+		if err != nil {
+			return "", fmt.Errorf("failed to marshal status code: %w", err)
+		}
+		return string(encoded), nil
+	case TOON:
+		encoded, err := gotoon.Encode(output)
+		if err != nil {
+			return "", fmt.Errorf("failed to encode status code: %w", err)
+		}
+
+		return encoded, nil
+	default:
+		return "", fmt.Errorf("unsupported format: %d", e.format)
+	}
+}

skills/opencloud-cli/SKILL.md

@@ -7,7 +7,7 @@ description: 'Manage files, folders and spaces of an OpenCloud server using the
 
 ## How to Use This Skill
 
-Use the `oc-cli` command to interact with the OpenCloud CLI. The `references` directory contains detailed documentation for all available resources and operations.
+Use the `oc-cli` command to interact with the OpenCloud CLI. The `references` directory contains detailed documentation for all available resources and operations. Responses get returned in TOON format.
 
 ### Examples
 
@@ -21,7 +21,7 @@ oc-cli api --help
 # examples
 oc-cli api -p /v1beta1/me/drives -m GET # list all my drives
 oc-cli api -p /v1.0/drives/90eedea1-dea1-90ee-a1de-ee90a1deee90 -m GET # get a drive by its id
-oc-cli api -p /v1.0/drives/90eedea1-dea1-90ee-a1de-ee90a1deee90 -m PATCH -b '{"name": "New Drive Name"}' # update a drive
+oc-cli api -p /v1.0/drives/90eedea1-dea1-90ee-a1de-ee90a1deee90 -m PATCH -b '{"name": "New Drive Name"}' --status-only # update a drive
 
 ```
 
@@ -76,3 +76,4 @@ references/
 ## General tips
 
 - prefer the `v1beta1` endpoints over the `v1.0` endpoints
+- use the `--status-only` flag when the response body is not needed, e.g. for update and delete operations