ynab_convert 1.0.7 → 2.0.1

data/lib/ynab_convert/transformers/formatters/n26_formatter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ynab_convert/transformers'
+
+module Transformers
+  module Formatters
+    # Formats N26 statement values to YNAB4 value
+    class N26 < Formatter
+      def initialize
+        super({ date: [0], payee: [1], amount: [5] })
+      end
+
+      # All amounts are always in EUR
+      def memo(_row)
+        'EUR'
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/ubs_chequing_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # UBS Switzerland Chequing accounts formatter
+    class UBSChequing < Formatter
+      def initialize
+        super({ date: [9], payee: [12], outflow: [18], inflow: [19] })
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/ubs_credit_formatter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # UBS Switzerland Credit Card accounts formatter
+    class UBSCredit < Formatter
+      def initialize
+        super({ date: [3], payee: [4], outflow: [10], inflow: [11] })
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers/formatters/wise_formatter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Transformers
+  module Formatters
+    # Wise card accounts formatter
+    class Wise < Formatter
+      def initialize
+        super({ date: [1], payee: [13], amount: [2] })
+      end
+
+      def payee(row)
+        merchant = row[13]
+        description = row[4]
+
+        return description if merchant.nil?
+
+        merchant
+      end
+
+      def memo(row)
+        # Description goes in Memo because we'll need to extract the original
+        # amount from it in the enhancer.
+        description = row[4]
+        amount_currency = row[3]
+        original_amount = description.scan(/\d+\.\d{2}\s\w{3}/).first
+
+        memo = amount_currency
+        # Topups don't have an original amount
+        memo = "#{memo},#{original_amount}" unless original_amount.nil?
+
+        memo
+      end
+    end
+  end
+end

data/lib/ynab_convert/transformers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Regroups all the classes involved in transforming a given Statement into a
+# YNAB4File
+module Transformers
+  transformers = %w[cleaner enhancer formatter]
+
+  # Load all known Transformers
+  transformers.each do |t|
+    # Require the base classes first so that its children can find the parent
+    # class since files are otherwise loaded in alphabetical order
+    require File.join(__dir__, 'transformers', "#{t}s", "#{t}.rb")
+
+    Dir[File.join(__dir__, 'transformers', "#{t}s", '*.rb')].sort.each do |file|
+      require file
+    end
+  end
+end

data/lib/ynab_convert/validators/ynab4_row_validator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Validators
+  # Checks YNAB4 row for validity. A row is valid if it has a Date, Payee, and
+  # one of Amount, Outflow, Inflow.
+  module YNAB4Row
+    # Validates a row
+    # @param row [Array<String, Numeric, Date>] The row to validate
+    # @return [Boolean] Whether the row is valid
+    def self.valid?(row)
+      # we are dealing with a YNAB4 row:
+      # %w[Date Payee Memo Amount|Outflow Inflow]
+      amount_valid?(row) &&
+        transaction_date_valid?(row) &&
+        payee_valid?(row)
+    end
+
+    # Indicates which format the row is in (:flows or :amounts)
+    # @param row [CSV::Row] the row to check
+    # @return [:flows, :amounts] the row's format
+    def self.row_format(row)
+      format = :flows
+      # :flows has 5 columns: Date, Payee, Memo, Outflow, Inflow
+      # :amounts has 4 columns: Date, Payee, Memo, Amount
+      format = :amounts if row.length == 4
+
+      format
+    end
+
+    # Indicates whether the amount on the row is valid
+    # @param row [CSV::Row] the row to check
+    # @return [Boolean] whether the amount is invalid
+    def self.amount_valid?(row)
+      format = row_format(row)
+      indices = [3]
+      indices << 4 if format == :flows
+
+      if format == :amounts
+        return indices.reduce(true) do |valid, i|
+          valid && value_valid?(row[i])
+        end
+      end
+
+      indices.reduce(false) do |valid, i|
+        valid || value_valid?(row[i])
+      end
+    end
+
+    # Indicates whether a value is valid
+    # @note Prefer using the #valid? method
+    # @param value [#zero?, #nil?, #to_s] the value to check
+    # @return [Boolean] whether the value is valid
+    def self.value_valid?(value)
+      if value.respond_to? :zero?
+        !value.zero?
+      else
+        !value.nil? && !value.to_s.empty?
+      end
+    end
+
+    # Validates the Date value
+    # @note Prefer using the #valid? method
+    # @param row [Array<String, Numeric, Date] The row to validate
+    # @return [Boolean] Whether the row's Date is invalid
+    def self.transaction_date_valid?(row)
+      date_index = 0
+      date = row[date_index]
+
+      value_valid?(date)
+    end
+
+    # Validates the Payee value
+    # @note Prefer using the #valid? method
+    # @param row [Array<String, Numeric, Date] The row to validate
+    # @return [Boolean] Whether the row's Payee is valid
+    def self.payee_valid?(row)
+      payee_index = 1
+      payee = row[payee_index]
+
+      value_valid?(payee)
+    end
+  end
+end

