Class: Digidoc::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/digidoc/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_url = TestEndpointUrl) ⇒ Client

Returns a new instance of Client.



17
18
19
20
21
 
# File 'lib/digidoc/client.rb', line 17

def initialize(endpoint_url = TestEndpointUrl)
  self.endpoint_url = endpoint_url || TestEndpointUrl
  self.respond_with_nested_struct = true
  self.embedded_datafiles = []
end

Instance Attribute Details

#embedded_datafiles ⇒ Object

Returns the value of attribute embedded_datafiles.



15
16
17
 
# File 'lib/digidoc/client.rb', line 15

def embedded_datafiles
  @embedded_datafiles
end

#endpoint_url ⇒ Object

Returns the value of attribute endpoint_url.



15
16
17
 
# File 'lib/digidoc/client.rb', line 15

def endpoint_url
  @endpoint_url
end

#respond_with_nested_struct ⇒ Object

Returns the value of attribute respond_with_nested_struct.



15
16
17
 
# File 'lib/digidoc/client.rb', line 15

def respond_with_nested_struct
  @respond_with_nested_struct
end

#session_code ⇒ Object

Returns the value of attribute session_code.



15
16
17
 
# File 'lib/digidoc/client.rb', line 15

def session_code
  @session_code
end

Instance Method Details

#add_datafile(file, *args) ⇒ Object

Add datafile to DigiDoc container



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/digidoc/client.rb', line 263

def add_datafile(file, *args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  filename = options.delete(:filename) || File.basename(file.path)
  mime_type = options[:mime_type] || calc_mime_type(file)
  use_hashcode = false #options.key?(:use_hashcode) || true
  filename = filename.gsub('/', '-')

  response = savon_client.request(:wsdl, 'AddDataFile') do |soap|
    file_content = Base64.encode64(file.read)
    # Upload file to webservice
    if use_hashcode
      # Calculate sha1 from file
      datafile = datafile(filename, mime_type, file.size, file_content, embedded_datafiles.size)
      self.embedded_datafiles << datafile
      hex_sha1 = Digest::SHA1.hexdigest(datafile)
      digest_value = Base64.encode64(hex_sha1.lines.to_a.pack('H*'))
      soap.body = {'Sesscode' => session_code, 'FileName' => filename, 'MimeType' => mime_type, 'ContentType' => 'HASHCODE',
        'Size' => file.size, 'DigestType' => 'sha1', 'DigestValue' => digest_value}
    else
      soap.body = {'Sesscode' => session_code, 'FileName' => filename, 'MimeType' => mime_type, 'ContentType' => 'EMBEDDED_BASE64',
        'Size' => file.size, 'Content' => file_content}
    end
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:add_data_file_response]
  respond_with_hash_or_nested(result)
end

#authenticate(*args) ⇒ Object

Authentication message



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/digidoc/client.rb', line 24

def authenticate(*args)
  options = args.last || {}

  phone = options.delete(:phone)
  personal_code = options.delete(:personal_code)
  country_code = options.delete(:country_code) || 'EE'
  language = options.delete(:language) || 'EST'
  service_name = options.delete(:service_name) || 'Testimine'
  message_to_display = options.delete(:message_to_display) || 'Tuvastamine'
  messaging_mode =  options.delete(:messaging_mode) || 'asynchClientServer'
  async_configuration = options.delete(:async_configuration) || 0
  return_cert_data = options.key?(:return_cert_data) ? options.delete(:return_cer_data) : true
  return_revocation_data = options.key?(:return_revocation_data) ? options.delete(:return_revocation_data) : true

  # SP challenge token
  sp_challenge = generate_sp_challenge
  phone = ensure_area_code(phone)
  self.session_code = nil

  # Make webservice call
  response = savon_client.request(:wsdl, 'MobileAuthenticate') do |soap|
    soap.body = {'CountryCode' => country_code, 'PhoneNo' => phone, 'Language' => language, 'ServiceName' => service_name,
      'MessageToDisplay' => message_to_display, 'SPChallenge' => sp_challenge, 'MessagingMode' => messaging_mode,
      'AsyncConfiguration' => async_configuration, 'ReturnCertData' => return_cert_data,
      'ReturnRevocationData' => return_revocation_data, 'IdCode' => personal_code }
  end

  if soap_fault?(response)
    result = response.to_hash[:fault]
  else
    result = response.to_hash[:mobile_authenticate_response]
    self.session_code = result[:sesscode]
  end
  respond_with_hash_or_nested(result)
