initial import

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: qiangxue
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1.
+2.
+3.
+4.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: qiangxue
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build.yml

@@ -0,0 +1,62 @@
+name: build
+on: [push, pull_request]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:10.8
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: go_restful
+        ports:
+          - 5432/tcp
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+
+      - name: Set up Go 1.13
+        uses: actions/setup-go@v1
+        with:
+          go-version: 1.13
+        id: go
+
+      - name: Set up path
+        run: |
+          echo "::set-env name=GOPATH::$(go env GOPATH)"
+          echo "::add-path::$(go env GOPATH)/bin"
+        shell: bash
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v1
+
+      - name: Get dependencies
+        run: |
+          go mod download
+          go mod verify
+          go get golang.org/x/tools/cmd/cover
+          go get github.com/mattn/goveralls
+          go get golang.org/x/lint/golint
+
+      - name: Run go lint
+        run: make lint
+
+      - name: Build
+        run: make build
+
+      - name: Test
+        env:
+          APP_DSN: postgres://127.0.0.1:${{ job.services.postgres.ports[5432] }}/go_restful?sslmode=disable&user=postgres&password=postgres
+        run: |
+          make migrate
+          make test-cover
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage-all.out

.gitignore

@@ -0,0 +1,24 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Test coverage output
+coverage*.*
+
+# postgres data volume used by postgres server container for testing purpose
+testdata/postgres
+
+# server binary
+./server
+
+# PID file generated to support live reload
+.pid

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2020 Qiang Xue
+
+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.

Makefile

@@ -0,0 +1,112 @@
+MODULE = $(shell go list -m)
+VERSION ?= $(shell git describe --tags --always --dirty --match=v* 2> /dev/null || echo "1.0.0")
+PACKAGES := $(shell go list ./... | grep -v /vendor/)
+LDFLAGS := -ldflags "-X main.Version=${VERSION}"
+
+CONFIG_FILE ?= ./config/local.yml
+APP_DSN ?= $(shell sed -n 's/^dsn:[[:space:]]*"\(.*\)"/\1/p' $(CONFIG_FILE))
+MIGRATE := docker run -v $(shell pwd)/migrations:/migrations --network host migrate/migrate -path=/migrations/ -database "$(APP_DSN)"
+
+PID_FILE := './.pid'
+FSWATCH_FILE := './fswatch.cfg'
+
+.PHONY: default
+default: help
+
+# generate help info from comments: thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+.PHONY: help
+help: ## help information about make commands
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: test
+test: ## run unit tests
+	@echo "mode: count" > coverage-all.out
+	@$(foreach pkg,$(PACKAGES), \
+		go test -p=1 -cover -covermode=count -coverprofile=coverage.out ${pkg}; \
+		tail -n +2 coverage.out >> coverage-all.out;)
+
+.PHONY: test-cover
+test-cover: test ## run unit tests and show test coverage information
+	go tool cover -html=coverage-all.out
+
+.PHONY: run
+run: ## run the API server
+	go run ${LDFLAGS} cmd/server/main.go & echo $$! > $(PID_FILE)
+
+.PHONY: run-stop
+run-stop: ## stop the API server
+	@pkill -P `cat $(PID_FILE)` || true
+
+.PHONY: run-restart
+run-restart: ## restart the API server
+	@make run-stop
+	@printf '%*s\n' "80" '' | tr ' ' -
+	@echo "Source file changed. Restarting server..."
+	@make run
+	@printf '%*s\n' "80" '' | tr ' ' -
+
+run-live: run ## run the API server with live reload support (requires fswatch)
+	@fswatch -x -o --event Created --event Updated --event Renamed -r internal pkg cmd config | xargs -n1 -I {} make run-restart
+
+.PHONY: build
+build:  ## build the API server binary
+	CGO_ENABLED=0 go build ${LDFLAGS} -a -o server $(MODULE)/cmd/server
+
+.PHONY: build-docker
+build-docker: ## build the API server as a docker image
+	docker build -f cmd/server/Dockerfile -t server .
+
+.PHONY: clean
+clean: ## remove temporary files
+	rm -rf server coverage.out coverage-all.out
+
+.PHONY: version
+version: ## display the version of the API server
+	@echo $(VERSION)
+
+.PHONY: db-start
+db-start: ## start the database server
+	@mkdir -p testdata/postgres
+	docker run --rm --name postgres -v $(shell pwd)/testdata:/testdata \
+		-v $(shell pwd)/testdata/postgres:/var/lib/postgresql/data \
+		-e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=go_restful -d -p 5432:5432 postgres
+
+.PHONY: db-stop
+db-stop: ## stop the database server
+	docker stop postgres
+
+.PHONY: testdata
+testdata: ## populate the database with test data
+	make migrate-reset
+	@echo "Populating test data..."
+	@docker exec -it postgres psql "$(APP_DSN)" -f /testdata/testdata.sql
+
+.PHONY: lint
+lint: ## run golint on all Go package
+	@golint $(PACKAGES)
+
+.PHONY: fmt
+fmt: ## run "go fmt" on all Go packages
+	@go fmt $(PACKAGES)
+
+.PHONY: migrate
+migrate: ## run all new database migrations
+	@echo "Running all new database migrations..."
+	@$(MIGRATE) up
+
+.PHONY: migrate-down
+migrate-down: ## revert database to the last migration step
+	@echo "Reverting database to the last migration step..."
+	@$(MIGRATE) down 1
+
+.PHONY: migrate-new
+migrate-new: ## create a new database migration
+	@read -p "Enter the name of the new migration: " name; \
+	$(MIGRATE) create -ext sql -dir /migrations/ $${name// /_}
+
+.PHONY: migrate-reset
+migrate-reset: ## reset database and re-run all migrations
+	@echo "Resetting database..."
+	@$(MIGRATE) drop
+	@echo "Running all database migrations..."
+	@$(MIGRATE) up