adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_metadata.rb

@@ -13,13 +13,15 @@
 #   Stan Smith 2014-05-02 added additional documentation
 #   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_metadataInfo')
-require $ReaderNS.readerModule('module_resourceInfo')
-require $ReaderNS.readerModule('module_distributionInfo')
-require $ReaderNS.readerModule('module_associatedResource')
-require $ReaderNS.readerModule('module_additionalDocumentation')
-require $ReaderNS.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_metadataInfo')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceInfo')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_distributionInfo')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_associatedResource')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_additionalDocumentation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
 
 module ADIWG
     module Mdtranslator
@@ -28,7 +30,7 @@ module ADIWG
 
                 module Metadata
 
-                    def self.unpack(hMetadata)
+                    def self.unpack(hMetadata, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -37,13 +39,13 @@ module ADIWG
                         # metadata - metadataInfo
                         # metadataInfo needs access to resourceInfo to check taxonomy
                         if hMetadata.has_key?('metadataInfo')
-                            intMetadata[:metadataInfo] = $ReaderNS::MetadataInfo.unpack(hMetadata)
+                            intMetadata[:metadataInfo] = MetadataInfo.unpack(hMetadata,responseObj)
                         end
 
                         # metadata - resource identification info
                         if hMetadata.has_key?('resourceInfo')
                             hResourceInfo = hMetadata['resourceInfo']
-                            intMetadata[:resourceInfo] = $ReaderNS::ResourceInfo.unpack(hResourceInfo)
+                            intMetadata[:resourceInfo] = ResourceInfo.unpack(hResourceInfo, responseObj)
                         end
 
                         # metadata - distribution info
@@ -51,7 +53,7 @@ module ADIWG
                             aDistributors = hMetadata['distributionInfo']
                             unless aDistributors.empty?
                                 aDistributors.each do |hDistributor|
-                                    intMetadata[:distributorInfo] << $ReaderNS::DistributionInfo.unpack(hDistributor)
+                                    intMetadata[:distributorInfo] << DistributionInfo.unpack(hDistributor, responseObj)
                                 end
                             end
                         end
@@ -61,7 +63,7 @@ module ADIWG
                             aAssocRes = hMetadata['associatedResource']
                             unless aAssocRes.empty?
                                 aAssocRes.each do |hAssocRes|
-                                    intMetadata[:associatedResources] << $ReaderNS::AssociatedResource.unpack(hAssocRes)
+                                    intMetadata[:associatedResources] << AssociatedResource.unpack(hAssocRes, responseObj)
                                 end
                             end
                         end
@@ -71,7 +73,7 @@ module ADIWG
                             aAddDocs = hMetadata['additionalDocumentation']
                             unless aAddDocs.empty?
                                 aAddDocs.each do |hAddDoc|
-                                    intMetadata[:additionalDocuments] << $ReaderNS::AdditionalDocumentation.unpack(hAddDoc)
+                                    intMetadata[:additionalDocuments] << AdditionalDocumentation.unpack(hAddDoc, responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_metadataExtension.rb

@@ -5,6 +5,8 @@
 # 	Stan Smith 2013-11-22 original script
 #   Stan Smith 2014-05-15 modified for JSON schema 0.4.0
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -13,7 +15,7 @@ module ADIWG
 
                 module MetadataExtension
 
-                    def self.addExtensionISObio()
+                    def self.addExtensionISObio(responseObj)
 
                         intMetadataClass = InternalMetadata.new
                         intMetaExt = intMetadataClass.newMetadataExtension

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_metadataInfo.rb

@@ -9,13 +9,17 @@
 #   Stan Smith 2014-11-06 removed metadataScope, moved to resourceType under resourceInfo json 0.9.0
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-06-12 added support for metadataCharacterSet
-
-require $ReaderNS.readerModule('module_responsibleParty')
-require $ReaderNS.readerModule('module_dateTime')
-require $ReaderNS.readerModule('module_resourceMaintenance')
-require $ReaderNS.readerModule('module_metadataExtension')
-require $ReaderNS.readerModule('module_resourceIdentifier')
-require $ReaderNS.readerModule('module_citation')
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-07-28 added support for locale
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceMaintenance')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_metadataExtension')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceIdentifier')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_locale')
 
 module ADIWG
     module Mdtranslator
