valvat 1.1.5 → 1.2.1

data/spec/valvat/lookup_spec.rb

@@ -4,98 +4,162 @@ require 'spec_helper'
 
 describe Valvat::Lookup do
   describe '#validate' do
-    context 'with existing VAT number' do
+    context 'with existing EU VAT number' do
       it 'returns true' do
         result = described_class.validate('IE6388047V')
-        # Skip if VIES is down
-        expect(result).to be(true) unless result.nil?
+        skip 'VIES is down' if result.nil?
+        expect(result).to be(true)
       end
 
       it 'allows Valvat instance as input' do
         result = described_class.validate(Valvat.new('IE6388047V'))
-        # Skip if VIES is down
-        expect(result).to be(true) unless result.nil?
+        skip 'VIES is down' if result.nil?
+        expect(result).to be(true)
       end
-    end
 
-    context 'with not existing VAT number' do
-      it 'returns false' do
-        result =  described_class.validate('IE6388048V')
-        # Skip if VIES is down
-        expect(result).to be(false) unless result.nil?
+      context 'with details' do
+        it 'returns hash of details instead of true' do
+          result = described_class.validate('IE6388047V', detail: true)
+          skip 'VIES is down' if result.nil?
+
+          expect(result).to match({
+                                    request_date: kind_of(Date),
+                                    country_code: 'IE',
+                                    vat_number: '6388047V',
+                                    name: 'GOOGLE IRELAND LIMITED',
+                                    address: '3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4',
+                                    valid: true
+                                  })
+        end
       end
     end
 
-    context 'with invalid country code / input' do
-      it 'returns false' do
-        expect(described_class.validate('AE259597697')).to be(false)
-        expect(described_class.validate('')).to be(false)
+    context 'with existing GB VAT number' do
+      it 'returns true' do
+        result = described_class.validate('GB727255821', uk: true)
+        skip 'HMRC is down' if result.nil?
+        expect(result).to be(true)
+      end
+
+      it 'returns details in format similar to VIES' do
+        result = described_class.validate('GB727255821', detail: true, uk: true)
+        skip 'HMRC is down' if result.nil?
+        expect(result).to match({
+                                  request_date: kind_of(Time),
+                                  country_code: 'GB',
+                                  vat_number: '727255821',
+                                  name: 'AMAZON EU SARL',
+                                  address: "1 PRINCIPAL PLACE\nWORSHIP STREET\nLONDON\nEC2A 2FA\nGB",
+                                  valid: true
+                                })
       end
     end
 
-    context 'with details' do
-      let(:details) do
-        {
-          '@xmlns:ns2': 'urn:ec.europa.eu:taxud:vies:services:checkVat:types',
-          country_code: 'IE',
-          vat_number: '6388047V',
-          name: 'GOOGLE IRELAND LIMITED',
-          address: '3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4',
-          valid: true
-        }
+    context 'with not existing EU VAT number' do
+      it 'returns false' do
+        result =  described_class.validate('IE6388048V')
+        skip 'VIES is down' if result.nil?
+        expect(result).to be(false)
       end
 
-      it 'returns hash of details instead of true' do
-        result = described_class.validate('IE6388047V', detail: true)
-        # Skip if VIES is down
-        if result
-          expect(result.delete(:request_date)).to be_kind_of(Date)
-          expect(result).to eql(details)
+      context 'with details' do
+        it 'still returns false' do
+          result = described_class.validate('LU21416128', detail: true)
+          skip 'VIES is down' if result.nil?
+          expect(result).to be(false)
         end
       end
+    end
 
-      it 'still returns false on not existing VAT number' do
-        result = described_class.validate('LU21416128', detail: true)
-        # Skip if VIES is down
-        expect(result).to be(false) unless result.nil?
+    context 'with not existing GB VAT number' do
+      it 'returns false' do
+        result =  described_class.validate('GB727255820', uk: true)
+        skip 'HMRC is down' if result.nil?
+        expect(result).to be(false)
       end
     end
 
-    context 'with request identifier' do
-      let(:response) { described_class.validate('IE6388047V', requester: 'IE6388047V') }
-      let(:details) do
-        {
-          '@xmlns:ns2': 'urn:ec.europa.eu:taxud:vies:services:checkVat:types',
-          country_code: 'IE',
-          vat_number: '6388047V',
-          name: 'GOOGLE IRELAND LIMITED',
-          company_type: nil,
-          address: '3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4',
-          valid: true
-        }
+    context 'with invalid country code / input' do
+      it 'returns false' do
+        expect(described_class.validate('AE259597697')).to be(false)
+        expect(described_class.validate('')).to be(false)
       end
+    end
 
+    context 'with request identifier' do
       it 'returns hash of details instead of true' do
-        # Skip if VIES is down
-        if response
-          expect(response.delete(:request_identifier).size).to be(16)
-          expect(response.delete(:request_date)).to be_kind_of(Date)
-          expect(response).to eql(details)
+        result = described_class.validate('IE6388047V', requester: 'IE6388047V')
+
+        skip 'VIES is down' if result.nil?
+
+        expect(result).to match({
+                                  request_date: kind_of(Date),
+                                  request_identifier: /\A[\w\W]{16}\Z/,
+                                  country_code: 'IE',
+                                  vat_number: '6388047V',
+                                  name: 'GOOGLE IRELAND LIMITED',
+                                  company_type: nil,
+                                  address: '3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4',
+                                  valid: true
+                                })
+      end
+
+      it 'supports old :requester_vat option for backwards compatibility' do
+        result = described_class.validate('IE6388047V', requester_vat: 'LU21416127')
+
+        expect(result).to match({
+                                  request_date: kind_of(Date),
+                                  request_identifier: /\A[\w\W]{16}\Z/,
+                                  country_code: 'IE',
+                                  vat_number: '6388047V',
+                                  name: 'GOOGLE IRELAND LIMITED',
+                                  company_type: nil,
+                                  address: '3RD FLOOR, GORDON HOUSE, BARROW STREET, DUBLIN 4',
+                                  valid: true
+                                })
+      end
+
+      context 'with GB VAT number' do
+        it 'returns hash of details with request number' do
+          response = described_class.validate('GB727255821', requester: 'GB727255821', uk: true)
+          skip 'HMRC is down' if response.nil?
+          expect(response).to match({
+                                      request_date: kind_of(Time),
+                                      request_identifier: /\A\w\w\w-\w\w\w-\w\w\w\Z/,
+                                      country_code: 'GB',
+                                      vat_number: '727255821',
+                                      name: 'AMAZON EU SARL',
+                                      address: "1 PRINCIPAL PLACE\nWORSHIP STREET\nLONDON\nEC2A 2FA\nGB",
+                                      valid: true
+                                    })
+        end
+
+        it 'raises exception if requester is not from GB' do
+          expect do
+            described_class.validate('GB727255821', requester: 'IE6388047V', uk: true)
+          end.to raise_error(Valvat::InvalidRequester,
+                             'The HMRC web service returned the error: '\
+                             'INVALID_REQUEST (Invalid requesterVrn - Vrn parameters should be 9 or 12 digits)')
         end
-      end
 
-      it 'supports old :requester_vat option for backwards stability' do
-        expect(
-          described_class.new('IE6388047V', requester_vat: 'LU21416127').instance_variable_get(:@options)[:requester]
-        ).to eql('LU21416127')
+        it 'raises exception if requester is not valid' do
+          expect do
+            described_class.validate('GB727255821', requester: 'GB6388047', uk: true)
+          end.to raise_error(Valvat::InvalidRequester,
+                             'The HMRC web service returned the error: '\
+                             'INVALID_REQUEST (Invalid requesterVrn - Vrn parameters should be 9 or 12 digits)')
+        end
       end
     end
   end
 
   describe '#validate with VIES test enviroment' do
     let(:options) do
-      { savon: { wsdl: 'https://ec.europa.eu/taxation_customs/vies/checkVatTestService.wsdl' },
-        skip_local_validation: true }
+      { skip_local_validation: true }
+    end
+
+    before do
+      stub_const('Valvat::Lookup::VIES::ENDPOINT_URI', URI('https://ec.europa.eu/taxation_customs/vies/test-services/checkVatTestService'))
     end
 
     context 'with valid request with valid VAT number' do
