adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,95 @@
+# unpack transfer option
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-21 original script
+
+require_relative 'module_medium'
+require_relative 'module_format'
+require_relative 'module_onlineResource'
+require_relative 'module_duration'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module TransferOption
+
+                    def self.unpack(hTransOp, responseObj)
+
+                        # return nil object if input is empty
+                        if hTransOp.empty?
+                            responseObj[:readerExecutionMessages] << 'Transfer Option object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intTransOpt = intMetadataClass.newTransferOption
+
+                        # transfer option - units of distribution
+                        if hTransOp.has_key?('unitsOfDistribution')
+                            if hTransOp['unitsOfDistribution'] != ''
+                                intTransOpt[:unitsOfDistribution] = hTransOp['unitsOfDistribution']
+                            end
+                        end
+
+                        # transfer option - transfer size
+                        if hTransOp.has_key?('transferSize')
+                            if hTransOp['transferSize'] != ''
+                                intTransOpt[:transferSize] = hTransOp['transferSize']
+                            end
+                        end
+
+                        # transfer option - online option [onlineResource]
+                        if hTransOp.has_key?('onlineOption')
+                            hTransOp['onlineOption'].each do |item|
+                                hReturn = OnlineResource.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intTransOpt[:onlineOptions] << hReturn
+                                end
+                            end
+                        end
+
+                        # transfer option - offline option [medium]
+                        if hTransOp.has_key?('offlineOption')
+                            hTransOp['offlineOption'].each do |item|
+                                hReturn = Medium.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intTransOpt[:offlineOptions] << hReturn
+                                end
+                            end
+                        end
+
+                        # transfer option - transferFrequency {duration}
+                        if hTransOp.has_key?('transferFrequency')
+                            hObject = hTransOp['transferFrequency']
+                            unless hObject.empty?
+                                hReturn = Duration.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intTransOpt[:transferFrequency] = hReturn
+                                end
+                            end
+                        end
+
+                        # transfer option - distribution format [format]
+                        if hTransOp.has_key?('distributionFormat')
+                            hTransOp['distributionFormat'].each do |item|
+                                hReturn = Format.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intTransOpt[:distributionFormats] << hReturn
+                                end
+                            end
+                        end
+
+                        return intTransOpt
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,55 @@
+# unpack vector object
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-19 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module VectorObject
+
+                    def self.unpack(hVecObj, responseObj)
+
+                        # return nil object if input is empty
+                        if hVecObj.empty?
+                            responseObj[:readerExecutionMessages] << 'Vector Object object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intVecObj = intMetadataClass.newVectorObject
+
+                        # vector object - object type (required)
+                        if hVecObj.has_key?('objectType')
+                            if hVecObj['objectType'] != ''
+                                intVecObj[:objectType] = hVecObj['objectType']
+                            end
+                        end
+                        if intVecObj[:objectType].nil?
+                            responseObj[:readerExecutionMessages] << 'Vector Object attribute objectType is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # vector object - object count
+                        if hVecObj.has_key?('objectCount')
+                            if hVecObj['objectCount'] != ''
+                                intVecObj[:objectCount] = hVecObj['objectCount']
+                            end
+                        end
+
+                        return intVecObj
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,55 @@
+# unpack vector representation
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-19 original script
+
+require_relative 'module_vectorObject'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module VectorRepresentation
+
+                    def self.unpack(hVector, responseObj)
+
+                        # return nil object if input is empty
+                        if hVector.empty?
+                            responseObj[:readerExecutionMessages] << 'Vector Representation object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intVector = intMetadataClass.newVectorInfo
+
+                        # vector representation - topology level
+                        if hVector.has_key?('topologyLevel')
+                            if hVector['topologyLevel'] != ''
+                                intVector[:topologyLevel] = hVector['topologyLevel']
+                            end
+                        end
+
+                        # vector representation - vector object []
+                        if hVector.has_key?('vectorObject')
+                            hVector['vectorObject'].each do |item|
+                                hVec = VectorObject.unpack(item, responseObj)
+                                unless hVec.nil?
+                                    intVector[:vectorObject] << hVec
+                                end
+                            end
+                        end
+
+                        return intVector
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,81 @@
+# unpack vertical extent
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-24 original script
+
+require_relative 'module_spatialReference'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module VerticalExtent
+
+                    def self.unpack(hVertical, responseObj)
+
+                        # return nil object if input is empty
+                        if hVertical.empty?
+                            responseObj[:readerExecutionMessages] << 'Vertical Extent object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intVertical = intMetadataClass.newVerticalExtent
+
+                        # vertical extent - description
+                        if hVertical.has_key?('description')
+                            if hVertical['description'] != ''
+                                intVertical[:description] = hVertical['description']
+                            end
+                        end
+
+                        # vertical extent - min value (required)
+                        if hVertical.has_key?('minValue')
+                            intVertical[:minValue] = hVertical['minValue']
+                        end
+                        if intVertical[:minValue].nil? || intVertical[:minValue] == ''
+                            responseObj[:readerExecutionMessages] << 'Vertical Extent is missing minValue'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # vertical extent - max value (required)
+                        if hVertical.has_key?('maxValue')
+                            intVertical[:maxValue] = hVertical['maxValue']
+                        end
+                        if intVertical[:maxValue].nil? || intVertical[:maxValue] == ''
+                            responseObj[:readerExecutionMessages] << 'Vertical Extent is missing maxValue'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # vertical extent - crs ID {spatialReference} (required)
+                        if hVertical.has_key?('crsId')
+                            hObject = hVertical['crsId']
+                            unless hObject.empty?
+                                hReturn = SpatialReferenceSystem.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intVertical[:crsId] = hReturn
+                                end
+                            end
+                        end
+                        if intVertical[:crsId].empty?
+                            responseObj[:readerExecutionMessages] << 'Vertical Extent is missing crsId'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intVertical
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,64 @@
+# unpack voucher
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-21 original script
+
+require_relative 'module_responsibleParty'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Voucher
+
+                    def self.unpack(hVoucher, responseObj)
+
+                        # return nil object if input is empty
+                        if hVoucher.empty?
+                            responseObj[:readerExecutionMessages] << 'Voucher object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intVoucher = intMetadataClass.newTaxonVoucher
+
+                        # voucher - specimen
+                        if hVoucher.has_key?('specimen')
+                            intVoucher[:specimen] = hVoucher['specimen']
+                        end
+                        if intVoucher[:specimen].nil? || intVoucher[:specimen] == ''
+                            responseObj[:readerExecutionMessages] << 'Voucher object is missing specimen'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # voucher - repository
+                        if hVoucher.has_key?('repository')
+                            hObject = hVoucher['repository']
+                            unless hObject.empty?
+                                hReturn = ResponsibleParty.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intVoucher[:repository] = hReturn
+                                end
+                            end
+                        end
+                        if intVoucher[:repository].empty?
+                            responseObj[:readerExecutionMessages] << 'Voucher object is missing repository'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intVoucher
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/readme.md

