magelex 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 032119d67096a3213c374635a710796c3732ea30
-  data.tar.gz: 9451eb9eba3fddd6bf7d6a12d0af3e554dc53222
+  metadata.gz: de06fc18a480aa62a7229eb17dd1039513345fd3
+  data.tar.gz: 2c47cad6e86d40495ddd67c32a6533ab5e2d4e77
 SHA512:
-  metadata.gz: a4e4e62c48ffa8fca02d241e5a953b191cf8fd3e6a7ad29769140aef3a0eae03b681822fa23a251b1aa33aac76afc108a798f97865d44eed6a606fce294e1a0d
-  data.tar.gz: cf520013296e47b60ac59790e43b677337673b7bb65bd18c292a3af5b9e95fddf60a0411492af011d0cc4cbaf8587e09a4c53961955cba9e46cc431ad694bbd3
+  metadata.gz: 07b259c2f497d0345b89ec13819b6717e2c64293bc212d7fe1a805214270aacf77f80fec7d0478462c2002cfd2a55b81741d6f171a971933aa1e924846873026
+  data.tar.gz: 7efba0085ec0ecfe48693fd2b0e71af54f7f4351769d943338d9bd8e39a2a339af03c9ab7e199b12f5ddd748318300778f5b8ccca1e43a543c78e71be301baea

data/README.md

@@ -2,7 +2,7 @@
 
 *This README reflects (more or less) the current development state, for documentation of a given version, see the README shipped with that gem (or respective tag on github).*
 
-Magelex takes Magento data and presents it in a format that Lexware can read.
+Magelex takes Magento online shop order data and presents it in a format that Lexware can read to model open positions.
 
 Aim is to manage the cash flow in Lexware.
 
@@ -16,7 +16,7 @@ Install it yourself as:
 
 ## Assumptions
 
-Customer accounts are hard coded.  Database access necessary for date corrections.
+Customer accounts are hard coded.  Database access is necessary for date corrections (but can be skipped).
 
 ## Usage
 
@@ -34,9 +34,9 @@ Call `magelex --help` to get a basic idea:
             --version                    Show version and exit.
     
 
-By default, `magelex` will log to `STDERR`, put you can pass the path to a log file.
+By default, `magelex` will log to `STDERR`, but you can pass the path to a log file.
 
-It consumes a single file (given as argument, as in `magelex magento_orders.csv`).  `magelex` will create a file with same filename in the path `lexware` (can be changed with the `--out-dir` switch).
+It consumes a single file (given as argument, as in `magelex magento_orders.csv`) or a directory of files.  `magelex` will create a file with same filename in the path `lexware` (can be changed with the `--out-dir` option).
 
 ### Configuration
 
@@ -48,9 +48,14 @@ If no database queries should be done, invoke with `--skip-db`.
 
 Call `magelex --help` to get a basic idea.
 
-## TODOs
+## Documentation of process
 
-  - Respect Discounts (item and totals).
+`bin/magelex` will read in a CSV file with orders exported by magento (`Magelex::MagentoCSV`).  In this file, one row accounts for one 'order item'.  Items are added up to form a `Magelex::LexwareBill`.  Adding Items to a `LexWareBill` collects the brutto values separated by tax.  For this, the tax category (0%, 7% or 19%) has to be guessed (`Magelex::TaxGuesser`).
+
+Result of this processing are a number of `LexwareBill`s.
+Swiss orders require some special attention, so steps are undertaken to adjust these to reality.  Afterwards, the shipping costs can be included.
+
+Finally the `LexwareBill`s that conform to the rules (`LexwareBill#check`) can be exported to be imported to Lexware (`Magelex::LexwareCSV`).
 
 ## Development
 

data/bin/magelex

@@ -37,7 +37,7 @@ optparse = OptionParser.new do |opts|
 end.parse!
 
 if ARGV.length != 1
-  STDERR.puts "Need an argument (directory or file)"
+  STDERR.puts "Need a single argument (directory or file)"
   exit 1
 end
 
@@ -50,7 +50,7 @@ Magelex.logger.formatter = proc { |severity, datetime, progname, msg|
 }
 
 def main options
-  Magelex.logger.info("Started")
+  Magelex.logger.info("Started (version #{Magelex::VERSION})")
 
   Dir.mkdir options[:out_dir] rescue {}
   outdir = Pathname.new(options[:out_dir]).realpath

data/bin/magelex_debug

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+require "magelex"
+
+require 'yaml'
+require 'optparse'
+require 'terminal-table'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} DIR_OR_FILE"
+  opts.separator ""
+  opts.separator "Debug magelex im- and export"
+  opts.separator ""
+
+  opts.on('-v', '--verbose', 'Run verbosely') do |o|
+    options[:verbose] = o
+  end
+  opts.on('-s', '--skip-db', 'Do not update dates from mysql database.') do |o|
+    options[:skipdb] = o
+  end
+  opts.on_tail('--version', 'Show version and exit.') do
+    puts "Magelex #{Magelex::VERSION}"
+    exit 0
+  end
+  opts.on('-h', '--help', 'Show this help and exit.') do
+    puts opts
+    exit 0
+  end
+end.parse!
+
+if ARGV.length != 1
+  STDERR.puts "Need an argument (directory or file)"
+  exit 1
+end
+
+Magelex.logger = Logger.new(options[:log_file] ? options[:log_file] : STDERR)
+
+Magelex.logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO
+Magelex.logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+Magelex.logger.formatter = proc { |severity, datetime, progname, msg|
+  "#{severity} - #{datetime} - #{msg}\n"
+}
+
+def main options
+  Magelex.logger.info("Started")
+
+  # Import/Read file.
+  bills = Magelex::MagentoCSV.read ARGV[0]
+  bills.each(&:swissify)
+  bills.each(&:process_shipping_costs)
+  bill_rows = bills.map do |bill|
+    [
+      bill.order_nr,
+      bill.swiss? ? 'Y' : 'N',
+      bill.total,
+      "%.3f" %bill.total_0, "%.3f" % bill.total_7, "%.3f" % bill.total_19,
+      "%.3f" % bill.tax_7, "%.3f" % bill.tax_19,
+      "%.3f" % bill.shipping_cost, "%.3f" % bill.check_diff, bill.check ? "Y" : "N"
+    ]
+  end
+
+  t = Terminal::Table.new(headings: ["nr", "S?","total_b",
+                                     "total0", "total7", "total19",
+                                     "tax7", "tax19",
+                                     "ship", "diff", "C"],
+                          rows: bill_rows)
+
+  puts t
+  puts Magelex::LexwareCSV::render bills
+  Magelex.logger.info("Finished")
+end
+
+main options

data/lib/magelex/bill_modifier.rb

@@ -0,0 +1,38 @@
+module Magelex
+  module BillModifier
+    def self.process bill
+      # 'Trick' around with bill
+      swissify bill
+      process_shipping_costs bill
+      adjust_order_number bill
+    end
+
+    def self.process_shipping_costs bill
+      if bill.swiss?
+        bill.total_0 += LexwareBill.floor2(bill.shipping_cost)
+      else
+        bill.tax_19 += bill.shipping_cost * 0.19
+        bill.total_19 += LexwareBill.floor2(bill.shipping_cost * 1.19)
+      end
+    end
+
+    def self.adjust_order_number bill
+      bill.order_nr.to_s.gsub!(/^e-/, '')
+    end
+
+    # total0 consumes total and resets others, if check passes
+    # shipping costs should be consumed before
+    # this has to be layed out in a graph or documented properly
+    # (what happens when)
+    def self.swissify bill
+      return if !bill.swiss?
+
+      bill.incorrect_tax += (bill.total_19 - bill.total_19 / 1.19)
+      bill.incorrect_tax += (bill.total_7  - bill.total_7 / 1.07)
+      bill.total_0 += (bill.total_19 / 1.19)
+      bill.total_19 = 0
+      bill.total_0 += (bill.total_7 / 1.07)
+      bill.total_7 = 0
+    end
+  end
+end

data/lib/magelex/lexware_account.rb

@@ -12,7 +12,8 @@ module Magelex
       10000 + ord * 100
     end
 
-    # get tax for :total_0, :total_7 or :total_19
+    # Get account number for
+    # :incorrect_tax, :total_0, :total_7 or :total_19
     def self.for(bill, tax_kind)
       if tax_kind == :total_0
         return for_0 bill
@@ -20,6 +21,8 @@ module Magelex
         return for_7 bill
       elsif tax_kind == :total_19
         return for_19 bill
+      elsif tax_kind == :incorrect_tax
+        return for_incorrect_tax bill
       else
         raise "unknown tax_kind (#{tax_kind})"
       end
@@ -36,5 +39,9 @@ module Magelex
     def self.for_0 bill
       '8120'
     end
+
+    def self.for_incorrect_tax bill
+      '1783'
+    end
   end
 end

data/lib/magelex/lexware_bill.rb

@@ -7,20 +7,23 @@ module Magelex
                   'NL','AT','PL','PT','RO','SI','SK','FI','SE','UK']
 
     attr_accessor :order_nr, :customer_name, :country_code,
-      :date, :status, :shipping_cost, :total, :total_0, :total_7, :total_19, :has_problems
+      :date, :status, :shipping_cost, :total, :total_0, :total_7, :total_19, :has_problems, :tax_7, :tax_19, :incorrect_tax
 
     def initialize values={}
       @total_0, @total_7, @total_19, @total = 0, 0, 0, 0
       @customer_name = values.delete(:customer_name) || ""
       @order_nr = values.delete(:order_nr) || nil
-      @date     = values.delete(:date) || nil
+      @date     = values.delete(:date)  || nil
       @total    = values.delete(:total) || 0
-      @total_0  = values.delete(:total_0) || 0
-      @total_7  = values.delete(:total_7) || 0
+      @total_0  = values.delete(:total_0)  || 0
+      @total_7  = values.delete(:total_7)  || 0
       @total_19 = values.delete(:total_19) || 0
+      @tax_7    = values.delete(:tax_7)  || 0
+      @tax_19   = values.delete(:tax_19) || 0
+      @incorrect_tax = values.delete(:incorrect_tax) || 0
       @status   = values.delete(:status) || nil
       @shipping_cost = values.delete(:shipping_cost) || nil
-      @country_code  = values.delete(:country_code) || nil
+      @country_code  = values.delete(:country_code)  || nil
       @has_problems  = false
       if !values.empty?
         raise "Unknown values for bill: #{values.inspect}"
@@ -31,17 +34,35 @@ module Magelex
       @country_code == 'CH'
     end
 
+    # Add item values to corresponding total_ and tax_ attributes
+    # depending on discount, include or exclude taxes.
     def add_item amount, tax, name, discount=0
       begin
         case TaxGuess.guess(amount, tax)
         when :tax0
-          @total_0 += amount.round(2)# - discount.round(0)
+          @total_0 += amount.round(2)
         when :tax7
-          @total_7 += amount.round(2)# - discount.round(0)
+          if discount != 0
+            @total_7 += (amount.round(2) * 1.07)
+          else
+            @total_7 += amount.round(2)
+          end
+          @tax_7 += tax
         when :tax19
-          @total_19 += amount.round(2)# - discount.round(0)
+          if discount != 0
+            @total_19 += (amount.round(2) * 1.18)
+          else
+            @total_19 += amount.round(2)
+          end
+          if swiss?
+            Magelex::logger.info("19% Tax Item in swiss order: #{@order_nr}: #{name}")
+          end
+          @tax_19 += tax
+        when :empty_item
+          Magelex::logger.debug("Empty item: '#{name}' #{amount}, tax: #{tax}")
         end
-      rescue
+      rescue RuntimeError
+        Magelex::logger.warn("Unguessable tax (#{@order_nr}: #{name} #{amount}/#{tax})")
         @has_problems = true
       end
     end
@@ -54,33 +75,21 @@ module Magelex
       @@EU_CODES.include? @country_code
     end
 
+    def check_diff
+      @total.round(2) - (@total_0.round(2) + @total_7.round(2) + @total_19.round(2) + @incorrect_tax.round(2)).round(2)
+    end
+
     def check
-      @has_problems == false && @total > 0 && @total.round(2) == (@total_0.round(2) + @total_7.round(2) + @total_19.round(2)).round(2)
+      @has_problems == false && @total > 0 && check_diff == 0
     end
 
     def self.floor2 value
       (value * 100).to_i / 100.0
     end
-
-    def consume_shipping_cost
-      if swiss?
-        @total_0 += LexwareBill.floor2(@shipping_cost)
-      else
-        @total_19 += LexwareBill.floor2(@shipping_cost * 1.19)
-      end
-      @shipping_cost = 0
     end
 
     def complete?
       @status == "complete"
     end
-
-    def swissify
-      return if !swiss?
-      @total_0 += @total_19
-      @total_19 = 0
-      @total_0 += @total_7
-      @total_7 = 0
-    end
   end
 end

data/lib/magelex/lexware_csv.rb

@@ -16,7 +16,7 @@ module Magelex
         Magelex::AccountNumber.for_customer(bill),
         0]
       # subs
-      [:total_0, :total_7, :total_19].each do |part|
+      [:total_0, :total_7, :total_19, :incorrect_tax].each do |part|
         if (amount = bill.send(part)) != 0
           rows << [
                   bill.date.strftime("%d.%m.%Y"),

data/lib/magelex/magento_csv.rb

@@ -3,7 +3,7 @@ require 'csv'
 module Magelex
   module MagentoCSV
     MONEY_FIELDS = ['Order Shipping', 'Order Grand Total',
-                    'Item Total', 'Item Tax']
+                    'Item Total', 'Item Tax', 'Item Discount']
 
     CSV::Converters[:german_money_amount] = lambda do |value, info|
       if MONEY_FIELDS.include? info[:header]
@@ -39,6 +39,13 @@ module Magelex
       bill.status        = row['Order Status']
 
       bill.shipping_cost = row['Order Shipping']
