added comments

Author: bstaijen

authentication-service/README.md

@@ -1,6 +1,7 @@
-# mariadb-for-microservices  - authentication service
+# mariadb-for-microservices - authentication service
+The authentication service is responsible for receiving and handling all login requests. The authentication service will return a object to the client containing a token which the client can use to sign requests.
 
-## Hoew does this work?
+## How does this work?
 TODO : explain somewhere that we are looking for .env file and environment variables (.env handy for building local)
 
 ## Requirements

authentication-service/app/models/user.go

@@ -2,6 +2,7 @@ package models
 
 import "time"
 
+// User contains user properties
 type User struct {
 	ID        int       `json:"id"`
 	Username  string    `json:"username"`

comment-service/app/models/comment_create.go

@@ -1,5 +1,6 @@
 package models
 
+// CommentCreate is the model for creating a comment
 type CommentCreate struct {
 	UserID  int    `json:"user_id"`
 	PhotoID int    `json:"photo_id"`

comment-service/database/db.go

@@ -41,6 +41,7 @@ func CloseConnection(db *sql.DB) {
 	db.Close()
 }
 
+// Create : saves a comment in the database
 func Create(db *sql.DB, comment *models.CommentCreate) (*sharedModels.CommentResponse, error) {
 	res, err := db.Exec("INSERT INTO comments(user_id, photo_id, comment) VALUES(?,?,?)", comment.UserID, comment.PhotoID, comment.Comment)
 	if err != nil {
@@ -59,6 +60,7 @@ func Create(db *sql.DB, comment *models.CommentCreate) (*sharedModels.CommentRes
 	return c, nil
 }
 
+// GetCommentByID returns a comment from the database
 func GetCommentByID(db *sql.DB, id int) (*sharedModels.CommentResponse, error) {
 	rows, err := db.Query("SELECT id, user_id, photo_id, comment, createdAt FROM comments WHERE id = ?", id)
 	if err != nil {
@@ -118,6 +120,7 @@ func GetCommentCount(db *sql.DB, items []*sharedModels.CommentCountRequest) ([]*
 	return responses, nil
 }
 
+// GetLastTenComments return the 10 comments for each comment in the [] parameter.
 func GetLastTenComments(db *sql.DB, items []*sharedModels.CommentRequest) ([]*sharedModels.CommentResponse, error) {
 	responses := make([]*sharedModels.CommentResponse, 0)
 

photo-service/app/http/controllers/image_controller.go

@@ -21,6 +21,7 @@ import (
 	"github.com/bstaijen/mariadb-for-microservices/shared/util"
 )
 
+// CreateHandler create a photo object and store it in the database.
 func CreateHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 		// Get title
@@ -73,6 +74,7 @@ func CreateHandler(connection *sql.DB) negroni.HandlerFunc {
 	})
 }
 
+// IndexHandler serves a photo indentiefied by filename
 func IndexHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 		vars := mux.Vars(r)
@@ -88,6 +90,7 @@ func IndexHandler(connection *sql.DB) negroni.HandlerFunc {
 	})
 }
 
+// ListByUserIDHandler list all photos owned by an user.
 func ListByUserIDHandler(connection *sql.DB) negroni.HandlerFunc {
 	return negroni.HandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
 		vars := mux.Vars(r)

photo-service/database/db.go

@@ -24,13 +24,13 @@ func OpenConnection(cnf config.Config) (*sql.DB, error) {
 	log.Debugf("Connect to : %v", dsn)
 	db, err := sql.Open("mysql", dsn)
 	if err != nil {
-		return nil, ErrCanNotConnectWithDatabase
+		return nil, errCanNotConnectWithDatabase
 	}
 
 	// Open doesn't open a connection. Validate DSN data:
 	err = db.Ping()
 	if err != nil {
-		return nil, ErrCanNotConnectWithDatabase
+		return nil, errCanNotConnectWithDatabase
 	}
 	return db, nil
 }
@@ -40,6 +40,7 @@ func CloseConnection(db *sql.DB) {
 	db.Close()
 }
 
+// InsertPhoto : inserts a photo in the database
 func InsertPhoto(db *sql.DB, photo *models.CreatePhoto) error {
 	//Insert
 	_, err := db.Exec("INSERT INTO photos(user_id, filename, title, contentType, photo) VALUES(?,?,?,?,?)", photo.UserID, photo.Filename, photo.Title, photo.ContentType, photo.Image)
@@ -49,14 +50,17 @@ func InsertPhoto(db *sql.DB, photo *models.CreatePhoto) error {
 	return nil
 }
 
+// ListImagesByUserID returns a list of photo's uploaded by the user.
 func ListImagesByUserID(db *sql.DB, id int) ([]*models.Photo, error) {
 	return selectQuery(db, "SELECT id, user_id, filename, title, createdAt, contentType, photo FROM photos WHERE user_id=?", id)
 }
 
+// ListIncoming returns a list of photos ordered by last inserted
 func ListIncoming(db *sql.DB, offset int, nrOfRows int) ([]*models.Photo, error) {
 	return selectQuery(db, "SELECT id, user_id, filename, title, createdAt, contentType, photo FROM photos ORDER BY createdAt DESC LIMIT ?, ?", offset, nrOfRows)
 }
 
+// GetPhotoByFilename return a photo based on the filename
 func GetPhotoByFilename(db *sql.DB, filename string) (*models.Photo, error) {
 	photos, err := selectQuery(db, "SELECT id, user_id, filename, title, createdAt, contentType, photo FROM photos WHERE filename = ?", filename)
 	if len(photos) > 0 {
@@ -65,6 +69,7 @@ func GetPhotoByFilename(db *sql.DB, filename string) (*models.Photo, error) {
 	return nil, err
 }
 
+// GetPhotoById returns a photo indexed by id
 func GetPhotoById(db *sql.DB, id int) (*models.Photo, error) {
 	photos, err := selectQuery(db, "SELECT id, user_id, filename, title, createdAt, contentType, photo  FROM photos WHERE id = ?", id)
 	if len(photos) > 0 {
@@ -94,5 +99,5 @@ func selectQuery(db *sql.DB, query string, args ...interface{}) ([]*models.Photo
 	return photos, nil
 }
 
-// ErrCanNotConnectWithDatabase error if database is unreachable
-var ErrCanNotConnectWithDatabase = errors.New("Can not connect with database")
+// errCanNotConnectWithDatabase error if database is unreachable
+var errCanNotConnectWithDatabase = errors.New("Can not connect with database")

profile-service/app/models/user.go

@@ -19,8 +19,7 @@ type User struct {
 	Hash      string
 }
 
-// Method of user. (not a function)
-// p *user is the receiver of method getUsername()
+// GetUsername returns the username of an user
 func (u *User) GetUsername() string {
 	return u.Username
 }
@@ -30,7 +29,7 @@ func (u *User) Print() string {
 	return fmt.Sprintf("%v (%v) - %v", u.Username, u.ID, u.CreatedAt)
 }
 
-// Validate method
+// Validate returns an error when the username or email is to short.
 func (u *User) Validate() error {
 	if len(u.Username) < 1 {
 		return ErrUsernameTooShort
@@ -43,6 +42,7 @@ func (u *User) Validate() error {
 	return nil
 }
 
+// ValidatePassword returns an error if the password is to small.
 func (u *User) ValidatePassword() error {
 	if len(u.Password) < 1 {
 		return ErrPasswordTooShort
@@ -51,6 +51,11 @@ func (u *User) ValidatePassword() error {
 	return nil
 }
 
+// ErrUsernameTooShort is a error and is used when username is too short.
 var ErrUsernameTooShort = errors.New("Username is too short")
+
+// ErrEmailTooShort is an error and is used when email address is too short.
 var ErrEmailTooShort = errors.New("Email address is to short")
+
+// ErrPasswordTooShort is an error and is used when a password is too short.
 var ErrPasswordTooShort = errors.New("Password is to short")

shared/README.md

@@ -1 +1,2 @@
 # Shared Library
+The shared library contains helper methods and modals who are shared with all services.

shared/util/datetime.go

@@ -6,6 +6,7 @@ import (
 	"time"
 )
 
+// TimeHelper converters a string to a time.Time struct.
 func TimeHelper(v string) time.Time {
 	layout := "2006-01-02 15:04:05"
 	t, err := time.Parse(layout, v)

shared/util/decoder.go

@@ -8,6 +8,7 @@ import (
 	"net/http/httptest"
 )
 
+// RequestToJSON converts a Request containg a json object to a targeted interface
 func RequestToJSON(req *http.Request, target interface{}) error {
 	if req.Body == nil {
 		return errors.New("Bad json")
@@ -16,6 +17,7 @@ func RequestToJSON(req *http.Request, target interface{}) error {
 	return toJSON(req.Body, target)
 }
 
+// ResponseJSONToObject converts a Response containing a json object to a targeted interface
 func ResponseJSONToObject(res *http.Response, target interface{}) error {
 	if res.Body == nil {
 		return errors.New("Bad json")
@@ -24,6 +26,7 @@ func ResponseJSONToObject(res *http.Response, target interface{}) error {
 	return toJSON(res.Body, target)
 }
 
+// ResponseRecorderJSONToObject converts a ResponseRecorder containing a json to a targeted interface. This is only used in test cases when a httptest server is used.
 func ResponseRecorderJSONToObject(res *httptest.ResponseRecorder, target interface{}) error {
 	if res.Body == nil {
 		return errors.New("Bad json")