valvat-core 0.0.1

data/lib/valvat/syntax.rb

@@ -0,0 +1,41 @@
+class Valvat
+  module Syntax
+
+    VAT_PATTERNS = {
+        'AT' => /\AATU[0-9]{8}\Z/,                                          # Austria
+        'BE' => /\ABE0[0-9]{9}\Z/,                                          # Belgium
+        'BG' => /\ABG[0-9]{9,10}\Z/,                                        # Bulgaria
+        'CY' => /\ACY[0-9]{8}[A-Z]\Z/,                                      # Cyprus
+        'CZ' => /\ACZ[0-9]{8,10}\Z/,                                        # Czech Republic
+        'DE' => /\ADE[0-9]{9}\Z/,                                           # Germany
+        'DK' => /\ADK[0-9]{8}\Z/,                                           # Denmark
+        'EE' => /\AEE[0-9]{9}\Z/,                                           # Estonia
+        'GR' => /\AEL[0-9]{9}\Z/,                                           # Greece
+        'ES' => /\AES([A-Z][0-9]{8}|[0-9]{8}[A-Z]|[A-Z][0-9]{7}[A-Z])\Z/,   # Spain
+        'FI' => /\AFI[0-9]{8}\Z/,                                           # Finland
+        'FR' => /\AFR[A-Z0-9]{2}[0-9]{9}\Z/,                                # France
+        'GB' => /\AGB([0-9]{9}|[0-9]{12}|(HA|GD)[0-9]{3})\Z/,               # United Kingdom
+        'HR' => /\AHR[0-9]{11}\Z/,                                          # Croatia
+        'HU' => /\AHU[0-9]{8}\Z/,                                           # Hungary
+        'IE' => /\AIE([0-9][A-Z][0-9]{5}|[0-9]{7}[A-Z]?)[A-Z]\Z/,           # Ireland
+        'IT' => /\AIT[0-9]{11}\Z/,                                          # Italy
+        'LT' => /\ALT([0-9]{9}|[0-9]{12})\Z/,                               # Lithuania
+        'LU' => /\ALU[0-9]{8}\Z/,                                           # Luxembourg
+        'LV' => /\ALV[0-9]{11}\Z/,                                          # Latvia
+        'MT' => /\AMT[0-9]{8}\Z/,                                           # Malta
+        'NL' => /\ANL[0-9]{9}B[0-9]{2}\Z/,                                  # Netherlands
+        'PL' => /\APL[0-9]{10}\Z/,                                          # Poland
+        'PT' => /\APT[0-9]{9}\Z/,                                           # Portugal
+        'RO' => /\ARO[1-9][0-9]{1,9}\Z/,                                    # Romania
+        'SE' => /\ASE[0-9]{10}01\Z/,                                        # Sweden
+        'SI' => /\ASI[0-9]{8}\Z/,                                           # Slovenia
+        'SK' => /\ASK[0-9]{10}\Z/                                           # Slovakia
+      }
+
+    def self.validate(vat)
+      vat = Valvat(vat)
+      pattern = VAT_PATTERNS[vat.iso_country_code]
+      !!(pattern && pattern =~ vat.to_s)
+    end
+  end
+end

data/lib/valvat/utils.rb

@@ -0,0 +1,27 @@
+class Valvat
+  module Utils
+
+    EU_COUNTRIES = %w(AT BE BG CY CZ DE DK EE ES FI FR GB GR HR HU IE IT LT LU LV MT NL PL PT RO SE SI SK)
+    COUNTRY_PATTERN = /\A([A-Z]{2})(.+)\Z/
+    NORMALIZE_PATTERN = /[-\.:_\s,;]+/
+
+    def self.split(vat)
+      COUNTRY_PATTERN =~ vat
+      result = [$1, $2]
+      iso_country = vat_country_to_iso_country(result[0])
+      EU_COUNTRIES.include?(iso_country) ? result : [nil, nil]
+    end
+
+    def self.normalize(vat)
+      vat.to_s.upcase.gsub(NORMALIZE_PATTERN, "")
+    end
+
+    def self.vat_country_to_iso_country(vat_country)
+      vat_country == "EL" ? "GR" : vat_country
+    end
+
+    def self.iso_country_to_vat_country(iso_country)
+      iso_country == "GR" ? "EL" : iso_country
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+
+require File.dirname(__FILE__) + '/../lib/valvat.rb'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.backtrace_exclusion_patterns = [/rspec\/(core|expectations)/]
+end
+

