refactored functions andadded test cases

Author: codedfinger

class.go

@@ -0,0 +1,95 @@
+package main
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"net/http"
+
+	"github.com/julienschmidt/httprouter"
+)
+
+// Models
+type Class struct {
+	ID        int    `json:"id"`
+	Name      string `json:"name"`
+	StartDate string `json:"startdate"`
+	EndDate   string `json:"enddate"`
+	Capacity  string `json:"capacity"`
+}
+
+var classes = []Class{}
+
+func addClass(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
+
+	body, err := ioutil.ReadAll(r.Body)
+	if err != nil {
+		failureResponse(w, err.Error())
+		return
+	}
+
+	type addClassRequestBody struct {
+		Name      *string `json:"name"`
+		StartDate *string `json:"startdate"`
+		EndDate   *string `json:"enddate"`
+		Capacity  *string `json:"capacity"`
+	}
+
+	var classBody addClassRequestBody
+
+	err = json.Unmarshal(body, &classBody)
+	if err != nil {
+		failureResponse(w, err.Error())
+		return
+	}
+
+	if classBody.Name == nil {
+		failureResponse(w, `name parameter is not specified or empty`)
+		return
+	}
+
+	if classBody.StartDate == nil {
+		failureResponse(w, `startdate parameter is not specified or empty`)
+		return
+	}
+
+	if classBody.EndDate == nil {
+		failureResponse(w, `end date parameter is not specified or empty`)
+		return
+	}
+
+	newClass := Class{
+		ID:        len(classes) + 1,
+		Name:      *classBody.Name,
+		StartDate: *classBody.StartDate,
+		EndDate:   *classBody.EndDate,
+		Capacity:  *classBody.Capacity,
+	}
+
+	classes = append(classes, newClass)
+
+	type Output struct {
+		Message string `json:"message"`
+	}
+	var output Output
+	output.Message = "Successful Class Creation"
+
+	j, err := json.Marshal(output)
+	if err != nil {
+		failureResponse(w, `Internal Server Error! `)
+		return
+	}
+
+	successResponse(w, j)
+
+}
+
+func listClass(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
+	classes, err := json.Marshal(classes)
+
+	if err != nil {
+		w.WriteHeader(http.StatusInternalServerError)
+		return
+	}
+
+	w.Write(classes)
+}

class_test.go

@@ -0,0 +1,65 @@
+package main
+
+import (
+	"io"
+	"io/ioutil"
+	"net/http"
+	"strings"
+	"testing"
+)
+
+const (
+	BadRequestCode     = 400
+	SuccessRequestCode = 200
+)
+
+type TestStruct struct {
+	requestBody        string
+	expectedStatusCode int
+	responseBody       string
+	observedStatusCode int
+}
+
+//Inside user_test.go
+func TestAddClass(t *testing.T) {
+
+	url := "http://localhost:8080/classes_list"
+
+	tests := []TestStruct{
+		{`{"name":"workout101","startdate":"10 Jun 20","enddate" : "20 Jun 20", "capacity": "10"}`, SuccessRequestCode, "", 0},
+	}
+
+	for i, testCase := range tests {
+
+		var reader io.Reader
+		reader = strings.NewReader(testCase.requestBody) //Convert string to reader
+
+		request, err := http.NewRequest("GET", url, reader)
+
+		res, err := http.DefaultClient.Do(request)
+
+		if err != nil {
+			t.Error(err) //Something is wrong while sending request
+		}
+		body, _ := ioutil.ReadAll(res.Body)
+
+		tests[i].responseBody = strings.TrimSpace(string(body))
+		tests[i].observedStatusCode = res.StatusCode
+
+	}
+
+	DisplayTestCaseResults("addClass", tests, t)
+
+}
+
+func DisplayTestCaseResults(functionalityName string, tests []TestStruct, t *testing.T) {
+
+	for _, test := range tests {
+
+		if test.observedStatusCode == test.expectedStatusCode {
+			t.Logf("Passed Case:\n  request body : %s \n expectedStatus : %d \n responseBody : %s \n observedStatusCode : %d \n", test.requestBody, test.expectedStatusCode, test.responseBody, test.observedStatusCode)
+		} else {
+			t.Errorf("Failed Case:\n  request body : %s \n expectedStatus : %d \n responseBody : %s \n observedStatusCode : %d \n", test.requestBody, test.expectedStatusCode, test.responseBody, test.observedStatusCode)
+		}
+	}
+}

