module_transferOption.rb in adiwg-mdtranslator-2.10.0

- old
+ new
@@ -1,95 +1,106 @@
 # unpack transfer option
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-21 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  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 Mdtranslator
+      module Readers
+         module MdJson
 
-                module TransferOption
+            module TransferOption
 
-                    def self.unpack(hTransOp, responseObj)
+               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
+                  # return nil object if input is empty
+                  if hTransOp.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distributor transfer option object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intTransOpt = intMetadataClass.newTransferOption
+                  # 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 - units of distribution
+                  if hTransOp.has_key?('unitsOfDistribution')
+                     unless 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 - transfer size
+                  if hTransOp.has_key?('transferSize')
+                     unless 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
+                  haveOption = false
+                  # 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
+                           haveOption = true
                         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
+                  # 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
+                           haveOption = true
                         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
+                  # 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
+                  # 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
+                  # error messages
+                  unless haveOption
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: transfer option must have an online or offline option'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                end
+                  return intTransOpt
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end