lsv-plus 1.0.0

data/lib/lsv_plus/total_record_formatter.rb

@@ -0,0 +1,42 @@
+require 'lsv_plus/formatting_helper'
+
+module LSVplus
+  class TotalRecordFormatter
+    TYPE = '890'
+    VERSION = '0'
+
+    attr_reader :file
+
+    def self.call(file)
+      new(file).call
+    end
+
+    def initialize(file)
+      @file = file
+    end
+
+    def call
+      [TYPE, VERSION, creation_date, creator_identification, record_number, currency, total_amount].join('')
+    end
+
+    def creation_date
+      LSVplus::FormattingHelper.date file.creation_date
+    end
+
+    def creator_identification
+      file.creator_identification
+    end
+
+    def record_number
+      LSVplus::FormattingHelper.index file.records.length
+    end
+
+    def currency
+      file.currency
+    end
+
+    def total_amount
+      LSVplus::FormattingHelper.amount file.total
+    end
+  end
+end

data/lib/lsv_plus/version.rb

@@ -0,0 +1,3 @@
+module LSVplus
+  VERSION = '1.0.0'
+end

data/lsv-plus.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lsv_plus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lsv-plus'
+  spec.version       = LSVplus::VERSION
+  spec.authors       = ['Raffael Schmid']
+  spec.email         = ['raffael.schmid@welltravel.com']
+  spec.summary       = 'Gem to create LSV+ files'
+  spec.homepage      = 'https://github.com/wtag/lsv-plus'
+  spec.license       = 'MIT'
+  spec.description   = 'Create a LSV+ file which can be uploaded to your bank.'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+end

data/spec/file_spec.rb

@@ -0,0 +1,98 @@
+require 'lsv_plus/file'
+
+RSpec.describe LSVplus::File do
+  let(:attributes) do
+    {
+      creator_identification: 'YOLO1',
+      currency: 'CHF',
+      processing_type: 'P',
+      creation_date: Date.new(2016, 1, 5),
+      lsv_identification: 'YOLO1',
+    }
+  end
+  let(:instance) { one_time_instance }
+
+  def one_time_instance
+    LSVplus::File.new(attributes)
+  end
+
+  describe 'validations' do
+    describe '#creator_identification' do
+      it 'it has to be all uppercase' do
+        attributes[:creator_identification] = 'yolo1'
+        expect { one_time_instance }.to raise_error(LSVplus::File::InvalidCreatorIdentification)
+      end
+
+      it 'has to be exactly 5 characters long' do
+        attributes[:creator_identification] = 'ASD1'
+        expect { one_time_instance }.to raise_error(LSVplus::File::InvalidCreatorIdentification)
+        attributes[:creator_identification] = 'ASDASD'
+        expect { one_time_instance }.to raise_error(LSVplus::File::InvalidCreatorIdentification)
+        attributes[:creator_identification] = 'ASD12'
+        expect { one_time_instance }.to_not raise_error
+      end
+    end
+
+    describe '#lsv_identification' do
+      it 'has to be all uppercase' do
+        attributes[:lsv_identification] = 'yolo1'
+        expect { one_time_instance }.to raise_error(LSVplus::File::InvalidLSVIdentification)
+      end
+
+      it 'has to be exactly 5 characters long' do
+        attributes[:lsv_identification] = 'ASD1'
+        expect { one_time_instance }.to raise_error(LSVplus::File::InvalidLSVIdentification)
+        attributes[:lsv_identification] = 'ASDASD'
+        expect { one_time_instance }.to raise_error(LSVplus::File::InvalidLSVIdentification)
+        attributes[:lsv_identification] = 'ASD12'
+        expect { one_time_instance }.to_not raise_error
+      end
+    end
+  end
+
+  describe '#add_record' do
+    it 'adds a record to #records' do
+      expect { instance.add_record('a') }.to change { instance.records }.from([]).to(%w(a))
+    end
+  end
+
+  describe '#to_s' do
+    it 'concatenates the records and the total record' do
+      expect(instance).to receive(:records_as_string).and_return('records').ordered
+      expect(instance).to receive(:total_record).and_return('total_record').ordered
+      expect(instance.to_s).to eq('recordstotal_record')
+    end
+  end
+
+  describe '#records_as_string' do
+    it 'calls RecordFormatter for each record' do
+      expect(LSVplus::RecordFormatter).to receive(:call).with(instance, 'record1', 1).once
+      expect(LSVplus::RecordFormatter).to receive(:call).with(instance, 'record2', 2).once
+      instance.add_record 'record1'
+      instance.add_record 'record2'
+      instance.records_as_string
+    end
+
+    it 'concatenates the records' do
+      expect(LSVplus::RecordFormatter).to receive(:call).and_return('a', 'b').twice
+      instance.add_record 'record1'
+      instance.add_record 'record2'
+      expect(instance.records_as_string).to eq('ab')
+    end
+  end
+
+  describe '#total_record' do
+    it 'calls TotalRecordFormatter' do
+      expect(LSVplus::TotalRecordFormatter).to receive(:call).with(instance)
+      instance.total_record
+    end
+  end
+
+  describe '#total' do
+    it 'sums record.amount' do
+      instance.add_record OpenStruct.new(amount: BigDecimal.new('0.9'))
+      instance.add_record OpenStruct.new(amount: 99)
+      expect(instance.total).to eq(BigDecimal.new('99.9'))
+    end
+  end
+end

