adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,100 +2,100 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-03 refactored for mdJson 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 (responseObj)
-#   Stan Smith 2014-12-30 refactored
-#   ... electronicMailAddresses into internal object
-#   Stan Smith 2014-12-19 prevented passing blank deliveryPoints and
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2013-10-21 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-03 refactored for mdJson 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 (responseObj)
+#  Stan Smith 2014-12-30 refactored
+#  ... electronicMailAddresses into internal object
+#  Stan Smith 2014-12-19 prevented passing blank deliveryPoints and
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2013-10-21 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Address
+            module Address
 
-                    def self.unpack(hAddress, responseObj)
+               def self.unpack(hAddress, responseObj)
 
-                        # return nil object if input is empty
-                        if hAddress.empty?
-                            responseObj[:readerExecutionMessages] << 'Address object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAdd = intMetadataClass.newAddress
-
-                        # address - address type [adiwg_addressType] (required)
-                        if hAddress.has_key?('addressType')
-                            hAddress['addressType'].each do |item|
-                                if item != ''
-                                    intAdd[:addressTypes] << item
-                                end
-                            end
-                        end
-                        if intAdd[:addressTypes].empty?
-                            responseObj[:readerExecutionMessages] << 'Address Type is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # address - description
-                        if hAddress.has_key?('description')
-                            if hAddress['description'] != ''
-                                intAdd[:description] = hAddress['description']
-                            end
-                        end
-
-                        # address - delivery point
-                        if hAddress.has_key?('deliveryPoint')
-                            hAddress['deliveryPoint'].each do |item|
-                                if item != ''
-                                    intAdd[:deliveryPoints] << item
-                                end
-                            end
-                        end
+                  # return nil object if input is empty
+                  if hAddress.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: address object is empty'
+                     return nil
+                  end
 
-                        # address - city
-                        if hAddress.has_key?('city')
-                            if hAddress['city'] != ''
-                                intAdd[:city] = hAddress['city']
-                            end
-                        end
-
-                        # address - admin area
-                        if hAddress.has_key?('administrativeArea')
-                            if hAddress['administrativeArea'] != ''
-                                intAdd[:adminArea] = hAddress['administrativeArea']
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAdd = intMetadataClass.newAddress
 
-                        # address - postal code
-                        if hAddress.has_key?('postalCode')
-                            if hAddress['postalCode'] != ''
-                                intAdd[:postalCode] = hAddress['postalCode']
-                            end
+                  # address - address type [adiwg_addressType] (required)
+                  if hAddress.has_key?('addressType')
+                     hAddress['addressType'].each do |item|
+                        unless item == ''
+                           intAdd[:addressTypes] << item
                         end
-
-                        # address - country
-                        if hAddress.has_key?('country')
-                            if hAddress['country'] != ''
-                                intAdd[:country] = hAddress['country']
-                            end
+                     end
+                  end
+                  if intAdd[:addressTypes].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: address type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # address - description
+                  if hAddress.has_key?('description')
+                     unless hAddress['description'] == ''
+                        intAdd[:description] = hAddress['description']
+                     end
+                  end
+
+                  # address - delivery point
+                  if hAddress.has_key?('deliveryPoint')
+                     hAddress['deliveryPoint'].each do |item|
+                        unless item == ''
+                           intAdd[:deliveryPoints] << item
                         end
-
-                        return intAdd
-
-                    end
-
-                end
+                     end
+                  end
+
+                  # address - city
+                  if hAddress.has_key?('city')
+                     unless hAddress['city'] == ''
+                        intAdd[:city] = hAddress['city']
+                     end
+                  end
+
+                  # address - admin area
+                  if hAddress.has_key?('administrativeArea')
+                     unless hAddress['administrativeArea'] == ''
+                        intAdd[:adminArea] = hAddress['administrativeArea']
+                     end
+                  end
+
+                  # address - postal code
+                  if hAddress.has_key?('postalCode')
+                     unless hAddress['postalCode'] == ''
+                        intAdd[:postalCode] = hAddress['postalCode']
+                     end
+                  end
+
+                  # address - country
+                  if hAddress.has_key?('country')
+                     unless hAddress['country'] == ''
+                        intAdd[:country] = hAddress['country']
+                     end
+                  end
+
+                  return intAdd
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2017-08-30 refactored for mdJson schema 2.3
 #  Stan Smith 2016-10-30 original script
 