@@ -3,17 +3,11 @@
 
 ### Supported versions
 
-> 1.0.x
+> 2.0.x
 
 ### Reader for ADIwg JSON metadata format (mdJson)
 
-The mdJson format is a simple JSON format for documenting and exchanging information
-about scientific projects and data.  The Alaska Data Integration working group (ADIwg) wrote the
-standard to support translation to complex standards such as the ISO 19115-2 Geographic Metadata standard
-and FGDC's Content Standard for Digital Geospatial Metadata.  The mdJson standard
-remains independent of any published standards while comprehensive enough to support translation
-to many. The mdJson standard is also a convenient format to exchange directly with other organizations as
-the JSON structure is easier create and ingest by programming languages.
+The mdJson format is a simple JSON format for documenting and exchanging information about scientific projects and data.  The Alaska Data Integration working group (ADIwg) wrote the standard to support translation to complex standards such as the ISO 19115-2 Geographic Metadata standard and FGDC's Content Standard for Digital Geospatial Metadata.  The mdJson standard remains independent of any published standards while comprehensive enough to support translation to established standards. The mdJson record is also a convenient format to exchange directly with other organizations as the JSON structure is easily created and ingest by programming languages.
 
 The mdJson format is fully documented on the interactive
-[mdTools](http://www.adiwg.org/mdTools) website.
+[mdTools](http://mdTools.adiwg.org) website.

data/lib/adiwg/mdtranslator/readers/mdJson/version.rb

@@ -0,0 +1,14 @@
+# adiwg mdTranslator / readers / mdJson
+
+# version 2 history
+# 2016-10-01 start of version 2
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+                VERSION = "2.0.0"
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdReaders.rb

@@ -1,61 +1,67 @@
 # MdTranslator - controller for evaluating and directing readers
 
 # History:
-# 	Stan Smith 2014-12-11 original script
-#   Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
-#   Stan Smith 2015-03-04 changed method of setting $WriterNS
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2016-11-12 refactored for mdTranslator 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 (hResponseObj)
+#   Stan Smith 2015-03-04 changed method of setting $WriterNS
+#   Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
+# 	Stan Smith 2014-12-11 original script
 
 module ADIWG
     module Mdtranslator
         module Readers
 
-            def self.handleReader(file, responseObj)
+            def self.handleReader(file, hResponseObj)
 
-                # use readerRequested from responseObj to build directory path to reader
-                # the readers's high level folder must be under the 'writers' directory
-                readerDir = File.join(path_to_readers, responseObj[:readerRequested])
+                # use ':readerRequested' from hResponseObj to build directory path to reader
+                # reader's high level folder must be placed in 'lib/adiwg/mdtranslator/readers/'
+                # reader's code must must be in folder named '{reader}'
+                # '{reader}' must contain a module named '{reader}_reader.rb'
+                # '{reader}_reader.rb' must have a method named 'readFile()'
+                # 'readFile()' must pass two parameters (file, hResponseObj)
+                # all reader modules and classes must remain in their private namespace
+                # reader namespace is 'ADIWG::Mdtranslator::Readers::{reader}'
+
+                # reader high-level folder
+                thisDir = File.dirname(File.expand_path(__FILE__))
+                readerDir = File.join(thisDir, hResponseObj[:readerRequested])
                 if File.directory?(readerDir)
 
-                    # if directory path exists, build reader file name and require it
-                    readerFile = File.join(readerDir, responseObj[:readerRequested] + '_reader')
-                    require readerFile
+                    # reader folder
+                    readerModule = File.join(readerDir, hResponseObj[:readerRequested] + '_reader')
+                    require readerModule
 
-                    # build the namespace for the reader
-                    readerNS = responseObj[:readerRequested].dup
+                    # reader namespace
+                    readerNS = hResponseObj[:readerRequested].dup
                     readerNS[0] = readerNS[0].upcase
 
-                    # pass file and response object to requested reader
-                    # the reader will return the internal object with the metadata content loaded
-                    return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, responseObj)
+                    # reader will return intObj and updated hResponseObj
+                    return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, hResponseObj)
 
                 else
