Merge pull request #76 from univedo/packageSplit

Package split

Author: sharpner

.travis.yml

@@ -6,7 +6,12 @@ go:
   - 1.4
   - tip
 
-install: go get -t -d -v ./... && go build -v ./...
+install: 
+  - go get -t -d -v ./...
+  - go get github.com/onsi/ginkgo/ginkgo
+
+script:
+  - ginkgo -r --randomizeAllSpecs --randomizeSuites --failOnPending --trace --race --progress
 
 notifications:
   slack:

README.md

@@ -11,6 +11,11 @@ import "github.com/univedo/api2go"
 
 **api2go works, but we're still working on some rough edges. Things might change. Open an issue and join in!**
 
+Note: if you only need the marshaling functionality, you can install the subpackage via
+ ```go
+go get github.com/univedo/api2go/jsonapi
+``` 
+
 ## Usage
 
 Take the simple structs:

api.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 
 	"github.com/julienschmidt/httprouter"
+	"github.com/univedo/api2go/jsonapi"
 )
 
 // DataSource provides methods needed for CRUD.
@@ -106,7 +107,7 @@ func (api *API) addResource(prototype interface{}, source DataSource) *resource
 		panic("pass an empty resource struct to AddResource!")
 	}
 
-	name := jsonify(pluralize(resourceType.Name()))
+	name := jsonapi.Jsonify(jsonapi.Pluralize(resourceType.Name()))
 	res := resource{
 		resourceType: resourceType,
 		name:         name,
@@ -242,11 +243,11 @@ func (res *resource) handleLinked(api *API, w http.ResponseWriter, r *http.Reque
 	// Iterate over all struct fields and determine the type of linked
 	for i := 0; i < res.resourceType.NumField(); i++ {
 		field := res.resourceType.Field(i)
-		fieldName := jsonify(field.Name)
+		fieldName := jsonapi.Jsonify(field.Name)
 		kind := field.Type.Kind()
 		if (kind == reflect.Ptr || kind == reflect.Slice) && fieldName == linked {
 			// Check if there is a resource for this type
-			fieldType := pluralize(jsonify(field.Type.Elem().Name()))
+			fieldType := jsonapi.Pluralize(jsonapi.Jsonify(field.Type.Elem().Name()))
 			for _, resource := range api.resources {
 				if resource.name == fieldType {
 					request := Request{
@@ -279,7 +280,9 @@ func (res *resource) handleCreate(w http.ResponseWriter, r *http.Request, prefix
 		return err
 	}
 	newObjs := reflect.MakeSlice(reflect.SliceOf(res.resourceType), 0, 0)
-	err = unmarshalInto(ctx, res.resourceType, &newObjs)
+
+	//TODO remove necessecity to call unmarshal into
+	err = jsonapi.UnmarshalInto(ctx, res.resourceType, &newObjs)
 	if err != nil {
 		return err
 	}
@@ -320,7 +323,9 @@ func (res *resource) handleUpdate(w http.ResponseWriter, r *http.Request, ps htt
 	}
 	updatingObjs := reflect.MakeSlice(reflect.SliceOf(res.resourceType), 1, 1)
 	updatingObjs.Index(0).Set(reflect.ValueOf(obj))
-	err = unmarshalInto(ctx, res.resourceType, &updatingObjs)
+
+	//TODO remove call to unmarshalInto
+	err = jsonapi.UnmarshalInto(ctx, res.resourceType, &updatingObjs)
 	if err != nil {
 		return err
 	}
@@ -359,7 +364,7 @@ func (res *resource) handleDelete(w http.ResponseWriter, r *http.Request, ps htt
 }
 
 func respondWith(obj interface{}, prefix string, status int, w http.ResponseWriter) error {
-	data, err := MarshalToJSONPrefix(obj, prefix)
+	data, err := jsonapi.MarshalToJSONPrefix(obj, prefix)
 	if err != nil {
 		return err
 	}

error.go

@@ -1,6 +1,11 @@
 package api2go
 
-import "fmt"
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+	"strconv"
+)
 
 //HTTPError is used for errors
 type HTTPError struct {
@@ -24,6 +29,34 @@ type Error struct {
 	Path   string `json:"path,omitempty"`
 }
 
+//marshalError marshals all error types
+func marshalError(err error) string {
+	httpErr, ok := err.(HTTPError)
+	if ok {
+		return marshalHTTPError(httpErr)
+	}
+
+	httpErr = NewHTTPError(err, err.Error(), 500)
+
+	return marshalHTTPError(httpErr)
+}
+
+//marshalHTTPError marshals an internal httpError
+func marshalHTTPError(input HTTPError) string {
+	if len(input.Errors) == 0 {
+		input.Errors = []Error{Error{Title: input.msg, Status: strconv.Itoa(input.status)}}
+	}
+
+	data, err := json.Marshal(input)
+
+	if err != nil {
+		log.Println(err)
+		return "{}"
+	}
+
+	return string(data)
+}
+
 // NewHTTPError creates a new error with message and status code.
 // `err` will be logged (but never sent to a client), `msg` will be sent and `status` is the http status code.
 // `err` can be nil.

helpers_test.go

@@ -0,0 +1,14 @@
+# api2go JSONAPI package
+
+This package contains [JSON API](http://jsonapi.org) compatible
+marshal und unmarshal functionality.
+
+```
+  go get github.com/univedo/api2go/jsonapi
+```
+
+## Usage
+
+For information on how to use this package, please refer to the 
+documentation on the [api2go](https://github.com/univedo/api2go) main project, 
+the integration_test.go or the [godoc](http://godoc.org/github.com/univedo/api2go/jsonapi).

jsonapi/Readme.md

@@ -1,4 +1,4 @@
-package api2go
+package jsonapi
 
 import (
 	"database/sql"
@@ -49,8 +49,8 @@ var commonInitialisms = map[string]bool{
 	"JWT":   true,
 }
 
-// dejsonify returns a go struct key name from a JSON key name
-func dejsonify(s string) string {
+// Dejsonify returns a go struct key name from a JSON key name
+func Dejsonify(s string) string {
 	if s == "" {
 		return ""
 	}
@@ -62,8 +62,8 @@ func dejsonify(s string) string {
 	return string(rs)
 }
 
-// jsonify returns a JSON formatted key name from a go struct field name
-func jsonify(s string) string {
+// Jsonify returns a JSON formatted key name from a go struct field name
+func Jsonify(s string) string {
 	if s == "" {
 		return ""
 	}
@@ -75,13 +75,13 @@ func jsonify(s string) string {
 	return string(rs)
 }
 
-// pluralize a noun
-func pluralize(word string) string {
+// Pluralize a noun
+func Pluralize(word string) string {
 	return inflector.Pluralize(word)
 }
 
-// singularize a noun
-func singularize(word string) string {
+// Singularize a noun
+func Singularize(word string) string {
 	return inflector.Singularize(word)
 }
 
@@ -207,6 +207,11 @@ func setIDValue(val reflect.Value, idInterface interface{}) error {
 
 		val.SetUint(intID)
 
+	case reflect.Invalid:
+		{
+			return fmt.Errorf("Invalid type given for %#v.", idInterface)
+		}
+
 	default:
 		return errors.New("expected ID to be of type int or string in struct")
 	}

helpers.go jsonapi/helpers.gohelpers.go renamed to jsonapi/helpers.go

@@ -0,0 +1,34 @@
+package jsonapi
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("StringHelpers", func() {
+	It("dejsonifies", func() {
+		Expect(Dejsonify("Post")).To(Equal("Post"))
+		Expect(Dejsonify("post")).To(Equal("Post"))
+		Expect(Dejsonify("id")).To(Equal("ID"))
+		Expect(Dejsonify("")).To(Equal(""))
+	})
+
+	It("jsonifies", func() {
+		Expect(Jsonify("Post")).To(Equal("post"))
+		Expect(Jsonify("post")).To(Equal("post"))
+		Expect(Jsonify("ID")).To(Equal("id"))
+		Expect(Jsonify("")).To(Equal(""))
+	})
+
+	It("Pluralizes", func() {
+		Expect(Pluralize("post")).To(Equal("posts"))
+		Expect(Pluralize("posts")).To(Equal("posts"))
+		Expect(Pluralize("category")).To(Equal("categories"))
+	})
+
+	It("singularizes", func() {
+		Expect(Singularize("posts")).To(Equal("post"))
+		Expect(Singularize("post")).To(Equal("post"))
+		Expect(Singularize("categories")).To(Equal("category"))
+	})
+})