virtuaaliviivakoodi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b85d1b0fc4e30a2da977685ca951701d0c476afe
+  data.tar.gz: 5cd8c6c11476f693a9eabfcfe405a53dbdcbbbe2
+SHA512:
+  metadata.gz: 627cdfd3622a2eeb7e1de580d160dcfb8dcba92e6e16c407fedc5f7ad593c831eba17ce0db35263cda823459d2881a7feaf14657499f71263cd0d7c48b9af287
+  data.tar.gz: c39e096ab250576b29c554711f9c0b0ec745dd6766ad3de409048fa4ce322d2334023fe04b466b14871908bdfa6b66a3ea135f726cb14a36c78894caf5943160

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in virtuaaliviivakoodi.gemspec
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# Virtuaaliviivakoodi
+
+Virtuaaliviivakoodi is a library for generating Pankkiviivakoodi of The Federation of Finnish Financial Services ("Finnish bank transfer barcode"). Implementation has been done following [the specification](http://www.finanssiala.fi/maksujenvalitys/dokumentit/Pankkiviivakoodi-opas.pdf).
+
+The library supports both current versions of Pankkiviivakoodi, version 4 (reference number in national form) and version 5 (reference number in international form, aka Creditor Reference based on ISO 11649).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "virtuaaliviivakoodi"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virtuaaliviivakoodi
+
+## Usage
+
+```ruby
+Virtuaaliviivakoodi.generate({
+  iban: "FI37 1590 3000 0007 76",
+  reference: 11112,
+  amount: 12.25,
+  due_date: "161221"
+}) #=> "437159030000007760000122500000000000000000011112161221"
+```
+
+## 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/kiskolabs/virtuaaliviivakoodi.
+
+## Thanks
+
+Akseli Nurmio for his JavaScript library [virtuaaliviivakoodi](https://github.com/akselinurmio/virtuaaliviivakoodi) from which this library has borrowed bunch of test cases.

data/Rakefile

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

data/bin/console

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

@@ -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/virtuaaliviivakoodi/amount_normalizer.rb

@@ -0,0 +1,28 @@
+module Virtuaaliviivakoodi
+  class AmountNormalizer
+    def self.call(value)
+      amount = value.to_f
+
+      if amount
+        raise(ArgumentError, "Amount is negative") if (amount < 0)
+        raise(ArgumentError, "Amount is too large, maximum is 999999.99") if (amount > 999999.99)
+
+        decimals = digits_after_decimal_point(amount)
+        raise(ArgumentError, "There can't be more than two decimals") if decimals > 2
+
+        euros, cents = sprintf("%0.02f", amount).split(".")
+
+        Virtuaaliviivakoodi.pad(euros, 6) + cents
+      else
+        Virtuaaliviivakoodi.pad("", 8)
+      end
+    end
+
+    private
+
+    def self.digits_after_decimal_point(f)
+      sign, digits, base, exponent = BigDecimal(f.to_s).split
+      digits.length - exponent
+    end
+  end
+end

data/lib/virtuaaliviivakoodi/due_date_normalizer.rb

@@ -0,0 +1,19 @@
+module Virtuaaliviivakoodi
+  DUE_DATE_PATTERN = /^[0-9]{6}$/
+
+  class DueDateNormalizer
+    def self.call(due_date)
+      if due_date
+        if due_date.respond_to?(:strftime)
+          due_date.strftime("%y%m%d")
+        else
+          raise ArgumentError, "Due date is not valid" if (!due_date.to_s.match(DUE_DATE_PATTERN))
+
+          due_date
+        end
+      else
+        Virtuaaliviivakoodi.pad("", 6)
+      end
+    end
+  end
+end

data/lib/virtuaaliviivakoodi/generator.rb

@@ -0,0 +1,53 @@
+require "bigdecimal"
+require "iban-tools"
+require "virtuaaliviivakoodi/iban_normalizer"
+require "virtuaaliviivakoodi/reference_normalizer"
+require "virtuaaliviivakoodi/due_date_normalizer"
+require "virtuaaliviivakoodi/amount_normalizer"
+
+module Virtuaaliviivakoodi
+  class Generator
+    attr_reader :iban, :reference, :amount, :due_date
+
+    def initialize(iban:, reference:, amount: nil, due_date: nil)
+      @iban = iban
+      @reference = reference
+      @amount = amount
+      @due_date = due_date
+    end
+
+    def call
+      reference_to_version + normalized_iban + normalized_amount + Virtuaaliviivakoodi.pad(normalized_reference, 23) + normalized_due_date
+    end
+
+    private
+
+    def normalized_due_date
+      Virtuaaliviivakoodi::DueDateNormalizer.call(due_date)
+    end
+
+    def normalized_iban
+      Virtuaaliviivakoodi::IBANNormalizer.call(iban)
+    end
+
+    def normalized_reference
+      Virtuaaliviivakoodi::ReferenceNormalizer.call(reference)
+    end
+
+    def normalized_amount
+      Virtuaaliviivakoodi::AmountNormalizer.call(amount)
+    end
+
+    def reference_to_version
+      if normalized_reference.size == 23
+        # international
+        "5"
+      elsif normalized_reference.size == 20
+        # national
+        "4"
+      else
+        raise ArgumentError, "Given reference is not of proper length. Should be either 23 or 20 characters long."
+      end
+    end
+  end
+end

data/lib/virtuaaliviivakoodi/iban_normalizer.rb

@@ -0,0 +1,13 @@
+module Virtuaaliviivakoodi
+  class IBANNormalizer
+    def self.call(iban)
+      iban_validator = IBANTools::IBAN.new(iban)
+
+      raise(ArgumentError, "IBAN is not valid") unless iban_validator.validation_errors.empty?
+      raise(ArgumentError, "IBAN is not Finnish") unless iban_validator.country_code == "FI"
+
+      # No country code
+      iban_validator.code[2..-1]
+    end
+  end
+end

data/lib/virtuaaliviivakoodi/reference_normalizer.rb

@@ -0,0 +1,20 @@
+module Virtuaaliviivakoodi
+  class ReferenceNormalizer
+    REFERENCE_INTERNATIONAL_PATTERN = /^RF[0-9]{3,23}$/
+    REFERENCE_NATIONAL_PATTERN = /^[0-9]{4,20}$/
+
+    def self.call(reference)
+      reference_without_whitespace = reference.to_s.gsub(/\s/, "")
+      case reference_without_whitespace
+      when REFERENCE_INTERNATIONAL_PATTERN
+        # Pad everything after checksum
+        reference_without_whitespace[2..3] + Virtuaaliviivakoodi.pad(reference_without_whitespace[4..-1], 21)
+      when REFERENCE_NATIONAL_PATTERN
+        # Pad everything
+        Virtuaaliviivakoodi.pad(reference_without_whitespace, 20)
+      else
+        raise ArgumentError, "Reference is not valid"
+      end
+    end
+  end
+end

data/lib/virtuaaliviivakoodi/version.rb

@@ -0,0 +1,3 @@
+module Virtuaaliviivakoodi
+  VERSION = "0.1.0"
+end

data/lib/virtuaaliviivakoodi.rb

@@ -0,0 +1,17 @@
+require "virtuaaliviivakoodi/version"
+require "virtuaaliviivakoodi/generator"
+
+module Virtuaaliviivakoodi
+  # Takes parameters and returns virtuaaliviivakoodi as a String.
+  def self.generate(**arguments)
+    Generator.new(**arguments).call
+  end
+
+  def self.pad(value, wanted_length)
+    value = value.to_s
+    raise(ArgumentError, "Value is #{value.size} characters long, maximum being #{wanted_length}") if (value.size > wanted_length)
+
+    value.rjust(wanted_length, "0")
+  end
+end
+

data/virtuaaliviivakoodi.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'virtuaaliviivakoodi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "virtuaaliviivakoodi"
+  spec.version       = Virtuaaliviivakoodi::VERSION
+  spec.authors       = ["Vesa Vänskä"]
+  spec.email         = ["vesa@vesavanska.com"]
+
+  spec.summary       = %q{Creates virtuaaliviivakoodi}
+  spec.description   = %q{Creates virtuaaliviivakoodi}
+  spec.homepage      = "https://github.com/kiskolabs/virtuaaliviivakoodi"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "iban-tools", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: virtuaaliviivakoodi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vesa Vänskä
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iban-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Creates virtuaaliviivakoodi
+email:
+- vesa@vesavanska.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/virtuaaliviivakoodi.rb
+- lib/virtuaaliviivakoodi/amount_normalizer.rb
+- lib/virtuaaliviivakoodi/due_date_normalizer.rb
+- lib/virtuaaliviivakoodi/generator.rb
+- lib/virtuaaliviivakoodi/iban_normalizer.rb
+- lib/virtuaaliviivakoodi/reference_normalizer.rb
+- lib/virtuaaliviivakoodi/version.rb
+- virtuaaliviivakoodi.gemspec
+homepage: https://github.com/kiskolabs/virtuaaliviivakoodi
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Creates virtuaaliviivakoodi
+test_files: []