-                    # the directory path was not found meaning there is no reader with that name
-                    # set the appropriate messages and report the failure
-                    responseObj[:readerValidationPass] = false
-                    responseObj[:readerValidationMessages] << "Validation Failed - see following message(s):\n"
-                    responseObj[:readerValidationMessages] << "Reader '#{responseObj[:readerRequested]}' is not supported."
-                    return false
+                    hResponseObj[:readerValidationMessages] << "Requested reader '#{hResponseObj[:readerRequested]}' cannot be found."
+                    hResponseObj[:readerValidationPass] = false
+                    return {}
                 end
 
             end
 
-            # return path to readers
-            def self.path_to_readers
-                File.dirname(File.expand_path(__FILE__))
-            end
-
             # return reader readme text
+            # this is called from the Rails API
             def self.get_reader_readme(reader)
-                readmeText = 'No readme found'
-                path = File.join(path_to_readers, reader, 'readme.md')
+
+                thisDir = File.dirname(File.expand_path(__FILE__))
+                path = File.join(thisDir, reader, 'readme.md')
                 if File.exist?(path)
                     file = File.open(path, 'r')
                     readmeText = file.read
                     file.close
+                    return readmeText
+                else
+                    return 'Readme file not found'
                 end
-                return readmeText
+
             end
 
         end