En/arango db support

CONTRIBUTING.md

@@ -83,6 +83,11 @@ docker pull scylladb/scylla
 docker run --name scylla -d -p 2025:9042 scylladb/scylla
 docker pull surrealdb/surrealdb:latest
 docker run --name surrealdb -d -p 8000:8000 surrealdb/surrealdb:latest start --bind 0.0.0.0:8000
+docker run -d --name arangodb \
+  -p 8529:8529 \
+  -e ARANGO_ROOT_PASSWORD=rootpassword \
+  --pull always \
+  arangodb:latest
 
 
 

docs/advanced-guide/injecting-databases-drivers/page.md

@@ -949,3 +949,167 @@ func main() {
 }
 
 ```
+
+
+## ArangoDB
+GoFr supports injecting `ArangoDB` that implements the following interface. Any driver that implements the interface can be 
+added using the `app.AddArangoDB()` method, and users can use ArangoDB across the application with `gofr.Context`.
+
+```go
+type ArangoDB interface {
+    // ListDBs lists all databases in ArangoDB.
+    ListDBs(ctx context.Context) ([]string, error)
+    // CreateDB creates a new database in ArangoDB.
+    CreateDB(ctx context.Context, database string) error
+    // DropDB deletes an existing database in ArangoDB.
+    DropDB(ctx context.Context, database string) error
+
+    // CreateCollection creates a new collection in a database with specified type.
+    CreateCollection(ctx context.Context, database, collection string, isEdge bool) error
+    // DropCollection deletes an existing collection from a database.
+    DropCollection(ctx context.Context, database, collection string) error
+    // TruncateCollection truncates a collection in a database.
+    TruncateCollection(ctx context.Context, database, collection string) error
+    // ListCollections lists all collections in a database.
+    ListCollections(ctx context.Context, database string) ([]string, error)
+
+    // CreateDocument creates a new document in the specified collection.
+    CreateDocument(ctx context.Context, dbName, collectionName string, document interface{}) (string, error)
+    // GetDocument retrieves a document by its ID from the specified collection.
+    GetDocument(ctx context.Context, dbName, collectionName, documentID string, result interface{}) error
+    // UpdateDocument updates an existing document in the specified collection.
+    UpdateDocument(ctx context.Context, dbName, collectionName, documentID string, document interface{}) error
+    // DeleteDocument deletes a document by its ID from the specified collection.
+    DeleteDocument(ctx context.Context, dbName, collectionName, documentID string) error
+
+    // CreateEdgeDocument creates a new edge document between two vertices.
+    CreateEdgeDocument(ctx context.Context, dbName, collectionName string, from, to string, document interface{}) (string, error)
+
+ 	// CreateGraph creates a new graph in a database taking graph name and *[]arangodb.EdgeDefinition as input.
+    CreateGraph(ctx context.Context, database, graph string, edgeDefinitions any) error
+    // DropGraph deletes an existing graph from a database.
+    DropGraph(ctx context.Context, database, graph string) error
+    // ListGraphs lists all graphs in a database.
+    ListGraphs(ctx context.Context, database string) ([]string, error)
+
+    // Query executes an AQL query and binds the results.
+    Query(ctx context.Context, dbName string, query string, bindVars map[string]any, result any) error
+
+   HealthCheck(context.Context) (any, error)
+}
+```
+
+Users can easily inject a driver that supports this interface, providing usability without compromising the extensibility to use multiple databases.
+
+Import the GoFr's external driver for ArangoDB:
+
+```shell
+go get gofr.dev/pkg/gofr/datasource/arangodb@latest
+```
+
+### Example
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"gofr.dev/pkg/gofr"
+	"gofr.dev/pkg/gofr/datasource/arangodb"
+)
+
+type Person struct {
+	Name string `json:"name"`
+	Age  int    `json:"age"`
+}
+
+type Friendship struct {
+	StartDate string `json:"startDate"`
+}
+
+func main() {
+	app := gofr.New()
+
+	// Configure the ArangoDB client
+	arangoClient := arangodb.New(arangodb.Config{
+		Host:     "localhost",
+		User:     "root",
+		Password: "root",
+		Port:     8529,
+	})
+	app.AddArangoDB(arangoClient)
+
+	// Example routes demonstrating different types of operations
+	app.POST("/setup", Setup)
+	app.POST("/friends", CreateFriendship)
+
+	app.Run()
+}
+
+// Setup demonstrates database and collection creation
+func Setup(ctx *gofr.Context) (interface{}, error) {
+	// Create a database
+	err := ctx.ArangoDB.CreateDB(ctx, "social_network")
+	if err != nil {
+		return nil, fmt.Errorf("failed to create database: %w", err)
+	}
+
+	// Create a regular collection for persons
+	err = ctx.ArangoDB.CreateCollection(ctx, "social_network", "persons", false)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create persons collection: %w", err)
+	}
+
+	// Create an edge collection for friendships
+	err = ctx.ArangoDB.CreateCollection(ctx, "social_network", "friendships", true)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create friendships collection: %w", err)
+	}
+
+	// Create a graph with edge definition
+	edgeDefs := arangodb.EdgeDefinition{
+		{
+			Collection: "friendships",
+			From:       []string{"persons"},
+			To:         []string{"persons"},
+		},
+	}
+
+	err = ctx.ArangoDB.CreateGraph(ctx, "social_network", "social_graph", &edgeDefs)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create graph: %w", err)
+	}
+
+	return "Setup completed successfully", nil
+}
+
+// CreateFriendship demonstrates edge document creation
+func CreateFriendship(ctx *gofr.Context) (interface{}, error) {
+	var req struct {
+		From      string `json:"from"`
+		To        string `json:"to"`
+		StartDate string `json:"startDate"`
+	}
+
+	if err := ctx.Bind(&req); err != nil {
+		return nil, err
+	}
+
+	friendship := Friendship{
+		StartDate: req.StartDate,
+	}
+
+	edgeID, err := ctx.ArangoDB.CreateEdgeDocument(ctx, "social_network", "friendships", req.From, req.To, friendship)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create friendship: %w", err)
+	}
+
+	return map[string]string{
+		"message": "Friendship created successfully",
+		"edgeID":  edgeID,
+	}, nil
+}
+```
+
+