@@ -24,7 +28,11 @@ module ADIWG
 
                 module MetadataInfo
 
-                    def self.unpack(hMetadata)
+                    def self.unpack(hMetadata, responseObj)
+
+                        # return nil object if input is empty
+                        intMetadataInfo = nil
+                        return if hMetadata.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -35,7 +43,7 @@ module ADIWG
                         if hMetadataInfo.has_key?('metadataIdentifier')
                             hMetadataId = hMetadataInfo['metadataIdentifier']
                             unless hMetadataId.empty?
-                                intMetadataInfo[:metadataId] = $ReaderNS::ResourceIdentifier.unpack(hMetadataId)
+                                intMetadataInfo[:metadataId] = ResourceIdentifier.unpack(hMetadataId, responseObj)
                             end
                         end
 
@@ -43,7 +51,7 @@ module ADIWG
                         if hMetadataInfo.has_key?('parentMetadata')
                             hParent = hMetadataInfo['parentMetadata']
                             unless hParent.empty?
-                                intMetadataInfo[:parentMetadata] = $ReaderNS::Citation.unpack(hParent)
+                                intMetadataInfo[:parentMetadata] = Citation.unpack(hParent, responseObj)
                             end
                         end
 
@@ -52,7 +60,7 @@ module ADIWG
                             aCust = hMetadataInfo['metadataContact']
                             unless aCust.empty?
                                 aCust.each do |rParty|
-                                    intMetadataInfo[:metadataCustodians] << $ReaderNS::ResponsibleParty.unpack(rParty)
+                                    intMetadataInfo[:metadataCustodians] << ResponsibleParty.unpack(rParty, responseObj)
                                 end
                             end
                         end
@@ -61,7 +69,7 @@ module ADIWG
                         if hMetadataInfo.has_key?('metadataCreationDate')
                             s = hMetadataInfo['metadataCreationDate']
                             if s != ''
-                                hDateTime = $ReaderNS::DateTime.unpack(s)
+                                hDateTime = DateTime.unpack(s, responseObj)
                                 hDateTime[:dateType] = 'publication'
                                 intMetadataInfo[:metadataCreateDate] = hDateTime
                             end
@@ -71,7 +79,7 @@ module ADIWG
                         if hMetadataInfo.has_key?('metadataLastUpdate')
                             s = hMetadataInfo['metadataLastUpdate']
                             if s != ''
-                                hDateTime = $ReaderNS::DateTime.unpack(s)
+                                hDateTime = DateTime.unpack(s, responseObj)
                                 hDateTime[:dateType] = 'revision'
                                 intMetadataInfo[:metadataUpdateDate] = hDateTime
                             end
@@ -82,6 +90,18 @@ module ADIWG
                             s = hMetadataInfo['metadataCharacterSet']
                             if s != ''
                                 intMetadataInfo[:metadataCharacterSet] = s
+                            else
+                                intMetadataInfo[:metadataCharacterSet] = 'utf8'
+                            end
+                        end
+
+                        # metadata - locale
+                        if hMetadataInfo.has_key?('metadataLocale')
+                            aLocale = hMetadataInfo['metadataLocale']
+                            unless aLocale.empty?
+                                aLocale.each do |hLocale|
+                                    intMetadataInfo[:metadataLocales] << Locale.unpack(hLocale, responseObj)
+                                end
                             end
                         end
 
@@ -105,7 +125,7 @@ module ADIWG
                         if hMetadataInfo.has_key?('metadataMaintenance')
                             hMetaMaint = hMetadataInfo['metadataMaintenance']
                             unless hMetaMaint.empty?
-                                intMetadataInfo[:maintInfo] = $ReaderNS::ResourceMaintenance.unpack(hMetaMaint)
+                                intMetadataInfo[:maintInfo] = ResourceMaintenance.unpack(hMetaMaint, responseObj)
                             end
                         end
 
