Release v1.7.0

CONTRIBUTING.md

@@ -1,15 +1,15 @@
 ## Contribution Guidelines
-* Minor changes can be done directly by editing code on github. Github automatically creates a temporary branch and
+* Minor changes can be done directly by editing code on GitHub. GitHub automatically creates a temporary branch and
   files a PR. This is only suitable for really small changes like: spelling fixes, variable name changes or error string
   change etc. For larger commits, following steps are recommended.
-* (Optional) If you want to discuss your implementation with the users of Gofr, use the github discussions of this repo.
+* (Optional) If you want to discuss your implementation with the users of GoFr, use the GitHub discussions of this repo.
 * Configure your editor to use goimport and golangci-lint on file changes. Any code which is not formatted using these
   tools, will fail on the pipeline.
 * All code contributions should have associated tests and all new line additions should be covered in those testcases.
   No PR should ever decrease the overall code coverage.
 * Once your code changes are done along with the testcases, submit a PR to development branch. Please note that all PRs
   are merged from feature branches to development first.
-* All PRs need to be reviewed by at least 2 Gofr developers. They might reach out to you for any clarfication.
+* All PRs need to be reviewed by at least 2 GoFr developers. They might reach out to you for any clarification.
 * Thank you for your contribution. :)
 
 ### GoFr Testing Policy:
@@ -87,7 +87,7 @@ Please note that the recommended local port for the services are different than
 * Take interfaces and return concrete types.
     - Lean interfaces - take 'exactly' what you need, not more. Onus of interface definition is on the package who is
       using it. so, it should be as lean as possible. This makes it easier to test.
-    - Be careful of type assertions in this context. If you take an interface and type assert to a type - then its
+    - Be careful of type assertions in this context. If you take an interface and type assert to a type - then it's
       similar to taking concrete type.
 * Uses of context:
     - We should use context as a first parameter.
@@ -113,4 +113,4 @@ Please note that the recommended local port for the services are different than
     - Use trailing white space or the <br> HTML tag at the end of the line.
     - Use "`" sign to add single line code and "```" to add multi-line code block.
     - Use relative references to images (in `public` folder as mentioned above.)
-* The [gofr.dev documentation]([url](https://gofr.dev/docs)) site is updated upon push to `/docs` path in the repo. Verify your changes are live after next gofr version.
+* The [gofr.dev documentation]([url](https://gofr.dev/docs)) site is updated upon push to `/docs` path in the repo. Verify your changes are live after next GoFr version.

README.md

@@ -16,13 +16,13 @@
 
 <br>
 
-Gofr is an opinionated microservice development framework. Listed in [CNCF Landscape](https://landscape.cncf.io/?selected=go-fr).
+GoFr is an opinionated microservice development framework. Listed in [CNCF Landscape](https://landscape.cncf.io/?selected=go-fr).
 
 Visit <a href="https://gofr.dev"/>https://gofr.dev</a> for more details and documentation.
 
 ## 🎯 Goal
-Even though generic applications can be written using Gofr, our main focus is to simplify the development of microservices.
-We will focus ourselves towards deployment in kubernetes and aspire to provide out-of-the-box observability.
+Even though generic applications can be written using GoFr, our main focus is to simplify the development of microservices.
+We will focus ourselves towards deployment in Kubernetes and aspire to provide out-of-the-box observability.
 
 ## 💡 Advantages/Features
 

docs/advanced-guide/dealing-with-datasources/page.md

@@ -1,13 +1,12 @@
 # Dealing with SQL
 
 GoFr simplifies the process of connecting to SQL databases where one needs to add respective configs in .env,
-which allows to connect to different SQL dialects(MYSQL, PostgreSQL) without going into complexity of configuring connections.
+which allows connecting to different SQL dialects(MySQL, PostgreSQL, SQLite) without going into complexity of configuring connections.
 
 With GoFr, connecting to different SQL databases is as straightforward as setting the DB_DIALECT environment variable to the respective dialect.
-For instance, to connect with PostgreSQL, set `DB_DIALECT` to `postgres`. Similarly, To connect with MySQL, simply set `DB_DIALECT` to `mysql`.
 
-## Usage
-Add the following configs in .env file.
+## Usage for PostgreSQL and MySQL
+To connect with PostgreSQL, set `DB_DIALECT` to `postgres`. Similarly, To connect with MySQL, simply set `DB_DIALECT` to `mysql`.
 
 ```dotenv
 DB_HOST=localhost
@@ -17,4 +16,13 @@ DB_NAME=test_db
 DB_PORT=3306
 
 DB_DIALECT=postgres
+```
+
+## Usage for SQLite
+To connect with PostgreSQL, set `DB_DIALECT` to `sqlite` and `DB_NAME` to the name of your DB File. If the DB file already exists then it will be used otherwise a new one will be created.
+
+```dotenv
+DB_NAME=test.db
+
+DB_DIALECT=sqlite
 ```

docs/advanced-guide/gofr-errors/page.md

@@ -0,0 +1,56 @@
+# Error Handling
+
+GoFr provides a structured error handling approach to simplify error management in your applications. 
+The errors package in GoFr provides functionality for handling errors in GoFr applications. It includes predefined HTTP 
+and database errors, as well as the ability to create custom errors with additional context.
+
+## Pre-defined HTTP Errors
+
+GoFr’s `http` package offers several predefined error types to represent common HTTP error scenarios. These errors 
+automatically handle HTTP status code selection. These include:
+
+- `ErrorInvalidParam`: Represents an error due to an invalid parameter.
+- `ErrorMissingParam`: Represents an error due to a missing parameter.
+- `ErrorEntityNotFound`: Represents an error due to a not found entity.
+
+#### Usage:
+To use the predefined http errors,users can simply call them using GoFr's http package:
+```go
+ err := http.ErrorMissingParam{Param: []string{"id"}}
+```
+
+## Database Errors
+Database errors in GoFr, represented in the `datasource` package, encapsulate errors related to database operations such
+as database connection, query failure, availability etc. The `ErrorDB` struct can be used to populate `error` as well as 
+any custom message to it.
+
+#### Usage:
+```go
+// Creating a custom error wrapped in  underlying error for database operations
+dbErr := datasource.ErrorDB{Err: err, Message: "error from sql db"}
+
+// Adding stack trace to the error
+dbErr = dbErr.WithStack()
+
+// Creating a custom error only with error message and no underlying error.
+dbErr2 := datasource.ErrorDB{Message : "database connection timed out!"}
+```
+
+## Custom Errors
+GoFr's error structs implements an interface with `Error() string` and `StatusCode() int` methods, users can override the 
+status code by implementing it for their custom error.
+
+#### Usage:
+```go
+type customError struct {
+	error string
+}
+
+func (c customError) Error() string {
+	return fmt.Sprintf("custom error: %s", c.error)
+}
+
+func (c customError) StatusCode() int {
+	return http.StatusMethodNotAllowed
+}
+```

docs/advanced-guide/grpc/page.md

@@ -11,13 +11,13 @@ framework initially developed by Google.
         $ apt install -y protobuf-compiler
         $ protoc --version  # Ensure compiler version is 3+
         ```
-    - MacOS, using homebrew
+    - macOS, using Homebrew
         ```shell
         $ brew install protobuf
         $ protoc --version  # Ensure compiler version is 3+  
         ```
 - Install **Go Plugins** for protocol compiler:
-    1. Install prtocol compiler plugins for Go
+    1. Install protocol compiler plugins for Go
        ```shell
        $ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
        $ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
@@ -30,7 +30,7 @@ framework initially developed by Google.
 ## Creating protocol buffers
 For a detailed guide, please take a look at the {% new-tab-link title="Tutorial" href="https://grpc.io/docs/languages/go/basics/" /%} at official gRPC docs.
 
-We need to create a `customer.proto` file to define our service and the rpc methods that the service provides.
+We need to create a `customer.proto` file to define our service and the RPC methods that the service provides.
 ```protobuf
 // Indicates the protocol buffer version that is being used
 syntax = "proto3";
@@ -76,7 +76,7 @@ protoc \
 --go-grpc_opt=paths=source_relative \ 
 customer.proto
 ```
-Above command will generate two files `customer.pb.go` and `customer_grpc.pb.go` and these contain necessary code to perform rpc calls.
+Above command will generate two files `customer.pb.go` and `customer_grpc.pb.go` and these contain necessary code to perform RPC calls.
 In `customer.pb.go` you can find `CustomerService` interface-
 ```go
 // CustomerServiceServer is the server API for CustomerService service.
@@ -102,8 +102,8 @@ func (h *Handler) GetCustomer(ctx context.Context, filter *CustomerFilter) (*Cus
 }
 ```
 
-Lastly to register the gRPC service to the gofr server, user can call the `RegisterCustomerServiceServer` in `customer_grpc.pb.go`
-to register the service giving gofr app and the Handler struct.
+Lastly to register the gRPC service to the GoFr server, user can call the `RegisterCustomerServiceServer` in `customer_grpc.pb.go`
+to register the service giving GoFr app and the Handler struct.
 ```go
 package main
 

docs/advanced-guide/handling-data-migrations/page.md

@@ -1,20 +1,20 @@
 # Handling Data Migrations
 
 Suppose you manually make changes to your database, and now it's your responsibility to inform other developers to execute them. Additionally, you need to keep track of which changes should be applied to production machines in the next deployment.
-Gofr supports data migrations for MySQL, Postgres and Redis which allows to alter the state of a database, be it adding a new column to existing table or modifying the data type of existing column or adding constraints to an existing table, setting and removing keys etc.
+GoFr supports data migrations for MySQL, Postgres and Redis which allows altering the state of a database, be it adding a new column to existing table or modifying the data type of existing column or adding constraints to an existing table, setting and removing keys etc.
 
 ## Usage
 
 ### Creating Migration Files
 
-It is recommended to maintain a migrations directory in your project root to enhance readability and maintainability.
+It is recommended to maintain a `migrations` directory in your project root to enhance readability and maintainability.
 
 **Migration file names**
 
 It is recommended that each migration file should be numbered in the format of _YYYYMMDDHHMMSS_ when the migration was created.
 This helps prevent numbering conflicts and allows for maintaining the correct sort order by name in different filesystem views.
 
-Create the following file in migrations directory.
+Create the following file in `migrations` directory.
 
 **Filename : 20240226153000_create_employee_table.go**
 

docs/advanced-guide/http-authentication/page.md

@@ -4,7 +4,7 @@ Authentication is a crucial aspect of web applications, controlling access to re
 It is the process of verifying a user's identity to grant access to protected resources. It ensures that only authenticated
 users can perform actions or access data within an application.
 
-GoFr offer various approaches to implement authorization.
+GoFr offers various approaches to implement authorization.
 
 ## 1. HTTP Basic Auth
 *Basic Authentication* is a simple HTTP authentication scheme where the user's credentials (username and password) are 

docs/advanced-guide/http-communication/page.md

@@ -19,7 +19,7 @@ Registration of multiple dependent services is quite easier, which is a common u
 
 > The services instances are maintained by the container.
 
-Other provided options can be added additionally to coat the basic http client with features like circuit-breaker and
+Other provided options can be added additionally to coat the basic HTTP client with features like circuit-breaker and
 custom health check and add to the functionality of the HTTP service.
 The design choice for this was made such as many options as required can be added and are order agnostic,
 i.e. the order of the options is not important.

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

@@ -6,9 +6,9 @@ as unnecessary database drivers are not being compiled and added to the build.
 
 > We are planning to provide custom drivers for most common databases, and is in the pipeline for upcoming releases!
 
-## Mongo DB
-Gofr supports injecting Mongo DB that supports the following interface. Any driver that implements the interface can be added
-using `app.UseMongo()` method, and user's can use MongoDB across application with `gofr.Context`. 
+## MongoDB
+GoFr supports injecting MongoDB that supports the following interface. Any driver that implements the interface can be added
+using `app.AddMongo()` method, and user's can use MongoDB across application with `gofr.Context`.
 ```go
 type Mongo interface {
 	Find(ctx context.Context, collection string, filter interface{}, results interface{}) error
@@ -42,7 +42,7 @@ compromising the extensibility to use multiple databases.
 package main
 
 import (
-    mongo "github.com/vipul-rawat/gofr-mongo"
+    "gofr.dev/pkg/gofr/datasource/mongo"
     "go.mongodb.org/mongo-driver/bson"
 
     "gofr.dev/pkg/gofr"
@@ -56,13 +56,12 @@ type Person struct {
 
 func main() {
 	app := gofr.New()
-
-	// using the mongo driver from `vipul-rawat/gofr-mongo`
-	db := mongo.New(app.Config, app.Logger(), app.Metrics())
+
+	db := mongo.New(Config{URI: "mongodb://localhost:27017", Database: "test"})
 
 	// inject the mongo into gofr to use mongoDB across the application
 	// using gofr context
-	app.UseMongo(db)
+	app.AddMongo(db)
 
 	app.POST("/mongo", Insert)
 	app.GET("/mongo", Get)

docs/advanced-guide/middlewares/page.md

@@ -1,7 +1,7 @@
 # Middleware in GoFr
 
-Middleware allows you to intercept and manipulate HTTP requests and responses flowing through your application's 
-router. Middlewares can perform tasks such as authentication, authorization, caching etc. before 
+Middleware allows you intercepting and manipulating HTTP requests and responses flowing through your application's
+router. Middlewares can perform tasks such as authentication, authorization, caching etc. before
 or after the request reaches your application's handler.
 
 ## Adding Custom Middleware in GoFr

docs/advanced-guide/overriding-default/page.md

@@ -1,6 +1,6 @@
 # Overriding Default
 
-GoFr allows to override default behavior of its features.
+GoFr allows overriding default behavior of its features.
 
 ## Raw response format
 
@@ -74,7 +74,7 @@ Response example:
 
 ## Favicon.ico
 
-By default GoFr load it's own `favicon.ico` present in root directory for an application. To override `favicon.ico` user 
-can place it's custom icon in the **static** directory of it's application.
+By default GoFr load its own `favicon.ico` present in root directory for an application. To override `favicon.ico` user
+can place its custom icon in the **static** directory of its application.
 
 > NOTE: The custom favicon should also be named as `favicon.ico` in the static directory of application.

docs/advanced-guide/publishing-custom-metrics/page.md

@@ -3,7 +3,7 @@
 GoFr publishes some {% new-tab-link newtab=false title="default metrics" href="/docs/quick-start/observability" /%}.
 
 GoFr can handle multiple different metrics concurrently, each uniquely identified by its name during initialization.
-It supports the following {% new-tab-link title="metrics" href="https://opentelemetry.io/docs/specs/otel/metrics/" /%} types in prometheus format:
+It supports the following {% new-tab-link title="metrics" href="https://opentelemetry.io/docs/specs/otel/metrics/" /%} types in Prometheus format:
 
 1. Counter
 2. UpDownCounter

docs/advanced-guide/remote-log-level-change/page.md

@@ -1,6 +1,6 @@
 # Remote Log Level Change
 
-Gofr makes it easy to adjust the details captured in the application's logs, even while it's running!
+GoFr makes it easy to adjust the details captured in the application's logs, even while it's running!
 
 This feature allows users to effortlessly fine-tune logging levels without the need for redeployment, enhancing the monitoring and debugging experience.
 It is facilitated through simple configuration settings.

docs/advanced-guide/using-cron/page.md

@@ -13,7 +13,7 @@ What can users automate with cron?
 Basically, any task that can be expressed as a command or script can be automated with cron.
 
 Writing a cron job!
-On linux like systems cron jobs can be added by adding a line to the crontab file, specifying the schedule and the command
+On Linux like systems cron jobs can be added by adding a line to the crontab file, specifying the schedule and the command
 that needs to be run at that schedule. The cron schedule is expressed in the following format.
 
 `minute hour day_of_month month day_of_week`
@@ -22,8 +22,8 @@ Each field can take a specific value or combination of values to define the sche
 `*` (asterisk) to represent **any** value and `,` (comma) to separate multiple values. It also supports `0-n` to define a
 range of values for which the cron should run and `*/n` to define number of times the cron should run. Here n is an integer.
 
-## Adding cron jobs in gofr applications
-Adding cron jobs to gofr applications is made easy with a simple injection of user's function to the cron table maintained
+## Adding cron jobs in GoFr applications
+Adding cron jobs to GoFr applications is made easy with a simple injection of user's function to the cron table maintained
 by the gofr. The minimum time difference between cron job's two consecutive runs is a minute as it is the least significant
 scheduling time parameter.
 ```go