libis-services 0.1.0-java

data/lib/libis/services/rosetta/pds_handler.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'libis/services/rest_client'
+
+module Libis
+  module Services
+    module Rosetta
+
+      class PdsHandler
+        include Libis::Services::RestClient
+
+        # @param [String] base_url
+        def initialize(base_url = 'https://pds.libis.be')
+          configure base_url
+        end
+
+        # @param [String] user
+        # @param [String] password
+        # @param [String] institute
+        # @return [String] PDS handle, nil if could not login
+        def login(user, password, institute)
+          params = {
+              func: 'login-url',
+              bor_id: user,
+              bor_verification: password,
+              institute: institute
+          }
+          response = get 'pds', params
+          return nil unless response.code == 200 and response.body.match /pds_handle=(\d+)[^\d]/
+          $1
+        end
+
+        # @param [String] pds_handle
+        # @return [Boolean] true if success
+        def logout(pds_handle)
+          params = {
+              func: 'logout',
+              pds_handle: pds_handle
+          }
+          response = get 'pds', params
+          response.code == 200
+        end
+
+        # @param [String] pds_handle
+        # @return [Hash] with user information. At least containing: 'id', 'name', 'institute' and 'group'
+        def user_info(pds_handle)
+          params = {
+              func: 'get-attribute',
+              attribute: 'BOR_INFO',
+              pds_handle: pds_handle
+          }
+          response = get 'pds', params
+          return nil unless response.code == 200
+          Nori.new(convert_tags_to: lambda {|tag| tag.to_sym}).parse(response.body)
+        end
+      end
+
+    end
+  end
+end

data/lib/libis/services/rosetta/producer.rb

@@ -0,0 +1,71 @@
+require 'virtus'
+
+module Libis
+  module Services
+    module Rosetta
+      class Producer
+        # noinspection RubyResolve
+        include Virtus.model(nullify_blank: true)
+
+        attribute :authoritative_name, String, default: 'producer'
+        attribute :account_type, String, default: 'GROUP'
+        attribute :status, String, default: 'ACTIVE'
+        attribute :expiry_date, String
+        attribute :first_name, String
+        attribute :last_name, String
+        attribute :institution, String, default: 'institution'
+        attribute :department, String, default: 'department'
+        attribute :user_name, String
+        attribute :producer_group, String, default: 'Published'
+        attribute :negotiator_id, String
+        attribute :producerProfile_id, String
+        attribute :telephone_1, String
+        attribute :telephone_2, String
+        attribute :fax, String
+        attribute :email, String
+        attribute :email_notify, String
+        attribute :web_site, String
+        attribute :street, String
+        attribute :suburb, String
+        attribute :city, String
+        attribute :zip_code, String
+        attribute :country, String
+        attribute :notes, String
+        attribute :local_field_1, String
+        attribute :local_field_2, String
+        attribute :contactUser_id_1, String
+        attribute :contactUser_id_2, String
+        attribute :contactUser_id_3, String
+        attribute :contactUser_id_4, String
+        attribute :contactUser_id_5, String
+
+        def to_hash
+          attributes.cleanup
+        end
+
+        def to_xml
+          Libis::Tools::XmlDocument.build do |xml|
+            # noinspection RubyResolve
+            xml.producer_info {
+              xml.parent.default_namespace = 'http://www.exlibrisgroup.com/xsd/dps/backoffice/service'
+              self.attributes.each do |name, value|
+                xml.send(name, xmlns: '').text(value) if value
+              end
+            }
+          end.to_xml
+        end
+
+        def self.from_xml(xml)
+          xml_doc = Libis::Tools::XmlDocument.parse(xml)
+          hash = xml_doc.to_hash(
+              strip_namespaces: true,
+              delete_namespace_attributes: true,
+              empty_tag_value: nil,
+              convert_tags_to: lambda { |tag| tag.to_sym }
+          )
+          self.new(hash[:producer_info])
+        end
+      end
+    end
+  end
+end

