verified 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8371a4df479325c78b7ccda1b0831166c768648
-  data.tar.gz: c9283c35875c14cbbb2fbc73e3128e13016e248c
+  metadata.gz: 662f237da759389d4d0c5555e205f24f775f75f3
+  data.tar.gz: 724fb1cd3688075750946b4921d47d9dbdae1f5f
 SHA512:
-  metadata.gz: b5a41333437f598396ef93988acb6a8d9aa47d0abb5395a7d152a62cea86788900b6e90b09102330bc9a3ca9bd443539e66c49a43d3e4af3f6cb993684e60455
-  data.tar.gz: 3a76b4ac8e15741fb8cdfdc6e20d4ff28623f08ee4b67a9057c5759ffd628ee7c1c06f6baec74de633aa196844b441c732cd9fdfac89acd21244ec3686d4cf30
+  metadata.gz: 34711f2c9a721d9d84d9f936514b32279b5824efeaa6414075f607fd65fcf5344d10a23a8d5c3134671a42178c64328ece0a78b775b2b6bdb7a069102ac12ec7
+  data.tar.gz: d1632fce51c5d5d299490845acdd529bd4bd693fbdfcea9f02b088798ad94da884bd703a14bf57b11bcd5705967cf2da112bd2615a4691f8aab1dd8b6ba2be42

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ruby N (rubymeow)
+
+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,73 @@
+# Verified
+
+A simple Ruby Gem to verify and parse MRZ codes on passports. Useful if you need to meet KYC or Money Laundering requirements.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'verified'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install verified
+
+## Usage
+
+### Passport
+
+Setup your passport instance like so:
+```ruby
+passport = Verified::Passport.new("mrz_line_1", "mrz_line_2")
+```
+
+```
+mrz_line_1: The first line of a Passport MRZ (the long strip of text on the bottom). (string, required)
+mrz_line_2: The second line of a Passport MRZ (the long strip of text on the bottom). (string, required)
+```
+
+It then can be called using any of the folllowing methods:
+
+```
+verified? : Returns true if it's a valid passport MRZ, false if it's not.
+issuing_state : Issuing country of the passport
+last_name : Last name on the passport
+first_names : Array of first names on the passport (First and any middle names)
+passport_number : Passport Number
+nationality : Nationality of the person on the passport. Different from the issuing state (eg. Swedish person who is also a citizen of UK.)
+date_of_birth : Date of Birth, given as a Ruby Date object.
+gender : Gender, given as M, F or nil if not specified.
+expiry_date : Expiry date of the passport, given as a Ruby Date object.
+personal_number : Personal number, if chosen to be given by issuer. Nil if not specified.
+```
+
+### UK Drivers License
+
+This is coming soon, as I'm currently waiting for the DVLA to respond to a [freedom of information request]() that will allow me to understand how the check digits in UK driver numbers are calculated.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install the gem onto your local machine, run `bundle exec rake install`. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubymeow/verified.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+MRZ parsing based on Document 9303 (Machine Readable Travel Documents - Part 1 - Machine Readable Passports. Volume 1 - Passports with Machine Readable Data Stored in Optical Character Recognition format) by the ICAO which can be found here:
+http://www.icao.int/publications/pages/publication.aspx?docnum=9303
+
+Warning: This is by no means a KYC solution on it's own. This merely parses MRZ's and validates they are valid **mrz codes**. This does **not** confirm the document you are verifying is legitimate.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "verified"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/verified.rb

@@ -1,22 +1,6 @@
-require 'verified/check'
+require "verified/version"
+require "verified/parser"
+require "verified/passport"
 
-Verified = Class.new
-class Verified::Passport
-  def initialize(mrz_line_1, mrz_line_2)
-    checker = Check.new
-    @data = checker.check(mrz_line_1, mrz_line_2)
-  end
-
-  def verified?
-    return false if @data == false
-  	return true
-  end
-
-  def method_missing(name, *args, &blk)
-    if args.empty? && blk.nil? && @data.has_key?(name.to_s)
-      @data[name.to_s]
-    else
-      super
-    end
-  end
-end
+module Verified
+end

data/lib/verified/parser.rb

@@ -0,0 +1,4 @@
+require "verified/parser/mrz"
+
+module Parser
+end

data/lib/verified/parser/mrz.rb

@@ -0,0 +1,6 @@
+require "verified/parser/mrz/check.rb"
+require "verified/parser/mrz/check_digit.rb"
+require "verified/parser/mrz/yy_date.rb"
+
+module MRZ
+end

data/lib/verified/parser/mrz/check.rb

