birth_number 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeaf0cc44d89627a61cf069d580984f3d82dc5c0
+  data.tar.gz: c448b9b77fed4cb920c4dd6d5e46c8394150a4b5
+SHA512:
+  metadata.gz: 681388466a5d1cc1e9f9b4e3476d8261600323dad0d2f7e211aebe5a5538bc4fd6d24ea475853c8906811af8c94280fbf32ad77358fe1b3c8d89629112ab924e
+  data.tar.gz: 36cd6e53cb0598226b84cecd5e8d1e7dceb084cfd05fd89659336546038cfa524bcb89e1a478fcfa96c8e13358bfea834e2abd9245c6b28e9bf3cd8909c4f75f

data/.editorconfig

@@ -0,0 +1,17 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Markdown uses trailing whitespace for linebreaks.
+[{*.markdown, *.md}]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,98 @@
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### Linux template
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+
+.gitver

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in birth_number.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sonans Privatgymnas AS
+
+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,45 @@
+# BirthNumber
+
+This is a simple Ruby gem for parsing and validating Birth Numbers, the national identification number used in Norway. It has been extracted from one of our internal projects for reuse, and released as open-source as it might be useful for others as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'birth_number'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install birth_number
+
+## Usage
+
+```rb
+birth_number = BirthNumber.parse('01017000027')
+birth_number.birth_date #=> #<Date: 1970-01-01 ((2440588j,0s,0n),+0s,2299161j)>
+birth_number.personal_number # => "00027
+birth_number.to_s #=> "01017000027"
+
+birth_number = BirthNumber.new('1970-01-01', '00027')
+birth_number.to_s #=> "01017000027"
+
+birth_number.valid? #=> true
+birth_number.male? #=> false
+birth_number.female? #=> true
+
+birth_number.to_s #=> "01017000027"
+
+birth_number == '01017000027' #=> false
+birth_number === '01017000027' #=> true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Sonans/birth_number.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/birth_number.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'birth_number/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'birth_number'
+  spec.version       = BirthNumber::VERSION
+  spec.authors       = ['Jo-Herman Haugholt']
+  spec.email         = ['jo-herman@sonans.no']
+
+  spec.summary       = 'Gem for parsing and validating Norwegian Birth Numbers'
+  spec.description   = <<END
+This is a simple Ruby gem for parsing and validating Birth Numbers,
+the national identification number used in Norway. It has been extracted from
+one of our internal projects for reuse, and released as open-source as it might
+be useful for others as well.
+END
+  spec.homepage      = 'https://github.com/Sonans/birth_number'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+end

data/lib/birth_number.rb

@@ -0,0 +1,173 @@
+require 'birth_number/version'
+require 'date'
+
+# Class representing a Norwegian "Birth Number" ("Fødselsnummer").
+#
+# A birth number is a national identificaion number used in Norway,
+# is unique for each person, and encodes birth date as well as gender.
+# The last two digits are used as a checksum to verify a valid
+# birth number.
+#
+# This implementation is based of the description on the Norwegian
+# Wikipedia page.
+#
+# @see https://en.wikipedia.org/wiki/National_identification_number#Norway
+#   Birth Number on Wikipedia
+# @see https://no.wikipedia.org/wiki/Fødselsnummer
+#   Fødselsnummer on Norwegian Wikipedia
+#
+# @author Jo-Herman Haugholt <jo-herman@sonans.no>
+class BirthNumber
+  # Birth Date
+  # @return [Date]
+  attr_accessor :birth_date
+
+  # Personal Number
+  # @return [String]
+  attr_accessor :personal_number
+
+  # Parse a 11-digit Birth Number
+  #
+  # @param [#to_s] birth_number
+  # @return [BirthNumber]
+  # @raise [ArgumentError] if passed string is not 11 digits or invalid date
+  def self.parse(birth_number)
+    birth_number = birth_number.to_s
+    unless birth_number =~ /^\d{11}$/
+      fail ArgumentError, 'Birth number must be 11 digits'
+    end
+
+    birth_date = parse_birth_date(birth_number)
+
+    new(birth_date, birth_number[6, 5])
+  end
+
+  # Check if a given birth number is valid
+  # @param [#to_s] birth_number
+  def self.valid?(birth_number)
+    digits = birth_number.to_s.chars.map(&:to_i)
+
+    digits.last(2) == control_digits(digits)
+
+  rescue ArgumentError
+    return false
+  end
+
+  # @param [#to_date,#to_s] birth_date
+  # @param [#to_i] personal_number
+  def initialize(birth_date, personal_number)
+    if birth_date.respond_to? :to_date
+      self.birth_date = birth_date.to_date
+    else
+      self.birth_date = Date.parse(birth_date.to_s)
+    end
+
+    self.personal_number = format('%05d', personal_number.to_i)
+  end
+
+  # Check if this birth number is valid
+  def valid?
+    BirthNumber.valid?(self)
+  end
+
+  # Is this birth number assigned to a man
+  def male?
+    personal_number[2].to_i.odd?
+  end
+
+  # Is this birth number assigned to a woman
+  def female?
+    personal_number[2].to_i.even?
+  end
+
+  # Formats this birthnumber in the proper 11-digit form
+  # @return [String]
+  def to_s
+    birth_date.strftime('%d%m%y') + format('%05d', personal_number.to_i)
+  end
+
+  def ==(other)
+    unless other.respond_to?(:birth_date) && other.respond_to?(:personal_number)
+      return false
+    end
+
+    birth_date == other.birth_date && personal_number == other.personal_number
+  end
+
+  def ===(other)
+    to_s == other.to_s
+  end
+
+  def eql?(other)
+    self == other
+  end
+
+  def hash
+    to_s.hash
+  end
+
+  # @!group Private Class Methods
+  BIRTH_NUMBER_REGEX     = /^([0-2][0-9]|3[0-1])(0[1-9]|1[0-2])(\d{7})$/
+  BIRTH_NUMBER_WEIGHTS_1 = [3, 7, 6, 1, 8, 9, 4, 5, 2]
+  BIRTH_NUMBER_WEIGHTS_2 = [5, 4, 3, 2, 7, 6, 5, 4, 3, 2]
+
+  # Parses the date part of a birth number
+  # @param [String] birth_number
+  # @return [Date]
+  def self.parse_birth_date(birth_number)
+    day, month, year   = birth_number.chars.take(6)
+                         .each_slice(2).map(&:join).map(&:to_i)
+    individual_numbers = birth_number[6, 3].to_i
+
+    year += parse_century(year, individual_numbers)
+
+    Date.new(year, month, day)
+  end
+
+  # Calculates the century of a year based on the individual numbers
+  # @param [Integer] year
+  # @param [Integer] individual_numbers
+  # @return [Integer]
+  def self.parse_century(year, individual_numbers)
+    case
+    when individual_numbers < 500 || (individual_numbers >= 900 && year >= 40)
+      1900
+    when individual_numbers < 750 && year >= 54
+      1800
+    else
+      2000
+    end
+  end
+
+  # Calculates the two control digits given an array of digits
+  # @param [Array<Integer>] digits
+  # @return [(Integer, Integer)]
+  def self.control_digits(digits)
+    [
+      control_digit(digits.take(9), BIRTH_NUMBER_WEIGHTS_1),
+      control_digit(digits.take(10), BIRTH_NUMBER_WEIGHTS_2)
+    ]
+  end
+
+  # Calculates the control digit, given an array of digits and weights.
+  # @param [Array<Integer>] digits
+  # @param [Array<Integer>] weights
+  # @return [Integer]
+  def self.control_digit(digits, weights)
+    control_digit = digits
+                    .zip(weights)
+                    .map { |digit, weight| digit * weight }
+                    .reduce(:+)
+    control_digit = 11 - (control_digit % 11)
+    control_digit = 0 if control_digit == 11
+    control_digit
+  end
+
+  private_constant :BIRTH_NUMBER_REGEX,
+                   :BIRTH_NUMBER_WEIGHTS_1,
+                   :BIRTH_NUMBER_WEIGHTS_2
+  private_class_method :parse_birth_date,
+                       :parse_century,
+                       :control_digits,
+                       :control_digit
+end

data/lib/birth_number/version.rb

@@ -0,0 +1,3 @@
+class BirthNumber
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: birth_number
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jo-Herman Haugholt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: |
+  This is a simple Ruby gem for parsing and validating Birth Numbers,
+  the national identification number used in Norway. It has been extracted from
+  one of our internal projects for reuse, and released as open-source as it might
+  be useful for others as well.
+email:
+- jo-herman@sonans.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- birth_number.gemspec
+- lib/birth_number.rb
+- lib/birth_number/version.rb
+homepage: https://github.com/Sonans/birth_number
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Gem for parsing and validating Norwegian Birth Numbers
+test_files: []
+has_rdoc: