adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_digitalTransferOption.rb

@@ -0,0 +1,80 @@
+# unpack digital transfer option
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-08-24 original script
+#   Stan Smith 2015-09-18 added distribution formats, transfer size
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_onlineResource')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_medium')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceFormat')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DigitalTransOption
+
+                    def self.unpack(hDigTranOpt, responseObj)
+
+                        # return nil object if input is empty
+                        intDigitalTran = nil
+                        return if hDigTranOpt.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDigitalTran = intMetadataClass.newDigitalTransOption
+
+                        # distribution transfer options - distribution format []
+                        if hDigTranOpt.has_key?('distributorFormat')
+                            aDistFormat = hDigTranOpt['distributorFormat']
+                            unless aDistFormat.empty?
+                                aDistFormat.each do |hResFormat|
+                                    intDigitalTran[:distFormats] << ResourceFormat.unpack(hResFormat, responseObj)
+                                end
+                            end
+                        end
+
+                        # distribution transfer options - transfer size
+                        if hDigTranOpt.has_key?('transferSize')
+                            s = hDigTranOpt['transferSize']
+                            if s != ''
+                                intDigitalTran[:transferSize] = s
+                            end
+                        end
+
+                        # distribution transfer options - transfer size units
+                        if hDigTranOpt.has_key?('transferSizeUnits')
+                            s = hDigTranOpt['transferSizeUnits']
+                            if s != ''
+                                intDigitalTran[:transferSizeUnits] = s
+                            end
+                        end
+
+                        # distribution transfer options - online []
+                        if hDigTranOpt.has_key?('online')
+                            aOnlineOption = hDigTranOpt['online']
+                            aOnlineOption.each do |hOlOption|
+                                intDigitalTran[:online] << OnlineResource.unpack(hOlOption, responseObj)
+                            end
+                        end
+
+                        # distribution transfer options - offline
+                        if hDigTranOpt.has_key?('offline')
+                            hOfflOption = hDigTranOpt['offline']
+                            if !hOfflOption.empty?
+                                intDigitalTran[:offline] = Medium.unpack(hOfflOption, responseObj)
+
+                            end
+                        end
+
+                        return intDigitalTran
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_dimension.rb

@@ -0,0 +1,81 @@
+# unpack dimension
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-07-30 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Dimension
+
+                    def self.unpack(hDimInfo, responseObj)
+
+                        # return nil object if input is empty
+                        intDim = nil
+                        return if hDimInfo.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDim = intMetadataClass.newDimensionInfo
+
+                        # dimension information - type of dimension - required
+                        if hDimInfo.has_key?('dimensionType')
+                            s = hDimInfo['dimensionType']
+                            if s != ''
+                                intDim[:dimensionType] = s
+                            end
+                        end
+
+                        # dimension information - number of elements along the axis - required
+                        if hDimInfo.has_key?('dimensionSize')
+                            s = hDimInfo['dimensionSize']
+                            if s != ''
+                                intDim[:dimensionSize] = s
+                            end
+                        end
+
+                        # dimension information - degree of detail in the grid
+                        if hDimInfo.has_key?('resolution')
+                            s = hDimInfo['resolution']
+                            if s != ''
+                                intDim[:resolution] = s
+                            end
+                        end
+
+                        # dimension information - units for resolution
+                        if hDimInfo.has_key?('resolutionUnit')
+                            s = hDimInfo['resolutionUnit']
+                            if s != ''
+                                intDim[:resolutionUnits] = s
+                            end
+                        end
+
+                        # dimension information - title for the axis
+                        if hDimInfo.has_key?('dimensionTitle')
+                            s = hDimInfo['dimensionTitle']
+                            if s != ''
+                                intDim[:dimensionTitle] = s
+                            end
+                        end
+
+                        # dimension information - definition of the title
+                        if hDimInfo.has_key?('dimensionDescription')
+                            s = hDimInfo['dimensionDescription']
+                            if s != ''
+                                intDim[:dimensionDescription] = s
+                            end
+                        end
+
+                        return intDim
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_distributionInfo.rb

@@ -0,0 +1,89 @@
+# unpack distribution info
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-09-23 original script
+# 	Stan Smith 2013-11-27 changed to receive single distributor rather than array
+# 	Stan Smith 2013-12-18 changed to unpack contact using responsible party
+#   Stan Smith 2014-05-02 changed to support responsible party as hash, not array
+#   Stan Smith 2014-07-08 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
+#   Stan Smith 2015-08-24 refactored to normalize module; created new modules for
+#   ... distributionOrder, digitalTransferOption, and medium
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_distributionOrder')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceFormat')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_digitalTransferOption')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DistributionInfo
+
+                    def self.unpack(hDistributor, responseObj)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDistributor = intMetadataClass.newDistributor
+
+
+                        # distributor - distribution contact - required
+                        if hDistributor.has_key?('distributorContact')
+                            hContact = hDistributor['distributorContact']
+                            unless hContact.empty?
+                                intDistributor[:distContact] = ResponsibleParty.unpack(hContact, responseObj)
+                            else
+                                responseObj[:readerExecutionMessages] << 'Distributor contact is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Distributor contact is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # distributor - distribution order process
+                        if hDistributor.has_key?('distributionOrderProcess')
+                            aDistOrder = hDistributor['distributionOrderProcess']
+                            unless aDistOrder.empty?
+                                aDistOrder.each do |hDistOrder|
+                                    intDistributor[:distOrderProcs] << DistributionOrder.unpack(hDistOrder, responseObj)
+                                end
+                            end
+                        end
+
+                        # distributor - distribution format
+                        if hDistributor.has_key?('distributorFormat')
+                            aDistFormat = hDistributor['distributorFormat']
+                            unless aDistFormat.empty?
+                                aDistFormat.each do |hResFormat|
+                                    intDistributor[:distFormats] << ResourceFormat.unpack(hResFormat, responseObj)
+                                end
+                            end
+                        end
+
+                        # distributor - distribution transfer options
+                        if hDistributor.has_key?('distributorTransferOptions')
+                            aDistTransOpt = hDistributor['distributorTransferOptions']
+                            unless aDistTransOpt.empty?
+                                aDistTransOpt.each do |hDigTranOpt|
+                                    intDistributor[:distTransOptions] << DigitalTransOption.unpack(hDigTranOpt, responseObj)
+                                end
+                            end
+                        end
+
+                        return intDistributor
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_v1/module_distributionOrder.rb