data/spec/formatting_helper_spec.rb

@@ -0,0 +1,51 @@
+require 'lsv_plus/formatting_helper'
+
+RSpec.describe LSVplus::FormattingHelper do
+  describe '.date' do
+    let(:value) { Date.new(2016, 1, 31) }
+
+    subject { described_class.date value }
+
+    it { is_expected.to eq('20160131') }
+  end
+
+  describe '.index' do
+    let(:value) { 1 }
+
+    subject { described_class.index value }
+
+    it { is_expected.to eq('0000001') }
+  end
+
+  describe '.amount' do
+    let(:value) { 133 }
+
+    subject { described_class.amount value }
+
+    it { is_expected.to eq('000000133,00') }
+  end
+
+  describe '.multiline' do
+    let(:value) { ['Somewhere', 'else'] }
+
+    subject { described_class.multiline value }
+
+    it { is_expected.to eq('Somewhere                          else                                                                                                     ') }
+  end
+
+  describe '.account' do
+    let(:value) { 'asd-1.233' }
+
+    subject { described_class.account value }
+
+    it { is_expected.to eq('asd-1.233                         ') }
+  end
+
+  describe '.clearing_number' do
+    let(:value) { '233' }
+
+    subject { described_class.clearing_number value }
+
+    it { is_expected.to eq('233  ') }
+  end
+end

data/spec/integration/simple_spec.rb

