adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,364 @@
+# unpack resource information
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-11-01 original script
+
+require_relative 'module_resourceType'
+require_relative 'module_citation'
+require_relative 'module_timePeriod'
+require_relative 'module_responsibleParty'
+require_relative 'module_spatialReference'
+require_relative 'module_spatialRepresentation'
+require_relative 'module_spatialResolution'
+require_relative 'module_duration'
+require_relative 'module_extent'
+require_relative 'module_coverageDescription'
+require_relative 'module_taxonomy'
+require_relative 'module_graphic'
+require_relative 'module_format'
+require_relative 'module_keyword'
+require_relative 'module_resourceUsage'
+require_relative 'module_constraint'
+require_relative 'module_locale'
+require_relative 'module_maintenance'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ResourceInfo
+
+                    def self.unpack(hResInfo, responseObj)
+
+                        # return nil object if input is empty
+                        if hResInfo.empty?
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intResInfo = intMetadataClass.newResourceInfo
+
+                        # resource information - resource type [] (required) {resourceType}
+                        if hResInfo.has_key?('resourceType')
+                            hResInfo['resourceType'].each do |item|
+                                unless item.empty?
+                                    hReturn = ResourceType.unpack(item, responseObj)
+                                    unless hReturn.nil?
+                                        intResInfo[:resourceTypes] << hReturn
+                                    end
+                                end
+                            end
+                        end
+                        if intResInfo[:resourceTypes].empty?
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo is missing resourceType'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource information - citation {citation} (required)
+                        if hResInfo.has_key?('citation')
+                            hObject = hResInfo['citation']
+                            unless hObject.empty?
+                                hReturn = Citation.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:citation] = hReturn
+                                end
+                            end
+                        end
+                        if intResInfo[:citation].empty?
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo is missing citation'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource information - abstract (required)
+                        if hResInfo.has_key?('abstract')
+                            intResInfo[:abstract] = hResInfo['abstract']
+                        end
+                        if intResInfo[:abstract].nil? || intResInfo[:abstract] == ''
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo is missing abstract'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource information - short abstract
+                        if hResInfo.has_key?('shortAbstract')
+                            if hResInfo['shortAbstract'] != ''
+                                intResInfo[:shortAbstract] = hResInfo['shortAbstract']
+                            end
+                        end
+
+                        # resource information - purpose
+                        if hResInfo.has_key?('purpose')
+                            if hResInfo['purpose'] != ''
+                                intResInfo[:purpose] = hResInfo['purpose']
+                            end
+                        end
+
+                        # resource information - credits []
+                        if hResInfo.has_key?('credit')
+                            hResInfo['credit'].each do |item|
+                                if item != ''
+                                    intResInfo[:credits] << item
+                                end
+                            end
+                        end
+
+                        # resource information - resource time period {timePeriod}
+                        if hResInfo.has_key?('timePeriod')
+                            hObject = hResInfo['timePeriod']
+                            unless hObject.empty?
+                                hReturn = TimePeriod.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:timePeriod] = hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - status [] (required)
+                        if hResInfo.has_key?('status')
+                            hResInfo['status'].each do |item|
+                                if item != ''
+                                    intResInfo[:status] << item
+                                end
+                            end
+                        end
+                        if intResInfo[:status].empty?
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo is missing status'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource information - topic category []
+                        if hResInfo.has_key?('topicCategory')
+                            hResInfo['topicCategory'].each do |item|
+                                if item != ''
+                                    intResInfo[:topicCategories] << item
+                                end
+                            end
+                        end
+
+                        # resource information - point of contact [] {responsibleParty} (required)
+                        if hResInfo.has_key?('pointOfContact')
+                            aItems = hResInfo['pointOfContact']
+                            aItems.each do |item|
+                                hReturn = ResponsibleParty.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:pointOfContacts] << hReturn
+                                end
+                            end
+                        end
+                        if intResInfo[:pointOfContacts].empty?
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo object is missing pointOfContact'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource information - spatial reference system [] {spatialReference}
+                        if hResInfo.has_key?('spatialReferenceSystem')
+                            aItems = hResInfo['spatialReferenceSystem']
+                            aItems.each do |item|
+                                hReturn = SpatialReferenceSystem.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:spatialReferenceSystems] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - spatial representation type []
+                        if hResInfo.has_key?('spatialRepresentationType')
+                            hResInfo['spatialRepresentationType'].each do |item|
+                                if item != ''
+                                    intResInfo[:spatialRepresentationTypes] << item
+                                end
+                            end
+                        end
+
+                        # resource information - spatial representation [] {spatialRepresentation}
+                        if hResInfo.has_key?('spatialRepresentation')
+                            aItems = hResInfo['spatialRepresentation']
+                            aItems.each do |item|
+                                hReturn = SpatialRepresentation.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:spatialRepresentations] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - spatial resolution [] {spatialResolution}
+                        if hResInfo.has_key?('spatialResolution')
+                            aItems = hResInfo['spatialResolution']
+                            aItems.each do |item|
+                                hReturn = SpatialResolution.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:spatialResolutions] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - temporal resolution [] {duration}
+                        if hResInfo.has_key?('temporalResolution')
+                            aItems = hResInfo['temporalResolution']
+                            aItems.each do |item|
+                                hReturn = Duration.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:temporalResolutions] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - extent [] {extent}
+                        if hResInfo.has_key?('extent')
+                            aItems = hResInfo['extent']
+                            aItems.each do |item|
+                                hReturn = Extent.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:extents] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - content information [] {contentInformation}
+                        if hResInfo.has_key?('coverageDescription')
+                            aItems = hResInfo['coverageDescription']
+                            aItems.each do |item|
+                                hReturn = CoverageDescription.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:coverageDescriptions] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - taxonomy {taxonomy}
+                        if hResInfo.has_key?('taxonomy')
+                            hObject = hResInfo['taxonomy']
+                            unless hObject.empty?
+                                hReturn = Taxonomy.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:taxonomy] = hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - graphic overview [] {graphicOverview}
+                        if hResInfo.has_key?('graphicOverview')
+                            aItems = hResInfo['graphicOverview']
+                            aItems.each do |item|
+                                hReturn = Graphic.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:graphicOverviews] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - resource format [] {format}
+                        if hResInfo.has_key?('resourceFormat')
+                            aItems = hResInfo['resourceFormat']
+                            aItems.each do |item|
+                                hReturn = Format.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:resourceFormats] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - keyword [] {keyword}
+                        if hResInfo.has_key?('keyword')
+                            aItems = hResInfo['keyword']
+                            aItems.each do |item|
+                                hReturn = Keyword.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:keywords] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - resource usage [] {resourceUsage}
+                        if hResInfo.has_key?('resourceUsage')
+                            aItems = hResInfo['resourceUsage']
+                            aItems.each do |item|
+                                hReturn = ResourceUsage.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:resourceUsages] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - constraint [] {constraint}
+                        if hResInfo.has_key?('constraint')
+                            aCons = hResInfo['constraint']
+                            aCons.each do |hItem|
+                                hReturn = Constraint.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:constraints] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - default resource locale {locale} (required)
+                        if hResInfo.has_key?('defaultResourceLocale')
+                            hObject = hResInfo['defaultResourceLocale']
+                            unless hObject.empty?
+                                hReturn = Locale.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:defaultResourceLocale] = hReturn
+                                end
+                            end
+                        end
+                        if intResInfo[:defaultResourceLocale].empty?
+                            responseObj[:readerExecutionMessages] << 'ResourceInfo object is missing defaultResourceLocale'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource information - other resource locale [] {locale}
+                        if hResInfo.has_key?('otherResourceLocale')
+                            aItems = hResInfo['otherResourceLocale']
+                            aItems.each do |item|
+                                hReturn = Locale.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:otherResourceLocales] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - resource maintenance [] {maintenance}
+                        if hResInfo.has_key?('resourceMaintenance')
+                            aItems = hResInfo['resourceMaintenance']
+                            aItems.each do |item|
+                                hReturn = Maintenance.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intResInfo[:resourceMaintenance] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource information - environment description
+                        if hResInfo.has_key?('environmentDescription')
+                            if hResInfo['environmentDescription'] != ''
+                                intResInfo[:environmentDescription] = hResInfo['environmentDescription']
+                            end
+                        end
+
+                        # resource information - supplemental information
+                        if hResInfo.has_key?('supplementalInfo')
+                            if hResInfo['supplementalInfo'] != ''
+                                intResInfo[:supplementalInfo] = hResInfo['supplementalInfo']
+                            end
+                        end
+
+                        return intResInfo
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,55 @@
+# unpack resourceType
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2017-02-15 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ResourceType
+
+                    def self.unpack(hType, responseObj)
+
+                        # return nil object if input is empty
+                        if hType.empty?
+                            responseObj[:readerExecutionMessages] << 'Resource Type object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intType = intMetadataClass.newResourceType
+
+                        # resource type - type (required) {MD_ScopeCode}
+                        if hType.has_key?('type')
+                            if hType['type'] != ''
+                                intType[:type] = hType['type']
+                            end
+                        end
+                        if intType[:type].nil?
+                            responseObj[:readerExecutionMessages] << 'Resource Type object is missing type'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource type - name
+                        if hType.has_key?('name')
+                            if hType['name'] != ''
+                                intType[:name] = hType['name']
+                            end
+                        end
+
+                        return intType
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,117 @@
+# unpack resource usage
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2016-10-11 refactored for mdJson 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-04-28 modified attribute names to match json schema 0.3.0
+# 	Stan Smith 2013-11-27 modified to process a single resource usage
+# 	Stan Smith 2013-11-25 original script
+
+require_relative 'module_temporalExtent'
+require_relative 'module_citation'
+require_relative 'module_responsibleParty'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ResourceUsage
+
+                    def self.unpack(hUsage, responseObj)
+
+                        # return nil object if input is empty
+                        if hUsage.empty?
+                            responseObj[:readerExecutionMessages] << 'Resource Usage object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intUsage = intMetadataClass.newResourceUsage
+
+                        # resource usage - specific usage (required)
+                        if hUsage.has_key?('specificUsage')
+                            intUsage[:specificUsage] = hUsage['specificUsage']
+                        end
+                        if intUsage[:specificUsage].nil? || intUsage[:specificUsage] == ''
+                            responseObj[:readerExecutionMessages] << 'Resource Usage attribute specificUsage is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # resource usage - temporal extent []
+                        if hUsage.has_key?('temporalExtent')
+                            aItems = hUsage['temporalExtent']
+                            aItems.each do |hItem|
+                                hReturn = TemporalExtent.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intUsage[:temporalExtents] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource usage - user determined limitations
+                        if hUsage.has_key?('userDeterminedLimitation')
+                            if hUsage['userDeterminedLimitation'] != ''
+                                intUsage[:userLimitation] = hUsage['userDeterminedLimitation']
+                            end
+                        end
+
+                        # resource usage - repository - limitation response []
+                        if hUsage.has_key?('limitationResponse')
+                            hUsage['limitationResponse'].each do |item|
+                                if item != ''
+                                    intUsage[:limitationResponses] << item
+                                end
+                            end
+                        end
+
+                        # resource usage - repository - documented issue
+                        if hUsage.has_key?('documentedIssue')
+                            hCitation = hUsage['documentedIssue']
+                            unless hCitation.empty?
+                                hReturn = Citation.unpack(hCitation, responseObj)
+                                unless hReturn.nil?
+                                    intUsage[:identifiedIssue] = hReturn
+                                end
+                            end
+                        end
+
+                        # resource usage - repository - additional documentation []
+                        if hUsage.has_key?('additionalDocumentation')
+                            aItems = hUsage['additionalDocumentation']
+                            aItems.each do |hItem|
+                                hReturn = Citation.unpack(hItem, responseObj)
+                                unless hReturn.nil?
+                                    intUsage[:additionalDocumentation] << hReturn
+                                end
+                            end
+                        end
+
+                        # resource usage - repository - responsible party []
+                        if hUsage.has_key?('userContactInfo')
+                            aContacts = hUsage['userContactInfo']
+                            aContacts.each do |item|
+                                hReturn = ResponsibleParty.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intUsage[:userContacts] << hReturn
+                                end
+                            end
+                        end
+
+                        return intUsage
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,91 @@
+# unpack responsible party
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+#   Stan Smith 2017-01-19 changed timePeriod to extent []
+#   Stan Smith 2016-10-09 refactored for mdJson 2.0
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-06-12 added check that contactId for responsibleParty
+#   ... matches an actual contact in the contact array
+#   Stan Smith 2015-01-18 added nil return if hRParty empty
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-05-28 modified to support JSON schema 0.5.0
+#   ... removed resource IDs associated with contact
+# 	Stan Smith 2013-08-26 original script
+
+require_relative 'module_extent'
+require_relative 'module_party'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ResponsibleParty
+
+                    def self.unpack(hRParty, responseObj)
+
+                        # return nil object if input is empty
+                        if hRParty.empty?
+                            responseObj[:readerExecutionMessages] << 'Responsible Party object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        # CI_Responsibility replaces CI_ResponsibleParty in 19115-1
+                        # Responsibility object is translated to ResponsibleParty by 19115-2 writer
+                        intMetadataClass = InternalMetadata.new
+                        intResParty = intMetadataClass.newResponsibility
+
+                        # responsible party - role - required
+                        if hRParty.has_key?('role')
+                            intResParty[:roleName] = hRParty['role']
+                        end
+                        if intResParty[:roleName].nil? || intResParty[:roleName] == ''
+                            responseObj[:readerExecutionMessages] << 'Responsible Party role is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # responsible party - role extent
+                        if hRParty.has_key?('roleExtent')
+                            aExtent = hRParty['roleExtent']
+                            aExtent.each do |hItem|
+                                unless hItem.empty?
+                                    hTimeExtent = Extent.unpack(hItem, responseObj)
+                                    unless hTimeExtent.nil?
+                                        intResParty[:roleExtents] << hTimeExtent
+                                    end
+                                end
+                            end
+                        end
+
+                        # responsible party - party [] (minimum 1)
+                        if hRParty.has_key?('party')
+                            hRParty['party'].each do |hParty|
+                                unless hParty.empty?
+                                    party = Party.unpack(hParty, responseObj)
+                                    unless party.nil?
+                                        intResParty[:parties] << party
+                                    end
+                                end
+                            end
+                        end
+                        if intResParty[:parties].empty?
+                            responseObj[:readerExecutionMessages] << 'Responsible Party object must have at least one party'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intResParty
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,56 @@
+# unpack schema
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-11-02 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Schema
+
+                    def self.unpack(hSchema, responseObj)
+
+                        # return nil object if input is empty
+                        if hSchema.empty?
+                            responseObj[:readerExecutionMessages] << 'Schema object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intSchema = intMetadataClass.newSchema
+
+                        # schema - name (required)
+                        if hSchema.has_key?('name')
+                            intSchema[:name] = hSchema['name']
+                        end
+                        if intSchema[:name].nil? || intSchema[:name] == ''
+                            responseObj[:readerExecutionMessages] << 'Schema is missing name'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # schema - version (required)
+                        if hSchema.has_key?('version')
+                            intSchema[:version] = hSchema['version']
+                        end
+                        if intSchema[:version].nil? || intSchema[:version] == ''
+                            responseObj[:readerExecutionMessages] << 'Schema is missing version'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intSchema
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end