fix(importer/ynab-import): fix initial bugs (#682)

- return a list of TransactionCreate resources, not Transaction resources
- name the TransactionCreate resource "transaction" in the list
- only use positive amounts

Author: morremeyer

api/docs.go

@@ -3213,13 +3213,13 @@
                         "type": "string"
                     }
                 },
-                "model": {
-                    "$ref": "#/definitions/models.Transaction"
-                },
                 "sourceAccountName": {
                     "description": "Name of the source account if the ID is not known",
                     "type": "string",
                     "example": "Employer"
+                },
+                "transaction": {
+                    "$ref": "#/definitions/models.TransactionCreate"
                 }
             }
         },

api/swagger.json

@@ -258,12 +258,12 @@ definitions:
         items:
           type: string
         type: array
-      model:
-        $ref: '#/definitions/models.Transaction'
       sourceAccountName:
         description: Name of the source account if the ID is not known
         example: Employer
         type: string
+      transaction:
+        $ref: '#/definitions/models.TransactionCreate'
     type: object
   models.AccountCreate:
     properties:

api/swagger.yaml

@@ -248,7 +248,7 @@ func duplicateTransactions(co Controller, transactions []importer.TransactionPre
 		var duplicates []models.Transaction
 		co.DB.Find(&duplicates, models.Transaction{
 			TransactionCreate: models.TransactionCreate{
-				ImportHash: transaction.Model.ImportHash,
+				ImportHash: transaction.Transaction.ImportHash,
 			},
 		})
 

pkg/controllers/import.go

@@ -159,7 +159,7 @@ func (suite *TestSuiteStandard) TestYnabImportPreviewDuplicateDetection() {
 
 	transaction := suite.createTestTransaction(models.TransactionCreate{
 		SourceAccountID: account.Data.ID,
-		ImportHash:      preview.Data[0].Model.ImportHash,
+		ImportHash:      preview.Data[0].Transaction.ImportHash,
 		Amount:          decimal.NewFromFloat(1.13),
 	})
 

pkg/controllers/import_test.go

@@ -44,13 +44,11 @@ func Parse(f io.Reader, account models.Account) ([]importer.TransactionPreview,
 		}
 
 		t := importer.TransactionPreview{
-			Model: models.Transaction{
-				TransactionCreate: models.TransactionCreate{
-					Date:       date,
-					ImportHash: helpers.Sha256String(strings.Join(record, ",")),
-					Note:       record[Memo],
-					BudgetID:   account.BudgetID,
-				},
+			Transaction: models.TransactionCreate{
+				Date:       date,
+				ImportHash: helpers.Sha256String(strings.Join(record, ",")),
+				Note:       record[Memo],
+				BudgetID:   account.BudgetID,
 			},
 		}
 
@@ -60,28 +58,28 @@ func Parse(f io.Reader, account models.Account) ([]importer.TransactionPreview,
 		} else if record[Outflow] == "" && record[Inflow] == "" {
 			return csvReadError(reader, errors.New("no amount is set for the transaction"))
 		} else if record[Outflow] != "" {
-			t.Model.TransactionCreate.SourceAccountID = account.DefaultModel.ID
+			t.Transaction.SourceAccountID = account.DefaultModel.ID
 			t.DestinationAccountName = record[Payee]
 
 			amount, err := decimal.NewFromString(record[Outflow])
 			if err != nil {
 				return csvReadError(reader, errors.New("outflow could not be parsed to a decimal"))
 			}
 
-			t.Model.TransactionCreate.Amount = amount.Neg()
+			t.Transaction.Amount = amount
 		} else {
-			t.Model.TransactionCreate.DestinationAccountID = account.DefaultModel.ID
+			t.Transaction.DestinationAccountID = account.DefaultModel.ID
 			t.SourceAccountName = record[Payee]
 
 			amount, err := decimal.NewFromString(record[Inflow])
 			if err != nil {
 				return csvReadError(reader, errors.New("inflow could not be parsed to a decimal"))
 			}
 
-			t.Model.TransactionCreate.Amount = amount
+			t.Transaction.Amount = amount
 		}
 
-		if t.Model.TransactionCreate.Amount.IsZero() {
+		if t.Transaction.Amount.IsZero() {
 			return csvReadError(reader, errors.New("the amount for a transaction must not be 0"))
 		}
 

pkg/importer/parser/ynab-import/parse.go

@@ -32,6 +32,10 @@ func TestParse(t *testing.T) {
 			transactions, err := Parse(f, models.Account{})
 			assert.Nil(t, err, "Parsing failed")
 			assert.Len(t, transactions, tt.length, "Wrong number of transactions has been parsed")
+
+			for _, transaction := range transactions {
+				assert.True(t, transaction.Transaction.Amount.IsPositive(), "Transaction amount is not positive: %s", transaction.Transaction.Amount)
+			}
 		})
 	}
 }

pkg/importer/parser/ynab-import/parse_test.go

@@ -48,8 +48,8 @@ type Transaction struct {
 
 // TransactionPreview is used to preview transactions that will be imported to allow for editing.
 type TransactionPreview struct {
-	Model                   models.Transaction
-	SourceAccountName       string      `json:"sourceAccountName" example:"Employer"`           // Name of the source account if the ID is not known
-	DestinationAccountName  string      `json:"destinationAccountName" example:"Deutsche Bahn"` // Name of the destination account if the ID is not known
-	DuplicateTransactionIDs []uuid.UUID `json:"duplicateTransactionIds"`                        // IDs of transactions that this transaction duplicates
+	Transaction             models.TransactionCreate `json:"transaction"`
+	SourceAccountName       string                   `json:"sourceAccountName" example:"Employer"`           // Name of the source account if the ID is not known
+	DestinationAccountName  string                   `json:"destinationAccountName" example:"Deutsche Bahn"` // Name of the destination account if the ID is not known
+	DuplicateTransactionIDs []uuid.UUID              `json:"duplicateTransactionIds"`                        // IDs of transactions that this transaction duplicates
 }