valvat 1.0.1 → 1.1.3

data/lib/valvat/checksum/gb.rb

@@ -1,51 +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)]
-      GOV_NUMBER = /\A(GD[0-4]{1}\d{2})\Z/
-      HEALTH_NUMBER = /\A(HA[5-9]{1}\d{2})\Z/
-
-      def validate
-        vat_number = vat.to_s_wo_country
+      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 gov_or_health?(vat_number)
-        return false if all_zero?(vat_number)
+        return true if gov_or_health?
+        return false if all_zero?
 
-        checksum  = vat_number[7..8].to_i
-        vat_base = vat_number[0..6]
-        vat_base_int = vat_base.to_i
-        vat_base_sum = generate_vat_base_sum(vat_base)
+        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 = (vat_base_sum + checksum).modulo(97)
-        new_format_remainder = (vat_base_sum + 55 + checksum).modulo(97)
+        old_format_remainder.zero? || new_format_remainder.zero?
+      end
 
-        return false if old_format_remainder == 0 &&
-          OLD_FORMAT_FORBIDDEN_RANGES.any? { |range| range.include? vat_base_int }
+      private
 
-        return false if new_format_remainder == 0 &&
-          NEW_FORMAT_FORBIDDEN_RANGES.any? { |range| range.include? vat_base_int }
+      def checksum
+        @checksum ||= str_wo_country[7..8].to_i
+      end
 
-        old_format_remainder == 0 || new_format_remainder == 0
+      def vat_base
+        @vat_base ||= str_wo_country[0..6]
       end
 
-      private
+      def gov_or_health?
+        str_wo_country =~ GOV_NUMBER || str_wo_country =~ HEALTH_NUMBER
+      end
 
-      def gov_or_health?(vat_number)
-        vat_number =~ GOV_NUMBER || vat_number =~ HEALTH_NUMBER
+      def all_zero?
+        str_wo_country =~ /\A0{9}\Z/ || str_wo_country =~ /\A0{12}\Z/
       end
 
-      def all_zero?(vat_number)
-        vat_number =~ /\A0{9}\Z/ || vat_number =~ /\A0{12}\Z/
+      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
 
-      def generate_vat_base_sum(vat_base)
-        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 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
+
+      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]) || 0)  * 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
+        y >= 1 && (y <= 100 || [120, 121, 999].include?(y)) &&
+          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,14 +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
+          super
       end
 
       def check_digit
         sum_figures_by do |fig, i|
-          fig*(i+2)
+          fig * (i + 2)
         end.modulo(11)
       end
 
@@ -17,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/checksum.rb

@@ -1,21 +1,11 @@
+# frozen_string_literal: true
+
 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)
+      def self.check_digit_length(len = nil)
         @check_digit_length = len if len
         @check_digit_length || 1
       end
@@ -39,44 +29,50 @@ class Valvat
       end
 
       def figures_str
-        str_wo_country[0..-(self.class.check_digit_length+1)]
+        str_wo_country[0..-(self.class.check_digit_length + 1)]
       end
 
       def figures
-        figures_str.split("").map(&:to_i)
+        figures_str.split('').map(&:to_i)
       end
 
       def str_wo_country
         vat.to_s_wo_country
       end
 
-      def sum_figures_by
-        figures.reverse.each_with_index.map do |fig, i|
-          yield(fig, i)
-        end.inject(:+)
+      def sum_figures_by(&block)
+        figures.reverse.each_with_index.map(&block).inject(:+)
       end
 
       def sum_of_squares(num)
-        num.to_s.split("").map(&:to_i).inject(:+)
+        num.to_s.split('').map(&:to_i).inject(:+)
       end
 
-      def sum_of_figures_for_at_es_it_se(reverse_ints=false)
+      def sum_of_figures_for_at_es_it_se(reverse_ints: false)
         ints = reverse_ints ? [2, 1] : [1, 2]
         sum_figures_by do |fig, i|
-          sum_of_squares(fig*(i.modulo(2) == 0 ? ints[0] : ints[1]))
+          sum_of_squares(fig * (i.modulo(2).zero? ? ints[0] : ints[1]))
         end
       end
 
       def sum_of_figues_for_pt_si
         11 - sum_figures_by do |fig, i|
-          fig*(i+2)
+          fig * (i + 2)
         end.modulo(11)
       end
     end
+
+    def self.validate(vat)
+      vat = Valvat(vat)
+      algo = ALGORITHMS[vat.iso_country_code]
+      Valvat::Syntax.validate(vat) && !!(algo.nil? || algo.new(vat).validate)
+    end
+
+    ALGORITHMS = Dir[File.join(__dir__, 'checksum', '*.rb')].each_with_object({}) do |path, algos|
+      require path.gsub(/\.rb$/, '')
+
+      classname = File.basename(path, '.rb').upcase
+      algos[classname] = ['Valvat', 'Checksum', classname].inject(Object, :const_get)
+    end.freeze
   end
 end
-
-Dir[File.join(File.dirname(__FILE__), 'checksum', '*.rb')].each do |path|
-  # On Ruby 2.1.0 ActiveSupport goes mad if you pass it paths with .rb at the end
-  require path.gsub(/\.rb$/, '')
-end

data/lib/valvat/error.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 class Valvat
   Error = Class.new(RuntimeError)
 
   class ViesError < Error
-    def initialize(faultstring='UNKNOWN')
-      @faultstring = faultstring
+    def initialize(faultstring = 'UNKNOWN', exception = nil)
+      @faultstring = faultstring || exception.inspect
+      @exception = exception
+      super(faultstring)
     end
 
     def to_s
