shoplex 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20c7941e19b65f85d1302da25487fbfcea4b97bd4ab155e2f7653016f17bb706
+  data.tar.gz: 101b225c841f95759f39448a22e6db2f49202d935e2e0c0dbe89b85cb6dfedf3
+SHA512:
+  metadata.gz: aa8521384cf880d9604114d072d9e10aec63d270da3f4411b627b48dff4fc09065d8bee630958af5b5cc030a6cccd8c4b88289a5dcda21cbd1e8a0f72a9650b8
+  data.tar.gz: d147a8c5c0684f92d57d1e0fae3e548583636456e78f0cc8d460969a313f8f713180525138a8dc665263b1e53ef010ad954080b989e164fabb0a5ec6050ade35

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.3.0] - 2023-03-02
+
+- Add invoice sanity check
+
+## [0.1.0] - 2023-03-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at felix.wolfsteller@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+ruby "3.2.1" # for CI to work, needs to match .github/workflows/ruby.yml
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shoplex.gemspec
+gemspec
+
+# Test and Gem maintenance
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "minitest-reporters", "~> 1.6"
+
+# Webui
+
+gem "sinatra", "~> 3.0"
+gem "haml", "~> 6.1"
+gem "puma", "~> 6.1"
+
+gem "rerun", "~> 0.14.0"
+
+gem "guard", "~> 2.18"
+
+gem "guard-minitest", "~> 2.4"

data/README.md

@@ -0,0 +1,105 @@
+# Shoplex
+
+Shoplex takes Shopware online shop order and invoice data and converts it in a format that Lexware can read to model open positions.
+
+It superseedes the [magelex (version online is outdated)](github.com/raw-living-germany/magelex), since the change from Monstergento to Shopliftware.
+
+It supports the management of cash flow in Lexware.
+
+The solution is specific for one customers needs. If you need a similar (or better) solution, contact us!
+
+It is hacked in pretty vanilla (and as of writing, recent) Ruby 3.2.1+ and comes
+with a sinatra (old school, single fileish) web interface.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install shoplex
+
+Instructions to run the web-ui are below.
+
+## Assumptions
+
+Customer accounts are hard coded.
+
+## Usage
+
+  $ none yet
+
+## Documentation of process
+
+
+
+## Open questions and/or answers
+
+**How to deal with credits/Gutschriften**
+
+*We don't know yet*
+
+**Does EU-ity depend on shipping or billing address**
+
+*We don't know yet*
+
+**Some invoices have 0 amount and/or a gutschrift - where do they come from?**
+
+*We don't know yet*
+
+**Where is the tax of the shipping costs?**
+
+The **invoiceAmount is inclusive the invoiceShipping**.
+Taxes of the shipping is not included in the individual tax columns but calculated via percentage (anteilsmäßig).
+
+**Which invoices or orders to take into account?**
+
+Take **all invoices** (irrespective of orderStatus and paymentStatus)
+
+**Does Lexware needs gross or net numbers?**
+
+Lexware takes **gross** numbers
+
+**Do we need to book the discount?**
+
+No.
+
+## Other
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/raw-living-germany/shoplex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/shoplex/blob/master/CODE_OF_CONDUCT.md).
+
+### License
+
+The included [pico css](https://github.com/picocss/pico) file is [MIT](https://github.com/picocss/pico/blob/08da409d0758dd1807783a938e4e202445f30033/LICENSE.md)
+licensed.
+Rest is [AGPLv3+](LICENSE), Copyright 2023 Felix wolfsteller.
+
+## Code of Conduct
+
+Everyone interacting in the Shoplex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/raw-living-germany/shoplex/blob/master/CODE_OF_CONDUCT.md).
+
+# Web-UI for Shoplex
+
+(single file sinatra app)
+
+## Start and usage instructions
+
+`bundle exec exe/shoplex-web`
+
+### Development
+
+Execute
+
+```bash
+bundle exec rerun --pattern "**/*" --ignore="test/*" exe/shoplex-web
+```
+
+for automatic server reloads in development.
+
+## Deployment
+
+As a service you can take the template in [webui/shoplex.service], link it (e.g.
+`ln -s /home/rawbotz/shoplex/webui/shoplex.service  /etc/systemd/system/shoplex.service`) and
+start it (`service shoplex restart`)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/config.ru

@@ -0,0 +1,4 @@
+## config.ru (run with rackup)
+load './exe/shoplex-web'
+
+run Sinatra::Application

data/exe/shoplex

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'shoplex'
+
+puts Shoplex::process(ARGF.read).csv_out
+
+exit 0