glofox_task

@@ -2,4 +2,7 @@ module github.com/AlexSwiss/glofox_task
 
 go 1.14
 
-require github.com/gorilla/mux v1.7.4
+require (
+	github.com/gorilla/mux v1.7.4
+	github.com/julienschmidt/httprouter v1.3.0
+)

go.mod

@@ -1,2 +1,4 @@
 github.com/gorilla/mux v1.7.4 h1:VuZ8uybHlWmqV03+zRzdwKL4tUnIp1MAQtp1mIFE1bc=
 github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/julienschmidt/httprouter v1.3.0 h1:U0609e9tgbseu3rBINet9P48AI/D3oJs4dN7jwJOQ1U=
+github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM=

go.sum

@@ -1,82 +1,19 @@
 package main
 
 import (
-	"encoding/json"
 	"fmt"
-	"io/ioutil"
 	"log"
 	"net/http"
 
-	"github.com/gorilla/mux"
+	"github.com/julienschmidt/httprouter"
 )
 
-// Our class model
-type class struct {
-	ID        string `json:"ID"`
-	Name      string `json:"name"`
-	StartDate string `json:"startdate"`
-	EndDate   string `json:"enddate"`
-	Capacity  int    `json: "capacty"`
-}
-
-type allClasses []class
-
-var classes allClasses
-
-// Dummy database
-func initClasses() {
-	classes = allClasses{
-		{
-			ID:        "1",
-			Name:      "Pilate",
-			StartDate: "21 Jun 20",
-			EndDate:   "02 Dec 20",
-			Capacity:  10,
-		},
-	}
-}
-
 func main() {
+	router := httprouter.New()
 
-	initClasses()
-
-	// Initialize mux router
-	router := mux.NewRouter().StrictSlash(true)
-
-	// API endpoints
-	router.HandleFunc("/classes", createClass).Methods("POST")
-	router.HandleFunc("/allclasses", getClasses).Methods("GET")
-	router.HandleFunc("/allclasses/{id}", getClass).Methods("GET")
-
-	log.Fatal(http.ListenAndServe(":8080", router))
-}
-
-// create new classes
-func createClass(w http.ResponseWriter, r *http.Request) {
-	var newClass class
-	reqBody, err := ioutil.ReadAll(r.Body)
-	if err != nil {
-		fmt.Fprintln(w, "Kindly enter values with ClassID, Name, StartDate, EndDate and Capacity only")
-	}
-	json.Unmarshal(reqBody, &newClass)
-	classes = append(classes, newClass)
-	w.WriteHeader(http.StatusCreated)
-
-	json.NewEncoder(w).Encode(newClass)
-}
-
-// Get all classes
-func getClasses(w http.ResponseWriter, r *http.Request) {
-	json.NewEncoder(w).Encode(classes)
-}
-
-// Get single class
-func getClass(w http.ResponseWriter, r *http.Request) {
-	classID := mux.Vars(r)["id"]
-
-	for _, singleClass := range classes {
-		if singleClass.ID == classID {
-			json.NewEncoder(w).Encode(singleClass)
-		}
-	}
+	router.POST("/classes", addClass)
+	router.GET("/classes_list", listClass)
+	port := ":8080"
+	fmt.Println("Starting server on ", port)
+	log.Fatal(http.ListenAndServe(port, router))
 }

main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+func failureResponse(w http.ResponseWriter, message string) {
+
+	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(http.StatusBadRequest)
+
+	json.NewEncoder(w).Encode(struct {
+		Error   string
+		IsError bool `json:"error"`
+	}{
+		Error:   message,
+		IsError: true,
+	})
+}
+
+func successResponse(w http.ResponseWriter, j []byte) {
+
+	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(http.StatusOK)
+	if bytes.Equal(j, []byte("null")) {
+		fmt.Fprintf(w, "%s", "{}")
+	} else {
+		fmt.Fprintf(w, "%s", j)
+	}
+}