data/lib/ynab_convert/validators.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Regroups all the row validators
+module Validators
+  # Load all known Validators
+  Dir[File.join(__dir__, 'validators', '*.rb')].sort.each do |file|
+    require file
+  end
+end

data/lib/ynab_convert/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YnabConvert
-  VERSION = '1.0.7'
+  VERSION = '2.0.1'
 end

data/lib/ynab_convert.rb

@@ -3,7 +3,11 @@
 require 'ynab_convert/version'
 require 'slop'
 require 'ynab_convert/logger'
-require 'core_extensions/string.rb'
+require 'core_extensions/string'
+require 'byebug' if ENV['YNAB_CONVERT_DEBUG']
+
+# FIXME: The architecture in here is not the greatest... It should be
+#   redesigned entirely.
 
 # The application
 module YnabConvert
@@ -32,7 +36,7 @@ module YnabConvert
 
       begin
         @processor = opts[:processor].new(
-          file: @file
+          filepath: @file
         )
       rescue Errno::ENOENT
         handle_file_not_found
@@ -98,7 +102,22 @@ module YnabConvert
     end
 
     def processor_class_name
-      "Processor::#{@options[:institution].camel_case}"
+      # Processor class names don't always match camelcasing the `-i` argument
+      # from the command line. For those classes that don't, a lookup is
+      # performed to find the proper class name.
+      institution = @options[:institution].to_sym
+      institution_to_classname = {
+        ubs_chequing: 'UBSChequing',
+        ubs_credit: 'UBSCredit'
+      }
+
+      classname = institution_to_classname.fetch(institution) do |el|
+        # If the class name is "regular", it will be found by camelcasing the
+        # name passed as the `-i` argument from the command line.
+        el.to_s.camel_case
+      end
+
+      "Processors::#{classname}"
     end
 
     def processor

data/ynab_convert.gemspec

@@ -59,9 +59,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-core'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'solargraph'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 
   spec.add_dependency 'i18n'
   spec.add_dependency 'slop'
+  spec.add_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab_convert
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 2.0.1
 platform: ruby
 authors:
 - coaxial
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-06 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Utility to convert CSV statements into the YNAB4 format for easier
   transation import. Supports several banks and can easily be extended to
@@ -224,15 +280,42 @@ files:
 - lib/core_extensions/string.rb
 - lib/slop/symbol.rb
 - lib/ynab_convert.rb
+- lib/ynab_convert/api_clients/api_client.rb
+- lib/ynab_convert/api_clients/currency_api.rb
+- lib/ynab_convert/documents.rb
+- lib/ynab_convert/documents/statements/example_statement.rb
+- lib/ynab_convert/documents/statements/n26_statement.rb
+- lib/ynab_convert/documents/statements/statement.rb
+- lib/ynab_convert/documents/statements/ubs_chequing_statement.rb
+- lib/ynab_convert/documents/statements/ubs_credit_statement.rb
+- lib/ynab_convert/documents/statements/wise_statement.rb
+- lib/ynab_convert/documents/ynab4_files/ynab4_file.rb
 - lib/ynab_convert/error.rb
 - lib/ynab_convert/logger.rb
-- lib/ynab_convert/processor/base.rb
-- lib/ynab_convert/processor/example.rb
-- lib/ynab_convert/processor/n26.rb
-- lib/ynab_convert/processor/revolut.rb
-- lib/ynab_convert/processor/ubs_chequing.rb
-- lib/ynab_convert/processor/ubs_credit.rb
 - lib/ynab_convert/processors.rb
