added initial swagger docs.

2018-03-14 07:18:19 -06:00
parent 0a6fa4bc53
commit 22b5e89784
17 changed files with 333 additions and 27 deletions
--- a/src/docs/.gitignore
+++ b/src/docs/.gitignore
@@ -0,0 +1 @@
+public/swagger.json
--- a/src/docs/public.go
+++ b/src/docs/public.go
@@ -0,0 +1,11 @@
+package docs
+
+import "sour.is/x/toolbox/httpsrv"
+
+func init() {
+	httpsrv.AssetRegister("docs", httpsrv.AssetRoutes{
+		{"Assets", "/docs/", httpsrv.FsHtml5(assetFS())},
+	})
+}
+
+//go:generate go-bindata-assetfs -pkg docs public/
--- a/src/docs/public/favicon-16x16.png
+++ b/src/docs/public/favicon-16x16.png
--- a/src/docs/public/favicon-32x32.png
+++ b/src/docs/public/favicon-32x32.png
--- a/src/docs/public/index.html
+++ b/src/docs/public/index.html
@@ -0,0 +1,95 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
+  <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+  <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  <style>
+    html
+    {
+      box-sizing: border-box;
+      overflow: -moz-scrollbars-vertical;
+      overflow-y: scroll;
+    }
+    *,
+    *:before,
+    *:after
+    {
+      box-sizing: inherit;
+    }
+
+    body {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+          <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+
+
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
+
+<script src="./swagger-ui-bundle.js"> </script>
+<script src="./swagger-ui-standalone-preset.js"> </script>
+<script>
+window.onload = function() {
+
+  // Build a system
+  const ui = SwaggerUIBundle({
+    url: "/docs/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  })
+
+  window.ui = ui
+}
+</script>
+</body>
+
+</html>
--- a/src/docs/public/oauth2-redirect.html
+++ b/src/docs/public/oauth2-redirect.html
@@ -0,0 +1,67 @@
+<!doctype html>
+<html lang="en-US">
+<body onload="run()">
+</body>
+</html>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1);
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&")
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value)
+                }
+        ) : {}
+
+        isValid = qp.state === sentState
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode"||
+          oauth2.auth.schema.get("flow") === "authorizationCode"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+</script>
--- a/src/docs/public/swagger-ui-bundle.js
+++ b/src/docs/public/swagger-ui-bundle.js
--- a/src/docs/public/swagger-ui-standalone-preset.js
+++ b/src/docs/public/swagger-ui-standalone-preset.js
--- a/src/docs/public/swagger-ui.css
+++ b/src/docs/public/swagger-ui.css
--- a/src/docs/public/swagger-ui.js
+++ b/src/docs/public/swagger-ui.js
--- a/src/routes/paste.go
+++ b/src/routes/paste.go
@@ -0,0 +1,220 @@
+package routes
+
+import (
+	"bufio"
+	"crypto/rand"
+	"crypto/sha256"
+	"encoding/base64"
+	"encoding/json"
+	"io"
+	"io/ioutil"
+	"net/http"
+	"os"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/gorilla/mux"
+	"golang.org/x/sys/unix"
+	"sour.is/x/toolbox/httpsrv"
+	"sour.is/x/toolbox/log"
+)
+
+var store string
+var randBytes int
+
+func init() {
+	httpsrv.RegisterModule("paste", setConfig)
+
+	httpsrv.HttpRegister("paste", httpsrv.HttpRoutes{
+		{"getRandom", "GET", "/paste/rng", getRandom},
+		{"getPaste", "GET", "/paste/{id}", getPaste},
+		{"getPaste", "GET", "/paste/get/{id}", getPaste},
+		{"postPaste", "POST", "/paste", postPaste},
+
+		{"getRandom", "GET", "/api/rng", getRandom},
+		{"getPaste", "GET", "/api/{id}", getPaste},
+		{"getPaste", "GET", "/api/get/{id}", getPaste},
+		{"postPaste", "POST", "/api", postPaste},
+	})
+}
+
+func setConfig(config map[string]string) {
+
+	store = "data/"
+	if config["store"] != "" {
+		store = config["store"]
+	}
+
+	if !chkStore(store) {
+		log.Criticalf("[routes::Paste] Store location [%s] does not exist or is not writable.", store)
+	}
+	log.Noticef("[paste::getPaste] Store location set to [%s]", store)
+
+	randBytes = 1024
+	if config["random"] != "" {
+		randBytes, _ = strconv.Atoi(config["random"])
+		log.Noticef("[paste:getRandom] set random size to %d bytes", randBytes)
+	}
+}
+
+func chkStore(path string) bool {
+	file, err := os.Stat(path)
+	if err == nil {
+		return true
+	}
+	if os.IsNotExist(err) {
+		return false
+	}
+	if !file.IsDir() {
+		return false
+	}
+	if unix.Access(path, unix.W_OK&unix.R_OK) != nil {
+		return false
+	}
+
+	return true
+}
+
+func chkFile(path string) bool {
+	file, err := os.Stat(path)
+	if err == nil {
+		return true
+	}
+	if os.IsNotExist(err) {
+		return false
+	}
+	if file.IsDir() {
+		return false
+	}
+	if unix.Access(path, unix.W_OK&unix.R_OK) != nil {
+		return false
+	}
+
+	return true
+}
+
+func chkGone(path string) bool {
+	file, err := os.Stat(path)
+	if err != nil {
+		return true
+	}
+	if file.Size() == 0 {
+		return true
+	}
+	return false
+}
+
+func getRandom(w http.ResponseWriter, r *http.Request) {
+	s := make([]byte, randBytes)
+	rand.Read(s)
+
+	w.Header().Set("content-type", "application/octet-stream")
+	w.WriteHeader(http.StatusOK)
+	w.Write(s)
+}
+
+func getPaste(w http.ResponseWriter, r *http.Request) {
+
+	vars := mux.Vars(r)
+	id := vars["id"]
+
+	if !chkFile(store + id) {
+		w.WriteHeader(http.StatusNotFound)
+		w.Write([]byte("ERR Not Found"))
+		return
+	}
+
+	if chkGone(store + id) {
+		w.WriteHeader(http.StatusGone)
+		w.Write([]byte("ERR Gone"))
+		return
+	}
+
+	head, err := os.Open(store + id)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer head.Close()
+
+	keep := true
+	scanner := bufio.NewScanner(head)
+	for scanner.Scan() {
+		txt := scanner.Text()
+		log.Debug(txt)
+
+		if txt == "" {
+			break
+		}
+
+		if strings.HasPrefix(txt, "exp:") {
+			now := time.Now().Unix()
+			exp, err := strconv.ParseInt(strings.TrimSpace(strings.TrimPrefix(txt, "exp:")), 10, 64)
+			if err != nil {
+				log.Warning(err)
+			}
+
+			log.Debugf("%d > %d", now, exp)
+			if now > exp {
+				w.WriteHeader(http.StatusGone)
+				w.Write([]byte("ERR Gone"))
+
+				deleteFile(store + id)
+
+				return
+			}
+		}
+
+		if strings.HasPrefix(txt, "burn:") {
+			burn := strings.TrimSpace(strings.TrimPrefix(txt, "burn:"))
+
+			if burn == "true" {
+				keep = false
+			}
+		}
+	}
+
+	file, _ := os.Open(store + id)
+	defer file.Close()
+
+	w.WriteHeader(http.StatusOK)
+
+	scanner = bufio.NewScanner(file)
+	for scanner.Scan() {
+		w.Write(scanner.Bytes())
+		w.Write([]byte("\n"))
+	}
+
+	if !keep {
+		deleteFile(store + id)
+	}
+}
+
+func postPaste(w http.ResponseWriter, r *http.Request) {
+	defer r.Body.Close()
+
+	body, err := ioutil.ReadAll(io.LimitReader(r.Body, 1048576))
+	checkErr(err, w)
+
+	s256 := sha256.Sum256(body)
+	id := base64.RawURLEncoding.EncodeToString(s256[12:])
+
+	ioutil.WriteFile(store+id, body, 0644)
+
+	w.WriteHeader(http.StatusCreated)
+	w.Write([]byte("OK " + id))
+
+	w.WriteHeader(http.StatusCreated)
+}
+
+func checkErr(err error, w http.ResponseWriter) {
+	if err != nil {
+		w.WriteHeader(http.StatusBadRequest)
+		json.NewEncoder(w).Encode(err)
+		panic(err)
+	}
+}
+
+func deleteFile(path string) {
+	ioutil.WriteFile(path, []byte(""), 0644)
+}
--- a/src/routes/paste.go.db
+++ b/src/routes/paste.go.db
@@ -0,0 +1,195 @@
+package routes
+
+import (
+	"sour.is/x/httpsrv"
+	"os"
+	"golang.org/x/sys/unix"
+	"log"
+	"net/http"
+	"sour.is/x/ident"
+	"crypto/rand"
+	"encoding/base64"
+	"crypto/sha256"
+	"io/ioutil"
+	"io"
+	"bufio"
+	"github.com/gorilla/mux"
+	"strings"
+	"time"
+	"strconv"
+)
+
+var store string
+var randBytes int
+
+func init() {
+	httpsrv.RegisterModule("paste", SetConfig)
+
+	httpsrv.IdentRegister("paste", httpsrv.IdentRoutes{
+		{ "Paste", "GET",    "/paste/rng",     GetRandom, },
+		{ "Paste", "GET",    "/paste/{id}",     GetPaste, },
+		{ "Paste", "GET",    "/paste/get/{id}", GetPaste, },
+		{ "Paste", "POST",   "/paste",         PostPaste, },
+		{ "Paste", "DELETE", "/paste/{id}",  DeletePaste, },
+
+		{ "Paste", "GET",    "/api/rng",       GetRandom, },
+		{ "Paste", "GET",    "/api/{id}",       GetPaste, },
+		{ "Paste", "GET",    "/api/get/{id}",   GetPaste, },
+		{ "Paste", "POST",   "/api",           PostPaste, },
+		{ "Paste", "DELETE", "/api/{id}",    DeletePaste, },
+	})
+}
+
+func SetConfig (config map[string]string) {
+
+	store = "data/"
+	if config["store"] != "" {
+		store = config["store"]
+	}
+
+	if !chkStore(store) {
+		log.Fatalf("[routes::Paste] Store location [%s] does not exist or is not writable.", store)
+	}
+
+	randBytes = 1024
+	if config["random"] != "" {
+		randBytes, _ = strconv.Atoi(config["random"])
+	}
+}
+
+func chkStore(path string) bool {
+	file, err := os.Stat(path)
+	if err == nil { return true }
+	if os.IsNotExist(err) { return false }
+	if !file.IsDir() { return false }
+	if unix.Access(path, unix.W_OK & unix.R_OK) != nil { return false }
+
+	return true
+}
+
+func chkFile(path string) bool {
+	file, err := os.Stat(path)
+	if err == nil { return true }
+	if os.IsNotExist(err) { return false }
+	if file.IsDir() { return false }
+	if unix.Access(path, unix.W_OK & unix.R_OK) != nil { return false }
+
+	return true
+}
+
+func chkGone(path string) bool {
+	file, err := os.Stat(path)
+	if err != nil { return true }
+	if file.Size() == 0 { return true }
+	return false
+}
+
+func GetRandom(w http.ResponseWriter, r *http.Request, i ident.Ident) {
+	w.WriteHeader(http.StatusOK)
+	w.Header().Set("content-type","application/octet-stream")
+	s := make([]byte, randBytes)
+	rand.Read(s)
+
+	w.Write(s)
+}
+
+func GetPaste(w http.ResponseWriter, r *http.Request, i ident.Ident) {
+	vars := mux.Vars(r)
+	id := vars["id"]
+
+	if !chkFile(store + id) {
+		w.WriteHeader(http.StatusNotFound)
+		w.Write([]byte("ERR Not Found"))
+		return
+	}
+
+	if chkGone(store + id) {
+		w.WriteHeader(http.StatusGone)
+		w.Write([]byte("ERR Gone"))
+		return
+	}
+
+	head, err := os.Open(store + id)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer head.Close()
+
+	keep := true
+
+	scanner := bufio.NewScanner(head)
+	for scanner.Scan() {
+		txt := scanner.Text()
+		log.Println(txt)
+		if (txt == "") {
+			break
+		}
+
+		if strings.HasPrefix(txt, "exp:") {
+			now := time.Now().Unix()
+			exp, err := strconv.ParseInt(strings.TrimSpace(strings.TrimPrefix(txt, "exp:")), 10, 64)
+			if err != nil {
+				log.Print(err)
+			}
+
+			if now > exp {
+				log.Printf("%d > %d", now, exp)
+				w.WriteHeader(http.StatusGone)
+				w.Write([]byte("ERR Gone"))
+
+				Delete(store + id)
+
+				return
+			}
+		}
+
+		if strings.HasPrefix(txt, "burn:") {
+			burn := strings.TrimSpace(strings.TrimPrefix(txt, "burn:"))
+
+			if burn == "true" {
+				keep = false
+			}
+		}
+	}
+
+	file, _ := os.Open(store + id)
+	defer file.Close()
+
+	w.WriteHeader(http.StatusOK)
+
+	scanner = bufio.NewScanner(file)
+	for scanner.Scan() {
+		w.Write(scanner.Bytes())
+		w.Write([]byte("\n"))
+	}
+
+	if !keep {
+		Delete(store + id)
+	}
+}
+
+func PostPaste(w http.ResponseWriter, r *http.Request, i ident.Ident) {
+	body, _ := ioutil.ReadAll(io.LimitReader(r.Body, 1048576))
+
+	s256 := sha256.Sum256(body)
+	id := base64.RawURLEncoding.EncodeToString(s256[12:])
+
+	ioutil.WriteFile(store + id, body, 0644)
+
+	w.WriteHeader(http.StatusCreated)
+	w.Write([]byte("OK " + id))
+}
+
+func DeletePaste(w http.ResponseWriter, r *http.Request, i ident.Ident) {
+	vars := mux.Vars(r)
+	id := vars["id"]
+
+	Delete(store + id)
+
+	w.WriteHeader(http.StatusNoContent)
+	w.Write([]byte("OK"))
+}
+
+func Delete(path string) {
+	ioutil.WriteFile(path, []byte(""), 0644)
+}
--- a/src/routes/public.go
+++ b/src/routes/public.go
@@ -0,0 +1,11 @@
+package routes
+
+import "sour.is/x/toolbox/httpsrv"
+
+func init() {
+	httpsrv.AssetRegister("paste", httpsrv.AssetRoutes{
+		{"Assets", "/", httpsrv.FsHtml5(assetFS())},
+	})
+}
+
+//go:generate go-bindata-assetfs -pkg routes  -prefix ../../ ../../public/ ../../public/static/css/ ../../public/static/js/  ../../public/static/media/