adiwg-mdtranslator 1.4.0 → 2.0.0rc2

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_mdJson.rb

@@ -0,0 +1,136 @@
+# unpack mdJson
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-11-07 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_schema'
+require_relative 'module_contact'
+require_relative 'module_metadata'
+require_relative 'module_dataDictionary'
+require_relative 'module_metadataRepository'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module MdJson
+
+                    def self.unpack(hMdJson, responseObj)
+
+                        # return nil object if input is empty
+                        if hMdJson.empty?
+                            responseObj[:readerExecutionMessages] << 'mdJson object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intObj = intMetadataClass.newBase
+
+                        # mdJson - schema {schema} (required)
+                        if hMdJson.has_key?('schema')
+                            hObject = hMdJson['schema']
+                            unless hObject.empty?
+                                hReturn = Schema.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intObj[:schema] = hReturn
+                                end
+                            end
+                        end
+                        if intObj[:schema].empty?
+                            responseObj[:readerExecutionMessages] << 'mdJson object is missing schema'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # mdJson - contact [] {contact} (required)
+                        if hMdJson.has_key?('contact')
+                            aItems = hMdJson['contact']
+                            aItems.each do |item|
+                                hReturn = Contact.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intObj[:contacts] << hReturn
+                                    @contacts = intObj[:contacts]
+                                end
+                            end
+                        end
+                        if intObj[:contacts].empty?
+                            responseObj[:readerExecutionMessages] << 'mdJson object is missing contact'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # mdJson - metadata {metadata}
+                        if hMdJson.has_key?('metadata')
+                            hObject = hMdJson['metadata']
+                            unless hObject.empty?
+                                hReturn = Metadata.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intObj[:metadata] = hReturn
+                                end
+                            end
+                        end
+
+                        # mdJson - data dictionary [] {dataDictionary}
+                        if hMdJson.has_key?('dataDictionary')
+                            aItems = hMdJson['dataDictionary']
+                            aItems.each do |hItem|
+                                hReturn = DataDictionary.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intObj[:dataDictionaries] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata - metadata distribution [] {metadataDistribution}
+                        if hMdJson.has_key?('metadataRepository')
+                            aItems = hMdJson['metadataRepository']
+                            aItems.each do |item|
+                                hReturn = MetadataRepository.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intObj[:metadataRepositories] << hReturn
+                                end
+                            end
+                        end
+
+                        return intObj
+
+                    end
+
+                    # find the array pointer and type for a contact
+                    def self.findContact(contactId)
+
+                        contactIndex = nil
+                        contactType = nil
+                        i = 0
+                        @contacts.each do |contact|
+                            if contact[:contactId] == contactId
+                                contactIndex = i
+                                if contact[:isOrganization]
+                                    contactType = 'organization'
+                                else
+                                    contactType = 'individual'
+                                end
+                            end
+                            i += 1
+                        end
+
+                        return contactIndex, contactType
+
+                    end
+
+                    # set contacts array for reader test modules
+                    def self.setContacts(contacts)
+                        @contacts = contacts
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_measure.rb

@@ -0,0 +1,75 @@
+# unpack measure
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-17 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Measure
+
+                    def self.unpack(hMeasure, responseObj)
+
+                        # return nil object if input is empty
+                        if hMeasure.empty?
+                            responseObj[:readerExecutionMessages] << 'Measure object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intMeasure = intMetadataClass.newMeasure
+
+                        # measure - type enumeration (required)
+                        if hMeasure.has_key?('type')
+                            if hMeasure['type'] != ''
+                                type = hMeasure['type']
+                                if %w{ distance length vertical angle measure scale }.one? { |word| word == type }
+                                    intMeasure[:type] = hMeasure['type']
+                                else
+                                    responseObj[:readerExecutionMessages] << 'Measure type must be distance, length, vertical, or angle'
+                                    responseObj[:readerExecutionPass] = false
+                                    return nil
+                                end
+                            end
+                        end
+                        if intMeasure[:type].nil? || intMeasure[:type] == ''
+                            responseObj[:readerExecutionMessages] << 'Measure attribute type is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # measure - value (required)
+                        if hMeasure.has_key?('value')
+                            intMeasure[:value] = hMeasure['value']
+                        end
+                        if intMeasure[:value].nil? || intMeasure[:value] == ''
+                            responseObj[:readerExecutionMessages] << 'Measure attribute value is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # measure - unit of measure (required)
+                        if hMeasure.has_key?('unitOfMeasure')
+                            intMeasure[:unitOfMeasure] = hMeasure['unitOfMeasure']
+                        end
+                        if intMeasure[:unitOfMeasure].nil? || intMeasure[:unitOfMeasure] == ''
+                            responseObj[:readerExecutionMessages] << 'Measure attribute unitOfMeasure is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intMeasure
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_medium.rb

