summaryrefslogtreecommitdiff
path: root/item
diff options
context:
space:
mode:
Diffstat (limited to 'item')
-rw-r--r--item/db_actions.go82
-rw-r--r--item/item.go75
-rw-r--r--item/router.go (renamed from item/item_router.go)13
3 files changed, 163 insertions, 7 deletions
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 <vidhukant@vidhukant.xyz>
+
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+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 <vidhukant@vidhukant.xyz>
+
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+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/router.go
index d86af68..299e943 100644
--- a/item/item_router.go
+++ b/item/router.go
@@ -19,7 +19,6 @@ package item
import (
"github.com/gin-gonic/gin"
- "github.com/MikunoNaka/OpenBills-lib/item"
"go.mongodb.org/mongo-driver/bson/primitive"
"log"
"net/http"
@@ -31,7 +30,7 @@ func Routes(route *gin.Engine) {
// TODO: add functionality to filter results
// /all returns all the saved items
i.GET("/all", func(ctx *gin.Context) {
- items, err := item.GetItems(nil)
+ 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())
@@ -42,9 +41,9 @@ func Routes(route *gin.Engine) {
})
i.POST("/new", func(ctx *gin.Context) {
- var i item.Item
+ var i Item
ctx.BindJSON(&i)
- _, err := item.SaveItem(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())
@@ -64,9 +63,9 @@ func Routes(route *gin.Engine) {
return
}
- var i item.Item
+ var i Item
ctx.BindJSON(&i)
- err = item.ModifyItem(objectId, 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())
@@ -86,7 +85,7 @@ func Routes(route *gin.Engine) {
return
}
- err = item.DeleteItem(objectId)
+ 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())