@@ -0,0 +1,97 @@
+require 'bigdecimal'
+require 'lsv-plus'
+
+RSpec.describe 'Simple LSV+ file' do
+  let(:record_type) { '875' }
+  let(:version) { '0' }
+  let(:processing_type) { 'P' }
+  let(:processing_date) { '20160115' }
+  let(:creditor_bank_clearing_number) { '1337 ' }
+  let(:creation_date) { '20160105' }
+  let(:debitor_bank_clearing_number) { '42   ' }
+  let(:creator_identification) { 'YOLO1' }
+  let(:record_number) { '0000001' }
+  let(:lsv_identification) { 'YOLO1' }
+  let(:currency) { 'CHF' }
+  let(:amount) { '000001337,42' }
+  let(:creditor_iban) { 'CH9300762011623852957             ' }
+  let(:creditor_address) do
+    'Fancy AG                           '\
+    'Funnystreet 42                     '\
+    '                                   '\
+    '                                   '
+  end
+  let(:debitor_account) { '123.456-78XY                      ' }
+  let(:debitor_address) do
+    'Debit AG                           '\
+    'Other Street 1337                  '\
+    'Somewhere City                     '\
+    '                                   '
+  end
+  let(:message) do
+    'Invoice 133 via BDD                '\
+    '                                   '\
+    '                                   '\
+    '                                   '
+  end
+  let(:reference_type) { 'A' }
+  let(:reference) { '200002000000004443332000061' }
+  let(:esr_member_id) { '133742   ' }
+  let(:record_string) do
+    [
+      record_type, version, processing_type, processing_date,
+      creditor_bank_clearing_number, creation_date, debitor_bank_clearing_number,
+      creator_identification, record_number, lsv_identification,
+      currency, amount,
+      creditor_iban, creditor_address,
+      debitor_account, debitor_address,
+      message, reference_type, reference, esr_member_id
+    ].join('')
+  end
+
+  let(:total_record_type) { '890' }
+  let(:total_record_version) { '0' }
+  let(:total_amount) { '000001337,42' }
+  let(:total_record) do
+    [
+      total_record_type, total_record_version,
+      creation_date, creator_identification, record_number, currency, total_amount
+    ].join('')
+  end
+  let(:valid_output) do
+    [record_string, total_record].join('')
+  end
+
+  let(:file_attributes) do
+    {
+      creator_identification: creator_identification,
+      currency: currency,
+      processing_type: 'P',
+      creation_date: Date.new(2016, 1, 5),
+      lsv_identification: 'YOLO1',
+    }
+  end
+
+  let(:record_attributes) do
+    {
+      processing_date: Date.new(2016, 1, 15),
+      creditor_bank_clearing_number: 1337,
+      amount: BigDecimal.new('1337.42'),
+      debitor_bank_clearing_number: 42,
+      creditor_iban: 'CH9300762011623852957',
+      creditor_address: ['Fancy AG', 'Funnystreet 42'],
+      debitor_account: '123.456-78XY',
+      debitor_address: ['Debit AG', 'Other Street 1337', 'Somewhere City'],
+      message: ['Invoice 133 via BDD'],
+      reference_type: 'A',
+      reference: '200002000000004443332000061',
+      esr_member_id: '133742',
+    }
+  end
+
+  it 'returns a valid LSV+ file' do
+    file = LSVplus::File.new(file_attributes)
+    file.add_record LSVplus::Record.new(record_attributes)
+    expect(file.to_s).to eq(valid_output)
+  end
+end

data/spec/record_formatter_spec.rb