@@ -0,0 +1,105 @@
+# unpack medium
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-20 original script
+
+require_relative 'module_citation'
+require_relative 'module_identifier'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Medium
+
+                    def self.unpack(hMedium, responseObj)
+
+                        # return nil object if input is empty
+                        if hMedium.empty?
+                            responseObj[:readerExecutionMessages] << 'Medium object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intMedium = intMetadataClass.newMedium
+
+                        # medium - mediumSpecification {citation}
+                        if hMedium.has_key?('mediumSpecification')
+                            hObject = hMedium['mediumSpecification']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMedium[:mediumSpecification] = hReturn
+                                end
+                            end
+                        end
+
+                        # medium - density
+                        if hMedium.has_key?('density')
+                            if hMedium['density'] != ''
+                                intMedium[:density] = hMedium['density']
+                            end
+                        end
+
+                        # medium - units
+                        if hMedium.has_key?('units')
+                            if hMedium['units'] != ''
+                                intMedium[:units] = hMedium['units']
+                            end
+                        end
+
+                        # medium - numberOfVolumes
+                        if hMedium.has_key?('numberOfVolumes')
+                            if hMedium['numberOfVolumes'] != ''
+                                intMedium[:numberOfVolumes] = hMedium['numberOfVolumes']
+                            end
+                        end
+
+                        # medium - numberOfVolumes
+                        if hMedium.has_key?('numberOfVolumes')
+                            if hMedium['numberOfVolumes'] != ''
+                                intMedium[:numberOfVolumes] = hMedium['numberOfVolumes']
+                            end
+                        end
+
+                        # medium - mediumFormat
+                        if hMedium.has_key?('mediumFormat')
+                            hMedium['mediumFormat'].each do |item|
+                                if item != ''
+                                    intMedium[:mediumFormat] << item
+                                end
+                            end
+                        end
+
+                        # medium - note
+                        if hMedium.has_key?('note')
+                            if hMedium['note'] != ''
+                                intMedium[:note] = hMedium['note']
+                            end
+                        end
+
+                        # medium - identifier
+                        if hMedium.has_key?('identifier')
+                            hObject = hMedium['identifier']
+                            unless hObject.empty?
+                                hReturn = Identifier.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMedium[:identifier] = hReturn
+                                end
+                            end
+                        end
+
+                        return intMedium
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadata.rb

@@ -0,0 +1,131 @@
+# unpack metadata
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-11-02 original script
+
+require_relative 'module_metadataInfo'
+require_relative 'module_resourceInfo'
+require_relative 'module_lineage'
+require_relative 'module_distribution'
+require_relative 'module_associatedResource'
+require_relative 'module_additionalDocumentation'
+require_relative 'module_funding'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Metadata
+
+                    def self.unpack(hMetadata, responseObj)
+
+                        # return nil object if input is empty
+                        if hMetadata.empty?
+                            responseObj[:readerExecutionMessages] << 'Metadata object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intMetadata = intMetadataClass.newMetadata
+
+                        # metadata - metadata info {metadataInfo} (required)
+                        if hMetadata.has_key?('metadataInfo')
+                            hObject = hMetadata['metadataInfo']
+                            unless hObject.empty?
+                                hReturn = MetadataInfo.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:metadataInfo] = hReturn
+                                end
+                            end
+                        end
+                        if intMetadata[:metadataInfo].empty?
+                            responseObj[:readerExecutionMessages] << 'Metadata object is missing metadataInfo'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # metadata - resource info {resourceInfo} (required)
+                        if hMetadata.has_key?('resourceInfo')
+                            hObject = hMetadata['resourceInfo']
+                            unless hObject.empty?
+                                hReturn = ResourceInfo.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:resourceInfo] = hReturn
+                                end
+                            end
+                        end
+                        if intMetadata[:resourceInfo].empty?
+                            responseObj[:readerExecutionMessages] << 'Metadata object is missing resourceInfo'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # metadata - resource lineage [] {lineage}
+                        if hMetadata.has_key?('resourceLineage')
+                            aItems = hMetadata['resourceLineage']
+                            aItems.each do |item|
+                                hReturn = ResourceLineage.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:lineageInfo] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata - resource distribution [] {distribution}
+                        if hMetadata.has_key?('resourceDistribution')
+                            aItems = hMetadata['resourceDistribution']
+                            aItems.each do |item|
+                                hReturn = Distribution.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:distributorInfo] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata - associated resource [] {associatedResource}
+                        if hMetadata.has_key?('associatedResource')
+                            aItems = hMetadata['associatedResource']
+                            aItems.each do |item|
+                                hReturn = AssociatedResource.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:associatedResources] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata - additional resource [] {additionalResource}
+                        if hMetadata.has_key?('additionalDocumentation')
+                            aItems = hMetadata['additionalDocumentation']
+                            aItems.each do |item|
+                                hReturn = AdditionalDocumentation.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:additionalDocuments] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata - funding [] {funding}
+                        if hMetadata.has_key?('funding')
+                            aItems = hMetadata['funding']
+                            aItems.each do |item|
+                                hReturn = Funding.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetadata[:funding] << hReturn
+                                end
+                            end
+                        end
+
+                        return intMetadata
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataInfo.rb