data/spec/valvat/syntax_spec.rb

@@ -0,0 +1,287 @@
+require 'spec_helper'
+
+describe Valvat::Syntax do
+  describe "#validate" do
+    it "validates a DE vat number" do
+      expect(subject.validate("DE345889003")).to eql(true)
+
+      expect(subject.validate("DE34588900")).to eql(false)
+      expect(subject.validate("DE3458890090")).to eql(false)
+      expect(subject.validate("DE34588900C")).to eql(false)
+    end
+
+    it "validates a AT vat number" do
+      expect(subject.validate("ATU03458890")).to eql(true)
+
+      expect(subject.validate("ATU034588908")).to eql(false)
+      expect(subject.validate("ATU0345908")).to eql(false)
+      expect(subject.validate("ATU0345889Y")).to eql(false)
+    end
+
+    it "should validate BE vat number" do
+      expect(subject.validate("BE0817331995")).to eql(true)
+
+      expect(subject.validate("BE081733199")).to eql(false)
+      expect(subject.validate("BE08173319944")).to eql(false)
+      expect(subject.validate("BE081733199H")).to eql(false)
+      expect(subject.validate("BE1817331999")).to eql(false)
+    end
+
+    it "validates a BG vat number" do
+      expect(subject.validate("BG468134789")).to eql(true)
+      expect(subject.validate("BG4681347897")).to eql(true)
+
+      expect(subject.validate("BG46813478979")).to eql(false)
+      expect(subject.validate("BG4681347897C")).to eql(false)
+      expect(subject.validate("BG46813478G")).to eql(false)
+      expect(subject.validate("BG46813478")).to eql(false)
+    end
+
+    it "validates a CY vat number" do
+      expect(subject.validate("CY36579347A")).to eql(true)
+      expect(subject.validate("CY36579347C")).to eql(true)
+
+      expect(subject.validate("CY36579347")).to eql(false)
+      expect(subject.validate("CY365793478")).to eql(false)
+      expect(subject.validate("CY365793478A")).to eql(false)
+      expect(subject.validate("CY365793G")).to eql(false)
+    end
+
+    it "validates a DK vat number" do
+      expect(subject.validate("DK67893463")).to eql(true)
+
+      expect(subject.validate("DK678934637")).to eql(false)
+      expect(subject.validate("DK6789346")).to eql(false)
+      expect(subject.validate("DK6789346H")).to eql(false)
+    end
+
+    it "validates a ES vat number" do
+      expect(subject.validate("ESX67345987")).to eql(true)
+      expect(subject.validate("ESA6734598B")).to eql(true)
+      expect(subject.validate("ES56734598C")).to eql(true)
+
+      expect(subject.validate("ES167345987")).to eql(false)
+      expect(subject.validate("ESX6734598")).to eql(false)
+      expect(subject.validate("ESX673459890")).to eql(false)
+    end
+
+    it "validates a EE vat number" do
+      expect(subject.validate("EE678678456")).to eql(true)
+      expect(subject.validate("EE6786784560")).to eql(false)
+      expect(subject.validate("EE67867845")).to eql(false)
+      expect(subject.validate("EE67867845K")).to eql(false)
+    end
+
+    it "validates a FI vat number" do
+      expect(subject.validate("FI67845638")).to eql(true)
+
+      expect(subject.validate("FI678456389")).to eql(false)
+      expect(subject.validate("FI6784563")).to eql(false)
+      expect(subject.validate("FI6784563K")).to eql(false)
+    end
+
+    it "validates a FR vat number" do
+      expect(subject.validate("FR99123543267")).to eql(true)
+      expect(subject.validate("FRBB123543267")).to eql(true)
+      expect(subject.validate("FR9B123543267")).to eql(true)
+      expect(subject.validate("FRB9123543267")).to eql(true)
+
+      expect(subject.validate("FR99123543267B")).to eql(false)
+      expect(subject.validate("FRBB12354326")).to eql(false)
+      expect(subject.validate("FR9B123543F67")).to eql(false)
+      expect(subject.validate("FRB9123543")).to eql(false)
+    end
+
+    it "validates a EL vat number" do
+      expect(subject.validate("EL678456345")).to eql(true)
+
+      expect(subject.validate("EL67845634")).to eql(false)
+      expect(subject.validate("EL6784563459")).to eql(false)
+      expect(subject.validate("EL67845634P")).to eql(false)
+    end
+
+    it "validates a HU vat number" do
+      expect(subject.validate("HU67894595")).to eql(true)
+
+      expect(subject.validate("HU6789459")).to eql(false)
+      expect(subject.validate("HU67894595L")).to eql(false)
+      expect(subject.validate("HU6789459J")).to eql(false)
+    end
+
+    it "validates a HR vat number" do
+      expect(subject.validate("HR12345678912")).to eql(true)
+
+      expect(subject.validate("HR6789459")).to eql(false)
+      expect(subject.validate("HR67894595L")).to eql(false)
+      expect(subject.validate("HR6789459J")).to eql(false)
+    end
+
+    it "validates a IE vat number" do
+      expect(subject.validate("IE1B12345J")).to eql(true)
+      expect(subject.validate("IE1234567B")).to eql(true)
+      expect(subject.validate("IE1234567XX")).to eql(true)
+
+      expect(subject.validate("IE1B123459")).to eql(false)
+      expect(subject.validate("IE19123450")).to eql(false)
+      expect(subject.validate("IEA9123450")).to eql(false)
+      expect(subject.validate("IE1B12345XX")).to eql(false)
+      expect(subject.validate("IE1X34567XX")).to eql(false)
+    end
+
+    it "validates a IT vat number" do
+      expect(subject.validate("IT45875359285")).to eql(true)
+
+      expect(subject.validate("IT458753592859")).to eql(false)
+      expect(subject.validate("IT4587535928G")).to eql(false)
+      expect(subject.validate("IT4587535928")).to eql(false)
+    end
+
+    it "validates a LV vat number" do
+      expect(subject.validate("LV85678368906")).to eql(true)
+
+      expect(subject.validate("LV8567836890")).to eql(false)
+      expect(subject.validate("LV856783689066")).to eql(false)
+      expect(subject.validate("LV8567836890S")).to eql(false)
+    end
+
+    it "validates a LT vat number" do
+      expect(subject.validate("LT678678987")).to eql(true)
+      expect(subject.validate("LT678678987956")).to eql(true)
+
+      expect(subject.validate("LT67867898")).to eql(false)
+      expect(subject.validate("LT6786789870")).to eql(false)
+      expect(subject.validate("LT678678987K")).to eql(false)
+      expect(subject.validate("LT67867898709")).to eql(false)
+      expect(subject.validate("LT6786789870C")).to eql(false)
+      expect(subject.validate("LT67867898795H")).to eql(false)
+    end
+
+    it "validates a LU vat number" do
+      expect(subject.validate("LU45679456")).to eql(true)
+
+      expect(subject.validate("LU4567945")).to eql(false)
+      expect(subject.validate("LU456794560")).to eql(false)
+      expect(subject.validate("LU4567945J")).to eql(false)
+    end
+
+    it "validates a MT vat number" do
+      expect(subject.validate("MT64569367")).to eql(true)
+
+      expect(subject.validate("MT6456936")).to eql(false)
+      expect(subject.validate("MT645693679")).to eql(false)
+      expect(subject.validate("MT6456936L")).to eql(false)
+    end
+
+    it "validates a NL vat number" do
+      expect(subject.validate("NL673739491B77")).to eql(true)
+
+      expect(subject.validate("NL673739491977")).to eql(false)
+      expect(subject.validate("NL673739491A77")).to eql(false)
+      expect(subject.validate("NL673739491B771")).to eql(false)
+      expect(subject.validate("NL673739491B7")).to eql(false)
+      expect(subject.validate("NL6737394917B7")).to eql(false)
+    end
+
+    it "validates a PL vat number" do
+      expect(subject.validate("PL6784567284")).to eql(true)
+
+      expect(subject.validate("PL678456728")).to eql(false)
+      expect(subject.validate("PL67845672849")).to eql(false)
+      expect(subject.validate("PL678456728K")).to eql(false)
+    end
+
+    it "validates a PT vat number" do
+      expect(subject.validate("PT346296476")).to eql(true)
+
+      expect(subject.validate("PT34629647")).to eql(false)
+      expect(subject.validate("PT3462964769")).to eql(false)
+    end
+
+    it "validates a GB vat number" do
+      expect(subject.validate("GB123456789")).to eql(true)
+      expect(subject.validate("GB123456789012")).to eql(true)
+      expect(subject.validate("GBGD123")).to eql(true)
+      expect(subject.validate("GBHA123")).to eql(true)
+
+      expect(subject.validate("GB12345678")).to eql(false)
+      expect(subject.validate("GB1234567890")).to eql(false)
+      expect(subject.validate("GB12345678901")).to eql(false)
+      expect(subject.validate("GB1234567890123")).to eql(false)
+      expect(subject.validate("GBAB123")).to eql(false)
+      expect(subject.validate("GBAA123")).to eql(false)
+      expect(subject.validate("GBHH123")).to eql(false)
+      expect(subject.validate("GBGD1234")).to eql(false)
+      expect(subject.validate("GBGD12")).to eql(false)
+    end
+
+    it "validates a RO vat number" do
+      expect(subject.validate("RO1234567890")).to eql(true)
+      expect(subject.validate("RO123456789")).to eql(true)
+      expect(subject.validate("RO12345678")).to eql(true)
+      expect(subject.validate("RO1234567")).to eql(true)
+      expect(subject.validate("RO123456")).to eql(true)
+      expect(subject.validate("RO12345")).to eql(true)
+      expect(subject.validate("RO1234")).to eql(true)
+      expect(subject.validate("RO123")).to eql(true)
+      expect(subject.validate("RO12")).to eql(true)
+
+      expect(subject.validate("RO1")).to eql(false)
+      expect(subject.validate("RO0234567890")).to eql(false)
+      expect(subject.validate("RO023456789")).to eql(false)
+      expect(subject.validate("RO02345678")).to eql(false)
+      expect(subject.validate("RO0234567")).to eql(false)
+      expect(subject.validate("RO023456")).to eql(false)
+      expect(subject.validate("RO02345")).to eql(false)
+      expect(subject.validate("RO0234")).to eql(false)
+      expect(subject.validate("RO023")).to eql(false)
+      expect(subject.validate("RO02")).to eql(false)
+      expect(subject.validate("RO12345678901")).to eql(false)
+    end
+
+    it "validates a SK vat number" do
+      expect(subject.validate("SK5683075682")).to eql(true)
+
+      expect(subject.validate("SK56830756821")).to eql(false)
+      expect(subject.validate("SK568307568")).to eql(false)
+    end
+
+    it "validates a SI vat number" do
+      expect(subject.validate("SI74357893")).to eql(true)
+
+      expect(subject.validate("SI743578931")).to eql(false)
+      expect(subject.validate("SI7435789")).to eql(false)
+    end
+
+    it "validates a SE vat number" do
+      expect(subject.validate("SE567396352701")).to eql(true)
+
+      expect(subject.validate("SE56739635201")).to eql(false)
+      expect(subject.validate("SE5673963527701")).to eql(false)
+      expect(subject.validate("SE567396352702")).to eql(false)
+      expect(subject.validate("SE567396352711")).to eql(false)
+    end
+
+    it "validates a CZ vat number" do
+      expect(subject.validate("CZ56389267")).to eql(true)
+      expect(subject.validate("CZ563892670")).to eql(true)
+      expect(subject.validate("CZ5638926790")).to eql(true)
+
+      expect(subject.validate("CZ5638926")).to eql(false)
+      expect(subject.validate("CZ56389268901")).to eql(false)
+    end
+
+    it "returns false on blank/non-sense vat number" do
+      expect(subject.validate("")).to eql(false)
+      expect(subject.validate(" ")).to eql(false)
+      expect(subject.validate("DE")).to eql(false)
+      expect(subject.validate("atu123xyz")).to eql(false)
+      expect(subject.validate("xxxxxxxxxx")).to eql(false)
+      expect(subject.validate("BEFR")).to eql(false)
+    end
+
+    it "allows Valvat instance as input" do
+      expect(subject.validate(Valvat.new("DE345889003"))).to eql(true)
+      expect(subject.validate(Valvat.new("DE34588900X"))).to eql(false)
+    end
+  end
+end

