valvat 0.1.0 → 0.1.1

data/CHANGES.md

@@ -1,6 +1,14 @@
 ### dev
 
-[full changelog](http://github.com/yolk/valvat/compare/v0.1.0...master)
+[full changelog](http://github.com/yolk/valvat/compare/v0.1.1...master)
+
+### 0.1.1 / 2011-01-07
+
+[full changelog](http://github.com/yolk/valvat/compare/v0.1.0...v0.1.1)
+
+* Fixed issue with country web service down and added spec
+* Stubbed web service specs with fakeweb
+* Added documentation for ActiveModel support
 
 ### 0.1.0 / 2011-01-07
 

data/README.md

@@ -1,8 +1,16 @@
 ## valvat
 
-Validates european vat numbers. Supports simple syntax verification and lookup via the VIES web service.
+Validates european vat numbers. Standalone or as an ActiveModel validator.
 
-valvat is tested and works with ruby 1.8.7 and 1.9.2.
+### Features
+
+* Simple syntax verification
+* Lookup via the VIES web service
+* Works standalone without any gem dependencies
+* (Optional) ActiveModel/Rails3 integration
+* I18n locales for country specific error messages
+
+valvat is tested and works with ruby 1.8.7/1.9.2 and ActiveModel 3.0.
 
 ### Installation
 
@@ -24,6 +32,32 @@ Keep in mind that the VIES webservice might be offline at some time for some cou
 
 See 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.
 
+### ActiveModel/Rails3 Usage
+
+When the valvat gem is required and ActiveModel is already loaded, everything will work fine out of the box. If your load order differs just add
+
+  require 'valvat/active_model'
+  
+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
+  end
+  
+To additionally perform a lookup via VIES:
+
+  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}
+  
+By default blank vat numbers validate to false, to change this add the _:allow_blank_ option:
+
+  validates :vat_number, :valvat => {:allow_blank => true}
+
 ### Utilities
 
 To split a vat number into the ISO country code and the remaining chars:

data/lib/valvat/lookup.rb

@@ -8,11 +8,15 @@ module Valvat
       parts = Valvat::Utils.split(vat)
       return false unless parts[0]
       
-      YAML.load(Net::HTTP.start("isvat.appspot.com", 80) {|http|
-        http.get("/#{parts.join("/")}/")
-      }.body)
-    rescue
-      nil
+      result = begin
+        YAML.load(Net::HTTP.start("isvat.appspot.com", 80) {|http|
+          http.get("/#{parts.join("/")}/")
+        }.body)
+      rescue
+        nil
+      end
+      
+      result.is_a?(Hash) && result["error_code"] == 1 ? nil : result
     end
   end
 end

data/lib/valvat/version.rb

@@ -1,3 +1,3 @@
 module Valvat
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/spec_helper.rb

@@ -1,8 +1,11 @@
 require 'rspec'
 require 'active_model'
+require 'fakeweb'
 
 require File.dirname(__FILE__) + '/../lib/valvat.rb'
 
+$fakeweb = true
+
 class ModelBase
   include ActiveModel::Serialization
   include ActiveModel::Validations

data/spec/valvat/lookup_spec.rb

@@ -2,17 +2,46 @@ require 'spec_helper'
 
 describe Valvat::Lookup do
   context "#validate" do
-    it "returns true on existing vat number" do
-      Valvat::Lookup.validate("BE0817331995").should eql(true)
+    context "existing vat number" do
+      before do
+        FakeWeb.register_uri(:get, "http://isvat.appspot.com/BE/0817331995/", :body => "true")
+      end if $fakeweb
+      
+      it "returns true" do
+        Valvat::Lookup.validate("BE0817331995").should eql(true)
+      end
     end
     
-    it "returns false on not existing vat number" do
-      Valvat::Lookup.validate("BE0817331994").should eql(false)
+    context "not existing vat number" do
+      before do
+        FakeWeb.register_uri(:get, "http://isvat.appspot.com/BE/0817331995/", :body => "false")
+      end if $fakeweb
+      
+      it "returns false" do
+        Valvat::Lookup.validate("BE0817331995").should eql(false)
+      end
     end
     
-    it "returns false on invalid country code / input" do
-      Valvat::Lookup.validate("AE259597697").should eql(false)
-      Valvat::Lookup.validate("").should eql(false)
+    context "invalid country code / input" do
+      before do
+        FakeWeb.register_uri(:get, "http://isvat.appspot.com/AE/259597697/", :body => "false")
+      end if $fakeweb
+      
+      it "returns false" do
+        Valvat::Lookup.validate("AE259597697").should eql(false)
+        Valvat::Lookup.validate("").should eql(false)
+      end
+    end
+    
+    context "country web service down" do
+      before do
+        json = "{\"error_message\": \"Member State service unavailable.\", \"error_code\": 1, \"error\": true}"
+        FakeWeb.register_uri(:get, "http://isvat.appspot.com/DE/259597697/", :body => json)
+      end if $fakeweb
+      
+      it "returns nil" do
+        Valvat::Lookup.validate("DE259597697").should eql(nil)
+      end
     end
   end
 end

data/valvat.gemspec

@@ -9,9 +9,19 @@ Gem::Specification.new do |s|
   s.authors     = ["Sebastian Munz"]
   s.email       = ["sebastian@yo.lk"]
   s.homepage    = "https://github.com/yolk/valvat"
-  s.summary     = %q{Validates european vat numbers. Supports simple syntax verification and lookup via the VIES web service.}
-  s.description = %q{Validates european vat numbers. Supports simple syntax verification and lookup via the VIES web service.}
-
+  s.summary     = %q{Validates european vat numbers. Standalone or as an ActiveModel validator.}
+  s.description = <<-END
+  Validates european vat numbers. Standalone or as an ActiveModel validator.
+  
+  * Simple syntax verification
+  * Lookup via the VIES web service
+  * Works standalone without any gem dependencies
+  * (Optional) ActiveModel/Rails3 integration
+  * I18n locales for country specific error messages
+  END
+  
+  
+  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -22,4 +32,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'growl', '>=1.0.3'
   s.add_development_dependency 'rb-fsevent', '>=0.3.9'
   s.add_development_dependency 'activemodel', '>=3.0'
+  s.add_development_dependency 'fakeweb'
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sebastian Munz
@@ -91,7 +91,20 @@ dependencies:
         version: "3.0"
   type: :development
   version_requirements: *id005
-description: Validates european vat numbers. Supports simple syntax verification and lookup via the VIES web service.
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: "  Validates european vat numbers. Standalone or as an 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  * I18n locales for country specific error messages\n"
 email: 
 - sebastian@yo.lk
 executables: []
@@ -155,7 +168,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Validates european vat numbers. Supports simple syntax verification and lookup via the VIES web service.
+summary: Validates european vat numbers. Standalone or as an ActiveModel validator.
 test_files: 
 - spec/spec_helper.rb
 - spec/valvat/active_model_spec.rb