toolkit

README

toolkit

A simple example how to create a reusable Go module with commonly used tools.

The included tools are:

• Read JSON
• Write JSON
• Produce a JSON encoded error response
• Upload a file to a specified directory
• Download a static file
• Get a random string of length n
• Post JSON to a remote service
• Create a directory, including all parent directories, if it does not already exists
• Create a URL safe slug from a string

Instalation

go get -u github.com/Narven/toolkit

Documentation

Index

• type JSONResponse
• type Tools
  • func (t *Tools) CreateDirIfNotExist(path string) error
  • func (t *Tools) DownloadStaticFile(w http.ResponseWriter, r *http.Request, pathName, displayName string)
  • func (t *Tools) ErrorJSON(w http.ResponseWriter, err error, status ...int) error
  • func (t *Tools) PushJSONToRemote(uri string, data interface{}, client ...*http.Client) (*http.Response, int, error)
  • func (t *Tools) RandomString(n int) string
  • func (t *Tools) ReadJSON(w http.ResponseWriter, r *http.Request, data interface{}) error
  • func (t *Tools) Slugify(s string) (string, error)
  • func (t *Tools) UploadFiles(r *http.Request, uploadDir string, rename ...bool) ([]*UploadedFile, error)
  • func (t *Tools) UploadOneFile(r *http.Request, uploadDir string, rename ...bool) (*UploadedFile, error)
  • func (t *Tools) WriteJSON(w http.ResponseWriter, status int, data interface{}, headers ...http.Header) error
• type UploadedFile

Types

type JSONResponse

type JSONResponse struct {
	Error   bool        `json:"error"`
	Message string      `json:"message"`
	Data    interface{} `json:"data,omitempty"`
}

JSONResponse is the type used for sending JSON around

type Tools

type Tools struct {
	MaxFileSize       int
	AllowedFileTypes  []string // []string{"image/jpeg", "image/png", "image/gif", "image/jpg"}
	MaxJSONSize       int
	AllowUnkownFields bool
}

Tools is the type used to instantiate this module. Any variable of this type will have access to all the methods with the receiver *Tools

func (*Tools) CreateDirIfNotExist

func (t *Tools) CreateDirIfNotExist(path string) error

CreateDirIfNotExist creates a directory and all necessary parents, if it does not exists

func (*Tools) DownloadStaticFile

func (t *Tools) DownloadStaticFile(w http.ResponseWriter, r *http.Request, pathName, displayName string)

DownloadStaticFile it downloads a file, and tries to force the browser to avoid displaying it in the browser window by setting content disposition. It also allows specification of the display name

func (*Tools) ErrorJSON

func (t *Tools) ErrorJSON(w http.ResponseWriter, err error, status ...int) error

ErrorJSON takes an error and optionally a status code, and generates and sends a JSON error message

func (*Tools) PushJSONToRemote

func (t *Tools) PushJSONToRemote(uri string, data interface{}, client ...*http.Client) (*http.Response, int, error)

PushJSONToRemote posts arbitrary data to some URL as JSON, and returns the response, status code and error if any

func (*Tools) RandomString

func (t *Tools) RandomString(n int) string

RandomString returns a string of random characters of length n, using randomStringSource as the source of the string

func (*Tools) ReadJSON

func (t *Tools) ReadJSON(w http.ResponseWriter, r *http.Request, data interface{}) error

ReadJSON tries to read the body of a request and converts it from json into a go data variable

func (*Tools) Slugify

func (t *Tools) Slugify(s string) (string, error)

Slugify is a very simple means of creating a slug from a string

func (*Tools) UploadFiles

func (t *Tools) UploadFiles(r *http.Request, uploadDir string, rename ...bool) ([]*UploadedFile, error)

func (*Tools) UploadOneFile

func (t *Tools) UploadOneFile(r *http.Request, uploadDir string, rename ...bool) (*UploadedFile, error)

func (*Tools) WriteJSON

func (t *Tools) WriteJSON(w http.ResponseWriter, status int, data interface{}, headers ...http.Header) error

WriteJSON takes a response status code and arbitrary data and writes json to the client

type UploadedFile

type UploadedFile struct {
	NewFileName      string
	OriginalFileName string
	FileSize         int64
}

UploadedFiled is a struct used to save information about an uploaded filed