data/spec/valvat/utils_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Valvat::Utils do
+  describe "#split" do
+    it "returns country and rest on vat number as array" do
+      expect(Valvat::Utils.split("DE345889003")).to eql(["DE", "345889003"])
+      expect(Valvat::Utils.split("ESX4588900X")).to eql(["ES", "X4588900X"])
+    end
+
+    it "returns two nils on non-european iso codes as array" do
+      expect(Valvat::Utils.split("US345889003")).to eql([nil, nil])
+      expect(Valvat::Utils.split("RUX4588900X")).to eql([nil, nil])
+    end
+
+    it "returns two nils on non-sense input as array" do
+      expect(Valvat::Utils.split("DE")).to eql([nil, nil])
+      expect(Valvat::Utils.split("X345889003")).to eql([nil, nil])
+      expect(Valvat::Utils.split("")).to eql([nil, nil])
+      expect(Valvat::Utils.split("1234")).to eql([nil, nil])
+      expect(Valvat::Utils.split(" ")).to eql([nil, nil])
+    end
+
+    it "returns EL (language iso code) on greek vat" do
+      expect(Valvat::Utils.split("EL999999999")).to eql(["EL", "999999999"])
+    end
+  end
+
+  describe "#normalize" do
+    it "returns vat number with upcase chars" do
+      expect(Valvat::Utils.normalize("de345889003")).to eql("DE345889003")
+      expect(Valvat::Utils.normalize("EsX4588900y")).to eql("ESX4588900Y")
+    end
+
+    it "returns trimmed vat number" do
+      expect(Valvat::Utils.normalize(" DE345889003")).to eql("DE345889003")
+      expect(Valvat::Utils.normalize("  DE345889003  ")).to eql("DE345889003")
+      expect(Valvat::Utils.normalize("DE345889003 ")).to eql("DE345889003")
+    end
+
+    it "does not change already normalized vat numbers" do
+      expect(Valvat::Utils.normalize("DE345889003")).to eql("DE345889003")
+      expect(Valvat::Utils.normalize("ESX4588900X")).to eql("ESX4588900X")
+    end
+
+    it "removes spaces" do
+      expect(Valvat::Utils.normalize("DE 345889003")).to eql("DE345889003")
+      expect(Valvat::Utils.normalize("ESX  458 8900 X")).to eql("ESX4588900X")
+    end
+
+    it "removes special chars" do
+      expect(Valvat::Utils.normalize("DE.345-889_00:3,;")).to eql("DE345889003")
+    end
+  end
+
+  describe "#vat_country_to_iso_country" do
+    it "returns iso country code on greek iso language 'EL'" do
+      expect(Valvat::Utils.vat_country_to_iso_country("EL")).to eql("GR")
+    end
+
+    Valvat::Utils::EU_COUNTRIES.each do |iso|
+      it "returns unchanged iso country code '#{iso}'" do
+        expect(Valvat::Utils.vat_country_to_iso_country(iso)).to eql(iso)
+      end
+    end
+  end
+
+  describe "#iso_country_to_vat_country" do
+    it "returns vat country on greek iso country code 'GR'" do
+      expect(Valvat::Utils.iso_country_to_vat_country("GR")).to eql("EL")
+    end
+
+    Valvat::Utils::EU_COUNTRIES.reject{|c| c == "GR"}.each do |c|
+      it "returns unchanged vat country code '#{c}'" do
+        expect(Valvat::Utils.iso_country_to_vat_country(c)).to eql(c)
+      end
+    end
+  end
+end