Class: Libis::Services::Rosetta::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/libis/services/rosetta/service.rb

Overview

noinspection RubyTooManyInstanceVariablesInspection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url = 'https://repository.teneo.libis.be', pds_url = 'https://pds.libis.be', opts = {}) ⇒ Service

Returns a new instance of Service.

Parameters:

  • base_url (String) (defaults to: 'https://repository.teneo.libis.be') 


29
30
31
32
33
34
35
36
37
 
# File 'lib/libis/services/rosetta/service.rb', line 29

def initialize(base_url = 'https://repository.teneo.libis.be', pds_url = 'https://pds.libis.be', opts = {})
  @pds_service = Libis::Services::Rosetta::PdsHandler.new pds_url
  @producer_service = Libis::Services::Rosetta::ProducerHandler.new base_url, opts
  @deposit_service = Libis::Services::Rosetta::DepositHandler.new base_url, opts
  @sip_service = Libis::Services::Rosetta::SipHandler.new base_url, opts
  @ie_service = Libis::Services::Rosetta::IeHandler.new base_url, opts
  @collection_service = Libis::Services::Rosetta::CollectionHandler.new base_url, opts
  @oai_pmh_service = Libis::Services::Rosetta::OaiPmh.new base_url, opts
end

Instance Attribute Details

#collection_service ⇒ Object (readonly)

Returns the value of attribute collection_service.



26
27
28
 
# File 'lib/libis/services/rosetta/service.rb', line 26

def collection_service
  @collection_service
end

#deposit_service ⇒ Object (readonly)

Returns the value of attribute deposit_service.



26
27
28
 
# File 'lib/libis/services/rosetta/service.rb', line 26

def deposit_service
  @deposit_service
end

#ie_service ⇒ Object (readonly)

Returns the value of attribute ie_service.



26
27
28
 
# File 'lib/libis/services/rosetta/service.rb', line 26

def ie_service
  @ie_service
end

#pds_service ⇒ Object (readonly)

Returns the value of attribute pds_service.



26
27
28
 
# File 'lib/libis/services/rosetta/service.rb', line 26

def pds_service
  @pds_service
end

#producer_service ⇒ Object (readonly)

Returns the value of attribute producer_service.



26
27
28
 
# File 'lib/libis/services/rosetta/service.rb', line 26

def producer_service
  @producer_service
end

#sip_service ⇒ Object (readonly)

Returns the value of attribute sip_service.



26
27
28
 
# File 'lib/libis/services/rosetta/service.rb', line 26

def sip_service
  @sip_service
end

Instance Method Details

#file ⇒ Object 



396
397
398
 
# File 'lib/libis/services/rosetta/service.rb', line 396

def file
  @file
end

#get_dav_deposit_report(report_file, deposits) ⇒ Object

Parameters:

  • report_file (String)
  • deposits (Array) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/libis/services/rosetta/service.rb', line 249