data/exe/shoplex-web

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require 'sinatra'
+require 'haml'
+
+require 'shoplex'
+
+set :root,          File.dirname(__FILE__)
+set :public_folder, Proc.new { File.join(root, "..", "webui") }
+set :static,        true
+
+get '/' do
+  content_type "text/html"
+  @open_file_upload_dialog = true
+  haml :index
+end
+
+post '/' do
+  unless params[:file] &&
+         (tmpfile = params[:file][:tempfile]) &&
+         (name = params[:file][:filename])
+    @open_file_upload_dialog = true
+    @error = "No file selected"
+    return haml(:index)
+  end
+  @open_file_upload_dialog = false
+  tmpfile_content = tmpfile.read
+  @result = Shoplex::process tmpfile_content
+  haml :index
+end
+
+# Sinatra & Ruby Magic
+__END__
+
+@@layout
+!!! 5
+%html{:"data-theme" => "dark"}
+  %head
+    %meta{:charset => "utf-8"}
+    %title Shoplex WEB
+    %meta{:name => "viewport", :content => "width=device-width, initial-scale=1"}
+    :css
+      :root {
+        --primary: #8e24aa;
+      }
+    %link{:rel => "stylesheet", :href => "/assets/pico.min.css"}
+    :css
+      /* Purple Dark scheme (Forced) */
+      [data-theme="dark"] {
+        --primary: #8e24aa;
+        --primary-hover: #9c27b0;
+        --primary-focus: rgba(142, 36, 170, 0.25);
+        --primary-inverse: #FFF;
+      }
+      /* Purple (Common styles) */
+      :root {
+        --form-element-active-border-color: var(--primary);
+        --form-element-focus-color: var(--primary-focus);
+        --switch-color: var(--primary-inverse);
+        --switch-checked-background-color: var(--primary);
+      }
+      h1 {
+        --typography-spacing-vertical: 1rem;
+      }
+  %body
+    %main.container
+      != yield
+
+@@index
+%h1 Shoplex
+%em(style="color: red")=@error
+%details(open=@open_file_upload_dialog)
+  %summary File Upload
+  %form{action: "/", method: "post", enctype: "multipart/form-data"}
+    .grid
+      %div
+        %input{type: "file", name: "file"}
+      %div
+        %input{type: "submit", value: "Upload"}
+%details
+  %summary Text Upload
+  %form{action: "/", method: "post", enctype: "multipart/form-data"}
+    %textarea{name: 'textarea', placeholder: "copy your text here"}
+    %input{type: "submit", value: "Upload"}
+%hr
+- if @result
+  %h2 Result
+  %h3 Errors and invoices to look out for
+  %div(style="color: red")
+    #{@result.errors.count} errors here
+    #{@result.errors.inspect}
+  %h3 Lexware file
+  %a{role: 'button', href:"data:attachment/csv;charset=utf-8,#{URI.encode_www_form_component @result.csv_out}", target: '_blank', download: 'filename.csv'}
+    Download file
+  %pre
+    = @result.csv_out

data/lib/shoplex/account_number.rb

@@ -0,0 +1,29 @@
+class Shoplex::AccountNumber
+  def self.sending_gross(lastname:)
+    char = lastname.encode(Encoding::UTF_8).strip.upcase[/[a-zA-ZÖÄÜ]/].chars.first
+    char.gsub!(/[ÖÜÄ]/, 'Ä' => 'A', 'Ö' => 'O', 'Ü' => 'U')
+
+    if char !~ /[A-Z]/
+      raise ArgumentError, "Don't know account number for #{lastname} (does not start with a 'good' letter A-Z)"
+    end
+
+    ordinal = char.ord - "A".ord
+
+    10_000 + ordinal * 100
+  end
+
+
+  # 8120 is e.g. Swiss and taxfree - book manually
+  # 8125 would be EU with tax-ID-Nr. §4 - book manually
+  def self.receiving_tax00(german:)
+    8120
+  end
+
+  def self.receiving_tax07(german:)
+    german ? 8300 : 8310
+  end
+
+  def self.receiving_tax19(german:)
+    german ? 8400 : 8315
+  end
+end

data/lib/shoplex/booking.rb

@@ -0,0 +1,22 @@
+class Shoplex::Booking
+  attr_reader :booking_lines, :date, :reference
+
+  def initialize(date:, reference:)
+    @booking_lines = []
+    @date = date
+    @reference = reference
+  end
+
+  def line(type:)
+    @booking_lines.select{_1.type == type}.first
+  end
+
+  def lines
+    @booking_lines.dup.freeze
+  end
+
+  def add_line(booking_line)
+    booking_line.booking = self
+    @booking_lines << booking_line
+  end
+end

data/lib/shoplex/booking_line.rb

@@ -0,0 +1,25 @@
+module Shoplex
+  BookingLine = Struct.new(:sending_account, :receiving_account, :gross_amount,
+                           :reference,
+                           :type,
+                           :booking,
+                           keyword_init:true) do
+    def initialize(...)
+      super(...)
+      raise BookingLine::Types::UnsupportedType.new("BookingLine Type #{type.inspect} not supported") if !BookingLine::Types::contains?(type)
+    end
+  end
+
+  module BookingLine::Types
+    class UnsupportedType < StandardError ; end
+
+    GROSS = :gross
+    TAX00 = :tax00
+    TAX07 = :tax07
+    TAX19 = :tax19
+
+    def self.contains? type
+      [GROSS, TAX00, TAX07, TAX19].include? type
+    end
+  end
+end

data/lib/shoplex/invoice_booking_converter.rb

@@ -0,0 +1,42 @@
+module Shoplex
+  class InvoiceBookingConverter
+    def self.convert(invoice:)
+      booking = Booking.new(date: invoice.order_time, reference: invoice.invoice_number)
+
+      add_gross_booking_line(invoice:, booking:)
+      [
+        [:tax00, AccountNumber::method(:receiving_tax00), :tax00_amount],
+        [:tax07, AccountNumber::method(:receiving_tax07), :tax07_amount],
+        [:tax19, AccountNumber::method(:receiving_tax19), :tax19_amount],
+      ].each do |type, account_number_method, invoice_amount_accessor|
+        add_tax_booking_line(invoice:, booking:, type:, account_number_method:, invoice_amount_accessor:)
+      end
+
+      booking
+    end
+
+    def self.create_reference invoice:
+      "#{invoice.invoice_number} #{invoice.order_number} #{invoice.firstname} #{invoice.lastname}"
+    end
+
+    def self.add_gross_booking_line(invoice:, booking:)
+      booking.add_line Shoplex::BookingLine.new(sending_account: Shoplex::AccountNumber::sending_gross(lastname: invoice.lastname),
+                                                receiving_account: 0,
+                                                gross_amount: invoice.invoice_amount,
+                                                reference: create_reference(invoice:),
+                                                type: BookingLine::Types::GROSS)
+    end
+
+    def self.add_tax_booking_line(invoice:, booking:, type:, account_number_method:, invoice_amount_accessor:)
+      return if invoice.send(invoice_amount_accessor).to_f == 0.0
+
+      line = Shoplex::BookingLine.new(
+        sending_account: 0,
+        receiving_account: account_number_method.(german: invoice.german?),
+        gross_amount: invoice.send(invoice_amount_accessor),
+        reference: create_reference(invoice:),
+        type:)
+      booking.add_line line
+    end
+  end
+end

data/lib/shoplex/lexware_csv.rb

