adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2017-10-23 original script
 
 module ADIWG
@@ -15,8 +16,8 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hLinePt.empty?
-                     responseObj[:readerExecutionMessages] << 'Oblique Line Point object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: spatial reference oblique line-point object is empty'
                      return nil
                   end
 
@@ -29,7 +30,8 @@ module ADIWG
                      intLinePoint[:azimuthLineLatitude] = hLinePt['azimuthLineLatitude']
                   end
                   if intLinePoint[:azimuthLineLatitude].nil? || intLinePoint[:azimuthLineLatitude] == ''
-                     responseObj[:readerExecutionMessages] << 'Azimuth line point latitude is missing'
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: spatial reference oblique line-point latitude is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -39,7 +41,8 @@ module ADIWG
                      intLinePoint[:azimuthLineLongitude] = hLinePt['azimuthLineLongitude']
                   end
                   if intLinePoint[:azimuthLineLongitude].nil? || intLinePoint[:azimuthLineLongitude] == ''
-                     responseObj[:readerExecutionMessages] << 'Azimuth line point latitude is missing'
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: spatial reference oblique line-point longitude is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,81 +2,80 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-03 original script
-#   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-12-10 changed to return nil intOlRes if input empty
-#   Stan Smith 2014-08-21 changed url to uri for json 0.6.0
-#   Stan Smith 2014-08-18 removed doi section for json 0.6.0
-#   Stan Smith 2014-04-23 modified for json 0.3.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-12-10 changed to return nil intOlRes if input empty
+#  Stan Smith 2014-08-21 changed url to uri for json 0.6.0
+#  Stan Smith 2014-08-18 removed doi section for json 0.6.0
+#  Stan Smith 2014-04-23 modified for json 0.3.0
 # 	Stan Smith 2013-09-25 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module OnlineResource
+            module OnlineResource
 
-                    def self.unpack(hOnlineRes, responseObj)
+               def self.unpack(hOnlineRes, responseObj)
 
-                        # return nil object if input is empty
-                        if hOnlineRes.empty?
-                            responseObj[:readerExecutionMessages] << 'OnlineResource object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hOnlineRes.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: online resource object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intOLRes = intMetadataClass.newOnlineResource
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intOLRes = intMetadataClass.newOnlineResource
 
-                        # resource - web link (required)
-                        # return nil if no web link is provided
-                        if hOnlineRes.has_key?('uri')
-                            intOLRes[:olResURI] = hOnlineRes['uri']
-                        end
-                        if intOLRes[:olResURI].nil? || intOLRes[:olResURI] == ''
-                            responseObj[:readerExecutionMessages] << 'Online Resource URI is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # resource - web link (required)
+                  if hOnlineRes.has_key?('uri')
+                     intOLRes[:olResURI] = hOnlineRes['uri']
+                  end
+                  if intOLRes[:olResURI].nil? || intOLRes[:olResURI] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: online resource URI is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # resource - web link protocol
-                        if hOnlineRes.has_key?('protocol')
-                            if hOnlineRes['protocol'] != ''
-                                intOLRes[:olResProtocol] = hOnlineRes['protocol']
-                            end
-                        end
+                  # resource - web link protocol
+                  if hOnlineRes.has_key?('protocol')
+                     unless hOnlineRes['protocol'] == ''
+                        intOLRes[:olResProtocol] = hOnlineRes['protocol']
+                     end
+                  end
 
-                        # resource - web link name
-                        if hOnlineRes.has_key?('name')
-                            if hOnlineRes['name'] != ''
-                                intOLRes[:olResName] = hOnlineRes['name']
-                            end
-                        end
+                  # resource - web link name
+                  if hOnlineRes.has_key?('name')
+                     unless hOnlineRes['name'] == ''
+                        intOLRes[:olResName] = hOnlineRes['name']
+                     end
+                  end
 
-                        # resource - web link description
-                        if hOnlineRes.has_key?('description')
-                            if hOnlineRes['description'] != ''
-                                intOLRes[:olResDesc] = hOnlineRes['description']
-                            end
-                        end
+                  # resource - web link description
+                  if hOnlineRes.has_key?('description')
+                     unless hOnlineRes['description'] == ''
+                        intOLRes[:olResDesc] = hOnlineRes['description']
+                     end
+                  end
 
-                        # resource - web link function
-                        if hOnlineRes.has_key?('function')
-                            if hOnlineRes['function'] != ''
-                                intOLRes[:olResFunction] = hOnlineRes['function']
-                            end
-                        end
+                  # resource - web link function
+                  if hOnlineRes.has_key?('function')
+                     unless hOnlineRes['function'] == ''
+                        intOLRes[:olResFunction] = hOnlineRes['function']
+                     end
+                  end
 
-                        return intOLRes
-                    end
-
-                end
+                  return intOLRes
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,67 +2,67 @@
 # 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_dateTime'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module OrderProcess
+            module OrderProcess
 
-                    def self.unpack(hOrder, responseObj)
+               def self.unpack(hOrder, responseObj)
 
