Merge pull request #6 from Coding-Web-Community/development

First merge from dev into main

Author: Mathis Van Eetvelde

.gitignore

@@ -0,0 +1 @@
+store.json

.travis.yml

@@ -0,0 +1,10 @@
+language: go
+
+go:
+  - 1.x
+  - 1.15
+
+script:
+  - cd api/src
+  - go test -v .
+  - go build

README.md

@@ -1,2 +1,23 @@
+[![Build Status](https://travis-ci.org/Coding-Web-Community/CodingBump.svg?branch=master)](https://travis-ci.org/Coding-Web-Community/CodingBump)
 # CodingBump
 Disboard clone (for now)
+
+# Architecture
+
+![](https://media.discordapp.net/attachments/760959186745163806/761885595857190972/unknown.png)
+## API
+- Keeps track of server list, bump times, etc
+
+## Discord Bot
+- Discord bot POSTS guild ID's to the API when bumped
+- other things about the Discord bot
+
+## Website
+- Website GETS recently bumped guilds
+- Things about the website
+
+# Contributing
+
+Please make a new branch `{name}/development/{thing you're working on}` and only PR into the `development` branch!
+
+IE: `mathis/development/api` -> PR -> `development`

api/README.md

@@ -0,0 +1,152 @@
+[![Build Status](https://travis-ci.org/Coding-Web-Community/CodingBump.svg?branch=master)](https://travis-ci.org/Coding-Web-Community/CodingBump)
+# Central API
+
+## Usage
+Launch the API the following way:
+```
+cd src
+go build -o main .
+./main
+```
+or
+```
+cd src
+go run .
+```
+
+# Endpoints
+This is where we describe the API endpoints and how they react to certain data.
+
+
+# bump
+
+**URL** Structure:
+```
+http://localhost:8080/V1/bump
+```
+
+Method: **POST**
+
+**JSON** Body:
+```json
+{"guildId": 636145886279237652}
+```
+
+## **Responses**:
+
+
+### **200**
+- *200 - Ok* | **guildId** successfully bumped!
+```json
+{
+    "code": 200,
+    "message": "Guild bumped",
+    "payload": {
+        "guildId": 636145886279237652,
+        "timestamp": 1601832221
+    }
+}
+```
+
+- *200 - Added* | **guildId** successfully bumped!
+```json
+{
+    "code": 200,
+    "message": "Guild added and bumped",
+    "payload": {
+        "guildId": 636145886279237152,
+        "timestamp": 1601832254
+    }
+}
+```
+
+### **400**
+- *400 - BadRequest* | Request body contains invalid character, most likely a string or a non number
+allowed characters: 0-9
+```json
+{
+    "code": 400,
+    "message": "Request body contains invalid character",
+    "payload": {
+        "guildId": 0,
+        "timestamp": 0
+    }
+}
+```
+- *400 - BadRequest* | **guildId** needs to be 18 characters long
+```json
+{
+    "code": 400,
+    "message": "GuildId does not conform to 18 character long integer requirement",
+    "payload": {
+        "guildId": 636149237152,
+        "timestamp": 0
+    }
+}
+```
+
+### **425**
+- *425 - TooEarly* | **guildId** bump delta hasn't exceeded the bumping interval. Try again later
+```json
+{
+    "code": 425,
+    "message": "Guild bumped too early",
+    "payload": {
+        "guildId": 636145886279237152,
+        "timestamp": 1601832360
+    }
+}
+```
+
+### **500**
+- *500 - InternalServerError* | Unrecoverable internal server error. Try again later
+```json
+{
+    "code": 425,
+    "message": "",
+    "payload": {
+        "guildId": 0,
+        "timestamp": 0
+    }
+}
+```
+
+*Additional note*:
+The **payload** is always a direct and latest representation of the stored guild in the database. That means when getting a `200` or `425` status code, the `timestamp` attribute represents the time that guild was last bumped in a UNIX timestamp.
+
+# fetch
+
+**URL** Structure:
+```
+http://localhost:8080/V1/fetch
+```
+
+Method: **GET**
+
+## **Responses**:
+
+
+### **200**
+- *200 - Ok* | **guildId** successfully bumped!
+```json
+{
+    "code":200,
+    "message":"Ok",
+    "paypload":[
+      {"guildId":636145886279237699,"timestamp":1602394289},
+      {"guildId":636123886245557612,"timestamp":1602394230}
+    ]
+}
+```
+
+### **400**
+- *400 - BadRequest*
+```json
+{
+    "code":400,
+    "message":"BadRequest",
+    "paypload":[
+      {}
+    ]
+  }
+```

api/src/bump.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"log"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+)
+
+func BumpGuild(w http.ResponseWriter, r *http.Request) {
+	var guild Guild
+
+	// Read request body
+	body, err := ioutil.ReadAll(r.Body)
+	if err != nil {
+		log.Print(err)
+		WriteBumpResponse(w, http.StatusInternalServerError, "Unable to read request body", guild)
+		return
+	}
+
+	// Unmarshal body into guild object
+	err = json.Unmarshal(body, &guild)
+	if err != nil {
+		log.Print(err)
+		if strings.Contains(err.Error(), "invalid character") {
+			WriteBumpResponse(w, http.StatusBadRequest, "Request body contains invalid character", guild)
+			return
+		}
+		WriteBumpResponse(w, http.StatusBadRequest, "Unable to process request body", guild)
+		return
+	}
+
+	// check if GuildId's length is 18
+	if len(strconv.Itoa(guild.GuildId)) != 18 {
+		errString := "GuildId does not conform to 18 character long integer requirement"
+		log.Print(errString)
+		WriteBumpResponse(w, http.StatusBadRequest, errString, guild)
+		return
+	}
+
+	// Adding timestamp to guild object
+	ts := time.Now().Unix()
+	guild.Timestamp = ts
+
+	if !gs.GuildInStore(guild) {
+		// guild is not yet present in GuildStore
+		gs.AddToStore(guild)
+		WriteBumpResponse(w, http.StatusOK, "Guild added and bumped", guild)
+	} else {
+		// guild is present in GuildStore
+		if gs.PastInterval(guild) {
+			// guild.Timestamp has exceeded BUMP_INTERVAL, Timestamp has been updated (bumped)
+			WriteBumpResponse(w, http.StatusOK, "Guild bumped", guild)
+		} else {
+			// guild.Timestamp has not exceeded BUMP_INTERVAL, not updated
+			guild.Timestamp = gs.GetTimestamp(guild)
+			WriteBumpResponse(w, http.StatusTooEarly, "Guild bumped too early", guild)
+		}
+	}
+
+	err = gs.WriteStore()
+	if err != nil {
+		log.Panic(err)
+		WriteBumpResponse(w, http.StatusInternalServerError, "Could not store changes", guild)
+		return
+	}
+}