money_s3 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7cbd29efedb54d59820bacc602225dd41d1b2f091ecc7f70514b1834bece682
-  data.tar.gz: 96dd8b3ded7dda408155c974eef6ee1849fc4327f2863c076fc179aaf86168e7
+  metadata.gz: 8e219b2f5b8a348583051fceb6947614d4f18cb35581bb98b846b247c587e168
+  data.tar.gz: b773d23e3528107c845406e287ec9df8be91d50f6a374fe871a7feb17222b34b
 SHA512:
-  metadata.gz: 0ba07b1e9c3552b390ed94af9c902783b8971130b94e28ac4d06410166156fbd101bec64afe4cc90c7b13433609aa96330f7108cc58350fc3c3e2039290e9560
-  data.tar.gz: c4d5f792690c68cb20d0065742feec3abfc5922ffcd4afa703408ed223352e5057fae224a83eb146a48e815df30d68ff79afc6c6fca0cb29944e0eab1d984ee0
+  metadata.gz: 370e4c82225e9255754daf03b9bdd5f5d49ad067368959821313e40a3154a099b048675f30d60ebcc277db27736229844ab79c5563ff9bfdf325ec2f67653526
+  data.tar.gz: d2caa678acf50542b67fdc7d3c94fac54071fcc65797dfc14ffcd33e7300569e2169584a71e7a068bec6fa6e597a36d15ff772183d4a17fb1921e2307b9c9642

data/README.md

@@ -1,13 +1,88 @@
 # MoneyS3
 
