Product api

Dockerfile

@@ -0,0 +1,10 @@
+FROM golang:1.14.10 AS builder
+RUN mkdir /app
+ADD . /app
+WORKDIR /app
+RUN CGO_ENABLED=0 GOOS=linux go build -o go-e-commerce_product-api
+
+FROM alpine:latest AS production
+COPY --from=builder /app .
+ENTRYPOINT ["./go-e-commerce_product-api"]
+CMD ["start"]

README.md

@@ -1,32 +1,93 @@
-## Golang Boilerplate
-Golang boilerplate to kickstart any go api project. This supports 2 database configurations currently:
+Assumption 1: You are simran.
+Assumption 2: Words in CAPITAL_CASE are meant to be set by simran.
+Assumption 3: Port 33001 must be free, else specify other port in application.yml .
+Assumption 4: Postgresql server is running on port 5432, if on other port then makes appropriate changes in application.yml. 
+Assumption 5: All the source code is pulled from git and you are currently on product_api branch
 
-* MongoDB
-* Postgres (default)
+## Setting Up Database
+Use PostgresQL database with version greater than 12.
 
-### Installing and configuring the boilerplate!
 
-Get the install.sh script into your microservice development directory.
+Create a database in PostgresQL via commandline
+sudo -u postgres createdb --owner=USERNAME DATABASE_NAME
+example:
+```
+sudo -u postgres createdb --owner=simran Commerce
+```
+
+```
+[Just For Knowledge]
+Drop a database in PostgresQL via commandline
+dropdb -h localhost -p PORT_NUMBER -U USERNAME DATABASE_NAME
+example:
+dropdb -h localhost -p 5432 -U simran Commerce
+```
+
+Copy your DB_URI to application.yml file
+DB_URI: "postgresql://USERNAME:PASSWORD@localhost:PORT_NUMBER/DATABASE_NAME?sslmode=disable"
+example: 
+```
+"postgresql://simran:root@localhost:5432/Commerce?sslmode=disable"
+```
+### golang version
+golang version 1.14.10
 
+### Build the Product_api
 ```
-wget https://raw.githubusercontent.com/joshsoftware/golang-boilerplate/master/install.sh
+go build
 ```
 
-Run the script with the options:
+You should see some executable getting created with name go-e-commerce
 
+### Migrate
 ```
-. ./install.sh -p package_name [-d {mongo|pg}] [-h]
+./go-e-commerce migrate
 ```
 
--p: [mandatory] Usually your github handle and service name. Eg. gautamrege/testly or github.com/corp/pkg/service
+This will create tables in the DATABASE_NAME you specified in application.yml
 
--d:  [optional] Default: pg. Specify 'mongo' for mongoDB setup
+### Copying Dump to Database
+Copy the migration.sql dump to this db with following command.
+psql DATABASE_NAME < PATH_TO_migration.sql
+example : 
+```
+psql Commerce < /home/simran/Desktop/Josh/InternProject/go-e-commerce/migration.sql
+```
 
--h:  [optional] Display help
+You should see that all records have been inserted successfully, if not either you messed up or there is version problem or our code is broke.
 
-### Testing
 
-Run test locally
+### Run directly on host
 ```
-$ make test
+./go-e-commerce start
 ```
+
+### Run on Docker
+
+Dependency 1: You must have docker installed with sudo rights.
+Dependency 2: You must have all migrations already created(See Migrate).
+
+## First Way
+Build Locally and run
+```
+docker build -t joshsoftware/go-e-commerce_product-api:v1 .
+
+
+docker run -it -p 33001:33001  \
+ --network=host  \
+ joshsoftware/go-e-commerce_product-api:v1
+```
+
+## Second Way
+Directly Pull the docker image from https://hub.docker.com/repository/docker/skavhar1998/go-e-commerce_product-api and then run.
+
+```
+docker pull skavhar1998/go-e-commerce_product-api:v1
+
+docker run -it -p 33001:33001  \
+ --network=host  \
+ skavhar1998/go-e-commerce_product-api:v1
+```
+
+### For documentation, refer the docs folder
+docs only include Product_api documentation

config/config.go

@@ -63,5 +63,6 @@ func checkIfSet(key string) {
 	if !viper.IsSet(key) {
 		err := errors.New(fmt.Sprintf("Key %s is not set", key))
 		panic(err)
+		//logger.WithField("err", err.Error()).Error("Error Couldn't find db!")
 	}
 }

db/common.go

