europe 0.0.26 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f6e189312895736dcfbb848edb51298272702f0a051133ce1fa10ff0ca332e9
-  data.tar.gz: 772a816ac59d52a91428f94f998be5f42624a02c25698afea20c27789cb48071
+  metadata.gz: d0918fb1141de821b11aff7fb2d11da6ef7c75b2870e3b90a1373cfd26dc5fbe
+  data.tar.gz: f7b250f54690746d5339f6209625238461b7dd7edcc4d58adad5e095660186be
 SHA512:
-  metadata.gz: 0d5827fce7a70c52def8b0869bca24fa7688363925ebc3e5c74f52f2f15a7b1d51277515f8a95418cb31ea1efdfc9b3357f5d00c7580a5a54a6920e22d83c815
-  data.tar.gz: 7a5f8f4f1a5dac64cf8c449ab06a20751c73c8b86a0aa7b7eecc2f452b797435de303016886bc87bac6a8add7b5917e08da6441ded34a859ac90f6e897117d31
+  metadata.gz: f57c86ea54e7539887b3f8674035bca535379c5fcc1b532e4a995f0d67c3435f34e5195487db2ecabbbe6c3a0d1846ae70b232ce18ab9d2436dadd2bb7ef6864
+  data.tar.gz: d05a4f28813638f846d0e507c60e7f4f731d843914448c85b68ad3b4011f61784bb8dd15a501fd5bfdbd2c21c79ba7aa2692f47bece6701444dbf09bb77276a3

data/.rubocop.yml

@@ -16,3 +16,6 @@ Style/RedundantRegexpCharacterClass:
 
 Style/CaseLikeIf:
   Enabled: false
