From 2f4a92b0f1d02096427a2d1c97746bb52cdcc38a Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Fri, 11 Nov 2022 21:22:31 +0530 Subject: Merged OpenBills-lib code into OpenBills-server --- item/db_actions.go | 82 ++++++++++++++++++++++++++++++++++++++++++ item/item.go | 75 +++++++++++++++++++++++++++++++++++++++ item/item_router.go | 100 ---------------------------------------------------- item/router.go | 99 +++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 256 insertions(+), 100 deletions(-) create mode 100644 item/db_actions.go create mode 100644 item/item.go delete mode 100644 item/item_router.go create mode 100644 item/router.go (limited to 'item') diff --git a/item/db_actions.go b/item/db_actions.go new file mode 100644 index 0000000..36f8364 --- /dev/null +++ b/item/db_actions.go @@ -0,0 +1,82 @@ +/* OpenBills-server - Server for libre billing software OpenBills-web + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package item + +import ( + "context" + "go.mongodb.org/mongo-driver/bson" + "go.mongodb.org/mongo-driver/bson/primitive" + "github.com/MikunoNaka/OpenBills-server/database" + "github.com/MikunoNaka/OpenBills-server/brand" + "go.mongodb.org/mongo-driver/mongo" +) + +var brands *mongo.Collection = database.DB.Collection("Brands") + +// Add item to db +func saveItem(i Item) (primitive.ObjectID, error) { + res, err := db.InsertOne(context.TODO(), i) + return res.InsertedID.(primitive.ObjectID), err +} + +// Delete item from DB +func deleteItem(id primitive.ObjectID) error { + _, err := db.DeleteOne(context.TODO(), bson.M{"_id": id}) + return err +} + +// modify item in DB +func modifyItem(id primitive.ObjectID, ni Item) error { + _, err := db.UpdateOne(context.TODO(), bson.D{{"_id", id}}, bson.D{{"$set", ni}}) + return err +} + +/* GetItems queries the database and + * returns items based on the given filter + * if filter is nil every item is returned + */ +func getItems(filter bson.M) ([]Item, error) { + var items []Item + + cursor, err := db.Find(context.TODO(), filter) + if err != nil { + return items, err + } + + err = cursor.All(context.TODO(), &items) + if err != nil { + return items, err + } + + for id, i := range items { + // continue if item doesn't have a brand + if (i.Brand.Id == primitive.ObjectID{}) { + continue + } + + var b brand.Brand + + err := brands.FindOne(context.TODO(), bson.M{"_id": i.Brand.Id}).Decode(&b) + if err != nil { + return items, err + } + items[id].Brand = b + } + + return items, err +} diff --git a/item/item.go b/item/item.go new file mode 100644 index 0000000..12b7d03 --- /dev/null +++ b/item/item.go @@ -0,0 +1,75 @@ +/* OpenBills-server - Server for libre billing software OpenBills-web + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package item + +import ( + "go.mongodb.org/mongo-driver/bson/primitive" + "go.mongodb.org/mongo-driver/mongo" + "github.com/MikunoNaka/OpenBills-server/database" + "github.com/MikunoNaka/OpenBills-server/brand" +) + +// initialise a database connection for this package +// not sure if I should do this but I am... +var db *mongo.Collection = database.DB.Collection("Items") + +/* each invoice must contain at least one item + * you should be able to: + * - add, modify, delete an item + * - add item to invoice + */ + +/* An item is any product + * or service that can be sold + * Items may have a max and min quanity + * and some default fields like GST and Unit Price + * that don't need to be entered manually + * + * the front-end may or may not implement + * the default fields + * + * Items can be assigned brands + * and certain actions can be performed + * on the products of a brand altogether + */ +type Item struct { + Id primitive.ObjectID `bson:"_id,omitempty" json:"Id"` + Brand brand.Brand `bson:"Brand,omitempty" json:"Brand"` + UnitOfMeasure string `bson:"UnitOfMeasure" json:"UnitOfMeasure"` + HasDecimalQuantity bool `bson:"HasDecimalQuantity, json:"HasDecimalQuantity"` + // just the defaults, can be overridden in an invoice + Name string `bson:"Name" json:"Name"` + Description string `bson:"Description" json:"Description"` + HSN string `bson:"HSN" json:"HSN"` + UnitPrice float64 `bson:"UnitPrice" json:"UnitPrice"` + // default tax percentage + GSTPercentage float64 `bson:"GSTPercentage" json:"GSTPercentage"` + MaxQuantity float64 `bson:"MaxQuantity" json:"MaxQuantity"` + MinQuantity float64 `bson:"MinQuantity" json:"MinQuantity"` +} + +// Item but with extra fields an invoice might require +type InvoiceItem struct { + Item + /* Each product must have a quantity + * but it is upto the backend to enforce that + */ + // TODO: float64 isn't ideal, find a better way + Quantity float64 `bson:"Quantitiy" json:"Quantity"` + DiscountPercentage float64 `bson:"DiscountPercentage,omitempty" json:"DiscountPercentage"` +} diff --git a/item/item_router.go b/item/item_router.go deleted file mode 100644 index d86af68..0000000 --- a/item/item_router.go +++ /dev/null @@ -1,100 +0,0 @@ -/* OpenBills-server - Server for libre billing software OpenBills-web - * Copyright (C) 2022 Vidhu Kant Sharma - - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -package item - -import ( - "github.com/gin-gonic/gin" - "github.com/MikunoNaka/OpenBills-lib/item" - "go.mongodb.org/mongo-driver/bson/primitive" - "log" - "net/http" -) - -func Routes(route *gin.Engine) { - i := route.Group("/item") - { - // TODO: add functionality to filter results - // /all returns all the saved items - i.GET("/all", func(ctx *gin.Context) { - items, err := item.GetItems(nil) - if err != nil { - ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) - log.Printf("ERROR: Failed to read items from DB: %v\n", err.Error()) - return - } - - ctx.JSON(http.StatusOK, items) - }) - - i.POST("/new", func(ctx *gin.Context) { - var i item.Item - ctx.BindJSON(&i) - _, err := item.SaveItem(i) - if err != nil { - ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) - log.Printf("ERROR: Failed to add new item %v to DB: %v\n", i, err.Error()) - return - } - - log.Printf("Successfully saved new item to DB: %v", i) - ctx.JSON(http.StatusOK, nil) - }) - - i.PUT("/:itemId", func(ctx *gin.Context) { - id := ctx.Param("itemId") - objectId, err := primitive.ObjectIDFromHex(id) - if err != nil { - ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) - log.Printf("ERROR: Failed to modify item, Error parsing ID: %v\n", err.Error()) - return - } - - var i item.Item - ctx.BindJSON(&i) - err = item.ModifyItem(objectId, i) - if err != nil { - ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) - log.Printf("ERROR: Failed to modify item %v: %v\n", objectId, err.Error()) - return - } - - log.Printf("Modified item %v to %v.\n", objectId, i) - ctx.JSON(http.StatusOK, nil) - }) - - i.DELETE("/:itemId", func(ctx *gin.Context) { - id := ctx.Param("itemId") - objectId, err := primitive.ObjectIDFromHex(id) - if err != nil { - ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) - log.Printf("ERROR: Failed to delete item, Error parsing ID: %v\n", err.Error()) - return - } - - err = item.DeleteItem(objectId) - if err != nil { - ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) - log.Printf("ERROR: Failed to delete item %v: %v\n", objectId, err.Error()) - return - } - - log.Printf("Deleted item %v from database.\n", objectId ) - ctx.JSON(http.StatusOK, nil) - }) - } -} diff --git a/item/router.go b/item/router.go new file mode 100644 index 0000000..299e943 --- /dev/null +++ b/item/router.go @@ -0,0 +1,99 @@ +/* OpenBills-server - Server for libre billing software OpenBills-web + * Copyright (C) 2022 Vidhu Kant Sharma + + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package item + +import ( + "github.com/gin-gonic/gin" + "go.mongodb.org/mongo-driver/bson/primitive" + "log" + "net/http" +) + +func Routes(route *gin.Engine) { + i := route.Group("/item") + { + // TODO: add functionality to filter results + // /all returns all the saved items + i.GET("/all", func(ctx *gin.Context) { + items, err := getItems(nil) + if err != nil { + ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) + log.Printf("ERROR: Failed to read items from DB: %v\n", err.Error()) + return + } + + ctx.JSON(http.StatusOK, items) + }) + + i.POST("/new", func(ctx *gin.Context) { + var i Item + ctx.BindJSON(&i) + _, err := saveItem(i) + if err != nil { + ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) + log.Printf("ERROR: Failed to add new item %v to DB: %v\n", i, err.Error()) + return + } + + log.Printf("Successfully saved new item to DB: %v", i) + ctx.JSON(http.StatusOK, nil) + }) + + i.PUT("/:itemId", func(ctx *gin.Context) { + id := ctx.Param("itemId") + objectId, err := primitive.ObjectIDFromHex(id) + if err != nil { + ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + log.Printf("ERROR: Failed to modify item, Error parsing ID: %v\n", err.Error()) + return + } + + var i Item + ctx.BindJSON(&i) + err = modifyItem(objectId, i) + if err != nil { + ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) + log.Printf("ERROR: Failed to modify item %v: %v\n", objectId, err.Error()) + return + } + + log.Printf("Modified item %v to %v.\n", objectId, i) + ctx.JSON(http.StatusOK, nil) + }) + + i.DELETE("/:itemId", func(ctx *gin.Context) { + id := ctx.Param("itemId") + objectId, err := primitive.ObjectIDFromHex(id) + if err != nil { + ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + log.Printf("ERROR: Failed to delete item, Error parsing ID: %v\n", err.Error()) + return + } + + err = deleteItem(objectId) + if err != nil { + ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) + log.Printf("ERROR: Failed to delete item %v: %v\n", objectId, err.Error()) + return + } + + log.Printf("Deleted item %v from database.\n", objectId ) + ctx.JSON(http.StatusOK, nil) + }) + } +} -- cgit v1.2.3