@@ -115,7 +135,7 @@ module ADIWG
                             if resourceInfo.has_key?('taxonomy')
                                 hTaxonomy = resourceInfo['taxonomy']
                                 unless hTaxonomy.empty?
-                                    intMetadataInfo[:extensions] << $ReaderNS::MetadataExtension.addExtensionISObio
+                                    intMetadataInfo[:extensions] << MetadataExtension.addExtensionISObio(responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_onlineResource.rb

@@ -8,6 +8,8 @@
 #   Stan Smith 2014-08-21 changed url to uri for json 0.6.0
 #   Stan Smith 2014-12-10 changed to return nil intOlRes if input empty
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -16,7 +18,7 @@ module ADIWG
 
                 module OnlineResource
 
-                    def self.unpack(hOlResource)
+                    def self.unpack(hOlResource, responseObj)
 
                         # return nil object if input is empty
                         intOLRes = nil
@@ -32,6 +34,10 @@ module ADIWG
                             s = hOlResource['uri']
                             if s != ''
                                 intOLRes[:olResURI] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Online Resource URI is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_phone.rb

@@ -6,6 +6,8 @@
 #   Stan Smith 2014-05-14 combine phone service types
 #   Stan Smith 2014-12-09 return empty phone object if no phone number
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -14,7 +16,7 @@ module ADIWG
 
                 module Phone
 
-                    def self.unpack(hPhone)
+                    def self.unpack(hPhone, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_point.rb

@@ -7,8 +7,9 @@
 #   Stan Smith 2014-04-30 reorganized for json schema 0.3.0
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-
-require $ReaderNS.readerModule('module_coordinates')
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-07-16 moved module_coordinates from mdJson reader to internal
 
 module ADIWG
     module Mdtranslator
@@ -17,13 +18,13 @@ module ADIWG
 
                 module Point
 
-                    def self.unpack(aCoords, geoType)
+                    def self.unpack(aCoords, geoType, responseObj)
                         intMetadataClass = InternalMetadata.new
                         intPoint = intMetadataClass.newGeometry
 
                         intPoint[:geoType] = geoType
                         intPoint[:geometry] = aCoords
-                        intPoint[:dimension] = $ReaderNS::Coordinates.getDimension(aCoords)
+                        intPoint[:dimension] = AdiwgCoordinates.getDimension(aCoords)
 
                         return intPoint
                     end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_polygon.rb

@@ -8,8 +8,9 @@
 #   Stan Smith 2014-05-23 modified to handle MultiPolygon objects
 #   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-
-require $ReaderNS.readerModule('module_coordinates')
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-07-16 moved module_coordinates from mdJson reader to internal
 
 module ADIWG
     module Mdtranslator
@@ -18,7 +19,7 @@ module ADIWG
 
                 module Polygon
 
-                    def self.unpack(aCoords, geoType)
+                    def self.unpack(aCoords, geoType, responseObj)
                         intMetadataClass = InternalMetadata.new
                         intGeometry = intMetadataClass.newGeometry
                         intGeometry[:geoType] = geoType
@@ -26,7 +27,7 @@ module ADIWG
                         # polygon - coordinate(s)
                         if geoType == 'Polygon'
                             intGeometry[:geometry] = splitPolygons(aCoords)
-                            intGeometry[:dimension] = $ReaderNS::Coordinates.getDimension(intGeometry[:geometry][:exteriorRing])
+                            intGeometry[:dimension] = AdiwgCoordinates.getDimension(intGeometry[:geometry][:exteriorRing])
                         elsif geoType == 'MultiPolygon'
                             aPolySets = Array.new
                             aCoords.each do |aPolygonSet|

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_processStep.rb

@@ -5,9 +5,10 @@
 # 	Stan Smith 2013-11-26 original script
 #   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
 
-require $ReaderNS.readerModule('module_responsibleParty')
-require $ReaderNS.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
 
 module ADIWG
     module Mdtranslator
@@ -16,7 +17,11 @@ module ADIWG
 
                 module ProcessStep
 
-                    def self.unpack(hProcStep)
+                    def self.unpack(hProcStep, responseObj)
+
+                        # return nil object if input is empty
+                        intDataPStep = nil
+                        return if hProcStep.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -30,12 +35,20 @@ module ADIWG
                             end
                         end
 
-                        # process step - description
+                        # process step - description - required
                         if hProcStep.has_key?('description')
                             s = hProcStep['description']
                             if s != ''
                                 intDataPStep[:stepDescription] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Process step description is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Process step description is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
                         end
 
                         # process step - rationale
@@ -50,7 +63,7 @@ module ADIWG
                         if hProcStep.has_key?('dateTime')
                             s = hProcStep['dateTime']
                             if s != ''
-                                intDataPStep[:stepDateTime] = $ReaderNS::DateTime.unpack(s)
+                                intDataPStep[:stepDateTime] = DateTime.unpack(s, responseObj)
                             end
                         end
 
@@ -59,7 +72,7 @@ module ADIWG
                             aProcessors = hProcStep['processor']
                             unless aProcessors.empty?
                                 aProcessors.each do |processor|
-                                    intDataPStep[:stepProcessors] << $ReaderNS::ResponsibleParty.unpack(processor)
+                                    intDataPStep[:stepProcessors] << ResponsibleParty.unpack(processor, responseObj)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_resolution.rb

@@ -4,6 +4,8 @@
 # History:
 # 	Stan Smith 2013-11-26 original script
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -12,7 +14,11 @@ module ADIWG
 
                 module Resolution
 
-                    def self.unpack(hResolution)
+                    def self.unpack(hResolution, responseObj)
+
+                        # return nil object if input is empty
+                        intResolution = nil
+                        return if hResolution.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_resourceFormat.rb

@@ -5,6 +5,9 @@
 # 	Stan Smith 2013-08-26 original script
 # 	Stan Smith 2013-11-27 modified to process single resource format rather than array
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-09-21 added compression method element
 
 module ADIWG
     module Mdtranslator
@@ -13,7 +16,7 @@ module ADIWG
 
                 module ResourceFormat
 
-                    def self.unpack(hResFormat)
+                    def self.unpack(hResFormat, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -35,6 +38,14 @@ module ADIWG
                             end
                         end
 
+                        # format - compression method
+                        if hResFormat.has_key?('compressionMethod')
+                            s = hResFormat['compressionMethod']
+                            if s != ''
+                                rFormat[:compressionMethod] = s
+                            end
+                        end
+
                         return rFormat
                     end
 

data/lib/adiwg/mdtranslator/readers/mdJson/{modules_1.0 → modules_v1}/module_resourceIdentifier.rb

@@ -6,10 +6,11 @@
 #   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-08-18 added type to identifier schema 0.6.0
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#   Stan Smith 2015-07-31 added support for fields added by ISO 19115-1 (RS_Identifier)
 
-require $ReaderNS.readerModule('module_citation')
-require $ReaderNS.readerModule('module_responsibleParty')
-require $ReaderNS.readerModule('module_onlineResource')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
 
 module ADIWG
     module Mdtranslator
@@ -18,7 +19,7 @@ module ADIWG
 
                 module ResourceIdentifier
 
-                    def self.unpack(hResID)
+                    def self.unpack(hResID, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
@@ -40,11 +41,35 @@ module ADIWG
                             end
                         end
 
+                        # resource identifier - namespace
+                        if hResID.has_key?('namespace')
+                            s = hResID['namespace']
+                            if s != ''
+                                intResID[:identifierNamespace] = s
+                            end
+                        end
+
+                        # resource identifier - version
+                        if hResID.has_key?('version')
+                            s = hResID['version']
+                            if s != ''
+                                intResID[:identifierVersion] = s
+                            end
+                        end
+
+                        # resource identifier - description
+                        if hResID.has_key?('description')
+                            s = hResID['description']
+                            if s != ''
+                                intResID[:identifierDescription] = s
+                            end
+                        end
+
                         # resource identifier - authority (expressed as a citation)
                         if hResID.has_key?('authority')
                             hCitation = hResID['authority']
                             unless hCitation.empty?
-                                intResID[:identifierCitation] = $ReaderNS::Citation.unpack(hCitation)
+                                intResID[:identifierCitation] = Citation.unpack(hCitation, responseObj)
                             end
                         end