mfynab 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d0ef3ce6051c500eb5a269c3763ff18ae129fbbef15693eb8413fa6e3c788ef
-  data.tar.gz: d9788544bc9aaa518c8ad47d3abfe526fb8686fe676b49fe30358930e91dca75
+  metadata.gz: dfe614bd0fee4c3bd2c60de5b1fb18105f0aaa58b889ffd12fcdbd63c1144bcb
+  data.tar.gz: 07420fe5903a4ab62d99ac5feb644d731976ea0af21b9ea8e0e60e6c36ee5b45
 SHA512:
-  metadata.gz: 7a6ae839f41a31c0615561ebf08c57df799ff576ef4cfde32e30eab5373e8289ca053887c272c8c2d0bc44c0643b29a41fe45a54e6f278514b6e05eecb6c8816
-  data.tar.gz: 7dd19ed30d13acaef9ed75649098611f36af8c19f314c4366e829e587c67a2f057ad88e9028c8058c66263b72384ff1e8cc481a48725a3e9924d7687b5edfe74
+  metadata.gz: 1b2085738c14c7615632c38d3423c6fdf55c2c21a91c174e01b0fa04e32674721b5f87bbe65a1a50661b34c1dd36b223994a98b6a580691579da10b38a82193b
+  data.tar.gz: 90afb5a30ecdff9033fe954c79f58e6a9776a56458a4f08ffbb340b4621e0a4235ce729a65ebe0b0e08a5628a3a84fa26c95c215bb36e2adc73622447b676f13

data/lib/mfynab/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "mfynab/config"
 require "mfynab/money_forward"
 require "mfynab/money_forward/session"
 require "mfynab/money_forward_data"
@@ -18,20 +19,9 @@ module MFYNAB
 
     def start
       logger.info("Running...")
-
       money_forward.update_accounts(money_forward_account_names)
-
-      Dir.mktmpdir("mfynab") do |save_path|
-        money_forward.download_csv(
-          path: save_path,
-          months: months_to_sync,
-        )
-
-        data = MoneyForwardData.new(logger: logger)
-        data.read_all_csv(save_path)
-        ynab_transaction_importer.run(data.to_h)
-      end
-
+      data = money_forward.fetch_data(config.months_to_sync)
+      ynab_transaction_importer.run(data.to_h)
       logger.info("Done!")
     end
 
@@ -40,30 +30,26 @@ module MFYNAB
       attr_reader :argv
 
       def money_forward_account_names
-        @_money_forward_account_names = config["accounts"].map { _1["money_forward_name"] }
+        @_money_forward_account_names = config.accounts.map { _1["money_forward_name"] }
       end
 
       def ynab_transaction_importer
         @_ynab_transaction_importer ||= YnabTransactionImporter.new(
-          config["ynab_access_token"],
-          config["ynab_budget"],
-          config["accounts"],
+          config.credentials["ynab_access_token"],
+          config.ynab_budget,
+          config.accounts,
           logger: logger,
         )
       end
 
-      def months_to_sync
-        config.fetch("months_to_sync", 3)
-      end
-
       def money_forward
         @_money_forward ||= MoneyForward.new(session, logger: logger)
       end
 
       def session
         @_session ||= MoneyForward::Session.new(
-          username: config["moneyforward_username"],
-          password: config["moneyforward_password"],
+          username: config.credentials["moneyforward_username"],
+          password: config.credentials["moneyforward_password"],
           logger: logger,
         )
       end
@@ -75,15 +61,7 @@ module MFYNAB
       end
 
       def config
-        @_config ||= YAML
-          .load_file(config_file)
-          .values
-          .first
-          .merge(
-            "ynab_access_token" => ENV.fetch("YNAB_ACCESS_TOKEN"),
-            "moneyforward_username" => ENV.fetch("MONEYFORWARD_USERNAME"),
-            "moneyforward_password" => ENV.fetch("MONEYFORWARD_PASSWORD"),
-          )
+        @_config ||= Config.from_yaml(config_file, logger)
       end
 
       def logger