-This gem allows to parse and build any Money S3 entity defined in theirs XML schemas. However i didn't yet have a time to document it.
+This gem allows to parse and build any Money S3 entity defined in theirs XML schemas. All the names and structure are preserved as in the original definitions which can be found [here](https://github.com/Masa331/money_xsd). This gem also includes few utilities for fast and easy XML generation.
 
-But it works pretty much the same as [pohoda](https://github.com/Masa331/pohoda) so if you are desperate, look there, the principle is the same.
+## Usage
+
+### Parsing a XML
+
+I didn't have time to write docs yet. However parsing works exactly the same as in [Pohoda gem](https://github.com/Masa331/pohoda)
+
+### Building a XML
+
+To build a Money S3 XML you need a hash with same structure you get from calling `#to_h` on parsed xml:
+
+```ruby
+hash = { seznam_fakt_vyd: [{ doklad: '123' }] }
+MoneyS3.build(hash)
+```
+
+it returns a string like this:
+```xml
+<?xml version=\"1.0\"?>
+<MoneyData>
+  <SeznamFaktVyd>
+    <FaktVyd>
+      <Doklad>123</Doklad>
+    </FaktVyd>
+  </SeznamFaktVyd>
+</MoneyData>
+```
+
+Building works also exactly the same as in [Pohoda gem](https://github.com/Masa331/pohoda)
+
+### Utilities
+
+#### `MoneyS3::Utils::BankStatements` class
+
+Generates XML with bank movements for importing into Money S3.
+
+Instantiate `MoneyS3::Utils::BankStatements` with hash containing statements config:
+```
+config = {
+  my_bank_account_id: 'BAN', # Czech: zkratka bankovniho uctu
+  credit_transactions_rule: 'BP001', # Czech: predkontace pro prijmy
+  debit_transactions_rule: 'BV001', # Czech: predkontace pro vydaje
+  credit_transactions_vat_rule: '19Ř00U', # Czech: cleneni dph pro prijmy
+  debit_transactions_vat_rule: '19Ř00P', # Czech: cleneni dph pro vydaje
+  credit_transactions_series: 'BPrr', # Czech: ciselna rada prijmovych bankovnich dokladu
+  debit_transactions_series: 'BVrr' # Czech: ciselna rada vydajovych bankovnich dokladu
+}
+generator = MoneyS3::Utils::BankStatements.new(config)
+```
+
+Then call `#to_xml` on the generator and pass it an array containing hashes with movement data:
+```
+transactions = [
+  { :date => #<Date: 2019-12-05 ((2458823j,0s,0n),+0s,2299161j)>,
+    :transaction_id => "121205SI201442",
+    :amount => 8500.0,
+    :statement_id => "012/00001",
+    :variable_symbol => "0000112019",
+    :specific_symbol => "",
+    :constant_symbol => "0000000138",
+    :counterparty_account => "1023706843",
+    :counterparty_bank_code => "0100",
+    :type => :debit, # or :credit for credit transactions
+    :description => "Some description..",
+    :note => "Some note.." },
+    ...,
+    ...
+]
+statements_string = generator.to_xml(transactions)
+File.open("statements.xml", 'wb') { |f| f.write statements_string }
+```
 
 ## Changelog
 
+### 23.02.2020 - v2.1.0
+
+Add utility class for bank statements generation.
+
 ### 20.10.2019
 
 Updated gem with new schemas from Money S3 19.603
 
-Premysl Donat
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/money_s3/utils/bank_statements.rb

@@ -0,0 +1,80 @@
+module MoneyS3
+  module Utils
+    class BankStatements
+      TRANSACTION_TYPES = [:credit, :debit]
+
+      def initialize(configuration)
+        @my_bank_account_id = configuration.fetch :my_bank_account_id
+
+        @credit_transactions_rule = configuration.fetch :credit_transactions_rule
+        @debit_transactions_rule = configuration.fetch :debit_transactions_rule
+
+        @credit_transactions_vat_rule = configuration.fetch :credit_transactions_vat_rule
+        @debit_transactions_vat_rule = configuration.fetch :debit_transactions_vat_rule
+
+        @credit_transactions_series = configuration.fetch :credit_transactions_series
+        @debit_transactions_series = configuration.fetch :debit_transactions_series
+      end
+
+      def to_xml(raw)
+        statements = raw.map do |item|
+          amount = item.fetch :amount
+
+          data = {
+            id_polozky: item[:transaction_id],
+            dat_uc_pr: item[:date],
+            dat_vyst: item[:date],
+            dat_plat: item[:date],
+            dat_pln: item[:date],
+            vypis: item[:statement_id],
+            celkem: amount,
+            ucet: { zkrat: @my_bank_account_id },
+            popis: item[:description],
+            pozn: item[:note],
+            var_sym: item[:variable_symbol],
+            spec_sym: item[:specific_symbol],
+            kon_sym: item[:constant_symbol],
+            ad_ucet: item[:counterparty_account],
+            ad_kod: item[:counterparty_bank_code],
+            souhrn_dph: {
+              zaklad0: amount
+            }
+          }
+
+          transaction_type = item.fetch :type
+          fail "Unknown transaction type: #{transaction_type}" unless TRANSACTION_TYPES.include? transaction_type
+
+          if transaction_type == :credit
+            data.merge!({
+              vydej: '0',
+              pr_kont: @credit_transactions_rule,
+              cleneni: @credit_transactions_vat_rule,
+              d_rada: @credit_transactions_series
+            })
+          else
+            data.merge!({
+              vydej: '1',
+              pr_kont: @debit_transactions_rule,
+              cleneni: @debit_transactions_vat_rule,
+              d_rada: @debit_transactions_series
+            })
+          end
+
+          data.delete_if { |_, v| v.nil? || v == '' }
+          data.transform_values! do |value|
+            if value.is_a? Hash
+              value.transform_values! { |value| value.to_s }
+            else
+              value.to_s
+            end
+          end
+
+          data
+        end
+
+        money_data = { seznam_bank_dokl: statements }
+        MoneyS3.build(money_data)
+      end
+    end
+  end
+end

data/lib/money_s3.rb

@@ -5,6 +5,8 @@ require 'money_s3/requires'
 require 'money_s3/parsers/money_data'
 require 'money_s3/builders/money_data'
 
+require 'money_s3/utils/bank_statements'
+
 module MoneyS3
   def self.parse(raw)
     parsed = Ox.load(raw, skip: :skip_none)

data/money_s3.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'money_s3'
-  spec.version       = '2.0.0'
+  spec.version       = '2.1.0'
   spec.authors       = ['Premysl Donat']
   spec.email         = ['pdonat@seznam.cz']
 
@@ -15,14 +15,12 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'ox'
   spec.add_dependency 'damedata_parser_core'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money_s3
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Premysl Donat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2020-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -149,9 +135,6 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/money_s3.rb
 - lib/money_s3/builders/adresa_type.rb
 - lib/money_s3/builders/alternativa_prislusenstvi_type.rb
@@ -574,6 +557,7 @@ files:
 - lib/money_s3/parsers/zauctovani_dph_type.rb
 - lib/money_s3/parsers/zavazek_type.rb
 - lib/money_s3/requires.rb
+- lib/money_s3/utils/bank_statements.rb
 - money_s3.gemspec
 - xsd/Dochazka/Dochazka.xsd
 - xsd/Dochazka/Zamestnanci.xsd
@@ -617,7 +601,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: MoneyS3 XML parser and builder

data/Rakefile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "money_s3"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here