unity26org / wheel

Tool written in Go Language for developers to quickly and easily build scalable and lightweight APIs and microservices.

Overview

Wheel is a tool for creating and maintaining scalable and lightweight RESTful APIs. It runs through command line and generates codes (in Go Language), avoiding rework when designing the application architecture and maintenance.

Features

• MVC
• RESTful
• JWT
• Session controller
• Middleware
• Authorization
• Users management
• ORM
• Migration
• Search engine
• Pagination
• Ordering
• Sends email
• Internationalization (I18n)
• Log

See full documentation of default features at http://wheel.unity26.org/features.html

Install

Go

Install Golang

Dependences

$> go get github.com/iancoleman/strcase
$> go get github.com/jinzhu/inflection

Wheel

$> go get github.com/unity26org/wheel
$> cd GOPATH/src/github.com/unity26org/wheel
$> go build -o wheel main.go 
$> sudo mv wheel /usr/bin

GOPATH is where the Go packages and sources are installed

The example above, the executable file was moved to /usr/bin. But feel free to set it up to any directory you want. Just add the path to your .profile, as you see below:

export PATH=$PATH:YOUR_DESIRED_PATH

Usage

Wheel has only two options: new to create new APIs and generate to add new functionalities to your API.

Check help for more details.

wheel --help

New API

Let's create an API for a Blog.

wheel new github.com/account_name/blog

It will output something like this:

"Go" seems installed
Checking dependences...
         ...
Generating new app...
         created: GOPATH/src/github.com/account_name/blog
         ...

Your RESTful API was successfully created!

Change to the root directory using the command line below: 
cd GOPATH/src/github.com/account_name/blog

Set up your database connection modifying the file config/database.yml

For more details call help:
go run main.go --help

Remember: GOPATH is where Go packages and sources are installed

Configure Your API

Database

Currently, Wheel has support only for Postgresql. Edit config/database.yml and set up your database connection.

Email

To connect to your email provider edit config/email.yml and set up with your send email account.

Application

Edit config/app.yml and set the following options:

Item	Definition
app_name	Your app name
app_repository	Repository name
frontend_base_url	URL to be used on your frontend
secret_key	Key to encrypt passwords on database
reset_password_expiration_seconds	After reset password, how long (in seconds) is it valid?
token_expiration_seconds	After a JWT token is generated, how long (in seconds) is it valid?
locales	List of available locales

Locales

Words and phrases for internacionalization. You can add your own locales files, but remember to add to config/app.yml configuration file first.

Running

Before running you must be sure your database schema is up to date, just run the migrate mode:

$> go run main.go --mode=migrate

Run:

$> go run main.go

Now go to http://localhost:8081 and you'll see:

{
  system_message: {
    type: "notice",
    content: "Yeah! Wheel is working!"
  }
}

See full documentation of default resources at http://wheel.unity26.org/default-resources.html

New CRUD

Based on the Blog API above, let's create a new CRUD.

Don't forget to call the directory where the application were generated.

cd GOPATH/src/github.com/account_name/blog
wheel g scaffold post title:string description:text published:bool user:references

It will output something like this:

"Go" seems installed
Checking dependences...
         ...
Generating new CRUD...
         created: app/entities/post_entity.go
         created: app/models/post/post_model.go
         created: app/models/post/post_view.go
         created: app/handlers/post_handler.go
         updated: routes/routes.go
         updated: db/schema/migrate.go
         updated: routes/authorize.go

After any changing, don't forget to run the migrate mode:

$> go run main.go --mode=migrate
$> go run main.go

Full Documentation

See full documentation at http://wheel.unity26.org/

License

Wheel is released under the MIT License.

wheel's Issues

Myself handler is not using JSON as input

Myself handler is still accepting form-data as input. It needs to be updated.

Substitute "id" for "uuid" when showing data

As an admin user I want to hide column "id" (let it for database relationship only) and show column "uuid" to avoid data enumeration.

Important: Apply UUID version 4.

Study for figure out best way to implement migration

MIgration must not be the GORM simple solution. It must be more complete and contains the rollback option. Just like Ruby on Rails.

Test coverage report not being generated

When tests check for errors messages, for invalid generate command, coverage report is not being generated.

Implement new migration

Return HTTP 404 status if database entry was not found

As an user I want have a HTTP 404 status if database entry was not found to compliance to API definitions.

Fatal error if email configuration is not set

When user sign ups this error is showed:

[FATAL] 2020/02/08 22:17:17 dial tcp: lookup smtp.example.com: no such host
panic: dial tcp: lookup smtp.example.com: no such host

goroutine 47 [running]:
log.(*Logger).Panic(0xc00008a190, 0xc000099d70, 0x1, 0x1)
/usr/local/go/src/log/log.go:212 +0xbe
github.com/adilsonchacon/blog/commons/mailer.Send(0xc0002b6990, 0xc, 0xc0000926e0, 0x159, 0x1)
/home/acc/go/src/github.com/adilsonchacon/blog/commons/mailer/mailer.go:125 +0x6e9
created by github.com/adilsonchacon/blog/app/handlers.SessionSignUp
/home/acc/go/src/github.com/adilsonchacon/blog/app/handlers/session_handler.go:154 +0x352
exit status 2

Check and log error for invalid JSON in body request

As an Wheel user I want to be notified if invalid JSON in body request is sent. It should be logged and return an error 400 (Bad Request).

Rename "Order" to "Sort"

As an user I want to use "sort" and not "order" to avoid missunderstanding

Default 404 message is responding HTTP 200 status

Default 404 message is responding HTTP 200 status

Refactory for gitignore

Remove all lines about .AppleDouble and .DS_Store and substitute for simples ".AppleDouble" and ".DS_Store".

Set SessionCheck as deprecated and use SessionUser instead

The name "SessionCheck" is not the best name for get the user ID from sessions. So, let's deprecate it and use "SessionUser" instead.

Add support for Mysql and SQLite

As an user I want to have the options Mysql and SQLite too to implement my project. And not just PostgreSQL.

New handler action on Users for update password only

As an admin user I want to have a separate action only for change others users password to avoid miss understanding with the itself update action.

Exemple: PUT /users/{id}/password

Strong password policy for users resources

As an user I want to my password be tested if it is strong enough to improve security.

Important: https://github.com/nbutton23/zxcvbn-go

Change header "token" to "Authorization" for JWT

As an API consumer I want to the information "token" in header of the requests be changed to "Authorizarion" and its contents starts with "Bearer " to make it compatible with others systems.

Wheel does not alert when generating new CRUD if resource name is invalid

When generating new CRUD, if resource name is invalid or missing Wheel does not alert.

The example below the resource name is missing:

wheel generate scaffold title:string description:text

The correct way is

wheel generate scaffold post title:string description:text

Lib Go Modules

Study to use this lib: https://blog.golang.org/using-go-modules

Columns created_at, updated_at and deleted_at on users resources should not be shown

As an admin user I don't want the columns created_at, updated_at and deleted_at be shown when reading users resources to improve security.