national-ids-validator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b67f3052b301f723580ea827a1cef144591b909b
+  data.tar.gz: 534fc4bb2742cf40dcf3c45da504967ff70aad3e
+SHA512:
+  metadata.gz: b3e9a7bcaae7795c8c56eaebb5537afd665e0aa05d81f0d3b0ff12eaa6224c803e48c020e4767f9cfa6b32db30bafb61742dc8544c5a48fea994fd7ec6916d80
+  data.tar.gz: 2eed0394ff295d1346a200ff9bc0437c0e0e0ce9438f9a4964a3d83abc23fd39ee45b930a4353b21e073b81c43312cfe33fde3ec7286fddcee952524e185a1fa

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,7 @@
+/.idea/*
+/pkg/*
+
+Gemfile.lock
+.ruby-gemset
+.ruby-version
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - ruby
+  - 2.1.1
+
+script: 'bundle exec rspec spec'
+
+notifications:
+  email:
+    recipients:
+      - info@matfiz.ocm.pl
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Grzegorz Brzezinka
+
+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/README.md

@@ -0,0 +1,68 @@
+[![Gem Version](https://badge.fury.io/rb/national-ids-validator@2x.png)](http://badge.fury.io/rb/national-ids-validator)
+[![Build Status](https://travis-ci.org/matfiz/national-ids-validator.svg?branch=master)](https://travis-ci.org/matfiz/national-ids-validator)
+[![Coverage Status](https://coveralls.io/repos/matfiz/national-ids-validator/badge.png)](https://coveralls.io/r/matfiz/national-ids-validator)
+
+National IDs Validator for Ruby on Rails (Active Model)
+======================
+
+It provides validators for national identification numbers. Currently the following countries are supported:
+* Norway (NO) - Fødselsnummer
+* Poland (PL) - PESEL
+
+## Usage
+
+Add to your Gemfile:
+
+```ruby
+gem 'national-ids-validator'
+```
+
+Run:
+
+```
+bundle install
+```
+
+Then add the following to your model:
+
+```ruby
+validates :personal_id_attribute, :national_id => {country: "PL"}
+```
+
+## Options
+A custom error message can be provided:
+
+```ruby
+validates :personal_id_attribute, :national_id => {country: "PL", message: "is not valid personal number"}
+```
+
+If the nil value should be allowed, it need to be explicitely stated:
+```ruby
+validates :personal_id_attribute, :national_id => {country: "PL", allow_nil: true}
+```
+
+## Retrieving data out of the personal number
+Often personal number contains useful data like birth date and/or gender. You may use the following commands to retrieve them:
+
+* gender
+```ruby
+require 'national_ids_validator'
+NationalIdsValidator.new("12030599592", "NO").gender %returns 0
+```
+It will return *0* for man, *1* for woman and *nil* for invalid number.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credit
+
+Based on https://github.com/balexand/email_validator and https://github.com/max-power/iban.
+
+## License
+
+MIT License. Copyright 2009-2014 Grzegorz Brzezinka. http://brzezinka.eu

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/national-ids-validator/rules.yml

@@ -0,0 +1,13 @@
+#http://en.wikipedia.org/wiki/National_identification_number
+
+pl:
+  length: 11
+  regexp: '(?<year>\d{2})(?<month>\d{2})(?<day>\d{2})(?<individual>\d{4})(?<control>\d{1})'
+  weights: '1379137913'
+
+
+'no':
+  length: 11
+  regexp: '(?<day>\d{2})(?<month>\d{2})(?<year>\d{2})(?<individual>\d{3})(?<control>\d{2})'
+  weights1: '376189452'  #provides multiplying weights for the sum of digits to compute a first control digit
+  weights2: '5432765432' #provides multiplying weights for the sum of digits to compute a second control digit

data/lib/national-ids-validator/validator.rb

@@ -0,0 +1,14 @@
+# Based on work from https://github.com/balexand/email_validator
+class NationalIdValidator < ActiveModel::EachValidator
+  @@default_options = {country: "PL"}
+
+  def self.default_options
+    @@default_options
+  end
+
+  def validate_each(record, attribute, value)
+    options = @@default_options.merge(self.options)
+    # name_validation = options[:strict_mode] ? "-a-z0-9+._" : "^@\\s"
+    record.errors.add(attribute, options[:message] || :invalid) unless NationalIdsValidator.valid?(value,options[:country])
+  end
+end

data/lib/national-ids-validator/version.rb

@@ -0,0 +1,3 @@
+class NationalIDsValidator
+  VERSION = "1.0.1"
+end

data/lib/national_ids_validator.rb

@@ -0,0 +1,119 @@
+require "national-ids-validator/version"
+require "yaml"
+require "national-ids-validator/validator" #if defined? ActiveModel
+
+class NationalIdsValidator
+
+  SUPPORTED_COUNTRY_CODES = %w(PL NO)
+
+  def self.specifications
+    @@rules ||= YAML.load_file(File.expand_path("national-ids-validator/rules.yml", File.dirname(__FILE__)))
+  end
+
+  def initialize(value,country_code)
+    @country_code = country_code.to_s.strip.gsub(/\s+/, '').upcase
+    @value = value.to_s.strip.gsub(/\s+/, '').upcase
+    unless self.class::SUPPORTED_COUNTRY_CODES.include?(@country_code)
+      raise RuntimeError.new("Unexpected country code '#{country_code}' that is not yet supported")
+    end
+  end
+
+  def self.valid?(value,code)
+    new(value,code).valid?
+  end
+
+  def valid?
+    valid_length? && valid_check_digits?
+  end
+
+  def valid_length?
+    !!specification && specification['length'] == @value.length
+  end
+
+  def valid_check_digits?
+    status = false
+    v = self.number_data
+    # binding.pry
+
+    case @country_code
+      when "NO"
+        #http://no.wikipedia.org/wiki/F%C3%B8dselsnummer
+        #first control digit
+        weights1 = specification['weights1']
+        first_sum = 0
+        0.upto(@value.length - 3).each do |i|
+          first_sum += @value[i].to_i*weights1[i].to_i
+        end
+        first_digit = 11 - (first_sum % 11)
+        #second control digit
+        weights2 = specification['weights2']
+        second_sum = 0
+        0.upto(@value.length - 2).each do |i|
+          second_sum += @value[i].to_i*weights2[i].to_i
+        end
+        second_digit = 11 - (second_sum % 11)
+        #check digits
+        calculated = [first_digit, second_digit].map!{|k| k == 11 ? 0 : k}
+        control = [v["control"][0].to_i, v["control"][1].to_i]
+        if calculated[0] == control[0] && calculated[1] == control[1]
+          status = true
+        end
+        # binding.pry
+      when "PL"
+        weights = specification['weights']
+        sum = 0
+        0.upto(@value.length - 2).each do |i|
+          sum += @value[i].to_i*weights[i].to_i
+        end
+        first_digit = 10 - (sum % 10)
+        calculated = first_digit == 10 ? 0 : first_digit
+        control = v["control"][0].to_i
+        if calculated == control
+          status = true
+        end
+    end
+
+    return status
+  end
+
+  def number_data
+    @number_data ||= Regexp.new("^#{specification['regexp']}$").match(@value) if specification
+  end
+
+  def gender #0 - man, 1 - woman
+    if self.valid?
+      case @country_code
+        when "NO"
+          number_data['individual'][2] % 2 == 0 ? 1 : 0
+        when "PL"
+          number_data['individual'][3] % 2 == 0 ? 1 : 0
+      end
+    end
+  end
+
+
+  private
+
+
+
+
+  def specification
+    @specification ||= self.class.specifications[@country_code.downcase]
+  end
+
+
+
+  # def method_missing(method_name, *args)
+  #   respond_to?(method_name) ? number_data[method_name] : super
+  # end
+  #
+  # def respond_to_missing?(method_name, include_private=false)
+  #   (number_data && number_data.names.include?(method_name.to_s)) || super
+  # end
+
+
+
+
+
+
+end

data/national-ids-validator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'national-ids-validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "national-ids-validator"
+  spec.version       = NationalIDsValidator::VERSION
+  spec.authors       = ["Grzegorz Brzezinka"]
+  spec.email         = ["grzegorz@brzezinka.eu"]
+  spec.description   = %q{It provides validators for national identification numbers}
+  spec.summary       = %q{Validation and formatting of national identification numbers, such as PESEL (PL), Fødselsnummer (NO) etc.}
+  spec.homepage      = "https://github.com/matfiz/national-ids-validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency 'rspec', "~> 3.0"
+  spec.add_development_dependency 'pry', "~> 0"
+  spec.add_development_dependency 'activemodel', "~> 3"
+  spec.add_development_dependency "coveralls", "~> 0"
+end

data/spec/general_validator_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class TestPolish < TestModel
+  validates :personal_number, :national_id => {country: "PL"}
+end
+
+class TestPolishWithMessage < TestModel
+  validates :personal_number, :national_id => {country: "PL", message: "is not valid personal number"}
+end
+
+class TestPolishAllowsNil < TestModel
+  validates :personal_number, :national_id => {country: "PL", message: "is not valid personal number", allow_nil: true}
+end
+
+class TestPolishAllowsNilFalse < TestModel
+  validates :personal_number, :national_id => {country: "PL", message: "is not valid personal number", allow_nil: false}
+end
+
+describe NationalIdsValidator do
+
+  describe "error messages" do
+    context "when the message is not defined" do
+      subject { TestPolish.new :personal_number => '12345678901' }
+      before { subject.valid? }
+
+      it "should add the default message" do
+        expect(subject.errors[:personal_number]).to include "is invalid"
+      end
+    end
+
+    context "when the message is defined" do
+      subject { TestPolishWithMessage.new :personal_number => '12345678901' }
+      before { subject.valid? }
+
+      it "should add the customized message" do
+        expect(subject.errors[:personal_number]).to include "is not valid personal number"
+      end
+    end
+  end
+
+  describe "nil personal number" do
+    it "should not be valid when :allow_nil option is missing" do
+      expect(TestPolish.new(:personal_number => nil)).not_to be_valid
+    end
+
+    it "should be valid when :allow_nil options is set to true" do
+      expect(TestPolishAllowsNil.new(:personal_number => nil)).to be_valid
+    end
+
+    it "should not be valid when :allow_nil option is set to false" do
+      expect(TestPolishAllowsNilFalse.new(:personal_number => nil)).not_to be_valid
+    end
+  end
+
+end

data/spec/no_fodselsnummer_validator_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class TestNorwegian < TestModel
+  validates :personal_number, :national_id => {country: "NO"}
+end
+
+describe NationalIdsValidator do
+
+  describe "validation" do
+    context "given the valid NO personal numbers" do
+      [
+          "15051273920",
+          "12039449925",
+          "12039449097",
+          "03121298286",
+          " 03121298286 "
+      ].each do |personal_number|
+
+        it "#{personal_number.inspect} should be valid" do
+          expect(TestNorwegian.new(:personal_number => personal_number, country: "NO")).to be_valid
+        end
+
+      end
+
+    end
+
+    context "given the invalid NO personal numbers", focus: true do
+      [
+          "",
+          "123",
+          "86020219131",
+          "@bar.com",
+          "86020219131\n<script>alert('hello')</script>"
+      ].each do |personal_number|
+
+        it "#{personal_number.inspect} should not be valid" do
+          expect(TestNorwegian.new(:personal_number => personal_number, country: "NO")).not_to be_valid
+        end
+
+      end
+    end
+  end
+
+  describe "gender" do
+    it "should return nil when invalid number provided" do
+      expect(NationalIdsValidator.new("123", "NO").gender).to be_nil
+    end
+
+    context "given the NO personal numbers of man" do
+        [
+            "12030599916",
+            "12030599754",
+            "12030599592",
+            "12030599169",
+            "12030598537"
+        ].each do |personal_number|
+
+          it "#{personal_number.inspect} gener should be 0 - man" do
+            expect(NationalIdsValidator.new(personal_number, "NO").gender).to equal(0)
+          end
+        end
+      end
+
+    context "given the NO personal numbers of woman" do
+      [
+          "14030599218",
+          "14030597479",
+          "14030594836",
+          "14030593023",
+          "14030594674"
+      ].each do |personal_number|
+        it "#{personal_number.inspect} gener should be 1 - woman" do
+          expect(NationalIdsValidator.new(personal_number, "NO").gender).to equal(0)
+        end
+      end
+    end
+  end
+end

data/spec/pl_pesel_validator_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class TestPolish < TestModel
+  validates :personal_number, :national_id => {country: "PL"}
+end
+
+describe NationalIdsValidator do
+
+  describe "validation" do
+    context "given the valid PL personal numbers" do
+      [
+          "86020219132",
+          "86040807100",
+          "02242100603",
+          " 02242100603 "
+      ].each do |personal_number|
+
+        it "#{personal_number.inspect} should be valid" do
+          expect(TestPolish.new(:personal_number => personal_number)).to be_valid
+        end
+
+      end
+
+    end
+
+    context "given the invalid PL personal numbers" do
+      [
+          "",
+          "123",
+          "86020219131",
+          "@bar.com",
+          "86020219131\n<script>alert('hello')</script>"
+      ].each do |personal_number|
+
+        it "#{personal_number.inspect} should not be valid" do
+          expect(TestPolish.new(:personal_number => personal_number)).not_to be_valid
+        end
+
+      end
+    end
+  end
+
+  describe "gender" do
+    it "should return nil when invalid number provided" do
+      expect(NationalIdsValidator.new("123", "PL").gender).to be_nil
+    end
+
+    context "given the PL PESEL of man" do
+      [
+          "78111914774",
+          "04301513670",
+          "20021804054",
+          "49121503797",
+          "76053019771"
+      ].each do |personal_number|
+
+        it "#{personal_number.inspect} gender should be 0 - man" do
+          expect(NationalIdsValidator.new(personal_number, "PL").gender).to equal(0)
+        end
+      end
+    end
+
+    context "given the PL PESEL of woman" do
+      [
+          "67070203144",
+          "21121317741",
+          "21022314928",
+          "22050917321",
+          "30122117724"
+      ].each do |personal_number|
+        it "#{personal_number.inspect} gender should be 1 - woman" do
+          expect(NationalIdsValidator.new(personal_number, "PL").gender).to equal(0)
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rspec'
+require 'active_model'
+require 'pry'
+require 'coveralls'
+Coveralls.wear!
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'national_ids_validator'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: national-ids-validator
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Grzegorz Brzezinka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It provides validators for national identification numbers
+email:
+- grzegorz@brzezinka.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/national-ids-validator/rules.yml
+- lib/national-ids-validator/validator.rb
+- lib/national-ids-validator/version.rb
+- lib/national_ids_validator.rb
+- national-ids-validator.gemspec
+- spec/general_validator_spec.rb
+- spec/no_fodselsnummer_validator_spec.rb
+- spec/pl_pesel_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/matfiz/national-ids-validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Validation and formatting of national identification numbers, such as PESEL
+  (PL), Fødselsnummer (NO) etc.
+test_files:
+- spec/general_validator_spec.rb
+- spec/no_fodselsnummer_validator_spec.rb
+- spec/pl_pesel_validator_spec.rb
+- spec/spec_helper.rb