valvat 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d200983c316dadd7d6fa2382bf7e76c3153cfe81a8b27ea820b4dd388f2868be
-  data.tar.gz: 27271cbfc2172fd9a335fe574d49a521bd7a0955710e1eace8493b74076ce157
+  metadata.gz: 9b64b4bcee899d80f3c9205b541eeaf7123df7560e47528368bedc0e06d85f85
+  data.tar.gz: 31f18a7bf075a71c719002e3b34dd4a057da7ba85aeaf7283385d7ffc98f7dcb
 SHA512:
-  metadata.gz: 997033c89f5641814cc856ac06a9029e937af9147b7450cf4b1ea2866090da46329310d6c72e7f14a94f0a7d5cdf2ebeedd3914bde0e6b1b66eeaa8b57422eea
-  data.tar.gz: fd50ce45794e3985ad2534be289f1e620e790ad75dfc27b91a5e5ac6022268ad0b50206bd951f5a6b9c8dbb1e407d2b5467e68ad4ee90380d78bf47d836c1a09
+  metadata.gz: 2b419833c23922a653f932995541e25300a8897529cd3bfdea2078de762f5829451e35c1a658510cfbd64978f0f6165471d1331e1673d381ef5c0ecd6ca6380a
+  data.tar.gz: e595829c058d7b2b89a644b779c4ea95c66eb9d416e395a4b32cf4d28f73bcb717f55c720fe51dd8d027092c94ae04b3c094cd1e7fbf1fe95d833330851a37d5

data/.gitignore

@@ -2,6 +2,7 @@ pkg/*
 *.gem
 .bundle
 Gemfile.lock
+gemfiles/*.lock
 tmp
 .rbenv-*
-.ruby-version
+.ruby-version

data/.travis.yml

@@ -1,33 +1,47 @@
 language: ruby
+cache: bundler
 rvm:
+  - 2.7
   - 2.6
   - 2.5
   - 2.4
   - 2.3
   - 2.2
   - 2.1
+  - jruby-head
   - jruby-19mode
 gemfile:
+  - gemfiles/activemodel-6
   - gemfiles/activemodel-5
   - gemfiles/activemodel-4
   - gemfiles/activemodel-3-2
   - gemfiles/standalone
 matrix:
   exclude:
-  - rvm: 2.1
-    gemfile: gemfiles/activemodel-5
-  - rvm: jruby-19mode
-    gemfile: gemfiles/activemodel-5
+    - rvm: 2.4
+      gemfile: gemfiles/activemodel-6
+    - rvm: 2.3
+      gemfile: gemfiles/activemodel-6
+    - rvm: 2.2
+      gemfile: gemfiles/activemodel-6
+    - rvm: 2.1
+      gemfile: gemfiles/activemodel-6
+    - rvm: jruby-19mode
+      gemfile: gemfiles/activemodel-6
+    - rvm: 2.1
+      gemfile: gemfiles/activemodel-5
+    - rvm: jruby-19mode
+      gemfile: gemfiles/activemodel-5
   include:
-  - rvm: 2.0
-    gemfile: gemfiles/before-ruby21/activemodel-4
-  - rvm: 2.0
-    gemfile: gemfiles/before-ruby21/activemodel-3-2
-  - rvm: 2.0
-    gemfile: gemfiles/before-ruby21/standalone
-  - rvm: 1.9.3
-    gemfile: gemfiles/before-ruby21/activemodel-4
-  - rvm: 1.9.3
-    gemfile: gemfiles/before-ruby21/activemodel-3-2
-  - rvm: 1.9.3
-    gemfile: gemfiles/before-ruby21/standalone
+    - rvm: 2.0
+      gemfile: gemfiles/before-ruby21/activemodel-4
+    - rvm: 2.0
+      gemfile: gemfiles/before-ruby21/activemodel-3-2
+    - rvm: 2.0
+      gemfile: gemfiles/before-ruby21/standalone
+    - rvm: 1.9.3
+      gemfile: gemfiles/before-ruby21/activemodel-4
+    - rvm: 1.9.3
+      gemfile: gemfiles/before-ruby21/activemodel-3-2
+    - rvm: 1.9.3
+      gemfile: gemfiles/before-ruby21/standalone

data/CHANGES.md

@@ -3,6 +3,19 @@
 
 [full changelog](http://github.com/yolk/valvat/compare/v0.9.1...master)
 
+### 1.0.0 / 2020-11-06
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.9.1...v1.0.0)
+
+* Refactored lookup to use specific rescue for savons soapfaults
+* Raises vies specific error classes to help debugging temporary and permanent VIES errors
+* Lookup#validate supports :savon option to allow altering the behaviour of the used savon client
+* ActiveModel validator now supports all lookup options.
+* Use https instead of http for accessing vies (by [Crazy Chris](https://github.com/lubekpl))
+* Lookup#validate supports :raise_error option to return nil instead of raising (known) error when connecting to the VIES web service.
+* [BUGFIX] Checksum: Prevent error on some invalid IE vat numbers
+* EN: Capitalized VAT in error messages (and specs) (by [Vitalii Kashoid](https://github.com/Kashoid23))
+
 ### 0.9.1 / 2020-03-19
 
 [full changelog](http://github.com/yolk/valvat/compare/v0.9.0...v0.9.1)

data/Gemfile

@@ -1,7 +1,6 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in valvat.gemspec
 gemspec
 
-gem 'rake'
-gem 'guard-rspec', '~>4.0'
+gem 'guard-rspec', '~>4.0'

data/README.md

@@ -14,7 +14,7 @@ Validates european vat numbers. Standalone or as a ActiveModel validator.
 * I18n locales for language specific error messages in English, German, French, Spanish, Italian, Portuguese, Polish, Swedish, Dutch, Danish, Czech, Slovakian, Hungarian, Bulgarian, Romanian, Latvian, Catalan, Norwegian, and Finnish.
 * *Experimental* checksum verification
 
-valvat is tested and works with ruby MRI 1.9.3/2.0/2.1/2.2/2.3/2.4/2.5/2.6, jruby (in 1.9 mode) and ActiveModel 3/4/5
+valvat is tested and works with ruby MRI 1.9.3/2.0/2.1/2.2/2.3/2.4/2.5/2.6/2.7, jruby (including 1.9 mode) and ActiveModel 3/4/5/6
 
 ## Installation
 
@@ -24,7 +24,7 @@ Add it to your Gemfile:
 
 To use less memory (~3.5 mb vs. ~0.5 mb) and load only the local verification functionality – and not the remote lookup with VIES – add it like this instead:
 
-    gem 'valvat', :require => 'valvat/local'
+    gem 'valvat', require: 'valvat/local'
 
 In any case run:
 
@@ -34,72 +34,114 @@ Or install it yourself as:
 
     $ gem install valvat
 
-## Basic Usage
+## Validate the syntax of a VAT number
 
 To verify the syntax of a vat number:
 
     Valvat.new("DE345789003").valid?
     => true or false
 
-To check if the given vat number exists via the VIES web service:
-
-    Valvat.new("DE345789003").exists?
-    => true or false or nil
+It is also possible to bypass initializing a Valvat instance and check the syntax of a vat number string directly with:
 
-*IMPORTANT* Keep in mind that the VIES web service might be offline at some time for some countries. If this happens `exists?` or `Valvat::Lookup.validate` will return `nil`.
+    Valvat::Syntax.validate("DE345789003")
+    => true or false
 
-Visit [http://ec.europa.eu/taxation_customs/vies/viesspec.do](http://ec.europa.eu/taxation_customs/vies/viesspec.do) for more accurate information at what time the service for a specific country will be down.
+## Validate agains the VIES web service
 
-It is also possible to bypass initializing a Valvat instance and check the syntax of a var number string directly with:
+To check if the given vat number exists via the VIES web service:
 
-    Valvat::Syntax.validate("DE345789003")
-    => true or false
+    Valvat.new("DE345789003").exists?
+    => true or false or nil
 
 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, FR, 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:
+*IMPORTANT* Keep in mind that the VIES web service might be offline at some time for all or some member states. If this happens `exists?` or `Valvat::Lookup.validate` will return `nil`. See *Handling of VIES maintenance errors* for further details.
 
-    Valvat.new("DE345789003").valid_checksum?
-    => true or false
+### Details & request identifier
 
-These results are more valuable than a simple syntax check, but keep in mind: they can not replace a lookup via VIES.
+If you need all details and not only if the VAT is valid, pass {detail: true} as second parameter to the lookup call.
 
-*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.
-
-    Valvat.new("IE6388047V").exists?(:detail => true)
+    Valvat.new("IE6388047V").exists?(detail: true)
     => {
-      :country_code=>"IE", :vat_number => "6388047V",
+      :country_code=>"IE", :vat_number => "6388047V", :valid => true,
       :request_date => Date.today, :name=>"GOOGLE IRELAND LIMITED",
       :address=>"1ST & 2ND FLOOR ,GORDON HOUSE ,BARROW STREET ,DUBLIN 4"
     } or false or nil
 
-According to EU law, or at least as Austria sees it, it's mandatory to verify the UID number of every new customer, but also to check the UID Number periodicaly. To prove that you have checked the UID number, the VIES Web service can return a requestIdentifier.
+According to EU law, or at least as Austria sees it, it's mandatory to verify the VAT number of every new customer, but also to check the VAT number periodicaly. To prove that you have checked the VAT number, the VIES Web service can return a `request_identifier`.
 
-To receive a requestIdentifier you need to pass your own VAT number in the options hash. In this Example, Google (VAT IE6388047V) is checking the validity of eBays VAT number (LU21416127)
+To receive a `request_identifier` you need to pass your own VAT number in the options hash. In this example, Google (VAT IE6388047V) is checking the validity of eBays VAT number (LU21416127)
 
-    Valvat.new("LU21416127").exists?(:requester_vat => "IE6388047V")
+    Valvat.new("LU21416127").exists?(requester: "IE6388047V")
     => {
-      :country_code=>"LU", :vat_number => "21416127",
+      :country_code=>"LU", :vat_number => "21416127", :valid => true,
       :request_date => Date.today, :name=>"EBAY EUROPE S.A R.L.",
       :address => "22, BOULEVARD ROYAL\nL-2449  LUXEMBOURG",
       :company_type => nil, :request_identifier => "some_uniq_string"
     } or false or nil
 
-## Usage with ActiveModel / Rails 3
+If the given `requester` is invalid, a `Valvat::InvalidRequester` error is thrown.
+
+### Handling of VIES maintenance errors
+
+From time to time the VIES web service for one or all member states is down for maintenance. To handle this kind of temporary errors, `Valvat::Lookup#validate` returns `nil` by default to indicate that there is no way at the moment to say if the given VAT is valid or not. You should revalidate the VAT later. If you prefer an error, use the `raise_error` option:
+
+    Valvat.new("IE6388047V").exists?(raise_error: true)
+
+This raises `Valvat::ServiceUnavailable` or `Valvat::MemberStateUnavailable` instead of returning `nil`.
+
+Visit [http://ec.europa.eu/taxation_customs/vies/viesspec.do](http://ec.europa.eu/taxation_customs/vies/viesspec.do) for more accurate information at what time the service for a specific member state will be down.
+
+### Handling of other VIES errors
+
+All other errors accuring while validating against the VIES web service are raised and must be handled by you. These include:
+
+ * `Valvat::InvalidRequester`
+ * `Valvat::BlockedError`
+ * `Valvat::RateLimitError`
+ * `Valvat::Timeout`
+ * all IO errors
+
+If you want to suppress all known error cases. Pass in the `raise_error` option set to `false`:
+
+    Valvat.new("IE6388047V").exists?(raise_error: false)
+
+This will return `nil` instead of raising a known error.
+
+### Set options for the savon client
+
+Use the `:savon` key to set options for the used savon SOAP client. For example to log all requests:
+
+    Valvat.new("IE6388047V").exists?(savon: {log: true})
+
+Or to use higher timeouts for the requests:
+
+   Valvat.new("IE6388047V").exists?(savon: {open_timeout: 10, read_timeout: 10})
+
+### Skip local validation before lookup
+
+To prevent unnecessary requests, valvat performs a local syntax check before making the request to the VIES web service. If you want to skip this step (for any reason), set the `:skip_local_validation` option to `true`.
+
+## Experimental checksum verification
+
+valvat allows to check vat numbers from AT, BE, BG, DE, DK, ES, FR, FI, GR, IE, IT, LU, NL, PL, PT, SE and SI against a checksum calculation. All other member states will fall back to a basic syntax check:
+
+    Valvat.new("DE345789003").valid_checksum?
+    => true or false
+
+These results are more valuable 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
+
+## Usage with ActiveModel / Rails
 
 ### Loading
 
@@ -114,30 +156,34 @@ after ActiveModel has been loaded.
 To validate the attribute `vat_number` add this to your model:
 
     class MyModel < ActiveRecord::Base
-      validates :vat_number, :valvat => true
+      validates :vat_number, valvat: true
     end
 
 ### Additional lookup validation
 
 To additionally perform a lookup via VIES:
 
-    validates :vat_number, :valvat => {:lookup => true}
+    validates :vat_number, valvat: {lookup: true}
 
 By default this will validate to true if the VIES web service is down. To fail in this case simply add the `:fail_if_down` option:
 
-    validates :vat_number, :valvat => {:lookup => :fail_if_down}
+    validates :vat_number, valvat: {lookup: {fail_if_down: true}}
+
+You can pass in any options accepted by `Valvat::Lookup#validate`:
+
+    validates :vat_number, valvat: {lookup: {raise_error: true, savon: {log: true}}}
 
 ### Additional (and experimental) checksum validation
 
 To additionally perform a checksum validation:
 
-    validates :vat_number, :valvat => {:checksum => true}
+    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:
 
-    validates :vat_number, :valvat => {:match_country => :country}
+    validates :vat_number, valvat: {match_country: :country}
 
 where it is supposed that your model has a method named _country_ which returns the country ISO code you want to match.
 
@@ -145,14 +191,14 @@ where it is supposed that your model has a method named _country_ which returns
 
 By default blank vat numbers validate to false. To change this add the `:allow_blank` option:
 
-    validates :vat_number, :valvat => {:allow_blank => true}
+    validates :vat_number, valvat: {allow_blank: true}
 
 ### Allow vat numbers outside of europe
 
 To allow vat numbers from outside of europe, add something like this to your model (country_code should return a upcase ISO country code):
 
     class MyModel < ActiveRecord::Base
-      validates :vat_number, :valvat => true, :if => :eu?
+      validates :vat_number, valvat: true, if: :eu?
 
       def eu?
         Valvat::Utils::EU_COUNTRIES.include?(country_code)
@@ -206,7 +252,7 @@ https://github.com/yolk/valvat/graphs/contributors
 
 ## BlaBla
 
-Copyright (c) 2011-2019 Yolk Sebastian Munz & Julia Soergel GbR
+Copyright (c) 2011-2020 Yolk Sebastian Munz & Julia Soergel GbR
 
 Beyond that, the implementation is licensed under the MIT License.
 

data/gemfiles/activemodel-3-2

@@ -1,8 +1,7 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "savon",       ">=2.3.0"
 gem "activemodel", "~> 3.2"
 
-gem 'rspec', '~> 3.0'
 gem 'rack', '< 2'
-gem 'rake'
+
+gemspec path: "../"

data/gemfiles/activemodel-4

@@ -1,8 +1,7 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "savon",       ">=2.3.0"
 gem "activemodel", "~> 4.2"
 
-gem 'rspec', '~> 3.0'
 gem 'rack', '< 2'
-gem 'rake'
+
+gemspec path: "../"

data/gemfiles/activemodel-5

@@ -1,8 +1,7 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "savon",       ">=2.3.0"
-gem "activemodel", "~> 5.0.2"
+gem "activemodel", "~> 5.2.0"
 
-gem 'rspec', '~> 3.0'
 gem 'rack'
-gem 'rake'
+
+gemspec path: "../"

data/gemfiles/activemodel-6

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "activemodel", "~> 6.0.0"
+
+gem 'rack'
+
+gemspec path: "../"

data/gemfiles/before-ruby21/activemodel-3-2

@@ -1,9 +1,8 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "nokogiri",    "< 1.7"
-gem "savon",       ">=2.3.0"
 gem "activemodel", "~> 3.2"
 
-gem 'rspec', '~> 3.0'
 gem 'rack', '< 2'
-gem 'rake'
+
+gemspec path: "../../"

data/gemfiles/before-ruby21/activemodel-4

@@ -1,9 +1,8 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "nokogiri",    "< 1.7"
-gem "savon",       ">=2.3.0"
 gem "activemodel", "~> 4.2"
 
-gem 'rspec', '~> 3.0'
 gem 'rack', '< 2'
-gem 'rake'
+
+gemspec path: "../../"

data/gemfiles/before-ruby21/standalone

@@ -1,8 +1,7 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "nokogiri",    "< 1.7"
-gem "savon",       ">=2.3.0"
 
-gem 'rspec', '~> 3.0'
 gem 'rack', '< 2'
-gem 'rake'
+
+gemspec path: "../../"

data/gemfiles/standalone

@@ -1,7 +1,5 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "savon",       ">=2.3.0"
-
-gem 'rspec', '~> 3.0'
 gem 'rack', '< 2'
-gem 'rake'
+
+gemspec path: "../"