def get_dav_deposit_report(report_file, deposits)
  # create and open Workbook
  workbook = WriteXLSX.new(report_file)

  # set up some formatting
  ie_data_header_format = workbook.add_format(bold: 1)
  rep_name_format = workbook.add_format(bold: 1)
  file_header_format = workbook.add_format(bold: 1)

  # First Sheet is an overview of all dossiers
  overview = workbook.add_worksheet('dossier overzicht')
  ie_data_keys = Set.new %w[id dossier link disposition]
  ie_list = [] # ie info will be collected in this array to be printed later

  # iterate over all deposits
  deposits.each do |deposit|
    # iterate over all IEs
    deposit[:ies].sort { |x, y| x[:id] <=> y[:id] }.each do |ie|
      @ie = ie
      id = (ie[:id] || ie[:ie])
      # noinspection RubyStringKeysInHashInspection
      ie_data = {
          'id' => "#{id}",
          'dossier' => ie[:title],
          'disposition' => (ie[:content][:dmd]['date'] rescue nil),
          'link' => "http://depot.lias.be/delivery/DeliveryManagerServlet?dps_pid=#{ie[:ie]}",
      }.cleanup
      [
          # (ie[:content][:dmd] rescue nil),
          (ie[:content][:amd][:tech]['generalIECharacteristics'] rescue nil),
          (ie[:content][:amd][:rights]['accessRightsPolicy'] rescue nil)
      ].each do |data|
        ie_data.merge! data if data
      end
      dossier_sheet = workbook.add_worksheet(id.gsub(/[\\\/*?]+/, '.'))
      dossier_row = 0

      ie[:content].each do |rep_name, rep|
        next unless rep_name.is_a?(String)
        @rep = rep
        file_data_keys = Set.new %w(folder naam link mimetype puid formaat versie)
        file_list = []

        dossier_sheet.write_row(dossier_row, 0, [rep_name], rep_name_format)
        %w(preservationType usageType).each do |key|
          dossier_row += 1
          dossier_sheet.write_row(
              dossier_row, 0,
              [
                  key.underscore.gsub('_', ' '),
                  rep[:amd][:tech]['generalRepCharacteristics'][key]
              ]
          )
        end
        dossier_row += 2

        file_proc = lambda do |file|
          @file = file
          if file[:id]
            tech = file[:amd][:tech]
            # noinspection RubyStringKeysInHashInspection
            file_data = {
                'folder' => (tech['generalFileCharacteristics']['fileOriginalPath'] rescue '').split('/')[1..-1].join('\\'),
                'naam' => (tech['generalFileCharacteristics']['fileOriginalName'] rescue nil),
                'link' => ("http://depot.lias.be/delivery/DeliveryManagerServlet?dps_pid=#{file[:id]}" rescue nil),
                'mimetype' => (tech['fileFormat']['mimeType'] rescue nil),
                'puid' => (tech['fileFormat']['formatRegistryId'] rescue nil),
                'formaat' => (tech['fileFormat']['formatDescription'] rescue nil),
                'versie' => (tech['fileFormat']['formatVersion'] rescue nil),
                'viruscheck' => (tech['fileVirusCheck']['status'] rescue nil),
                'file_type' => (tech['generalFileCharacteristics']['FileEntityType']),
                'groep' => file[:group],
            }
            data = tech['fileValidation']
            if data
              valid = (data['isValid'] == 'true') rescue nil
              well_formed = (data['isWellFormed'] == 'true') rescue nil
              file_data['validatie'] = if valid && well_formed
                                         'OK'
                                       else
                                         'niet OK'
                                       end
            end
            data = tech['significantProperties']
            if data
              file_data[data['significantPropertiesType']] = data['significantPropertiesValue']
            end
            data = file[:dmd]
            if data
              data.each { |key, value| file_data[key] = value }
            end
            file_list << file_data
            file_data_keys.merge file_data.keys
          else
            file.each do |_, value|
              next unless value.is_a? Hash
              # noinspection RubyScope
              file_proc.call(value)
            end
          end
        end

        rep.keys.each do |key|
          file_proc.call(rep[key]) if key.is_a?(String)
        end

        table_start = dossier_row
        dossier_sheet.write_row(dossier_row, 0, file_data_keys.to_a, file_header_format)
        file_list.each do |file_info|
          dossier_row += 1
          file_data = []
          file_data_keys.each { |key| file_data << file_info[key] }
          dossier_sheet.write_row(dossier_row, 0, file_data)
        end
        table_end = dossier_row

        dossier_sheet.add_table(
            table_start, 0, table_end, file_data_keys.size - 1,
            style: 'Table Style Medium 16', name: rep[:id],
            columns: file_data_keys.map { |key| {header: key} }
        )

        dossier_row += 2
      end
      ie_data_keys.merge ie_data.keys
      ie_list << ie_data
    end
  end

  # write ie data to overview worksheet
  overview.write_row(0, 0, ie_data_keys.to_a, ie_data_header_format)
  overview_row = 1
  ie_list.each do |ie_info|
    ie_data = []
    ie_data_keys.each { |key| ie_data << ie_info[key] }
    overview.write_row(overview_row, 0, ie_data)
    overview_row += 1
  end

rescue Exception => e
  puts e.message
  puts e.backtrace
    # close and save workbook
ensure
  workbook.close
end

#get_deposit_report(report_file, deposits) ⇒ Object

Parameters:

  • report_file (String)
  • deposits (Array) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/libis/services/rosetta/service.rb', line 100

def get_deposit_report(report_file, deposits)
  # create and open Workbook
  workbook = WriteXLSX.new(report_file)

  # set up some formatting
  ie_data_header_format = workbook.add_format(bold: 1)
  rep_name_format = workbook.add_format(bold: 1)
  file_header_format = workbook.add_format(bold: 1)

  # First Sheet is an overview of all dossiers
  overview = workbook.add_worksheet('IE overview')
  ie_data_keys = Set.new %w[id dossier link disposition]
  ie_list = [] # ie info will be collected in this array to be printed later

  # iterate over all deposits
  deposits.each do |deposit|
    # iterate over all IEs
    deposit[:ies].sort { |x, y| x[:id] <=> y[:id] }.each do |ie|
      @ie = ie
      id = (ie[:id] || ie[:ie])
      # noinspection RubyStringKeysInHashInspection
      ie_data = {
          'id' => "#{id}",
          'dossier' => ie[:title],
          'disposition' => (ie[:content][:dmd]['date'] rescue nil),
          'link' => "http://depot.lias.be/delivery/DeliveryManagerServlet?dps_pid=#{ie[:ie]}",
      }.cleanup
      [
          # (ie[:content][:dmd] rescue nil),
          (ie[:content][:amd][:tech]['generalIECharacteristics'] rescue nil),
          (ie[:content][:amd][:rights]['accessRightsPolicy'] rescue nil)
      ].each do |data|
        ie_data.merge! data if data
      end
      dossier_sheet = workbook.add_worksheet(id.gsub(/[\\\/*?]+/, '.'))
      dossier_row = 0

      ie[:content].each do |rep_name, rep|
        next unless rep_name.is_a?(String)
        @rep = rep
        file_data_keys = Set.new %w(folder naam link mimetype puid formaat versie)
        file_list = []

        dossier_sheet.write_row(dossier_row, 0, [rep_name], rep_name_format)
        %w(preservationType usageType).each do |key|
          dossier_row += 1
          dossier_sheet.write_row(
              dossier_row, 0,
              [
                  key.underscore.gsub('_', ' '),
                  rep[:amd][:tech]['generalRepCharacteristics'][key]
              ]
          )
        end
        dossier_row += 2

        file_proc = lambda do |file|
          @file = file
          if file[:id]
            tech = file[:amd][:tech]
            # noinspection RubyStringKeysInHashInspection
            file_data = {
                'folder' => (tech['generalFileCharacteristics']['fileOriginalPath'] rescue '').split('/')[1..-1].join('\\'),
                'naam' => (tech['generalFileCharacteristics']['fileOriginalName'] rescue nil),
                'link' => ("http://depot.lias.be/delivery/DeliveryManagerServlet?dps_pid=#{file[:id]}" rescue nil),
                'mimetype' => (tech['fileFormat']['mimeType'] rescue nil),
                'puid' => (tech['fileFormat']['formatRegistryId'] rescue nil),
                'formaat' => (tech['fileFormat']['formatDescription'] rescue nil),
                'versie' => (tech['fileFormat']['formatVersion'] rescue nil),
                'viruscheck' => (tech['fileVirusCheck']['status'] rescue nil),
                'file_type' => (tech['generalFileCharacteristics']['FileEntityType']),
                'groep' => file[:group],
            }
            data = tech['fileValidation']
            if data
              valid = (data['isValid'] == 'true') rescue nil
              well_formed = (data['isWellFormed'] == 'true') rescue nil
              file_data['validatie'] = if valid && well_formed
                                         'OK'
                                       else
                                         'niet OK'
                                       end
            end
            data = tech['significantProperties']
            if data
              file_data[data['significantPropertiesType']] = data['significantPropertiesValue']
            end
            data = file[:dmd]
            if data
              data.each { |key, value| file_data[key] = value }
            end
            file_list << file_data
            file_data_keys.merge file_data.keys
          else
            file.each do |_, value|
              next unless value.is_a? Hash
              # noinspection RubyScope
              file_proc.call(value)
            end
          end
        end

        rep.keys.each do |key|
          file_proc.call(rep[key]) if key.is_a?(String)
        end

        table_start = dossier_row
        dossier_sheet.write_row(dossier_row, 0, file_data_keys.to_a, file_header_format)
        file_list.each do |file_info|
          dossier_row += 1
          file_data = []
          file_data_keys.each { |key| file_data << file_info[key] }
          dossier_sheet.write_row(dossier_row, 0, file_data)
        end
        table_end = dossier_row

        dossier_sheet.add_table(
            table_start, 0, table_end, file_data_keys.size - 1,
            style: 'Table Style Medium 16', name: rep[:id],
            columns: file_data_keys.map { |key| {header: key} }
        )

        dossier_row += 2
      end
      ie_data_keys.merge ie_data.keys
      ie_list << ie_data
    end
  end

  # write ie data to overview worksheet
  overview.write_row(0, 0, ie_data_keys.to_a, ie_data_header_format)
  overview_row = 1
  ie_list.each do |ie_info|
    ie_data = []
    ie_data_keys.each { |key| ie_data << ie_info[key] }
    overview.write_row(overview_row, 0, ie_data)
    overview_row += 1
  end

rescue Exception => e
  puts e.message
  puts e.backtrace
    # close and save workbook
ensure
  workbook.close
end

#get_deposits(from_date, to_date, flow_id, options = {}) ⇒ Hash

Searches for all deposits in the date range and for the given flow id. The method returns a list of all deposits, including information about the sip, the related IEs and a breakdown of the IE’s METS file.

Parameters:

  • from_date (String)
  • to_date (String)
  • flow_id (String)
  • options (String) (defaults to: {})

Returns:

  • (Hash) —

    detailed deposit information



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/libis/services/rosetta/service.rb', line 67

def get_deposits(from_date, to_date, flow_id, options = {})
  deposits = @deposit_service.get_by_submit_flow(from_date, to_date, flow_id, {status: 'Approved'}.merge(options))
  deposits.each do |deposit|
    ies = @sip_service.get_ies(deposit[:sip])
    ies_info = ies.map do |ie|
      title = nil
      id = nil
      begin
        md = @ie_service.get_metadata(ie).to_hash['mets:mets']
        dc = md['mets:dmdSec']['mets:mdWrap']['mets:xmlData']['dc:record']
        title = dc['dc:title']
        id = dc['dc:identifier']
      rescue
        # ignore
      end
      # retrieve ie mets file
      ie_info = @ie_service.get_mets(ie)
      {
          ie: ie,
          title: title,
          id: id,
          content: ie_info
      }.cleanup
    end
    deposit[:ies] = ies_info
  end
  deposits.sort! { |x, y| x[:ies][0][:id] <=> y[:ies][0][:id] }
  # deposits.each { |dep| dep[:ies].each { |ie| puts "DEP ##{dep[:deposit]} - SIP ##{dep[:sip]} - IE ##{ie[:ie]} - #{ie[:id]} - #{ie[:title]}" } }
  deposits
end

#ie ⇒ Object 



400
401
402
 
# File 'lib/libis/services/rosetta/service.rb', line 400

def ie
  @ie
end

#login(name, passwd, institute) ⇒ String

Returns PDS handle.

Parameters:

  • name (String)
  • passwd (String)
  • institute (String)

Returns:

  • (String) —

    PDS handle

Raises:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/libis/services/rosetta/service.rb', line 43

def (name, passwd, institute)
  handle = nil
  0.upto(3).each do |i|
    handle = @pds_service.(name, passwd, institute)
    break if handle
    sleep(3 ** i)
  end
  raise ServiceError, 'Could not login into Rosetta.' unless handle
  @producer_service.pds_handle = handle
  @deposit_service.pds_handle = handle
  @sip_service.pds_handle = handle
  @ie_service.pds_handle = handle
  @collection_service.pds_handle = handle
  handle
end

#rep ⇒ Object 



404
405
406
 
# File 'lib/libis/services/rosetta/service.rb', line 404

def rep
  @rep
end