SDK-88: Add edge_ips support for Spectrum (#431)

Author: patryk

spectrum.go

@@ -3,6 +3,8 @@ package cloudflare
 import (
 	"encoding/json"
 	"fmt"
+	"net"
+	"strings"
 	"time"
 
 	"github.com/pkg/errors"
@@ -48,6 +50,7 @@ type SpectrumApplication struct {
 	ProxyProtocol ProxyProtocol                 `json:"proxy_protocol,omitempty"`
 	TLS           string                        `json:"tls,omitempty"`
 	TrafficType   string                        `json:"traffic_type,omitempty"`
+	EdgeIPs       *EdgeIPs                      `json:"edge_ips,omitempty"`
 	CreatedOn     *time.Time                    `json:"created_on,omitempty"`
 	ModifiedOn    *time.Time                    `json:"modified_on,omitempty"`
 }
@@ -102,6 +105,43 @@ type SpectrumApplicationsDetailResponse struct {
 	Result []SpectrumApplication `json:"result"`
 }
 
+// EdgeIPs represents configuration for Bring-Your-Own-IP
+// https://developers.cloudflare.com/spectrum/getting-started/byoip/
+type EdgeIPs struct {
+	Type EdgeType `json:"type"`
+	IPs  []net.IP `json:"ips,omitempty"`
+}
+
+// EdgeType for possible Edge configurations
+type EdgeType string
+
+const (
+	// STATIC IP config
+	STATIC EdgeType = "static"
+)
+
+// UnmarshalJSON function for EdgeType enum
+func (t *EdgeType) UnmarshalJSON(b []byte) error {
+	var s string
+	err := json.Unmarshal(b, &s)
+	if err != nil {
+		return err
+	}
+
+	newEdgeType := EdgeType(strings.ToLower(s))
+	switch newEdgeType {
+	case STATIC:
+		*t = newEdgeType
+		return nil
+	}
+
+	return errors.New(errUnmarshalError)
+}
+
+func (t EdgeType) String() string {
+	return string(t)
+}
+
 // SpectrumApplications fetches all of the Spectrum applications for a zone.
 //
 // API reference: https://developers.cloudflare.com/spectrum/api-reference/#list-spectrum-applications

spectrum_test.go

@@ -2,6 +2,7 @@ package cloudflare
 
 import (
 	"fmt"
+	"net"
 	"net/http"
 	"testing"
 	"time"
@@ -400,3 +401,70 @@ func TestSpectrumApplicationProxyProtocolDeprecations(t *testing.T) {
 		teardown()
 	}
 }
+
+func TestSpectrumApplicationEdgeIPs(t *testing.T) {
+	setup()
+	defer teardown()
+
+	handler := func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, r.Method, "GET", "Expected method 'GET', got %s", r.Method)
+		w.Header().Set("content-type", "application/json")
+		fmt.Fprint(w, `{
+			"result": {
+				"id": "f68579455bd947efb65ffa1bcf33b52c",
+				"protocol": "tcp/22",
+				"ipv4": true,
+				"dns": {
+					"type": "CNAME",
+					"name": "spectrum.example.com"
+				},
+				"origin_direct": [
+					"tcp://192.0.2.1:22"
+				],
+				"ip_firewall": true,
+				"proxy_protocol": "off",
+				"tls": "off",
+				"edge_ips": {
+					"type": "static",
+					"ips": [
+						"192.0.2.1",
+						"2001:db8::1"
+					]
+				},
+				"created_on": "2018-03-28T21:25:55.643771Z",
+				"modified_on": "2018-03-28T21:25:55.643771Z"
+			},
+			"success": true,
+			"errors": [],
+			"messages": []
+		}`)
+	}
+
+	mux.HandleFunc("/zones/01a7362d577a6c3019a474fd6f485823/spectrum/apps/f68579455bd947efb65ffa1bcf33b52c", handler)
+	createdOn, _ := time.Parse(time.RFC3339, "2018-03-28T21:25:55.643771Z")
+	modifiedOn, _ := time.Parse(time.RFC3339, "2018-03-28T21:25:55.643771Z")
+	want := SpectrumApplication{
+		ID:         "f68579455bd947efb65ffa1bcf33b52c",
+		CreatedOn:  &createdOn,
+		ModifiedOn: &modifiedOn,
+		Protocol:   "tcp/22",
+		IPv4:       true,
+		DNS: SpectrumApplicationDNS{
+			Name: "spectrum.example.com",
+			Type: "CNAME",
+		},
+		OriginDirect:  []string{"tcp://192.0.2.1:22"},
+		IPFirewall:    true,
+		ProxyProtocol: "off",
+		TLS:           "off",
+		EdgeIPs: &EdgeIPs{
+			Type: STATIC,
+			IPs:  []net.IP{net.ParseIP("192.0.2.1"), net.ParseIP("2001:db8::1")},
+		},
+	}
+
+	actual, err := client.SpectrumApplication("01a7362d577a6c3019a474fd6f485823", "f68579455bd947efb65ffa1bcf33b52c")
+	if assert.NoError(t, err) {
+		assert.Equal(t, want, actual)
+	}
+}