resident 0.0.11 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f353c0782a96c1d79d67c61cb7d29d7508ad45bb
-  data.tar.gz: adfc48cdb9ca18ab426aff09572f8d5a1d4903cf
+SHA256:
+  metadata.gz: 90fe6f9288f6764f383ff5f8e74cc2a2e31854df1eaf42ebacd505ee586b9328
+  data.tar.gz: 9fb294f619eeaf83066b315ab3daeedcc79cf713ff8b64ce188289313e54d554
 SHA512:
-  metadata.gz: 87117786abbf0a70b38ec3a654fcf133fae1fbdac1c3e8c1b3b957bf037a8abec7b049225627d6d6233f0dcbe91ad6802b7c42eb225b492322a9030f0dcaedce
-  data.tar.gz: 11458275db57866d20915a61cf480ca50ec7b3922f787f5bc2dd2cfe0bf70857dabd253b87500af7d13796e95393dabcaa4a6f20c7e7d37a6bef2cf66d65d2b3
+  metadata.gz: bfa89495903de491d933a9d76f603213f8a84d28b7a828de49f79c5c9cee25c598c18b298e02296afc134f161ac99386e36d49c05733976553a213b57922c36e
+  data.tar.gz: 7c1725cea3d9e57f7efe7cebc63d91e461a1feac2edfbcffac1bad466b4cdce96d0f3a3c3463d5c851893ea0482434f7a0168c05ec364f1f4ffb1aec5f8a317f

data/README.md

