teri 0.5.1

data/lib/teri/openai_client.rb

@@ -0,0 +1,229 @@
+require 'openai'
+require 'logger'
+require 'fileutils'
+
+module Teri
+  class OpenAIClient
+    attr_reader :client, :logger, :model
+
+    def initialize(options = {})
+      @api_key = options[:api_key] || ENV.fetch('OPENAI_API_KEY', nil)
+      unless @api_key
+        raise 'OpenAI API key not found. Please set OPENAI_API_KEY environment variable or provide it as an argument.'
+      end
+
+      @model = options[:model] || 'gpt-3.5-turbo'
+      @client = OpenAI::Client.new(access_token: @api_key)
+
+      # Set up logging
+      setup_logger(options[:log_file])
+    end
+
+    # Get a suggested category for a transaction based on its details and previous codings
+    # @param transaction [Teri::Transaction] The transaction to get a suggestion for
+    # @param accounting [Teri::Accounting] The accounting instance with previous codings
+    # @return [Hash] A hash containing the suggested category and confidence score
+    def suggest_category(transaction, accounting)
+      previous_codings = accounting.respond_to?(:previous_codings) ? accounting.previous_codings : {}
+      counterparty_hints = accounting.respond_to?(:counterparty_hints) ? accounting.counterparty_hints : {}
+      available_categories = []
+
+      # Prepare the prompt with transaction details
+      prompt = build_prompt(transaction, accounting)
+
+      # Log the previous_codings for debugging
+      if @logger
+        @logger.info("PREVIOUS_CODINGS: #{previous_codings.inspect}")
+        @logger.info("COUNTERPARTY_HINTS: #{counterparty_hints.inspect}")
+      end
+
+      # Log the prompt
+      @logger&.info("PROMPT: #{prompt}")
+
+      # Call the OpenAI API
+      response = @client.chat(
+        parameters: {
+          model: @model,
+          messages: [
+            { role: 'user', content: prompt },
+          ],
+        }
+      )
+
+      # Log the response
+      @logger&.info("RESPONSE: #{response.dig('choices', 0, 'message', 'content')}")
+
+      # Parse the response
+      parse_suggestion(response, available_categories)
+    end
+
+    # Build a prompt for the OpenAI API
+    # @param transaction [Teri::Transaction] The transaction to get a suggestion for
+    # @param accounting [Teri::Accounting] The accounting instance with previous codings
+    # @return [String] The prompt for the OpenAI API
+    def build_prompt(transaction, accounting)
+      prompt = "Transaction details:\n"
+      prompt += "Date: #{transaction.date}\n"
+      prompt += "Description: #{transaction.description}\n"
+
+      prompt += "Memo: #{transaction.memo}\n" if transaction.respond_to?(:memo) && transaction.memo
+
+      prompt += "Amount: #{transaction.amount}\n" if transaction.respond_to?(:amount)
+
+      if transaction.respond_to?(:counterparty) && transaction.counterparty
+        prompt += "Counterparty: #{transaction.counterparty}\n"
+      end
+
+      if transaction.respond_to?(:hints) && transaction.hints && !transaction.hints.empty?
+        prompt += "\nHints from previous categorizations:\n"
+        transaction.hints.each do |hint|
+          prompt += "- #{hint}\n"
+        end
+      end
+
+      # Add previous codings section if available
+      if accounting.respond_to?(:previous_codings) && accounting.previous_codings && !accounting.previous_codings.empty?
+        prompt += "\nPrevious codings:\n"
+        accounting.previous_codings.each do |desc, info|
+          next unless info.is_a?(Hash)
+
+          prompt += if info[:hints] && !info[:hints].empty?
+                      "- \"#{desc}\" => #{info[:category]} (hints: #{info[:hints].join(', ')})\n"
+                    else
+                      "- \"#{desc}\" => #{info[:category]}\n"
+                    end
+        end
+      end
+
+      # Add counterparty hints if available
+      if accounting.respond_to?(:counterparty_hints) &&
+         transaction.respond_to?(:counterparty) &&
+         transaction.counterparty &&
+         accounting.counterparty_hints[transaction.counterparty]
+        prompt += "\nCounterparty information:\n"
+        accounting.counterparty_hints[transaction.counterparty].each do |hint|
+          prompt += "- #{hint}\n"
+        end
+      end
+
+      prompt += "\nPlease respond with a JSON object containing:\n"
+      prompt += "- category: The suggested category (e.g., 'Expenses:Office')\n"
+      prompt += "- confidence: A number between 0-100 indicating your confidence\n"
+      prompt += "- explanation: A brief explanation of your suggestion\n"
+
+      prompt
+    end
+
+    private
+
+    # Set up the logger
+    # @param log_file [String] The path to the log file
+    def setup_logger(log_file = nil)
+      # Skip logger setup if we're in a test environment
+      if defined?(RSpec)
+        @logger = nil
+        return
+      end
+
+      begin
+        # Create logs directory if it doesn't exist
+        FileUtils.mkdir_p('logs')
+
+        # Use the provided log file or create a default one with timestamp
+        log_file ||= "logs/openai_#{Time.now.strftime('%Y%m%d_%H%M%S')}.log"
+
+        @logger = Logger.new(log_file)
+        @logger.level = Logger::INFO
+        @logger.formatter = proc do |severity, datetime, _progname, msg|
+          "#{datetime.strftime('%Y-%m-%d %H:%M:%S')} [#{severity}] #{msg}\n"
+        end
+
+        @logger.info('OpenAI client initialized')
+      rescue StandardError => e
+        puts "Warning: Failed to set up OpenAI logging: #{e.message}"
+        @logger = nil
+      end
+    end
+
+    # Parse the suggestion from the OpenAI API response
+    # @param response [Hash] The response from the OpenAI API
+    # @param available_categories [Array<String>] A list of available categories
+    # @return [Hash] A hash containing the suggested category and confidence score
+    def parse_suggestion(response, available_categories = [])
+      content = response.dig('choices', 0, 'message', 'content')
+      return { category: 'Expenses:Unknown', confidence: 0, explanation: 'Failed to parse AI response' } unless content
+
+      begin
+        # Parse the JSON response
+        suggestion = JSON.parse(content, symbolize_names: true)
+
+        # Set default values if missing
+        suggestion[:category] ||= 'Expenses:Unknown'
+        suggestion[:confidence] ||= 0
+        suggestion[:explanation] ||= 'No explanation provided'
+
+        # Convert confidence to a float between 0 and 1 if it's a percentage
+        if suggestion[:confidence].is_a?(Numeric) && suggestion[:confidence] > 1
+          suggestion[:confidence] = suggestion[:confidence].to_f / 100.0
+        end
+
+        # Find the closest match if the category is not in the available categories
+        if !available_categories.empty? && !available_categories.include?(suggestion[:category])
+          original_category = suggestion[:category]
+          suggestion[:category] = find_closest_match(original_category, available_categories)
+          suggestion[:explanation] += " (Adjusted from '#{original_category}' to closest match '#{suggestion[:category]}')"
+        end
+
+        suggestion
+      rescue JSON::ParserError
+        { category: 'Expenses:Unknown', confidence: 0, explanation: 'Failed to parse AI response' }
+      end
+    end
+
+    # Find the closest match for a category in the available categories
+    # @param category [String] The category to find a match for
+    # @param available_categories [Array<String>] A list of available categories
+    # @return [String] The closest matching category
+    def find_closest_match(category, available_categories)
+      return category if available_categories.empty?
+
+      # Find the category with the smallest Levenshtein distance
+      closest_match = available_categories.min_by do |available_category|
+        levenshtein_distance(category, available_category)
+      end
+
+      closest_match || category
+    end
+
+    # Calculate the Levenshtein distance between two strings
+    # @param str1 [String] The first string
+    # @param str2 [String] The second string
+    # @return [Integer] The Levenshtein distance
+    def levenshtein_distance(str1, str2)
+      m = str1.length
+      n = str2.length
+
+      # Create a matrix of size (m+1) x (n+1)
+      d = Array.new(m + 1) { Array.new(n + 1, 0) }
+
+      # Initialize the first row and column
+      (0..m).each { |i| d[i][0] = i }
+      (0..n).each { |j| d[0][j] = j }
+
+      # Fill in the rest of the matrix
+      (1..m).each do |i|
+        (1..n).each do |j|
+          cost = str1[i - 1] == str2[j - 1] ? 0 : 1
+          d[i][j] = [
+            d[i - 1][j] + 1,      # deletion
+            d[i][j - 1] + 1,      # insertion
+            d[i - 1][j - 1] + cost, # substitution
+          ].min
+        end
+      end
+
+      # Return the distance
+      d[m][n]
+    end
+  end
+end

