Unit Tests and a gin example (#11)

* move gin example to dedicated example folder

* included tests

* add ContentType middleware function

* update comments and func names

* createResourceIdentifier unit tests

* more unit tests

documentation-wip.md

@@ -22,56 +22,7 @@ go get github.com/alehechka/go-jsonapi
 
 This library does not create any unnecessary marshalling assumptions, it will simply take in `Response` or `CollectionResponse` objects and transform them into JSON:API structs that keep the same provided object as the `Attributes` value. This allows an overlaying marshalling implementation to take over after transformation.
 
-<details><summary>Example Implementation</summary>
-
-```go
-package main
-
-import (
-    "github.com/gin-gonic/gin"
-    "github.com/alehechka/go-jsonapi"
-)
-
-func main() {
-    engine := gin.Default()
-
-    engine.GET("/record", getRecords)
-    engine.GET("/record/:id", getRecord)
-
-    engine.Run()
-}
-
-type Record struct {
-    RecordID string `json:"-"`
-    // variables
-}
-
-func (record Record) ID() string {
-    return record.RecordID
-}
-
-func (record Record) Type() string {
-    return "records"
-}
-
-func getRecords(ctx *gin.Context) {
-    records := getRecordsFromDatabase()
-
-    ctx.JSON(200, jsonapi.CreateCollectionResponse(ctx.Request)(jsonapi.CollectionResponse{
-        Nodes: records,
-    }))
-}
-
-func getRecord(ctx *gin.Context) {
-    record := getRecordFromDatabase(ctx.Param("id"))
-
-    ctx.JSON(200, jsonapi.CreateResponse(ctx.Request)(jsonapi.Response{
-        Node: record,
-    }))
-}
-```
-
-</details>
+View examples here: [/examples](/examples)
 
 ### Interface Methods
 

examples/gin.go

@@ -0,0 +1,68 @@
+package examples
+
+import (
+	"github.com/alehechka/go-jsonapi/jsonapi"
+	"github.com/gin-gonic/gin"
+)
+
+func main() {
+	engine := gin.Default()
+
+	engine.GET("/record", getRecords)
+	engine.GET("/record/:id", getRecord)
+
+	engine.Run()
+}
+
+type Record struct {
+	RecordID  string `json:"-"`
+	FirstName string `json:"firstName"`
+	Age       int    `json:"age"`
+	IsAdmin   bool   `json:"isAdmin"`
+}
+
+func (record Record) ID() string {
+	return record.RecordID
+}
+
+func (record Record) Type() string {
+	return "records"
+}
+
+func getRecords(ctx *gin.Context) {
+
+	ctx.JSON(200, jsonapi.CreateCollectionResponse(ctx.Request)(jsonapi.CollectionResponse{
+		Nodes: records(),
+	}))
+}
+
+func getRecord(ctx *gin.Context) {
+	records := records()
+	recordID := ctx.Param("id")
+
+	var record Record
+	for _, r := range records {
+		if r.RecordID == recordID {
+			record = r
+		}
+	}
+
+	ctx.JSON(200, jsonapi.CreateResponse(ctx.Request)(jsonapi.Response{
+		Node: record,
+	}))
+}
+
+func records() []Record {
+	return []Record{{
+		RecordID:  "1234",
+		FirstName: "Joe",
+		Age:       25,
+		IsAdmin:   true,
+	},
+		{
+			RecordID:  "4321",
+			FirstName: "Sally",
+			Age:       30,
+			IsAdmin:   true,
+		}}
+}

jsonapi/constants.go

@@ -21,6 +21,14 @@ const (
 // Include query parameter used to request extra resources to include in response
 const Include string = "include"
 
+// HTTP Header keys and values
+const (
+	// ContentType is the standard Content-Type header.
+	ContentType string = "Content-Type"
+	// MediaType is the standard JSON:API media type for the Content-Type header.
+	MediaType string = "application/vnd.api+json"
+)
+
 // Standard HTTP Headers
 const (
 	// ForwardedPrefix represents the prefix that is dropped when proxied through rest-api

jsonapi/included_test.go

@@ -0,0 +1,45 @@
+package jsonapi
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_transformIncluded_Nil(t *testing.T) {
+	included := transformIncluded([]Node{}, nil, baseURL)
+
+	assert.Nil(t, included)
+}
+
+func Test_transformIncluded(t *testing.T) {
+	included := transformIncluded([]Node{testObject}, []Node{}, baseURL)
+
+	assert.NotNil(t, included)
+	assert.Equal(t, 1, len(included))
+
+	include := included[0]
+
+	assert.Equal(t, testObject.ID(), include.ID)
+	assert.Equal(t, testObject.Type(), include.Type)
+	assert.Equal(t, testObject, include.Attributes)
+	assert.Equal(t, testObject.Meta(), include.Meta)
+
+	assert.NotNil(t, include.Links)
+	assert.NotNil(t, include.Links[SelfKey])
+	assert.Equal(t, baseURL+testObject.Links()[SelfKey].Href, include.Links[SelfKey])
+}
+
+func Test_transformIncludedNode(t *testing.T) {
+	include := transformIncludedNode(testObject, baseURL)
+
+	assert.NotNil(t, include)
+	assert.Equal(t, testObject.ID(), include.ID)
+	assert.Equal(t, testObject.Type(), include.Type)
+	assert.Equal(t, testObject, include.Attributes)
+	assert.Equal(t, testObject.Meta(), include.Meta)
+
+	assert.NotNil(t, include.Links)
+	assert.NotNil(t, include.Links[SelfKey])
+	assert.Equal(t, baseURL+testObject.Links()[SelfKey].Href, include.Links[SelfKey])
+}

jsonapi/links.go

@@ -43,11 +43,11 @@ type Link struct {
 	Queries Queries `json:"-"`
 }
 
-// Links is a map of JsonAPILink objects
+// Links is a map of Link objects
 type Links map[string]Link
 
-// LinkMap should have values of type JsonAPILink or string
-type LinkMap map[string]interface{} // JsonAPILink | string
+// LinkMap should have values of type Link or string
+type LinkMap map[string]interface{} // Link | string
 
 type Linkable interface {
 	Links() Links
@@ -81,7 +81,7 @@ func TransformLink(jsonLink Link, baseURL string) (link interface{}) {
 }
 
 func appendBaseURL(link Link, baseURL string) Link {
-	// only append baseURL if href is a relative URL
+
 	if IsRelativeURL(link.Href) {
 		link.Href = fmt.Sprintf("%s%s", baseURL, link.Href)
 	}
@@ -90,21 +90,23 @@ func appendBaseURL(link Link, baseURL string) Link {
 }
 
 func substitutePathParams(link Link) Link {
-	if link.Params != nil && len(link.Params) > 0 {
-		pathParts := strings.Split(link.Href, "/")
-
-		for index, pathPart := range pathParts {
-			if strings.HasPrefix(pathPart, ":") {
-				paramString := strings.TrimPrefix(pathPart, ":")
-				if param, exists := link.Params[paramString]; exists {
-					pathParts[index] = fmt.Sprintf("%v", param)
-				}
+	if link.Params == nil && len(link.Params) == 0 {
+		return link
+	}
+
+	pathParts := strings.Split(link.Href, "/")
+
+	for index, pathPart := range pathParts {
+		if strings.HasPrefix(pathPart, ":") {
+			paramString := strings.TrimPrefix(pathPart, ":")
+			if param, exists := link.Params[paramString]; exists {
+				pathParts[index] = fmt.Sprintf("%v", param)
 			}
 		}
-
-		link.Href = strings.Join(pathParts, "/")
 	}
 
+	link.Href = strings.Join(pathParts, "/")
+
 	return link
 }