pkg/gofr/container/container.go

@@ -61,6 +61,7 @@ type Container struct {
 	OpenTSDB   OpenTSDB
 	ScyllaDB   ScyllaDB
 	SurrealDB  SurrealDB
+	ArangoDB   ArangoDB
 
 	KVStore KVStore
 

pkg/gofr/container/datasources.go

@@ -574,3 +574,58 @@ type ScyllaDBProvider interface {
 	ScyllaDB
 	provider
 }
+
+type ArangoDB interface {
+	// ListDBs lists all databases in ArangoDB.
+	ListDBs(ctx context.Context) ([]string, error)
+	// CreateDB creates a new database in ArangoDB.
+	CreateDB(ctx context.Context, database string) error
+	// DropDB deletes an existing database in ArangoDB.
+	DropDB(ctx context.Context, database string) error
+
+	// CreateCollection creates a new collection in a database with specified type.
+	CreateCollection(ctx context.Context, database, collection string, isEdge bool) error
+	// DropCollection deletes an existing collection from a database.
+	DropCollection(ctx context.Context, database, collection string) error
+	// TruncateCollection truncates a collection in a database.
+	TruncateCollection(ctx context.Context, database, collection string) error
+	// ListCollections lists all collections in a database.
+	ListCollections(ctx context.Context, database string) ([]string, error)
+
+	// CreateDocument creates a new document in the specified collection.
+	CreateDocument(ctx context.Context, dbName, collectionName string, document any) (string, error)
+	// GetDocument retrieves a document by its ID from the specified collection.
+	GetDocument(ctx context.Context, dbName, collectionName, documentID string, result any) error
+	// UpdateDocument updates an existing document in the specified collection.
+	UpdateDocument(ctx context.Context, dbName, collectionName, documentID string, document any) error
+	// DeleteDocument deletes a document by its ID from the specified collection.
+	DeleteDocument(ctx context.Context, dbName, collectionName, documentID string) error
+
+	// CreateEdgeDocument creates a new edge document between two vertices.
+	// The `document` parameter should be a map or struct containing the edge data.
+	// Example of `document` parameter:
+	//   document := map[string]any{
+	//       "attribute1": "value1",
+	//       "attribute2": "value2",
+	//   }
+	CreateEdgeDocument(ctx context.Context, dbName, collectionName string, from, to string, document any) (string, error)
+
+	// CreateGraph creates a new graph in a database taking graph name and *[]arangodb.EdgeDefinition as input.
+	CreateGraph(ctx context.Context, database, graph string, edgeDefinitions any) error
+	// DropGraph deletes an existing graph from a database.
+	DropGraph(ctx context.Context, database, graph string) error
+	// ListGraphs lists all graphs in a database.
+	ListGraphs(ctx context.Context, database string) ([]string, error)
+
+	// Query executes an AQL query and binds the results
+	Query(ctx context.Context, dbName string, query string, bindVars map[string]any, result any) error
+
+	HealthChecker
+}
+
+// ArangoProvider is an interface that extends ArangoDB with additional methods for logging, metrics, and connection management.
+type ArangoProvider interface {
+	ArangoDB
+
+	provider
+}

pkg/gofr/container/mock_container.go

@@ -87,6 +87,9 @@ func NewMockContainer(t *testing.T, options ...options) (*Container, *Mocks) {
 	opentsdbMock := NewMockOpenTSDBProvider(ctrl)
 	container.OpenTSDB = opentsdbMock
 
+	arangoMock := NewMockArangoProvider(ctrl)
+	container.ArangoDB = arangoMock
+
 	var httpMock *service.MockHTTP
 
 	container.Services = make(map[string]service.HTTP)