valvat 0.8.2 → 1.1.0

data/lib/valvat/checksum/fi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class FI < Base
@@ -10,4 +12,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/fr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class FR < Base
@@ -5,10 +7,10 @@ class Valvat
         siren = str_wo_country[2..-1].to_i
         (12 + (3 * siren) % 97) % 97
       end
-      
+
       def given_check_digit
         str_wo_country[0..1].to_i
       end
     end
   end
-end
+end

data/lib/valvat/checksum/gb.rb

@@ -1,34 +1,66 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class GB < Base
-      OLD_FORMAT_FORBIDDEN_RANGES = [(100_000..999_999), (9_490_001..9_700_000), (9_990_001..9_999_999)]
-      NEW_FORMAT_FORBIDDEN_RANGES = [(1..100_000), (100_001..1_000_000)]
-
-      def validate
-        vat_number = vat.to_s_wo_country
-        check_sum  = vat.to_s_wo_country[7..8].to_i
-        vat_base = vat_number[0..6]
+      OLD_FORMAT_FORBIDDEN_RANGES = [(100_000..999_999), (9_490_001..9_700_000), (9_990_001..9_999_999)].freeze
+      NEW_FORMAT_FORBIDDEN_RANGES = [(1..100_000), (100_001..1_000_000)].freeze
+      GOV_NUMBER = /\A(GD[0-4]{1}\d{2})\Z/.freeze
+      HEALTH_NUMBER = /\A(HA[5-9]{1}\d{2})\Z/.freeze
 
+      def validate # rubocop:disable Metrics/CyclomaticComplexity
         # government departments and health authorities, so no checksum
-        return true if vat_number =~ /\A(GD[0-4]{1}\d{2})\Z/ || vat_number =~ /\A(HA[5-9]{1}\d{2})\Z/
-        return false if vat_number =~ /\A0{9}\Z/ || vat_number =~ /\A0{12}\Z/
+        return true if gov_or_health?
+        return false if all_zero?
+
+        return false if old_format_remainder.zero? && fobidden_in_old_format?
+        return false if new_format_remainder.zero? && fobidden_in_new_format?
+
+        old_format_remainder.zero? || new_format_remainder.zero?
+      end
+
+      private
+
+      def checksum
+        @checksum ||= str_wo_country[7..8].to_i
+      end
+
+      def vat_base
+        @vat_base ||= str_wo_country[0..6]
+      end
 
-        vat_base_sum = vat_base.split('').
-          map(&:to_i).
-          zip([8, 7, 6, 5, 4, 3, 2]).
-          map { |vat_number_digit, multiplier| vat_number_digit * multiplier }.
-          inject(:+)
+      def gov_or_health?
+        str_wo_country =~ GOV_NUMBER || str_wo_country =~ HEALTH_NUMBER
+      end
 
-        old_format_remainder = (vat_base_sum + check_sum).modulo(97)
-        new_format_remainder = (vat_base_sum + 55 + check_sum).modulo(97)
+      def all_zero?
+        str_wo_country =~ /\A0{9}\Z/ || str_wo_country =~ /\A0{12}\Z/
+      end
 
-        return false if old_format_remainder == 0 &&
-          OLD_FORMAT_FORBIDDEN_RANGES.any? { |range| range.include? vat_base.to_i }
+      def vat_base_sum
+        @vat_base_sum ||= vat_base.split('')
+                                  .map(&:to_i)
+                                  .zip([8, 7, 6, 5, 4, 3, 2])
+                                  .map { |vat_number_digit, multiplier| vat_number_digit * multiplier }
+                                  .inject(:+)
+      end
 
-        return false if new_format_remainder == 0 &&
-          NEW_FORMAT_FORBIDDEN_RANGES.any? { |range| range.include? vat_base.to_i }
+      def old_format_remainder
+        @old_format_remainder ||= (vat_base_sum + checksum).modulo(97)
+      end
+
+      def new_format_remainder
+        @new_format_remainder ||= (vat_base_sum + 55 + checksum).modulo(97)
+      end
+
+      def fobidden_in_new_format?
+        vat_base_int = vat_base.to_i
+        NEW_FORMAT_FORBIDDEN_RANGES.any? { |range| range.include?(vat_base_int) }
+      end
 