@@ -0,0 +1,48 @@
+module MRZ
+  class Check
+    def initialize
+      @@digit_checker = CheckDigit.new
+      @@date_converter = YYDate.new
+    end
+    
+    def check(mrz_line_1, mrz_line_2)
+      # Read the first line without chevrons
+      split = mrz_line_1.split(/<+/)
+
+      doc_data = Hash.new(9)
+      doc_data["issuing_state"] = mrz_line_1[2...5].sub(/<+/, '')
+      doc_data["last_name"] = split[1][3..-1]
+      doc_data["first_names"] = split[2..-1]
+      doc_data["passport_number"] = mrz_line_2[0...9]
+      doc_data["nationality"] = mrz_line_2[10...13].sub(/<+/, '')
+      doc_data["date_of_birth"] = @@date_converter.convert_to_date(mrz_line_2[13...19])
+      doc_data["gender"] = mrz_line_2[20].sub(/<+/, '')
+      doc_data["expiry_date"] = @@date_converter.convert_to_date(mrz_line_2[21...27])
+      doc_data["personal_number"] = mrz_line_2[28...42].sub(/<+/, '')
+
+      # Grabbing the MRZ's check digits
+      doc_check = Array.new
+      doc_check[0] = mrz_line_2[9].to_s
+      doc_check[1] = mrz_line_2[19].to_s
+      doc_check[2] = mrz_line_2[27].to_s
+      doc_check[3] = mrz_line_2[42].to_s
+      doc_check[4] = mrz_line_2[43].to_s
+
+      # Calculating our own check digits...
+      our_check = Array.new
+      our_check[0] = @@digit_checker.check_calc(mrz_line_2[0...9])
+      our_check[1] = @@digit_checker.check_calc(mrz_line_2[13...19])
+      our_check[2] = @@digit_checker.check_calc(mrz_line_2[21...27])
+      our_check[3] = @@digit_checker.check_calc(mrz_line_2[28...42])
+      our_check[4]	= @@digit_checker.check_calc(mrz_line_2[0...10]+mrz_line_2[13...20]+mrz_line_2[21...43])
+
+      # The 4th check digit can be either > or 0, we always return 0 from our CheckDigit calc.
+      if our_check[3] == "0" && doc_check[3] == "<"
+      	our_check[3] = "<"
+      end
+  		
+      return doc_data if doc_check.uniq.sort == our_check.uniq.sort
+      return false
+    end
+  end
+end

data/lib/verified/parser/mrz/check_digit.rb

@@ -0,0 +1,20 @@
+module MRZ
+  class CheckDigit
+    def check_calc(str)
+      str = str.strip.upcase
+      values = str.chars.map do |char|
+        case char
+          when '<'
+            0
+          when 'A'..'Z'
+            char.ord - 65 + 10
+          when '0'..'9'
+            char.ord - 48
+          else
+            raise "Unexpected character '#{char}'"
+          end
+        end
+      return (values.zip([7,3,1].cycle).map{|(v,w)| v * w}.reduce(:+) % 10).to_s
+    end
+  end
+end

data/lib/verified/parser/mrz/yy_date.rb

@@ -0,0 +1,16 @@
+require "date"
+
+module MRZ
+  class YYDate
+    def convert_to_date(input_date)
+    	#yymmdd has the flaw of not knowing which century
+    	#uses current year as a cut off to make an accurate prediction
+      current_year_yy = (Date.today.strftime("%Y"))[2..4]
+      input_year_yy = input_date[0..1]
+      input_month = input_date[2..3]
+      input_day = input_date[4..5]
+      return Date.parse(input_day+"-"+input_month+"-"+"19"+input_year_yy) if input_year_yy >= current_year_yy
+      return Date.parse(input_day+"-"+input_month+"-"+"20"+input_year_yy)
+    end
+  end
+end

data/lib/verified/passport.rb

@@ -0,0 +1,23 @@
+module Verified
+  class Passport
+    private
+    def initialize(mrz_line_1, mrz_line_2)
+      checker = MRZ::Check.new
+      @data = checker.check(mrz_line_1, mrz_line_2)
+    end
+
+    def method_missing(name, *args, &blk)
+      if args.empty? && blk.nil? && @data.has_key?(name.to_s)
+        @data[name.to_s]
+      else
+        super
+      end
+    end
+
+    public
+    def verified?
+      return true if @data != false
+      return false
+    end
+  end
+end

data/lib/verified/version.rb

@@ -0,0 +1,3 @@
+module Verified
+  VERSION = "1.3.0"
+end

