lsv-plus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67b0dced0cbb671ce675eec190846010d2f54112
+  data.tar.gz: df55a6632071da0acd5cd8246585d8df817b2233
+SHA512:
+  metadata.gz: fcf542e1fc21da168312cc9d29738c7e2c9cd7b4edc93bea047146e0cdce830262c16bd78d6695a8a7991be30744ac37e67e7c8f7a4a76f8995df83358cdcdc6
+  data.tar.gz: f075b7d881fdc12bdd9e459b32bcd1fea36e637a8859c8bcf1f1d9728cc6cf513a7ed817c6a671d766a5b8e7a9816369e3ec9d0a945e2a5579139a55e3ec71c6

data/.gitignore

@@ -0,0 +1,2 @@
+spec/examples.txt
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    lsv-plus (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    coveralls (0.8.10)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    mime-types (2.99)
+    netrc (0.11.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rspec_junit_formatter (0.2.3)
+      builder (< 4)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (>= 0.8.10)
+  lsv-plus!
+  rake (~> 10.4)
+  rspec (~> 3.4.0)
+  rspec_junit_formatter (>= 0.2.2)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,69 @@
+# LSV+ [![Circle CI](https://circleci.com/gh/wtag/lsv-plus.svg?style=svg)](https://circleci.com/gh/wtag/lsv-plus) [![Code Climate](https://codeclimate.com/github/wtag/lsv-plus/badges/gpa.svg)](https://codeclimate.com/github/wtag/lsv-plus) [![Coverage Status](https://coveralls.io/repos/wtag/lsv-plus/badge.svg?branch=master&service=github)](https://coveralls.io/github/wtag/lsv-plus?branch=master)
+
+Create LSV+ files with ease.
+
+## Setup
+
+Add the gem to your project:
+
+```ruby
+gem 'lsv-plus'
+```
+
+Run bundle to install:
+
+```shell
+$ bundle install
+```
+
+## Usage
+
+To create a new LSV+ file, follow the steps below.
+
+```ruby
+# instantiate a new LSV+ file
+file = LSVplus::File.new(
+  creator_identification: 'WTAGI',
+  currency: 'CHF',
+  processing_type: 'P',
+  creation_date: Date.today,
+  lsv_identification: 'WT001',
+)
+
+# add some records to the file
+record1 = LSVplus::Record.new(
+  processing_date: Date.today + 1,
+  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',
+)
+file.add_record record1
+
+record2 = LSVplus::Record.new(
+  processing_date: Date.today + 1,
+  creditor_bank_clearing_number: 1337,
+  amount: BigDecimal.new('42.10'),
+  debitor_bank_clearing_number: 1337,
+  creditor_iban: 'CH9300762011623852957',
+  creditor_address: ['Fancy AG', 'Funnystreet 42'],
+  debitor_account: '455.24401-AB',
+  debitor_address: ['Customer 77', 'Bubu Av', 'New Lala City'],
+  message: ['Invoice 42 via BDD'],
+  reference_type: 'B',
+  reference: '030000SWAGFEEFORYOLO',
+  esr_member_id: nil,
+)
+file.add_record record2
+
+# generate the LSV+ file and return it as a string
+file.to_s
+# => "8750P201601071337 2016010642   WTAGI0000001WT001CHF000001337,42CH9300762011623852957             Fancy AG                           Funnystreet 42                                                                                           123.456-78XY                      Debit AG                           Other Street 1337                  Somewhere City                                                        Invoice 133 via BDD                                                                                                                         A200002000000004443332000061133742   8750P201601071337 201601061337 WTAGI0000002WT001CHF000000042,10CH9300762011623852957             Fancy AG                           Funnystreet 42                                                                                           455.24401-AB                      Customer 77                        Bubu Av                            New Lala City                                                         Invoice 42 via BDD                                                                                                                          B030000SWAGFEEFORYOLO                890020160106WTAGI0000002CHF000001379,52"
+```

data/bin/lsv-plus

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift './lib'
+
+require 'irb'
+require 'lsv-plus'
+
+IRB.start

data/lib/lsv-plus.rb

@@ -0,0 +1 @@
+require 'lsv_plus'

data/lib/lsv_plus.rb

@@ -0,0 +1,7 @@
+require 'date'
+
+module LSVplus
+end
+
+require 'lsv_plus/file'
+require 'lsv_plus/record'

data/lib/lsv_plus/base_container.rb

@@ -0,0 +1,47 @@
+require 'lsv_plus/errors'
+
+module LSVplus
+  class BaseContainer
+    class UnknownAttribute < LSVplus::Errors::Base
+      def initialize(attribute)
+        @attribute = attribute
+      end
+
+      def to_s
+        "Attribute #{@attribute} is unknown"
+      end
+    end
+
+    class MissingAttribute < LSVplus::Errors::Base
+      def initialize(attribute)
+        @attribute = attribute
+      end
+
+      def to_s
+        "Attribute :#{@attribute} is missing"
+      end
+    end
+
+    def initialize(attributes)
+      validate attributes
+      set_attributes attributes
+    end
+
+    def validate(attributes)
+      validate_presence_of_required_attributes(attributes)
+    end
+
+    def set_attributes(attributes)
+      attributes.each do |key, value|
+        raise UnknownAttribute, key unless self.class::ATTRIBUTES.include?(key)
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def validate_presence_of_required_attributes(attributes)
+      self.class::ATTRIBUTES.each do |attribute|
+        raise MissingAttribute, attribute unless attributes.key?(attribute)
+      end
+    end
+  end
+end

data/lib/lsv_plus/errors.rb

@@ -0,0 +1,14 @@
+module LSVplus
+  module Errors
+    class Base < StandardError; end
+    class InvalidAttribute < Base
+      def initialize(reason)
+        @reason = reason
+      end
+
+      def to_s
+        "Attribute #{self.class::ATTRIBUTE} is invalid: #{@reason}"
+      end
+    end
+  end
+end

data/lib/lsv_plus/file.rb

@@ -0,0 +1,68 @@
+require 'lsv_plus/errors'
+require 'lsv_plus/base_container'
+require 'lsv_plus/record_formatter'
+require 'lsv_plus/total_record_formatter'
+
+module LSVplus
+  class File < LSVplus::BaseContainer
+    class InvalidCreatorIdentification < LSVplus::Errors::InvalidAttribute
+      ATTRIBUTE = :creator_identification
+    end
+    class InvalidLSVIdentification < LSVplus::Errors::InvalidAttribute
+      ATTRIBUTE = :lsv_identification
+    end
+
+    ATTRIBUTES = %i(processing_type creation_date creator_identification currency lsv_identification)
+    FIVE_CHARS_UPPERCASE = /\A[A-Z0-9]{5}\z/
+
+    attr_reader(*ATTRIBUTES)
+
+    def add_record(record)
+      records << record
+    end
+
+    def records
+      @records ||= []
+    end
+
+    def to_s
+      records_as_string + total_record
+    end
+
+    def records_as_string
+      output = StringIO.new
+      records.each_with_index do |record, index|
+        index += 1
+        output.write RecordFormatter.call(self, record, index)
+      end
+      output.rewind
+      output.read
+    end
+
+    def total_record
+      TotalRecordFormatter.call(self)
+    end
+
+    def total
+      records.inject(BigDecimal.new(0)) { |sum, record| sum + record.amount }
+    end
+
+    def validate(attributes)
+      super(attributes)
+      validate_creator_identification(attributes)
+      validate_lsv_identification(attributes)
+    end
+
+    def validate_creator_identification(attributes)
+      unless attributes[:creator_identification] =~ FIVE_CHARS_UPPERCASE
+        raise InvalidCreatorIdentification, "Does not match #{FIVE_CHARS_UPPERCASE}"
+      end
+    end
+
+    def validate_lsv_identification(attributes)
+      unless attributes[:lsv_identification] =~ FIVE_CHARS_UPPERCASE
+        raise InvalidLSVIdentification, "Does not match #{FIVE_CHARS_UPPERCASE}"
+      end
+    end
+  end
+end

data/lib/lsv_plus/formatting_helper.rb

@@ -0,0 +1,34 @@
+module LSVplus
+  module FormattingHelper
+    DATE_FORMAT = '%Y%m%d'
+
+    def self.date(date)
+      date.strftime DATE_FORMAT
+    end
+
+    def self.index(index)
+      format '%07d', index
+    end
+
+    def self.amount(amount)
+      format('%012.2f', amount).sub('.', ',')
+    end
+
+    def self.multiline(lines)
+      lines_string = StringIO.new
+      4.times do |index|
+        lines_string.write format('%-35s', lines[index])
+      end
+      lines_string.rewind
+      lines_string.read
+    end
+
+    def self.account(account)
+      format '%-34s', account
+    end
+
+    def self.clearing_number(number)
+      format '%-5s', number
+    end
+  end
+end

data/lib/lsv_plus/record.rb

@@ -0,0 +1,57 @@
+require 'bigdecimal'
+require 'lsv_plus/base_container'
+require 'lsv_plus/errors'
+
+module LSVplus
+  class Record < LSVplus::BaseContainer
+    class InvalidProcessingDate < LSVplus::Errors::InvalidAttribute
+      ATTRIBUTE = :processing_date
+    end
+    class InvalidAmount < LSVplus::Errors::InvalidAttribute
+      ATTRIBUTE = :amount
+    end
+
+    ATTRIBUTES = %i(
+      type version
+      creditor_bank_clearing_number creditor_iban creditor_address
+      debitor_bank_clearing_number debitor_account debitor_address
+      amount message processing_date
+      reference_type reference esr_member_id
+    )
+
+    TYPE = '875'
+    VERSION = '0'
+    MAX_AMOUNT = BigDecimal.new('99_999_999.99')
+    PROCESSING_MAX_IN_FUTURE = 30
+    PROCESSING_MAX_IN_PAST = 10
+
+    attr_reader(*ATTRIBUTES)
+
+    def initialize(attributes)
+      attributes = attributes.merge type: TYPE, version: VERSION
+      validate attributes
+      super attributes
+    end
+
+    def validate(attributes)
+      super(attributes)
+      validate_processing_date(attributes)
+      validate_amount(attributes)
+    end
+
+    def validate_processing_date(attributes)
+      if Date.today + PROCESSING_MAX_IN_FUTURE < attributes[:processing_date]
+        raise InvalidProcessingDate, "Max #{PROCESSING_MAX_IN_FUTURE} days in future"
+      end
+      if Date.today - PROCESSING_MAX_IN_PAST > attributes[:processing_date]
+        raise InvalidProcessingDate, "Max #{PROCESSING_MAX_IN_PAST} days in past"
+      end
+    end
+
+    def validate_amount(attributes)
+      if attributes[:amount] > MAX_AMOUNT
+        raise InvalidAmount, "Must not be higher than #{MAX_AMOUNT}"
+      end
+    end
+  end
+end

data/lib/lsv_plus/record_formatter.rb

@@ -0,0 +1,110 @@
+require 'lsv_plus/formatting_helper'
+
+module LSVplus
+  class RecordFormatter
+    attr_reader :file, :record, :output
+
+    def self.call(file, record, index)
+      new(file, record, index).call
+    end
+
+    def initialize(file, record, index)
+      @file = file
+      @record = record
+      @index = index
+      @output = StringIO.new
+    end
+
+    def call
+      [
+        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
+
+    def type
+      record.type
+    end
+
+    def version
+      record.version
+    end
+
+    def processing_type
+      file.processing_type
+    end
+
+    def processing_date
+      LSVplus::FormattingHelper.date record.processing_date
+    end
+
+    def creditor_bank_clearing_number
+      LSVplus::FormattingHelper.clearing_number record.creditor_bank_clearing_number
+    end
+
+    def creation_date
+      LSVplus::FormattingHelper.date file.creation_date
+    end
+
+    def debitor_bank_clearing_number
+      LSVplus::FormattingHelper.clearing_number record.debitor_bank_clearing_number
+    end
+
+    def creator_identification
+      file.creator_identification
+    end
+
+    def record_number
+      LSVplus::FormattingHelper.index @index
+    end
+
+    def lsv_identification
+      file.lsv_identification
+    end
+
+    def currency
+      file.currency
+    end
+
+    def amount
+      LSVplus::FormattingHelper.amount record.amount
+    end
+
+    def creditor_iban
+      LSVplus::FormattingHelper.account record.creditor_iban
+    end
+
+    def creditor_address
+      LSVplus::FormattingHelper.multiline record.creditor_address
+    end
+
+    def debitor_account
+      LSVplus::FormattingHelper.account record.debitor_account
+    end
+
+    def debitor_address
+      LSVplus::FormattingHelper.multiline record.debitor_address
+    end
+
+    def message
+      LSVplus::FormattingHelper.multiline record.message
+    end
+
+    def reference_type
+      record.reference_type
+    end
+
+    def reference
+      format '%-27s', record.reference
+    end
+
+    def esr_member_id
+      format '%-9s', record.esr_member_id
+    end
+  end
+end