mrz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80f5720b27f8c119f51abaab7b7d9819b8615b6617bc5f3b3a6d3fba5fa9f575
+  data.tar.gz: ed30dc33fcd504994da3b68abc6af1defc8307966f777d5dee588d095f1bc64a
+SHA512:
+  metadata.gz: 87aa4fb5b716201469e3da15bc13330bddf6c51a8baca6bd7c4ca62d57354c9e4e73b34c9889665d00d5ad5ad3dca29282ad730509b9e0b509c6aeb4c6f83d16
+  data.tar.gz: 833d145bf96df764b7ec4eaf8a16bbafe74c25a5b8152b5facd1a1bc1daaf57a38d4a79e83bca97f8a046499d3c5bfa0913f97588d16f441fdb50030e549907d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mrz.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    mrz (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  mrz!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License
+
+Copyright (c) 2018 Streetspotr GmbH
+
+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,60 @@
+# MRZ
+
+[![Build Status](https://travis-ci.org/streetspotr/mrz.svg?branch=master)](https://travis-ci.org/streetspotr/mrz)
+
+MRZ is a small library which can parse MRZ codes on ID cards and passports. It was inspired by https://github.com/cheminfo-js/mrz.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mrz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mrz
+
+## Usage
+
+```
+id_card = [
+    "IDD<<T220001293<<<<<<<<<<<<<<<",
+    "6408125<2010315D<<<<<<<<<<<<<4",
+    "MUSTERMANN<<ERIKA<PAULA<ANNA<<"
+]
+
+result = MRZ.parse(id_card)
+
+result.valid?                      # => true
+result.birth_date                  # => Date.new(1964, 8, 12)
+result.birth_date_check_digit      # => "5"
+result.composite_check_digit       # => "4"
+result.document_code               # => "ID"
+result.document_number             # => "T22000129"
+result.document_check_digit        # => "3"
+result.expiration_date             # => Date.new(2020, 10, 15)
+result.expiration_date_check_digit # => "5"
+result.first_name                  # => "ERIKA PAULA ANNA"
+result.issuing_state               # => "D"
+result.last_name                   # => "MUSTERMANN"
+result.nationality                 # => "D"
+result.optional1                   # => ""
+result.optional2                   # => ""
+result.sex                         # => "nonspecified" (otherwise "M" or "F")
+```
+
+## 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/streetspotr/mrz.

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 "mrz"
+
+# 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(__FILE__)

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/mrz.rb

@@ -0,0 +1,35 @@
+require "mrz/version"
+require "mrz/invalid_format_error"
+require "mrz/check_digit"
+require "mrz/result"
+require "mrz/base_parser"
+require "mrz/td1_parser"
+require "mrz/td2_parser"
+require "mrz/td3_parser"
+
+module MRZ
+  def self.parse(mrz_code)
+    case determine_type(mrz_code)
+    when :td1
+      TD1Parser.new(mrz_code).parse
+    when :td2
+      TD2Parser.new(mrz_code).parse
+    when :td3
+      TD3Parser.new(mrz_code).parse
+    end
+  end
+
+  private
+
+    def self.determine_type(code)
+      if code.size == 3
+        :td1
+      elsif code.size == 2 && code.first.size == 36
+        :td2
+      elsif code.size == 2 && code.first.size == 44
+        :td3
+      else
+        raise MRZ::InvalidFormatError, "invalid or unsupported mrz code given"
+      end
+    end
+end

data/lib/mrz/base_parser.rb

@@ -0,0 +1,15 @@
+class BaseParser
+  SPECIAL_CHAR = "<"
+  WHITESPACE = " "
+  EMPTY_SPACE = ""
+
+  protected
+
+    def special_char_to_empty_space(str)
+      str.gsub(SPECIAL_CHAR, EMPTY_SPACE)
+    end
+
+    def special_char_to_white_space(str)
+      str.gsub(SPECIAL_CHAR, WHITESPACE)
+    end
+end

data/lib/mrz/check_digit.rb

@@ -0,0 +1,27 @@
+module MRZ
+  module CheckDigit
+    FACTORS = [7, 3, 1]
+
+    def self.calculate(sequence)
+      check_digit = sequence.split("").each_with_index.reduce(0) do |acc,(char, i)|
+        asciiCode = char.ord
+
+        normalized_code =
+          case asciiCode
+          when proc { |n| n == 60 }
+            0
+          when proc { |n| n >= 65 }
+            asciiCode - 55
+          when proc { |n| n >= 48 }
+            asciiCode - 48
+          else
+            asciiCode
+          end
+
+        acc + normalized_code * FACTORS[i % 3]
+      end
+
+      check_digit % 10
+    end
+  end
+end

data/lib/mrz/invalid_format_error.rb

@@ -0,0 +1,4 @@
+module MRZ
+  class InvalidFormatError < StandardError
+  end
+end

data/lib/mrz/result.rb

@@ -0,0 +1,86 @@
+require "date"
+
+module MRZ
+  class Result
+    attr_reader :birth_date_check_digit, :composite_check_digit,
+                :document_code, :document_number, :document_number_check_digit,
+                :expiration_date_check_digit, :first_name, :issuing_state,
+                :last_name, :nationality, :optional1, :optional2
+
+    def initialize(opts={})
+      @birth_date                  = opts.fetch(:birth_date)
+      @birth_date_check_digit      = opts.fetch(:birth_date_check_digit)
+      @composite_check_digit       = opts.fetch(:composite_check_digit)
+      @document_code               = opts.fetch(:document_code)
+      @document_number             = opts.fetch(:document_number)
+      @document_number_check_digit = opts.fetch(:document_number_check_digit)
+      @expiration_date             = opts.fetch(:expiration_date)
+      @expiration_date_check_digit = opts.fetch(:expiration_date_check_digit)
+      @first_name                  = opts.fetch(:first_name)
+      @issuing_state               = opts.fetch(:issuing_state)
+      @last_name                   = opts.fetch(:last_name)
+      @nationality                 = opts.fetch(:nationality)
+      @optional1                   = opts.fetch(:optional1)
+      @optional2                   = opts.fetch(:optional2)
+      @sex                         = opts.fetch(:sex)
+      @type                        = opts.fetch(:type)
+    end
+
+    def birth_date
+      @_birth_date ||= begin
+        year = @birth_date[0..1].to_i
+        month = @birth_date[2..3].to_i
+        day = @birth_date[4..5].to_i
+
+        Date.new(add_correct_century(year), month, day)
+      end
+    end
+
+    def expiration_date
+      @_expiration_date ||= Date.strptime(@expiration_date, "%y%m%d")
+    end
+
+    def sex
+      @_sex ||= @sex == "" ? "nonspecified" : @sex
+    end
+
+    def valid?
+      @_valid ||= begin
+        MRZ::CheckDigit.calculate(@birth_date).to_s == @birth_date_check_digit &&
+        MRZ::CheckDigit.calculate(@document_number).to_s == @document_number_check_digit &&
+        MRZ::CheckDigit.calculate(@expiration_date).to_s == @expiration_date_check_digit &&
+        composite_digit_valid?
+      end
+    end
+
+    private
+
+      def add_correct_century(year)
+        if (Date.today.year - (1900 + year)) >= 100
+          2000 + year
+        else
+          1900 + year
+        end
+      end
+
+      def composite_digit_valid?
+        if @type == :td1
+          MRZ::CheckDigit.calculate(
+            @document_number + @document_number_check_digit +
+            @optional1 + @birth_date + @birth_date_check_digit +
+            @expiration_date + @expiration_date_check_digit +
+            @optional2
+          ).to_s == @composite_check_digit
+        elsif [:td2, :td3].include?(@type)
+          MRZ::CheckDigit.calculate(
+            @document_number + @document_number_check_digit +
+            @birth_date + @birth_date_check_digit +
+            @expiration_date + @expiration_date_check_digit +
+            @optional1 + @optional2
+          ).to_s == @composite_check_digit
+        else
+          raise InvalidFormatError, "Unknown format type"
+        end
+      end
+  end
+end

data/lib/mrz/td1_parser.rb

@@ -0,0 +1,55 @@
+module MRZ
+  class TD1Parser < BaseParser
+    FORMAT_ONE = /\A(.{2})(.{3})(.{9})(\d)(.{15})\z/
+    FORMAT_TWO = /\A(\d{6})(\d)(.)(\d{6})(\d)(.{3})(.{11})(\d)\z/
+    FORMAT_THREE = /\A([^<]+)<<(.+)\z/
+
+    def initialize(code_ary)
+      @code  = code_ary
+      @one   = code_ary[0]
+      @two   = code_ary[1]
+      @three = code_ary[2]
+    end
+
+    def parse
+      if @code.size != 3
+        raise MRZ::InvalidFormatError, "td1 requires 3 mrz lines"
+      end
+
+      line_one_matches = FORMAT_ONE.match(@one)
+      line_two_matches = FORMAT_TWO.match(@two)
+      line_three_matches = FORMAT_THREE.match(@three)
+
+      if line_one_matches.nil?
+        raise MRZ::InvalidFormatError, "td1 first line does not match the required format"
+      end
+
+      if line_two_matches.nil?
+        raise MRZ::InvalidFormatError, "td1 second line does not match the required format"
+      end
+
+      if @three.size != 30 || line_three_matches.nil?
+        raise MRZ::InvalidFormatError, "td1 third line does not match the required format"
+      end
+
+      MRZ::Result.new(
+        birth_date: line_two_matches[1],
+        birth_date_check_digit: line_two_matches[2],
+        composite_check_digit: line_two_matches[8],
+        document_code: special_char_to_empty_space(line_one_matches[1]),
+        document_number: special_char_to_empty_space(line_one_matches[3]),
+        document_number_check_digit: line_one_matches[4],
+        expiration_date: line_two_matches[4],
+        expiration_date_check_digit: line_two_matches[5],
+        first_name: special_char_to_white_space(line_three_matches[2]).strip,
+        issuing_state: special_char_to_empty_space(line_one_matches[2]),
+        last_name: line_three_matches[1],
+        nationality: special_char_to_empty_space(line_two_matches[6]),
+        optional1: special_char_to_empty_space(line_one_matches[5]),
+        optional2: special_char_to_empty_space(line_two_matches[7]),
+        sex: special_char_to_empty_space(line_two_matches[3]),
+        type: :td1,
+      )
+    end
+  end
+end

data/lib/mrz/td2_parser.rb

@@ -0,0 +1,48 @@
+module MRZ
+  class TD2Parser < BaseParser
+    FORMAT_ONE = /\A(.{2})(.{3})([^<]+)<<(.*)\z/
+    FORMAT_TWO = /\A(.{9})(\d)(.{3})(\d{6})(\d)(.)(\d{6})(.)(.{7})(.)\z/
+
+    def initialize(code_ary)
+      @code = code_ary
+      @one = code_ary[0]
+      @two = code_ary[1]
+    end
+
+    def parse
+      if @code.size != 2
+        raise MRZ::InvalidFormatError, "td2 requires two mrz lines"
+      end
+
+      line_one_matches = FORMAT_ONE.match(@one)
+      line_two_matches = FORMAT_TWO.match(@two)
+
+      if @one.size != 36 || line_one_matches.nil?
+        raise MRZ::InvalidFormatError, "td2 first line does not match the required format"
+      end
+
+      if line_two_matches.nil?
+        raise MRZ::InvalidFormatError, "td2 second line does not match the required format"
+      end
+
+      MRZ::Result.new(
+        birth_date: line_two_matches[4],
+        birth_date_check_digit: line_two_matches[5],
+        composite_check_digit: line_two_matches[10],
+        document_code: special_char_to_empty_space(line_one_matches[1]),
+        document_number: special_char_to_empty_space(line_two_matches[1]),
+        document_number_check_digit: line_two_matches[2],
+        expiration_date: line_two_matches[7],
+        expiration_date_check_digit: line_two_matches[8],
+        first_name: special_char_to_white_space(line_one_matches[4]).strip,
+        issuing_state: special_char_to_empty_space(line_one_matches[2]),
+        last_name: line_one_matches[3],
+        nationality: special_char_to_empty_space(line_two_matches[3]),
+        optional1: special_char_to_empty_space(line_two_matches[9]),
+        optional2: "",
+        sex: special_char_to_empty_space(line_two_matches[6]),
+        type: :td2,
+      )
+    end
+  end
+end

data/lib/mrz/td3_parser.rb

@@ -0,0 +1,48 @@
+module MRZ
+  class TD3Parser < BaseParser
+    FORMAT_ONE = /\A(.{2})(.{3})([^<]+)<<(.*)\z/
+    FORMAT_TWO = /\A(.{9})(\d)(.{3})(\d{6})(\d)(.)(\d{6})(.)(.{14})(.)(\d)/
+
+    def initialize(code_ary)
+      @code = code_ary
+      @one = code_ary[0]
+      @two = code_ary[1]
+    end
+
+    def parse
+      if @code.size != 2
+        raise MRZ::InvalidFormatError, "td3 requires two mrz lines"
+      end
+
+      line_one_matches = FORMAT_ONE.match(@one)
+      line_two_matches = FORMAT_TWO.match(@two)
+
+      if @one.length != 44 || line_one_matches.nil?
+        raise MRZ::InvalidFormatError, "td3 line one does not match the required format"
+      end
+
+      if line_two_matches.nil?
+        raise MRZ::InvalidFormatError, "td3 line two does not match the required format"
+      end
+
+      MRZ::Result.new(
+        birth_date: line_two_matches[4],
+        birth_date_check_digit: line_two_matches[5],
+        composite_check_digit: line_two_matches[11],
+        document_code: special_char_to_empty_space(line_one_matches[1]),
+        document_number: special_char_to_empty_space(line_two_matches[1]),
+        document_number_check_digit: line_two_matches[2],
+        expiration_date: line_two_matches[7],
+        expiration_date_check_digit: line_two_matches[8],
+        first_name: special_char_to_white_space(line_one_matches[4]).strip,
+        issuing_state: special_char_to_empty_space(line_one_matches[2]),
+        last_name: line_one_matches[3],
+        nationality: special_char_to_empty_space(line_two_matches[3]),
+        optional1: special_char_to_empty_space(line_two_matches[9]),
+        optional2: special_char_to_empty_space(line_two_matches[10]),
+        sex: special_char_to_empty_space(line_two_matches[6]),
+        type: :td3,
+      )
+    end
+  end
+end

data/lib/mrz/version.rb

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

data/mrz.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mrz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mrz"
+  spec.version       = MRZ::VERSION
+  spec.authors       = ["Streetspotr GmbH"]
+  spec.email         = ["devs@streetspotr.com"]
+
+  spec.summary       = %q{Small library to read and parse MRZ codes on passports and ID cards}
+  spec.description   = %q{Small library to read and parse MRZ codes on passports and ID cards}
+  spec.homepage      = "https://github.com/streetspotr/mrz"
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mrz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Streetspotr GmbH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Small library to read and parse MRZ codes on passports and ID cards
+email:
+- devs@streetspotr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mrz.rb
+- lib/mrz/base_parser.rb
+- lib/mrz/check_digit.rb
+- lib/mrz/invalid_format_error.rb
+- lib/mrz/result.rb
+- lib/mrz/td1_parser.rb
+- lib/mrz/td2_parser.rb
+- lib/mrz/td3_parser.rb
+- lib/mrz/version.rb
+- mrz.gemspec
+homepage: https://github.com/streetspotr/mrz
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Small library to read and parse MRZ codes on passports and ID cards
+test_files: []