@@ -18,8 +19,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hAlloc.empty?
-                     responseObj[:readerExecutionMessages] << 'Allocation object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: budget allocation object is empty'
                      return nil
                   end
 
@@ -29,7 +29,7 @@ module ADIWG
 
                   # allocation - id
                   if hAlloc.has_key?('sourceAllocationId')
-                     if hAlloc['sourceAllocationId'] != ''
+                     unless hAlloc['sourceAllocationId'] == ''
                         intAlloc[:id] = hAlloc['sourceAllocationId']
                      end
                   end
@@ -39,7 +39,7 @@ module ADIWG
                      intAlloc[:amount] = hAlloc['amount']
                   end
                   if intAlloc[:amount].nil? || intAlloc[:amount] == ''
-                     responseObj[:readerExecutionMessages] << 'Allocation attribute is missing amount'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: budget allocation amount is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -49,21 +49,21 @@ module ADIWG
                      intAlloc[:currency] = hAlloc['currency']
                   end
                   if intAlloc[:currency].nil? || intAlloc[:currency] == ''
-                     responseObj[:readerExecutionMessages] << 'Allocation attribute is missing currency'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: budget allocation currency is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # allocation - source ID {contactId}
                   if hAlloc.has_key?('sourceId')
-                     if hAlloc['sourceId'] != ''
+                     unless hAlloc['sourceId'] == ''
                         intAlloc[:sourceId] = hAlloc['sourceId']
                      end
                   end
 
                   # allocation - recipient ID {contactId}
                   if hAlloc.has_key?('recipientId')
-                     if hAlloc['recipientId'] != ''
+                     unless hAlloc['recipientId'] == ''
                         intAlloc[:recipientId] = hAlloc['recipientId']
                      end
                   end
@@ -88,7 +88,7 @@ module ADIWG
 
                   # allocation - comment
                   if hAlloc.has_key?('comment')
-                     if hAlloc['comment'] != ''
+                     unless hAlloc['comment'] == ''
                         intAlloc[:comment] = hAlloc['comment']
                      end
                   end

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

@@ -2,15 +2,16 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-18 refactored for mdJson 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 (responseObj)
-#   Stan Smith 2014-12-30 added return if empty input
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-11-06 added resourceType for 0.9.0
-#   Stan Smith 2014-11-06 changed resourceType to initiative type for 0.9.0
-#   Stan Smith 2014-08-18 moved resourceIdentifier to citation module schema 0.6.0
-#   Stan Smith 2014-07-08 resolve require statements using Mdtranslator.reader_module
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-18 refactored for mdJson 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 (responseObj)
+#  Stan Smith 2014-12-30 added return if empty input
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-11-06 added resourceType for 0.9.0
+#  Stan Smith 2014-11-06 changed resourceType to initiative type for 0.9.0
+#  Stan Smith 2014-08-18 moved resourceIdentifier to citation module schema 0.6.0
+#  Stan Smith 2014-07-08 resolve require statements using Mdtranslator.reader_module
 # 	Stan Smith 2014-06-02 added resource metadata citation section
 # 	Stan Smith 2014-05-28 added resource identifier section
 # 	Stan Smith 2014-05-02 original script
@@ -18,94 +19,92 @@
 require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module AssociatedResource
-
-                    def self.unpack(hAssocRes, responseObj)
-
-                        # return nil object if input is empty
-                        if hAssocRes.empty?
-                            responseObj[:readerExecutionMessages] << 'Associated Resource object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module AssociatedResource
+
+               def self.unpack(hAssocRes, responseObj)
+
+                  # return nil object if input is empty
+                  if hAssocRes.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: associated resource object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAssocRes = intMetadataClass.newAssociatedResource
+
+                  # associated resource - resource type [] (required) {resourceType}
+                  if hAssocRes.has_key?('resourceType')
+                     hAssocRes['resourceType'].each do |item|
+                        unless item.empty?
+                           hReturn = ResourceType.unpack(item, responseObj)
+                           unless hReturn.nil?
+                              intAssocRes[:resourceTypes] << hReturn
+                           end
                         end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAssocRes = intMetadataClass.newAssociatedResource
-
-                        # associated resource - resource type [] (required) {resourceType}
-                        if hAssocRes.has_key?('resourceType')
-                            hAssocRes['resourceType'].each do |item|
-                                unless item.empty?
-                                    hReturn = ResourceType.unpack(item, responseObj)
-                                    unless hReturn.nil?
-                                        intAssocRes[:resourceTypes] << hReturn
-                                    end
-                                end
-                            end
+                     end
+                  end
+                  if intAssocRes[:resourceTypes].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: associated resource resource type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # associated resource - association type (required)
+                  if hAssocRes.has_key?('associationType')
+                     intAssocRes[:associationType] = hAssocRes['associationType']
+                  end
+                  if intAssocRes[:associationType].nil? || intAssocRes[:associationType] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: associated resource association type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # associated resource - initiative type
+                  if hAssocRes.has_key?('initiativeType')
+                     if hAssocRes['initiativeType'] != ''
+                        intAssocRes[:initiativeType] = hAssocRes['initiativeType']
+                     end
+                  end
+
+                  # associated resource - resource citation (required) {CI_Citation}
+                  if hAssocRes.has_key?('resourceCitation')
+                     hObject = hAssocRes['resourceCitation']
+                     unless hObject.empty?
+                        hReturn = Citation.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intAssocRes[:resourceCitation] = hReturn
                         end
-                        if intAssocRes[:resourceTypes].empty?
-                            responseObj[:readerExecutionMessages] << 'Associated Resource is missing resourceType'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+                  if intAssocRes[:resourceCitation].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: associated resource citation is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # associated resource - metadata citation
+                  if hAssocRes.has_key?('metadataCitation')
+                     hObject = hAssocRes['metadataCitation']
+                     unless hObject.empty?
+                        hReturn = Citation.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intAssocRes[:metadataCitation] = hReturn
                         end
+                     end
+                  end
 
-                        # associated resource - association type (required)
-                        if hAssocRes.has_key?('associationType')
-                            intAssocRes[:associationType] = hAssocRes['associationType']
-                        end
-                        if intAssocRes[:associationType].nil? || intAssocRes[:associationType] == ''
-                            responseObj[:readerExecutionMessages] << 'Associated Resource attribute associationType is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  return intAssocRes
 
-                        # associated resource - initiative type
-                        if hAssocRes.has_key?('initiativeType')
-                            if hAssocRes['initiativeType'] != ''
-                                intAssocRes[:initiativeType] = hAssocRes['initiativeType']
-                            end
-                        end
-
-                         # associated resource - resource citation (required) {CI_Citation}
-                        if hAssocRes.has_key?('resourceCitation')
-                            hObject = hAssocRes['resourceCitation']
-                            unless hObject.empty?
-                                hReturn = Citation.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intAssocRes[:resourceCitation] = hReturn
-                                end
-                            end
-                        end
-                        if intAssocRes[:resourceCitation].empty?
-                            responseObj[:readerExecutionMessages] << 'Associated Resource requires a resource citation'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # associated resource - metadata citation
-                        if hAssocRes.has_key?('metadataCitation')
-                            hObject = hAssocRes['metadataCitation']
-                            unless hObject.empty?
-                                hReturn = Citation.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intAssocRes[:metadataCitation] = hReturn
-                                end
-                            end
-                        end
-
-
-                        return intAssocRes
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end