-        old_format_remainder == 0 || new_format_remainder == 0
+      def fobidden_in_old_format?
+        vat_base_int = vat_base.to_i
+        OLD_FORMAT_FORBIDDEN_RANGES.any? { |range| range.include?(vat_base_int) }
       end
     end
   end

data/lib/valvat/checksum/gr.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class GR < Base
       def check_digit
         chk = sum_figures_by do |fig, i|
-          fig*(2**(i+1))
+          fig * (2**(i + 1))
         end.modulo(11)
         chk > 9 ? 0 : chk
       end
     end
   end
-end
+end

data/lib/valvat/checksum/hr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class HR < Base

data/lib/valvat/checksum/hu.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class HU < Base

data/lib/valvat/checksum/ie.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class IE < Base
       def check_digit
         total = sum_figures_by do |fig, i|
-          fig*(i+2)
-        end
-        if str_wo_country.size == 9
-          total += (CHARS.index(str_wo_country[8]) * 9)
+          fig * (i + 2)
         end
+        total += ((CHARS.index(str_wo_country[8]) || 0) * 9) if str_wo_country.size == 9
         total.modulo(23)
       end
 
-      CHARS = "WABCDEFGHIJKLMNOPQRSTUV".split("")
+      CHARS = 'WABCDEFGHIJKLMNOPQRSTUV'.split('')
 
       def given_check_digit
         if str_wo_country.size == 9
@@ -38,7 +38,6 @@ class Valvat
           super
         end
       end
-
     end
   end
 end

data/lib/valvat/checksum/it.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class IT < Base
       def validate
         y = figures_str[7..9].to_i
         y >= 1 && (y <= 100 || [120, 121].include?(y)) &&
-        figures_str[0..6] != "0000000" &&
-        super
+          figures_str[0..6] != '0000000' &&
+          super
       end
 
       def check_digit
-        chk = 10 - sum_of_figures_for_at_es_it_se(true).modulo(10)
+        chk = 10 - sum_of_figures_for_at_es_it_se(reverse_ints: true).modulo(10)
         chk == 10 ? 0 : chk
       end
     end
   end
-end
+end

data/lib/valvat/checksum/lt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class LT < Base

data/lib/valvat/checksum/lu.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class LU < Base
@@ -8,4 +10,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/mt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class MT < Base

data/lib/valvat/checksum/nl.rb

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class NL < Base
+      def validate
+        vat.to_s.gsub(/[A-Z]/) { |let| (let.ord - 55).to_s }.to_i % 97 == 1 ||
+          super
+      end
+
       def check_digit
         sum_figures_by do |fig, i|
-          fig*(i+2)
+          fig * (i + 2)
         end.modulo(11)
       end
 
@@ -12,4 +19,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/pl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class PL < Base
@@ -9,4 +11,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/pt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class PT < Base
@@ -7,4 +9,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/ro.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class RO < Base

data/lib/valvat/checksum/se.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class SE < Base
       check_digit_length 0
 
       def validate
-        vat.to_s_wo_country[-2..-1].to_i > 0 &&
-        super
+        vat.to_s_wo_country[-2..-1].to_i.positive? &&
+          super
       end
 
       private
@@ -23,4 +25,4 @@ class Valvat
       end
     end
   end
-end
+end

data/lib/valvat/checksum/si.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 class Valvat
   module Checksum
     class SI < Base
       def validate
-        figures_str.to_i > 999999 &&
-        super
+        figures_str.to_i > 999_999 &&
+          super
       end
 
       def check_digit

data/lib/valvat/error.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Valvat
+  Error = Class.new(RuntimeError)
+
+  class ViesError < Error
+    def initialize(faultstring = 'UNKNOWN')
+      @faultstring = faultstring
+      super
+    end
+
+    def to_s
+      "The VIES web service returned the error '#{@faultstring}'."
+    end
+
+    def eql?(other)
+      to_s.eql?(other.to_s)
+    end
+  end
+  ViesMaintenanceError = Class.new(ViesError)
+
+  ServiceUnavailable = Class.new(ViesMaintenanceError)
+  MemberStateUnavailable = Class.new(ViesMaintenanceError)
+
+  Timeout = Class.new(ViesError)
+  InvalidRequester = Class.new(ViesError)
+  BlockedError = Class.new(ViesError)
+  RateLimitError = Class.new(ViesError)
+
+  UnknownViesError = Class.new(ViesError)
+end