@@ -0,0 +1,313 @@
+require 'lsv_plus/record_formatter'
+
+RSpec.describe LSVplus::RecordFormatter do
+  let(:file) do
+    LSVplus::File.new(
+      creator_identification: 'YOLO1',
+      currency: 'CHF',
+      processing_type: 'P',
+      creation_date: Date.new(2016, 1, 5),
+      lsv_identification: 'YOLO1',
+    )
+  end
+  let(:record) do
+    LSVplus::Record.new(
+      processing_date: Date.new(2016, 1, 15),
+      creditor_bank_clearing_number: 1337,
+      amount: BigDecimal.new('1337.42'),
+      debitor_bank_clearing_number: 42,
+      creditor_iban: 'CH9300762011623852957',
+      creditor_address: ['Fancy AG', 'Funnystreet 42'],
+      debitor_account: '123.456-78XY',
+      debitor_address: ['Debit AG', 'Other Street 1337', 'Somewhere City'],
+      message: ['Invoice 133 via BDD'],
+      reference_type: 'A',
+      reference: '200002000000004443332000061',
+      esr_member_id: '133742',
+    )
+  end
+  let(:index) { 1 }
+  let(:instance) { LSVplus::RecordFormatter.new(file, record, index) }
+
+  describe '.call' do
+    let(:record_formatter_double) { instance_double(LSVplus::RecordFormatter) }
+
+    it 'initializes a new instance and calls `#call`' do
+      expect(LSVplus::RecordFormatter).
+        to receive(:new).with(record, file, index).and_return(record_formatter_double)
+      expect(record_formatter_double).to receive(:call)
+      LSVplus::RecordFormatter.call(record, file, index)
+    end
+  end
+
+  describe '#call' do
+    it 'returns all the formatted fields as string' do
+      %i(type version processing_type processing_date
+         creditor_bank_clearing_number creation_date debitor_bank_clearing_number
+         creator_identification record_number lsv_identification
+         currency amount
+         creditor_iban creditor_address
+         debitor_account debitor_address
+         message reference_type reference esr_member_id).each do |meth|
+           expect(instance).to receive(meth).with(no_args).and_call_original.ordered
+         end
+      expect(instance.call).to be_a(String)
+    end
+  end
+
+  describe '#type' do
+    it 'calls record.type' do
+      expect(record).to receive(:type).and_return('value')
+      expect(instance.type).to eq('value')
+    end
+  end
+
+  describe '#version' do
+    it 'calls record.version' do
+      expect(record).to receive(:version).and_return('value')
+      expect(instance.version).to eq('value')
+    end
+  end
+
+  describe '#processing_type' do
+    it 'calls file.processing_type' do
+      expect(file).to receive(:processing_type).and_return('value')
+      expect(instance.processing_type).to eq('value')
+    end
+  end
+
+  describe '#processing_date' do
+    let(:value) { Date.today }
+    before do
+      allow(record).to receive(:processing_date).and_return(value)
+    end
+
+    it 'calls record.processing_date' do
+      expect(record).to receive(:processing_date).and_return(value)
+      instance.processing_date
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:date).with(value).and_return('value')
+      expect(instance.processing_date).to eq('value')
+    end
+  end
+
+  describe '#creditor_bank_clearing_number' do
+    let(:value) { Date.today }
+    before do
+      allow(record).to receive(:creditor_bank_clearing_number).and_return(value)
+    end
+
+    it 'calls record.creditor_bank_clearing_number' do
+      expect(record).to receive(:creditor_bank_clearing_number).and_return(value)
+      instance.creditor_bank_clearing_number
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:clearing_number).with(value).and_return('value')
+      expect(instance.creditor_bank_clearing_number).to eq('value')
+    end
+  end
+
+  describe '#creation_date' do
+    let(:value) { Date.today }
+    before do
+      allow(file).to receive(:creation_date).and_return(value)
+    end
+
+    it 'calls file.creation_date' do
+      expect(file).to receive(:creation_date).and_return(value)
+      instance.creation_date
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:date).with(value).and_return('value')
+      expect(instance.creation_date).to eq('value')
+    end
+  end
+
+  describe '#debitor_bank_clearing_number' do
+    let(:value) { Date.today }
+    before do
+      allow(record).to receive(:debitor_bank_clearing_number).and_return(value)
+    end
+
+    it 'calls record.debitor_bank_clearing_number' do
+      expect(record).to receive(:debitor_bank_clearing_number).and_return(value)
+      instance.debitor_bank_clearing_number
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:clearing_number).with(value).and_return('value')
+      expect(instance.debitor_bank_clearing_number).to eq('value')
+    end
+  end
+
+  describe '#creator_identification' do
+    it 'calls file.creator_identification' do
+      expect(file).to receive(:creator_identification).and_return('value')
+      expect(instance.creator_identification).to eq('value')
+    end
+  end
+
+  describe '#record_number' do
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:index).with(index).and_return('value')
+      expect(instance.record_number).to eq('value')
+    end
+  end
+
+  describe '#lsv_identification' do
+    it 'calls file.lsv_identification' do
+      expect(file).to receive(:lsv_identification).and_return('value')
+      expect(instance.lsv_identification).to eq('value')
+    end
+  end
+
+  describe '#currency' do
+    it 'calls file.currency' do
+      expect(file).to receive(:currency).and_return('value')
+      expect(instance.currency).to eq('value')
+    end
+  end
+
+  describe '#amount' do
+    let(:value) { 1234 }
+    before do
+      allow(record).to receive(:amount).and_return(value)
+    end
+
+    it 'calls record.amount' do
+      expect(record).to receive(:amount).and_return(value)
+      instance.amount
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:amount).with(value).and_return('value')
+      expect(instance.amount).to eq('value')
+    end
+  end
+
+  describe '#creditor_iban' do
+    let(:value) { 1234 }
+    before do
+      allow(record).to receive(:creditor_iban).and_return(value)
+    end
+
+    it 'calls record.creditor_iban' do
+      expect(record).to receive(:creditor_iban).and_return(value)
+      instance.creditor_iban
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:account).with(value).and_return('value')
+      expect(instance.creditor_iban).to eq('value')
+    end
+  end
+
+  describe '#creditor_address' do
+    let(:value) { 1234 }
+    before do
+      allow(record).to receive(:creditor_address).and_return(value)
+    end
+
+    it 'calls record.creditor_address' do
+      expect(record).to receive(:creditor_address).and_return(value)
+      instance.creditor_address
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:multiline).with(value).and_return('value')
+      expect(instance.creditor_address).to eq('value')
+    end
+  end
+
+  describe '#debitor_account' do
+    let(:value) { 1234 }
+    before do
+      allow(record).to receive(:debitor_account).and_return(value)
+    end
+
+    it 'calls record.debitor_account' do
+      expect(record).to receive(:debitor_account).and_return(value)
+      instance.debitor_account
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:account).with(value).and_return('value')
+      expect(instance.debitor_account).to eq('value')
+    end
+  end
+
+  describe '#debitor_address' do
+    let(:value) { 1234 }
+    before do
+      allow(record).to receive(:debitor_address).and_return(value)
+    end
+
+    it 'calls record.debitor_address' do
+      expect(record).to receive(:debitor_address).and_return(value)
+      instance.debitor_address
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:multiline).with(value).and_return('value')
+      expect(instance.debitor_address).to eq('value')
+    end
+  end
+
+  describe '#message' do
+    let(:value) { 1234 }
+    before do
+      allow(record).to receive(:message).and_return(value)
+    end
+
+    it 'calls record.message' do
+      expect(record).to receive(:message).and_return(value)
+      instance.message
+    end
+
+    it 'uses LSVplus::FormattingHelper to format it' do
+      expect(LSVplus::FormattingHelper).to receive(:multiline).with(value).and_return('value')
+      expect(instance.message).to eq('value')
+    end
+  end
+
+  describe '#reference_type' do
+    it 'calls record.reference_type' do
+      expect(record).to receive(:reference_type).and_return('value')
+      expect(instance.reference_type).to eq('value')
+    end
+  end
+
+  describe '#reference' do
+    before do
+      allow(record).to receive(:reference).and_return('value')
+    end
+
+    it 'calls record.reference' do
+      expect(record).to receive(:reference).and_return('1' * 27)
+      expect(instance.reference).to eq('1' * 27)
+    end
+
+    it 'fills up the missing chars with spaces' do
+      expect(instance.reference).to eq('value                      ')
+    end
+  end
+
+  describe '#esr_member_id' do
+    before do
+      allow(record).to receive(:esr_member_id).and_return('value')
+    end
+
+    it 'calls record.esr_member_id' do
+      expect(record).to receive(:esr_member_id).and_return('1' * 9)
+      expect(instance.esr_member_id).to eq('1' * 9)
+    end
+
+    it 'fills up the missing chars with spaces' do
+      expect(instance.esr_member_id).to eq('value    ')
+    end
+  end
+end