+- lib/ynab_convert/processors/example_processor.rb
+- lib/ynab_convert/processors/n26_processor.rb
+- lib/ynab_convert/processors/processor.rb
+- lib/ynab_convert/processors/ubs_chequing_processor.rb
+- lib/ynab_convert/processors/ubs_credit_processor.rb
+- lib/ynab_convert/processors/wise_processor.rb
+- lib/ynab_convert/transformers.rb
+- lib/ynab_convert/transformers/cleaners/cleaner.rb
+- lib/ynab_convert/transformers/cleaners/n26_cleaner.rb
+- lib/ynab_convert/transformers/cleaners/ubs_chequing_cleaner.rb
+- lib/ynab_convert/transformers/cleaners/ubs_credit_cleaner.rb
+- lib/ynab_convert/transformers/cleaners/wise_cleaner.rb
+- lib/ynab_convert/transformers/enhancers/enhancer.rb
+- lib/ynab_convert/transformers/enhancers/n26_enhancer.rb
+- lib/ynab_convert/transformers/enhancers/wise_enhancer.rb
+- lib/ynab_convert/transformers/formatters/example_formatter.rb
+- lib/ynab_convert/transformers/formatters/formatter.rb
+- lib/ynab_convert/transformers/formatters/n26_formatter.rb
+- lib/ynab_convert/transformers/formatters/ubs_chequing_formatter.rb
+- lib/ynab_convert/transformers/formatters/ubs_credit_formatter.rb
+- lib/ynab_convert/transformers/formatters/wise_formatter.rb
+- lib/ynab_convert/validators.rb
+- lib/ynab_convert/validators/ynab4_row_validator.rb
 - lib/ynab_convert/version.rb
 - ynab_convert.gemspec
 homepage: https://github.com/coaxial/ynab_convert

data/lib/ynab_convert/processor/base.rb