end

#authentication_status(session_code = self.session_code) ⇒ Object

Authentication status



61
62
63
64
65
66
67
68
 
# File 'lib/digidoc/client.rb', line 61

def authentication_status(session_code = self.session_code)
  response = savon_client.request(:wsdl, 'GetMobileAuthenticateStatus') do |soap|
    soap.body = {'Sesscode' => session_code }
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:get_mobile_authenticate_status_response]
  respond_with_hash_or_nested(result)
end

#close_session(session_code = self.session_code) ⇒ Object

Closes current session



252
253
254
255
256
257
258
259
260
 
# File 'lib/digidoc/client.rb', line 252

def close_session(session_code = self.session_code)
  response = savon_client.request(:wsdl, 'CloseSession') do |soap|
    soap.body = {'Sesscode' => session_code }
  end
  self.session_code = nil

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:close_session_response]
  respond_with_hash_or_nested(result)
end

#create_signed_doc(*args) ⇒ Object

Creates DigiDoc container



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/digidoc/client.rb', line 92

def create_signed_doc(*args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  version = options.delete(:version) || '1.3'

  response = savon_client.request(:wsdl, 'CreateSignedDoc') do |soap|
    soap.body = {'Sesscode' => session_code, 'Format' => 'DIGIDOC-XML', 'Version' => version}
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:create_signed_doc_response]
  respond_with_hash_or_nested(result)
end

#finalize_signature(*args) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/digidoc/client.rb', line 129

def finalize_signature(*args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  signature = options.delete(:signature)
  signature_id = options.delete(:signature_id)

  response = savon_client.request(:wsdl, 'FinalizeSignature') do |soap|
    soap.body = {'Sesscode' => session_code, 'SignatureValue' => signature, 'SignatureId' => signature_id}
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:finalize_signature_response]
  respond_with_hash_or_nested(result)
end

#mobile_sign(*args) ⇒ Object

Sign DigiDoc container



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/digidoc/client.rb', line 159

def mobile_sign(*args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  phone = options.delete(:phone)
  personal_code = options.delete(:personal_code)
  country_code = options.delete(:country_code) || 'EE'
  country_name = options.delete(:country_name) || 'Eesti'
  language = options.delete(:language) || 'EST'
  service_name = options.delete(:service_name) || 'Testimine'
  message_to_display = options.delete(:message_to_display) || 'Allkirjastamine'
  messaging_mode =  options.delete(:messaging_mode) || 'asynchClientServer'
  async_configuration = options.delete(:async_configuration) || 0
  return_doc_info = options.key?(:return_doc_info) ? options.delete(:return_doc_info) : true
  return_doc_data = options.key?(:return_doc_data) ? options.delete(:return_doc_data) : true
  state_or_province = options.delete(:state_or_province)
  role = options.delete(:role)
  city = options.delete(:city)
  postal_code = options.delete(:postal_code)
  phone = ensure_area_code(phone)

  response = savon_client.request(:wsdl, 'MobileSign') do |soap|
    soap.body = {'Sesscode' => session_code, 'SignersCountry' => country_code, 'CountryName' => country_name,
      'SignerPhoneNo' => phone, 'Language' => language, 'ServiceName' => service_name,
      'AdditionalDataToBeDisplayed' => message_to_display, 'MessagingMode' => messaging_mode,
      'AsyncConfiguration' => async_configuration, 'ReturnDocInfo' => return_doc_info,
      'ReturnDocData' => return_doc_data, 'SignerIDCode' => personal_code, 'Role' => role, 'City' => city,
       'StateOrProvince' => state_or_province, 'PostalCode' => postal_code }
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:mobile_sign_response]
  respond_with_hash_or_nested(result)
end

#notary(*args) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/digidoc/client.rb', line 144

def notary(*args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  signature_id = options.delete(:signature_id)

  response = savon_client.request(:wsdl, 'GetNotary') do |soap|
    soap.body = {'Sesscode' => session_code, 'SignatureId' => signature_id}
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:get_notary_response]
  respond_with_hash_or_nested(result)
