gojison

README

gojison

Package gojison provides two simple middlewares for working with JSON data in goji and two simple helper function to write out Error and Success responses to the http.RequestWriter.

Example

package main

import (
    "fmt"
    "net/http"

    "github.com/zenazn/goji"
    "github.com/zenazn/goji/web"
    "github.com/ndyakov/whatever"
    "github.com/ndyakov/gojison"
)

func main() {
    goji.Use(gojison.Request)
    goji.Use(gojison.Response)
    goji.Post("/save", handleSave)
    goji.Serve()
}

func handleSave(c web.C, w http.ResponseWriter, r *http.Request) {
    params := c.Env["Params"].(whatever.Params)
    if err := params.Required("user.name", "user.email"); err != nil {
        gojison.Error(err, 0)
        return
    }
    // do something...
    gojison.Success("saved", 0)
}

Install

Get the package

go get github.com/ndyakov/gojison

Import in your source

import "github.com/ndyakov/gojison"

Middlewares

This package includes the following middlewares:

Response:

This middleware will set the content type of the response to "application/json"

Request:

This middlware will unmarshal the request parameters to an whatever.Params structure and then attach it to the goji context map. You can access that structure from the context and work with it as either map[string]iterface{} or whatever.Params

For more information about how to work with the whatever.Params type, please refer to: http://godoc.org/github.com/ndyakov/whatever

Helpers

gojison exports two helper functions:

• Error(w http.ResponseWriter, err error, code int)
• Success(w http.ResponseWriter, message string, code int)

Those helpers can be used to render an error or success message as json and set the response code.

If the response code argument is 0, the following will be used:

• 400(http.StatusBadRequest) for Error
• 200(http.StatusOK) for Success

Contributions

Before contributing please execute:

• gofmt
• golint
• govet

License

The MIT License (MIT)

Copyright (c) 2015 Nedyalko Dyakov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Package gojison provides two simple middlewares for working with JSON data in goji and two simple helper function to write out Error and Success responses to the http.RequestWriter. This package includes the following middlewares:

Response:

This middleware will set the content type of the response to:

"application/json"

Request:

This middlware will unmarshal the request parameters to an whatever.Params structure and the attach it to the goji context map. You can access that structure from the context and work with it as either:

map[string]iterface{} or whatever.Params

For more information about how to work with the whatever.Params type, please refer to: http://godoc.org/github.com/ndyakov/whatever

Example:

package main

import (
    "fmt"
    "net/http"

    "github.com/zenazn/goji"
    "github.com/zenazn/goji/web"
    "github.com/ndyakov/whatever"
    "github.com/ndyakov/gojison"
)

func main() {
    goji.Use(gojison.Request)
    goji.Use(gojison.Response)
    goji.Post("/save", handleSave)
    goji.Serve()
}

func handleSave(c web.C, w http.ResponseWriter, r *http.Request) {
    params := c.Env["Params"].(whatever.Params)
    if err := params.Required("user.name", "user.email"); err != nil {
        gojison.Error(err, 0)
        return
    }
    // do something...
    gojison.Success("saved", 0)
}

Index

• func Error(w http.ResponseWriter, err error, code int)
• func Request(c *web.C, h http.Handler) http.Handler
• func Response(h http.Handler) http.Handler
• func Success(w http.ResponseWriter, message string, code int)

Functions

func Error

func Error(w http.ResponseWriter, err error, code int)

Error recieves http.ResponseWriter, error interface and response code. Sets the code to the ResponseWriter header and then writes out the error as JSON.

If the code parameter is 0, http.StatusBadRequest will be used.

func Request

func Request(c *web.C, h http.Handler) http.Handler

Request will parse the request body to a whatever.Params structure and then add this structure to the goji context map with the key "Params". The error (or nil) of the decoding will be available in the context with the key "GojisonDecodeError".

The parsing of the body will happen only if the Content-Type of the request is application/json.

For more information about how to work with the whatever.Params type, please refer to: http://godoc.org/github.com/ndyakov/whatever

func Response

func Response(h http.Handler) http.Handler

Response will set the Content-Type of the http response to:

"application/json"

func Success

func Success(w http.ResponseWriter, message string, code int)

Success recieves http.ResponseWriter, success message and a response code. Sets the code to the ResponseWriter header and then writes out the message as JSON.

If the code parameter is 0, http.StatusOK will be used.