valvat 0.3.6 → 0.4.0

data/CHANGES.md

@@ -1,6 +1,14 @@
 ### dev
 
-[full changelog](http://github.com/yolk/valvat/compare/v0.3.6...master)
+[full changelog](http://github.com/yolk/valvat/compare/v0.4.0...master)
+
+### 0.4.0 / 2012-07-17
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.3,6...v0.4.0)
+
+* Added support for company details and requester identifiers in successful responses
+(by [lcx](https://github.com/lcx)) 
+* Added Valvat::Lookup.last_error for debugging 
 
 ### 0.3.6 / 2012-04-10
 

data/Guardfile

@@ -1,5 +1,5 @@
 guard 'rspec', :version => 2 do
-  watch('^spec/(.*)_spec.rb')
-  watch('^lib/(.*)\.rb')                              { |m| "spec/#{m[1]}_spec.rb" }
-  watch('^spec/spec_helper.rb')                       { "spec" }
+  watch(/^spec\/(.*)_spec.rb/)
+  watch(/^lib\/(.*)\.rb/)          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^spec\/spec_helper.rb/)   { "spec" }
 end

data/README.md

@@ -28,7 +28,7 @@ To check if the given vat number exists via the VIES web service:
     Valvat.new("DE345789003").exists?
     => true or false or nil
   
-Keep in mind that the VIES web service might be offline at some time for some countries. If this happens `Valvat::Lookup.validate` returns `nil`.
+*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`.
 
 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.
 
@@ -41,6 +41,29 @@ Or to lookup a vat number string directly via VIES web service:
 
     Valvat::Lookup.validate("DE345789003")
     => true or false or nil
+    
+## 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)
+    => {
+      :country_code=>"IE", :vat_number => "6388047V", 
+      :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.
+
+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)
+
+    Valvat.new("LU21416127").exists?(:my_vat => "IE6388047V")
+    => {
+      :country_code=>"LU", :vat_number => "21416127", 
+      :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
 
 ## ActiveModel/Rails3 Usage
 
@@ -133,6 +156,14 @@ This basically just removes trailing spaces and ensures all chars are uppercase.
 * [European vat number formats (german)](http://bzst.de/DE/Steuern_International/USt_Identifikationsnummer/Merkblaetter/Aufbau_USt_IdNr.html)
 * [European vat number formats on Wikipedia](http://en.wikipedia.org/wiki/European_Union_Value_Added_Tax)
 
+## Contributions by
+
+* [lcx](https://github.com/lcx)
+* [opsidao](https://github.com/opsidao)
+* [henrik](https://github.com/henrik)
+* [SpoBo](https://github.com/SpoBo)
+* [Deb Bassett](https://github.com/urbanwide)
+
 ## BlaBla
 
 Copyright (c) 2011 Yolk Sebastian Munz & Julia Soergel GbR

data/lib/valvat.rb

@@ -10,8 +10,8 @@ class Valvat
     Valvat::Syntax.validate(self)
   end
 
-  def exists?
-    Valvat::Lookup.validate(self)
+  def exists?(options={})
+    Valvat::Lookup.validate(self, options)
   end
   alias_method :exist?, :exists?
 
@@ -43,5 +43,7 @@ end
 require 'valvat/utils'
 require 'valvat/syntax'
 require 'valvat/lookup'
+require 'valvat/lookup/request'
+require 'valvat/lookup/request_with_id'
 require 'valvat/version'
 require 'valvat/active_model' if defined?(ActiveModel)

data/lib/valvat/lookup.rb

@@ -5,16 +5,20 @@ require 'yaml'
 class Valvat
   module Lookup
 
-    def self.validate(vat)
+    def self.validate(vat, options={})
       vat = Valvat(vat)
       return false unless vat.european?
 
+      request = options[:requester_vat] ? 
+        Valvat::Lookup::RequestWithId.new(vat, Valvat(options[:requester_vat])) : 
+        Valvat::Lookup::Request.new(vat)
+      
       begin
-        client.request("n1", "checkVat") do
-          soap.body = {"n1:countryCode" => vat.vat_country_code, "n1:vatNumber" => vat.to_s_wo_country}
-          soap.namespaces["xmlns:n1"] = "urn:ec.europa.eu:taxud:vies:services:checkVat:types"
-        end.to_hash[:check_vat_response][:valid]
+        response = request.perform(self.client)
+        response[:valid] && (options[:detail] || options[:requester_vat]) ? 
+          filter_detail(response) : response[:valid]
       rescue => err
+        @last_error = err
         if err.respond_to?(:to_hash) && err.to_hash[:fault] && err.to_hash[:fault][:faultstring] == "{ 'INVALID_INPUT' }"
           return false
         end
@@ -36,5 +40,23 @@ class Valvat
         end
       end
     end
+    
+    def self.last_error
+      @last_error
+    end
+    
+    private
+    
+    REMOVE_KEYS = [:valid, :@xmlns] 
+    
+    def self.filter_detail(response)
+      response.inject({}) do |hash, kv|
+        key, value = kv
+        unless REMOVE_KEYS.include?(key)
+          hash[key.to_s.sub(/^trader_/, "").to_sym] = (value == "---" ? nil : value)
+        end
+        hash
+      end
+    end
   end
 end

data/lib/valvat/lookup/request.rb

@@ -0,0 +1,30 @@
+class Valvat
+  module Lookup
+    class Request
+      def initialize(vat)
+        @vat = vat
+      end
+      
+      def perform(client)
+        client.request("n1", action) do
+          soap.body = body
+          soap.namespaces["xmlns:n1"] = "urn:ec.europa.eu:taxud:vies:services:checkVat:types"    
+        end.to_hash[response_key]
+      end
+      
+      private
+      
+      def body
+        {"n1:countryCode" => @vat.vat_country_code, "n1:vatNumber" => @vat.to_s_wo_country}
+      end
+      
+      def action
+        "checkVat"
+      end
+      
+      def response_key
+        :check_vat_response
+      end
+    end
+  end
+end

data/lib/valvat/lookup/request_with_id.rb

@@ -0,0 +1,27 @@
+class Valvat
+  module Lookup
+    class RequestWithId < Request
+      def initialize(vat, requester_vat)
+        @vat = vat
+        @requester_vat = requester_vat
+      end
+      
+      private
+      
+      def body
+        super.merge(
+          "n1:requesterCountryCode" => @requester_vat.vat_country_code, 
+          "n1:requesterVatNumber" => @requester_vat.to_s_wo_country
+        )
+      end
+      
+      def action
+        "checkVatApprox"
+      end
+      
+      def response_key
+        :check_vat_approx_response
+      end
+    end
+  end
+end

data/lib/valvat/version.rb

@@ -1,3 +1,3 @@
 class Valvat
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/spec/valvat/lookup_spec.rb

@@ -27,6 +27,47 @@ describe Valvat::Lookup do
         Valvat::Lookup.validate("").should eql(false)
       end
     end
+    
+    context "with details" do
+      it "returns hash of details instead of true" do
+        Valvat::Lookup.validate("IE6388047V", :detail => true).should eql({
+          :country_code=>"IE", 
+          :vat_number=>"6388047V", 
+          :request_date=> Date.today, 
+          :name=>"GOOGLE IRELAND LIMITED", 
+          :address=>"1ST & 2ND FLOOR ,GORDON HOUSE ,BARROW STREET ,DUBLIN 4"
+        })
+        
+        Valvat::Lookup.validate("LU21416127", :detail => true).should eql({
+          :country_code=>"LU", 
+          :vat_number=>"21416127", 
+          :request_date=> Date.today, 
+          :name=>"EBAY EUROPE S.A R.L.", 
+          :address=>"22, BOULEVARD ROYAL\nL-2449  LUXEMBOURG"
+        })
+      end
+      
+      it "still returns false on not existing vat number" do
+        Valvat::Lookup.validate("BE08173319921", :detail => true).should eql(false)
+      end
+    end
+    
+    context "with request identifier" do
+      it "returns hash of details instead of true" do
+        response = Valvat::Lookup.validate("LU21416127", :requester_vat => "IE6388047V")
+        response[:request_identifier].size.should eql(16)
+        response[:request_identifier] = "some_uniq_string"
+        response.should eql({
+          :country_code=>"LU", 
+          :vat_number=>"21416127", 
+          :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"
+        })
+      end
+    end
 
     # TODO : Reactivate with coorect "down" response
     # context "country web service down" do

data/spec/valvat_spec.rb

@@ -68,6 +68,13 @@ describe Valvat do
           at_vat.exist?.should eql(false)
         end
       end
+
+      context "with options" do
+        it "calls Valvat::Lookup.validate with options" do
+          Valvat::Lookup.should_receive(:validate).once.with(de_vat, :detail => true, :bla => 'blupp').and_return(true)
+          de_vat.exists?(:detail => true, :bla => 'blupp').should eql(true)
+        end
+      end
     end
 
     context "#iso_country_code" do

data/valvat.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec',       '>= 2.4.0'
   s.add_development_dependency 'guard-rspec', '>=0.1.9'
   s.add_development_dependency 'growl',       '>=1.0.3'
-  s.add_development_dependency 'rb-fsevent',  '>=0.3.9'
+  s.add_development_dependency 'rb-fsevent',  '>=0.9.1'
   s.add_development_dependency 'activemodel', '>=3.0'
   s.add_development_dependency 'fakeweb',     '>= 1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valvat
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &2151816700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 0.8.2
   type: :runtime
   prerelease: false
-  version_requirements: *2151816700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2151816160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2151816160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2151815160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 0.1.9
   type: :development
   prerelease: false
-  version_requirements: *2151815160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.9
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &2151814240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +69,31 @@ dependencies:
         version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *2151814240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &2151813380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: 0.9.1
   type: :development
   prerelease: false
-  version_requirements: *2151813380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2151827280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2151827280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2151826400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +117,12 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *2151826400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 description: ! "  Validates european vat numbers. Standalone or as a ActiveModel validator.\n\n
   \ * Simple syntax verification\n  * Lookup via the VIES web service\n  * Works standalone
   without any gem dependencies\n  * (Optional) ActiveModel/Rails3 integration\n  *
@@ -112,6 +147,8 @@ files:
 - lib/valvat/locales/en.yml
 - lib/valvat/locales/sv.yml
 - lib/valvat/lookup.rb
+- lib/valvat/lookup/request.rb
+- lib/valvat/lookup/request_with_id.rb
 - lib/valvat/syntax.rb
 - lib/valvat/utils.rb
 - lib/valvat/version.rb
@@ -134,15 +171,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 674123835255991256
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 674123835255991256
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Validates european vat numbers. Standalone or as a ActiveModel validator.