@@ -0,0 +1,21 @@
+module Shoplex
+  class LexwareCSV
+    def self.create_from(bookings:)
+      CSV.generate do |csv|
+        bookings.each do |booking|
+          booking.booking_lines.each do |line|
+            csv << [
+              booking.date.strftime("%d.%m.%Y"),
+              booking.reference,
+              line.reference,
+              "%.2f" % line.gross_amount.to_f,
+              line.sending_account,
+              line.receiving_account,
+              'EUR'
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoplex/result.rb

@@ -0,0 +1,19 @@
+module Shoplex
+  class Result
+    attr_accessor :invoices
+    attr_reader   :errors
+    attr_accessor :csv_out
+
+    def initialize
+      @invoices = []
+      @errors = {}
+    end
+
+    def mark_error(maker:, error:, obj:)
+      @errors[maker] ||= {}
+      @errors[maker][error] ||= []
+
+      @errors[maker][error] << obj
+    end
+  end
+end

data/lib/shoplex/sanity_check.rb

@@ -0,0 +1,15 @@
+module Shoplex
+  class SanityCheck
+    class GrossDoesNotMatchNet < StandardError ; end
+    def self.check!(invoice:)
+      net_tax_sum = (invoice.invoice_amount_net + invoice.tax07_amount + invoice.tax19_amount).round(2)
+      if invoice.invoice_amount != net_tax_sum
+        raise GrossDoesNotMatchNet.new(
+          "Gross amount #{invoice.invoice_amount} does not equal net + tax sums "\
+          "(#{invoice.invoice_amount_net} "\
+          "+ #{invoice.tax07_amount} "\
+          "+ #{invoice.tax19_amount} == #{net_tax_sum})")
+      end
+    end
+  end
+end

data/lib/shoplex/shipping_splitter.rb

@@ -0,0 +1,22 @@
+module Shoplex
+  class ShippingSplitter
+    def self.apply!(invoice:)
+      return if invoice.shipping_net.to_i == 0 || invoice.shipping_gross.to_i == 0
+
+      #https://www.wolframalpha.com/input?i=solve+a+%2B+b+%3D+1+AND+g+-+n+%3D+0.07+*+a+*+n+%2B+0.19+*+b+*+n+for+a
+
+
+      ratio_07 = (119 / 12.0) - (25 * invoice.shipping_gross) / (3 * invoice.shipping_net)
+      ratio_19 = 1.0 - ratio_07
+
+      shipping_cost_19part = invoice.shipping_net * ratio_19
+      shipping_cost_07part = invoice.shipping_net * ratio_07
+
+      invoice.tax19_amount = invoice.tax19_amount.to_f + shipping_cost_19part * 0.19
+      invoice.tax07_amount = invoice.tax07_amount.to_f + shipping_cost_07part * 0.07
+
+      invoice.tax19_amount = invoice.tax19_amount.round(2)
+      invoice.tax07_amount = invoice.tax07_amount.round(2)
+    end
+  end
+end

data/lib/shoplex/shopware_csv_parser.rb

@@ -0,0 +1,55 @@
+require 'csv'
+
+module Shoplex
+  class ShopwareCSVParser
+    def self.parse csv_file_content
+      result = Shoplex::Result.new
+
+      CSV.parse(csv_file_content, headers: true, col_sep: ';', converters:
+                :date_time, encoding: Encoding::ISO_8859_1) do |row|
+        if row['invoiceNumber']
+          begin
+            convert_tax_numbers!(row:)
+            convert_shipping_and_amount__numbers!(row:)
+            result.invoices << create_invoice_from(row:)
+          rescue => e
+            result.mark_error(maker: self, error: :creation_failed, obj: [e, row])
+            STDERR.puts e
+            STDERR.puts e.backtrace
+          end
+        else
+          result.mark_error(maker: self, error: :no_invoice_number, obj: row)
+        end
+      end
+
+      return result
+    end
+
+    def self.convert_tax_numbers!(row:)
+      row["taxRateSums_7"]  = row["taxRateSums_7"].to_f
+      row["taxRateSums_19"] = row["taxRateSums_19"].to_f
+    end
+
+    def self.convert_shipping_and_amount__numbers!(row:)
+      row["invoiceShipping"]    = row["invoiceShipping"].to_s.gsub(",",".").to_f
+      row["invoiceShippingNet"] = row["invoiceShippingNet"].to_s.gsub(",",".").to_f
+      row["invoiceAmount"]      = row["invoiceAmount"].to_s.gsub(",",".").to_f
+      row["invoiceAmountNet"]   = row["invoiceAmountNet"].to_s.gsub(",",".").to_f
+    end
+
+    def self.create_invoice_from(row:)
+      ShopwareInvoice.new(invoice_number: row["invoiceNumber"],
+                          order_number:   row['orderNumber'],
+                          order_time:     row['orderTime'],
+                          tax00_amount:   row['taxRateSums_0'],
+                          tax07_amount:   row['taxRateSums_7'],
+                          tax19_amount:   row['taxRateSums_19'],
+                          invoice_amount: row['invoiceAmount'],
+                          invoice_amount_net: row['invoiceAmountNet'],
+                          shipping_gross: row['invoiceShipping'],
+                          shipping_net:   row['invoiceShippingNet'],
+                          country:        row['billingCountry'],
+                          lastname:       row['billingLastName'],)
+    end
+  end
+end

data/lib/shoplex/shopware_invoice.rb

@@ -0,0 +1,37 @@
+module Shoplex
+  ShopwareInvoice = Struct.new(:invoice_number,
+                               :order_number,
+                               :firstname, :lastname,
+                               :country,
+                               :order_time,
+                               :invoice_amount, :invoice_amount_net,
+                               :tax00_amount,
+                               :tax07_amount,
+                               :tax19_amount,
+                               :shipping_gross, :shipping_net,
+                               keyword_init: true) do
+
+    # provide defaults (floats for the numbers)
+    def initialize(invoice_number: nil,
+                   order_number:   nil,
+                   firstname: nil, lastname: nil,
+                   country: nil,
+                   order_time: nil,
+                   invoice_amount: 0.0, invoice_amount_net: 0.0,
+                   tax00_amount: 0.0,
+                   tax07_amount: 0.0,
+                   tax19_amount: 0.0,
+                   shipping_gross: 0.0, shipping_net: 0.0
+                   )
+      super
+    end
+
+    def german?
+      country == "Deutschland"
+    end
+
+    def swiss?
+      county == "Schweiz"
+    end
+  end
+end

data/lib/shoplex/version.rb

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