diff options
Diffstat (limited to 'client')
| -rw-r--r-- | client/client.go | 75 | ||||
| -rw-r--r-- | client/db_actions.go | 62 | ||||
| -rw-r--r-- | client/router.go (renamed from client/client_router.go) | 13 |
3 files changed, 143 insertions, 7 deletions
diff --git a/client/client.go b/client/client.go new file mode 100644 index 0000000..caa3076 --- /dev/null +++ b/client/client.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 client + +import ( + "go.mongodb.org/mongo-driver/bson/primitive" + "go.mongodb.org/mongo-driver/mongo" + "github.com/MikunoNaka/OpenBills-server/database" +) + +// initialise a database connection for this package +// not sure if I should do this but I am... +var db *mongo.Collection = database.DB.Collection("Clients") + +/* each invoice has a client + * you should be able to: + * - add, modify, delete a client + * - add client to invoices + * - get all invoices associated with client, etc + */ + +/* each contact has one name + * but multiple contact addresses + * it is assumed that the first one + * has the highest priority + */ + +type Contact struct { + Name string `bson:"Name" json:"Name"` + Phones []string `bson:"Phones" json:"Phones"` + Emails []string `bson:"Emails" json:"Emails"` + Website string `bson:"Website" json:"Website"` +} + +type Address struct { + /* "Text" means the actual address lines. + * If address is 123, xyz colony, myCity, myState the Text + * will be 123, xyz colony, and + * State and City will be myCity and myState + * + * A multiline string is expected. + */ + Text string `bson:"Text" json:"Text"` + City string `bson:"City" json:"City"` + State string `bson:"State" json:"State"` + PostalCode string `bson:"PostalCode" json:"PostalCode"` + Country string `bson:"Country" json:"Country"` +} + +type Client struct { + Id primitive.ObjectID `bson:"_id,omitempty" json:"Id"` + Name string `bson:"Name" json:"Name"` + Contact Contact `bson:"Contact" json:"Contact"` + GSTIN string `bson:"GSTIN" json:"GSTIN"` + /* if shipping address is empty it means that + * the billing address is also shipping address + */ + BillingAddress Address `bson:"BillingAddress" json:"BillingAddress"` + ShippingAddresses []Address `bson:"ShippingAddresses,omitempty" json:"ShippingAddresses"` +} diff --git a/client/db_actions.go b/client/db_actions.go new file mode 100644 index 0000000..bf32d97 --- /dev/null +++ b/client/db_actions.go @@ -0,0 +1,62 @@ +/* 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 client + +import ( + "context" + "go.mongodb.org/mongo-driver/bson" + "go.mongodb.org/mongo-driver/bson/primitive" +) + +/* TODO: Handle errors properly + * Send an API error response instead of log.Fatal + */ + +// Add client to db +func saveClient(c Client) (primitive.ObjectID, error) { + res, err := db.InsertOne(context.TODO(), c) + return res.InsertedID.(primitive.ObjectID), err +} + +// Delete client from DB +func deleteClient(id primitive.ObjectID) error { + _, err := db.DeleteOne(context.TODO(), bson.M{"_id": id}) + return err +} + +// modify client in DB +func modifyClient(id primitive.ObjectID, nc Client) error { + _, err := db.UpdateOne(context.TODO(), bson.D{{"_id", id}}, bson.D{{"$set", nc}}) + return err +} + +/* GetClients queries the database and + * returns clients based on the given filter + * if filter is nil every client is returned + */ +func getClients(filter bson.M) ([]Client, error) { + var clients []Client + + cursor, err := db.Find(context.TODO(), filter) + if err != nil { + return clients, err + } + + err = cursor.All(context.TODO(), &clients) + return clients, err +} diff --git a/client/client_router.go b/client/router.go index 2fd14fc..46e339a 100644 --- a/client/client_router.go +++ b/client/router.go @@ -19,7 +19,6 @@ package client import ( "github.com/gin-gonic/gin" - "github.com/MikunoNaka/OpenBills-lib/client" "log" "net/http" "go.mongodb.org/mongo-driver/bson/primitive" @@ -30,7 +29,7 @@ func Routes(route *gin.Engine) { { c.GET("/all", func(ctx *gin.Context) { // TODO: add functionality to filter results - clients, err := client.GetClients(nil) + clients, err := getClients(nil) if err != nil { ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) log.Printf("ERROR: Failed to read clients from DB: %v\n", err.Error()) @@ -41,9 +40,9 @@ func Routes(route *gin.Engine) { }) c.POST("/new", func(ctx *gin.Context) { - var c client.Client + var c Client ctx.BindJSON(&c) - _, err := client.SaveClient(c) + _, err := saveClient(c) if err != nil { ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) log.Printf("ERROR: Failed to add new client %v to DB: %v\n", c, err.Error()) @@ -63,9 +62,9 @@ func Routes(route *gin.Engine) { return } - var c client.Client + var c Client ctx.BindJSON(&c) - err = client.ModifyClient(objectId, c) + err = modifyClient(objectId, c) if err != nil { ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) log.Printf("ERROR: Failed to modify client %v: %v\n", objectId, err.Error()) @@ -85,7 +84,7 @@ func Routes(route *gin.Engine) { return } - err = client.DeleteClient(objectId) + err = deleteClient(objectId) if err != nil { ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) log.Printf("ERROR: Failed to delete client %v: %v\n", objectId, err.Error()) |