data/lib/mfynab/config.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "mfynab/credentials_normalizer"
+
+module MFYNAB
+  class Config
+    DEFAULT_MONTHS_TO_SYNC = 3
+
+    def initialize(hash_config, logger)
+      @hash_config = hash_config
+      @logger = logger
+    end
+
+    def self.from_yaml(file, logger)
+      yaml_data = YAML.load_file(file)
+      # Backwards compatibility: support old config files that still have a top-level key.
+      # TODO: at some point (major version bump), we should probably remove this.
+      unless yaml_data.key?("accounts")
+        logger.warn("Top-level key in configuration file is deprecated. Please remove it.")
+        yaml_data = yaml_data.values.first
+      end
+
+      raise "Invalid configuration file" unless yaml_data.key?("accounts")
+
+      new(yaml_data, logger)
+    end
+
+    def ynab_budget
+      hash_config.fetch("ynab_budget")
+    end
+
+    def months_to_sync
+      hash_config.fetch("months_to_sync", DEFAULT_MONTHS_TO_SYNC)
+    end
+
+    def accounts
+      hash_config.fetch("accounts", [])
+    end
+
+    def credentials
+      @_credentials ||= CredentialsNormalizer.new(hash_config, logger).normalize
+    end
+
+    private
+
+      attr_reader :hash_config, :logger
+  end
+end

data/lib/mfynab/credentials_normalizer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MFYNAB
+  class CredentialsNormalizer
+    def initialize(hash_config, logger)
+      @hash_config = hash_config
+      @logger = logger
+    end
+
+    def normalize
+      config = hash_config["credentials"]
+      if config.nil?
+        logger.warn("No credentials found in configuration file. Please update your configuration file.")
+        # This provides backwards compatibility with old configuration files
+        # that did not include the new credentials.
+        # TODO: at some point (major version bump), we should probably remove this.
+        return {
+          "ynab_access_token" => ENV.fetch("YNAB_ACCESS_TOKEN"),
+          "moneyforward_username" => ENV.fetch("MONEYFORWARD_USERNAME"),
+          "moneyforward_password" => ENV.fetch("MONEYFORWARD_PASSWORD"),
+        }
+      end
+
+      config.transform_values { normalize_credential(_1) }
+    end
+
+    private
+
+      attr_reader :hash_config, :logger
+
+      def normalize_credential(value)
+        case value
+        when String
+          value
+        when Hash
+          if !value.key?("type") || value["type"] == "literal"
+            value.fetch("value")
+          elsif value["type"] == "env"
+            ENV.fetch(value.fetch("value"))
+          else
+            raise "Unknown credential type: #{value['type']}"
+          end
+        else
+          raise "Unknown credential type: #{value.class}"
+        end
+      end
+  end
+end

data/lib/mfynab/money_forward.rb

@@ -32,6 +32,19 @@ module MFYNAB
       update_accounts(account_names, update_invalid: false)
     end
 
+    def fetch_data(months)
+      Dir.mktmpdir("mfynab") do |save_path|
+        download_csv(
+          path: save_path,
+          months: months,
+        )
+
+        MoneyForwardData.new(logger: logger).tap do |data|
+          data.read_all_csv(save_path)
+        end
+      end
+    end
+
     def download_csv(path:, months:)
       month = Date.today
       month -= month.day - 1 # First day of month

data/lib/mfynab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MFYNAB
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mfynab
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Stosik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -90,6 +90,8 @@ extra_rdoc_files: []
 files:
 - exe/mfynab
 - lib/mfynab/cli.rb
+- lib/mfynab/config.rb
+- lib/mfynab/credentials_normalizer.rb
 - lib/mfynab/money_forward.rb
 - lib/mfynab/money_forward/account_status.rb
 - lib/mfynab/money_forward/session.rb