Basic forwarding mechanism

Enable parsing of SQL time to time.Time, ErrNotFound
Format Migrations
Add Shortcut struct with matcher field
Add Response with JSON and HTML rendering
Fix headers in middlewares

Signed-off-by: David Kröll <[email protected]>

Author: davidkroell

.env.example

@@ -0,0 +1,9 @@
+DB_CONNECTION=mysql
+DB_USERNAME=
+DB_PASSWORD=
+DB_HOST=
+DB_DATABASE=
+
+PORT=9999
+
+JWT_SECRET=

models/database.go

@@ -2,6 +2,7 @@ package models
 
 import (
 	"database/sql"
+	"errors"
 	_ "github.com/go-sql-driver/mysql"
 	"log"
 	"sync"
@@ -11,6 +12,12 @@ import (
 var db Database
 var singleton sync.Once
 
+var ErrNotFound = errors.New("not found")
+
+type Relateable interface {
+	LoadRelated() (err error)
+}
+
 type DBModel interface {
 	Save() (err error)
 	Delete() (err error)
@@ -24,11 +31,18 @@ type Database struct {
 	*sql.DB
 }
 
+type MatchingField string
+
+const (
+	ID              MatchingField = "ID"
+	ShortIdentifier MatchingField = "ShortIdentifier"
+)
+
 func InitDatabase(config DBConfig) *Database {
 	// make sure this code only gets executed once
 	singleton.Do(func() {
 		database, err := sql.Open(config.Driver,
-			config.Username+":"+config.Password+"@tcp("+config.Host+")/"+config.Name)
+			config.Username+":"+config.Password+"@tcp("+config.Host+")/"+config.Name+"?parseTime=true")
 		if err != nil {
 			log.Fatal(err)
 		}

models/migrations.go

@@ -3,8 +3,8 @@ package models
 import "log"
 
 const (
-	createUsersTable string = `
-CREATE TABLE Users (
+	createUsersTable string = `CREATE TABLE Users
+(
   ID        CHAR(36) PRIMARY KEY,
   Email     CHAR(50)    NOT NULL UNIQUE,
   Firstname VARCHAR(50) NOT NULL,
@@ -13,21 +13,22 @@ CREATE TABLE Users (
   CreatedAt DATETIME    NOT NULL DEFAULT CURRENT_TIMESTAMP,
   UpdatedAt DATETIME    NOT NULL DEFAULT CURRENT_TIMESTAMP,
   LastLogin DATETIME,
-    CHECK (UpdatedAt >= CreatedAt)
+  CHECK (UpdatedAt >= CreatedAt)
 )
   ENGINE = InnoDB;`
 	dropUsersTable string = `DROP TABLE IF EXISTS Users;`
 
-	createShortcutsTable string = `
-CREATE TABLE Shortcuts (
+	createShortcutsTable string = `CREATE TABLE Shortcuts
+(
   ID              CHAR(36) PRIMARY KEY,
-  ShortIdentifier CHAR(50)      NOT NULL,
-  RedirectionURL  VARCHAR(1024) NOT NULL,
-  CreatedAt       DATETIME      NOT NULL DEFAULT CURRENT_TIMESTAMP	,
+  ShortIdentifier CHAR(50)      NOT NULL UNIQUE,
+  RedirectURL     VARCHAR(1024) NOT NULL,
+  RedirectStatus  INT(3)        NOT NULL,
+  CreatedAt       DATETIME      NOT NULL DEFAULT CURRENT_TIMESTAMP,
   UpdatedAt       DATETIME      NOT NULL DEFAULT CURRENT_TIMESTAMP,
   ValidThru       DATETIME      NOT NULL,
   UserID          CHAR(36)      NOT NULL,
-  
+
   CHECK (ValidThru > CreatedAt),
   CHECK (UpdatedAt >= CreatedAt),
 
@@ -37,8 +38,8 @@ CREATE TABLE Shortcuts (
 `
 	dropShortcutsTable string = `DROP TABLE IF EXISTS Shortcuts;`
 
-	createShortcutLogsTable string = `
-CREATE TABLE ShortcutLog (
+	createShortcutLogsTable string = `CREATE TABLE ShortcutLog
+(
   ShortcutID    CHAR(36),
   IPAddress     VARCHAR(39),
   UserAgent     VARCHAR(100),

models/shortcuts.go

@@ -0,0 +1,50 @@
+package models
+
+import (
+	"database/sql"
+	"fmt"
+	"time"
+)
+
+type Shortcut struct {
+	ID             string
+	ShortIdentifer string
+	RedirectURL    string
+	RedirectStatus int
+	CreatedAt      time.Time
+	UpdatedAt      time.Time
+	ValidThru      time.Time
+	User           *User
+	userID         string
+}
+
+const (
+	selectShortcut      string = `SELECT * FROM Shortcuts WHERE %s = ?;`
+	loadRelatedShortcut string = `SELECT * FROM Users WHERE ID = ?;`
+)
+
+func ShortcutBy(matcher MatchingField, value string) (*Shortcut, error) {
+	s := &Shortcut{}
+
+	// make sure user cannot parse matcher by malformed input
+	row := db.QueryRow(fmt.Sprintf(selectShortcut, matcher), value)
+	err := row.Scan(&s.ID, &s.ShortIdentifer, &s.RedirectURL, &s.RedirectStatus, &s.CreatedAt, &s.UpdatedAt, &s.ValidThru, &s.userID)
+
+	if err != nil && err != sql.ErrNoRows {
+		return nil, err
+	} else if err == sql.ErrNoRows {
+		return nil, ErrNotFound
+	}
+
+	return s, nil
+}
+
+func (s *Shortcut) LoadRelated() (err error) {
+	result := db.QueryRow(loadRelatedShortcut, s.userID)
+
+	if err := result.Scan(s.User.ID, s.User.Email, s.User.Firstname, s.User.Lastname, s.User.Password, s.User.CreatedAt, s.User.UpdatedAt, s.User.LastLogin); err != nil {
+		return err
+	}
+
+	return nil
+}

routes/html.go

@@ -0,0 +1,25 @@
+package routes
+
+import (
+	"html/template"
+	"log"
+	"net/http"
+)
+
+var shortcutNotFound = *template.Must(template.New("shortcutNotFound").Parse(`<html lang="en">
+<body>
+<h1>404</h1>
+<h2>We could not find the requested page</h2>
+<h3>Error code: {{.Code}}</h3>
+
+<p>{{.Message}}</p>
+</body>
+</html>`))
+
+func (r Response) HTML(w http.ResponseWriter, statusCode int, tmpl template.Template) {
+	w.WriteHeader(statusCode)
+
+	if err := tmpl.Execute(w, r); err != nil {
+		log.Println(err)
+	}
+}

routes/http_bodies.go

@@ -1,5 +1,22 @@
 package routes
 
-type ErrorResponse struct {
-	Message string `json:"message"`
+import (
+	"encoding/json"
+	"log"
+	"net/http"
+)
+
+type Response struct {
+	Success bool   `json:"success"`
+	Code    int    `json:"code,omitempty"`
+	Message string `json:"message,omitempty"`
+}
+
+func (r Response) JSON(w http.ResponseWriter, statusCode int) {
+	w.WriteHeader(statusCode)
+
+	err := json.NewEncoder(w).Encode(r)
+	if err != nil {
+		log.Println(err)
+	}
 }

routes/middlewares.go

@@ -1,11 +1,13 @@
 package routes
 
 import (
-	"encoding/json"
 	"log"
 	"net/http"
 )
 
+var jsonBody = "application/json"
+var htmlBody = "text/html"
+
 // MiddlewareFunc is a custom Middleware type
 type MiddlewareFunc func(http.Handler) http.Handler
 
@@ -24,15 +26,22 @@ func HeaderBinding(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 
 		if r.Method == "POST" {
-			if r.Header.Get("Content-Type") != "application/json" {
-				_ = json.NewEncoder(w).Encode(ErrorResponse{
-					"Wrong Content-Type in POST request. application/json expected",
-				})
+			if r.Header.Get("Content-Type") != jsonBody {
+				Response{
+					Success: false,
+					Code:    1000,
+					Message: "Wrong Content-Type in POST request. application/json expected",
+				}.JSON(w, 400)
 				return
 			}
 		}
 
-		w.Header().Set("Content-Type", "application/json")
+		if r.Header.Get("Accept") == jsonBody {
+			w.Header().Set("Content-Type", jsonBody)
+		} else {
+			w.Header().Set("Content-Type", htmlBody)
+		}
+
 		next.ServeHTTP(w, r)
 	})
 }

routes/router.go

@@ -21,5 +21,7 @@ func InitRouter() (router mux.Router) {
 	api.HandleFunc("/user", getUser).Methods("GET")
 	api.HandleFunc("/user", updateUser).Methods("PUT")
 
+	router.HandleFunc("/{shortId:[a-zA-Z0-9]+}", forwardShortcut).Methods("GET")
+
 	return
 }

routes/shortcuts.go

@@ -1,6 +1,10 @@
 package routes
 
-import "net/http"
+import (
+	"github.com/davidkroell/shortcut/models"
+	"github.com/gorilla/mux"
+	"net/http"
+)
 
 func createShortcut(w http.ResponseWriter, r *http.Request) {
 
@@ -21,3 +25,33 @@ func updateShortcut(w http.ResponseWriter, r *http.Request) {
 func deleteShortcut(w http.ResponseWriter, r *http.Request) {
 
 }
+
+func forwardShortcut(w http.ResponseWriter, r *http.Request) {
+	vars := mux.Vars(r)
+	shortId := vars["shortId"]
+
+	shortcut, err := models.ShortcutBy(models.ShortIdentifier, shortId)
+	if err != nil && err != models.ErrNotFound {
+		Response{
+			Success: false,
+			Code:    1001,
+			Message: "Bad Request. " + err.Error(),
+		}.JSON(w, 400)
+		return
+	} else if err == models.ErrNotFound {
+		resp := Response{
+			Success: false,
+			Code:    1002,
+			Message: shortId + " not found",
+		}
+
+		if w.Header().Get("Content-Type") == jsonBody {
+			resp.JSON(w, 404)
+		} else {
+			resp.HTML(w, 404, shortcutNotFound)
+		}
+		return
+	}
+
+	http.Redirect(w, r, shortcut.RedirectURL, shortcut.RedirectStatus)
+}