adiwg-mdtranslator 1.2.1 → 1.3.0

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

@@ -8,6 +8,8 @@
 #   Stan Smith 2014-12-01 changed adiwgJson to mdJson in version name check
 #   Stan Smith 2014-12-03 changed class name to MdJsonValidation from AdiwgJsonValidation
 #   Stan Smith 2014-12-11 added namespace
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+
 
 require 'json'
 require 'json-schema'
@@ -23,31 +25,31 @@ module ADIWG
 
                 # validate json against the adiwg-json_schemas
                 # only one schema version is supported at this time
-                def self.validate(file)
-                    begin
+                def self.validate(file, responseObj)
 
+                    begin
                         schema = ADIWG::MdjsonSchemas::Utils.schema_path
                         aValErrs = Array.new
-                        if $response[:readerValidationLevel] == 'strict'
+                        if responseObj[:readerValidationLevel] == 'strict'
                             aValErrs = JSON::Validator.fully_validate(schema, file, :strict => true, :errors_as_objects => true)
-                        elsif $response[:readerValidationLevel] == 'normal'
+                        elsif responseObj[:readerValidationLevel] == 'normal'
                             aValErrs = JSON::Validator.fully_validate(schema, file, :errors_as_objects => true)
                         end
 
                         if aValErrs.length > 0
-                            $response[:readerValidationPass] = false
-                            $response[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
-                            $response[:readerValidationMessages] = aValErrs
+                            responseObj[:readerValidationPass] = false
+                            responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
+                            responseObj[:readerValidationMessages] << aValErrs
                             return
                         end
                     rescue JSON::Schema::ValidationError
-                        $response[:readerValidationPass] = false
-                        $response[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
-                        $response[:readerValidationMessages] << $!.message
+                        responseObj[:readerValidationPass] = false
+                        responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
+                        responseObj[:readerValidationMessages] << $!.message
                         return
                     end
 
-                    $response[:readerValidationPass] = true
+                    responseObj[:readerValidationPass] = true
                 end
 
             end

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

@@ -7,8 +7,10 @@
 #   Stan Smith 2014-12-30 added return if empty input
 #   ... found & fixed error of method using associatedResource object instead of
 #   ... additionalDocumentation object
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
 
 module ADIWG
     module Mdtranslator
@@ -17,7 +19,7 @@ module ADIWG
 
                 module AdditionalDocumentation
 
-                    def self.unpack(hAddDoc)
+                    def self.unpack(hAddDoc, responseObj)
 
                         # return nil object if input is empty
                         intAddDoc = nil
@@ -39,8 +41,16 @@ module ADIWG
                         if hAddDoc.has_key?('citation')
                             hCitation = hAddDoc['citation']
                             unless hCitation.empty?
-                                intAddDoc[:citation] = $ReaderNS::Citation.unpack(hCitation)
+                                intAddDoc[:citation] = Citation.unpack(hCitation, responseObj)
+                            else
+                                responseObj[:readerExecutionMessages] << 'Additional documentation citation is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Additional documentation citation is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
                         end
 
                         return intAddDoc

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

@@ -7,6 +7,8 @@
 #   Stan Smith 2014-12-19 prevented passing blank deliveryPoints and
 #   ... electronicMailAddresses into internal object
 #   Stan Smith 2014-12-30 refactored
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -15,7 +17,7 @@ module ADIWG
 
                 module Address
 
-                    def self.unpack(hConAddress)
+                    def self.unpack(hConAddress, responseObj)
 
                         # return nil object if input is empty
                         intAdd = nil

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

@@ -11,8 +11,10 @@
 #   Stan Smith 2014-11-06 added resourceType for 0.9.0
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2014-12-30 added return if empty input
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_citation')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_citation')
 
 module ADIWG
     module Mdtranslator
@@ -21,7 +23,7 @@ module ADIWG
 
                 module AssociatedResource
 
-                    def self.unpack(hAssocRes)
+                    def self.unpack(hAssocRes, responseObj)
 
                         # return nil object if input is empty
                         intAssocRes = nil
@@ -36,7 +38,15 @@ module ADIWG
                             s = hAssocRes['associationType']
                             if s != ''
                                 intAssocRes[:associationType] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Associated resource association type is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Associated resource association type is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
                         end
 
                         # associated resource - initiative type
@@ -52,14 +62,22 @@ module ADIWG
                             s = hAssocRes['resourceType']
                             if s != ''
                                 intAssocRes[:resourceType] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Associated resource resource type is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Associated resource resource type is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
                         end
 
                         # associated resource - resource citation
                         if hAssocRes.has_key?('resourceCitation')
                             hCitation = hAssocRes['resourceCitation']
                             unless hCitation.empty?
-                                intAssocRes[:resourceCitation] = $ReaderNS::Citation.unpack(hCitation)
+                                intAssocRes[:resourceCitation] = Citation.unpack(hCitation, responseObj)
                             end
                         end
 
@@ -67,7 +85,7 @@ module ADIWG
                         if hAssocRes.has_key?('metadataCitation')
                             hCitation = hAssocRes['metadataCitation']
                             unless hCitation.empty?
-                                intAssocRes[:metadataCitation] = $ReaderNS::Citation.unpack(hCitation)
+                                intAssocRes[:metadataCitation] = Citation.unpack(hCitation, responseObj)
                             end
                         end
 

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

@@ -5,6 +5,8 @@
 # 	Stan Smith 2013-11-07 original script
 #   Stan Smith 2014-04-28 reorganized for json schema 0.3.0
 #   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
 
 module ADIWG
     module Mdtranslator
@@ -13,7 +15,7 @@ module ADIWG
 
                 module BoundingBox
 
-                    def self.unpack(aBBox)
+                    def self.unpack(aBBox, responseObj)
 
                         # instance classes needed in script
                         intMetadataClass = InternalMetadata.new

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

@@ -8,6 +8,8 @@
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2014-12-24 added return if input hash is empty
 #   Stan Smith 2014-12-30 refactored
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
 module ADIWG
     module Mdtranslator
@@ -16,7 +18,7 @@ module ADIWG
 
                 module BrowseGraphic
 
-                    def self.unpack(hBgraphic)
+                    def self.unpack(hBgraphic, responseObj)
 
                         # return nil object if input is empty
                         intBGraphic = nil
@@ -31,7 +33,15 @@ module ADIWG
                             s = hBgraphic['fileName']
                             if s != ''
                                 intBGraphic[:bGName] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Graphic overview name is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
                             end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Graphic overview name is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
                         end
 
                         # graphic - file description

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

@@ -9,11 +9,14 @@
 #   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 #   Stan Smith 2014-12-19 refactored to return nil when hCitation is empty
 #   Stan Smith 2014-12-30 refactored
+#   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-28 added alternate title
 
-require $ReaderNS.readerModule('module_dateTime')
-require $ReaderNS.readerModule('module_responsibleParty')
-require $ReaderNS.readerModule('module_onlineResource')
-require $ReaderNS.readerModule('module_resourceIdentifier')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_dateTime')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_responsibleParty')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_onlineResource')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_resourceIdentifier')
 
 module ADIWG
     module Mdtranslator