@@ -19,6 +23,8 @@ class Valvat
   ServiceUnavailable = Class.new(ViesMaintenanceError)
   MemberStateUnavailable = Class.new(ViesMaintenanceError)
 
+  OperationUnknown = Class.new(ViesError)
+  HTTPError = Class.new(ViesError)
   Timeout = Class.new(ViesError)
   InvalidRequester = Class.new(ViesError)
   BlockedError = Class.new(ViesError)

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?
@@ -36,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,6 +2,7 @@ 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

data/lib/valvat/locales/hu.yml

@@ -2,6 +2,7 @@ hu:
   errors:
     messages:
       invalid_vat: a közösségi adószám %{country_adjective} helytelen
+      vies_down: "Az adószám ellenőrzése sikertelen: a VIES szolgáltatás nem elérhető. Kérjük próbálja újra később."
   valvat:
     country_adjectives:
       eu: európai

data/lib/valvat/locales/nl.yml

@@ -2,6 +2,7 @@ nl:
   errors:
     messages:
       invalid_vat: is geen geldig %{country_adjective} btw nummer
+      vies_down: "We kunnen uw btw-nummer niet bevestigen: de VIES-service is momenteel niet beschikbaar. Probeer het later opnieuw."
   valvat:
     country_adjectives:
       eu: Europees

data/lib/valvat/locales/pl.yml

@@ -2,6 +2,7 @@ pl:
   errors:
     messages:
       invalid_vat: nie jest prawidłowym %{country_adjective} numerem VAT
+      vies_down: "Nie można zweryfikować numeru VAT: serwis VIES nie działa. Spróbuj ponownie później."
   valvat:
     country_adjectives:
       eu: europejskim

data/lib/valvat/lookup/fault.rb

@@ -1,30 +1,38 @@
+# frozen_string_literal: true
+
 class Valvat
   class Lookup
     class Fault < Response
-      private
+      def to_hash
+        @to_hash ||= case @raw
+        when Savon::HTTPError
+          { error: HTTPError.new(nil, @raw) }
+        when Savon::UnknownOperationError
+          { error: OperationUnknown.new(nil, @raw) }
+        else
+          fault = @raw.to_hash[:fault][:faultstring]
 
-      def self.cleanup(hash)
-        fault = hash[:fault][:faultstring]
-        return {valid: false} if fault == "INVALID_INPUT"
-        {error: fault_to_error(fault)}
+          if fault == 'INVALID_INPUT'
+            { valid: false }
+          else
+            error = (FAULTS[fault] || UnknownViesError).new(fault)
+            { error: error }
+          end
+        end
       end
 
       FAULTS = {
-        "SERVICE_UNAVAILABLE" => ServiceUnavailable,
-        "MS_UNAVAILABLE" => MemberStateUnavailable,
-        "INVALID_REQUESTER_INFO" => InvalidRequester,
-        "TIMEOUT" => Timeout,
-        "VAT_BLOCKED" => BlockedError,
-        "IP_BLOCKED" => BlockedError,
-        "GLOBAL_MAX_CONCURRENT_REQ" => RateLimitError,
-        "GLOBAL_MAX_CONCURRENT_REQ_TIME" => RateLimitError,
-        "MS_MAX_CONCURRENT_REQ" => RateLimitError,
-        "MS_MAX_CONCURRENT_REQ_TIME" => RateLimitError
-      }
-
-      def self.fault_to_error(fault)
-        (FAULTS[fault] || UnknownViesError).new(fault)
-      end
+        'SERVICE_UNAVAILABLE' => ServiceUnavailable,
+        'MS_UNAVAILABLE' => MemberStateUnavailable,
+        'INVALID_REQUESTER_INFO' => InvalidRequester,
+        'TIMEOUT' => Timeout,
+        'VAT_BLOCKED' => BlockedError,
+        'IP_BLOCKED' => BlockedError,
+        'GLOBAL_MAX_CONCURRENT_REQ' => RateLimitError,
+        'GLOBAL_MAX_CONCURRENT_REQ_TIME' => RateLimitError,
+        'MS_MAX_CONCURRENT_REQ' => RateLimitError,
+        'MS_MAX_CONCURRENT_REQ_TIME' => RateLimitError
+      }.freeze
     end
   end
-end
+end

data/lib/valvat/lookup/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'savon'
 
 class Valvat
@@ -12,13 +14,11 @@ class Valvat
       end
 
       def perform
-        begin
-          Response.new(
-            client.call(action, message: message, message_tag: message_tag)
-          )
-        rescue Savon::SOAPFault => fault
-          Fault.new(fault)
-        end
+        Response.new(
+          client.call(action, message: message, message_tag: message_tag, soap_action: nil)
+        )
+      rescue Savon::SOAPFault, Savon::HTTPError, Savon::UnknownOperationError => e
+        Fault.new(e)
       end
 
       private
@@ -30,14 +30,10 @@ class Valvat
       end
 
       def message
-        {
-          country_code: @vat.vat_country_code,
-          vat_number: @vat.to_s_wo_country
-        }.merge(@requester ? {
-            requester_country_code: @requester.vat_country_code,
-            requester_vat_number: @requester.to_s_wo_country
-          } : {}
-        )
+        add_requester({
+                        country_code: @vat.vat_country_code,
+                        vat_number: @vat.to_s_wo_country
+                      })
       end
 
       def message_tag
@@ -47,6 +43,15 @@ class Valvat
       def action
         @requester ? :check_vat_approx : :check_vat
       end
+
+      def add_requester(message)
+        return message unless @requester
+
+        message[:requester_country_code] = @requester.vat_country_code
+        message[:requester_vat_number]   = @requester.to_s_wo_country
+
+        message
+      end
     end
   end
-end
+end