-                        # return nil object if input is empty
-                        if hOrder.empty?
-                            responseObj[:readerExecutionMessages] << 'Order Process object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intOrder = intMetadataClass.newOrderProcess
+                  # return nil object if input is empty
+                  if hOrder.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distribution order process object is empty'
+                     return nil
+                  end
 
-                        # order process - fees
-                        if hOrder.has_key?('fees')
-                            if hOrder['fees'] != ''
-                                intOrder[:fees] = hOrder['fees']
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intOrder = intMetadataClass.newOrderProcess
 
-                        # order process - planned availability
-                        if hOrder.has_key?('plannedAvailability')
-                            unless hOrder['plannedAvailability'].empty?
-                                hDate = DateTime.unpack(hOrder['plannedAvailability'], responseObj)
-                                unless hDate.nil?
-                                    intOrder[:plannedAvailability] = hDate
-                                end
-                            end
-                        end
+                  # order process - fees
+                  if hOrder.has_key?('fees')
+                     unless hOrder['fees'] == ''
+                        intOrder[:fees] = hOrder['fees']
+                     end
+                  end
 
-                        # order process - ordering instructions
-                        if hOrder.has_key?('orderingInstructions')
-                            if hOrder['orderingInstructions'] != ''
-                                intOrder[:orderingInstructions] = hOrder['orderingInstructions']
-                            end
+                  # order process - planned availability
+                  if hOrder.has_key?('plannedAvailability')
+                     unless hOrder['plannedAvailability'].empty?
+                        hDate = DateTime.unpack(hOrder['plannedAvailability'], responseObj)
+                        unless hDate.nil?
+                           intOrder[:plannedAvailability] = hDate
                         end
+                     end
+                  end
 
-                        # order process - turnaround
-                        if hOrder.has_key?('turnaround')
-                            if hOrder['turnaround'] != ''
-                                intOrder[:turnaround] = hOrder['turnaround']
-                            end
-                        end
+                  # order process - ordering instructions
+                  if hOrder.has_key?('orderingInstructions')
+                     unless hOrder['orderingInstructions'] == ''
+                        intOrder[:orderingInstructions] = hOrder['orderingInstructions']
+                     end
+                  end
 
-                        return intOrder
-                    end
+                  # order process - turnaround
+                  if hOrder.has_key?('turnaround')
+                     unless hOrder['turnaround'] == ''
+                        intOrder[:turnaround] = hOrder['turnaround']
+                     end
+                  end
 
-                end
+                  return intOrder
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,78 +2,78 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-09 original script
 
 require_relative 'module_mdJson'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Party
+            module Party
 
-                    def self.unpack(hParty, responseObj)
+               def self.unpack(hParty, responseObj)
 
-                        # return nil object if input is empty
-                        if hParty.empty?
-                            responseObj[:readerExecutionMessages] << 'Role Party object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hParty.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: responsibility party object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intParty = intMetadataClass.newParty
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intParty = intMetadataClass.newParty
 
-                        # party - contact ID (required)
-                        if hParty.has_key?('contactId')
-                            intParty[:contactId] = hParty['contactId']
-                        end
-                        if intParty[:contactId].nil? || intParty[:contactId] == ''
-                            responseObj[:readerExecutionMessages] << 'Role Party contact ID is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # party - contact ID (required)
+                  if hParty.has_key?('contactId')
+                     intParty[:contactId] = hParty['contactId']
+                  end
+                  if intParty[:contactId].nil? || intParty[:contactId] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: responsibility party contact ID is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # party - contact index, contact type (computed)
-                        # return nil if contact ID does not exist in contact array
-                        hContact = MdJson.findContact(hParty['contactId'])
-                        if hContact[0].nil?
-                            responseObj[:readerExecutionMessages] << "Responsible Party contact ID #{hParty['contactId']} not found"
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        else
-                            intParty[:contactIndex] = hContact[0]
-                            intParty[:contactType] = hContact[1]
-                        end
+                  # party - contact index, contact type (computed)
+                  # return nil if contact ID does not exist in contact array
+                  hContact = MdJson.findContact(hParty['contactId'])
+                  if hContact[0].nil?
+                     responseObj[:readerExecutionMessages] << "ERROR: mdJson reader: responsibility party contact ID #{hParty['contactId']} not found"
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  else
+                     intParty[:contactIndex] = hContact[0]
+                     intParty[:contactType] = hContact[1]
+                  end
 
