valvat 0.4.7 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2422dd0589a6a76903426d5b4e738e3b3c66c9c8
+  data.tar.gz: 0f473b7a536cc5f8eb48a9071821e09f88f4e213
+SHA512:
+  metadata.gz: c871aec23db77c958785bb116b03348dd030946aeec3ed85b923b991fc98c084ebf146bda3a8a77459b411d556f14f39d8b0d612f758ec45122587999c2fc47e
+  data.tar.gz: ddea5c3424e6f95c39858a6d1b1ef418b9b9afc8f1d65ce17cdf189ea8106c3446136230159c322307dd71e337e58000254df5d6c980a62cefba344c775fb6e2

data/.rbenv-version

@@ -1 +1 @@
-1.9.3-p286
+2.0.0-p247

data/CHANGES.md

@@ -1,6 +1,13 @@
 ### dev
 
-[full changelog](http://github.com/yolk/valvat/compare/v0.4.7...master)
+[full changelog](http://github.com/yolk/valvat/compare/v0.5.0...master)
+
+### 0.5.0 / 2013-07-18
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.4.7...v0.5.0)
+
+* Added experimental checksum verification for 17 european countries (with help from [kirichkov](https://github.com/kirichkov))
+* Works now with current version of savon gem (2.2.0) (by [nevesenin](https://github.com/nevesenin))
 
 ### 0.4.7 / 2013-07-18
 

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :version => 2 do
+guard 'rspec' do
   watch(/^spec\/(.*)_spec.rb/)
   watch(/^lib\/(.*)\.rb/)          { |m| "spec/#{m[1]}_spec.rb" }
   watch(/^spec\/spec_helper.rb/)   { "spec" }

data/README.md

@@ -8,9 +8,10 @@ Validates european vat numbers. Standalone or as a ActiveModel validator.
 * Lookup via the VIES web service
 * (Optional) ActiveModel/Rails3 integration
 * Works standalone without ActiveModel
-* I18n locales for country specific error messages in english, german, swedish and bulgarian
+* I18n locales for country specific error messages in English, German, Swedish, Italian, Portuguese, Polish, Bulgarian, Romanian and Latvian.
+* *Experimental* checksum verification
 
-valvat is tested and works with ruby 1.8.7/1.9.3 and ActiveModel 3.2.9
+valvat is tested and works with ruby 1.8.7/1.9.3/2.0 and ActiveModel 3.2/4.0
 
 ## Installation
 
@@ -42,6 +43,22 @@ Or to lookup a vat number string directly via VIES web service:
     Valvat::Lookup.validate("DE345789003")
     => true or false or nil
 
+## Experimental checksum verification
+
+valvat allows to check vat numbers from AT, BE, BG, DE, DK, ES, FI, GR, IE, IT, LU, NL, PL, PT, SE and SI against a checksum calculation. All other countries will fall back to a simple syntax check:
+
+  Valvat.new("DE345789003").valid_checksum?
+  => true or false
+
+These results are more valuabel than a simple syntax check, but keep in mind: they can not replace a lookup via VIES.
+
+*IMPORTANT* This feature was tested against all vat numbers I could get my hand on, but it is still marked as *experimental* because these calculations are not documented and may return wrong results.
+
+To bypass initializing a Valvat instance:
+
+  Valvat::Checksum.validate("DE345789003")
+  => true or false
+
 ## Details & request identifier
 
 If you need all details and not only if the VAT is valid, pass {:detail => true} as second parameter to the lookup call.
@@ -93,6 +110,12 @@ By default this will validate to true if the VIES web service is down. To fail i
 
     validates :vat_number, :valvat => {:lookup => :fail_if_down}
 
+### Additional (and experimental) checksum validation
+
+To additionally perform a checksum validation:
+
+    validates :vat_number, :valvat => {:checksum => true}
+
 ### Additional ISO country code validation
 
 If you want the vat number’s (ISO) country to match another country attribute, use the _match_country_ option:
@@ -158,6 +181,8 @@ This basically just removes trailing spaces and ensures all chars are uppercase.
 
 ## Contributions by
 
+* [nevesenin](https://github.com/nevesenin)
+* [shaundaley39](https://github.com/shaundaley39)
 * [lcx](https://github.com/lcx)
 * [kirichkov](https://github.com/kirichkov)
 * [borodiychuk](https://github.com/borodiychuk)

data/lib/valvat.rb

@@ -10,6 +10,10 @@ class Valvat
     Valvat::Syntax.validate(self)
   end
 
+  def valid_checksum?
+    Valvat::Checksum.validate(self)
+  end
+
   def exists?(options={})
     Valvat::Lookup.validate(self, options)
   end
@@ -42,6 +46,7 @@ end
 
 require 'valvat/utils'
 require 'valvat/syntax'
+require 'valvat/checksum'
 require 'valvat/lookup'
 require 'valvat/lookup/request'
 require 'valvat/lookup/request_with_id'

data/lib/valvat/active_model.rb

@@ -17,7 +17,10 @@ module ActiveModel
         end
 
         if is_valid
-          is_valid = options[:lookup] ? vat.valid? && vat.exists? : vat.valid?
+          is_valid = vat.valid?
+
+          is_valid = vat.valid_checksum? if is_valid && options[:checksum]
+          is_valid = vat.exists? if is_valid && options[:lookup]
 
           if is_valid.nil?
             is_valid = options[:lookup] != :fail_if_down

data/lib/valvat/checksum.rb

@@ -0,0 +1,60 @@
+require 'valvat'
+
+class Valvat
+  module Checksum
+    ALGORITHMS = {}
+
+    def self.validate(vat)
+      vat = Valvat(vat)
+      algo = ALGORITHMS[vat.iso_country_code]
+      Valvat::Syntax.validate(vat) && !!(algo.nil? || algo.new(vat).validate)
+    end
+
+    class Base
+      def self.inherited(klass)
+        ALGORITHMS[klass.name.split(/::/).last] = klass
+      end
+
+      attr_reader :vat
+
+      def self.check_digit_length(len=nil)
+        @check_digit_length = len if len
+        @check_digit_length || 1
+      end
+
+      def initialize(vat)
+        @vat = vat
+      end
+
+      def validate
+        check_digit == given_check_digit
+      end
+
+      private
+
+      def given_check_digit_str
+        str_wo_country[-self.class.check_digit_length..-1]
+      end
+
+      def given_check_digit
+        given_check_digit_str.to_i
+      end
+
+      def figures_str
+        str_wo_country[0..-(self.class.check_digit_length+1)]
+      end
+
+      def figures
+        figures_str.split("").map(&:to_i)
+      end
+
+      def str_wo_country
+        vat.to_s_wo_country
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/checksum/*.rb"].each do |file|
+  require file
+end

data/lib/valvat/checksum/at.rb

@@ -0,0 +1,18 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class AT < Base
+      def check_digit
+        chk = 96 - figures.reverse.each_with_index.map do |fig, i|
+          (fig*(i.modulo(2) == 0 ? 1 : 2)).to_s.split("").inject(0) { |sum, n| sum + n.to_i }
+        end.inject(:+)
+        chk.to_s[-1].to_i
+      end
+
+      def str_wo_country
+        super[1..-1]
+      end
+    end
+  end
+end

data/lib/valvat/checksum/be.rb

@@ -0,0 +1,13 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class BE < Base
+      check_digit_length 2
+
+      def check_digit
+        97 - figures_str.to_i.modulo(97)
+      end
+    end
+  end
+end

data/lib/valvat/checksum/bg.rb

@@ -0,0 +1,61 @@
+class Valvat
+  module Checksum
+    class BG < Base
+      def check_digit
+        natural_person? ? check_digit_natural_person : check_digit_legal_person
+      end
+      
+      def check_digit_natural_person
+        local_person_chk = check_digit_local_natural_person
+
+        return local_person_chk if given_check_digit == local_person_chk
+        check_digit_foreign_natural_person
+      end
+      
+      def check_digit_local_natural_person
+        weight = [2, 4, 8, 5, 10, 9, 7, 3, 6]
+        chk = figures.map do |fig|
+          fig * weight.shift
+        end.inject(:+).modulo(11)
+        
+        return chk if chk < 10
+        return 0
+      end
+      
+      def check_digit_foreign_natural_person
+        weight = [21, 19, 17, 13, 11, 9, 7, 3, 1]
+
+        chk = figures.map do |fig|
+          fig * weight.shift
+        end.inject(:+).modulo(10)
+        
+        chk
+      end
+
+      def check_digit_legal_person
+        prod = 0
+        figures.each_with_index do |fig, index|
+          prod += (index + 1) * fig.to_i
+        end
+        
+        chk = prod % 11
+        
+        if chk == 10
+          prod = 0
+          figures.each_with_index do |fig, index|
+            prod += (index + 3) * fig.to_i
+          end
+          
+          chk = prod % 11
+          chk = 0 if chk == 10
+        end
+        
+        chk
+      end
+      
+      def natural_person?
+        vat.to_s_wo_country.length == 10
+      end
+    end
+  end
+end

data/lib/valvat/checksum/de.rb

@@ -0,0 +1,21 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class DE < Base
+      M = 10
+      N = 11
+
+      def check_digit
+        prod = M
+        figures.each do |fig|
+          sum = (prod + fig).modulo(M)
+          sum = M if sum == 0
+          prod = (2*sum).modulo(N)
+        end
+        chk = N - prod
+        chk == 10 ? 0 : chk
+      end
+    end
+  end
+end

data/lib/valvat/checksum/dk.rb

@@ -0,0 +1,20 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class DK < Base
+      check_digit_length 0
+
+      def check_digit
+        weight = [2, 7, 6, 5, 4, 3, 2, 1]
+        figures.map do |fig|
+          fig * weight.shift
+        end.inject(:+).modulo(11)
+      end
+
+      def given_check_digit
+        0
+      end
+    end
+  end
+end

data/lib/valvat/checksum/es.rb

@@ -0,0 +1,45 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class ES < Base
+      NATURAL_PERSON_CHARS       = %w(T R W A G M Y F P D X B N J Z S Q V H L C K E)
+      LEGAL_FOREIGN_PERSON_CHARS = [false] + %w(A B C D E F G H I J)
+
+      def check_digit
+        natural_person? ? check_digit_natural_person : check_digit_legal_person
+      end
+
+      def check_digit_natural_person
+        NATURAL_PERSON_CHARS[figures_str.to_i.modulo(23)]
+      end
+
+      def check_digit_legal_person
+        chk = 10 - figures.reverse.each_with_index.map do |fig, i|
+          (fig*(i.modulo(2) == 0 ? 2 : 1)).to_s.split("").inject(0) { |sum, n| sum + n.to_i }
+        end.inject(:+).modulo(10)
+        legal_foreign_person? ? 
+          LEGAL_FOREIGN_PERSON_CHARS[chk] : 
+          (chk == 10 ? 0 : chk)
+      end
+
+      def given_check_digit
+        natural_person? || legal_foreign_person? ? str_wo_country[-1] : super
+      end
+
+      def str_wo_country
+        str = super
+        str[0] =~ /\d/ ? str : str[1..-1]
+      end
+
+      def natural_person?
+        !!(vat.to_s_wo_country =~ /\A[\d]{8}[ABCDEFGHJKLMNPQRSTVWXYZ]\Z/) ||
+        !!(vat.to_s_wo_country =~ /\A[KLMX][\d]{7}[ABCDEFGHJKLMNPQRSTVWXYZ]\Z/)
+      end
+
+      def legal_foreign_person?
+        !!(vat.to_s_wo_country =~ /\A[NPQRSW][\d]{7}[ABCDEFGHIJ]\Z/)
+      end
+    end
+  end
+end

data/lib/valvat/checksum/fi.rb

@@ -0,0 +1,15 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class FI < Base
+      def check_digit
+        weight = [7, 9, 10, 5, 8, 4, 2]
+        chk = 11 - figures.map do |fig|
+          fig * weight.shift
+        end.inject(:+).modulo(11)
+        chk == 11 ? 0 : chk
+      end
+    end
+  end
+end

data/lib/valvat/checksum/gr.rb

@@ -0,0 +1,14 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class GR < Base
+      def check_digit
+        chk = figures.reverse.each_with_index.map do |fig, i|
+          fig*(2**(i+1))
+        end.inject(:+).modulo(11)
+        chk > 9 ? 0 : chk
+      end
+    end
+  end
+end

data/lib/valvat/checksum/ie.rb

@@ -0,0 +1,29 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class IE < Base
+      def check_digit
+        figures.reverse.each_with_index.map do |fig, i|
+          fig*(i+2)
+        end.inject(:+).modulo(23)
+      end
+
+      CHARS = "WABCDEFGHIJKLMNOPQRSTUV".split("")
+
+      def given_check_digit
+        CHARS.index(given_check_digit_str)
+      end
+
+      def str_wo_country
+        str = super
+        # Convert old irish vat format to new one
+        if str =~ /\A[0-9][A-Z][0-9]{5}[A-Z]\Z/
+          "0#{str[2..6]}#{str[0]}#{str[7]}"
+        else
+          str
+        end
+      end
+    end
+  end
+end

data/lib/valvat/checksum/it.rb

@@ -0,0 +1,22 @@
+require 'valvat/checksum'
+
+class Valvat
+  module Checksum
+    class IT < Base
+      def validate
+        # IT02762750210
+        y = figures_str[7..9].to_i
+        y >= 1 && (y <= 100 || [120, 121].include?(y)) &&
+        figures_str[0..6] != "0000000" &&
+        super
+      end
+
+      def check_digit
+        chk = 10 - figures.reverse.each_with_index.map do |fig, i|
+          (fig*(i.modulo(2) == 0 ? 2 : 1)).to_s.split("").inject(0) { |sum, n| sum + n.to_i }
+        end.inject(:+).modulo(10)
+        chk == 10 ? 0 : chk
+      end
+    end
+  end
+end