Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

Commit

Permalink
Merge pull request #111 from arnested/punktum.dk
Browse files Browse the repository at this point in the history
Changed DK Hostmaster to Punktum.dk
  • Loading branch information
arnested authored Dec 16, 2023
2 parents 6bbd13b + c206d7a commit 4c77c16
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Go library for updating DS records with DK Hostmasters proprietary DS Update protocol
# Go library for updating DS records with Punktum.dk's proprietary DS Update protocol

[![Codecov](https://codecov.io/gh/arnested/dsupdate/branch/main/graph/badge.svg)](https://codecov.io/gh/arnested/dsupdate)
[![CLA assistant](https://cla-assistant.io/readme/badge/arnested/dsupdate)](https://cla-assistant.io/arnested/dsupdate)
Expand All @@ -8,15 +8,15 @@
import "arnested.dk/go/dsupdate"
```

Package dsupdate is a library for updating DS records with DK
Hostmasters proprietary DS Update protocol.
Package dsupdate is a library for updating DS records with
Punktum.dk's (DK Hostmasters) proprietary DS Update protocol.

DS Update is a proprietary protocol and service developed and offered
by DK Hostmaster as an interface for updating DNSSEC related DS
records associated with a .dk domain name.
by Punktum as an interface for updating DNSSEC related DS records
associated with a .dk domain name.

The service and protocol is documented at
<https://github.com/DK-Hostmaster/dsu-service-specification>.
<https://github.com/Punktum-dk/dsu-service-specification>.

This package has functionality to update or delete DS records using
the DS Update protocol.
Expand Down
2 changes: 1 addition & 1 deletion README.md.template
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Go library for updating DS records with DK Hostmasters proprietary DS Update protocol
# Go library for updating DS records with Punktum.dk's proprietary DS Update protocol

[![Codecov](https://codecov.io/gh/arnested/dsupdate/branch/main/graph/badge.svg)](https://codecov.io/gh/arnested/dsupdate)
[![CLA assistant](https://cla-assistant.io/readme/badge/arnested/dsupdate)](https://cla-assistant.io/arnested/dsupdate)
Expand Down
10 changes: 5 additions & 5 deletions doc.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/*
Package dsupdate is a library for updating DS records with DK
Hostmasters proprietary DS Update protocol.
Package dsupdate is a library for updating DS records with
Punktum.dk's (DK Hostmasters) proprietary DS Update protocol.
DS Update is a proprietary protocol and service developed and offered
by DK Hostmaster as an interface for updating DNSSEC related DS
records associated with a .dk domain name.
by Punktum as an interface for updating DNSSEC related DS records
associated with a .dk domain name.
The service and protocol is documented at
<https://github.com/DK-Hostmaster/dsu-service-specification>.
<https://github.com/Punktum-dk/dsu-service-specification>.
This package has functionality to update or delete DS records using
the DS Update protocol.
Expand Down
10 changes: 5 additions & 5 deletions dsupdate.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import (
// BaseURL is the endpoint of the DS Update service.
type BaseURL string

// DK Hostmasters environments are predefined as constants.
// Punktum.dk's environments are predefined as constants.
const (
// Production environment of DK Hostmasters DSU service.
// Production environment of Punktum.dk's DSU service.
Production BaseURL = "https://dsu.dk-hostmaster.dk/1.0"
// Sandbox environment of DK Hostmasters DSU service.
// Sandbox environment of Punktum.dk's DSU service.
Sandbox BaseURL = "https://dsu-sandbox.dk-hostmaster.dk/1.0"
)

Expand All @@ -38,8 +38,8 @@ type DsRecord struct {
//nolint:lll
type Client struct {
Domain string // .dk domain name, i.e eksempel.dk
UserID string // DK Hostmaster user ID, i.e. ABCD1234-DK
Password string // DK Hostmater password
UserID string // Punktum.dk user ID, i.e. ABCD1234-DK
Password string // Punktum.dk password
BaseURL BaseURL // DS Update service base URL. You can use constants dsupdate.Production (default) or dsupdate.Sandbox
HTTPClient *http.Client
}
Expand Down
16 changes: 8 additions & 8 deletions example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ func Example_update() {
// Create a client with some fake credentials.
client := dsupdate.Client{
Domain: "eksempel.dk", // .dk domain name
UserID: "ABCD1234-DK", // DK Hostmaster user ID
Password: "abba4evah", // DK Hostmaster password
UserID: "ABCD1234-DK", // Punktum.dk user ID
Password: "abba4evah", // Punktum.dk password
BaseURL: dsupdate.Sandbox, // If left out defaults to dsupdate.Production
HTTPClient: &http.Client{
Timeout: 5 * time.Second,
Expand All @@ -39,7 +39,7 @@ func Example_update() {

ctx := context.Background()

// Post the new DS record(s) to DK Hostmaster.
// Post the new DS record(s) to Punktum.dk.
resp, err := client.Update(ctx, records)

// If the update failed and a substatus was returned in the
Expand All @@ -62,7 +62,7 @@ func Example_update() {
// If there was no error returned the update succeeded. `resp`
// will be the body of whatever was returned from the DS
// Update service ("Request sent to DSU::Version_1_0 okay").
fmt.Printf("Succeeded. DK Hostmaster responded with the message in the body: %s", resp)
fmt.Printf("Succeeded. Punktum.dk responded with the message in the body: %s", resp)
}

// This example deletes existing DS records of the eksempel.dk
Expand All @@ -74,8 +74,8 @@ func Example_delete() {
// Create a client with some fake credentials.
client := dsupdate.Client{
Domain: "eksempel.dk", // .dk domain name
UserID: "ABCD1234-DK", // DK Hostmaster user ID
Password: "abba4evah", // DK Hostmaster password
UserID: "ABCD1234-DK", // Punktum.dk user ID
Password: "abba4evah", // Punktum.dk password
BaseURL: dsupdate.Sandbox, // If left out defaults to dsupdate.Production
HTTPClient: &http.Client{}, // If left out defaults to http.DefaultClient
}
Expand All @@ -85,7 +85,7 @@ func Example_delete() {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()

// Delete the DS record(s) to DK Hostmaster.
// Delete the DS record(s) to Punktum.dk.
resp, err := client.Delete(ctx)

// If the update failed and a substatus was returned in the
Expand All @@ -108,5 +108,5 @@ func Example_delete() {
// If there was no error returned the delete succeeded. `resp`
// will be the body of whatever was returned from the DS
// Update service.
fmt.Printf("Succeeded. DK Hostmaster responded with the message in the body: %s", resp)
fmt.Printf("Succeeded. Punktum.dk responded with the message in the body: %s", resp)
}

0 comments on commit 4c77c16

Please sign in to comment.