@@ -22,7 +25,7 @@ module ADIWG
 
                 module Citation
 
-                    def self.unpack(hCitation)
+                    def self.unpack(hCitation, responseObj)
 
                         # return nil object if input is empty
                         intCitation = nil
@@ -37,6 +40,22 @@ module ADIWG
                             s = hCitation['title']
                             if s != ''
                                 intCitation[:citTitle] = s
+                            else
+                                responseObj[:readerExecutionMessages] << 'Citation title is empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        else
+                            responseObj[:readerExecutionMessages] << 'Citation title is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # citation - alternate title
+                        if hCitation.has_key?('alternateTitle')
+                            s = hCitation['alternateTitle']
+                            if s != ''
+                                intCitation[:citAltTitle] = s
                             end
                         end
 
@@ -48,7 +67,7 @@ module ADIWG
                                     if hCitDate.has_key?('date')
                                         s = hCitDate['date']
                                         if s != ''
-                                            intDateTime = $ReaderNS::DateTime.unpack(s)
+                                            intDateTime = DateTime.unpack(s, responseObj)
                                             if hCitDate.has_key?('dateType')
                                                 s = hCitDate['dateType']
                                                 if s != ''
@@ -75,7 +94,7 @@ module ADIWG
                             aRParty = hCitation['responsibleParty']
                             unless aRParty.empty?
                                 aRParty.each do |hRParty|
-                                    intCitation[:citResponsibleParty] << $ReaderNS::ResponsibleParty.unpack(hRParty)
+                                    intCitation[:citResponsibleParty] << ResponsibleParty.unpack(hRParty, responseObj)
                                 end
                             end
                         end
@@ -95,7 +114,7 @@ module ADIWG
                             aResIds = hCitation['identifier']
                             aResIds.each do |hIdentifier|
                                 unless hIdentifier.empty?
-                                    intCitation[:citResourceIds] << $ReaderNS::ResourceIdentifier.unpack(hIdentifier)
+                                    intCitation[:citResourceIds] << ResourceIdentifier.unpack(hIdentifier, responseObj)
                                 end
                             end
                         end
@@ -105,7 +124,7 @@ module ADIWG
                             aOlRes = hCitation['onlineResource']
                             aOlRes.each do |hOlRes|
                                 unless hOlRes.empty?