data/lib/libis/services/rosetta/producer_handler.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+require 'libis/tools/extend/hash'
+require 'libis/tools/xml_document'
+require_relative 'producer'
+require_relative 'user'
+
+require_relative 'client'
+module Libis
+  module Services
+    module Rosetta
+
+      class ProducerHandler < Libis::Services::Rosetta::Client
+
+
+        def initialize(base_url = 'http://depot.lias.be', options = {})
+          super 'backoffice', 'ProducerWebServices', {url: base_url}.merge(options)
+        end
+
+        def user_id(external_id)
+          call :get_internal_user_id_by_external_id, arg0: external_id
+        end
+
+        def is_user?(user_id)
+          call :is_user_exists, arg0: @pds_handle, arg1: user_id
+        end
+
+        def producer(producer_id, producer_info = nil)
+          if producer_info
+            info = producer(producer_id)
+            return nil if info.nil?
+            (producer_info.is_a?(Rosetta::Producer) ? producer_info.attributes : producer_info).each do |name, value|
+              info[name] = value
+            end
+            call :update_producer, arg0: @pds_handle, arg1: producer_id, arg2: info.to_xml
+          else
+            request_object :get_producer_details, Rosetta::Producer, arg0: @pds_handle, arg1: producer_id
+          end
+        end
+
+        def new_producer(producer_info)
+          producer_info = Rosetta::Producer.new(producer_info) unless producer_info.is_a?(Rosetta::Producer)
+          call :create_producer, arg0: @pds_handle, arg1: producer_info.to_xml
+        end
+
+        def delete_producer(producer_id)
+          call :remove_producer, arg0: @pds_handle, arg1: producer_id
+        end
+
+        def agent(agent_id, agent_info = nil)
+          if agent_info
+            info = agent(agent_id)
+            return nil if info.nil?
+            (agent_info.is_a?(Rosetta::User) ? agent_info.attributes : agent_info).each do |name, value|
+              info[name] = value
+            end
+            call :update_producer_agent, arg0: @pds_handle, arg1: agent_id, arg2: info.to_xml
+          else
+            request_object :get_producer_agent, Rosetta::User, arg0: @pds_handle, arg1: agent_id
+          end
+        end
+
+        def new_agent(agent_info)
+          agent_info = Rosetta::User.new(agent_info) unless agent_info.is_a?(Rosetta::User)
+          call :create_producer_agent, arg0: @pds_handle, arg1: agent_info.to_xml
+        end
+
+        def delete_agent(agent_id)
+          call :remove_producer_agent, arg0: @pds_handle, arg1: agent_id
+        end
+
+        def link_agent(agent_id, producer_id)
+          call :link_producer_agent_to_producer, arg0: @pds_handle, arg1: producer_id, arg2: agent_id
+        end
+
+        def unlink_agent(agent_id, producer_id)
+          call :unlink_producer_agent_from_producer, arg0: @pds_handle, arg1: producer_id, arg2: agent_id
+        end
+
+        def agent_producers(agent_id, institution = nil)
+          if institution
+            request_array :get_producers_of_producer_agent_with_ins, arg0: agent_id, arg1: institution
+          else
+            request_array :get_producers_of_producer_agent, arg0: agent_id
+          end
+        end
+
+        def contact(contact_id, contact_info = nil)
+          if contact_info
+            info = contact(contact_id)
+            return nil if info.nil?
+            (contact_info.is_a?(Rosetta::User) ? contact_info.attributes : contact_info).each do |name, value|
+              info[name] = value
+            end
+            call :update_contact, arg0: @pds_handle, arg1: contact_id, arg2: info.to_xml
+          else
+            request_object :get_contact, Rosetta::User, arg0: @pds_handle, arg1: contact_id
+          end
+        end
+
+        def new_contact(contact_info)
+          contact_info = Rosetta::User.new(contact_info) unless contact_info.is_a?(Rosetta::User)
+          call :create_contact, arg0: @pds_handle, arg1: contact_info.to_xml
+        end
+
+        def delete_contact(contact_id)
+          call :remove_contact, arg0: @pds_handle, arg1: contact_id
+        end
+
+        def link_contact(contact_id, producer_id, primary = true)
+          call :link_contact_to_producer, arg0: @pds_handle, arg1: producer_id, arg2: contact_id, arg3: (!!primary).to_s.upcase
+        end
+
+        def unlink_contact(contact_id, producer_id)
+          call :unlink_contact_from_producer, arg0: @pds_handle, arg1: producer_id, arg2: contact_id
+        end
+
+        def material_flows(producer_id)
+          request_array :get_material_flows_of_producer, arg0: producer_id
+        end
+
+      end
+
+    end
+  end
+end

data/lib/libis/services/rosetta/service.rb

@@ -0,0 +1,403 @@
+require_relative 'pds_handler'
+require_relative 'producer_handler'
+require_relative 'deposit_handler'
+require_relative 'sip_handler'
+require_relative 'ie_handler'
+require_relative 'collection_handler'
+require_relative 'oai_pmh'
+
+require 'libis/tools/mets_file'
+
+require 'csv'
+require 'write_xlsx'
+require 'backports'
+require 'awesome_print'
+
+module Libis
+  module Services
+    module Rosetta
+
+      # noinspection RubyTooManyInstanceVariablesInspection
+      class Service
+
+        attr_reader :pds_service, :producer_service, :deposit_service, :sip_service, :ie_service, :collection_service
+
+        # @param [String] base_url
+        def initialize(base_url = 'http://depot.lias.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
+
+        # @param [String] name
+        # @param [String] passwd
+        # @param [String] institute
+        # @return [String] PDS handle
+        def login(name, passwd, institute)
+          handle = @pds_service.login(name, passwd, institute)
+          @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
+
+        # 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.
+        #
+        # @param [String] from_date
+        # @param [String] to_date
+        # @param [String] flow_id
+        # @param [String] options
+        # @return [Hash] detailed deposit information
+        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
+
+        # @param [String] report_file
+        # @param [Array] deposits
+        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
+
+        # @param [String] report_file
+        # @param [Array] deposits
+        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
+
+        def file
+          @file
+        end
+
+        def ie
+          @ie
+        end
+
+        def rep
+          @rep
+        end
+
+      end
+
+    end
+  end
+end

data/lib/libis/services/rosetta/sip.rb

@@ -0,0 +1,26 @@
+require 'virtus'
+
+module Libis
+  module Services
+    module Rosetta
+      class Sip
+        # noinspection RubyResolve
+        include Virtus.model nullify_blank: true
+
+        MODULE = %w'PER'
+        STAGE = %w'Finished'
+        STATUS = %w'FINISHED'
+
+        attribute :id, Integer
+        attribute :module, String
+        attribute :stage, String
+        attribute :status, String
+
+        def to_hash
+          super.cleanup
+        end
+
+      end
+    end
+  end
+end