@@ -170,6 +234,22 @@ describe Valvat::Lookup do
       end
     end
 
+    describe 'Network timeout' do
+      subject(:result) { described_class.validate('DE200', options) }
+
+      before { stub_request(:post, /ec.europa.eu/).to_timeout }
+
+      it 'raises error' do
+        expect { result }.to raise_error(Net::OpenTimeout, 'execution expired')
+      end
+
+      it 'also raises error with raise_error set to false (not handled)' do
+        expect do
+          described_class.validate('DE302', options.merge(raise_error: false))
+        end.to raise_error(Net::OpenTimeout, 'execution expired')
+      end
+    end
+
     describe 'Error : VAT_BLOCKED' do
       subject(:result) { described_class.validate('DE400', options) }
 
@@ -242,39 +322,147 @@ describe Valvat::Lookup do
       end
     end
 
-    describe 'Error : Savon::UnknownOperationError' do
+    describe 'Error : HTTP error' do
       subject(:result) { described_class.validate('DE601', options) }
 
       before do
-        dbl = instance_double(Savon::Client)
-        allow(Savon::Client).to receive(:new).and_return(dbl)
-        allow(dbl).to receive(:call).and_raise(Savon::UnknownOperationError.new('from stub'))
+        stub_request(:post, %r{\Ahttps://ec\.europa\.eu}).to_return({ status: 405 })
       end
 
       it 'raises error' do
-        expect { result }.to raise_error(Valvat::OperationUnknown, /#<Savon::UnknownOperationError: from stub>/)
+        expect { result }.to raise_error(Valvat::HTTPError, 'The VIES web service returned the error: 405')
       end
 
       it 'returns nil with raise_error set to false' do
         expect(described_class.validate('DE601', options.merge(raise_error: false))).to be_nil
       end
     end
+  end
 
-    describe 'Error : Savon::HTTPError' do
-      subject(:result) { described_class.validate('DE601', options) }
+  describe '#validate with HMRC test enviroment' do
+    # https://developer.service.hmrc.gov.uk/api-documentation/docs/testing
+    # https://github.com/hmrc/vat-registered-companies-api/blob/master/public/api/conf/1.0/test-data/vrn.csv
+    subject(:result) { described_class.validate('GB123456789', uk: true) }
+
+    before do
+      stub_const('Valvat::Lookup::HMRC::ENDPOINT_URL', 'https://test-api.service.hmrc.gov.uk/organisations/vat/check-vat-number/lookup')
+    end
+
+    context 'with valid request with valid VAT number' do
+      it 'returns true' do
+        expect(described_class.validate('GB553557881', uk: true)).to be(true)
+        expect(described_class.validate('GB146295999727', uk: true)).to be(true)
+      end
+    end
 
+    context 'with valid request with an invalid VAT number' do
+      it 'returns false' do
+        expect(result).to be(false)
+      end
+    end
+
+    describe 'Error : MESSAGE_THROTTLED_OUT' do
       before do
-        dbl = instance_double(Savon::Client)
-        allow(Savon::Client).to receive(:new).and_return(dbl)
-        allow(dbl).to receive(:call).and_raise(Savon::HTTPError.new(Struct.new(:code, :body).new(403, 'from stub')))
+        stub_request(:get, /test-api.service.hmrc.gov.uk/).to_return(
+          status: 429,
+          body: '{"code":"MESSAGE_THROTTLED_OUT"}'
+        )
       end
 
       it 'raises error' do
-        expect { result }.to raise_error(Valvat::HTTPError, /#<Savon::HTTPError: HTTP error \(403\): from stub>/)
+        expect { result }.to raise_error(Valvat::RateLimitError, /MESSAGE_THROTTLED_OUT/)
       end
 
       it 'returns nil with raise_error set to false' do
-        expect(described_class.validate('DE601', options.merge(raise_error: false))).to be_nil
+        expect(described_class.validate('GB123456789', raise_error: false, uk: true)).to be_nil
+      end
+    end
+
+    describe 'Error : SCHEDULED_MAINTENANCE' do
+      before do
+        stub_request(:get, /test-api.service.hmrc.gov.uk/).to_return(
+          status: 503,
+          body: '{"code":"SCHEDULED_MAINTENANCE"}'
+        )
+      end
+
+      it 'returns nil' do
+        expect(result).to be_nil
+      end
+
+      it 'raises error with raise_error set to false' do
+        expect do
+          described_class.validate('GB123456789', raise_error: true, uk: true)
+        end.to raise_error(Valvat::ServiceUnavailable, 'The HMRC web service returned the error: SCHEDULED_MAINTENANCE')
+      end
+    end
+
+    describe 'Error : SERVER_ERROR' do
+      before do
+        stub_request(:get, /test-api.service.hmrc.gov.uk/).to_return(
+          status: 503,
+          body: '{"code":"SERVER_ERROR"}'
+        )
+      end
+
+      it 'returns nil' do
+        expect(result).to be_nil
+      end
+
+      it 'raises error with raise_error set to false' do
+        expect do
+          described_class.validate('GB123456789', raise_error: true, uk: true)
+        end.to raise_error(Valvat::ServiceUnavailable, 'The HMRC web service returned the error: SERVER_ERROR')
+      end
+    end
+
+    describe 'Error : GATEWAY_TIMEOUT' do
+      before do
+        stub_request(:get, /test-api.service.hmrc.gov.uk/).to_return(
+          status: 504,
+          body: '{"code":"GATEWAY_TIMEOUT"}'
+        )
+      end
+
+      it 'raises error' do
+        expect { result }.to raise_error(Valvat::Timeout, /GATEWAY_TIMEOUT/)
+      end
+
+      it 'returns nil with raise_error set to false' do
+        expect(described_class.validate('GB123456789', raise_error: false, uk: true)).to be_nil
+      end
+    end
+
+    describe 'Network timeout' do
+      before do
+        stub_request(:get, /test-api.service.hmrc.gov.uk/).to_timeout
+      end
+
+      it 'raises error' do
+        expect { result }.to raise_error(Net::OpenTimeout)
+      end
+
+      it 'also raises error with raise_error set to false (not handled)' do
+        expect do
+          described_class.validate('GB123456789', raise_error: false, uk: true)
+        end.to raise_error(Net::OpenTimeout)
+      end
+    end
+
+    describe 'Error : INTERNAL_SERVER_ERROR' do
+      before do
+        stub_request(:get, /test-api.service.hmrc.gov.uk/).to_return(
+          status: 500,
+          body: '{"code":"INTERNAL_SERVER_ERROR"}'
+        )
+      end
+
+      it 'raises error' do
+        expect { result }.to raise_error(Valvat::UnknownLookupError, /INTERNAL_SERVER_ERROR/)
+      end
+
+      it 'returns nil with raise_error set to false' do
+        expect(described_class.validate('GB123456789', raise_error: false, uk: true)).to be_nil
       end
     end
   end

data/valvat.gemspec

@@ -20,10 +20,12 @@ Gem::Specification.new do |s|
   s.signing_key   = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME =~ /gem\z/
   s.required_ruby_version = '>= 2.5.0'
 
-  s.add_dependency             'savon', '>= 2.3.0'
+  s.add_runtime_dependency('rexml', '>= 3.2', '< 4.0')
 
   s.add_development_dependency 'activemodel', '>= 5.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 3.0'
+
   s.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valvat
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.1
 platform: ruby
 authors:
 - Sebastian Munz
@@ -35,22 +35,28 @@ cert_chain:
   BUdT7mtr41GgvWnIjaGWAldSuabxx5H+PKS5FzjNDMHThRZWuvYp/nP2RXDh4gIa
   7hV09P+XxvS96G+petG5KmC/lev8VqKu
   -----END CERTIFICATE-----
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: savon
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +99,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Validates european vat numbers. Standalone or as a ActiveModel validator.
 email:
 - sebastian@yo.lk
@@ -166,9 +186,9 @@ files:
 - lib/valvat/locales/sv.yml
 - lib/valvat/locales/tr.yml
 - lib/valvat/lookup.rb
-- lib/valvat/lookup/fault.rb
-- lib/valvat/lookup/request.rb
-- lib/valvat/lookup/response.rb
+- lib/valvat/lookup/base.rb
+- lib/valvat/lookup/hmrc.rb
+- lib/valvat/lookup/vies.rb
 - lib/valvat/syntax.rb
 - lib/valvat/utils.rb
 - lib/valvat/version.rb
@@ -200,9 +220,8 @@ files:
 - spec/valvat/checksum/se_spec.rb
 - spec/valvat/checksum/si_spec.rb
 - spec/valvat/checksum_spec.rb
-- spec/valvat/lookup/fault_spec.rb
-- spec/valvat/lookup/request_spec.rb
-- spec/valvat/lookup/response_spec.rb
+- spec/valvat/lookup/hmrc_spec.rb
+- spec/valvat/lookup/vies_spec.rb
 - spec/valvat/lookup_spec.rb
 - spec/valvat/syntax_spec.rb
 - spec/valvat/utils_spec.rb
@@ -261,9 +280,8 @@ test_files:
 - spec/valvat/checksum/se_spec.rb
 - spec/valvat/checksum/si_spec.rb
 - spec/valvat/checksum_spec.rb
-- spec/valvat/lookup/fault_spec.rb
-- spec/valvat/lookup/request_spec.rb
-- spec/valvat/lookup/response_spec.rb
+- spec/valvat/lookup/hmrc_spec.rb
+- spec/valvat/lookup/vies_spec.rb
 - spec/valvat/lookup_spec.rb
 - spec/valvat/syntax_spec.rb
 - spec/valvat/utils_spec.rb

data/lib/valvat/lookup/fault.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-class Valvat
-  class Lookup
-    class Fault < Response
-      def to_hash
-        @to_hash ||= case @raw
-                     when Savon::HTTPError
-                       { error: HTTPError.new(nil, @raw) }
-                     when Savon::UnknownOperationError
-                       { error: OperationUnknown.new(nil, @raw) }
-                     else
-                       soap_fault
-                     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
-      }.freeze
-
-      private
-
-      def soap_fault
-        fault = @raw.to_hash[:fault][:faultstring]
-
-        if fault == 'INVALID_INPUT'
-          { valid: false }
-        else
-          error = (FAULTS[fault] || UnknownViesError).new(fault)
-          { error: error }
-        end
-      end
-    end
-  end
-end

data/lib/valvat/lookup/request.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'savon'
-
-class Valvat
-  class Lookup
-    class Request
-      VIES_WSDL_URL = 'https://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl'
-
-      def initialize(vat, options)
-        @vat = Valvat(vat)
-        @options = options || {}
-        @requester = @options[:requester] && Valvat(@options[:requester])
-      end
-
-      def perform
-        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
-
-      def client
-        Savon::Client.new({
-          wsdl: VIES_WSDL_URL, log: false, follow_redirects: true
-        }.merge(@options[:savon] || {}))
-      end
-
-      def message
-        add_requester({
-                        country_code: @vat.vat_country_code,
-                        vat_number: @vat.to_s_wo_country
-                      })
-      end
-
-      def message_tag
-        @requester ? :checkVatApprox : :checkVat
-      end
-
-      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

data/lib/valvat/lookup/response.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-class Valvat
-  class Lookup
-    class Response
-      def initialize(raw)
-        @raw = raw
-      end
-
-      def [](key)
-        to_hash[key]
-      end
-
-      def to_hash
-        @to_hash ||= self.class.cleanup(@raw.to_hash)
-      end
-
-      def self.cleanup(hash)
-        (
-          hash[:check_vat_approx_response] || hash[:check_vat_response] || {}
-        ).each_with_object({}) do |(key, value), result|
-          result[cleanup_key(key)] = cleanup_value(value) unless key == :@xmlns
-        end
-      end
-
-      TRADER_PREFIX = /\Atrader_/.freeze
-
-      def self.cleanup_key(key)
-        key.to_s.sub(TRADER_PREFIX, '').to_sym
-      end
-
-      def self.cleanup_value(value)
-        value == '---' ? nil : value
-      end
-    end
-  end
-end