magelex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d3dcd100c3a4c73c1e885c3e512704d4e21d1ba
+  data.tar.gz: da8ac0c3a739e5a8c05c361a52bd9260f4619c32
+SHA512:
+  metadata.gz: 19cf4f8f959f1ee4c13cdb19c0ea37f456314a75050d442a3ee148458fa78213912302c54aedb4c44170259af13e69a507d734b805db81d6e006e17b84d559bb
+  data.tar.gz: e0113ad7243563e6dc4e55a67e7f8ebe682498a0f1339dcc466ae17a89410a8666e642b744f049ec12c5085e933c4230676fffcce1c5958050f4fad69ec65db2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+magelex.conf

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at felix.wolfsteller@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in magelex.gemspec
+gemspec

data/README.md

@@ -0,0 +1,63 @@
+# Magelex
+
+*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.
+
+Aim is to manage the cash flow in Lexware.
+
+The solution is specific for one customers needs.  If you need a similar solution (or have a better one!) contact me!
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install magelex
+
+## Assumptions
+
+Customer accounts are hard coded.  Database access necessary for date corrections.
+
+## Usage
+
+Call `magelex --help` to get a basic idea:
+
+    Usage: magelex DIR_OR_FILE
+    
+    Imports order data from magento csv export, exports this data to be imported to open positions in lexware.
+    
+        -o, --out-dir DIR                Directory to write output files to.
+        -l, --log-file FILE              File to log to (default: STDERR).
+        -v, --verbose                    Run verbosely
+        -s, --skip-db                    Do not update dates from mysql database.
+        -h, --help                       Show this help and exit.
+            --version                    Show version and exit.
+    
+
+By default, `magelex` will log to `STDERR`, put 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).
+
+### Configuration
+
+Configure magento MySQL database access in `magelex.conf` .  An example configuration comes shipped with the gem (`magelex.conf.example`).
+
+If no database queries should be done, invoke with `--skip-db`.
+
+### Use the command line interface
+
+Call `magelex --help` to get a basic idea.
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests. You can also run `bundle console` for an interactive prompt that will allow you to experiment. Run `bundle exec magelex` to use the gem in this directory, ignoring other installed copies of this gem.
+
+Generally, I prefer to work and develop in `bundle exec`-mode.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fwolfst/magelex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+That said, just get in contact.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/magelex

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require "magelex"
+
+require 'yaml'
+require 'optparse'
+
+program_name = File.basename __FILE__
+options = {out_dir: 'lexware'}
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{program_name} DIR_OR_FILE"
+  opts.separator ""
+  opts.separator "Imports order data from magento csv export, exports this"\
+    " data to be imported to open positions in lexware."
+  opts.separator ""
+
+  opts.on('-o', '--out-dir DIR', 'Directory to write output files to.') do |o|
+    options[:out_dir] = o
+  end
+  opts.on('-l', '--log-file FILE', 'File to log to (default: STDERR).') do |o|
+    options[:log_file] = o
+  end
+  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_export = []
+  bills = Magelex::MagentoCSV.read ARGV[0]
+  bills.each do |bill|
+    if !bill.complete?
+      Magelex.logger.info("Skip order #{bill.order_nr} (incomplete: #{bill.status})")
+    else # complete!
+      bill.consume_shipping_cost
+      bill.swissify
+      if !bill.check
+        Magelex.logger.info("Skip order #{bill.order_nr} "\
+                            "(totals do not match #{bill.total} != "\
+                            "(0: #{bill.total_0} + 7: #{bill.total_7} "\
+                            "+ 19: #{bill.total_19})")
+      else
+        Magelex.logger.debug("Handle #{bill.order_nr}")
+        bills_export << bill
+      end
+    end
+  end
+
+  # Fix dates via database.
+  if !options[:skipdb]
+    begin
+      Magelex.logger.info("Fetching dates from magento mysql.")
+      Magelex::MagentoMYSQL.update_dates YAML.load_file('magelex.conf'), bills_export
+    rescue => e
+      Magelex.logger.error("Could not connect to MySQL database, exiting.")
+      Magelex.logger.error(e.inspect)
+      exit 2
+    end
+  end
+
+  # Export/Write to file
+  Dir.mkdir options[:out_dir] rescue {}
+  outdir  = Pathname.new(options[:out_dir]).realpath
+  outfile = outdir.join(File::basename ARGV[0])
+  if File.exist?(outfile)
+    Magelex.logger.error("Output file #{outfile} exists already, exiting.")
+    exit 3
+  end
+  Magelex.logger.info("Writing to #{outfile}")
+  Magelex::LexwareCSV.write outfile, bills_export
+  Magelex.logger.info("Finished")
+end
+
+main options

data/lib/magelex/lexware_account.rb

@@ -0,0 +1,40 @@
+module Magelex
+  module AccountNumber
+    def self.for_customer bill
+      first_letter = bill.customer_lastname[0].upcase
+      first_letter.gsub!(/[ÖÜÄ]/, 'Ä' => 'A', 'Ö' => 'O', 'Ü' => 'U')
+
+      return 12300 if first_letter == "Y"
+      return 12300 if first_letter == "Z"
+
+      # A is 0
+      ord = first_letter.ord - "A".ord# + 1
+      10000 + ord * 100
+    end
+
+    # get tax for :total_0, :total_7 or :total_19
+    def self.for(bill, tax_kind)
+      if tax_kind == :total_0
+        return for_0 bill
+      elsif tax_kind == :total_7
+        return for_7 bill
+      elsif tax_kind == :total_19
+        return for_19 bill
+      else
+        raise "unknown tax_kind"
+      end
+    end
+
+    def self.for_7 bill
+      bill.in_eu? ? '8310' : '8300'
+    end
+
+    def self.for_19 bill
+      bill.in_eu? ? '8315' : '8400'
+    end
+
+    def self.for_0 bill
+      '8120'
+    end
+  end
+end

data/lib/magelex/lexware_bill.rb

@@ -0,0 +1,75 @@
+require 'magelex'
+
+module Magelex
+  class LexwareBill
+    @@EU_CODES = ['BE','BG','CZ','DK','EE','EL','ES','FR',
+                  'IE','IT','CY','LV','LT','LU','HU','MT',
+                  '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
+
+    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
+      @total    = values.delete(:total) || 0
+      @total_0  = values.delete(:total_0) || 0
+      @total_7  = values.delete(:total_7) || 0
+      @total_19 = values.delete(:total_19) || 0
+      @status   = values.delete(:status) || nil
+      @shipping_cost = values.delete(:shipping_cost) || nil
+      @country_code  = values.delete(:country_code) || nil
+      if !values.empty?
+        raise "Unknown values for bill: #{values.inspect}"
+      end
+    end
+
+    def swiss?
+      @country_code == 'CH'
+    end
+
+    def add_item amount, tax, name
+      case TaxGuess.guess(amount, tax)
+      when :tax0
+        @total_0 += amount
+      when :tax7
+        @total_7 += amount
+      when :tax19
+        @total_19 += amount
+      else
+        raise 'Unknown Tax class'
+      end
+    end
+
+    def customer_lastname
+      @customer_name.split[-1]
+    end
+
+    def in_eu?
+      @@EU_CODES.include? @country_code
+    end
+
+    def check
+      @total.round(2) == (@total_0 + @total_7 + @total_19).round(2)
+    end
+
+    def consume_shipping_cost
+      @total_19 += @shipping_cost * 1.19
+      @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

@@ -0,0 +1,43 @@
+module Magelex
+  module LexwareCSV
+    def self.write file, bills
+      File.open(file, 'w') do |f|
+        f.write render(bills).gsub("\n", "\r\n").encode(
+          'windows-1252', invalid: :replace, undef: :replace)
+      end
+    end
+
+    def self.to_rows bill
+      # main
+      rows = []
+      rows << [bill.date.strftime("%d.%m.%Y"),
+       bill.order_nr,
+       bill.customer_name,
+       bill.total.round(2),
+       Magelex::AccountNumber.for_customer(bill),
+       0]
+      # subs
+      [:total_0, :total_7, :total_19].each do |part|
+        if (amount = bill.send(part)) != 0
+          rows << [
+                  bill.date.strftime("%d.%m.%Y"),
+                  bill.order_nr,
+                  bill.customer_name,
+                  amount.round(2),
+                  0,
+                  Magelex::AccountNumber.for(bill, part),
+                  ]
+        end
+      end
+      rows
+    end
+
+    def self.render bills
+      CSV.generate(encoding: 'utf-8') do |csv|
+        bills.each do |b|
+          to_rows(b).each { |r| csv << r }
+        end
+      end
+    end
+  end
+end

data/lib/magelex/magento_csv.rb

@@ -0,0 +1,69 @@
+require 'csv'
+
+module Magelex
+  module MagentoCSV
+    MONEY_FIELDS = ['Order Shipping', 'Order Grand Total',
+                    'Item Total', 'Item Tax']
+
+    CSV::Converters[:german_money_amount] = lambda do |value, info|
+      if MONEY_FIELDS.include? info[:header]
+        value.gsub(',', '.').to_f
+      else
+        value
+      end
+    end
+
+    CSV::Converters[:order_date] = lambda do |value, info|
+      if info[:header] == 'Order Date'
+        Date.strptime(value[0..10], "%d.%m.%Y")
+      else
+        value
+      end
+    end
+
+    # Reads file and returns lexware_bills
+    def self.read filename
+      self.parse(File.read filename)
+    end
+
+    # Creates a bill with basic information from csv line
+    def self.init_bill row
+      bill = Magelex::LexwareBill.new
+
+      # TODO: defining a attribute|colum- map would be nicer
+      bill.order_nr = row['Order Number']
+      bill.customer_name = row['Billing Name']
+      bill.country_code  = row['Shipping Country']
+      bill.date          = row['Order Date']
+
+      bill.status        = row['Order Status']
+
+      bill.shipping_cost = row['Order Shipping']
+      bill.total         = row['Order Grand Total']
+      bill
+    end
+
+    def self.parse string
+      bills = []
+      current_bill = Magelex::LexwareBill.new
+
+      CSV::parse(string, :headers => :first_row,
+                 converters: [:all, :german_money_amount, :order_date]) do |row|
+        # Multiple rows (with same order_nr) define one order
+        # One order will be mapped to one bill
+        if current_bill.order_nr != row['Order Number']
+          current_bill = init_bill row
+        end
+
+        current_bill.add_item(row['Item Total'],
+                              row['Item Tax'],
+                              row['Item Name'])
+
+        if !bills.include? (current_bill)
+          bills << current_bill
+        end
+      end
+      bills
+    end
+  end
+end

data/lib/magelex/magento_mysql.rb

@@ -0,0 +1,27 @@
+require 'mysql2'
+
+module Magelex
+  module MagentoMYSQL
+    def self.update_dates mysqlconf, bills
+      @client = Mysql2::Client.new(:host => mysqlconf[:host],
+                                   :port => mysqlconf[:port],
+                                   :database => mysqlconf[:database],
+                                   :username => mysqlconf[:username],
+                                   :password => mysqlconf[:password])
+
+      in_statement = bills.map{|b| "'#{b.order_id}'"}.join(',')
+      query = "SELECT increment_id, created_at, updated_at, "\
+        "invoice_status_id  FROM sales_flat_invoice "\
+        "WHERE increment_id IN (#{in_statement});"
+
+      # Build up index TODO rubyfy
+      bill_idx = {}
+      bills.each {|b| bill_idx[b.order_id] = b}
+      results = @client.query(query)
+
+      results.each do |row|
+        bill_idx[row['increment_id']].date = row['created_at']
+      end
+    end
+  end
+end

data/lib/magelex/tax_guess.rb

@@ -0,0 +1,16 @@
+module Magelex
+  module TaxGuess
+    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
+        raise "TaxGuess: Cannot guess tax of "\
+          "#{total}/#{tax_amount} (#{total - total/tax_amount})"
+      end
+    end
+  end
+end

data/lib/magelex/version.rb

@@ -0,0 +1,3 @@
+module Magelex
+  VERSION = "0.1.0".freeze
+end

data/lib/magelex.rb

@@ -0,0 +1,18 @@
+require 'magelex/version'
+require 'magelex/magento_csv'
+require 'magelex/lexware_bill'
+require 'magelex/lexware_csv'
+require 'magelex/tax_guess'
+require 'magelex/lexware_account'
+require 'magelex/magento_mysql'
+
+require 'logger'
+
+module Magelex
+  def self.logger
+    @logger ||= Logger.new
+  end
+  def self.logger= logger
+    @logger = logger
+  end
+end

data/magelex.conf.example

@@ -0,0 +1,6 @@
+host : 127.0.0.1
+port : 3306
+database : db
+username : user
+password : pass
+

data/magelex.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magelex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magelex"
+  spec.version       = Magelex::VERSION
+  spec.authors       = ["Felix Wolfsteller"]
+  spec.email         = ["felix.wolfsteller@gmail.com"]
+  spec.licenses      = ['GPL-3.0']
+
+  spec.summary       = %q{Bridge for data from Magento shop to Lexware financial software.}
+  spec.homepage      = "https://github.com/fwolfst/magelex"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mysql2', '~> 0.4'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: magelex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Wolfsteller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- felix.wolfsteller@gmail.com
+executables:
+- magelex
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/magelex
+- lib/magelex.rb
+- lib/magelex/lexware_account.rb
+- lib/magelex/lexware_bill.rb
+- lib/magelex/lexware_csv.rb
+- lib/magelex/magento_csv.rb
+- lib/magelex/magento_mysql.rb
+- lib/magelex/tax_guess.rb
+- lib/magelex/version.rb
+- magelex.conf.example
+- magelex.gemspec
+homepage: https://github.com/fwolfst/magelex
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Bridge for data from Magento shop to Lexware financial software.
+test_files: []