@@ -2,9 +2,13 @@
 
 Validates a National Identification Number (See http://en.wikipedia.org/wiki/National_identification_number).
 There are some 62 countries that have this type of number.
-This gem currently only supports Swedish (Personnummer) and Finnish (Henkilöasiakkaat) ones.
 
-There is a special focus on identifying these numbers robustly (i.e. you can safely validate a param[:number] directly, or cleanup your database by running every non-normalized value through this gem).
+This gem currently only supports Swedish (Personnummer), Finnish
+(Henkilöasiakkaat), Norwegian (Fødelsenummer) and Danish (CPR).
+
+There is a special focus on identifying these numbers robustly
+(i.e. you can safely validate a param[:number] directly, or cleanup
+your database by running every non-normalized value through this gem).
 
 ## Installation
 
@@ -38,7 +42,7 @@ Some marked parts of the code are inspired or taken from MIT licensed code of
 
 Other than that you got:
 
-Copyright (c) 2011-2014 Bukowskis.
+Copyright (c) 2011-2022 Bukowskis.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/national_identification_number/base.rb

@@ -25,6 +25,10 @@ module NationalIdentificationNumber
       age_for_dob date
     end
 
+    def ==(other)
+      other.class == self.class && other&.to_s == to_s
+    end
+
     protected
 
     # stackoverflow.com/questions/819263
@@ -41,6 +45,5 @@ module NationalIdentificationNumber
     def validate
       raise 'You need to implement at least this method in subclasses.'
     end
-
   end
 end

data/lib/national_identification_number/danish.rb

@@ -0,0 +1,43 @@
+require 'national_identification_number/base'
+
+module NationalIdentificationNumber
+  class Danish < Base
+    attr_reader :date
+
+    protected
+
+    def repair
+      super
+      @number.gsub!(/[^0-9]/, '')
+      if (matches = @number.match(/\A(?<birthday>[0-9]{6})(?<checksum>[0-9]{4})\z/))
+        birthday, checksum = %w[birthday checksum].map { |group| matches[group] }
+        @number = "#{birthday}-#{checksum}"
+      end
+    end
+
+    def validate
+      if (matches = @number.match(/\A(?<day>\d{2})(?<month>\d{2})(?<year>\d{2})-(?<serial>\d{3})(?<checksum>\d{1})\z/))
+        day, month, year, serial, checksum = %i[day month year serial checksum].map { |group| matches[group] }
+        begin
+          @date = Date.parse("#{full_year(serial, year)}-#{month}-#{day}")
+          @valid = true
+          @number = "#{day}#{month}#{year}-#{serial}#{checksum}"
+        rescue ArgumentError
+        end
+      end
+    end
+
+    private
+
+    def full_year(serial, year)
+      century(serial, year.to_i) + year.to_i
+    end
+
+    def century(serial, year)
+      first_digit = serial[0].to_i
+      return 1800 if (5..8).include?(first_digit) && year > 57
+      return 2000 if (4..9).include?(first_digit) && year < 37
+      1900
+    end
+  end
+end

data/lib/national_identification_number/norwegian.rb

@@ -0,0 +1,61 @@
+require 'national_identification_number/base'
+
+module NationalIdentificationNumber
+  class Norwegian < Base
+    attr_reader :date
+
+    protected
+
+    def repair
+      super
+      @number.gsub!(/[^0-9]/, '')
+    end
+
+    def validate
+      if (matches = @number.match(/\A(?<day>\d{2})(?<month>\d{2})(?<year>\d{2})(?<serial>\d{3})(?<checksum>\d{2})\z/))
+        day, month, year, serial, checksum = %i[day month year serial checksum].map { |group| matches[group] }
+
+        sans_checksum = "#{day}#{month}#{year}#{serial}"
+
+        if checksum == calculate_checksum(sans_checksum)
+          begin
+            @date = Date.parse("#{full_year(serial, year)}-#{month}-#{day}")
+            @valid = true
+            @number = "#{sans_checksum}#{checksum}"
+          rescue ArgumentError
+          end
+        end
+      end
+    end
+
+    private
+
+    def full_year(serial, year)
+      century(serial) + year.to_i
+    end
+
+    def century(serial)
+      case serial.to_i
+      when 0..499 then 1900
+      else 2000 # or 1800, not possible to tell.
+      end
+    end
+
+    def calculate_checksum(number)
+      digits = number.split('').map(&:to_i)
+      w1 = [3, 7, 6, 1, 8, 9, 4, 5, 2]
+      w2 = [5, 4, 3, 2, 7, 6, 5, 4, 3, 2]
+
+      k1 = weighted_modulo_11(digits.zip(w1))
+      k2 = weighted_modulo_11([*digits, k1].zip(w2))
+      "#{k1}#{k2}"
+    end
+
+    def weighted_modulo_11(digits_and_weights)
+      result = 11 - (digits_and_weights.map do |terms|
+                       terms.reduce(:*)
+                     end.reduce(:+) % 11)
+      result > 9 ? 0 : result
+    end
+  end
+end

data/lib/national_identification_number.rb

@@ -1,2 +1,4 @@
 require 'national_identification_number/swedish'
 require 'national_identification_number/finnish'
+require 'national_identification_number/norwegian'
+require 'national_identification_number/danish'

data/spec/national_identification_number/base_spec.rb

@@ -74,4 +74,23 @@ describe NationalIdentificationNumber::Base do
     end
   end
 
+  describe '#==' do
+    it 'should be true if same class and string representation' do
+      one = NationalIdentificationNumber::Swedish.new('040626-5488')
+      other = NationalIdentificationNumber::Swedish.new('20040626-5488')
+      expect(one == other).to be true
+    end
+
+    it 'should be false if other string representation' do
+      one = NationalIdentificationNumber::Swedish.new('040626-5488')
+      other = NationalIdentificationNumber::Swedish.new('040626-8128')
+      expect(one == other).to be false
+    end
+
+    it 'should be false if other class' do
+      one = NationalIdentificationNumber::Swedish.new('040626-5488')
+      other = NationalIdentificationNumber::Finnish.new('040626-5488')
+      expect(one == other).to be false
+    end
+  end
 end

data/spec/national_identification_number/danish_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'resident'
+
+describe NationalIdentificationNumber::Danish do
+  describe '#valid?' do
+    it 'recognizes valid numbers' do
+      expect(described_class.new('311257-1735')).to be_valid
+      expect(described_class.new('290444-0305')).to be_valid
+      expect(described_class.new('300168-0330')).to be_valid
+    end
+
+    it 'recognizes invalid numbers' do
+      expect(described_class.new('251379-4001')).not_to be_valid # invalid month
+      expect(described_class.new('300279-4001')).not_to be_valid # invalid day
+      expect(described_class.new('asdf')).not_to be_valid
+      expect(described_class.new('1234567890')).not_to be_valid
+      expect(described_class.new('0000000000000')).not_to be_valid
+      expect(described_class.new('000000-0000')).not_to be_valid
+      expect(described_class.new('')).not_to be_valid
+      expect(described_class.new(1234567890)).not_to be_valid
+      expect(described_class.new(:really_bad_input_value)).not_to be_valid
+    end
+  end
+
+  describe 'sanitize' do
+    context 'with valid numbers' do
+      it 'is the formatted number' do
+        expect(described_class.new('3112571735').sanitize).to eq '311257-1735'
+        expect(described_class.new('290444.0305').sanitize).to eq '290444-0305'
+        expect(described_class.new('30.01.68.03.30').sanitize).to eq '300168-0330'
+      end
+    end
+
+    context 'with invalid numbers' do
+      it 'is nil' do
+        expect(described_class.new('251379-4001').sanitize).to be_nil
+        expect(described_class.new('300279-4001').sanitize).to be_nil
+        expect(described_class.new('asdf').sanitize).to be_nil
+        expect(described_class.new('1234567890').sanitize).to be_nil
+        expect(described_class.new('0000000000000').sanitize).to be_nil
+        expect(described_class.new('000000-0000').sanitize).to be_nil
+        expect(described_class.new('').sanitize).to be_nil
+        expect(described_class.new(1234567890).sanitize).to be_nil
+        expect(described_class.new(:really_bad_input_value).sanitize).to be_nil
+      end
+    end
+  end
+
+  describe 'age' do
+    before do
+      Timecop.freeze Date.parse('2022-03-04')
+    end
+
+    it 'recognizes valid numbers' do
+      expect(described_class.new('110779-4101').age).to eq 42
+      expect(described_class.new('010100-1000').age).to eq 122
+      expect(described_class.new('110736-4002').age).to be_nil # Birthday in the future
+      expect(described_class.new('030320-5006').age).to eq 2
+      expect(described_class.new('110952-3113').age).to eq 69
+      expect(described_class.new('211164-2234').age).to eq 57
+    end
+
+    it 'is nil for invalid numbers' do
+      expect(described_class.new('251379-4001').age).to be_nil # invalid month
+      expect(described_class.new('300279-4001').age).to be_nil # invalid day
+      expect(described_class.new('asdf').age).to be_nil
+      expect(described_class.new('1234567890').age).to be_nil
+      expect(described_class.new('0000000000000').age).to be_nil
+      expect(described_class.new('000000-0000').age).to be_nil
+      expect(described_class.new('').age).to be_nil
+      expect(described_class.new(1234567890).age).to be_nil
+      expect(described_class.new(:really_bad_input_value).age).to be_nil
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns the number normalized regardless of wether its valid' do
+      expect(described_class.new('251.379.4001').to_s).to eq '251379-4001'
+    end
+  end
+end

data/spec/national_identification_number/norwegian_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require 'resident'
+
+describe NationalIdentificationNumber::Norwegian do
+  describe '#valid?' do
+    it 'recognizes valid numbers' do
+      expect(described_class.new('11077941012')).to be_valid
+    end
+
+    it 'recognizes invalid numbers' do
+      expect(described_class.new('671301A172V')).not_to be_valid # valid checksum, invalid month
+      expect(described_class.new('830231A172M')).not_to be_valid # valid checksum, invalid day
+      expect(described_class.new('11077941010')).not_to be_valid
+      expect(described_class.new('670368A172X')).not_to be_valid
+      expect(described_class.new('310145--586A')).not_to be_valid
+      expect(described_class.new('asdf')).not_to be_valid
+      expect(described_class.new('1234567890')).not_to be_valid
+      expect(described_class.new('0000000000000')).not_to be_valid
+      expect(described_class.new('000000-0000')).not_to be_valid
+      expect(described_class.new('')).not_to be_valid
+      expect(described_class.new(1234567890)).not_to be_valid
+      expect(described_class.new(:really_bad_input_value)).not_to be_valid
+    end
+  end
+
+  describe 'sanitize' do
+    context 'with valid numbers' do
+      it 'is the formatted number' do
+        expect(described_class.new('11077941012').sanitize).to eq '11077941012'
+        expect(described_class.new('11.07.79.410.12').sanitize).to eq '11077941012'
+        expect(described_class.new('11 07 79 41012').sanitize).to eq '11077941012'
+      end
+    end
+
+    context 'with invalid numbers' do
+      it 'is nil' do
+        expect(described_class.new('11077941010').sanitize).to be_nil
+        expect(described_class.new('671301A172V').sanitize).to be_nil
+        expect(described_class.new('830231A172M').sanitize).to be_nil
+        expect(described_class.new('311180-999J').sanitize).to be_nil
+        expect(described_class.new('131052-308S').sanitize).to be_nil
+        expect(described_class.new('290164X862U').sanitize).to be_nil
+        expect(described_class.new('670368A172X').sanitize).to be_nil
+        expect(described_class.new('310145--586A').sanitize).to be_nil
+        expect(described_class.new('asdf').sanitize).to be_nil
+        expect(described_class.new('1234567890').sanitize).to be_nil
+        expect(described_class.new('0000000000000').sanitize).to be_nil
+        expect(described_class.new('000000-0000').sanitize).to be_nil
+        expect(described_class.new('').sanitize).to be_nil
+        expect(described_class.new(1234567890).sanitize).to be_nil
+        expect(described_class.new(:really_bad_input_value).sanitize).to be_nil
+      end
+    end
+  end
+
+  describe 'age' do
+    before do
+      Timecop.freeze Date.parse('2022-03-04')
+    end
+
+    it 'recognizes valid numbers' do
+      expect(described_class.new('11077941012').age).to eq 42
+      expect(described_class.new('01010010000').age).to eq 122
+      expect(described_class.new('11077950020').age).to be_nil # Birthday in the future
+      expect(described_class.new('03032050068').age).to eq 2
+      expect(described_class.new('11095231138').age).to eq 69
+      expect(described_class.new('21116422341').age).to eq 57
+    end
+
+    it 'is nil for invalid numbers' do
+      expect(described_class.new('671301A172V').age).to be_nil
+      expect(described_class.new('830231A172M').age).to be_nil
+      expect(described_class.new('311180-999J').age).to be_nil
+      expect(described_class.new('131052-308S').age).to be_nil
+      expect(described_class.new('290164X862U').age).to be_nil
+      expect(described_class.new('670368A172X').age).to be_nil
+      expect(described_class.new('310145--586A').age).to be_nil
+      expect(described_class.new('asdf').age).to be_nil
+      expect(described_class.new('1234567890').age).to be_nil
+      expect(described_class.new('0000000000000').age).to be_nil
+      expect(described_class.new('000000-0000').age).to be_nil
+      expect(described_class.new('').age).to be_nil
+      expect(described_class.new(1234567890).age).to be_nil
+      expect(described_class.new(:really_bad_input_value).age).to be_nil
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns the number normalized regardless of wether it is valid' do
+      expect(described_class.new('311280999J').to_s).to eq '311280999'
+      expect(described_class.new('27..036.8A172X  ').to_s).to eq '270368172'
+      expect(described_class.new('xx270368A172X  ').to_s).to eq '270368172'
+      expect(described_class.new('xxx270368A172Xt  ').to_s).to eq '270368172'
+      expect(described_class.new('\t050126-1853').to_s).to eq '0501261853'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resident
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.14
 platform: ruby
 authors:
 - Bukowskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,34 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  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: rb-fsevent
-  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: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -76,11 +48,15 @@ files:
 - README.md
 - lib/national_identification_number.rb
 - lib/national_identification_number/base.rb
+- lib/national_identification_number/danish.rb
 - lib/national_identification_number/finnish.rb
+- lib/national_identification_number/norwegian.rb
 - lib/national_identification_number/swedish.rb
 - lib/resident.rb
 - spec/national_identification_number/base_spec.rb
+- spec/national_identification_number/danish_spec.rb
 - spec/national_identification_number/finnish_spec.rb
+- spec/national_identification_number/norwegian_spec.rb
 - spec/national_identification_number/swedish_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/bukowskis/national_identification_number/
@@ -103,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Validate National Identification Numbers.