Merge remote-tracking branch 'upstream/master'

Author: mrowdy

.gitignore

@@ -1,3 +1,4 @@
 /bin/
 /pkg/
 /src/
+/.idea

.travis.yml

@@ -2,5 +2,6 @@ language: go
 go:
   - 1.7.x
   - 1.8.x
+  - 1.9.x
   - tip
 script: script/test -v

README.md

@@ -1,6 +1,8 @@
 # jsonapi
 
-[![Build Status](https://travis-ci.org/google/jsonapi.svg?branch=master)](https://travis-ci.org/google/jsonapi) [![GoDoc](https://godoc.org/github.com/google/jsonapi?status.svg)](http://godoc.org/github.com/google/jsonapi)
+[![Build Status](https://travis-ci.org/google/jsonapi.svg?branch=master)](https://travis-ci.org/google/jsonapi)
+[![Go Report Card](https://goreportcard.com/badge/github.com/google/jsonapi)](https://goreportcard.com/report/github.com/google/jsonapi)
+[![GoDoc](https://godoc.org/github.com/google/jsonapi?status.svg)](http://godoc.org/github.com/google/jsonapi)
 
 A serializer/deserializer for JSON payloads that comply to the
 [JSON API - jsonapi.org](http://jsonapi.org) spec in go.

examples/fixtures.go

@@ -8,31 +8,31 @@ func fixtureBlogCreate(i int) *Blog {
 		Title:     "Title 1",
 		CreatedAt: time.Now(),
 		Posts: []*Post{
-			&Post{
+			{
 				ID:    1 * i,
 				Title: "Foo",
 				Body:  "Bar",
 				Comments: []*Comment{
-					&Comment{
+					{
 						ID:   1 * i,
 						Body: "foo",
 					},
-					&Comment{
+					{
 						ID:   2 * i,
 						Body: "bar",
 					},
 				},
 			},
-			&Post{
+			{
 				ID:    2 * i,
 				Title: "Fuubar",
 				Body:  "Bas",
 				Comments: []*Comment{
-					&Comment{
+					{
 						ID:   1 * i,
 						Body: "foo",
 					},
-					&Comment{
+					{
 						ID:   3 * i,
 						Body: "bas",
 					},
@@ -44,11 +44,11 @@ func fixtureBlogCreate(i int) *Blog {
 			Title: "Foo",
 			Body:  "Bar",
 			Comments: []*Comment{
-				&Comment{
+				{
 					ID:   1 * i,
 					Body: "foo",
 				},
-				&Comment{
+				{
 					ID:   2 * i,
 					Body: "bar",
 				},

examples/handler_test.go

@@ -84,3 +84,35 @@ func TestExampleHandler_get_list(t *testing.T) {
 		t.Fatalf("Expected a status of %d, got %d", e, a)
 	}
 }
+
+func TestHttpErrorWhenHeaderDoesNotMatch(t *testing.T) {
+	r, err := http.NewRequest(http.MethodGet, "/blogs", nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	r.Header.Set(headerAccept, "application/xml")
+
+	rr := httptest.NewRecorder()
+	handler := &ExampleHandler{}
+	handler.ServeHTTP(rr, r)
+
+	if rr.Code != http.StatusUnsupportedMediaType {
+		t.Fatal("expected Unsupported Media Type staus error")
+	}
+}
+
+func TestHttpErrorWhenMethodDoesNotMatch(t *testing.T) {
+	r, err := http.NewRequest(http.MethodPatch, "/blogs", nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	r.Header.Set(headerAccept, jsonapi.MediaType)
+
+	rr := httptest.NewRecorder()
+	handler := &ExampleHandler{}
+	handler.ServeHTTP(rr, r)
+
+	if rr.Code != http.StatusNotFound {
+		t.Fatal("expected HTTP Status Not Found status error")
+	}
+}

examples/models.go

@@ -7,6 +7,7 @@ import (
 	"github.com/google/jsonapi"
 )
 
+// Blog is a model representing a blog site
 type Blog struct {
 	ID            int       `jsonapi:"primary,blogs"`
 	Title         string    `jsonapi:"attr,title"`
@@ -17,6 +18,7 @@ type Blog struct {
 	ViewCount     int       `jsonapi:"attr,view_count"`
 }
 
+// Post is a model representing a post on a blog
 type Post struct {
 	ID       int        `jsonapi:"primary,posts"`
 	BlogID   int        `jsonapi:"attr,blog_id"`
@@ -25,19 +27,21 @@ type Post struct {
 	Comments []*Comment `jsonapi:"relation,comments"`
 }
 
+// Comment is a model representing a user submitted comment
 type Comment struct {
 	ID     int    `jsonapi:"primary,comments"`
 	PostID int    `jsonapi:"attr,post_id"`
 	Body   string `jsonapi:"attr,body"`
 }
 
-// Blog Links
+// JSONAPILinks implements the Linkable interface for a blog
 func (blog Blog) JSONAPILinks() *jsonapi.Links {
 	return &jsonapi.Links{
 		"self": fmt.Sprintf("https://example.com/blogs/%d", blog.ID),
 	}
 }
 
+// JSONAPIRelationshipLinks implements the RelationshipLinkable interface for a blog
 func (blog Blog) JSONAPIRelationshipLinks(relation string) *jsonapi.Links {
 	if relation == "posts" {
 		return &jsonapi.Links{
@@ -52,13 +56,14 @@ func (blog Blog) JSONAPIRelationshipLinks(relation string) *jsonapi.Links {
 	return nil
 }
 
-// Blog Meta
+// JSONAPIMeta implements the Metable interface for a blog
 func (blog Blog) JSONAPIMeta() *jsonapi.Meta {
 	return &jsonapi.Meta{
 		"detail": "extra details regarding the blog",
 	}
 }
 
+// JSONAPIRelationshipMeta implements the RelationshipMetable interface for a blog
 func (blog Blog) JSONAPIRelationshipMeta(relation string) *jsonapi.Meta {
 	if relation == "posts" {
 		return &jsonapi.Meta{

request_test.go

@@ -753,15 +753,15 @@ func samplePayload() io.Reader {
 			Relationships: map[string]interface{}{
 				"posts": &RelationshipManyNode{
 					Data: []*Node{
-						&Node{
+						{
 							Type: "posts",
 							Attributes: map[string]interface{}{
 								"title": "Foo",
 								"body":  "Bar",
 							},
 							ClientID: "1",
 						},
-						&Node{
+						{
 							Type: "posts",
 							Attributes: map[string]interface{}{
 								"title": "X",
@@ -782,14 +782,14 @@ func samplePayload() io.Reader {
 						Relationships: map[string]interface{}{
 							"comments": &RelationshipManyNode{
 								Data: []*Node{
-									&Node{
+									{
 										Type: "comments",
 										Attributes: map[string]interface{}{
 											"body": "Great post!",
 										},
 										ClientID: "4",
 									},
-									&Node{
+									{
 										Type: "comments",
 										Attributes: map[string]interface{}{
 											"body": "Needs some work!",
@@ -866,16 +866,16 @@ func testModel() *Blog {
 		Title:     "Title 1",
 		CreatedAt: time.Now(),
 		Posts: []*Post{
-			&Post{
+			{
 				ID:    1,
 				Title: "Foo",
 				Body:  "Bar",
 				Comments: []*Comment{
-					&Comment{
+					{
 						ID:   1,
 						Body: "foo",
 					},
-					&Comment{
+					{
 						ID:   2,
 						Body: "bar",
 					},
@@ -885,16 +885,16 @@ func testModel() *Blog {
 					Body: "foo",
 				},
 			},
-			&Post{
+			{
 				ID:    2,
 				Title: "Fuubar",
 				Body:  "Bas",
 				Comments: []*Comment{
-					&Comment{
+					{
 						ID:   1,
 						Body: "foo",
 					},
-					&Comment{
+					{
 						ID:   3,
 						Body: "bas",
 					},
@@ -910,11 +910,11 @@ func testModel() *Blog {
 			Title: "Foo",
 			Body:  "Bar",
 			Comments: []*Comment{
-				&Comment{
+				{
 					ID:   1,
 					Body: "foo",
 				},
-				&Comment{
+				{
 					ID:   2,
 					Body: "bar",
 				},

response.go

@@ -19,7 +19,7 @@ var (
 	// was not a valid numeric type.
 	ErrBadJSONAPIID = errors.New(
 		"id should be either string, int(8,16,32,64) or uint(8,16,32,64)")
-	// ErrExpectedSlice is returned when a variable or arugment was expected to
+	// ErrExpectedSlice is returned when a variable or argument was expected to
 	// be a slice of *Structs; MarshalMany will return this error when its
 	// interface{} argument is invalid.
 	ErrExpectedSlice = errors.New("models should be a slice of struct pointers")