data/verified.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'verified/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "verified"
+  spec.version       = Verified::VERSION
+  spec.authors       = ["Ruby"]
+  spec.email         = ["hi@ruby.sh"]
+
+  spec.summary       = "Really simple passport, drivers license and other identification parsing and verification."
+  spec.description   = "A simple gem to verify and parse MRZ codes and numbers on passports and UK drivers licenses. Useful if you need to comply with KYC or Money Laundering ID checks."
+  spec.homepage      = "http://github.com/rubymeow/verified"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -1,24 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: verified
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ruby
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-05-23 00:00:00.000000000 Z
-dependencies: []
-description: A simple gem to verify and parse MRZ codes on passports. Useful if you
-  need to comply with KYC or Money Laundering ID checks.
-email: hi@ruby.sh
+date: 2015-07-01 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: minitest
+  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: A simple gem to verify and parse MRZ codes and numbers on passports and
+  UK drivers licenses. Useful if you need to comply with KYC or Money Laundering ID
+  checks.
+email:
+- hi@ruby.sh
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitattributes
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/verified.rb
-- lib/verified/check.rb
+- lib/verified/parser.rb
+- lib/verified/parser/mrz.rb
+- lib/verified/parser/mrz/check.rb
+- lib/verified/parser/mrz/check_digit.rb
+- lib/verified/parser/mrz/yy_date.rb
+- lib/verified/passport.rb
+- lib/verified/version.rb
+- verified-1.3.0.gem
+- verified.gemspec
 homepage: http://github.com/rubymeow/verified
 licenses:
 - MIT
@@ -29,18 +90,19 @@ 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
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Really simple passport parsing and verification.
+summary: Really simple passport, drivers license and other identification parsing
+  and verification.
 test_files: []

data/lib/verified/check.rb

@@ -1,82 +0,0 @@
-require 'date'
-
-class Check
-  def check(mrz_line_1, mrz_line_2)
-    #make a new digit checker
-    @@digit_checker = CheckDigit.new
-    @@date_converter = YYDate.new
-    #string manipulation to simply reading the first line
-    split = mrz_line_1.split(/<+/)
-    #get data unformatted from passport
-    doc_data = Hash.new(9)
-    #first line of MRZ
-    doc_data["IssuingState"] = mrz_line_1[2...5].sub(/<+/, '')
-    doc_data["LastName"] = split[1][3..-1]
-    doc_data["FirstNames"] = split[2..-1]
-
-    #second line of MRZ
-    doc_data["Number"] = mrz_line_2[0...9]
-    doc_data["Nationality"] = mrz_line_2[10...13].sub(/<+/, '')
-    doc_data["DateOfBirth"] = @@date_converter.convert_to_date(mrz_line_2[13...19])
-    doc_data["Gender"] = mrz_line_2[20].sub(/<+/, '')
-    doc_data["ExpiryDate"] = @@date_converter.convert_to_date(mrz_line_2[21...27])
-    doc_data["PersonalNumber"] = mrz_line_2[28...42].sub(/<+/, '')
-
-    #mrz given check digits
-    doc_check = Array.new
-    doc_check[0] = mrz_line_2[9].to_s
-    doc_check[1] = mrz_line_2[19].to_s
-    doc_check[2] = mrz_line_2[27].to_s
-    doc_check[3] = mrz_line_2[42].to_s
-    doc_check[4] = mrz_line_2[43].to_s
-
-    #calculate our own check digits
-    our_check = Array.new
-    our_check[0] = @@digit_checker.check_calc(mrz_line_2[0...9])
-    our_check[1] = @@digit_checker.check_calc(mrz_line_2[13...19])
-    our_check[2] = @@digit_checker.check_calc(mrz_line_2[21...27])
-    our_check[3] = @@digit_checker.check_calc(mrz_line_2[28...42])
-    our_check[4]	= @@digit_checker.check_calc(mrz_line_2[0...10]+mrz_line_2[13...20]+mrz_line_2[21...43])
-
-    #the 4th check digit can be either > or 0, we always return 0 from our CheckDigit calc.
-    #this basically changes our check to > so the true return can pass
-    if our_check[3] == "0" && doc_check[3] == "<"
-    	our_check[3] = "<"
-    end
-		
-    return doc_data if doc_check.uniq.sort == our_check.uniq.sort
-    return false
-  end
-end
-
-class Check::CheckDigit
-  def check_calc(str)
-    str = str.strip.upcase
-    values = str.chars.map do |char|
-      case char
-        when '<'
-          0
-        when 'A'..'Z'
-          char.ord - 65 + 10
-        when '0'..'9'
-          char.ord - 48
-        else
-          raise "Unexpected character '#{char}'"
-        end
-      end
-    return (values.zip([7,3,1].cycle).map{|(v,w)| v * w}.reduce(:+) % 10).to_s
-  end
-end
-
-class Check::YYDate
-  def convert_to_date(input_date)
-  	#yymmdd has the flaw of not knowing which century
-  	#uses current year as a cut off to make an accurate prediction
-    current_year_yy = (Date.today.strftime("%Y"))[2..4]
-    input_year_yy = input_date[0..1]
-    input_month = input_date[2..3]
-    input_day = input_date[4..5]
-    return Date.parse(input_day+"-"+input_month+"-"+"19"+input_year_yy) if input_year_yy >= current_year_yy
-    return Date.parse(input_day+"-"+input_month+"-"+"20"+input_year_yy)
-  end
-end