elfproef 0.1.3 → 0.1.4

data/README.md

@@ -2,10 +2,11 @@
 
 [![Build Status](https://secure.travis-ci.org/sytzeloor/elfproef.png?branch=master)](http://travis-ci.org/sytzeloor/elfproef)
 
-This gem adds two validators to your arsenal:
+This gem adds three validators to your arsenal:
 
   * 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.
+  * PaymentReferenceValidator will validate betalingskenmerken (Dutch payment reference numbers) using a weighted modulus 11 and a length check.
 
 ## Installation
 
@@ -35,6 +36,12 @@ Using the BankAccountValidator
       validates :account_number, bank_account: true
 	end
 
+Using the PaymentReferenceValidator
+
+    class User < ActiveRecord::Base
+      validates :reference, payment_reference: true
+    end
+
 You can also use these validators without `ActiveRecord` by including `ActiveModel::Validations`.
    
     class AwesomeDutchPerson
@@ -55,6 +62,7 @@ Add the following to your locale file:
                 ATTRIBUTE:
                   invalid_bank_account: "is not a valid bank account number"
                   invalid_bsn: "is not a valid BSN"
+                  invalid_payment_reference: "is not a valid payment reference"
 
 ## Bugs / Feature Requests
 

data/elfproef.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Sytze Loor", "Ariejan de Vroom"]
   s.email       = ["sytze@tweedledum.nl", "ariejan@ariejan.net"]
   s.homepage    = "https://github.com/sytzeloor/elfproef"
-  s.summary     = %q{Validation for Dutch bank account numbers and Citizen Service Numbers (BSN)}
-  s.description = %q{Validation for Dutch bank account numbers and Citizen Service Numbers (BSN)}
+  s.summary     = %q{Validation for Dutch bank account numbers, Citizen Service Numbers (BSN) and Payment reference}
+  s.description = %q{Validation for Dutch bank account numbers, Citizen Service Numbers (BSN) and Payment reference}
 
   s.rubyforge_project = "elfproef"
 

data/lib/elfproef/payment_reference_validator.rb

@@ -0,0 +1,87 @@
+require 'active_model/validator'
+require 'active_support/concern'
+
+# Validates if the specified value is a valid
+# payment reference number using a weighted modulus 11
+class PaymentReferenceValidator < ::ActiveModel::EachValidator
+  extend ActiveSupport::Concern
+
+  def validate_each(record, attribute, value)
+    unless self.class.validate_payment_reference(value, options)
+      record.errors.add(attribute, :invalid_payment_reference, options)
+    end
+  end
+
+  # Takes the payment reference number and returns true if:
+  #
+  #  * The number is exact 7 digits (no verification is possible)
+  #  * Is between 9 and 14 digits, has the correct check digit and has the correct length digit
+  #  * Is exact 16 digits and has the correct check digit
+  #
+  def self.validate_payment_reference(value, options = {})
+    number = value.to_s.gsub(/\D/, '').strip
+
+    # Not valid if payment reference length is < 7, 8, 15 or > 16
+    return false if number.length < 7 || number.length == 8 || number.length == 15 || number.length > 16
+
+    # No further verification possible for 7 digit payment references
+    return true if number.length == 7
+
+    # For payment references between 9 and 14 digits validate it has the correct length digit
+    self.validate_length_digit(number) if (9..14).include?(number.length)
+
+    # Validate the check digit
+    self.validate_check_digit(number)
+  end
+
+  private
+
+  # Validates the length digit. This is the second digit when 
+  # a payment reference is between 9 and 14 digits
+  #
+  # Possible values:
+  #   7  for a  9-digit payment reference
+  #   8  for a 10-digit payment reference
+  #   9  for a 11-digit payment reference
+  #   0  for a 12-digit payment reference
+  #   1  for a 13-digit payment reference
+  #   2  for a 14-digit payment reference
+  #
+  def self.validate_length_digit(number)
+    number[1].chr.to_i == number.length - (number.length > 11 ? 12 : 2)
+  end
+
+  # Validates the check digit. This is the first digit when a payment
+  # reference is between 9 and 14 digits or is exact 16 digits
+  #
+  # The check digit is calculated using a weighted modulus 11:
+  #
+  #   c123456789012345
+  #    ABCDEFGHIJKLMNO
+  #
+  #   sum = 10*A + 5*B + 8*C + 4*D + 2*E + 1*F + 6*G + 3*H + 7*I + 9*J + 10*K + 5*L + 8*M + 4*N + 2*O
+  #   c = 11 - (sum % 11)
+  #
+  # The check digit is equal to c, with two exceptions. The check digit is
+  #   0 when c == 10
+  #   1 when c == 11
+  def self.validate_check_digit(number)
+    # Remove the first digit (check digit) from the payment reference.
+    # To calculate the sum we need a 15 digit payment reference, 
+    # prefix with 0 if necessary.
+    reference = number[1..-1].rjust(15,"0").split("")
+    weights = [10,5,8,4,2,1,6,3,7,9,10,5,8,4,2]
+
+    # Calculate the sum
+    sum = 0
+    i = 0
+    while i < 15
+      sum += reference[i].to_i * weights[i]
+      i += 1
+    end
+    check_digit = 11 - (sum % 11)
+    check_digit -= 10 if check_digit >= 10
+
+    number[0].chr.to_i == check_digit
+  end
+end

data/lib/elfproef/version.rb

@@ -1,3 +1,3 @@
 module Elfproef
-  VERSION= "0.1.3"
+  VERSION= "0.1.4"
 end

data/lib/elfproef.rb

@@ -1,3 +1,4 @@
 require 'elfproef/version'
 require 'elfproef/bsn_validator'
 require 'elfproef/bank_account_validator'
+require 'elfproef/payment_reference_validator'

data/spec/bank_account_validator_spec.rb

@@ -22,27 +22,37 @@ describe BankAccountValidator do
   end
 
   it "accepts 3 digit ING accounts" do
-    subject.account = "3"
+    subject.account = "123"
     subject.should be_valid
   end
 
   it "accepts 4 digit ING accounts" do
-    subject.account = "4"
+    subject.account = "1234"
     subject.should be_valid
   end
 
   it "accepts 5 digit ING accounts" do
-    subject.account = "5"
+    subject.account = "12345"
     subject.should be_valid
   end
 
   it "accepts 6 digit ING accounts" do
-    subject.account = "6"
+    subject.account = "123456"
     subject.should be_valid
   end
 
   it "accepts 7 digit ING accounts" do
-    subject.account = "7"
+    subject.account = "1234567"
+    subject.should be_valid
+  end
+
+  it "accepts P-prefixed ING accounts" do
+    subject.account = "P123"
+    subject.should be_valid
+  end
+
+  it "accepts P-prefixed ING accounts with 7 digits" do
+    subject.account = "P1234567"
     subject.should be_valid
   end
 

data/spec/payment_reference_validator_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class PaymentReferenceTest
+  include ActiveModel::Validations
+  attr_accessor :reference
+  validates :reference, :payment_reference => true
+end
+
+describe PaymentReferenceValidator do
+  subject {
+    PaymentReferenceTest.new
+  }
+
+  it "accepts 7 digit payment references" do
+    subject.reference = "1234567"
+    subject.should be_valid
+  end
+
+  it "accepts 9 digit payment references" do
+    subject.reference = "173456789"
+    subject.should be_valid
+  end
+
+  it "accepts 10 digit payment references" do
+    subject.reference = "5834567890"
+    subject.should be_valid
+  end
+
+  it "accepts 11 digit payment references" do
+    subject.reference = "79345678901"
+    subject.should be_valid
+  end
+
+  it "accepts 12 digit payment references" do
+    subject.reference = "603456789012"
+    subject.should be_valid
+  end
+
+  it "accepts 13 digit payment references" do
+    subject.reference = "2134567890123"
+    subject.should be_valid
+  end
+
+  it "accepts 14 digit payment references" do
+    subject.reference = "02345678901234"
+    subject.should be_valid
+  end
+
+  it "accepts 16 digit payment references" do
+    subject.reference = "5000056789012345"
+    subject.should be_valid
+  end
+
+  it "rejects on an 6 payment references" do
+    subject.reference = "123456"
+    subject.should_not be_valid
+    subject.errors[:reference].should be_present
+  end
+
+  it "rejects on an 8 payment references" do
+    subject.reference = "12345678"
+    subject.should_not be_valid
+    subject.errors[:reference].should be_present
+  end
+
+  it "rejects on an 15 payment references" do
+    subject.reference = "123456789012345"
+    subject.should_not be_valid
+    subject.errors[:reference].should be_present
+  end
+
+  it "rejects on obviously wrong numbers" do
+    subject.reference = "CHUCKNORRIS"
+    subject.should_not be_valid
+    subject.errors[:reference].should be_present
+  end
+end

metadata

@@ -1,70 +1,82 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: elfproef
-version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
 platform: ruby
-authors:
+authors: 
 - Sytze Loor
 - Ariejan de Vroom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-08-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70232266117480 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *70232266117480
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70232266117020 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: *70232266117020
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70232266116560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
   prerelease: false
-  version_requirements: *70232266116560
-- !ruby/object:Gem::Dependency
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: activemodel
-  requirement: &70232266116040 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: *70232266116040
-description: Validation for Dutch bank account numbers and Citizen Service Numbers
-  (BSN)
-email:
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Validation for Dutch bank account numbers, Citizen Service Numbers (BSN) and Payment reference
+email: 
 - sytze@tweedledum.nl
 - ariejan@ariejan.net
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -75,35 +87,44 @@ files:
 - lib/elfproef.rb
 - lib/elfproef/bank_account_validator.rb
 - lib/elfproef/bsn_validator.rb
+- lib/elfproef/payment_reference_validator.rb
 - lib/elfproef/version.rb
 - spec/bank_account_validator_spec.rb
 - spec/bsn_validator_spec.rb
+- spec/payment_reference_validator_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/sytzeloor/elfproef
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: elfproef
-rubygems_version: 1.8.17
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Validation for Dutch bank account numbers and Citizen Service Numbers (BSN)
-test_files:
+summary: Validation for Dutch bank account numbers, Citizen Service Numbers (BSN) and Payment reference
+test_files: 
 - spec/bank_account_validator_spec.rb
 - spec/bsn_validator_spec.rb
+- spec/payment_reference_validator_spec.rb
 - spec/spec_helper.rb