feat: add date filtering with fromDate and untilDate

Author: morremeyer

api/docs.go

@@ -2406,6 +2406,18 @@ const docTemplate = `{
                         "name": "date",
                         "in": "query"
                     },
+                    {
+                        "type": "string",
+                        "description": "Transactions at and after this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided.",
+                        "name": "fromDate",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Transactions before and at this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided.",
+                        "name": "untilDate",
+                        "in": "query"
+                    },
                     {
                         "type": "string",
                         "description": "Filter by amount",

api/swagger.json

@@ -2394,6 +2394,18 @@
                         "name": "date",
                         "in": "query"
                     },
+                    {
+                        "type": "string",
+                        "description": "Transactions at and after this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided.",
+                        "name": "fromDate",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Transactions before and at this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided.",
+                        "name": "untilDate",
+                        "in": "query"
+                    },
                     {
                         "type": "string",
                         "description": "Filter by amount",

api/swagger.yaml

@@ -2491,6 +2491,16 @@ paths:
         in: query
         name: date
         type: string
+      - description: Transactions at and after this date. Ignores exact time, matches
+          on the day of the RFC3339 timestamp provided.
+        in: query
+        name: fromDate
+        type: string
+      - description: Transactions before and at this date. Ignores exact time, matches
+          on the day of the RFC3339 timestamp provided.
+        in: query
+        name: untilDate
+        type: string
       - description: Filter by amount
         in: query
         name: amount

pkg/controllers/transaction.go

@@ -34,6 +34,8 @@ type TransactionLinks struct {
 
 type TransactionQueryFilter struct {
 	Date                  time.Time       `form:"date" filterField:"false"`
+	FromDate              time.Time       `form:"fromDate" filterField:"false"`
+	UntilDate             time.Time       `form:"untilDate" filterField:"false"`
 	Amount                decimal.Decimal `form:"amount"`
 	AmountLessOrEqual     decimal.Decimal `form:"amountLessOrEqual" filterField:"false"` // Amount less than or equal to this
 	AmountMoreOrEqual     decimal.Decimal `form:"amountMoreOrEqual" filterField:"false"` // Amount more than or equal to this
@@ -201,6 +203,8 @@ func (co Controller) CreateTransaction(c *gin.Context) {
 //	@Failure		500	{object}	httperrors.HTTPError
 //	@Router			/v1/transactions [get]
 //	@Param			date					query	string	false	"Date of the transaction. Ignores exact time, matches on the day of the RFC3339 timestamp provided."
+//	@Param			fromDate				query	string	false	"Transactions at and after this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided."
+//	@Param			untilDate				query	string	false	"Transactions before and at this date. Ignores exact time, matches on the day of the RFC3339 timestamp provided."
 //	@Param			amount					query	string	false	"Filter by amount"
 //	@Param			amountLessOrEqual		query	string	false	"Amount less than or equal to this"
 //	@Param			amountMoreOrEqual		query	string	false	"Amount more than or equal to this"
@@ -240,6 +244,14 @@ func (co Controller) GetTransactions(c *gin.Context) {
 		query = query.Where("transactions.date >= date(?)", date).Where("transactions.date < date(?)", date.AddDate(0, 0, 1))
 	}
 
+	if !filter.FromDate.IsZero() {
+		query = query.Where("transactions.date >= date(?)", time.Date(filter.FromDate.Year(), filter.FromDate.Month(), filter.FromDate.Day(), 0, 0, 0, 0, time.UTC))
+	}
+
+	if !filter.UntilDate.IsZero() {
+		query = query.Where("transactions.date <= date(?)", time.Date(filter.UntilDate.Year(), filter.UntilDate.Month(), filter.UntilDate.Day(), 0, 0, 0, 0, time.UTC))
+	}
+
 	if filter.AccountID != "" {
 		accountID, ok := httputil.UUIDFromString(c, filter.AccountID)
 		if !ok {

pkg/controllers/transaction_test.go

@@ -160,6 +160,12 @@ func (suite *TestSuiteStandard) TestGetTransactionsFilter() {
 	}{
 		{"Exact Time", fmt.Sprintf("date=%s", time.Date(2021, 2, 6, 5, 1, 0, 585, time.UTC).Format(time.RFC3339Nano)), 1},
 		{"Same date", fmt.Sprintf("date=%s", time.Date(2021, 2, 6, 7, 0, 0, 700, time.UTC).Format(time.RFC3339Nano)), 1},
+		{"After date", fmt.Sprintf("fromDate=%s", time.Date(2017, 1, 1, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano)), 2},
+		{"Before date", fmt.Sprintf("untilDate=%s", time.Date(2017, 1, 1, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano)), 1},
+		{"After all dates", fmt.Sprintf("fromDate=%s", time.Date(2022, 1, 1, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano)), 0},
+		{"Before all dates", fmt.Sprintf("untilDate=%s", time.Date(2010, 8, 17, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano)), 0},
+		{"Between two dates", fmt.Sprintf("untilDate=%s&fromDate=%s", time.Date(2019, 8, 17, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano), time.Date(2015, 12, 24, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano)), 2},
+		{"Impossible between two dates", fmt.Sprintf("fromDate=%s&untilDate=%s", time.Date(2019, 8, 17, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano), time.Date(2015, 12, 24, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano)), 0},
 		{"Exact Amount", fmt.Sprintf("amount=%s", decimal.NewFromFloat(2.718).String()), 2},
 		{"Note", "note=Not important", 1},
 		{"No note", "note=", 1},