Add godoc examples

README.md

@@ -34,37 +34,38 @@ Assuming that the server is listening on http://localhost:80 for virtual host `l
 ### Get/add/change/delete zones
 
 ```go
-zones, err := pdns.Zones.List(context.Background())
-zone, err := pdns.Zones.Get(context.Background(), "example.com")
-export, err := pdns.Zones.Export(context.Background(), "example.com")
-zone, err := pdns.Zones.AddNative(context.Background(), "example.com", true, "", false, "foo", "foo", true, []string{"ns.foo.tld."})
-zone, err := pdns.Zones.Add(context.Background(), &powerdns.Zone{})
-err := pdns.Zones.Change(context.Background(), "example.com", &zone)
-err := pdns.Zones.Delete(context.Background(), "example.com")
+ctx := context.Background()
+
+zones, err := pdns.Zones.List(ctx)
+zone, err := pdns.Zones.Get(ctx, "example.com")
+export, err := pdns.Zones.Export(ctx, "example.com")
+zone, err := pdns.Zones.AddNative(ctx, "example.com", true, "", false, "foo", "foo", true, []string{"ns.foo.tld."})
+err := pdns.Zones.Change(ctx, "example.com", &zone)
+err := pdns.Zones.Delete(ctx, "example.com")
 ```
 
 ### Add/change/delete resource records
 
 ```go
-err := pdns.Records.Add(context.Background(), "example.com", "www.example.com", powerdns.RRTypeAAAA, 60, []string{"::1"})
-err := pdns.Records.Change(context.Background(), "example.com", "www.example.com", powerdns.RRTypeAAAA, 3600, []string{"::1"})
-err := pdns.Records.Delete(context.Background(), "example.com", "www.example.com", powerdns.RRTypeA)
+err := pdns.Records.Add(ctx, "example.com", "www.example.com", powerdns.RRTypeAAAA, 60, []string{"::1"})
+err := pdns.Records.Change(ctx, "example.com", "www.example.com", powerdns.RRTypeAAAA, 3600, []string{"::1"})
+err := pdns.Records.Delete(ctx, "example.com", "www.example.com", powerdns.RRTypeA)
 ```
 
 ### Request server information and statistics
 
 ```go
-statistics, err := pdns.Statistics.List(context.Background())
-servers, err := pdns.Servers.List(context.Background())
-server, err := pdns.Servers.Get(context.Background(), "localhost")
+statistics, err := pdns.Statistics.List(ctx)
+servers, err := pdns.Servers.List(ctx)
+server, err := pdns.Servers.Get(ctx, "localhost")
 ```
 
 ### Handle DNSSEC cryptographic material
 
 ```go
-cryptokeys, err := pdns.Cryptokeys.List(context.Background())
-cryptokey, err := pdns.Cryptokeys.Get(context.Background(), "example.com", "1337")
-err := pdns.Cryptokeys.Delete(context.Background(), "example.com", "1337")
+cryptokeys, err := pdns.Cryptokeys.List(ctx)
+cryptokey, err := pdns.Cryptokeys.Get(ctx, "example.com", "1337")
+err := pdns.Cryptokeys.Delete(ctx, "example.com", "1337")
 ```
 
 ### More examples

examples/zone-operations/main.go

