elfproef 0.0.3 → 0.1.0

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -2,12 +2,10 @@
 
 [![Build Status](https://secure.travis-ci.org/sytzeloor/elfproef.png?branch=master)](http://travis-ci.org/sytzeloor/elfproef)
 
-This gem adds a validation method for Dutch bank account numbers and
-Citizen Service Numbers (BSN). These can be validated using the
-so-called Elfproef.
+This gem adds two validators to your arsenal:
 
-Based on:
-[Elfproef](https://github.com/tilsammans/elfproef/) by tilsammans
+  * BsnValidator will validate Burgerservicenummers (Dutch social security numbers). It accepts both 8 and 9 digit BSN numbers.
+  * BankAccountValidator will validate ING accounts (1-7 digits), and 9 or 10 digit bank account numbers using the elven-test.
 
 ## Installation
 
@@ -25,16 +23,25 @@ and run
 
 ## Usage
 
-Simply add "validates_elfproef_of" to your model class.
+Using the BsnValidator
 
-	class User < ActiveRecord::Base
-    # Validate with 11-test, do not allow 7 digit ING account numbers
-		validates :bsn, elfproef: true
+    class User < ActiveRecord::Base
+      validates :bsn_number, bsn: true
+    end
 
-    # Validate bank account numbers with 11-test, allow 7 digit ING account numbers
-		validates :bank_account, elfproef: { allow_ing: true }
+Using the BankAccountValidator
+
+    class User < ActiveRecord::Base
+      validates :account_number, bank_account: true
 	end
 
+You can also use these validators without `ActiveRecord` by including `ActiveModel::Validations`.
+   
+    class AwesomeDutchPerson
+      include ActiveModel::Validations
+      validates :bsn, bsn: true
+    end
+
 ## Bugs / Feature Requests
 
 Please post them to

data/elfproef.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "version"
+require "elfproef/version"
 
 Gem::Specification.new do |s|
   s.name        = "elfproef"

data/lib/elfproef.rb

@@ -1,30 +1,3 @@
-require "active_model"
-require "active_model/validations"
-
-# define my validator
-class ElfproefValidator < ActiveModel::EachValidator
-  # implement the method where the validation logic must reside
-  def validate_each(record, attribute, value)
-    record.errors.add(attribute, options[:message] || "is not valid") unless Elfproef.elfproef(value, options)
-  end
-end
-
-
-# Elfproef.
-module Elfproef
-  # Calculates the elfproef of a Dutch bank account number or Citizen Service Number (BSN).
-  # Return value should be 0 (proof succeeded). Any other value means faillure.
-  # Postbank bank accounts (7 digits) cannot be validated using the elfproef and
-  # will always return 0 (success).
-  # http://nl.wikipedia.org/wiki/Elfproef
-  def self.elfproef(number, options = {})
-    number, sum = number.to_s, 0
-    number.gsub!(/\D/, '')                                                # strip out any non-digit character.
-    return true if options[:allow_ing] && (1..7).include?(number.length)  # always pass ING accounts (between 1 and 7 digits)
-    return false unless (9..10).include?(number.length)                   # account should be exactly 9 or 10 digits
-    (1..number.length).each do |c|
-      sum += number[-c].chr.to_i * c
-    end
-    sum % 11 == 0
-  end
-end
+require 'elfproef/version'
+require 'elfproef/bsn_validator'
+require 'elfproef/bank_account_validator'

data/lib/elfproef/bank_account_validator.rb

@@ -0,0 +1,56 @@
+require "active_model"
+require "active_model/validations"
+
+# Validates if the specified value is a valid
+# bank account number using the 11-test
+class BankAccountValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, options[:message] || "is not valid") unless validate_account_number(value, options)
+  end
+
+  private
+
+  # Takes the bank account number and returns true if:
+  #
+  #  * The number is 1...7 digit ING account number (no verification is possible)
+  #  * Is 9 or 10 digits and passes the 11-test
+  #
+  def validate_account_number(value, options = {})
+    number = value.to_s.gsub(/\D/, '').strip
+
+    # Not valid if length is 0, 8 or > 10
+    return false if number.length == 0 || number.length == 8 || number.length > 10
+
+    # ING account numbers
+    return true if (1..7).include?(number.length)
+
+    # Validate length 9 and 10 numbers as bank accounts
+    validate_with_eleven_test(number)
+  end
+
+  # Performs the actual 11-test on a
+  # 9 or 10 digit account number
+  #
+  #  For 10 digits (prefix with a 0 for 9 digits):
+  #
+  #   0123456789
+  #   ABCDEFGHIJ
+  #
+  #   sum = 1*A + 2*B + 3*C + 4*D + 5*E + 6*F + 7*G + 8*H + 9*I + 10*J
+  #
+  # If sum % 11 is 0, the number is valid, otherwise
+  # a typo has been made or the number is outright invalid.
+  def validate_with_eleven_test(number)
+    # Make sure we have a 10 digit account number,
+    # Prefix with a 0 if necessary
+    number = "0#{number}" if number.length == 9
+
+    # Calculate the sum
+    sum = 0
+    number.split("").each_with_index do |char, i|
+      sum += char.to_i * (i+1)
+    end
+
+    sum % 11 == 0
+  end
+end

data/lib/elfproef/bsn_validator.rb

@@ -0,0 +1,41 @@
+require "active_model"
+require "active_model/validations"
+
+# Validates if the specified value is a valid
+# Burgerservicenummer (Dutch social security number)
+class BsnValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, options[:message] || "is not valid") unless validate_bsn(value, options)
+  end
+
+  private
+
+  # A BSN is an 8 or 9 digit Dutch social security
+  # number.
+  def validate_bsn(value, options = {})
+    bsn = value.to_s.gsub(/\D/, '').strip
+
+    # Only allow 8 or 9 digits
+    return false if bsn.length < 8 || bsn.length > 9
+
+    # Validate with the advanced eleven test
+    validate_with_advanced_eleven_test(bsn)
+  end
+
+  def validate_with_advanced_eleven_test(number)
+    # Make sure we have 9 digits
+    number = "0#{number}" if number.size == 8
+
+    numbers = number.split("").map(&:to_i)
+    control, numbers = numbers.pop, numbers.reverse
+
+
+    sum = 0
+    numbers.each_with_index do |digit, i|
+      sum += digit * (i+2)
+    end
+
+    sum.remainder(11) == control
+  end
+end
+

data/lib/{version.rb → elfproef/version.rb}

@@ -1,3 +1,3 @@
 module Elfproef
-  VERSION= "0.0.3"
+  VERSION= "0.1.0"
 end

data/spec/bank_account_validator_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BankAccountValidator do
+  subject {
+    Class.new do
+      include ActiveModel::Validations
+      attr_accessor :account
+      validates :account, :bank_account => true
+    end.new
+  }
+
+  let(:errors) { ["is not valid"] }
+
+  it "accepts 1 digit ING accounts" do
+    subject.account = "1"
+    subject.should be_valid
+  end
+
+  it "accepts 2 digit ING accounts" do
+    subject.account = "12"
+    subject.should be_valid
+  end
+
+  it "accepts 3 digit ING accounts" do
+    subject.account = "3"
+    subject.should be_valid
+  end
+
+  it "accepts 4 digit ING accounts" do
+    subject.account = "4"
+    subject.should be_valid
+  end
+
+  it "accepts 5 digit ING accounts" do
+    subject.account = "5"
+    subject.should be_valid
+  end
+
+  it "accepts 6 digit ING accounts" do
+    subject.account = "6"
+    subject.should be_valid
+  end
+
+  it "accepts 7 digit ING accounts" do
+    subject.account = "7"
+    subject.should be_valid
+  end
+
+  it "accepts a valid 9 digit bank account number" do
+    subject.account = "123456789"
+    subject.should be_valid
+  end
+
+  it "accepts a valid 10 digit bank account number" do
+    subject.account = "0123456789"
+    subject.should be_valid
+  end
+
+  it "fails on an 8 digit number" do
+    subject.account = "12345678"
+    subject.should_not be_valid
+    subject.errors[:account].should == errors
+  end
+
+  it "fails on obviously wrong numbers" do
+    subject.account = "CHUCKNORRIS"
+    subject.should_not be_valid
+    subject.errors[:account].should == errors
+  end
+
+  it "fails on 1 digit errors" do
+    subject.account = "133456789"
+    subject.should_not be_valid
+    subject.errors[:account].should == errors
+  end
+end

data/spec/bsn_validator_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BsnValidator do
+  subject {
+    Class.new do
+      include ActiveModel::Validations
+      attr_accessor :number
+      validates :number, :bsn => true
+    end.new
+  }
+
+  let(:errors) { ["is not valid"] }
+
+  it "accepts an 8 digit bsn" do
+    subject.number = "12345672"
+    subject.should be_valid
+  end
+
+  it "accepts a 9 digit bsn" do
+    subject.number = "123456782"
+    subject.should be_valid
+  end
+
+  it "rejects too short bsn numbers" do
+    subject.number = "123"
+    subject.should_not be_valid
+    subject.errors[:number].should == errors
+  end
+
+  it "rejects too long bsn numbers" do
+    subject.number = "123456789012345"
+    subject.should_not be_valid
+    subject.errors[:number].should == errors
+  end
+
+  it "rejects obvious incorrect bsn numbers" do
+    subject.number = "NOTAXES"
+    subject.should_not be_valid
+    subject.errors[:number].should == errors
+  end
+
+  it "rejects mistyped bsn numbers" do
+    subject.number = "123456789012345"
+    subject.should_not be_valid
+    subject.errors[:number].should == errors
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elfproef
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70105363295440 !ruby/object:Gem::Requirement
+  requirement: &70122195961320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105363295440
+  version_requirements: *70122195961320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70105363294960 !ruby/object:Gem::Requirement
+  requirement: &70122195960660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105363294960
+  version_requirements: *70122195960660
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70105363294520 !ruby/object:Gem::Requirement
+  requirement: &70122195959980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70105363294520
+  version_requirements: *70122195959980
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70105363293980 !ruby/object:Gem::Requirement
+  requirement: &70122195959000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70105363293980
+  version_requirements: *70122195959000
 description: Validation for Dutch bank account numbers and Citizen Service Numbers
   (BSN)
 email:
@@ -68,12 +68,16 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - elfproef.gemspec
 - lib/elfproef.rb
-- lib/version.rb
-- spec/elfproef_spec.rb
+- lib/elfproef/bank_account_validator.rb
+- lib/elfproef/bsn_validator.rb
+- lib/elfproef/version.rb
+- spec/bank_account_validator_spec.rb
+- spec/bsn_validator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sytzeloor/elfproef
 licenses: []
@@ -87,18 +91,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1515901023488646711
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1515901023488646711
 requirements: []
 rubyforge_project: elfproef
-rubygems_version: 1.8.17
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Validation for Dutch bank account numbers and Citizen Service Numbers (BSN)
 test_files:
-- spec/elfproef_spec.rb
+- spec/bank_account_validator_spec.rb
+- spec/bsn_validator_spec.rb
 - spec/spec_helper.rb

data/spec/elfproef_spec.rb

@@ -1,160 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe Elfproef do
-  account_class = Class.new do
-    include ActiveModel::Validations
-    attr_accessor :account
-    validates :account, :elfproef => { :allow_ing => true }
-  end
-
-  bank_only_class = Class.new do
-    include ActiveModel::Validations
-    attr_accessor :account
-    validates :account, :elfproef => true
-  end
-
-  # Nine digets are not allowed
-  it "tests account format" do
-    Elfproef.elfproef(123456).should == false
-    Elfproef.elfproef(1234567890).should == false
-    Elfproef.elfproef('12345678a').should == false
-  end
-
-  # Invalid accounts will a value greather then 0
-  it "tests invalid accounts" do
-    Elfproef.elfproef(999999999).should == false
-    Elfproef.elfproef('99.99.99.999').should == false
-    Elfproef.elfproef('99 99 99 999').should == false
-  end
-
-  # Valid accounts will return 0
-  it "tests valid accounts" do
-    Elfproef.elfproef(123456789).should == true
-    Elfproef.elfproef('12.34.56.789').should == true
-    Elfproef.elfproef('12 34 56 789').should == true
-  end
-
-  it "tests valid ING accounts" do
-    opts = { :allow_ing => true }
-    Elfproef.elfproef(1234567, opts).should == true
-    Elfproef.elfproef('1234567', opts).should == true
-  end
-
-  shared_examples_for "elfproef validations" do
-    subject { account_class.new }
-
-    it "fails when empty" do
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-
-    it "fails with an obviously wrong number" do
-      subject.account = "12345678901"
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-
-    it "passes with a 7-diget ING number" do
-      subject.account = "1234567"
-      subject.should be_valid
-    end
-
-    it "passes with a 6-digit ING number" do
-      subject.account = "123456"
-      subject.should be_valid
-    end
-
-    it "passes with a 5-digit ING number" do
-      subject.account = "12345"
-      subject.should be_valid
-    end
-
-    it "passes with a 4-digit ING number" do
-      subject.account = "1234"
-      subject.should be_valid
-    end
-
-    it "passes with a 3-digit ING number" do
-      subject.account = "123"
-      subject.should be_valid
-    end
-
-    it "passes with a 2-digit ING number" do
-      subject.account = "12"
-      subject.should be_valid
-    end
-
-    it "passes with a 1-digit ING number" do
-      subject.account = "1"
-      subject.should be_valid
-    end
-
-    it "passes with a ING number starting with a P (from Postbank)" do
-      subject.account = "P1234567"
-      subject.should be_valid
-    end
-
-    it "passes with a valid 9-digit bank number" do
-      subject.account = "123456789"
-      subject.should be_valid
-    end
-
-    it "passes with a valid 10-digit bank number" do
-      subject.account = "0123456789"
-      subject.should be_valid
-    end
-
-    it "fails with an wrong bank number" do
-      subject.account = "999999999"
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-  end
-
-  shared_examples_for "elfproef, bank accounts only validations" do
-    subject { bank_only_class.new }
-
-    it "fails when empty" do
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-
-    it "fails with an obviously wrong number" do
-      subject.account = "666"
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-
-    it "fails with a ING number" do
-      subject.account = "1234567"
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-
-    it "passes with a valid 9-digit bank number" do
-      subject.account = "123456789"
-      subject.should be_valid
-    end
-
-    it "passes with a valid 10-digit bank number" do
-      subject.account = "0123456789"
-      subject.should be_valid
-    end
-
-    it "fails with an wrong bank number" do
-      subject.account = "999999999"
-      subject.should_not be_valid
-      subject.errors[:account].should == errors
-    end
-  end
-
-  describe "bank + ing validations" do
-    let!(:errors) { [ "is not valid"] }
-    it_should_behave_like "elfproef validations"
-  end
-
-  describe "bank only validations" do
-    let!(:errors) { [ "is not valid"] }
-    it_should_behave_like "elfproef, bank accounts only validations"
-  end
-end