-                                    intCitation[:citOlResources] << $ReaderNS::OnlineResource.unpack(hOlRes)
+                                    intCitation[:citOlResources] << OnlineResource.unpack(hOlRes, responseObj)
                                 end
                             end
                         end

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

@@ -0,0 +1,49 @@
+# unpack classed data
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-08-20 original script
+
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_classedDataItem')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ClassedData
+
+                    def self.unpack(hClassData, responseObj)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        hClass = intMetadataClass.newClassedData
+
+                        # classed data - number of classed items
+                        if hClassData.has_key?('numberOfClasses')
+                            s = hClassData['numberOfClasses']
+                            if s != ''
+                                hClass[:numberOfClasses] = s
+                            end
+                        end
+
+                        # classed data - classed data items
+                        if hClassData.has_key?('classifiedDataItem')
+                            aClassItems = hClassData['classifiedDataItem']
+                            aClassItems.each do |hClassItem|
+                                if !hClassItem.empty?
+                                    hClass[:classedDataItems] << ClassedDataItem.unpack(hClassItem, responseObj)
+                                end
+                            end
+                        end
+
+                        return hClass
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,53 @@
+# unpack classed data item
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2015-08-20 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ClassedDataItem
+
+                    def self.unpack(hClassData, responseObj)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        hClassItem = intMetadataClass.newClassedDataItem
+
+                        # classed data item - name
+                        if hClassData.has_key?('className')
+                            s = hClassData['className']
+                            if s != ''
+                                hClassItem[:className] = s
+                            end
+                        end
+
+                        # classed data item - description
+                        if hClassData.has_key?('classDescription')
+                            s = hClassData['classDescription']
+                            if s != ''
+                                hClassItem[:classDescription] = s
+                            end
+                        end
+
+                        # classed data item - value
+                        if hClassData.has_key?('classValue')
+                            s = hClassData['classValue']
+                            if s != ''
+                                hClassItem[:classValue] = s
+                            end
+                        end
+
+                        return hClassItem
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -14,10 +14,12 @@
 #   Stan Smith 2014-12-19 added testing and messages for '' and missing contactId
 #   Stan Smith 2014-12-19 added testing to not place nil address into internal object
 #   Stan Smith 2014-12-30 refactored
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to remove global namespace constants
 
-require $ReaderNS.readerModule('module_address')
-require $ReaderNS.readerModule('module_onlineResource')
-require $ReaderNS.readerModule('module_phone')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_address')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_onlineResource')
+require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_phone')
 
 module ADIWG
     module Mdtranslator
@@ -26,10 +28,10 @@ module ADIWG
 
                 module Contact
 
-                    def self.unpack(hContact)
+                    def self.unpack(hContact, responseObj)
 
                         # return nil object if input is empty
-                        intAddDoc = nil
+                        intCont = nil
                         return if hContact.empty?
 
                         # instance classes needed in script
@@ -45,13 +47,13 @@ module ADIWG
                             if s != ''
                                 intCont[:contactId] = s
                             else
-                                $response[:readerExecutionPass] =  false
-                                $response[:readerExecutionMessages] << 'contact: {contactId: } is blank.'
+                                responseObj[:readerExecutionPass] =  false
+                                responseObj[:readerExecutionMessages] << 'contact: {contactId: } is blank.'
                                 return nil
                             end
                         else
-                            $response[:readerExecutionPass] =  false
-                            $response[:readerExecutionMessages] << 'contact: {contactId: } is missing.'
+                            responseObj[:readerExecutionPass] =  false
+                            responseObj[:readerExecutionMessages] << 'contact: {contactId: } is missing.'
                             return nil
                         end
 
@@ -84,7 +86,7 @@ module ADIWG
                             aOlRes = hContact['onlineResource']
                             aOlRes.each do |hOlRes|
                                 unless hOlRes.empty?
-                                    intCont[:onlineRes] << $ReaderNS::OnlineResource.unpack(hOlRes)
+                                    intCont[:onlineRes] << OnlineResource.unpack(hOlRes, responseObj)
                                 end
                             end
                         end
@@ -101,14 +103,14 @@ module ADIWG
                         if hContact.has_key?('phoneBook')
                             aPhones = hContact['phoneBook']
                             aPhones.each do |hPhone|
-                                intCont[:phones].concat($ReaderNS::Phone.unpack(hPhone))
+                                intCont[:phones].concat(Phone.unpack(hPhone, responseObj))
                             end
                         end
 
                         # address
                         if hContact.has_key?('address')
                             conAddress = hContact['address']
-                            hAddress = $ReaderNS::Address.unpack(conAddress)
+                            hAddress = $ReaderNS::Address.unpack(conAddress, responseObj)
                             unless hAddress.nil?
                                 intCont[:address] = hAddress
                             end