@@ -1,226 +0,0 @@
-# frozen_string_literal: true
-
-require 'core_extensions/string'
-require 'csv'
-require 'ynab_convert/logger'
-
-module Processor
-  # Base class for a Processor, all processors must inherit from it.
-
-  # rubocop:disable Metrics/ClassLength
-  class Base
-    include YnabLogger
-    include CoreExtensions::String::Inflections
-
-    attr_reader :loader_options
-
-    # @option options [String] :file Path to the CSV file to process
-    # @option options [Symbol] :format YNAB4 format to use, one of :flows or
-    #   :amounts. :flows is useful for CSVs with separate debit and credit
-    #   columns, :amounts is for CSVs with only one amount columns and +/-
-    #   numbers. See
-    #   https://docs.youneedabudget.com/article/921-formatting-csv-file
-    def initialize(options)
-      default_options = { file: '', format: :flows }
-      opts = default_options.merge(options)
-
-      logger.debug "Initializing processor with options: `#{opts.to_h}'"
-      raise ::Errno::ENOENT unless File.exist? opts[:file]
-
-      @file = opts[:file]
-      @headers = { transaction_date: nil, payee: nil }
-      @format = opts[:format]
-
-      if @format == :amounts
-        amounts_columns = { amount: nil }
-        @headers.merge!(amounts_columns)
-      else
-        flows_columns = { inflow: nil, outflow: nil }
-        @headers.merge!(flows_columns)
-      end
-    end
-
-    def to_ynab!
-      begin
-        convert!
-        rename_file
-      rescue YnabConvert::Error
-        invalid_csv_file
-      end
-    ensure
-      logger.debug "Deleting temp file `#{temp_filename}'"
-      delete_temp_csv
-    end
-
-    protected
-
-    attr_accessor :statement_from, :statement_to, :headers
-
-    def amount_invalid?(row)
-      amount_index = 3
-
-      # If there is no amount,
-      # then the row is invalid.
-      row[amount_index].nil? || row[amount_index].empty?
-    end
-
-    def inflow_outflow_invalid?(row)
-      inflow_index = 3
-      outflow_index = 4
-
-      # If there is neither inflow and outflow values,
-      # or both the inflow and outflow amounts are 0,
-      # then the row is invalid.
-      (
-        row[inflow_index].nil? ||
-        row[inflow_index].empty? ||
-        row[inflow_index] == '0.00'
-      ) && (
-        row[outflow_index].nil? ||
-        row[outflow_index].empty? ||
-        row[outflow_index] == '0.00'
-      )
-    end
-
-    def amounts_missing?(row)
-      logger.debug "Checking for missing amount in `#{row}`"
-      if @format == :amounts
-        logger.debug 'Using `:amounts`'
-        amount_invalid?(row)
-      else
-        logger.debug 'Using `:flows`'
-        inflow_outflow_invalid?(row)
-      end
-    end
-
-    def skip_row(row)
-      logger.debug "Found empty row, skipping it: #{row.to_h}"
-      throw :skip_row
-    end
-
-    def delete_temp_csv
-      FileUtils.remove_file temp_filename, force: true
-    end
-
-    def transaction_date_missing?(ynab_row)
-      ynab_row[0].nil? || [0].empty?
-    end
-
-    def extract_transaction_date(ynab_row)
-      transaction_date_index = 0
-      ynab_row[transaction_date_index]
-    end
-
-    def record_statement_interval_dates(ynab_row)
-      transaction_date_index = 0
-      date = Date.parse(ynab_row[transaction_date_index])
-
-      if date_is_further_away?(date)
-        logger.debug "Replacing statement_from `#{statement_from.inspect}' "\
-          "with `#{date}'"
-        self.statement_from = date
-      end
-      # rubocop:disable Style/GuardClause
-      if date_is_more_recent?(date)
-        logger.debug "Replacing statement_to `#{statement_to.inspect}' with "\
-          "`#{date}'"
-        self.statement_to = date
-      end
-      # rubocop:enable Style/GuardClause
-    end
-
-    def date_is_more_recent?(date)
-      statement_to.nil? || statement_to < date
-    end
-
-    def date_is_further_away?(date)
-      statement_from.nil? || statement_from > date
-    end
-
-    def convert!
-      logger.debug "Will write to `#{temp_filename}'"
-
-      logger.debug(loader_options)
-      CSV.open(temp_filename, 'wb', **output_options) do |converted|
-        CSV.foreach(@file, 'rb', **loader_options) do |row|
-          logger.debug "Parsing row: `#{row.to_h}'"
-          # Some rows don't contain valid or useful data
-          catch :skip_row do
-            extract_header_names(row)
-            ynab_row = transformers(row)
-            if amounts_missing?(ynab_row) ||
-               transaction_date_missing?(ynab_row)
-              logger.debug 'Empty row, skipping it'
-              skip_row(row)
-            end
-            converted << ynab_row
-            record_statement_interval_dates(ynab_row)
-          end
-
-          logger.debug 'Done converting'
-        end
-      end
-    end
-
-    def rename_file
-      File.rename(temp_filename, output_filename)
-      logger.debug "Renamed temp file `#{temp_filename}' to "\
-        "`#{output_filename}'"
-    end
-
-    def invalid_csv_file
-      raise YnabConvert::Error, "Unable to parse file `#{@file}'. Is it a "\
-        "valid CSV file from #{@institution_name}?"
-    end
-
-    def file_uid
-      @file_uid ||= rand(36**8).to_s(36)
-    end
-
-    def temp_filename
-      "#{File.basename(@file, '.csv')}_#{@institution_name.snake_case}_"\
-        "#{file_uid}_ynab4.csv"
-    end
-
-    def output_filename
-      # If the file contained no parsable CSV data, from and to dates will be
-      # nil.
-      # This is to avoid a NoMethodError on NilClass.
-      raise YnabConvert::Error if statement_from.nil? || statement_to.nil?
-
-      from = statement_from.strftime('%Y%m%d')
-      to = statement_to.strftime('%Y%m%d')
-
-      "#{File.basename(@file, '.csv')}_#{@institution_name.snake_case}_"\
-        "#{from}-#{to}_ynab4.csv"
-    end
-
-    def ynab_headers
-      common_headers = %w[Date Payee Memo]
-
-      if @format == :amounts
-        amounts_headers = %w[Amount]
-        common_headers.concat(amounts_headers)
-      else
-        flows_headers = %w[Outflow Inflow]
-        common_headers.concat(flows_headers)
-      end
-
-      common_headers
-    end
-
-    def output_options
-      {
-        converters: %i[numeric date],
-        force_quotes: true,
-        write_headers: true,
-        headers: ynab_headers
-      }
-    end
-
-    def transformers
-      raise NotImplementedError, :transformers
-    end
-  end
-  # rubocop:enable Metrics/ClassLength
-end