Merge pull request #299 from manyminds/framework-routing

Installl adapter via conditional build tags

Author: wwwdata

.travis.yml

@@ -14,9 +14,14 @@ install:
   - go get -u github.com/golang/lint/golint
   - go get -u github.com/modocache/gover
   - go get -u github.com/mattn/goveralls
+    # optional dependencies
+  - go get -u github.com/gin-gonic/gin
+  - go get -u github.com/gorilla/mux
 
 script:
   - ginkgo -r -cover --randomizeAllSpecs --randomizeSuites --failOnPending --trace --race --progress
+  - ginkgo -tags=gorillamux -r --randomizeSuites --failOnPending --trace --race
+  - ginkgo -tags=gingonic -r --randomizeSuites --failOnPending --trace --race
   - rm examples/examples.coverprofile
   - bash scripts/fmtpolice
   - gover

README.md

@@ -333,14 +333,16 @@ In order to use omitempty with those types, you need to specify them as pointers
 If you want to use api2go with [gin](https://github.com/gin-gonic/gin) you need to use a different router than the default one.
 Get the according adapter using:
 
-```go get github.com/manyminds/api2go-adapter/gingonic```
+```go get -tags=gingonic github.com/manyminds/api2go```
+
+Currently the supported tags are: `gingonic` or `gorillamux`.
 
 After that you can bootstrap api2go the following way:
 ```go
   import (
     "github.com/gin-gonic/gin"
     "github.com/manyminds/api2go"
-    "github.com/manyminds/api2go-adapter/gingonic"
+    "github.com/manyminds/api2go/routing"
     "github.com/manyminds/api2go/examples/model"
     "github.com/manyminds/api2go/examples/resource"
     "github.com/manyminds/api2go/examples/storage"
@@ -351,7 +353,7 @@ After that you can bootstrap api2go the following way:
     api := api2go.NewAPIWithRouting(
       "api",
       api2go.NewStaticResolver("/"),
-      gingonic.New(r),
+      routing.Gin(r),
     )
 
     userStorage := storage.NewUserStorage()

api.go

@@ -172,7 +172,13 @@ type notAllowedHandler struct {
 func (n notAllowedHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	err := NewHTTPError(nil, "Method Not Allowed", http.StatusMethodNotAllowed)
 	w.WriteHeader(http.StatusMethodNotAllowed)
-	n.API.handleError(err, w, r)
+
+	contentType := defaultContentTypHeader
+	if n.API != nil {
+		contentType = n.API.ContentType
+	}
+
+	handleError(err, w, r, contentType)
 }
 
 type resource struct {
@@ -262,7 +268,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 		err := res.handleIndex(c, w, r, *info)
 		api.contextPool.Put(c)
 		if err != nil {
-			api.handleError(err, w, r)
+			handleError(err, w, r, api.ContentType)
 		}
 	})
 
@@ -284,7 +290,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 			err := res.handleRead(c, w, r, params, *info)
 			api.contextPool.Put(c)
 			if err != nil {
-				api.handleError(err, w, r)
+				handleError(err, w, r, api.ContentType)
 			}
 		})
 	}
@@ -303,7 +309,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 					err := res.handleReadRelation(c, w, r, params, *info, relation)
 					api.contextPool.Put(c)
 					if err != nil {
-						api.handleError(err, w, r)
+						handleError(err, w, r, api.ContentType)
 					}
 				}
 			}(relation))
@@ -317,7 +323,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 					err := res.handleLinked(c, api, w, r, params, relation, *info)
 					api.contextPool.Put(c)
 					if err != nil {
-						api.handleError(err, w, r)
+						handleError(err, w, r, api.ContentType)
 					}
 				}
 			}(relation))
@@ -330,7 +336,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 					err := res.handleReplaceRelation(c, w, r, params, relation)
 					api.contextPool.Put(c)
 					if err != nil {
-						api.handleError(err, w, r)
+						handleError(err, w, r, api.ContentType)
 					}
 				}
 			}(relation))
@@ -345,7 +351,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 						err := res.handleAddToManyRelation(c, w, r, params, relation)
 						api.contextPool.Put(c)
 						if err != nil {
-							api.handleError(err, w, r)
+							handleError(err, w, r, api.ContentType)
 						}
 					}
 				}(relation))
@@ -358,7 +364,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 						err := res.handleDeleteToManyRelation(c, w, r, params, relation)
 						api.contextPool.Put(c)
 						if err != nil {
-							api.handleError(err, w, r)
+							handleError(err, w, r, api.ContentType)
 						}
 					}
 				}(relation))
@@ -375,7 +381,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 			err := res.handleCreate(c, w, r, info.prefix, *info)
 			api.contextPool.Put(c)
 			if err != nil {
-				api.handleError(err, w, r)
+				handleError(err, w, r, api.ContentType)
 			}
 		})
 	}
@@ -388,7 +394,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 			err := res.handleDelete(c, w, r, params)
 			api.contextPool.Put(c)
 			if err != nil {
-				api.handleError(err, w, r)
+				handleError(err, w, r, api.ContentType)
 			}
 		})
 	}
@@ -402,7 +408,7 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 			err := res.handleUpdate(c, w, r, params, *info)
 			api.contextPool.Put(c)
 			if err != nil {
-				api.handleError(err, w, r)
+				handleError(err, w, r, api.ContentType)
 			}
 		})
 	}
@@ -413,7 +419,6 @@ func (api *API) addResource(prototype jsonapi.MarshalIdentifier, source interfac
 }
 
 func getAllowedMethods(source interface{}, collection bool) []string {
-
 	result := []string{http.MethodOptions}
 
 	if _, ok := source.(ResourceGetter); ok {
@@ -597,7 +602,6 @@ func (res *resource) handleLinked(c APIContexter, api *API, w http.ResponseWrite
 }
 
 func (res *resource) handleCreate(c APIContexter, w http.ResponseWriter, r *http.Request, prefix string, info information) error {
-
 	source, ok := res.source.(ResourceCreator)
 
 	if !ok {
@@ -1151,16 +1155,16 @@ func replaceAttributes(query *map[string][]string, entry *jsonapi.Data) map[stri
 	return nil
 }
 
-func (api *API) handleError(err error, w http.ResponseWriter, r *http.Request) {
+func handleError(err error, w http.ResponseWriter, r *http.Request, contentType string) {
 	log.Println(err)
 	if e, ok := err.(HTTPError); ok {
-		writeResult(w, []byte(marshalHTTPError(e)), e.status, api.ContentType)
+		writeResult(w, []byte(marshalHTTPError(e)), e.status, contentType)
 		return
 
 	}
 
 	e := NewHTTPError(err, err.Error(), http.StatusInternalServerError)
-	writeResult(w, []byte(marshalHTTPError(e)), http.StatusInternalServerError, api.ContentType)
+	writeResult(w, []byte(marshalHTTPError(e)), http.StatusInternalServerError, contentType)
 }
 
 // TODO: this can also be replaced with a struct into that we directly json.Unmarshal

api_entity_name_test.go

@@ -76,7 +76,7 @@ var _ = Describe("Test route renaming with EntityNamer interface", func() {
 		body *strings.Reader
 	)
 	BeforeEach(func() {
-		api = NewAPI("v1")
+		api = NewAPIWithRouting(testPrefix, NewStaticResolver(""), newTestRouter())
 		api.AddResource(BaguetteTaste{}, BaguetteResource{})
 		rec = httptest.NewRecorder()
 		body = strings.NewReader(`

api_object_initializer_test.go

@@ -40,7 +40,7 @@ var _ = Describe("Test resource implementing the ObjectInitializer interface", f
 		body *strings.Reader
 	)
 	BeforeEach(func() {
-		api = NewAPI("v1")
+		api = NewAPIWithRouting(testPrefix, NewStaticResolver(""), newTestRouter())
 		api.AddResource(Post{}, ObjectInitializerResource{})
 		rec = httptest.NewRecorder()
 		body = strings.NewReader(`

api_test.go

@@ -17,6 +17,8 @@ import (
 	"gopkg.in/guregu/null.v2"
 )
 
+const testPrefix = "v1"
+
 type requestURLResolver struct {
 	r     http.Request
 	calls int
@@ -1236,7 +1238,7 @@ var _ = Describe("RestHandler", func() {
 				"7": {ID: "7", Title: "Hello, World!"},
 			}, false}
 
-			api = NewAPI("v1")
+			api = NewAPIWithRouting(testPrefix, NewStaticResolver(""), newTestRouter())
 			api.AddResource(Post{}, source)
 
 			rec = httptest.NewRecorder()
@@ -1413,10 +1415,10 @@ var _ = Describe("RestHandler", func() {
 				req, err := http.NewRequest("PATCH", "/v1/posts", reqBody)
 				Expect(err).To(BeNil())
 				api.Handler().ServeHTTP(rec, req)
-				expected := `{"errors":[{"status":"405","title":"Method Not Allowed"}]}`
-				Expect(rec.Body.String()).To(MatchJSON(expected))
 				Expect(rec.Header().Get("Content-Type")).To(Equal(defaultContentTypHeader))
 				Expect(rec.Code).To(Equal(http.StatusMethodNotAllowed))
+				expected := `{"errors":[{"status":"405","title":"Method Not Allowed"}]}`
+				Expect(rec.Body.String()).To(MatchJSON(expected))
 			})
 		})
 
@@ -1463,7 +1465,7 @@ var _ = Describe("RestHandler", func() {
 				"1": {ID: "1", Title: "Hello, World!"},
 			}, false}
 
-			api = NewAPI("v1")
+			api = NewAPIWithRouting(testPrefix, NewStaticResolver(""), newTestRouter())
 			api.AddResource(Post{}, source)
 			MiddleTest := func(c APIContexter, w http.ResponseWriter, r *http.Request) {
 				w.Header().Add("x-test", "test123")
@@ -1497,7 +1499,7 @@ var _ = Describe("RestHandler", func() {
 				"1": {ID: "1", Title: "Hello, World!"},
 			}, false}
 
-			api = NewAPI("v1")
+			api = NewAPIWithRouting(testPrefix, NewStaticResolver(""), newTestRouter())
 			api.AddResource(Post{}, source)
 			api.SetContextAllocator(func(api *API) APIContexter {
 				customContextCalled = true
@@ -1780,7 +1782,7 @@ var _ = Describe("RestHandler", func() {
 			source = &fixtureSource{map[string]*Post{
 				"1": {ID: "1", Title: "Nice Post", Value: null.FloatFrom(13.37), Author: &author},
 			}, false}
-			mainAPI = NewAPI("v1")
+			mainAPI = NewAPIWithRouting(testPrefix, NewStaticResolver(""), newTestRouter())
 			mainAPI.AddResource(Post{}, source)
 
 			author2 := User{ID: "888", Name: "Version 2 Tester", Info: "Is the next version"}

gingonic_router_test.go

@@ -0,0 +1,26 @@
+// +build gingonic,!gorillamux
+
+package api2go
+
+import (
+	"log"
+
+	"github.com/gin-gonic/gin"
+	"github.com/manyminds/api2go/routing"
+)
+
+func newTestRouter() routing.Routeable {
+	gin.SetMode(gin.ReleaseMode)
+	gg := gin.Default()
+	notFound := func(c *gin.Context) {
+		notAllowedHandler{}.ServeHTTP(c.Writer, c.Request)
+	}
+
+	gg.NoRoute(notFound)
+
+	return routing.Gin(gg)
+}
+
+func init() {
+	log.Println("Testing with gin router")
+}

gorillamux_router_test.go

@@ -0,0 +1,20 @@
+// +build !gingonic,gorillamux
+
+package api2go
+
+import (
+	"log"
+
+	"github.com/gorilla/mux"
+	"github.com/manyminds/api2go/routing"
+)
+
+func newTestRouter() routing.Routeable {
+	router := mux.NewRouter()
+	router.MethodNotAllowedHandler = notAllowedHandler{}
+	return routing.Gorilla(router)
+}
+
+func init() {
+	log.Println("Testing with gorilla router")
+}

httprouter_test.go

@@ -0,0 +1,17 @@
+// +build !gingonic,!gorillamux
+
+package api2go
+
+import (
+	"log"
+
+	"github.com/manyminds/api2go/routing"
+)
+
+func newTestRouter() routing.Routeable {
+	return routing.NewHTTPRouter(testPrefix, &notAllowedHandler{})
+}
+
+func init() {
+	log.Println("Testing with default router")
+}

routing/gingonic.go

@@ -0,0 +1,35 @@
+// +build gingonic,!gorillamux
+
+package routing
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+type ginRouter struct {
+	router *gin.Engine
+}
+
+func (g ginRouter) Handler() http.Handler {
+	return g.router
+}
+
+func (g ginRouter) Handle(protocol, route string, handler HandlerFunc) {
+	wrappedCallback := func(c *gin.Context) {
+		params := map[string]string{}
+		for _, p := range c.Params {
+			params[p.Key] = p.Value
+		}
+
+		handler(c.Writer, c.Request, params)
+	}
+
+	g.router.Handle(protocol, route, wrappedCallback)
+}
+
+//Gin creates a new api2go router to use with the gin framework
+func Gin(g *gin.Engine) Routeable {
+	return &ginRouter{router: g}
+}