Merge branch 'storm-server-api' into 'master'

Storm server api

See merge request masre/liquidweb-go!10

Author: Caige Nichols

.gitlab-ci.yml

@@ -1,13 +1,6 @@
 stages:
   - build
 
-variables:
-  DOCKER_HOST: tcp://docker:2375/
-  DOCKER_DRIVER: overlay2
-
-services:
-  - docker:dind
-
 build:
   tags:
     - docker-with-registry

Makefile

@@ -3,3 +3,6 @@ build:
 
 vet:
 	go vet
+
+test:
+	go test ./...

client/client.go

@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"crypto/tls"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -93,78 +92,32 @@ func NewClient(config *Config) *Client {
 //	if gotErr != nil {
 //		panic(gotErr)
 //	}
-func (client *Client) Call(method string, params interface{}) (interface{}, error) {
+func (client *Client) Call(method string, params interface{}, into interface{}) error {
 	bsRb, err := client.CallRaw(method, params)
 	if err != nil {
-		return nil, err
+		return err
 	}
 
-	// json decode into interface
-	var decodedResp interface{}
-	if jsonDecodeErr := json.Unmarshal(bsRb, &decodedResp); jsonDecodeErr != nil {
-		return nil, jsonDecodeErr
-	}
-	mapDecodedResp, ok := decodedResp.(map[string]interface{})
-	if !ok {
-		return nil, errors.New("endpoint did not return the expected JSON structure")
+	var raw map[string]interface{}
+	if err = json.Unmarshal(bsRb, &raw); err != nil {
+		return err
 	}
-	errorClass, ok := mapDecodedResp["error_class"]
+	errorClass, ok := raw["error_class"]
 	if ok {
 		errorClassStr := errorClass.(string)
 		if errorClassStr != "" {
-			return nil, liquidweb.LWAPIError{
+			return liquidweb.LWAPIError{
 				ErrorClass:   errorClassStr,
-				ErrorFullMsg: mapDecodedResp["full_message"].(string),
-				ErrorMsg:     mapDecodedResp["error"].(string),
+				ErrorFullMsg: raw["full_message"].(string),
+				ErrorMsg:     raw["error"].(string),
 			}
 		}
 	}
-	// no LW errors so return the decoded response
-	return decodedResp, nil
-}
 
-// CallInto is like call, but instead of returning an interface you pass it a
-// struct which is filled, much like the json.Unmarshal function.  The struct
-// you pass must satisfy the LWAPIRes interface.  If you embed the LWAPIError
-// struct from this package into your struct, this will be taken care of for you.
-//
-// Example:
-//	type ZoneDetails struct {
-//		lwApi.LWAPIError
-//		AvlZone     string   `json:"availability_zone"`
-//		Desc        string   `json:"description"`
-//		GatewayDevs []string `json:"gateway_devices"`
-//		HvType      string   `json:"hv_type"`
-//		ID          int      `json:"id"`
-//		Legacy      int      `json:"legacy"`
-//		Name        string   `json:"name"`
-//		Status      string   `json:"status"`
-//		SourceHVs   []string `json:"valid_source_hvs"`
-//	}
-//	var zone ZoneDetails
-//	err = apiClient.CallInto("network/zone/details", paramers, &zone)
-//	if err != nil {
-//		log.Fatal(err)
-//	}
-//	fmt.Printf("Got struct %#v\n", zone)
-//
-func (client *Client) CallInto(method string, params interface{}, into liquidweb.LWAPIRes) error {
-	bsRb, err := client.CallRaw(method, params)
-	if err != nil {
+	// Response should be valid, decode it.
+	if err = json.Unmarshal(bsRb, &into); err != nil {
 		return err
 	}
-
-	err = json.Unmarshal(bsRb, into)
-	if err != nil {
-		return err
-	}
-
-	if into.HasError() {
-		// the LWAPIRes satisfies the Error interface, so we can just return it on
-		// error.
-		return into
-	}
-
 	return nil
 }
 

liquidweb.go

@@ -8,12 +8,11 @@ import (
 
 // Backend is an interface for calls against Liquid Web's API.
 type Backend interface {
-	Call(string, interface{}) (interface{}, error)
-	CallInto(string, interface{}, LWAPIRes) error
+	Call(string, interface{}, interface{}) error
 	CallRaw(string, interface{}) ([]byte, error)
 }
 
-// LWAPIRes is a convenient interface used (for example) by CallInto to ensure a passed
+// LWAPIRes is a convenient interface used (for example) by Call to ensure a passed
 // struct knows how to indicate whether or not it had an error.
 type LWAPIRes interface {
 	Error() string

network/dns.go

@@ -68,19 +68,11 @@ type DNSRecord struct {
 
 // DNSRecordList is an envelope for the API result containing either a list of DNS Records or an error.
 type DNSRecordList struct {
-	liquidweb.LWAPIError
 	liquidweb.ListMeta
 	Items []DNSRecord `json:"items,omitempty"`
 }
 
-// DNSRecordItem is an envelope for the API result containing either a DNS Record or an error.
-type DNSRecordItem struct {
-	liquidweb.LWAPIError
-	DNSRecord
-}
-
 // DNSRecordDeletion represents the API result when deleting a DNS Record.
 type DNSRecordDeletion struct {
-	liquidweb.LWAPIError
-	Deleted int `json:"deleted"`
+	Deleted types.FlexInt `json:"deleted"`
 }

network/dns_client.go

@@ -6,11 +6,11 @@ import (
 
 // DNSBackend describes the interface for interactions with the API.
 type DNSBackend interface {
-	Create(*DNSRecordParams) (*DNSRecordItem, error)
-	Details(int) *DNSRecordItem
-	List(*DNSRecordParams) *DNSRecordList
-	Update(*DNSRecordParams) *DNSRecordItem
-	Delete(*DNSRecordParams) *DNSRecordDeletion
+	Create(*DNSRecordParams) (*DNSRecord, error)
+	Details(int) (*DNSRecord, error)
+	List(*DNSRecordParams) (*DNSRecordList, error)
+	Update(*DNSRecordParams) (*DNSRecord, error)
+	Delete(*DNSRecordParams) (*DNSRecordDeletion, error)
 }
 
 // DNSClient is the backend implementation for interacting with DNS Records.
@@ -19,9 +19,9 @@ type DNSClient struct {
 }
 
 // Create creates a new DNS Record.
-func (c *DNSClient) Create(params *DNSRecordParams) (*DNSRecordItem, error) {
-	var result DNSRecordItem
-	err := c.Backend.CallInto("v1/Network/DNS/Record/create", params, &result)
+func (c *DNSClient) Create(params *DNSRecordParams) (*DNSRecord, error) {
+	var result DNSRecord
+	err := c.Backend.Call("v1/Network/DNS/Record/create", params, &result)
 	if err != nil {
 		return nil, err
 	}
@@ -30,35 +30,44 @@ func (c *DNSClient) Create(params *DNSRecordParams) (*DNSRecordItem, error) {
 }
 
 // Details returns details about a DNS Record.
-func (c *DNSClient) Details(id int) *DNSRecordItem {
-	var result DNSRecordItem
+func (c *DNSClient) Details(id int) (*DNSRecord, error) {
+	var result DNSRecord
 	params := DNSRecordParams{ID: id}
 
-	c.Backend.CallInto("v1/Network/DNS/Record/details", params, &result)
-
-	return &result
+	err := c.Backend.Call("v1/Network/DNS/Record/details", params, &result)
+	if err != nil {
+		return nil, err
+	}
+	return &result, nil
 }
 
 // List returns a list of DNS Records.
-func (c *DNSClient) List(params *DNSRecordParams) *DNSRecordList {
+func (c *DNSClient) List(params *DNSRecordParams) (*DNSRecordList, error) {
 	list := &DNSRecordList{}
 
-	c.Backend.CallInto("v1/Network/DNS/Record/list", params, list)
-	return list
+	err := c.Backend.Call("v1/Network/DNS/Record/list", params, list)
+	if err != nil {
+		return nil, err
+	}
+	return list, nil
 }
 
 // Update will update a DNS Record.
-func (c *DNSClient) Update(params *DNSRecordParams) *DNSRecordItem {
-	var result DNSRecordItem
-	c.Backend.CallInto("v1/Network/DNS/Record/update", params, &result)
-
-	return &result
+func (c *DNSClient) Update(params *DNSRecordParams) (*DNSRecord, error) {
+	var result DNSRecord
+	err := c.Backend.Call("v1/Network/DNS/Record/update", params, &result)
+	if err != nil {
+		return nil, err
+	}
+	return &result, nil
 }
 
 // Delete will delete a DNS Record.
-func (c *DNSClient) Delete(params *DNSRecordParams) *DNSRecordDeletion {
+func (c *DNSClient) Delete(params *DNSRecordParams) (*DNSRecordDeletion, error) {
 	var result DNSRecordDeletion
-	c.Backend.CallInto("v1/Network/DNS/Record/delete", params, &result)
-
-	return &result
+	err := c.Backend.Call("v1/Network/DNS/Record/delete", params, &result)
+	if err != nil {
+		return nil, err
+	}
+	return &result, nil
 }

network/load_balancer.go

@@ -3,7 +3,6 @@ package network
 import (
 	"net"
 
-	liquidweb "git.liquidweb.com/masre/liquidweb-go"
 	"git.liquidweb.com/masre/liquidweb-go/types"
 )
 
@@ -66,14 +65,7 @@ type LoadBalancer struct {
 	VIP                types.IPAddr           `json:"vip,omitempty"`
 }
 
-// LoadBalancerItem is an envelope for the API result containing either a load balancer or an error.
-type LoadBalancerItem struct {
-	liquidweb.LWAPIError
-	LoadBalancer
-}
-
 // LoadBalancerDeletion represents the API result when deleting a load balancer.
 type LoadBalancerDeletion struct {
-	liquidweb.LWAPIError
 	Destroyed string `json:"destroyed"`
 }

network/load_balancer_client.go

@@ -6,10 +6,10 @@ import (
 
 // LoadBalancerBackend describes the interface for interactions with the API.
 type LoadBalancerBackend interface {
-	Create(LoadBalancerParams) (*LoadBalancerItem, error)
-	Details(string) *LoadBalancerItem
-	Update(LoadBalancerParams) *LoadBalancerItem
-	Delete(string) *LoadBalancerDeletion
+	Create(LoadBalancerParams) (*LoadBalancer, error)
+	Details(string) (*LoadBalancer, error)
+	Update(LoadBalancerParams) (*LoadBalancer, error)
+	Delete(string) (*LoadBalancerDeletion, error)
 }
 
 // LoadBalancerClient is the backend implementation for interacting with the API.
@@ -18,9 +18,9 @@ type LoadBalancerClient struct {
 }
 
 // Create creates a new load balancer.
-func (c *LoadBalancerClient) Create(params LoadBalancerParams) (*LoadBalancerItem, error) {
-	var result LoadBalancerItem
-	err := c.Backend.CallInto("v1/Network/LoadBalancer/create", params, &result)
+func (c *LoadBalancerClient) Create(params LoadBalancerParams) (*LoadBalancer, error) {
+	var result LoadBalancer
+	err := c.Backend.Call("v1/Network/LoadBalancer/create", params, &result)
 	if err != nil {
 		return nil, err
 	}
@@ -29,29 +29,36 @@ func (c *LoadBalancerClient) Create(params LoadBalancerParams) (*LoadBalancerIte
 }
 
 // Details returns details about a load balancer.
-func (c *LoadBalancerClient) Details(uniqID string) *LoadBalancerItem {
-	var result LoadBalancerItem
+func (c *LoadBalancerClient) Details(uniqID string) (*LoadBalancer, error) {
+	var result LoadBalancer
 	params := LoadBalancerParams{UniqID: uniqID}
 
-	c.Backend.CallInto("v1/Network/LoadBalancer/details", params, &result)
+	err := c.Backend.Call("v1/Network/LoadBalancer/details", params, &result)
+	if err != nil {
+		return nil, err
+	}
 
-	return &result
+	return &result, nil
 }
 
 // Update will update a load balancer.
-func (c *LoadBalancerClient) Update(params LoadBalancerParams) *LoadBalancerItem {
-	var result LoadBalancerItem
-	c.Backend.CallInto("v1/Network/LoadBalancer/update", params, &result)
-
-	return &result
+func (c *LoadBalancerClient) Update(params LoadBalancerParams) (*LoadBalancer, error) {
+	var result LoadBalancer
+	err := c.Backend.Call("v1/Network/LoadBalancer/update", params, &result)
+	if err != nil {
+		return nil, err
+	}
+	return &result, nil
 }
 
 // Delete will delete a load balancer.
-func (c *LoadBalancerClient) Delete(uniqID string) *LoadBalancerDeletion {
+func (c *LoadBalancerClient) Delete(uniqID string) (*LoadBalancerDeletion, error) {
 	var result LoadBalancerDeletion
 	params := LoadBalancerParams{UniqID: uniqID}
 
-	c.Backend.CallInto("v1/Network/LoadBalancer/delete", params, &result)
-
-	return &result
+	err := c.Backend.Call("v1/Network/LoadBalancer/delete", params, &result)
+	if err != nil {
+		return nil, err
+	}
+	return &result, nil
 }

network/vip.go

@@ -1,7 +1,6 @@
 package network
 
 import (
-	liquidweb "git.liquidweb.com/masre/liquidweb-go"
 	"git.liquidweb.com/masre/liquidweb-go/types"
 )
 
@@ -23,15 +22,8 @@ type VIP struct {
 	IP           string                 `json:"ip,omitempty"`
 }
 
-// VIPItem is an envelope for the API result containing either a VIP or an error.
-type VIPItem struct {
-	liquidweb.LWAPIError
-	VIP
-}
-
 // VIPDeletion represents the API result when deleting a VIP.
 type VIPDeletion struct {
-	liquidweb.LWAPIError
 	Destroyed string `json:"destroyed"`
 }