bank_payments 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43707bdafa2f5e3084c528617a5d66b3e7d1552a
+  data.tar.gz: 9e0ce3837589276b89558e1e79e08827de49f24f
+SHA512:
+  metadata.gz: def9f02a0bde03a699e0e27b534861c9294edfb13cab2ae9190f33720aff866933c43a1c80fc2f9b59cf1ab5e899eacb6648757b119c3e3b5d5b2d7dfeb9d933
+  data.tar.gz: 7cbeaeb48a7a595e847160f59edd14048c09423546a88a0d811320666473232577c93bbfe895c47f7dc73829c6fa3d5b4cca39f3588adf24188d24e93892378c

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

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

data/.todo.reek

@@ -0,0 +1,3 @@
+---
+Attribute:
+  enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5
+after_success:
+  - "coveralls push"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bank_payments.gemspec
+gemspec
+
+gem 'byebug'
+gem 'yard'
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Litton, ApoEx AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# BankPayments
+
+[![Coverage Status](https://coveralls.io/repos/github/apoex/bank_payments/badge.svg?branch=master)](https://coveralls.io/github/apoex/bank_payments?branch=master)
+[![Build Status](https://travis-ci.org/apoex/bank_payments.svg?branch=master)](https://travis-ci.org/apoex/bank_payments)
+
+Ruby implementation of bank payments. Starting with
+
+* Swedbank International Payment, in SPISU-format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bank_payments'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bank_payments
+
+## International Payments
+
+Note that the Swedbank file is in an older format (SPISU). In about six months the Swedish standard will be based on ISO 20022 SEPA (Single Euro Payments Area). At the time of this writing (2016-08-09) there are two alternative gems for this standard:
+
+* [Ruby gem for creating SEPA XML files](https://github.com/salesking/sepa_king)
+* [SEPA ISO20022 XML message builder](https://github.com/conanite/sepa)
+
+When possible one should consider moving over to that standard instead.
+
+## Usage
+
+For anyone using a communications protocol to relay information from one party to another the important part is not the protocol itself. It's the information that needs to be sent. In order to send the information you need two pieces of information about the transaction: The beneciciary and the transactional data itself.
+
+**Create a beneficiary**
+
+```ruby
+b = BankPayments::Beneficiary.new do |b|
+  b.name         = 'Some company AO'
+  b.address      = 'Byvägen 12 731 00 Rala'
+  b.country_code = 'FI'
+  b.bank_id      = 'HELSFIHH'
+  b.account      = '10278'
+end
+```
+**Create a transaction**
+
+```ruby
+t = BankPayments::Transaction.new(
+  amount_sek:     100_000,
+  amount_foreign: 1_189_104.93,
+  currency:       'JPY',
+  message:        'Payment, Bill 99',
+  pay_date:       Date.new(2016,8,9),
+  reason:         101
+)
+```
+
+**Create a sequence, add payment and add it to a file**
+
+```ruby
+s = BankPayments::SwedbankExport::Sequence.new(account, name, address)
+s.add_transaction(b, t)
+
+f = BankPayments::SwedbankExport::File.new('file_name')
+f << s
+f.to_file_data
+```
+
+Download the result of `f.to_file_data` and upload it to the bank. The important part here is to setup the beneficiary and transactions correctly.
+
+Use `yard` to generate the gem documentation which will give you more information about the implementation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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/apoex/bank_payments.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bank_payments.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bank_payments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bank_payments"
+  spec.version       = BankPayments::VERSION
+  spec.authors       = ["Michael Litton"]
+  spec.email         = ["michael.litton@apoex.se"]
+
+  spec.summary       = "For generating payment files for various banks"
+  spec.homepage      = "https://github.com/apoex/bank_payments"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  unless spec.respond_to?(:metadata)
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+
+  # For IBAN validation
+  spec.add_runtime_dependency "ibandit", "~> 0.11"
+
+  # Ensure correct upcase for swedish characters. This wont be
+  # needed in Ruby 2.4
+  spec.add_runtime_dependency "unicode_utils", "~> 1.4"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bank_payments"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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

data/lib/bank_payments.rb

@@ -0,0 +1,42 @@
+require 'core_extensions/numeric/spisu'
+Numeric.include CoreExtensions::Numeric::SPISU
+
+require "bank_payments/version"
+require "bank_payments/beneficiary"
+require "bank_payments/transaction"
+require "bank_payments/spisu_record"
+
+require "bank_payments/swedbank_export/enums"
+require "bank_payments/swedbank_export/field_definition"
+require "bank_payments/swedbank_export/opening_record"
+require "bank_payments/swedbank_export/name_record"
+require "bank_payments/swedbank_export/address_record"
+require "bank_payments/swedbank_export/bank_record"
+require "bank_payments/swedbank_export/money_record"
+require "bank_payments/swedbank_export/credit_memo_record"
+require "bank_payments/swedbank_export/payment_record"
+require "bank_payments/swedbank_export/reason_record"
+require "bank_payments/swedbank_export/reconciliation_record"
+
+require "bank_payments/swedbank_export/sequence"
+require "bank_payments/swedbank_export/file"
+
+require "bank_payments/swedbank_import/sequence"
+require "bank_payments/swedbank_import/file"
+require "bank_payments/swedbank_import/amount_converter"
+
+require "bank_payments/swedbank_import/account_record"
+require "bank_payments/swedbank_import/address_record"
+require "bank_payments/swedbank_import/money_record"
+require "bank_payments/swedbank_import/name_record"
+require "bank_payments/swedbank_import/opening_record"
+require "bank_payments/swedbank_import/reconciliation_record"
+
+# Includes a simple representation of payments that can be serialized to a
+# number of different banks. At the time of this writing we'll start by
+# implementing the international payments for Swedbank.
+#
+# @author Michael Litton
+module BankPayments
+  # Your code goes here...
+end

data/lib/bank_payments/beneficiary.rb

@@ -0,0 +1,69 @@
+module BankPayments
+
+  # Encapulates all the information about the destination of a payment.
+  # We choose this class name since this is what Swedbank seems to call
+  # it on their english homepage. Another viable option is also "Payee".
+  #
+  # @author Michael Litton
+  class Beneficiary
+
+    # Required regular fields
+    attr_accessor :name, :address, :country_code
+
+    # The BIC (Bank Identification Code) for countires within EU
+    attr_accessor :bank_id
+
+    # Can be empty for European payments
+    attr_accessor :bank_name
+
+    # IBAN
+    attr_accessor :account
+
+    # Configuration used for the address record in Swedbank SPISU
+    attr_accessor :account_type, :cost_carrier, :priority
+
+    # Creates a new Beneficiary object with defaults for part of the
+    # Swedbank payments
+    def initialize
+      yield self if block_given?
+
+      # Set sensible defaults
+      @account_type ||= BankPayments::SwedbankExport::AccountType::CURRENCY_ACCOUNT
+      @cost_carrier ||= BankPayments::SwedbankExport::CostResponsibility::OWN_EXPENSES
+      @priority     ||= BankPayments::SwedbankExport::Priority::NORMAL
+    end
+
+    def eql?(other)
+      instance_values == other.instance_values
+    end
+
+    def hash
+      instance_values.hash
+    end
+
+    def instance_values
+      Hash[instance_variables.map do |variable|
+        [variable[1..-1], instance_variable_get(variable)]
+      end]
+    end
+
+    def to_spisu_records
+      name      = BankPayments::SwedbankExport::NameRecord.new
+      name.name = @name
+
+      address              = BankPayments::SwedbankExport::AddressRecord.new
+      address.address      = @address
+      address.country_code = @country_code
+      address.account_type = @account_type
+      address.cost_carrier = @cost_carrier
+      address.priority     = @priority
+
+      bank            = BankPayments::SwedbankExport::BankRecord.new
+      bank.bank_id    = @bank_id
+      bank.name       = @bank_name || ''
+      bank.account    = @account
+
+      [name, address, bank]
+    end
+  end
+end

data/lib/bank_payments/spisu_record.rb

@@ -0,0 +1,130 @@
+require 'ostruct'
+require 'unicode_utils/upcase'
+
+module BankPayments
+
+  # An "abstract" class that is used by records that conforms to the SPISU-format
+  # for Swedbank international payments. It's a flat file format that lets
+  # implementations easily describe each row similar to how the documentation is
+  # structured by the bank.
+  #
+  # @author Michael Litton
+  class SpisuRecord
+    def initialize(data = ' ' * 80)
+      @data   = data
+
+      yield self if block_given?
+    end
+
+    # Used to set the attributes in child records during
+    # initialization. An example definition is
+    #
+    # define_field :account, '2:9:N'
+    #
+    # which means that the account is available in position 2 to 9. The third
+    # part of the definition includes the format of the field which can be
+    #
+    # N: Numeric, zero pad to the left of the value
+    # AN: Alpha numeric, blank pad to the right of the value
+    #
+    # define_field :f1, '2:9:N'
+    # define_field :f2, '10:12:AN'
+    def self.define_field(field, definition)
+      field_class = BankPayments::SwedbankExport::FieldDefinition
+      (@fields ||= {})[field] = field_class.new(field, definition)
+    end
+
+    def self.defined_fields
+      @fields || {}
+    end
+
+    def self.definition_for(field)
+      @fields[field]
+    end
+
+    def set_text_value(start, stop, value)
+      value = UnicodeUtils.upcase(value, :sv)
+      set_value(start, stop, value, :ljust, ' ')
+    end
+
+    def set_numeric_value(start, stop, value)
+      set_value(start, stop, value, :rjust, '0')
+    end
+
+    def set_value(start, stop, value, direction = :ljust, padstr = ' ')
+      value   = serialize_value(value)
+      length  = stop - start + 1
+      @data[start-1,length] = value[0,length].send(direction, *[length, padstr])
+    end
+
+    def serialize_value(val)
+      if val.is_a?(Date)
+        val.strftime('%y%m%d')
+      else
+        val.to_s
+      end
+    end
+
+    def type=(type)
+      @data[0,1] = type.to_s
+    end
+
+    def type
+      @data[0,1]
+    end
+
+    def to_s
+      @data
+    end
+
+    # Attempts to handle serialization and deserialization of numeric and
+    # text values in the SPISU
+    def method_missing(method_name, *arguments, &block)
+      record_fields   = self.class.defined_fields.keys
+      requested_field = method_name.to_s.sub('=','').to_sym
+
+      if record_fields.include?(requested_field)
+        is_setter_field = method_name =~ /=/
+        definition      = self.class.definition_for(requested_field)
+
+        if is_setter_field
+          args = [definition.start, definition.stop, arguments.first]
+          case definition.type
+            when 'N'  then set_numeric_value(*args)
+            when 'AN' then set_text_value(*args)
+          end
+        else
+          extract_field_value(definition)
+        end
+      else
+        super
+      end
+    end
+
+    def extract_field_value(definition)
+      return_value = @data[definition.start-1, definition.length]
+      (return_value.sub(/^0+/, "") || return_value).strip
+    end
+
+    # Used in some child classes in order to construct a ruby Date
+    # from the the underlying data. Only used for imports of transaction
+    # confirmations
+    def extract_date(field)
+      value      = extract_raw_value(field)
+      parts      = value.scan(/\d{2}/)
+      Date.new(2000 + parts[0].to_i, parts[1].to_i, parts[2].to_i)
+    end
+
+    def extract_raw_value(field)
+      definition = self.class.definition_for(field.to_sym)
+      @data[definition.start-1, definition.length]
+    end
+
+    # Ensure that we include the defined fields in the parent but still
+    # allow them to be overwritten. We can't use @@fields because certain
+    # fields that share their name between classes will be overwritten
+    def self.inherited(base)
+      base.instance_variable_set(:@fields, @fields)
+    end
+  end
+end