norwegian_national_id_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e2ff9d6f137df56a8ff963b17c5627a8651d00d
+  data.tar.gz: 9fc9eb9d8eb1f654cc2e26099c69d0c60cc9c452
+SHA512:
+  metadata.gz: 89661f2e72ca3fe0d99cddcc04ac334516dbf1eff204b42973c5e996183e3a8e3a3d044b960208f11a99a9ef9cc70bb6fefcd26f678d0a91b152bf9716880287
+  data.tar.gz: 45d2bd453b9a85bec04005f9e1ddf5eb8b9523601f46f2f63b8a7f35b0571c3b65940d807ee5a6efaa37700c7f4fc55e39afd2ae13ee1b4ac9e7a2d1a60b8f1d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.0.rc.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pal@rubynor.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pål Andre Sundt
+
+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,55 @@
+# Norwegian national id parser
+
+A simple way to valdiate and get information like date of birth and gender from a norwegian national id number.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'norwegian_national_id_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install norwegian_national_id_parser
+
+## Usage
+
+```Ruby
+national_id = NorwegianNationalIdParser.parse("13042046846")
+
+# Get date of birth
+national_id.birth_date
+# => 1920-04-13
+
+# Get the gender
+national_id.gender
+# => female
+
+# Get the age
+national_id.age
+# => 99
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubynor/norwegian_national_id_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits
+
+![rubynor](http://rubynor.com/wp-content/uploads/2016/12/cropped-Rubynor_div.logoer-nettsidebanner.png)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "norwegian_national_id_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/norwegian_national_id_parser.rb

@@ -0,0 +1,47 @@
+require "norwegian_national_id_parser/version"
+require "norwegian_national_id_parser/parser"
+
+module NorwegianNationalIdParser
+  class NationalIdError < StandardError ; end
+
+  class IndividualDigitsParseError < NationalIdError ; end
+  class InvalidControlNumberError  < NationalIdError ; end
+  class InvalidCharactersError     < NationalIdError ; end
+  class WrongLengthError           < NationalIdError ; end
+  class DateInvalidError           < NationalIdError ; end
+  class IdMissingError             < NationalIdError ; end
+
+  ID_LENGTH = 11
+
+  DAY = [0,2]
+  MONTH = [2,2]
+  YEAR = [4,2]
+  INDUVIDUAL_DIGITS = [6,3]
+  GENDER = 8
+  CONTROL_NUMBER_1 = 9
+  CONTROL_NUMBER_2 = 10
+
+  D_NUMBER_VALUE = 40
+  H_NUMBER_VALUE = 40
+
+  INDIVIDUAL_DIGITS_CENTURY_MAP = {
+    0..499 => { 
+      00..99 => 1900
+    },
+    500..749 => {
+      54..99 => 1800,
+      0..39 => 2000
+    },
+    750..899 => {
+      0..39 => 2000
+    },
+    900..999 => {
+      0..39 => 2000,
+      40..99 => 1900
+    }
+  }
+
+  def self.parse(national_id)
+    Parser.new(national_id)
+  end
+end

data/lib/norwegian_national_id_parser/date_parser.rb

@@ -0,0 +1,74 @@
+module NorwegianNationalIdParser
+  class DateParser
+    attr_reader :date
+
+    def initialize(national_id)
+      @national_id = national_id
+      @date = parse_date
+    end
+
+    def type
+      if d_number?
+        'd_number'
+      elsif h_number?
+        'h_number'
+      else
+        'normal'
+      end
+    end
+
+    private
+
+    def parse_date
+      validate_century
+
+      Date.new(year, month, day)
+    rescue ArgumentError
+      raise DateInvalidError
+    end
+
+    def year
+      century + part_of_id(YEAR)
+    end
+
+    def month
+      if h_number?
+        return part_of_id(MONTH) - H_NUMBER_VALUE
+      end
+
+      part_of_id(MONTH)
+    end
+
+    def day
+      if d_number?
+        return part_of_id(DAY) - D_NUMBER_VALUE
+      end
+
+      part_of_id(DAY)
+    end
+
+    def validate_century
+      if century.nil? || century < 1
+        raise IndividualDigitsParseError
+      end
+    end
+
+    def century
+      INDIVIDUAL_DIGITS_CENTURY_MAP
+        .detect { |k,v| k === part_of_id(INDUVIDUAL_DIGITS) }.last
+        .detect { |k,v| k === part_of_id(YEAR) }.last
+    end
+
+    def d_number?
+      part_of_id(DAY) > 40
+    end
+
+    def h_number?
+      part_of_id(MONTH) > 40
+    end
+
+    def part_of_id(part)
+      @national_id[*part].to_i
+    end
+  end
+end

data/lib/norwegian_national_id_parser/national_id_validator.rb

@@ -0,0 +1,69 @@
+require_relative 'date_parser'
+
+module NorwegianNationalIdParser
+  class NationalIdValidator
+    def initialize(national_id)
+      @national_id = national_id
+    end
+
+    def call
+      validate_presence
+      validate_length
+      validate_numeric
+      validate_date
+      validate_control_numbers
+    end
+
+    private
+
+    def validate_presence
+      if !@national_id || @national_id.empty?
+        raise IdMissingError
+      end
+    end
+
+    def validate_length
+      if @national_id.length != ID_LENGTH
+        raise WrongLengthError
+      end
+    end
+
+    def validate_numeric
+      unless @national_id.match(/\D/).nil?
+        raise InvalidCharactersError
+      end
+    end
+
+    def validate_date
+      DateParser.new(@national_id)
+    end
+
+    def validate_control_numbers
+      d1 = lookup_digit(0)
+      d2 = lookup_digit(1)
+      m1 = lookup_digit(2)
+      m2 = lookup_digit(3)
+      y1 = lookup_digit(4)
+      y2 = lookup_digit(5)
+      i1 = lookup_digit(6)
+      i2 = lookup_digit(7)
+      i3 = lookup_digit(8)
+
+      k1 = 11 - ((3 * d1 + 7 * d2 + 6 * m1 + 1 * m2 + 8 * y1 + 9 * y2 + 4 * i1 + 5 * i2 + 2 * i3) % 11)
+      k2 = 11 - ((5 * d1 + 4 * d2 + 3 * m1 + 2 * m2 + 7 * y1 + 6 * y2 + 5 * i1 + 4 * i2 + 3 * i3 + 2 * k1) % 11)
+      k1 = 0 if k1 == 11
+      k2 = 0 if k2 == 11
+
+      unless lookup_digit(CONTROL_NUMBER_1) == k1 &&
+             lookup_digit(CONTROL_NUMBER_2) == k2
+        raise InvalidControlNumberError
+      end
+    end
+
+    private
+
+    def lookup_digit(i)
+      @national_id[i].to_i
+    end
+  end
+end

data/lib/norwegian_national_id_parser/parser.rb

@@ -0,0 +1,44 @@
+require_relative 'date_parser'
+require_relative 'national_id_validator'
+
+module NorwegianNationalIdParser
+  class Parser
+    attr_reader :national_id
+
+    def initialize(national_id)
+      self.national_id = national_id
+    end
+
+    def national_id=(national_id)
+      national_id = national_id&.delete(' ')
+
+      NationalIdValidator.new(national_id).call()
+
+      @national_id = national_id
+    end
+
+    def birth_date
+      DateParser.new(@national_id).date
+    end
+
+    def age
+      calc_age(birth_date)
+    end
+
+    def gender
+      if @national_id[GENDER].to_i.even?
+        'female'
+      else
+        'male'
+      end
+    end
+
+    private
+
+    def calc_age(dob)
+      now = Date.today
+      year_diff = now.year - dob.year
+      year_diff - ((now.month > dob.month || (now.month == dob.month && now.day >= dob.day)) ? 0 : 1)
+    end
+  end
+end

data/lib/norwegian_national_id_parser/version.rb

@@ -0,0 +1,3 @@
+module NorwegianNationalIdParser
+  VERSION = "0.1.0"
+end

data/norwegian_national_id_parser.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'norwegian_national_id_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "norwegian_national_id_parser"
+  spec.version       = NorwegianNationalIdParser::VERSION
+  spec.authors       = ["Pål André Sundt"]
+  spec.email         = ["pal@rubynor.com"]
+
+  spec.summary       = "Parse a norwegian national id number"
+  spec.description   = %q{A simple gem for parsing a norwegian national id number}
+  spec.homepage      = "https://rubygems.org/gems/norwegian_national_id_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: norwegian_national_id_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pål André Sundt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.a
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple gem for parsing a norwegian national id number
+email:
+- pal@rubynor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/norwegian_national_id_parser.rb
+- lib/norwegian_national_id_parser/date_parser.rb
+- lib/norwegian_national_id_parser/national_id_validator.rb
+- lib/norwegian_national_id_parser/parser.rb
+- lib/norwegian_national_id_parser/version.rb
+- norwegian_national_id_parser.gemspec
+homepage: https://rubygems.org/gems/norwegian_national_id_parser
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Parse a norwegian national id number
+test_files: []