@@ -0,0 +1,7 @@
+package db
+
+type ErrorResponse struct {
+	Code    string            `json:"code"`
+	Message string            `json:"message"`
+	Fields  map[string]string `json:"fields"`
+}

db/common_test.go

@@ -0,0 +1,37 @@
+package db
+
+import (
+	"testing"
+	"time"
+
+	"github.com/DATA-DOG/go-sqlmock"
+	"github.com/jmoiron/sqlx"
+	logger "github.com/sirupsen/logrus"
+	"github.com/stretchr/testify/suite"
+)
+
+var (
+	now        time.Time
+	mockedRows *sqlmock.Rows
+)
+
+func InitMockDB() (s Storer, sqlConn *sqlx.DB, sqlmockInstance sqlmock.Sqlmock) {
+	mockDB, sqlmock, err := sqlmock.New()
+	if err != nil {
+		logger.WithField("err:", err).Error("error initializing mock db")
+		return
+	}
+
+	sqlmockInstance = sqlmock
+	sqlxDB := sqlx.NewDb(mockDB, "sqlmock")
+
+	var pgStoreConn pgStore
+	pgStoreConn.db = sqlxDB
+
+	return &pgStoreConn, sqlxDB, sqlmockInstance
+}
+
+func TestExampleTestSuite(t *testing.T) {
+	suite.Run(t, new(ProductsTestSuite))
+	suite.Run(t, new(FilterTestSuite))
+}

db/db.go

@@ -2,11 +2,16 @@ package db
 
 import (
 	"context"
+	"mime/multipart"
 )
 
 type Storer interface {
-	ListUsers(context.Context) ([]User, error)
-	//Create(context.Context, User) error
-	//GetUser(context.Context) (User, error)
-	//Delete(context.Context, string) error
+	ListProducts(context.Context, int, int) (int, []Product, error)
+	FilteredProducts(context.Context, Filter, string, string) (int, []Product, error)
+	SearchProductsByText(context.Context, string, string, string) (int, []Product, error)
+	CreateProduct(context.Context, Product, []*multipart.FileHeader) (Product, error, int)
+	DeleteProductById(context.Context, int) error
+	UpdateProductById(context.Context, Product, int, []*multipart.FileHeader) (Product, error, int)
+	UpdateProductStockById(context.Context, int, int) (Product, error, int)
+	GetProductByID(context.Context, int) (Product, error)
 }

db/filters.go

@@ -0,0 +1,164 @@
+package db
+
+import (
+	"context"
+	"fmt"
+	"regexp"
+	"strings"
+
+	logger "github.com/sirupsen/logrus"
+)
+
+var (
+	filterSearchProduct = `SELECT count(*) OVER() AS total,*
+		FROM   products p
+		INNER JOIN category c
+		ON p.cid = c.cid`
+)
+
+type Filter struct {
+	// Below fields are what we may receive as Parameters in request body
+	CategoryId string
+	Price      string
+	Brand      string
+	Size       string
+	Color      string
+	// These Flags will help us format our query, true means that field exists in Request Parameters
+	CategoryFlag bool
+	PriceFlag    bool
+	BrandFlag    bool
+	SizeFlag     bool
+	ColorFlag    bool
+}
+
+// TODO Add condition and sort capabilities for both these APIs
+// These capabilities are suppossed to make filter and search APIs
+// really really dynamic and much robust.
+// eg for condition -> WHERE cid >= 5 AND tax <= 4
+// eg for sort ->  category_id = desc, price asc
+
+// @Title FilteredProducts
+// @Description Get the products that are filtered as per request Parameters
+// @Accept	request.Context, Filter struct's object
+// @Success total= (count of filtered products), error=nil
+// @Failure total=0, error= "Some Error"
+func (s *pgStore) FilteredProducts(ctx context.Context, filter Filter, limitStr string, offsetStr string) (int, []Product, error) {
+
+	var found bool
+	var records Records
+	var err error
+
+	// helper will be used in making query dynamic.
+	// See how it's getting concatanation added in case a flag was Filter Flag is true
+	sqlRegexp := ``
+	filterQuery := `   `
+	if filter.CategoryFlag == true {
+		filterQuery += ` c.cid = ` + filter.CategoryId + ` AND`
+		sqlRegexp += filter.CategoryId
+		found = true
+	}
+	if filter.BrandFlag {
+		filterQuery += ` LOWER(p.brand) = LOWER('` + filter.Brand + `') AND`
+		sqlRegexp += filter.Brand
+		found = true
+	}
+	if filter.SizeFlag {
+		filterQuery += ` LOWER(p.size) = LOWER('` + filter.Size + `') AND`
+		sqlRegexp += filter.Size
+		found = true
+	}
+	if filter.ColorFlag {
+		filterQuery += ` LOWER(p.color) =LOWER('` + filter.Color + `') AND`
+		sqlRegexp += filter.Color
+		found = true
+	}
+	if found {
+		var validParameters = regexp.MustCompile(`^[\w ]+$`)
+		if validParameters.MatchString(sqlRegexp) == false {
+			err = fmt.Errorf("Possible SQL Injection Attack.")
+			logger.WithField("err", err.Error()).Error("Error In Parameters, special Characters are present.")
+			return 0, []Product{}, err
+		}
+		filterQuery = ` WHERE ` + filterQuery[:len(filterQuery)-3]
+	}
+
+	filterQuery = filterSearchProduct + filterQuery
+
+	if filter.PriceFlag {
+		filterQuery += ` ORDER BY p.price ` + filter.Price + `, p.id LIMIT ` + limitStr + `  OFFSET  ` + offsetStr + `  ;`
+	} else {
+		filterQuery += ` ORDER BY p.id LIMIT ` + limitStr + `  OFFSET  ` + offsetStr + `  ;`
+	}
+
+	err = s.db.Select(&records, filterQuery)
+	if err != nil {
+		logger.WithField("err", err.Error()).Error("Error fetching Products from database")
+		return 0, []Product{}, err
+	} else if len(records) == 0 {
+		err = fmt.Errorf("Desired page not found, Offset was big")
+		logger.WithField("err", err.Error()).Error("Products don't exist by such filters!")
+		return 0, []Product{}, err
+	}
+
+	return records[0].TotalRecords, records.Products(), nil
+}
+
+// @Title SearchRecords
+// @Description Get records that are searched as per request Parameter "text" along with count
+// @Accept	request.Context, text as string, limitStr, pageStr
+// @Success total= (count of search qualifying records), error=nil
+// @Failure total=0, error= "Some Error"
+func (s *pgStore) SearchProductsByText(ctx context.Context, text string, limitStr string, offsetStr string) (int, []Product, error) {
+
+	var records Records
+	var validParameters = regexp.MustCompile(`^[\w ]+$`)
+
+	// if There are other chracters than word and space
+	if validParameters.MatchString(text) == false {
+		err := fmt.Errorf("Possible SQL Injection Attack.")
+		logger.WithField("err", err.Error()).Error("Error In Parameters, special Characters are present.")
+		return 0, []Product{}, err
+	}
+
+	// Split the text into slice of strings, max 10 first words will be considered
+	textSlice := strings.SplitN(text, " ", 11)
+
+	// If there are more than 10 words in search, ask user to be less verbose
+	if len(textSlice) > 10 {
+		err := fmt.Errorf("Unnecessary detailed text given.")
+		logger.WithField("err", err.Error()).Error("Error In Parameters, very detailed!.")
+		return 0, []Product{}, err
+	}
+
+	// Removing Duplicate words from textSlice
+	textMap := make(map[string]bool, 10)
+	for i := 0; i < len(textSlice); i++ {
+		textMap[textSlice[i]] = true
+	}
+
+	searchQuery := ` WHERE `
+
+	// iterate over all the textMap
+	for key := range textMap {
+		searchQuery += ` 
+		LOWER(p.name) LIKE LOWER('%` + key + `%') OR 
+		LOWER(p.brand) LIKE LOWER('%` + key + `%') OR 
+		LOWER(c.cname) LIKE LOWER('%` + key + `%') OR`
+	}
+
+	// remove that last OR from searchQuery
+	searchQuery = filterSearchProduct + searchQuery[:len(searchQuery)-2] +
+		` LIMIT ` + limitStr + ` OFFSET  ` + offsetStr + ` ;`
+
+	err := s.db.Select(&records, searchQuery)
+	if err != nil {
+		logger.WithField("err", err.Error()).Error("Error fetching Products from database")
+		return 0, []Product{}, err
+	} else if len(records) == 0 {
+		err = fmt.Errorf("Either Offset was big or No Records Present in database!")
+		logger.WithField("err", err.Error()).Error("database Returned total record count as 0")
+		return 0, []Product{}, err
+	}
+
+	return records[0].TotalRecords, records.Products(), nil
+}