Class: Mindee::V1::Product::FR::IdCard::IdCardV1Document

Inherits:
Mindee::V1::Parsing::Common::Prediction show all
Includes:
Mindee::V1::Parsing::Standard
Defined in:
lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb

Overview

Carte Nationale d’Identité API version 1.1 document data.

Direct Known Subclasses

IdCardV1PagePrediction

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prediction, page_id) ⇒ IdCardV1Document

Returns a new instance of IdCardV1Document.

Parameters:

  • prediction (Hash)
  • page_id (Integer, nil) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 47

def initialize(prediction, page_id)
  super
  @authority = Parsing::Standard::StringField.new(
    prediction['authority'],
    page_id
  )
  @birth_date = Parsing::Standard::DateField.new(
    prediction['birth_date'],
    page_id
  )
  @birth_place = Parsing::Standard::StringField.new(
    prediction['birth_place'],
    page_id
  )
  @expiry_date = Parsing::Standard::DateField.new(
    prediction['expiry_date'],
    page_id
  )
  @gender = Parsing::Standard::StringField.new(
    prediction['gender'],
    page_id
  )
  @given_names = [] # : Array[Parsing::Standard::StringField]
  prediction['given_names'].each do |item|
    @given_names.push(Parsing::Standard::StringField.new(item, page_id))
  end
  @id_number = Parsing::Standard::StringField.new(
    prediction['id_number'],
    page_id
  )
  @mrz1 = Parsing::Standard::StringField.new(prediction['mrz1'], page_id)
  @mrz2 = Parsing::Standard::StringField.new(prediction['mrz2'], page_id)
  @surname = Parsing::Standard::StringField.new(
    prediction['surname'],
    page_id
  )
end

Instance Attribute Details

#authority ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The name of the issuing authority.

Returns:



16
17
18
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 16

def authority
  @authority
end

#birth_date ⇒ Mindee::V1::Parsing::Standard::DateField (readonly)

The date of birth of the card holder.

Returns:



19
20
21
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 19

def birth_date
  @birth_date
end

#birth_place ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The place of birth of the card holder.

Returns:



22
23
24
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 22

def birth_place
  @birth_place
end

#expiry_date ⇒ Mindee::V1::Parsing::Standard::DateField (readonly)

The expiry date of the identification card.

Returns:



25
26
27
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 25

def expiry_date
  @expiry_date
end

#gender ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The gender of the card holder.

Returns:



28
29
30
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 28

def gender
  @gender
end

#given_names ⇒ Array<Mindee::V1::Parsing::Standard::StringField> (readonly)

The given name(s) of the card holder.

Returns:



31
32
33
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 31

def given_names
  @given_names
end

#id_number ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The identification card number.

Returns:



34
35
36
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 34

def id_number
  @id_number
end

#mrz1 ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

Machine Readable Zone, first line

Returns:



37
38
39
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 37

def mrz1
  @mrz1
end

#mrz2 ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

Machine Readable Zone, second line

Returns:



40
41
42
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 40

def mrz2
  @mrz2
end

#surname ⇒ Mindee::V1::Parsing::Standard::StringField (readonly)

The surname of the card holder.

Returns:



43
44
45
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 43

def surname
  @surname
end

Instance Method Details

#to_s ⇒ String

Returns:

  • (String) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb', line 86

def to_s
  given_names = @given_names.join("\n #{' ' * 15}")
  out_str = String.new
  out_str << "\n:Identity Number: #{@id_number}".rstrip
  out_str << "\n:Given Name(s): #{given_names}".rstrip
  out_str << "\n:Surname: #{@surname}".rstrip
  out_str << "\n:Date of Birth: #{@birth_date}".rstrip
  out_str << "\n:Place of Birth: #{@birth_place}".rstrip
  out_str << "\n:Expiry Date: #{@expiry_date}".rstrip
  out_str << "\n:Issuing Authority: #{@authority}".rstrip
  out_str << "\n:Gender: #{@gender}".rstrip
  out_str << "\n:MRZ Line 1: #{@mrz1}".rstrip
  out_str << "\n:MRZ Line 2: #{@mrz2}".rstrip
  out_str[1..].to_s
end