eurovat 1.0.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Phusion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/lib/eurovat.rb

@@ -0,0 +1,145 @@
+require 'thread'
+begin
+  require 'soap/wsdlDriver'
+rescue LoadError
+  require 'savon'
+end
+
+class Eurovat
+  SERVICE_URL = 'http://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl'.freeze
+  VAT_FORMAT  = /\A([A-Z]{2})([0-9A-Za-z\+\*\.]{2,12})\Z/.freeze
+
+  # Names must be consistent with the country_select plugin. If you know
+  # alternative country spellings please add them here.
+  EU_MEMBER_STATES = [
+    'Austria',
+    'Belgium',
+    'Bulgaria',
+    'Cyprus',
+    'Czech Republic',
+    'Denmark',
+    'Estonia',
+    'Finland',
+    'France',
+    'Germany',
+    'Greece',
+    'Hungary',
+    'Ireland',
+    'Italy',
+    'Latvia',
+    'Lithuania',
+    'Luxembourg',
+    'Malta',
+    'Netherlands',
+    'Poland',
+    'Portugal',
+    'Romania',
+    'Slovakia',
+    'Slovenia',
+    'Spain',
+    'Sweden',
+    'United Kingdom'
+  ].freeze
+
+  class InvalidFormatError < StandardError
+  end
+
+  @@country  = 'Netherlands'
+  @@instance = nil
+
+  def self.country
+    @@country
+  end
+
+  def self.country=(val)
+    @@country = country
+  end
+
+  def self.must_charge_vat?(customer_country, vat_number)
+    # http://www.belastingdienst.nl/reken/diensten_in_en_uit_het_buitenland/
+    if customer_country == @@country
+      true
+    else
+      if present?(vat_number)
+        false
+      else
+        EU_MEMBER_STATES.include?(customer_country)
+      end
+    end
+  end
+
+  def self.check_vat_number(vat_number)
+    @@instance ||= new
+    @@instance.check_vat_number(vat_number)
+  end
+
+  def initialize
+    @country = @@country
+    @mutex   = Mutex.new
+    if defined?(SOAP)
+      @driver = SOAP::WSDLDriverFactory.new(SERVICE_URL).create_rpc_driver
+    else
+      @driver = Savon::Client.new(SERVICE_URL)
+    end
+  end
+
+  # Any exception other than InvalidFormatError indicates that the service is down.
+  def check_vat_number(vat_number)
+    vat_number = sanitize_vat_number(vat_number)
+    if vat_number =~ VAT_FORMAT
+      country_code = $1
+      number = $2
+      if @driver.respond_to?(:checkVat)
+        @mutex.synchronize do
+          begin
+            result = @driver.checkVat(
+              :countryCode => country_code,
+              :vatNumber => number)
+            result.valid == "true"
+          rescue SOAP::FaultError => e
+            if e.message == "INVALID_INPUT"
+              raise InvalidFormatError, "#{vat_number.inspect} is not formatted like a valid VAT number"
+            else
+              raise e
+            end
+          end
+        end
+      else
+        @mutex.synchronize do
+          begin
+            result = @driver.request(:checkVat) do
+              soap.body = {
+                :countryCode => country_code,
+                :vatNumber => number
+              }
+            end
+            result[:check_vat_response][:valid]
+          rescue Savon::SOAP::Fault => e
+            if e.message =~ /INVALID_INPUT/
+              raise InvalidFormatError, "#{vat_number.inspect} is not formatted like a valid VAT number"
+            else
+              raise e
+            end
+          end
+        end
+      end
+    else
+      raise InvalidFormatError, "#{vat_number.inspect} is not formatted like a valid VAT number"
+    end
+  end
+
+private
+  def self.present?(val)
+    if val.nil?
+      false
+    elsif val.is_a?(String)
+      !val.empty?
+    else
+      !!val
+    end
+  end
+
+  def sanitize_vat_number(vat_number)
+    vat_number.gsub(/[\s\t\.]/, '').upcase
+  end
+end

data/lib/eurovat/version.rb

@@ -0,0 +1,3 @@
+class Eurovat
+  VERSION_STRING = '1.0.0'
+end

data/test/eurovat_spec.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'rubygems'
+require 'eurovat'
+
+describe Eurovat do
+  # NL819225642B01 is Phusion's VAT number. If we ever go out of business replace
+  # it with any other valid VAT number to have the unit tests pass.
+
+  it "works" do
+    @eurovat = Eurovat.new
+    @eurovat.check_vat_number('NL819225642B01').should be_true
+    @eurovat.check_vat_number('NL010101010B99').should be_false
+  end
+
+  it "strips away spaces and dots" do
+    @eurovat = Eurovat.new
+    @eurovat.check_vat_number('nl8192.25 642.b01').should be_true
+  end
+
+  it "raises InvalidFormatError if the VAT number is not formatted like one" do
+    @eurovat = Eurovat.new
+    lambda { @eurovat.check_vat_number('foobar') }.should raise_error(Eurovat::InvalidFormatError)
+    lambda { @eurovat.check_vat_number('foobar!') }.should raise_error(Eurovat::InvalidFormatError)
+  end
+
+  it "always charges VAT if the customer is from one's own country" do
+    Eurovat.must_charge_vat?('Netherlands', nil).should be_true
+    Eurovat.must_charge_vat?('Netherlands', 'NL819225642B01').should be_true
+  end
+
+  it "doesn't charge VAT if the customer is outside one's own country and supplied a VAT number" do
+    Eurovat.must_charge_vat?('Germany', 'NL819225642B01').should be_false
+    Eurovat.must_charge_vat?('United States', 'NL819225642B01').should be_false
+  end
+
+  it "charges VAT if the customer is outside one's own country, but inside the EU, and didn't supply a VAT number" do
+    Eurovat.must_charge_vat?('Germany', nil).should be_true
+  end
+
+  it "doesn't charge VAT if the customer is outside one's own country, outside the EU, and didn't supply a VAT number" do
+    Eurovat.must_charge_vat?('United States', nil).should be_false
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: eurovat
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Hongli Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-21 00:00:00 Z
+dependencies: []
+
+description: A utility library for dealing with European Union VAT numbers
+email: info@phusion.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE.txt
+- lib/eurovat/version.rb
+- lib/eurovat.rb
+- test/eurovat_spec.rb
+homepage: https://github.com/phusion/eurovat
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: European Union VAT number utilities
+test_files: []
+
+has_rdoc: