Merge pull request #46 from jungaretti/porkbun-api-throttling

Throttle Porkbun API requests

Author: jungaretti

pkg/providers/porkbun/api/api.go

@@ -14,7 +14,8 @@ const (
 )
 
 type Api struct {
-	Auth Auth
+	Auth      Auth
+	Throttler Throttler
 }
 
 func (p Api) Ping() error {
@@ -24,6 +25,7 @@ func (p Api) Ping() error {
 	}
 
 	response := pingRes{}
+	p.Throttler.WaitForPermit()
 	err := makeRequest(PING, p.Auth, &response)
 	if err != nil {
 		return err
@@ -39,6 +41,7 @@ func (p Api) RetrieveRecords(domain string) ([]porkbun.Record, error) {
 	}
 
 	response := listRes{}
+	p.Throttler.WaitForPermit()
 	err := makeRequest(RETRIEVE+"/"+domain, p.Auth, &response)
 	if err != nil {
 		return nil, err
@@ -70,6 +73,7 @@ func (p Api) CreateRecord(domain string, toCreate porkbun.Record) (string, error
 	request.Name = trimDomain(toCreate.Name, domain)
 
 	response := createRes{}
+	p.Throttler.WaitForPermit()
 	err := makeRequest(CREATE+"/"+domain, request, &response)
 	if err != nil {
 		return "", err
@@ -80,6 +84,7 @@ func (p Api) CreateRecord(domain string, toCreate porkbun.Record) (string, error
 
 func (p Api) DeleteRecord(domain string, id string) error {
 	response := baseRes{}
+	p.Throttler.WaitForPermit()
 	err := makeRequest(DELETE+"/"+domain+"/"+id, p.Auth, &response)
 	if err != nil {
 		return err

pkg/providers/porkbun/api/throttle.go

@@ -0,0 +1,29 @@
+package api
+
+import (
+	"time"
+)
+
+type Throttler struct {
+	ticker *time.Ticker
+}
+
+func NewThrottler(ratePerSecond int) *Throttler {
+	interval := time.Second / time.Duration(ratePerSecond)
+	ticker := time.NewTicker(interval)
+
+	return &Throttler{
+		ticker: ticker,
+	}
+}
+
+// Waits for the next available permit.
+// Use this method to respect rate limits.
+func (t *Throttler) WaitForPermit() {
+	// Send a tick to 1 caller per interval
+	<-t.ticker.C
+}
+
+func (t *Throttler) Stop() {
+	t.ticker.Stop()
+}

pkg/providers/porkbun/porkbun.go

@@ -18,6 +18,7 @@ func NewPorkbunProvider(apiKey, secretApiKey string) dns.Provider {
 				ApiKey:       apiKey,
 				SecretApiKey: secretApiKey,
 			},
+			Throttler: *api.NewThrottler(1),
 		},
 	}
 }