beid_parser 0.0.1

data/LICENSE

@@ -0,0 +1,167 @@
+Copyright (C) 2012 Thibault Poncelet <thibaultponcelet@gmail.com>
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,36 @@
+beid_parser
+===========
+Ruby beID parser. Allowing to easily handle beID xml files
+
+Please refer to http://eid.belgium.be/en/developing_eid_applications/ for references
+
+Usage
+-----
+**Create a new Beid from a beID xml file:**
+  - beid = BeidParser::Beid.new(filepath) 
+
+**Methods accessibles:**
+  - #picture64: The picture encoded in base64
+  - #picture: The decoded picture
+  - #extract_picture([filename]): Write the JPG picture into a file
+  - #name: The family name
+  - #firstname The firstname (including second first name if any)
+  - #firstnames: Array of firstnames
+  - #middlename: The middlename
+  - #nationality: The nationality
+  - #place_of_birth: The place of birth
+  - #date_of_birth: The date of birth, *Date*
+  - #national_number: The national number, *Fixnum*
+  - #gender: The gender ("male" or "female")
+  - #validity_date_begin: The card validity begin date, *Date*
+  - #validity_date_end: The card validity end date, *Date*
+  - #delivery_municipality: The delivery municipality
+  - #street_and_number: The street and number of the citizen address
+  - #zip: The zip code of the citizen address, *Fixnum*
+  - #municipality: The municipality of the citizen address
+  - #document_type: The document type (belgian_citizen,...)
+  - #card_number: The card number, *Fixnum*
+  - #chip_number: The chip number
+  - #certificates: A Hash of all the certificates on the card (typically :root,:citizenca,:authentication,:signing,rrn)
+  
+NB: When not specified fields are stored as String.

data/Rakefile

@@ -0,0 +1,5 @@
+desc "Run tests"
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/beid_parser.rb

@@ -0,0 +1,10 @@
+# Load the gem files in the system
+require 'rexml/document'
+require "base64"
+require 'date'
+
+module BeidParser
+end
+
+require_relative "./beid_parser/beid.rb"
+

data/lib/beid_parser/beid.rb

@@ -0,0 +1,86 @@
+class BeidParser::Beid
+  include REXML
+  attr_reader :picture64,:name,:firstname,:middlename,
+    :nationality,:place_of_birth,:date_of_birth,:national_number, :gender,:document_type,
+    :card_number,:chip_number,:validity_date_begin,:validity_date_end,
+    :delivery_municipality,:street_and_number,:zip,:municipality,
+    :certificates
+  def initialize(filename)
+    @document = Document.new(File.new(filename))
+    parse_document
+  end
+  
+  #Return an array of firstnames
+  def firstnames
+    firstname.split(" ")
+  end
+  
+  # Decode the Base64 encoded picture
+  def picture
+    Base64.decode64(picture64)
+  end
+  
+  # Extract the citizen picture into a JPG file
+  def extract_picture(filename="picture.jpg")
+    if !filename.match(/.*\.jpg/)
+      raise "The ouput file for the picture must have the '.jpg' extension."
+    end
+    
+    File.open(filename, 'w') { |f| f.write(picture) }
+  end
+  
+  private
+  # Extract datas from XML
+  def parse_document
+    root          = @document.root
+    identity      = root.elements.to_a("identity").first
+    card          = root.elements.to_a("card").first
+    address       = root.elements.to_a("address").first
+    xml_certificates  = root.elements.to_a("certificates").first
+    
+    # Identity
+    @national_number  = get_info(identity, "nationalnumber", true).to_i
+    @date_of_birth    = parse_date(get_info(identity, "dateofbirth", true))
+    @gender           = get_info(identity, "gender", true)
+    @name             = get_info(identity, "name")
+    @firstname        = get_info(identity, "firstname")
+    @middlename       = get_info(identity, "middlename")
+    @nationality      = get_info(identity, "nationality")
+    @place_of_birth   = get_info(identity, "placeofbirth")
+    @picture64        = get_info(identity, "photo")
+    
+    # Card
+    @document_type          = get_info(card, "documenttype", true)
+    @card_number            = get_info(card, "cardnumber", true).to_i
+    @chip_number            = get_info(card, "chipnumber", true)
+    @validity_date_begin    = parse_date(get_info(card,"validitydatebegin",true))
+    @validity_date_end      = parse_date(get_info(card,"validitydateend",true))
+    @delivery_municipality  = get_info(card, "deliverymunicipality")
+    
+    # Address
+    @street_and_number  = get_info(address, "streetandnumber")
+    @zip                = get_info(address, "zip").to_i
+    @municipality       = get_info(address, "municipality")
+    
+    # Certificates
+    @certificates = {}
+    xml_certificates.elements.each do |e|
+      @certificates[e.name] = get_info(xml_certificates,e.name)
+    end
+  end
+  
+  
+  # Get info from the XML element attributes or children
+  def get_info(element,key,attrib=false)
+    if attrib 
+      element.attributes[key]
+    else
+      element.elements.to_a(key).first.text
+    end
+  end
+  
+  # Return a Date object from a string of pattern YYYYMMDD
+  def parse_date(date)
+    Date.new(date[0..3].to_i,date[4..5].to_i,date[6..7].to_i)
+  end
+end

data/lib/beid_parser/version.rb

@@ -0,0 +1,3 @@
+module BeidParser
+  VERSION = "0.0.1"
+end

data/spec/beid_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe BeidParser::Beid do
+  pending
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require "beid_parser"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'progress'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: beid_parser
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thibault Poncelet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.5"
+  type: :development
+  version_requirements: *id001
+description: Ruby beID parser. Allowing to easily handle beID xml files
+email: thibaultponcelet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/beid_parser/beid.rb
+- lib/beid_parser/version.rb
+- lib/beid_parser.rb
+- LICENSE
+- Rakefile
+- README.md
+- spec/beid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thibaultponcelet/beid_parser
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Ruby beID parser. Allowing to easily handle beID xml files
+test_files: 
+- spec/beid_spec.rb
+- spec/spec_helper.rb