-                        # party - organization members []
-                        # organization member contact IDs not found in 'contacts' are reported as warnings
-                        if intParty[:contactType] == 'organization'
-                            if hParty.has_key?('organizationMembers')
-                                hParty['organizationMembers'].each do |contactId|
-                                    hContact = MdJson.findContact(contactId)
-                                    if hContact[0].nil?
-                                        responseObj[:readerExecutionMessages] << "Responsible Party organization member #{contactId} not found"
-                                    else
-                                        newParty = intMetadataClass.newParty
-                                        newParty[:contactId] = contactId
-                                        newParty[:contactIndex] = hContact[0]
-                                        newParty[:contactType] = hContact[1]
-                                        intParty[:organizationMembers] << newParty
-                                    end
-                                end
-                            end
+                  # party - organization members []
+                  # organization member contact IDs not found in 'contacts' are reported as warnings
+                  if intParty[:contactType] == 'organization'
+                     if hParty.has_key?('organizationMembers')
+                        hParty['organizationMembers'].each do |contactId|
+                           hContact = MdJson.findContact(contactId)
+                           if hContact[0].nil?
+                              responseObj[:readerExecutionMessages] << "WARNING: mdJson reader: responsibility party organization member contact ID #{contactId} not found"
+                           else
+                              newParty = intMetadataClass.newParty
+                              newParty[:contactId] = contactId
+                              newParty[:contactIndex] = hContact[0]
+                              newParty[:contactType] = hContact[1]
+                              intParty[:organizationMembers] << newParty
+                           end
                         end
+                     end
+                  end
 
-                        return intParty
-
-                    end
+                  return intParty
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,67 +2,65 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-02 phone service is now an array rather than creating individual phone records per service
-#   Stan Smith 2016-10-02 refactored for mdJson 2.0.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-12-09 return empty phone object if no phone number
-#   Stan Smith 2014-05-14 combine phone service types
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-02 phone service is now an array rather than creating individual phone records per service
+#  Stan Smith 2016-10-02 refactored for mdJson 2.0.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-12-09 return empty phone object if no phone number
+#  Stan Smith 2014-05-14 combine phone service types
 # 	Stan Smith 2013-12-16 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Phone
+            module Phone
 
-                    def self.unpack(hPhone, responseObj)
+               def self.unpack(hPhone, responseObj)
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intPhone = intMetadataClass.newPhone
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intPhone = intMetadataClass.newPhone
 
-                        if hPhone.empty?
-                            responseObj[:readerExecutionMessages] << 'Phone object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  if hPhone.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: phone object is empty'
+                     return nil
+                  end
 
-                        # phone - phoneNumber (required)
-                        # return nil if no phone number is provided
-                        if hPhone.has_key?('phoneNumber')
-                            intPhone[:phoneNumber] = hPhone['phoneNumber']
-                        end
-                        if hPhone['phoneNumber'].nil? || hPhone['phoneNumber'] == ''
-                            responseObj[:readerExecutionMessages] << 'Phone object did not provide a phone number'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # phone - phoneNumber (required)
+                  # return nil if no phone number is provided
+                  if hPhone.has_key?('phoneNumber')
+                     intPhone[:phoneNumber] = hPhone['phoneNumber']
+                  end
+                  if hPhone['phoneNumber'].nil? || hPhone['phoneNumber'] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: phone number is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # phone - phoneName
-                        if hPhone.has_key?('phoneName')
-                            if hPhone['phoneName'] != ''
-                                intPhone[:phoneName] = hPhone['phoneName']
-                            end
-                        end
+                  # phone - phoneName
+                  if hPhone.has_key?('phoneName')
+                     unless hPhone['phoneName'] == ''
+                        intPhone[:phoneName] = hPhone['phoneName']
+                     end
+                  end
 
-                        # phone - service (recommended)
-                        if hPhone.has_key?('service')
-                            intPhone[:phoneServiceTypes] = hPhone['service']
-                        else
-                            intPhone[:phoneServiceTypes] = []
-                        end
-                        if intPhone[:phoneServiceTypes].empty?
-                            responseObj[:readerExecutionMessages] << 'Phone object did not provide a service'
-                        end
-
-                        return intPhone
-                    end
-                end
+                  # phone - service (recommended)
+                  if hPhone.has_key?('service')
+                     intPhone[:phoneServiceTypes] = hPhone['service']
+                  end
+                  if intPhone[:phoneServiceTypes].empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: phone service type is missing'
+                  end
 
+                  return intPhone
+               end
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 #  Stan Smith 2017-08-30 added support for process step sources
 #  Stan Smith 2016-10-15 refactored for mdJson 2.0
 #  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
@@ -25,8 +26,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hProcStep.empty?
-                     responseObj[:readerExecutionMessages] << 'Process Step object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: process step object is empty'
                      return nil
                   end
 
@@ -36,24 +36,24 @@ module ADIWG
 
                   # process step - step ID
                   if hProcStep.has_key?('stepId')
-                     if hProcStep['stepId'] != ''
+                     unless hProcStep['stepId'] == ''
                         intProcStep[:stepId] = hProcStep['stepId']
                      end
                   end
 
-                  # process step - description - required
+                  # process step - description - (required)
                   if hProcStep.has_key?('description')
                      intProcStep[:description] = hProcStep['description']
                   end
                   if intProcStep[:description].nil? || intProcStep[:description] == ''
-                     responseObj[:readerExecutionMessages] << 'Process Step attribute description is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: process step description is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # process step - rationale
                   if hProcStep.has_key?('rationale')
-                     if hProcStep['rationale'] != ''
+                     unless hProcStep['rationale'] == ''
                         intProcStep[:rationale] = hProcStep['rationale']
                      end
                   end