feat: TransIP support (#274)

* feat: TransIP support

* style: make comments end with `.`

* style: make error compatible with staticcheck

Author: Tinyblargon

README.md

@@ -53,6 +53,7 @@
     - [OVH](#ovh)
     - [Dynu](#dynu)
     - [IONOS](#ionos)
+    - [TransIP](#transip)
   - [Notifications](#notifications)
     - [Email](#email)
     - [Telegram](#telegram)
@@ -110,6 +111,7 @@
 | [OVH][ovh]                            | :white_check_mark: | :white_check_mark: |        :x:         | :white_check_mark: |
 | [Dynu][dynu]                          | :white_check_mark: | :white_check_mark: |        :x:         | :white_check_mark: |
 | [IONOS][ionos]                          | :white_check_mark: | :white_check_mark: |        :x:         | :white_check_mark: |
+| [TransIP][transip]                    | :white_check_mark: | :white_check_mark: |        :x:         | :white_check_mark: |
 
 [cloudflare]: https://cloudflare.com
 [digitalocean]: https://digitalocean.com
@@ -130,6 +132,7 @@
 [ovh]: https://www.ovh.com
 [dynu]: https://www.dynu.com/
 [ionos]: https://www.ionos.com/
+[transip]: https://www.transip.net/
 
 Tip: You can follow this [issue](https://github.com/TimothyYe/godns/issues/76) to view the current status of DDNS for root domains.
 
@@ -863,6 +866,33 @@ socks5_proxy: ""
 
 </details>
 
+#### TransIP
+
+For TransIP, you need to provide your api private key as `login_token` and username as `email`, and configure all the domains & subdomains.
+
+<details>
+<summary>Example</summary>
+
+```yaml
+provider: TransIP
+email: account_name
+login_token: api_key
+domains:
+  - domain_name: example.com
+    sub_domains:
+      - "@"
+      - somesubdomain
+      - anothersubdomain
+resolver: 1.1.1.1
+ip_urls:
+  - https://api.ipify.org
+ip_type: IPv4
+interval: 300
+socks5_proxy: ""
+```
+
+<details>
+
 ### Notifications
 
 GoDNS can send a notification each time the IP changes.

go.mod

@@ -18,6 +18,7 @@ require (
 require (
 	github.com/fsnotify/fsnotify v1.8.0
 	github.com/gofiber/fiber/v2 v2.52.6
+	github.com/transip/gotransip/v6 v6.26.0
 )
 
 require (

go.sum

@@ -71,6 +71,8 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/transip/gotransip/v6 v6.26.0 h1:Aejfvh8rSp8Mj2GX/RpdBjMCv+Iy/DmgfNgczPDP550=
+github.com/transip/gotransip/v6 v6.26.0/go.mod h1:x0/RWGRK/zob817O3tfO2xhFoP1vu8YOHORx6Jpk80s=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
 github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
 github.com/valyala/fasthttp v1.51.0 h1:8b30A5JlZ6C7AS81RsWjYMQmrZG6feChmgAolCl1SqA=

internal/provider/factory.go

@@ -22,6 +22,7 @@ import (
 	"github.com/TimothyYe/godns/internal/provider/ovh"
 	"github.com/TimothyYe/godns/internal/provider/scaleway"
 	"github.com/TimothyYe/godns/internal/provider/strato"
+	"github.com/TimothyYe/godns/internal/provider/transip"
 	"github.com/TimothyYe/godns/internal/settings"
 	"github.com/TimothyYe/godns/internal/utils"
 )
@@ -68,6 +69,8 @@ func GetProvider(conf *settings.Settings) (IDNSProvider, error) {
 		provider = &dynu.DNSProvider{}
 	case utils.IONOS:
 		provider = &ionos.DNSProvider{}
+	case utils.TRANSIP:
+		provider = &transip.DNSProvider{}
 	default:
 		return nil, fmt.Errorf("Unknown provider '%s'", conf.Provider)
 	}

internal/provider/transip/transip_handler.go

@@ -0,0 +1,89 @@
+package transip
+
+import (
+	"strings"
+
+	"github.com/TimothyYe/godns/internal/settings"
+	"github.com/TimothyYe/godns/internal/utils"
+	log "github.com/sirupsen/logrus"
+	"github.com/transip/gotransip/v6"
+	"github.com/transip/gotransip/v6/domain"
+)
+
+const defaultTTL int = 60 // 60 seconds.
+
+// DNSProvider struct.
+type DNSProvider struct {
+	configuration *settings.Settings
+	clientConfig  gotransip.ClientConfiguration
+}
+
+// Init passes DNS settings and store it to the provider instance.
+func (provider *DNSProvider) Init(conf *settings.Settings) {
+	provider.configuration = conf
+	provider.clientConfig = gotransip.ClientConfiguration{
+		AccountName: conf.Email}
+	if strings.HasPrefix(conf.LoginToken, "-----BEGIN PRIVATE KEY-----") { // Private Key.
+		provider.clientConfig.PrivateKeyReader = strings.NewReader(conf.LoginToken)
+	} else { // JWT.
+		provider.clientConfig.Token = conf.LoginToken
+	}
+}
+
+// UpdateIP updates the IP address of the given subdomain.
+func (provider *DNSProvider) UpdateIP(domainName, subDomainName, ip string) error {
+	client, err := gotransip.NewClient(provider.clientConfig)
+	if err != nil {
+		return err
+	}
+	domainRepo := domain.Repository{Client: client}
+
+	exists, ttl, err := checkExistence(domainRepo, subDomainName, domainName)
+	if err != nil {
+		return err
+	}
+
+	if exists { // Update.
+		err = domainRepo.UpdateDNSEntry(domainName, domain.DNSEntry{
+			Name:    subDomainName,
+			Type:    provider.setType(),
+			Content: ip,
+			Expire:  ttl})
+		if err != nil {
+			log.Error("failed to update domain:", subDomainName)
+			return err
+		}
+	} else { // Create.
+		err = domainRepo.AddDNSEntry(domainName, domain.DNSEntry{
+			Name:    subDomainName,
+			Type:    provider.setType(),
+			Content: ip,
+			Expire:  defaultTTL})
+		if err != nil {
+			log.Error("failed to add domain:", subDomainName)
+			return err
+		}
+	}
+	return nil
+}
+
+func checkExistence(repo domain.Repository, subdomain, domainName string) (bool, int, error) {
+	records, err := repo.GetDNSEntries(domainName)
+	if err == nil {
+		for _, record := range records {
+			if record.Name == subdomain {
+				return true, record.Expire, nil
+			}
+		}
+	}
+	log.Error("failed to get domain:", domainName)
+	return false, defaultTTL, err
+}
+
+// defaults to A record (ipv4).
+func (provider *DNSProvider) setType() string {
+	if strings.ToUpper(provider.configuration.IPType) == utils.IPV6 {
+		return utils.IPTypeAAAA
+	}
+	return utils.IPTypeA
+}

internal/utils/constants.go

@@ -43,6 +43,8 @@ const (
 	OVH = "OVH"
 	// IONOS for IONOS.
 	IONOS = "IONOS"
+	// TransIP for TransIP.
+	TRANSIP = "TransIP"
 	// IPV4 for IPV4 mode.
 	IPV4 = "IPV4"
 	// IPV6 for IPV6 mode.

internal/utils/settings.go

@@ -101,6 +101,14 @@ func CheckSettings(config *settings.Settings) error {
 		if config.ConsumerKey == "" {
 			return errors.New("consumer key cannot be empty")
 		}
+	case TRANSIP:
+		if config.Email == "" {
+			return errors.New("email cannot be empty")
+		}
+		if config.LoginToken == "" {
+			return errors.New("login token cannot be empty")
+		}
+
 	default:
 		message := fmt.Sprintf("'%s' is not a supported DNS provider", config.Provider)
 		return errors.New(message)