+
+Naming/PredicateMethod:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
+## 0.0.27
+  - Updated VIES VAT check service to their REST API instead of their SOAP API
+  - Improved error handling for the VAT check service
+  - Changed the endpoint to check for VAT rates to increase it's stability
+  - [Full Changelog](https://github.com/gem-shards/europe.rb/compare/v0.0.26...v0.0.27)
 ## 0.0.26
   - Removed spaces by default for VAT number format validations, as per request from tim-vandecasteele
   - [Full Changelog](https://github.com/gem-shards/europe.rb/compare/v0.0.25...v0.0.26)

data/lib/europe/vat/rates.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rexml/document'
+require 'json'
 
 module Europe
   module Vat
@@ -12,8 +12,10 @@ module Europe
         IT: 22.0, LT: 21.0, LU: 17.0, LV: 21.0, MT: 18.0, NL: 21.0, PL: 23.0, PT: 23.0,
         RO: 19.0, SE: 25.0, SI: 22.0, SK: 23.0
       }.freeze
-      RATES_URL = 'https://europa.eu/youreurope/business/taxation/vat' \
-                  '/vat-rules-rates/index_en.htm'
+      RATES_URL = 'https://raw.githubusercontent.com/benbucksch/eu-vat-rates' \
+                  '/refs/heads/master/rates.json'
+
+      COUNTRY_CODE_MAP = { GR: :EL }.freeze
 
       def self.retrieve
         resp = fetch_rates
@@ -22,33 +24,16 @@ module Europe
         extract_rates(resp)
       end
 
-      # rubocop:disable Metrics/MethodLength
       def self.extract_rates(resp)
+        data = JSON.parse(resp)
         rates = {}
-
-        begin
-          data = resp.scan(%r{\<tbody\>(.*)\<\/tbody\>}m).first.first.strip
-        rescue NoMethodError
-          return FALLBACK_RATES
-        end
-
-        xml = REXML::Document.new("<root>#{data}</root>")
-        xml.first.elements.each('tr') do |result|
-          next if result[3].nil?
-
-          rates = filter_rate(result, rates || {})
+        data['rates'].each do |code, info|
+          key = COUNTRY_CODE_MAP[code.to_sym] || code.to_sym
+          rates[key] = info['standard_rate'].to_f
         end
         rates
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def self.filter_rate(result, rates)
-        return unless result[1].text.size == 2
-
-        country = result[1].text
-        rate = result[5].text
-        rates[country.to_sym] = rate.to_f if country && rate
-        rates
+      rescue JSON::ParserError
+        FALLBACK_RATES
       end
 
       def self.fetch_rates

data/lib/europe/vat/vat.rb

@@ -4,77 +4,67 @@ require 'europe/vat/rates'
 require 'europe/vat/format'
 require 'uri'
 require 'net/http'
-require 'rexml/document'
+require 'json'
 require 'date'
 
 # Europe Gem
 module Europe
   # VAT
   module Vat
-    WSDL = 'http://ec.europa.eu/taxation_customs/vies/' \
-           'services/checkVatService'
+    API_URL = 'https://ec.europa.eu/taxation_customs/vies/rest-api/check-vat-number'
     HEADERS = {
-      'Content-Type' => 'text/xml;charset=UTF-8',
-      'SOAPAction' => ''
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json'
     }.freeze
 
-    BODY = <<-XML
-      <soapenv:Envelope
-      xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
-      xmlns:urn="urn:ec.europa.eu:taxud:vies:services:checkVat:types">
-        <soapenv:Header/>
-        <soapenv:Body>
-           <urn:checkVat>
-              <urn:countryCode>{COUNTRY_CODE}</urn:countryCode>
-              <urn:vatNumber>{NUMBER}</urn:vatNumber>
-           </urn:checkVat>
-        </soapenv:Body>
-      </soapenv:Envelope>
-    XML
+    VIES_ERRORS = {
+      'INVALID_INPUT' => :invalid_input,
+      'GLOBAL_MAX_CONCURRENT_REQ' => :rate_limited,
+      'MS_MAX_CONCURRENT_REQ' => :rate_limited,
+      'SERVICE_UNAVAILABLE' => :service_unavailable,
+      'MS_UNAVAILABLE' => :ms_unavailable,
+      'TIMEOUT' => :timeout
+    }.freeze
 
     def self.validate(number)
-      return :failed if number.size < 4
+      return :invalid_input if number.size < 4
 
       response = send_request(number[0..1], number[2..-1])
-      return :failed unless response.is_a? Net::HTTPSuccess
-      return :failed if response.body.include?('soap:Fault')
-      return :timeout if response.body.include?('TIMEOUT')
-      return :timeout if response.body.include?('MS_MAX_CONCURRENT_REQ')
+      return handle_error_response(response) unless response.is_a?(Net::HTTPSuccess)
 
       setup_response(response)
-    rescue Net::OpenTimeout
+    rescue Net::OpenTimeout, Net::ReadTimeout
       :timeout
-    rescue Net::HTTPServerError
-      :server_error
+    rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ETIMEDOUT, SocketError, OpenSSL::SSL::SSLError
+      :service_unavailable
+    end
+
+    def self.handle_error_response(response)
+      body = JSON.parse(response.body)
+      error_code = body.dig('errorWrappers', 0, 'error')
+      VIES_ERRORS[error_code] || :service_error
+    rescue JSON::ParserError
+      :service_error
     end
 
     def self.setup_response(response)
-      body = response_xml(response)
+      body = JSON.parse(response.body)
       {
-        valid: extract_data(body, 3) == 'true',
-        country_code: extract_data(body, 0),
-        vat_number: extract_data(body, 1),
-        request_date: convert_date(extract_data(body, 2)),
-        name: extract_data(body, 4),
-        address: extract_data(body, 5)
+        valid: body['valid'] == true,
+        country_code: body['countryCode'],
+        vat_number: body['vatNumber'],
+        request_date: convert_date(body['requestDate']),
+        name: body['name'],
+        address: body['address']
       }
     end
 
-    def self.response_xml(response)
-      xml = REXML::Document.new(response.body)
-      xml.elements.first.elements[2].elements[1]
-    end
-
     def self.convert_date(date)
       return unless date
 
       Date.parse(date)
     end
 
-    def self.extract_data(body, position)
-      body[position]&.text
-    end
-
     def self.charge_vat?(origin_country, number)
       return false if number.nil? || number.empty?
 
@@ -83,18 +73,16 @@ module Europe
     end
 
     def self.send_request(country_code, number)
-      uri = URI.parse(WSDL)
-
-      body = BODY.dup.gsub('{COUNTRY_CODE}', country_code)
-      body = body.gsub('{NUMBER}', number)
-
-      # Create the HTTP objects
-      http = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Post.new(uri.request_uri, HEADERS)
-      request.body = body
-
-      # Send the request
-      http.request(request)
+      uri = URI.parse(API_URL)
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        request = Net::HTTP::Post.new(uri.request_uri, HEADERS)
+        request.body = JSON.generate(
+          countryCode: country_code,
+          vatNumber: number
+        )
+        http.request(request)
+      end
     end
   end
 end

data/lib/europe/version.rb

@@ -2,5 +2,5 @@
 
 # Europe version
 module Europe
-  VERSION = '0.0.26'
+  VERSION = '0.0.27'
 end

data/test/europe/vat/validation_test.rb

@@ -4,6 +4,25 @@ require 'test_helper'
 
 module Europe
   module Vat
+    SERVICE_UNAVAILABLE_BODY = '{"actionSucceed":false,"errorWrappers":' \
+                               '[{"error":"SERVICE_UNAVAILABLE","message":' \
+                               '"An error was encountered either at the national ' \
+                               'level or at the European Commission"}]}'
+    MS_UNAVAILABLE_BODY = '{"actionSucceed":false,"errorWrappers":' \
+                          '[{"error":"MS_UNAVAILABLE","message":"The Member State service is unavailable"}]}'
+    GLOBAL_RATE_LIMITED_BODY = '{"actionSucceed":false,"errorWrappers":' \
+                               '[{"error":"GLOBAL_MAX_CONCURRENT_REQ","message":' \
+                               '"Your Request for VAT validation has not been processed; ' \
+                               'your max. number of concurrent requests has been reached"}]}'
+    MS_RATE_LIMITED_BODY = '{"actionSucceed":false,"errorWrappers":' \
+                           '[{"error":"MS_MAX_CONCURRENT_REQ","message":' \
+                           '"Your Request for VAT validation has not been processed; ' \
+                           'your max. number of concurrent requests for this Member State has been reached"}]}'
+    INVALID_INPUT_BODY = '{"actionSucceed":false,"errorWrappers":' \
+                         '[{"error":"INVALID_INPUT","message":"The provided CountryCode is invalid"}]}'
+    VIES_TIMEOUT_BODY = '{"actionSucceed":false,"errorWrappers":' \
+                        '[{"error":"TIMEOUT","message":"The Member State service could not be reached in time"}]}'
+
     # ValidationTest
     class ValidationTest < Minitest::Test
       include Benchmark
@@ -13,7 +32,7 @@ module Europe
       end
 
       def test_validation_of_short_vat_number
-        assert_equal :failed, Europe::Vat.validate('6')
+        assert_equal :invalid_input, Europe::Vat.validate('6')
       end
 
       def test_validation_of_false_vat_number
@@ -29,23 +48,76 @@ module Europe
         # PostNL
         validate_correct_vat = Europe::Vat.validate('NL009291477B01')
         assert validate_correct_vat[:valid] \
-          unless %i[timeout failed].include?(validate_correct_vat)
+          unless validate_correct_vat.is_a?(Symbol)
 
         # Volkswagen
         validate_correct_vat = Europe::Vat.validate('DE115235681')
         assert validate_correct_vat[:valid] \
-          unless %i[timeout failed].include?(validate_correct_vat)
+          unless validate_correct_vat.is_a?(Symbol)
       end
 
-      def test_failed_request_to_soap_service
+      def test_timeout
         WebMock.enable!
-        stub_request(:any, 'http://ec.europa.eu/taxation_customs/vies/services/checkVatService').to_timeout
-        Europe::Vat.validate('DE115235681')
+        stub_request(:post, Europe::Vat::API_URL).to_timeout
+        assert_equal :timeout, Europe::Vat.validate('DE115235681')
+        WebMock.disable!
+      end
+
+      def test_connection_refused
+        WebMock.enable!
+        stub_request(:post, Europe::Vat::API_URL).to_raise(Errno::ECONNREFUSED)
+        assert_equal :service_unavailable, Europe::Vat.validate('DE115235681')
+        WebMock.disable!
+      end
+
+      def test_server_error_without_body
+        WebMock.enable!
+        stub_request(:post, Europe::Vat::API_URL)
+          .to_return(status: 500, body: '')
+        assert_equal :service_error, Europe::Vat.validate('DE115235681')
+        WebMock.disable!
+      end
+
+      def test_service_unavailable_error
+        assert_vies_error 500, SERVICE_UNAVAILABLE_BODY,
+                          'DE115235681', :service_unavailable
+      end
 
-        stub_request(:get, 'http://ec.europa.eu/taxation_customs/vies/services/checkVatService')
-          .with(headers: { 'Accept' => '*/*', 'User-Agent' => 'Ruby' })
-          .to_return(status: 421, body: '')
-        Europe::Vat.validate('DE115235681')
+      def test_ms_unavailable_error
+        assert_vies_error 500, MS_UNAVAILABLE_BODY,
+                          'DE115235681', :ms_unavailable
+      end
+
+      def test_rate_limited_global
+        assert_vies_error 500, GLOBAL_RATE_LIMITED_BODY,
+                          'DE115235681', :rate_limited
+      end
+
+      def test_rate_limited_member_state
+        assert_vies_error 500, MS_RATE_LIMITED_BODY,
+                          'DE115235681', :rate_limited
+      end
+
+      def test_invalid_input_error
+        assert_vies_error 400, INVALID_INPUT_BODY,
+                          'XX123456789', :invalid_input
+      end
+
+      def test_vies_timeout_error
+        assert_vies_error 500, VIES_TIMEOUT_BODY,
+                          'DE115235681', :timeout
+      end
+
+      private
+
+      def assert_vies_error(status, body, vat, expected)
+        WebMock.enable!
+        stub_request(:post, Europe::Vat::API_URL)
+          .to_return(
+            status: status, body: body,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+        assert_equal expected, Europe::Vat.validate(vat)
         WebMock.disable!
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: europe
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.27
 platform: ruby
 authors:
 - Gem shards
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-15 00:00:00.000000000 Z
+date: 2026-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Europe is a gem for retrieving and validating EU government data.