From 700659ff6011ab032331219f0c8f61f2fa8f2510 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 15:12:22 -0500 Subject: [PATCH 1/7] fix: make module work and add instructions for using --- README.md | 2 + flake.nix | 84 ++++++++++++++----------- modules/actualbudget-report/default.nix | 12 ++-- 3 files changed, 54 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 14e047b..0bec688 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ inputs.actualbudget-report.url = "git+https://git.wanderingcrow.net/TheWandering Then in your configuration (using sops-nix, you will need to adjust it if you use agenix or alternatives): ```nix +nixpkgs.overlays = [ inputs.actualbudget-report.overlays.default ]; + imports = [ inputs.actualbudget-report.nixosModules.default; ]; diff --git a/flake.nix b/flake.nix index 5caf0c0..29ec137 100644 --- a/flake.nix +++ b/flake.nix @@ -7,44 +7,52 @@ }; outputs = - inputs@{ flake-parts, ... }: - flake-parts.lib.mkFlake { inherit inputs; } { - systems = [ - "x86_64-linux" - "aarch64-linux" - "aarch64-darwin" - "x86_64-darwin" - ]; - flake.nixosModules = { - default = ./modules/actualbudget-report; - }; - perSystem = - { - config, - self', - inputs', - pkgs, - system, - ... - }: - { - packages.default = pkgs.buildGoModule { - name = "actualbudget-report"; - src = pkgs.fetchFromGitea { - domain = "git.wanderingcrow.net"; - owner = "TheWanderingCrow"; - repo = "actualbudget-report"; - rev = "v0.1"; - hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; + inputs@{ + self, + flake-parts, + ... + }: + flake-parts.lib.mkFlake + { + inherit inputs; + } + { + imports = [ inputs.flake-parts.flakeModules.easyOverlay ]; + systems = [ + "x86_64-linux" + "aarch64-linux" + "aarch64-darwin" + "x86_64-darwin" + ]; + flake.nixosModules.default = ./modules/actualbudget-report; + perSystem = + { + config, + self', + inputs', + pkgs, + system, + ... + }: + { + overlayAttrs = { inherit (config.packages) actualbudget-report; }; + packages.actualbudget-report = pkgs.buildGoModule { + name = "actualbudget-report"; + src = pkgs.fetchFromGitea { + domain = "git.wanderingcrow.net"; + owner = "TheWanderingCrow"; + repo = "actualbudget-report"; + rev = "v0.1"; + hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; + }; + vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; + }; + devShells.default = pkgs.mkShell { + ENVIRONMENT = "dev"; + nativeBuildInputs = with pkgs; [ + devenv + ]; }; - vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; - devShells.default = pkgs.mkShell { - ENVIRONMENT = "dev"; - nativeBuildInputs = with pkgs; [ - devenv - ]; - }; - }; - }; + }; } diff --git a/modules/actualbudget-report/default.nix b/modules/actualbudget-report/default.nix index d3e3763..c856982 100644 --- a/modules/actualbudget-report/default.nix +++ b/modules/actualbudget-report/default.nix @@ -1,8 +1,8 @@ { + pkgs, config, options, lib, - pkgs, ... }: let @@ -10,8 +10,8 @@ let opt = options.services.actualbudget-report; inherit (lib) mkEnableOption - mkOption mkPackageOption + mkOption mkIf types ; @@ -20,12 +20,12 @@ in options = { services.actualbudget-report = { enable = mkEnableOption "Actualbudget email reports"; - package = mkPackageOption pkgs.default; - interval = { + interval = mkOption { type = types.str; default = "Sun 12:00:00"; description = "systemd-timer OnCalendar legal string for sending reports."; }; + package = mkPackageOption pkgs "actualbudget-report" { }; environmentFile = mkOption { type = types.path; default = ""; @@ -39,11 +39,11 @@ in description = "Actualbudget report sender service"; serviceConfig = { Type = "oneshot"; - ExecStart = "${cfg.package}/bin/actualbudget-report"; + ExecStart = "${pkgs.actualbudget-report}/bin/actualbudget-report"; EnvironmentFile = cfg.environmentFile; }; }; - systemd.timers.flamesite-backup = { + systemd.timers.actualbudget-report = { enable = true; wantedBy = [ "timers.target" ]; timerConfig = { From 6eb0beb355259b8a7ef29202508b605dc97a61fc Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 27 Dec 2025 10:45:31 -0500 Subject: [PATCH 2/7] add support for encryption key protected budget files --- README.md | 1 + main.go | 23 +++++++++++++++-------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0bec688..2829f18 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ sops.templates."actualbudget-report-env".content = '' SMTP_PASSWORD= SMTP_HOST= SMTP_RECIPIENTS= + BUDGET_ENCRYPTION_KEY= ''; services.actualbudget-report = { diff --git a/main.go b/main.go index 195a22a..945591e 100644 --- a/main.go +++ b/main.go @@ -32,10 +32,11 @@ import ( ) type BudgetClient struct { - baseUrl string - apiKey string - syncId string - fullUrl string + baseUrl string + apiKey string + syncId string + fullUrl string + encryptionKey string } type BudgetMonthsResponse struct { @@ -73,9 +74,12 @@ type BudgetMonthsResponse struct { } `json:"data"` } -func CreateBudgetClient(baseUrl string, apiKey string, syncId string) *BudgetClient { +// Create budget client, you may pass empty strings to optional parameters +// Required: baseUrl, apiKey, syncId +// Optional: encryptionKey +func CreateBudgetClient(baseUrl string, apiKey string, syncId string, encryptionKey string) *BudgetClient { fullUrl := baseUrl + "/v1/budgets/" + syncId - client := BudgetClient{baseUrl, apiKey, syncId, fullUrl} + client := BudgetClient{baseUrl, apiKey, syncId, fullUrl, encryptionKey} return &client } @@ -111,7 +115,9 @@ func (b BudgetClient) GetBudgetMonths() *BudgetMonthsResponse { currentTime := time.Now() year, month := currentTime.Year(), int(currentTime.Month()) budgetMonth := fmt.Sprintf("%v-%v", year, month) - resp := b.callApi("GET", "/months/"+budgetMonth, nil) + resp := b.callApi("GET", "/months/"+budgetMonth, map[string]string{ + "budget-encryption-password": b.encryptionKey, + }) defer resp.Body.Close() if resp.StatusCode != http.StatusOK { log.Fatal("GetBudgetAmounts failed with: " + string(resp.Status)) @@ -139,11 +145,12 @@ func main() { var baseUrl = os.Getenv("BASE_URL") var apiKey = os.Getenv("API_KEY") var syncId = os.Getenv("SYNC_ID") + var encryptionKey = os.Getenv("BUDGET_ENCRYPTION_KEY") var smtpUsername = os.Getenv("SMTP_USERNAME") var smtpPassword = os.Getenv("SMTP_PASSWORD") var smtpHost = os.Getenv("SMTP_HOST") var smtpRecipients = os.Getenv("SMTP_RECIPIENTS") - client := CreateBudgetClient(baseUrl, apiKey, syncId) + client := CreateBudgetClient(baseUrl, apiKey, syncId, encryptionKey) if !client.BankSync() { log.Println("Bank Sync failed, information may not be up to date") } From ae765605d9fce350c3773abb6b14bbd2c67d95c5 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 27 Dec 2025 10:49:42 -0500 Subject: [PATCH 3/7] chore: release v1.0 --- flake.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/flake.nix b/flake.nix index 29ec137..a07b5a6 100644 --- a/flake.nix +++ b/flake.nix @@ -42,8 +42,8 @@ domain = "git.wanderingcrow.net"; owner = "TheWanderingCrow"; repo = "actualbudget-report"; - rev = "v0.1"; - hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; + rev = "v1.0"; + hash = "sha256-MP2JRBls5rqUZOMmb8BD60jcLwGgvGRAAixWxMttNhA="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; From 00104dc59a91875835e98fff123608fb55397874 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 27 Dec 2025 11:04:02 -0500 Subject: [PATCH 4/7] docs: fix syntax error in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2829f18..4d5e23d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Then in your configuration (using sops-nix, you will need to adjust it if you us nixpkgs.overlays = [ inputs.actualbudget-report.overlays.default ]; imports = [ - inputs.actualbudget-report.nixosModules.default; + inputs.actualbudget-report.nixosModules.default ]; # Fill out all the following environment variables for the service From 43d4e6caee531c8ad1a0bb4f54ae4e0470b72331 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Tue, 30 Dec 2025 21:20:52 -0500 Subject: [PATCH 5/7] chore: update sha256 --- flake.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flake.nix b/flake.nix index a07b5a6..1db92a9 100644 --- a/flake.nix +++ b/flake.nix @@ -43,7 +43,7 @@ owner = "TheWanderingCrow"; repo = "actualbudget-report"; rev = "v1.0"; - hash = "sha256-MP2JRBls5rqUZOMmb8BD60jcLwGgvGRAAixWxMttNhA="; + hash = "sha256-rt4wiSzsNqmSWGoMBf6fiNpCxZfEPwYlZuClLI+s+A4="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; From 1c1b2a3a1d1475a1b04a6a4e37b9d484ae19518a Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Tue, 30 Dec 2025 21:49:28 -0500 Subject: [PATCH 6/7] fix!: SMTP now works properly in non-dev environments --- main.go | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/main.go b/main.go index 945591e..38d12d0 100644 --- a/main.go +++ b/main.go @@ -149,6 +149,7 @@ func main() { var smtpUsername = os.Getenv("SMTP_USERNAME") var smtpPassword = os.Getenv("SMTP_PASSWORD") var smtpHost = os.Getenv("SMTP_HOST") + var smtpPort = os.Getenv("SMTP_PORT") var smtpRecipients = os.Getenv("SMTP_RECIPIENTS") client := CreateBudgetClient(baseUrl, apiKey, syncId, encryptionKey) if !client.BankSync() { @@ -184,12 +185,8 @@ func main() { message := []byte(subject + mime + body + categories.String()) var auth smtp.Auth - if os.Getenv("ENVIRONMENT") == "dev" { - auth = nil - } else { - auth = smtp.PlainAuth("", smtpUsername, smtpPassword, smtpHost) - } - err := smtp.SendMail(smtpHost, auth, smtpUsername, strings.Split(smtpRecipients, ","), []byte(message)) + auth = smtp.PlainAuth("", smtpUsername, smtpPassword, smtpHost) + err := smtp.SendMail(smtpHost+":"+smtpPort, auth, smtpUsername, strings.Split(smtpRecipients, ","), []byte(message)) if err != nil { log.Fatal(err) } From 586e336cb885cbc87d2f296e995590385e9d60d9 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Tue, 30 Dec 2025 21:52:15 -0500 Subject: [PATCH 7/7] chore: release v2.0 --- flake.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/flake.nix b/flake.nix index 1db92a9..21fc84e 100644 --- a/flake.nix +++ b/flake.nix @@ -42,8 +42,8 @@ domain = "git.wanderingcrow.net"; owner = "TheWanderingCrow"; repo = "actualbudget-report"; - rev = "v1.0"; - hash = "sha256-rt4wiSzsNqmSWGoMBf6fiNpCxZfEPwYlZuClLI+s+A4="; + rev = "v2.0"; + hash = "sha256-H+pA9dFsP5QQ3W32NEU1TWYiOiti53jnzN3Bnq+QJ5Q="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; };