Isolated client logic into jsc package, added Parser type to avoid namespace polution and to simplify parsing DSL

Author: Derek Dowling

client.go

@@ -0,0 +1,111 @@
+package jsc
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"strconv"
+	"strings"
+
+	"github.com/derekdowling/go-json-spec-handler"
+)
+
+// Response is a wrapper around an http.Response that allows us to perform
+// intelligent actions on them
+type Response struct {
+	*http.Response
+}
+
+// GetObject validates the http response and parses out the JSON object from the
+// body if possible
+func (r *Response) GetObject() (*jsh.Object, error) {
+	return buildParser(r).GetObject()
+}
+
+// GetList validates the http response and parses out the JSON list from the
+// body if possible
+func (r *Response) GetList() (jsh.List, error) {
+	return buildParser(r).GetList()
+}
+
+// BodyStr is a convenience function that parses the body of the response into a
+// string BUT DOESN'T close the ReadCloser
+func (r *Response) BodyStr() (string, error) {
+
+	byteData, err := ioutil.ReadAll(r.Body)
+	if err != nil {
+		return "", fmt.Errorf("Error attempting to read request body: %s", err)
+	}
+
+	return string(byteData), nil
+}
+
+func buildParser(response *Response) *jsh.Parser {
+	return &jsh.Parser{
+		Method:  "",
+		Headers: response.Header,
+		Payload: response.Body,
+	}
+}
+
+// setPath builds a JSON url.Path for a given resource type. Typically this just
+// envolves concatting a pluralized resource name
+func setPath(url *url.URL, resource string) {
+
+	if url.Path != "" && !strings.HasSuffix(url.Path, "/") {
+		url.Path = url.Path + "/"
+	}
+
+	url.Path = fmt.Sprintf("%s%ss", url.Path, resource)
+}
+
+// setIDPath creates a JSON url.Path for a specific resource type including an
+// ID specifier.
+func setIDPath(url *url.URL, resource string, id string) {
+	setPath(url, resource)
+	url.Path = strings.Join([]string{url.Path, id}, "/")
+}
+
+// objectToPayload first prepares/validates the object to ensure it is JSON
+// spec compatible, and then marshals it to JSON
+func objectToPayload(request *http.Request, object *jsh.Object) ([]byte, error) {
+
+	payload, err := object.Prepare(request, false)
+	if err != nil {
+		return nil, fmt.Errorf("Error preparing object: %s", err.Error())
+	}
+
+	jsonContent, jsonErr := json.MarshalIndent(payload, "", "  ")
+	if jsonErr != nil {
+		return nil, fmt.Errorf("Unable to prepare JSON content: %s", jsonErr)
+	}
+
+	return jsonContent, nil
+}
+
+// sendPayloadRequest is required for sending JSON payload related requests
+// because by default the http package does not set Content-Length headers
+func sendObjectRequest(request *http.Request, object *jsh.Object) (*Response, error) {
+
+	payload, err := objectToPayload(request, object)
+	if err != nil {
+		return nil, fmt.Errorf("Error converting object to JSON: %s", err.Error())
+	}
+
+	// prepare payload and corresponding headers
+	request.Body = jsh.CreateReadCloser(payload)
+	request.Header.Add("Content-Type", jsh.ContentType)
+	request.Header.Set("Content-Length", strconv.Itoa(len(payload)))
+
+	client := &http.Client{}
+	response, err := client.Do(request)
+	if err != nil {
+		return nil, fmt.Errorf(
+			"Error sending %s request: %s", request.Method, err.Error(),
+		)
+	}
+
+	return &Response{response}, nil
+}

client/client.go

@@ -0,0 +1,80 @@
+package jsc
+
+import (
+	"net/url"
+	"testing"
+
+	"github.com/derekdowling/go-json-spec-handler"
+	. "github.com/smartystreets/goconvey/convey"
+)
+
+const testURL = "https://httpbin.org"
+
+func TestClientRequest(t *testing.T) {
+
+	Convey("Client Tests", t, func() {
+
+		Convey("->setPath()", func() {
+			url := &url.URL{Host: "test"}
+
+			Convey("should format properly", func() {
+				setPath(url, "test")
+				So(url.String(), ShouldEqual, "//test/tests")
+			})
+
+			Convey("should respect an existing path", func() {
+				url.Path = "admin"
+				setPath(url, "test")
+				So(url.String(), ShouldEqual, "//test/admin/tests")
+			})
+		})
+
+		Convey("->setIDPath()", func() {
+			url := &url.URL{Host: "test"}
+
+			Convey("should format properly an id url", func() {
+				setIDPath(url, "test", "1")
+				So(url.String(), ShouldEqual, "//test/tests/1")
+			})
+		})
+
+	})
+}
+
+func TestClientResponse(t *testing.T) {
+
+	Convey("Client Response Tests", t, func() {
+
+		Convey("->GetObject()", func() {
+
+			obj, objErr := jsh.NewObject("123", "test", map[string]string{"test": "test"})
+			So(objErr, ShouldBeNil)
+			response, err := mockObjectResponse(obj)
+			So(err, ShouldBeNil)
+
+			Convey("should parse successfully", func() {
+				respObj, err := response.GetObject()
+				So(err, ShouldBeNil)
+				So(respObj, ShouldNotBeNil)
+			})
+
+		})
+
+		Convey("->GetList()", func() {
+
+			obj, objErr := jsh.NewObject("123", "test", map[string]string{"test": "test"})
+			So(objErr, ShouldBeNil)
+
+			list := jsh.List{obj, obj}
+
+			response, err := mockListResponse(list)
+			So(err, ShouldBeNil)
+
+			Convey("should parse successfully", func() {
+				respObj, err := response.GetList()
+				So(err, ShouldBeNil)
+				So(respObj, ShouldNotBeNil)
+			})
+		})
+	})
+}