Merge pull request #1 from Craze1997/add-spaceship-provider

feat: add Spaceship DNS provider support

Author: tinyoverflow

docs/PARAMETERS.md

@@ -0,0 +1,47 @@
+# Plugin Parameters
+
+- [Retrievers](#retrievers)
+  - [ifconfigco](#ifconfigco)
+  - [unifi](#unifi)
+
+- [Providers](#providers)
+  - [hetzner_cloud](#hetzner_cloud)
+  - [spaceship](#spaceship)
+
+## Retrievers
+
+### `ifconfigco`
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `base_url` | `string` | No | "https://ifconfig.co" | API base URL |
+
+### `unifi`
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `base_url` | `string` | Yes |  | Unifi controller base URL (e.g. https://192.168.1.1) |
+| `api_token` | `string` | Yes |  | API authentication token |
+| `site_id` | `string` | No | "default" | Site ID |
+| `verify_tls` | `bool` | No | false | Enable TLS certificate verification |
+
+## Providers
+
+### `hetzner_cloud`
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `api_token` | `string` | Yes |  | Hetzner Cloud API token |
+| `zone` | `string` | Yes |  | DNS zone (e.g. homelab.com) |
+| `rr_name` | `string` | Yes |  | Resource record name (e.g. @) |
+
+### `spaceship`
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `api_key` | `string` | Yes |  | Spaceship API key |
+| `api_secret` | `string` | Yes |  | Spaceship API secret |
+| `domain` | `string` | Yes |  | The domain name (e.g. example.com) |
+| `subdomain` | `string` | Yes |  | The (sub)domain name |
+| `ttl` | `int` | No | 3600 | The TTL (Time to live) for the entry |
+

internal/plugins/provider_spaceship.go

@@ -0,0 +1,118 @@
+package plugins
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"goddns/internal/plugin"
+	"net/http"
+)
+
+type spaceshipConfig struct {
+	APIKey    string `json:"api_key"    required:"true" doc:"Spaceship API key"`
+	APISecret string `json:"api_secret" required:"true" doc:"Spaceship API secret"`
+	Domain    string `json:"domain"     required:"true" doc:"The domain name (e.g. example.com)"`
+	Subdomain string `json:"subdomain"       required:"true" doc:"The (sub)domain name"`
+	TTL       int    `json:"ttl"        default:"3600" doc:"The TTL (Time to live) for the entry"`
+}
+
+type spaceshipProvider struct {
+	apiKey    string
+	apiSecret string
+	subdomain string
+	domain    string
+	ttl       int
+}
+
+func init() {
+	plugin.RegisterProvider("spaceship", newSpaceshipFromConfig, spaceshipConfig{})
+}
+
+func newSpaceshipFromConfig(params map[string]any) (plugin.Provider, error) {
+	cfg, err := plugin.Decode[spaceshipConfig](params)
+	if err != nil {
+		return nil, fmt.Errorf("spaceship: %w", err)
+	}
+
+	if cfg.APIKey == "" {
+		return nil, fmt.Errorf("spaceship: api_key is required")
+	}
+	if cfg.APISecret == "" {
+		return nil, fmt.Errorf("spaceship: api_secret is required")
+	}
+	if cfg.Domain == "" {
+		return nil, fmt.Errorf("spaceship: domain is required")
+	}
+	if cfg.Subdomain == "" {
+		return nil, fmt.Errorf("spaceship: subdomain is required")
+	}
+	if cfg.TTL == 0 {
+		cfg.TTL = 3600
+	}
+
+	return spaceshipProvider{
+		apiKey:    cfg.APIKey,
+		apiSecret: cfg.APISecret,
+		domain:    cfg.Domain,
+		subdomain: cfg.Subdomain,
+		ttl:       cfg.TTL,
+	}, nil
+}
+
+func (p spaceshipProvider) SetIPAddress(ip string) error {
+	client := http.DefaultClient
+
+	reqData := struct {
+		Force bool `json:"force"`
+		Items []struct {
+			Type    string `json:"type"`
+			Name    string `json:"name"`
+			TTL     int    `json:"ttl"`
+			Address string `json:"address"`
+		} `json:"items"`
+	}{
+		Items: []struct {
+			Type    string `json:"type"`
+			Name    string `json:"name"`
+			TTL     int    `json:"ttl"`
+			Address string `json:"address"`
+		}{
+			{Type: "A", Name: p.subdomain, TTL: p.ttl, Address: ip},
+		},
+	}
+
+	reqDataBytes, err := json.Marshal(reqData)
+	if err != nil {
+		return err
+	}
+
+	url := fmt.Sprintf("https://spaceship.dev/api/v1/dns/records/%v", p.domain)
+	req, err := http.NewRequest(http.MethodPut, url, bytes.NewBuffer(reqDataBytes))
+	if err != nil {
+		return err
+	}
+
+	req.Header.Add("X-API-Key", p.apiKey)
+	req.Header.Add("X-API-Secret", p.apiSecret)
+	req.Header.Add("Content-Type", "application/json")
+
+	res, err := client.Do(req)
+	if err != nil {
+		return err
+	}
+
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusNoContent {
+		return fmt.Errorf("expected status 204, got %d", res.StatusCode)
+	}
+
+	var data map[string]any
+	if json.NewDecoder(res.Body).Decode(&data) != nil {
+		return err
+	}
+
+	return nil
+}
+
+var _ plugin.Provider = spaceshipProvider{}