data/lib/teri/report_generator.rb

@@ -0,0 +1,258 @@
+require 'English'
+require 'date'
+
+module Teri
+  # Handles report generation for balance sheets and income statements
+  class ReportGenerator
+    def initialize(options, logger)
+      @options = options
+      @logger = logger
+    end
+
+    def generate_balance_sheet(options = {})
+      # Merge provided options with default options
+      opts = @options.merge(options)
+
+      # Get the specified year from options, defaulting to current year
+      specified_year = opts[:year] || Date.today.year
+
+      # Get the number of periods from options, defaulting to 2 if not specified
+      periods = opts[:periods] || 2
+
+      puts "Balance Sheet for #{specified_year}"
+      if opts[:month]
+        puts "Month: #{opts[:month]}"
+      else
+        puts "Including previous #{periods} years"
+      end
+      puts '=' * 50
+      puts ''
+
+      # Check if coding.ledger exists
+      unless File.exist?('coding.ledger')
+        puts "Warning: coding.ledger file does not exist. Please run 'teri code' first to process and code your transactions."
+        puts 'Without coding, the balance sheet cannot be generated correctly.'
+        return
+      end
+
+      # Common ledger options for consistent formatting
+      ledger_options = '--exchange USD --no-total --collapse'
+
+      # If a specific month is provided, show just that month
+      if opts[:month]
+        month = opts[:month].to_i
+        end_date = Date.new(specified_year, month, -1) # Last day of the month
+
+        puts "Balance Sheet as of #{end_date.strftime('%Y-%m-%d')}"
+        puts '-' * 50
+
+        cmd = 'ledger -f coding.ledger'
+        Dir.glob('transactions/*.ledger').each do |file|
+          cmd += " -f #{file}"
+        end
+        cmd += " balance #{ledger_options} --end #{end_date.strftime('%Y/%m/%d')} ^Assets ^Liabilities ^Equity"
+
+        output = `#{cmd}`
+        if $?.success?
+          puts output
+
+          # Check if the balance sheet is balanced
+          if balance_sheet_unbalanced?(output)
+            puts "Note: The balance sheet is not balanced. You may want to run 'teri fix-balance' to create adjustment entries."
+          end
+        else
+          puts "Error generating balance sheet (exit code: #{$?.exitstatus})"
+          puts "Command was: #{cmd}"
+        end
+
+        return
+      end
+
+      # Generate balance sheet for the specified year and previous periods
+      start_year = specified_year - periods
+      end_year = specified_year - 1
+
+      # Show previous years
+      (start_year..end_year).each do |year|
+        puts "Balance Sheet as of #{year}-12-31"
+        puts '-' * 50
+
+        # Use the --file option to specify files instead of a glob pattern
+        cmd = 'ledger -f coding.ledger'
+        Dir.glob('transactions/*.ledger').each do |file|
+          cmd += " -f #{file}"
+        end
+        cmd += " balance #{ledger_options} --end #{year}/12/31 ^Assets ^Liabilities ^Equity"
+
+        output = `#{cmd}`
+        if $?.success?
+          puts output
+
+          # Check if the balance sheet is balanced
+          if balance_sheet_unbalanced?(output)
+            puts "Note: The balance sheet is not balanced. You may want to run 'teri fix-balance' to create adjustment entries."
+          end
+        else
+          puts "Error generating balance sheet (exit code: #{$?.exitstatus})"
+          puts "Command was: #{cmd}"
+        end
+      end
+
+      # Show current balance sheet for specified year
+      current_date = Date.today
+      if specified_year == current_date.year
+        # If specified year is current year, show as of today
+        puts "Balance Sheet as of #{current_date.strftime('%Y-%m-%d')}"
+        end_date = current_date
+      else
+        # If specified year is not current year, show as of year end
+        puts "Balance Sheet as of #{specified_year}-12-31"
+        end_date = Date.new(specified_year, 12, 31)
+      end
+      puts '-' * 50
+
+      cmd = 'ledger -f coding.ledger'
+      Dir.glob('transactions/*.ledger').each do |file|
+        cmd += " -f #{file}"
+      end
+      cmd += " balance #{ledger_options} --end #{end_date.strftime('%Y/%m/%d')} ^Assets ^Liabilities ^Equity"
+
+      output = `#{cmd}`
+      if $?.success?
+        puts output
+
+        # Check if the balance sheet is balanced
+        if balance_sheet_unbalanced?(output)
+          puts "Note: The balance sheet is not balanced. You may want to run 'teri fix-balance' to create adjustment entries."
+        end
+      else
+        puts "Error generating balance sheet (exit code: #{$?.exitstatus})"
+        puts "Command was: #{cmd}"
+      end
+    end
+
+    # Helper method to check if a balance sheet is unbalanced
+    def balance_sheet_unbalanced?(output)
+      # With --no-total option, we need to calculate the total ourselves
+      assets = 0.0
+      liabilities = 0.0
+      equity = 0.0
+
+      # Extract amounts for each section
+      output.each_line do |line|
+        case line
+        when /^\s*([\-\$\d,\.]+)\s+USD\s+Assets/
+          assets_str = ::Regexp.last_match(1).gsub(/[\$,]/, '')
+          assets = assets_str.to_f
+        when /^\s*([\-\$\d,\.]+)\s+USD\s+Liabilities/
+          liabilities_str = ::Regexp.last_match(1).gsub(/[\$,]/, '')
+          liabilities = liabilities_str.to_f
+        when /^\s*([\-\$\d,\.]+)\s+USD\s+Equity/
+          equity_str = ::Regexp.last_match(1).gsub(/[\$,]/, '')
+          equity = equity_str.to_f
+        end
+      end
+
+      # Calculate the balance (Assets = Liabilities + Equity)
+      balance = assets - (liabilities + equity)
+
+      # Consider it balanced if the difference is less than 1 cent
+      balance.abs > 0.01
+    end
+
+    def generate_income_statement(options = {})
+      # Merge provided options with default options
+      opts = @options.merge(options)
+
+      # Get the specified year from options, defaulting to current year
+      specified_year = opts[:year] || Date.today.year
+
+      # Get the number of periods from options, defaulting to 2 if not specified
+      periods = opts[:periods] || 2
+
+      puts "Income Statement for #{specified_year}"
+      if opts[:month]
+        puts "Month: #{opts[:month]}"
+      else
+        puts "Including previous #{periods} years"
+      end
+      puts '=' * 50
+      puts ''
+
+      # Check if coding.ledger exists
+      unless File.exist?('coding.ledger')
+        puts "Warning: coding.ledger file does not exist. Please run 'teri code' first to process and code your transactions."
+        puts 'Without coding, the income statement cannot be generated correctly.'
+        return
+      end
+
+      # Common ledger options for consistent formatting
+      ledger_options = '--exchange USD --no-total --collapse'
+
+      # If a specific month is provided, show just that month
+      if opts[:month]
+        month = opts[:month].to_i
+        start_date = Date.new(specified_year, month, 1)
+        end_date = Date.new(specified_year, month, -1) # Last day of the month
+
+        puts "Income Statement for #{start_date.strftime('%B %Y')}"
+        puts '-' * 50
+
+        cmd = 'ledger -f coding.ledger'
+        Dir.glob('transactions/*.ledger').each do |file|
+          cmd += " -f #{file}"
+        end
+        cmd += " balance #{ledger_options} --begin #{start_date.strftime('%Y/%m/%d')} --end #{end_date.strftime('%Y/%m/%d')} ^Income ^Expenses"
+
+      else
+        # Generate income statement for the specified year and previous periods
+        start_year = specified_year - periods
+        end_year = specified_year - 1
+
+        # Show previous years
+        (start_year..end_year).each do |year|
+          puts "Income Statement for #{year}"
+          puts '-' * 50
+
+          cmd = 'ledger -f coding.ledger'
+          Dir.glob('transactions/*.ledger').each do |file|
+            cmd += " -f #{file}"
+          end
+          cmd += " balance #{ledger_options} --begin #{year}/01/01 --end #{year}/12/31 ^Income ^Expenses"
+
+          output = `#{cmd}`
+          if $?.success?
+            puts output
+          else
+            puts "Error generating income statement (exit code: #{$?.exitstatus})"
+            puts "Command was: #{cmd}"
+          end
+        end
+
+        # Show current year income statement
+        current_date = Date.today
+        if specified_year == current_date.year
+          # If specified year is current year, show as of today
+          puts "Income Statement as of #{current_date.strftime('%Y-%m-%d')}"
+        else
+          # If specified year is not current year, show as of year end
+          puts "Income Statement as of #{specified_year}-12-31"
+        end
+
+        cmd = 'ledger -f coding.ledger'
+        Dir.glob('transactions/*.ledger').each do |file|
+          cmd += " -f #{file}"
+        end
+        cmd += " balance #{ledger_options} --begin #{specified_year}/01/01 --end #{specified_year}/12/31 ^Income ^Expenses"
+      end
+      
+      output = `#{cmd}`
+      if $?.success?
+        puts output
+      else
+        puts "Error generating income statement (exit code: #{$?.exitstatus})"
+        puts "Command was: #{cmd}"
+      end
+    end
+  end
+end