end

#prepare_signature(*args) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/digidoc/client.rb', line 106

def prepare_signature(*args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  signers_certificate = options.delete(:signers_certificate)
  signers_token_id = options.delete(:signers_token_id)
  signing_profile = options.delete(:signing_profile)
  country_name = options.delete(:country_name) || 'Eesti'
  state_or_province = options.delete(:state_or_province)
  role = options.delete(:role)
  city = options.delete(:city)
  postal_code = options.delete(:postal_code)

  response = savon_client.request(:wsdl, 'PrepareSignature') do |soap|
    soap.body = {'Sesscode' => session_code, 'SignersCertificate' => signers_certificate,
      'SignersTokenId' => signers_token_id, 'Role' => role, 'City' => city,
      'State' => state_or_province, 'PostalCode' => postal_code, 'Country' => country_name, 'SigningProfile' => signing_profile }
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:prepare_signature_response]
  respond_with_hash_or_nested(result)
end

#save_signed_doc(*args, &block) ⇒ Object

Get DigiDoc container



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/digidoc/client.rb', line 222

def save_signed_doc(*args, &block)
  options = args.last || {}
  session_code = options.delete(:session_code) || self.session_code

  response = savon_client.request(:wsdl, 'GetSignedDoc') do |soap|
    soap.body = {'Sesscode' => session_code }
  end

  if soap_fault?(response)
    result = respond_with_hash_or_nested(response.to_hash[:fault])
  else
    escaped = Crack::XML.parse(response.http.body).to_hash['SOAP_ENV:Envelope']['SOAP_ENV:Body']['dig:GetSignedDocResponse']['SignedDocData']
    # TODO: is escaping needed? - it removes original escaped & form XML
    digidoc_container = escaped#CGI.unescapeHTML(escaped)

    if embedded_datafiles.present?
      xmldata = Nokogiri::XML(digidoc_container)
      xmldata.root.elements.each { |el| el.replace(embedded_datafiles.shift) if el.name == 'DataFile' }
      digidoc_container = xmldata.to_xml
    end

    if block_given?
      yield digidoc_container
    else
      digidoc_container
    end
  end
end

#sign_status(*args) ⇒ Object

Get session status info.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/digidoc/client.rb', line 194

def sign_status(*args)
  options = args.last || {}

  session_code = options.delete(:session_code) || self.session_code
  return_doc_info = options.key?(:return_doc_info) ? options.delete(:return_doc_info) : false
  wait_signature = options.key?(:wait_signature) ? options.delete(:wait_signature) : false

  response = savon_client.request(:wsdl, 'GetStatusInfo') do |soap|
    soap.body = {'Sesscode' => session_code, 'ReturnDocInfo' => return_doc_info, 'WaitSignature' => wait_signature}
  end

  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:get_status_info_response]
  respond_with_hash_or_nested(result)
end

#signed_doc_info(*args) ⇒ Object

Get DigiDoc container status



210
211
212
213
214
215
216
217
218
219
 
# File 'lib/digidoc/client.rb', line 210

def signed_doc_info(*args)
  options = args.last || {}
  session_code = options.delete(:session_code) || self.session_code

  response = savon_client.request(:wsdl, 'GetSignedDocInfo') do |soap|
    soap.body = {'Sesscode' => session_code }
  end
  result = soap_fault?(response) ? response.to_hash[:fault] : response.to_hash[:get_signed_doc_info_response]
  respond_with_hash_or_nested(result)
end

#start_session(*args) ⇒ Object

Starts and holds session



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/digidoc/client.rb', line 71

def start_session(*args)
  self.session_code = nil
  self.embedded_datafiles = []
  options = args.last || {}
  signed_doc_file = options.delete(:signed_doc_file)
  signed_doc_xml = signed_doc_file.read if signed_doc_file

  response = savon_client.request(:wsdl, 'StartSession') do |soap|
    soap.body = { 'bHoldSession' => true, 'SigDocXML' => signed_doc_xml}
  end

  if soap_fault?(response)
    result = response.to_hash[:fault]
  else
    result = response.to_hash[:start_session_response]
    self.session_code = result[:sesscode]
  end
  respond_with_hash_or_nested(result)
end