@@ -0,0 +1,62 @@
+# unpack distribution order process
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-08-24 original script
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module DistributionOrder
+
+                    def self.unpack(hDistOrder, responseObj)
+
+                        # return nil object if input is empty
+                        intDistOrder = nil
+                        return if hDistOrder.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intDistOrder = intMetadataClass.newDistOrder
+
+                        if hDistOrder.has_key?('fees')
+                            s = hDistOrder['fees']
+                            if s != ''
+                                intDistOrder[:fees] = s
+                            end
+                        end
+
+                        if hDistOrder.has_key?('plannedAvailabilityDateTime')
+                            s = hDistOrder['plannedAvailabilityDateTime']
+                            if s != ''
+                                intDistOrder[:plannedDateTime] = DateTime.unpack(s, responseObj)
+                            end
+                        end
+
+                        if hDistOrder.has_key?('orderingInstructions')
+                            s = hDistOrder['orderingInstructions']
+                            if s != ''
+                                intDistOrder[:orderInstructions] = s
+                            end
+                        end
+
+                        if hDistOrder.has_key?('turnaround')
+                            s = hDistOrder['turnaround']
+                            if s != ''
+                                intDistOrder[:turnaround] = s
+                            end
+                        end
+
+                        return intDistOrder
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -4,8 +4,11 @@
 # History:
 # 	Stan Smith 2013-12-01 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
+#   Stan Smith 2015-07-23 added error reporting of missing items
 
-require $ReaderNS.readerModule('module_domainItem')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_domainItem')
 
 module ADIWG
     module Mdtranslator
@@ -14,7 +17,7 @@ module ADIWG
 
                 module Domain
 
-                    def self.unpack(hDomain)
+                    def self.unpack(hDomain, responseObj)
 
                         # return nil object if input is empty
                         intDomain = nil
@@ -29,6 +32,10 @@ module ADIWG
                             s = hDomain['domainId']
                             if s != ''
                                 intDomain[:domainId] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain ID is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -45,6 +52,10 @@ module ADIWG
                             s = hDomain['codeName']
                             if s != ''
                                 intDomain[:domainCode] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain code name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
@@ -53,16 +64,24 @@ module ADIWG
                             s = hDomain['description']
                             if s != ''
                                 intDomain[:domainDescription] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain description is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
                         # data dictionary domain - members
                         if hDomain.has_key?('member')
                             aDoItems = hDomain['member']
-                            aDoItems.each do |hDoItem|
-                                unless hDoItem.empty?
-                                    intDomain[:domainItems] << $ReaderNS::DomainItem.unpack(hDoItem)
+                            unless aDoItems.empty?
+                                aDoItems.each do |hDoItem|
+                                    intDomain[:domainItems] << DomainItem.unpack(hDoItem, responseObj)
                                 end
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain has no members'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 

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

@@ -4,6 +4,9 @@
 # History:
 # 	Stan Smith 2013-12-01 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
+#   Stan Smith 2015-07-23 added error reporting of missing items
 
 module ADIWG
     module Mdtranslator
@@ -12,33 +15,49 @@ module ADIWG
 
                 module DomainItem
 
-                    def self.unpack(hDoItem)
+                    def self.unpack(hDoItem, responseObj)
+
+                        # return nil object if input is empty
+                        intItem = nil
+                        return if hDoItem.empty?
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new
                         intItem = intMetadataClass.newDomainItem
 
-                        # data dictionary domain item - name
+                        # data dictionary domain item - name - required
                         if hDoItem.has_key?('name')
                             s = hDoItem['name']
                             if s != ''
                                 intItem[:itemName] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain item name is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
-                        # data dictionary domain item - value
+                        # data dictionary domain item - value - required
                         if hDoItem.has_key?('value')
                             s = hDoItem['value']
                             if s != ''
                                 intItem[:itemValue] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain item value is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end
 
-                        # data dictionary domain item - definition
+                        # data dictionary domain item - definition - required
                         if hDoItem.has_key?('definition')
                             s = hDoItem['definition']
                             if s != ''
                                 intItem[:itemDefinition] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Data Dictionary domain item definition is missing'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
                         end