vat_check 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 161ced06f8bbe69aa32234ea941633459c9d5c48
-  data.tar.gz: d214f05f0e53135fcd031ff70e95721895d29363
+SHA256:
+  metadata.gz: d2b59db2a077b774b3a45f9ef3e56ccf07e3880d04629720e02956f3c0c86db6
+  data.tar.gz: 74f27a5c342b028fc5e2cf263b74b15645a8573c0b209204b2c35fd1721f04b7
 SHA512:
-  metadata.gz: 22c4797919d9ce95b01846ba5e5a2480878a3107bc42fb8a60b5aded16faa75180e50e0412efa45ba078454ab46451b367f58ba7c6d10ac8cf33ea7c16df5f08
-  data.tar.gz: bec7aaf559af0894e3d89871e00a74f25f751443d211f7d623ce100a78925b647f4ac4c86f95316bfeae9766845137f52fde1f76f3a1e9d6445f1a953009ee6c
+  metadata.gz: 4ad491dc114a787d8953a24e655d8d5ebbc84c365c2d78669c60c3387b7e16f69f154d8865f57f3f8d0f42124b6778d543b5cd50f7d0bef13a0e08bd2160c2e6
+  data.tar.gz: 333eeb1ebfa7e53ae6db4d377d7e75e770e302b10c88349f8b327a5a8d1a35e3f67eca5dc0b38041c575e0b169d44f946e3af16b42dd36209eabe7152a1a2deb

data/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org/
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+
+[*.rb]
+indent_style=space
+indent_size=2
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+.env*
+.byebug_history
+.rspec_status
+.ruby-gemset
+.ruby-version
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+ - "2.3"
+ - "2.4"
+ - "2.5"
+ - "2.6"
+ - "2.7"
+
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,129 @@
+# VatCheck [![RubyGems](http://img.shields.io/gem/v/vat_check.svg?style=flat-square)](https://rubygems.org/gems/vat_check) [![Build Status](http://img.shields.io/travis/taxjar/vat_check.svg?style=flat-square)](https://travis-ci.org/taxjar/vat_check)
+
+Need to verify VAT identification numbers in Ruby? VatCheck makes it easy and simple:
+
+```ruby
+vat = VatCheck.new('GB333289454')
+puts 'Legit' if vat.valid?
+```
+
+That's it. VatCheck first performs a regex validation. If it passes, it attempts to verify on VIES. [Sometimes it's up, sometimes it's down](http://ec.europa.eu/taxation_customs/vies/help.html). When it's down `valid?` gracefully falls back to regex.
+
+## Getting Started
+
+Install it via RubyGems in your terminal:
+
+```
+gem install vat_check
+```
+
+Or in your Gemfile:
+
+```
+gem 'vat_check', '~> 1.0'
+```
+
+**Note:** VatCheck requires Ruby 2.3 or greater.
+
+## Basic Usage
+
+```ruby
+require 'vat_check'
+vat = VatCheck.new('VATIN')
+```
+
+This returns some nifty helper methods and attributes for all your VAT needs:
+
+```ruby
+vat.regex # True if regex validated
+vat.vies # True if VIES response is valid
+vat.vies_available # True if VIES available
+vat.response # Hash if VIES available
+
+vat.valid? # True if regex and VIES validated (if available)
+vat.exists? # True if VIES available and VATIN exists
+```
+
+`valid?` will be your goto method for quick verification. If VIES is currently available, you'll get a response hash:
+
+```ruby
+{
+  :country_code => "GB",
+  :vat_number => "333289454",
+  :request_date => Date.today,
+  :valid => true,
+  :name => "BRITISH BROADCASTING CORPORATION",
+  :address => "FAO ALEX FITZPATRICK\nBBC GROUP VAT MANAGER\nTHE LIGHT HOUSE (1ST FLOOR)\nMEDIA VILLAGE, 201 WOOD LANE\nLONDON\nW127TQ"
+}
+```
+
+If you'd like to expose that info, go ahead and use `exists?`:
+
+```ruby
+if vat.exists?
+  puts vat.response.name
+  puts vat.response.address
+end
+```
+
+## Examples
+
+VIES is available, the VAT is formatted correctly, and the VAT is registered to a business:
+
+```ruby
+vat = VatCheck.new('GB333289454')
+vat.regex # true
+vat.vies_available # true
+vat.vies # true
+vat.response # {:country_code=>"GB", :vat_number=>"333289454", :request_date=>#<Date: 2016-01-13 ((2457401j,0s,0n),+0s,2299161j)>, :valid=>true, :name=>"BRITISH BROADCASTING CORPORATION", :address=>"FAO ALEX FITZPATRICK\nBBC GROUP VAT MANAGER\nTHE LIGHT HOUSE (1ST FLOOR)\nMEDIA VILLAGE, 201 WOOD LANE\nLONDON\nW12 7TQ"}
+vat.valid? # true
+vat.exists? # true
+```
+
+VIES is available, the VAT ID is formatted correctly, but the VAT ID is not registered to a business:
+
+```ruby
+vat = VatCheck.new('GB999999999')
+vat.regex # true
+vat.vies_available # true
+vat.vies # false
+vat.response # {:country_code=>"GB", :vat_number=>"999999999", :request_date=>#<Date: 2016-01-13 ((2457401j,0s,0n),+0s,2299161j)>, :valid=>false, :name=>"---", :address=>"---"}
+vat.valid? # false
+vat.exists? # false
+```
+
+VAT is not formatted correctly:
+
+```ruby
+vat = VatCheck.new('XX123456789')
+vat.regex # false
+vat.vies # false
+vat.vies_available # false
+vat.response # {}
+vat.valid? # false
+vat.exists? # false
+```
+
+VAT is formatted correctly but VIES is unavailable:
+
+```ruby
+vat = VatCheck.new('GB333289454')
+vat.regex # true
+vat.vies_available # false
+vat.vies # false
+vat.response # {:error=>"Service unavailable"}
+vat.valid? # true
+vat.exists? # false
+```
+
+VAT is formatted correctly but VIES times out:
+
+```ruby
+vat = VatCheck.new('GB333289454')
+vat.regex # true
+vat.vies_available # false
+vat.vies # false
+vat.response # {:error=>"Service timed out"}
+vat.valid? # true
+vat.exists? # false
+```