@@ -0,0 +1,157 @@
+# unpack metadata information
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2017-01-31 remove metadataCreationDate
+#   Stan Smith 2016-10-31 original script
+
+require_relative 'module_identifier'
+require_relative 'module_citation'
+require_relative 'module_locale'
+require_relative 'module_responsibleParty'
+require_relative 'module_date'
+require_relative 'module_onlineResource'
+require_relative 'module_maintenance'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module MetadataInfo
+
+                    def self.unpack(hMetaInfo, responseObj)
+
+
+                        # return nil object if input is empty
+                        if hMetaInfo.empty?
+                            responseObj[:readerExecutionMessages] << 'MetadataInfo object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intMetaInfo = intMetadataClass.newMetadataInfo
+
+                        # metadata information - metadata identifier {identifier}
+                        if hMetaInfo.has_key?('metadataIdentifier')
+                            hObject = hMetaInfo['metadataIdentifier']
+                            unless hObject.empty?
+                                hReturn = Identifier.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:metadataIdentifier] = hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - parent metadata {citation}
+                        if hMetaInfo.has_key?('parentMetadata')
+                            hObject = hMetaInfo['parentMetadata']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:parentMetadata] = hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - default metadata locale {locale} (default to utf-8)
+                        if hMetaInfo.has_key?('defaultMetadataLocale')
+                            hObject = hMetaInfo['defaultMetadataLocale']
+                            unless hObject.empty?
+                                hReturn = Locale.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:defaultMetadataLocale] = hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - other metadata locale [] {locale}
+                        if hMetaInfo.has_key?('otherMetadataLocale')
+                            aItems = hMetaInfo['otherMetadataLocale']
+                            aItems.each do |item|
+                                hReturn = Locale.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:otherMetadataLocales] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - metadata contact [] {responsibleParty} (required)
+                        if hMetaInfo.has_key?('metadataContact')
+                            aItems = hMetaInfo['metadataContact']
+                            aItems.each do |item|
+                                hReturn = ResponsibleParty.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:metadataContacts] << hReturn
+                                end
+                            end
+                        end
+                        if intMetaInfo[:metadataContacts].empty?
+                            responseObj[:readerExecutionMessages] << 'MetadataInfo object is missing metadataContacts'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # metadata information - metadata dates [] {date}
+                        if hMetaInfo.has_key?('metadataDate')
+                            aItems = hMetaInfo['metadataDate']
+                            aItems.each do |item|
+                                hReturn = Date.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:metadataDates] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - metadata online resource [] {onlineResource}
+                        if hMetaInfo.has_key?('metadataOnlineResource')
+                            aItems = hMetaInfo['metadataOnlineResource']
+                            aItems.each do |item|
+                                hReturn = OnlineResource.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:metadataLinkages] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - metadata maintenance {maintenance}
+                        if hMetaInfo.has_key?('metadataMaintenance')
+                            hObject = hMetaInfo['metadataMaintenance']
+                            unless hObject.empty?
+                                hReturn = Maintenance.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:metadataMaintenance] = hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - alternative metadata reference [] {citation}
+                        if hMetaInfo.has_key?('alternateMetadataReference')
+                            aItems = hMetaInfo['alternateMetadataReference']
+                            aItems.each do |item|
+                                hReturn = Citation.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intMetaInfo[:alternateMetadataReferences] << hReturn
+                                end
+                            end
+                        end
+
+                        # metadata information - metadata status
+                        if hMetaInfo.has_key?('metadataStatus')
+                            if hMetaInfo['metadataStatus'] != ''
+                                intMetaInfo[:metadataStatus] = hMetaInfo['metadataStatus']
+                            end
+                        end
+
+                        return intMetaInfo
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataRepository.rb

@@ -0,0 +1,53 @@
+# unpack metadata distribution
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2017-02-09 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module MetadataRepository
+
+                    def self.unpack(hMdDist, responseObj)
+
+                        # return nil object if input is empty
+                        if hMdDist.empty?
+                            responseObj[:readerExecutionMessages] << 'Metadata Repository object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intMdDist = intMetadataClass.newMetadataRepository
+
+                        # metadata distribution - repository (required)
+                        if hMdDist.has_key?('repository')
+                            intMdDist[:repository] = hMdDist['repository']
+                        end
+                        if intMdDist[:repository].nil? || intMdDist[:repository] == ''
+                            responseObj[:readerExecutionMessages] << 'Metadata Repository repository is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # metadata distribution - metadata format
+                        if hMdDist.has_key?('metadataStandard')
+                            if hMdDist['metadataStandard'] != ''
+                                intMdDist[:metadataStandard] = hMdDist['metadataStandard']
+                            end
+                        end
+
+                        return intMdDist
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end