+      if bill.shipping_cost == 12.6
+        Magelex::logger.info "Correcting shipping cost of #{bill.order_nr} (12.6 -> 15 / 1.19 €)"
+        bill.shipping_cost = 15 / 1.19
+      elsif bill.shipping_cost == 4.15
+        Magelex::logger.info "Correcting shipping cost of #{bill.order_nr} (4.15 -> 4.95 / 1.19 €)"
+        bill.shipping_cost = 4.95 / 1.19
+      end
       bill.total         = row['Order Grand Total']
       bill
     end
@@ -57,7 +64,8 @@ module Magelex
 
         current_bill.add_item(row['Item Total'],
                               row['Item Tax'],
-                              row['Item Name'])
+                              row['Item Name'],
+                              row['Item Discount'])
 
         if !bills.include? (current_bill)
           bills << current_bill

data/lib/magelex/tax_guess.rb

@@ -1,16 +1,34 @@
 module Magelex
   module TaxGuess
+    # Guesses the tax category.
+    # Question is: how many percent of total is tax_amount.
     def self.guess(total, tax_amount)
-      if tax_amount == 0
-        :tax0
-      elsif (total - total/1.06) <= tax_amount && (total - total/1.08) >= tax_amount
-        :tax7
-      elsif (total - total/1.18) <= tax_amount && (total - total/1.20) >= tax_amount
-        :tax19
-      else
+      if total == 0 && tax_amount == 0
+        return :empty_item
+      end
+      if total == 0
         raise "TaxGuess: Cannot guess tax of "\
           "#{total}/#{tax_amount} (#{total - total/tax_amount})"
       end
+
+      # net: netto, gro: gross/brutto
+      # gro_price = net_price + taxes         ## (1: net_price = gro_price - taxes)
+      # gro_price = net_price + net_price * tax_perce
+      # tax_perce = (gro_price - net_price) / net_price
+      # tax_perce = gro_price / net_price - 1 ## (see 1)
+      percentage = total.to_f / (total - tax_amount) - 1
+
+      case percentage
+        when -0.01..0.01
+          :tax0
+        when 0.06..0.09
+          :tax7
+        when 0.16..0.20
+          :tax19
+        else
+          raise "TaxGuess: Cannot guess tax of "\
+            "#{total}/#{tax_amount} (#{total - total/tax_amount}) - #{tax_amount/total if total != 0}"
+      end
     end
   end
 end

data/lib/magelex/version.rb

@@ -1,3 +1,3 @@
 module Magelex
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

data/lib/magelex.rb

@@ -5,12 +5,13 @@ require 'magelex/lexware_csv'
 require 'magelex/tax_guess'
 require 'magelex/lexware_account'
 require 'magelex/magento_mysql'
+require 'magelex/bill_modifier'
 
 require 'logger'
 
 module Magelex
   def self.logger
-    @logger ||= Logger.new
+    @logger ||= Logger.new STDERR
   end
   def self.logger= logger
     @logger = logger
@@ -24,15 +25,17 @@ module Magelex
       if !bill.complete?
         Magelex.logger.info("Skip order #{bill.order_nr} (incomplete: #{bill.status})")
       else # complete!
-        bill.consume_shipping_cost
-        bill.swissify
+        Magelex::BillModifier.process bill
         if !bill.check
-          Magelex.logger.info("Skip order #{bill.order_nr}#{bill.swiss? ? ' (swiss)' : ''}")
+          Magelex.logger.info("Skip order #{bill.order_nr}#{bill.swiss? ? ' (swiss)' : ''} #{bill.has_problems ? ' (broken item)': '' }")
           Magelex.logger.info("  (totals do not match #{bill.total} != "\
                               "(0: #{bill.total_0} + 7: #{bill.total_7} "\
                               "+ 19: #{bill.total_19} "\
                               "= #{bill.total_0 + bill.total_7 + bill.total_19})")
         else
+          if bill.swiss?
+            Magelex.logger.info("#{bill.order_nr}: swiss")
+          end
           Magelex.logger.debug("Handle #{bill.order_nr}")
           bills_export << bill
         end

data/magelex.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'mysql2', '~> 0.4'
+  spec.add_dependency 'terminal-table', '~> 1.5'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magelex
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Felix Wolfsteller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +85,7 @@ email:
 - felix.wolfsteller@gmail.com
 executables:
 - magelex
+- magelex_debug
 extensions: []
 extra_rdoc_files: []
 files:
@@ -81,7 +96,9 @@ files:
 - README.md
 - Rakefile
 - bin/magelex
+- bin/magelex_debug
 - lib/magelex.rb
+- lib/magelex/bill_modifier.rb
 - lib/magelex/lexware_account.rb
 - lib/magelex/lexware_bill.rb
 - lib/magelex/lexware_csv.rb