data/lib/vat_check.rb

@@ -1,3 +1,8 @@
+require 'vat_check/utility'
+require 'vat_check/format'
+require 'vat_check/requests'
+require 'vat_check/version'
+
 class VatCheck
   attr_reader :regex, :vies, :vies_available, :response
 
@@ -18,8 +23,4 @@ class VatCheck
   def exists?
     return @vies
   end
-end
-
-require 'vat_check/utility'
-require 'vat_check/format'
-require 'vat_check/requests'
+end

data/lib/vat_check/requests.rb

@@ -3,7 +3,7 @@ require 'savon'
 class VatCheck
   module Request
     def self.lookup(vat)
-      client = Savon.client(wsdl: 'http://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl', log: false, log_level: :debug, pretty_print_xml: false)
+      client = Savon.client(wsdl: 'https://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl', follow_redirects: true, log: false, log_level: :debug, pretty_print_xml: false)
       country_code, vat_number = VatCheck::Utility.split(vat)
       begin
         response = client.call(:check_vat, message: {country_code: country_code, vat_number: vat_number}, message_tag: :checkVat)
@@ -19,4 +19,4 @@ class VatCheck
       end
     end
   end
-end
+end

data/lib/vat_check/version.rb

@@ -0,0 +1,3 @@
+class VatCheck
+  VERSION = '1.0.0'
+end

data/vat_check.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vat_check/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'vat_check'
+  s.version       = VatCheck::VERSION
+  s.authors       = ['TaxJar']
+  s.email         = 'support@taxjar.com'
+
+  s.summary       = 'Validate VAT IDs'
+  s.description   = 'A gem by TaxJar that can be used to validate VAT IDs'
+  s.homepage      = 'https://taxjar.com'
+  s.license       = 'MIT'
+
+  if s.respond_to?(:metadata)
+    s.metadata['source_code_uri'] = 'https://github.com/taxjar/vat_check'
+    s.metadata['bug_tracker_uri'] = 'https://github.com/taxjar/vat_check/issues'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.required_ruby_version = '>= 2.3'
+
+  s.add_runtime_dependency      'savon',    '~> 2.12',  '>= 2.12.0'
+
+  s.add_development_dependency  'rspec',    '~> 3.4'
+  s.add_development_dependency  'vcr',      '~> 5.1',   '>= 5.1.0'
+  s.add_development_dependency  'webmock',  '~> 3.8',  '>= 3.8.3'
+  s.add_development_dependency  'mocha',    '~> 1.1',   '>= 1.1.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vat_check
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - TaxJar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,40 +50,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 5.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 3.8.3
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -110,14 +110,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
 - lib/vat_check.rb
 - lib/vat_check/format.rb
 - lib/vat_check/requests.rb
 - lib/vat_check/utility.rb
-homepage: http://taxjar.com
+- lib/vat_check/version.rb
+- vat_check.gemspec
+homepage: https://taxjar.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/taxjar/vat_check
+  bug_tracker_uri: https://github.com/taxjar/vat_check/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.6
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -134,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Validate VAT IDs