@@ -13,34 +13,35 @@ import (
 
 func main() {
 	rand.Seed(time.Now().UnixNano())
-	domain := fmt.Sprintf("test-%d.com.", rand.Int())
 
+	domain := fmt.Sprintf("%d.example.com.", rand.Int())
 	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
 
 	// Create a native zone
-	zone, err := pdns.Zones.AddNative(context.Background(), domain, false, "", false, "", "", true, []string{"localhost."})
+	zone, err := pdns.Zones.AddNative(ctx, domain, false, "", false, "", "", true, []string{"localhost."})
 	if err != nil {
 		log.Fatalf("%v", err)
 	}
 
 	o, _ := json.MarshalIndent(zone, "", "\t")
-	fmt.Printf("zone: %s\n\n", o)
+	log.Printf("Zone: %s\n\n", o)
 
 	// Add and change an A record
-	if err := pdns.Records.Add(context.Background(), domain, fmt.Sprintf("www.%s", domain), powerdns.RRTypeA, 1337, []string{"127.0.0.9"}); err != nil {
+	if err := pdns.Records.Add(ctx, domain, fmt.Sprintf("www.%s", domain), powerdns.RRTypeA, 1337, []string{"127.0.0.9"}); err != nil {
 		log.Fatalf("%v", err)
 	}
-	if err := pdns.Records.Change(context.Background(), domain, fmt.Sprintf("www.%s", domain), powerdns.RRTypeA, 42, []string{"127.0.0.10"}); err != nil {
+	if err := pdns.Records.Change(ctx, domain, fmt.Sprintf("www.%s", domain), powerdns.RRTypeA, 42, []string{"127.0.0.10"}); err != nil {
 		log.Fatalf("%v", err)
 	}
 
 	// Add a MX record with multiple values
-	if err := pdns.Records.Add(context.Background(), domain, domain, powerdns.RRTypeMX, 1337, []string{"10 mx1.example.com.", "20 mx2.example.com."}); err != nil {
+	if err := pdns.Records.Add(ctx, domain, domain, powerdns.RRTypeMX, 1337, []string{"10 mx1.example.com.", "20 mx2.example.com."}); err != nil {
 		log.Fatalf("%v", err)
 	}
 
 	// Add a TXT record
-	if err := pdns.Records.Add(context.Background(), domain, fmt.Sprintf("www.%s", domain), powerdns.RRTypeTXT, 1337, []string{"\"foo1\""}); err != nil {
+	if err := pdns.Records.Add(ctx, domain, fmt.Sprintf("www.%s", domain), powerdns.RRTypeTXT, 1337, []string{"\"foo1\""}); err != nil {
 		log.Fatalf("%v", err)
 	}
 
@@ -50,18 +51,17 @@ func main() {
 		DNSsec:  powerdns.Bool(true),
 	}
 
-	err = pdns.Zones.Change(context.Background(), domain, zoneChangeSet)
-	if err != nil {
+	if err := pdns.Zones.Change(ctx, domain, zoneChangeSet); err != nil {
 		log.Fatalf("%v", err)
 	}
 
 	// Retrieve zone attributes
-	changedZone, err := pdns.Zones.Get(context.Background(), domain)
+	changedZone, err := pdns.Zones.Get(ctx, domain)
 	if err != nil {
 		log.Fatalf("%v", err)
 	}
 
 	o, _ = json.MarshalIndent(changedZone, "", "\t")
-	fmt.Printf("changed zone: %s\n\n", o)
-	fmt.Printf("Account is \"%s\" and DNSsec is %t\n\n", powerdns.StringValue(changedZone.Account), powerdns.BoolValue(changedZone.DNSsec))
+	log.Printf("Changed zone: %q\n\n", o)
+	log.Printf("Account is %q and DNSsec is %t\n\n", powerdns.StringValue(changedZone.Account), powerdns.BoolValue(changedZone.DNSsec))
 }

powerdns_integration_test.go

@@ -0,0 +1,9 @@
+package powerdns_test
+
+import (
+	"github.com/joeig/go-powerdns/v3"
+)
+
+func ExampleNewClient() {
+	_ = powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+}

powerdns_test.go

@@ -35,7 +35,6 @@ func initialisePowerDNSTestClient() *Client {
 }
 
 func registerDoMockResponder() {
-
 	httpmock.RegisterResponder("GET", fmt.Sprintf("%s/servers/doesntExist", generateTestAPIURL()),
 		func(req *http.Request) (*http.Response, error) {
 			if res := verifyAPIKey(req); res != nil {

records_integration_test.go

@@ -0,0 +1,44 @@
+package powerdns_test
+
+import (
+	"context"
+	"log"
+
+	"github.com/joeig/go-powerdns/v3"
+)
+
+func ExampleRecordsService_Add_basic() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+
+	if err := pdns.Records.Add(ctx, "example.com.", "www.example.com.", powerdns.RRTypeA, 1337, []string{"127.0.0.9"}); err != nil {
+		log.Fatalf("%v", err)
+	}
+}
+
+func ExampleRecordsService_Add_mX() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+
+	if err := pdns.Records.Add(ctx, "example.com.", "www.example.com.", powerdns.RRTypeMX, 1337, []string{"10 mx1.example.com.", "20 mx2.example.com."}); err != nil {
+		log.Fatalf("%v", err)
+	}
+}
+
+func ExampleRecordsService_Add_tXT() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+
+	if err := pdns.Records.Add(ctx, "example.com.", "www.example.com.", powerdns.RRTypeTXT, 1337, []string{"\"foo1\""}); err != nil {
+		log.Fatalf("%v", err)
+	}
+}
+
+func ExampleRecordsService_Change() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+
+	if err := pdns.Records.Change(ctx, "example.com.", "www.example.com.", powerdns.RRTypeA, 42, []string{"127.0.0.10"}); err != nil {
+		log.Fatalf("%v", err)
+	}
+}

zones_integration_test.go

@@ -0,0 +1,45 @@
+package powerdns_test
+
+import (
+	"context"
+	"log"
+
+	"github.com/joeig/go-powerdns/v3"
+)
+
+func ExampleZonesService_AddNative() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+
+	zone, err := pdns.Zones.AddNative(ctx, "example.com.", false, "", false, "", "", true, []string{"localhost."})
+	if err != nil {
+		log.Fatalf("%v", err)
+	}
+
+	log.Printf("Zone: %v", zone)
+}
+
+func ExampleZonesService_Change() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+	zoneChangeSet := &powerdns.Zone{
+		Account: powerdns.String("test"),
+		DNSsec:  powerdns.Bool(true),
+	}
+
+	if err := pdns.Zones.Change(ctx, "example.com.", zoneChangeSet); err != nil {
+		log.Fatalf("%v", err)
+	}
+}
+
+func ExampleZonesService_Get() {
+	pdns := powerdns.NewClient("http://localhost:8080", "localhost", map[string]string{"X-API-Key": "apipw"}, nil)
+	ctx := context.Background()
+
+	zone, err := pdns.Zones.Get(ctx, "example.com.")
+	if err != nil {
+		log.Fatalf("%v", err)
+	}
+
+	log.Printf("Zone: %v", zone)
+}