toolkit

README

Tool

A simple example of 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 exist
• Create a URL safe slug from a string

Installation

go get -u github.com/tsawler/toolkit

Documentation

Index

• type Tools
  • func (t *Tools) CreateDirIfNotExist(path string) error
  • func (t *Tools) RandomString(length int) string
  • func (t *Tools) UploadFile(r *http.Request, uploadDir string, rename ...bool) (*UploadedFile, error)
  • func (t *Tools) UploadFiles(r *http.Request, uploadDir string, rename ...bool) ([]*UploadedFile, error)
• type UploadedFile

Types

type Tools

type Tools struct {
	MaxFileSize      int
	AllowedFileTypes []string
}

func (*Tools) CreateDirIfNotExist

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

func (*Tools) RandomString

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

func (*Tools) UploadFile

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

func (*Tools) UploadFiles

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

type UploadedFile

type UploadedFile struct {
	NewFileName      string
	OriginalFileName string
	FileSize         int64
}