data/lib/valvat/local.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 class Valvat
   def initialize(raw)
-    @raw = Valvat::Utils.normalize(raw || "")
+    @raw = Valvat::Utils.normalize(raw || '')
     @vat_country_code, @to_s_wo_country = to_a
   end
 
   attr_reader :raw, :vat_country_code, :to_s_wo_country
 
   def blank?
-    raw.nil? || raw.strip == ""
+    raw.nil? || raw.strip == ''
   end
 
   def valid?
@@ -22,8 +24,9 @@ class Valvat
     Valvat::Utils.vat_country_to_iso_country(vat_country_code)
   end
 
+  # TODO: Remove method / not in use
   def european?
-    Valvat::Utils::EU_COUNTRIES.include?(iso_country_code)
+    Valvat::Utils::EU_MEMBER_STATES.include?(iso_country_code)
   end
 
   def to_a
@@ -35,11 +38,11 @@ class Valvat
   end
 
   def inspect
-    "#<Valvat #{[raw, iso_country_code].compact.join(" ")}>"
+    "#<Valvat #{[raw, iso_country_code].compact.join(' ')}>"
   end
 end
 
-def Valvat(vat)
+def Valvat(vat) # rubocop:disable Naming/MethodName
   vat.is_a?(Valvat) ? vat : Valvat.new(vat)
 end
 

data/lib/valvat/locales/de.yml

@@ -1,7 +1,8 @@
 de:
   errors:
     messages:
-      invalid_vat: ist keine gültige %{country_adjective} USt-IdNr.
+      invalid_vat: "ist keine gültige %{country_adjective} USt-IdNr."
+      vies_down: "Die USt-IdNr. kann nicht überprüft werden: der VIES-Webservice ist nicht verfügbar. Bitte später noch einmal versuchen."
   valvat:
     country_adjectives:
       eu: europäische

data/lib/valvat/locales/en.yml

@@ -1,7 +1,8 @@
 en:
   errors:
     messages:
-      invalid_vat: is not a valid %{country_adjective} vat number
+      invalid_vat: "is not a valid %{country_adjective} VAT number"
+      vies_down: "Unable to validate your VAT number: the VIES service is down. Please try again later."
   valvat:
     country_adjectives:
       eu: European

data/lib/valvat/locales/es.yml

@@ -2,6 +2,7 @@ es:
   errors:
     messages:
       invalid_vat: no es un número de IVA intracomunitario %{country_adjective} válido
+      vies_down: "No se ha podido validar su número de IVA: El servicio VIES no está disponible, por favor inténtelo más tarde."
   valvat:
     country_adjectives:
       eu: europeo

data/lib/valvat/locales/fr.yml

@@ -2,32 +2,33 @@ fr:
   errors:
     messages:
       invalid_vat: "Numéro de TVA %{country_adjective} invalide"
+      vies_down: "Impossible de valider votre numéro de TVA : le service de validation VIES est indisponible. Merci de réessayer ultérieurement."
   valvat:
     country_adjectives:
       eu: intracommunautaire
-      at: autrichienne
+      at: autrichien
       be: belge
       bg: bulgare
       cy: chypriote
       cz: tchèque
-      de: allemande
-      dk: danoise
+      de: allemand
+      dk: danois
       ee: estonien
-      es: espagnole
-      fi: finlandaise
-      fr: française
+      es: espagnol
+      fi: finlandais
+      fr: français
       gb: britannique
-      gr: grèque
-      ie: irlandaise
-      it: italienne
-      lt: lituanienne
-      lu: luxembourgeoise
-      lv: lettone
+      gr: grec
+      ie: irlandais
+      it: italien
+      lt: lituanien
+      lu: luxembourgeois
+      lv: letton
       mt: maltais
-      nl: hollandaise
-      pl: polonaise
-      pt: portugaise
-      ro: roumaine
-      se: suédoise
+      nl: hollandais
+      pl: polonais
+      pt: portugais
+      ro: roumain
+      se: suédois
       si: slovène
       sk: slovaque