added missing comments

Author: bstaijen

authentication-service/app/models/token.go

@@ -1,5 +1,6 @@
 package models
 
+// The token contains the token properties
 type Token struct {
 	Token     string `json:"token"`
 	ExpiresOn string `json:"expires_on"`

comment-service/app/http/controllers/controller.go

@@ -20,6 +20,7 @@ import (
 	sharedModels "github.com/bstaijen/mariadb-for-microservices/shared/models"
 )
 
+// CreateHandler creates a comment and stores it in the database
 func CreateHandler(connection *sql.DB, cnf config.Config) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 		commentObject := &models.CommentCreate{}
@@ -50,6 +51,7 @@ func CreateHandler(connection *sql.DB, cnf config.Config) negroni.HandlerFunc {
 	})
 }
 
+// ListCommentsHandler return a list of comments
 func ListCommentsHandler(connection *sql.DB, cnf config.Config) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 
@@ -96,6 +98,7 @@ func ListCommentsHandler(connection *sql.DB, cnf config.Config) negroni.HandlerF
 	})
 }
 
+// GetCommentCountHandler returns a list of counts beloning to comments.
 func GetCommentCountHandler(connection *sql.DB, cnf config.Config) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 		if r.Body == nil {
@@ -127,6 +130,7 @@ func GetCommentCountHandler(connection *sql.DB, cnf config.Config) negroni.Handl
 	})
 }
 
+// GetLastTenHandler returns a list of last 10 comments
 func GetLastTenHandler(connection *sql.DB, cnf config.Config) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 

comment-service/database/db.go

@@ -74,6 +74,7 @@ func GetCommentByID(db *sql.DB, id int) (*sharedModels.CommentResponse, error) {
 	return nil, ErrCommentNotFound
 }
 
+// GetComments return an array of comments.
 func GetComments(db *sql.DB, photoID, offset, nrOfRows int) ([]*sharedModels.CommentResponse, error) {
 	rows, err := db.Query("SELECT id, user_id, photo_id, comment, createdAt FROM comments WHERE photo_id=? ORDER BY createdAt DESC LIMIT ?, ?", photoID, offset, nrOfRows)
 	if err != nil {
@@ -89,6 +90,7 @@ func GetComments(db *sql.DB, photoID, offset, nrOfRows int) ([]*sharedModels.Com
 	return responses, nil
 }
 
+// GetCommentCount returns the number of comment counts
 func GetCommentCount(db *sql.DB, items []*sharedModels.CommentCountRequest) ([]*sharedModels.CommentCountResponse, error) {
 
 	if len(items) < 1 {

vote-service/app/http/controllers/ipc.go

@@ -13,6 +13,7 @@ import (
 	"github.com/bstaijen/mariadb-for-microservices/shared/util"
 )
 
+// GetTopRatedHandler is the handler for the top rated timeline.
 func GetTopRatedHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 
@@ -32,6 +33,7 @@ func GetTopRatedHandler(connection *sql.DB) negroni.HandlerFunc {
 	})
 }
 
+// GetHotHandler is the handler for the hot photos timeline
 func GetHotHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 
@@ -51,6 +53,7 @@ func GetHotHandler(connection *sql.DB) negroni.HandlerFunc {
 	})
 }
 
+// HasVotedHandler is the handler for calculating whether the user has voted on a photo or not.
 func HasVotedHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 
@@ -78,6 +81,7 @@ func HasVotedHandler(connection *sql.DB) negroni.HandlerFunc {
 	})
 }
 
+// GetVoteCountHandler is the handler for calculating the number of votes on a photo
 func GetVoteCountHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 		type Collection struct {

vote-service/app/http/routes/routes.go

@@ -11,6 +11,7 @@ import (
 	"github.com/urfave/negroni"
 )
 
+// InitRoutes initializes the REST and IPC routes for this service.
 func InitRoutes(db *sql.DB, cnf config.Config) *mux.Router {
 	router := mux.NewRouter()
 	router = setRESTRoutes(db, cnf, router)

vote-service/database/db.go

@@ -137,51 +137,52 @@ func HasVoted(db *sql.DB, items []*sharedModels.HasVotedRequest) ([]*sharedModel
 
 // GetTopRatedTimeline returns an array of top rated photos. The array contains a list of ID's. Offset and nrOfRows can be used for pagination.
 func GetTopRatedTimeline(db *sql.DB, offset int, nrOfRows int) ([]*sharedModels.TopRatedPhotoResponse, error) {
-	rows, err := db.Query("SELECT photo_id, sum(upvote) AS total_upvote, sum(downvote) AS total_downvote, sum(upvote) - sum(downvote) as difference FROM votes GROUP BY photo_id ORDER BY difference DESC LIMIT ?, ?", offset, nrOfRows)
+	rows, err := db.Query("SELECT photo_id as photoID, sum(upvote) AS totalUpvote, sum(downvote) AS totalDownvote, sum(upvote) - sum(downvote) as difference FROM votes GROUP BY photo_id ORDER BY difference DESC LIMIT ?, ?", offset, nrOfRows)
 	if err != nil {
 		return nil, err
 	}
 
 	photos := make([]*sharedModels.TopRatedPhotoResponse, 0)
 
 	for rows.Next() {
-		var photo_id int
-		var total_upvote int
-		var total_downvote int
+		var photoID int
+		var totalUpvote int
+		var totalDownvote int
 		var difference int
 
-		err = rows.Scan(&photo_id, &total_upvote, &total_downvote, &difference)
+		err = rows.Scan(&photoID, &totalUpvote, &totalDownvote, &difference)
 		if err != nil {
 			return nil, err
 		}
 		photos = append(photos, &sharedModels.TopRatedPhotoResponse{
-			PhotoID: photo_id,
+			PhotoID: photoID,
 		})
 	}
 	return photos, nil
 }
 
+// GetHotTimeline returns an array of photos ordered by on which is most 'hot' meaning which has been voted on the most for the CURRENT_DAY
 func GetHotTimeline(db *sql.DB, offset int, nrOfRows int) ([]*sharedModels.TopRatedPhotoResponse, error) {
-	rows, err := db.Query("SELECT photo_id, sum(upvote) AS total_upvote, sum(downvote) AS total_downvote, sum(upvote) - sum(downvote) AS difference FROM votes WHERE createdAt > DATE_SUB(now(), INTERVAL 1 DAY) GROUP BY photo_id ORDER BY difference DESC LIMIT ?, ?", offset, nrOfRows)
+	rows, err := db.Query("SELECT photo_id as photoID, sum(upvote) AS totalUpvote, sum(downvote) AS totalDownvote, sum(upvote) - sum(downvote) AS difference FROM votes WHERE createdAt > DATE_SUB(now(), INTERVAL 1 DAY) GROUP BY photo_id ORDER BY difference DESC LIMIT ?, ?", offset, nrOfRows)
 	if err != nil {
 		return nil, err
 	}
 
 	photos := make([]*sharedModels.TopRatedPhotoResponse, 0)
 
 	for rows.Next() {
-		var photo_id int
-		var total_upvote int
-		var total_downvote int
+		var photoID int
+		var totalUpvote int
+		var totalDownvote int
 		var difference int
 
-		err = rows.Scan(&photo_id, &total_upvote, &total_downvote, &difference)
+		err = rows.Scan(&photoID, &totalUpvote, &totalDownvote, &difference)
 		if err != nil {
 			return nil, err
 		}
 
 		photos = append(photos, &sharedModels.TopRatedPhotoResponse{
-			PhotoID: photo_id,
+			PhotoID: photoID,
 		})
 	}
 	return photos, nil