adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,164 @@
+# unpack citation
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-13 refactored for mdJson 2.0
+#   Stan Smith 2015-08-28 added alternate title
+#   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
+#   Stan Smith 2014-12-19 refactored to return nil when hCitation is empty
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-08-18 changed additionalIdentifier section to identifier schema 0.6.0
+#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-04-25 modified to support json schema 0.3.0
+# 	Stan Smith 2013-08-26 original script
+
+require_relative 'module_date'
+require_relative 'module_responsibleParty'
+require_relative 'module_onlineResource'
+require_relative 'module_identifier'
+require_relative 'module_series'
+require_relative 'module_graphic'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Citation
+
+                    def self.unpack(hCitation, responseObj)
+
+
+                        # return nil object if input is empty
+                        if hCitation.empty?
+                            responseObj[:readerExecutionMessages] << 'Citation object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intCitation = intMetadataClass.newCitation
+
+                        # citation - title (required)
+                        if hCitation.has_key?('title')
+                            intCitation[:title] = hCitation['title']
+                        end
+                        if intCitation[:title].nil? || intCitation[:title] == ''
+                            responseObj[:readerExecutionMessages] << 'Citation attribute title is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # citation - alternate title []
+                        if hCitation.has_key?('alternateTitle')
+                            hCitation['alternateTitle'].each do |item|
+                                if item != ''
+                                    intCitation[:alternateTitles] << item
+                                end
+                            end
+                        end
+
+                        # citation - date []
+                        if hCitation.has_key?('date')
+                            aItems = hCitation['date']
+                            aItems.each do |item|
+                                hReturn = Date.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intCitation[:dates] << hReturn
+                                end
+                            end
+                        end
+
+                        # citation - edition
+                        if hCitation.has_key?('edition')
+                            if hCitation['edition'] != ''
+                                intCitation[:edition] = hCitation['edition']
+                            end
+                        end
+
+                        # citation - responsible party []
+                        if hCitation.has_key?('responsibleParty')
+                            aItems = hCitation['responsibleParty']
+                            aItems.each do |item|
+                                hReturn = ResponsibleParty.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intCitation[:responsibleParties] << hReturn
+                                end
+                            end
+                        end
+
+                        # citation - presentation form []
+                        if hCitation.has_key?('presentationForm')
+                            hCitation['presentationForm'].each do |item|
+                                if item != ''
+                                    intCitation[:presentationForms] << item
+                                end
+                            end
+                        end
+
+                        # citation - identifier []
+                        if hCitation.has_key?('identifier')
+                            aItems = hCitation['identifier']
+                            aItems.each do |item|
+                                hReturn = Identifier.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intCitation[:identifiers] << hReturn
+                                end
+                            end
+                        end
+
+                        # citation - series
+                        if hCitation.has_key?('series')
+                            hObject = hCitation['series']
+                            unless hObject.empty?
+                                hReturn = Series.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intCitation[:series] = hReturn
+                                end
+                            end
+                        end
+
+                        # citation - other details
+                        if hCitation.has_key?('otherCitationDetails')
+                            hCitation['otherCitationDetails'].each do |item|
+                                if item != ''
+                                    intCitation[:otherDetails] << item
+                                end
+                            end
+                        end
+
+                        # citation - online resource []
+                        if hCitation.has_key?('onlineResource')
+                            aItems = hCitation['onlineResource']
+                            aItems.each do |item|
+                                hReturn = OnlineResource.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intCitation[:onlineResources] << hReturn
+                                end
+                            end
+                        end
+
+                        # citation - graphic []
+                        if hCitation.has_key?('graphic')
+                            aItems = hCitation['graphic']
+                            aItems.each do |item|
+                                hReturn = Graphic.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intCitation[:browseGraphics] << hReturn
+                                end
+                            end
+                        end
+
+                        return intCitation
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,163 @@
+# unpack constraint
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-15 original script
+
+require_relative 'module_scope'
+require_relative 'module_graphic'
+require_relative 'module_citation'
+require_relative 'module_releasability'
+require_relative 'module_responsibleParty'
+require_relative 'module_legalConstraint'
+require_relative 'module_securityConstraint'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Constraint
+
+                    def self.unpack(hConstraint, responseObj)
+
+
+                        # return nil object if input is empty
+                        if hConstraint.empty?
+                            responseObj[:readerExecutionMessages] << 'Constraint object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intConstraint = intMetadataClass.newConstraint
+
+                        # constraint - type (required)
+                        type = nil
+                        if hConstraint.has_key?('type')
+                            if hConstraint['type'] != ''
+                                type = hConstraint['type']
+                                if %w{ use legal security }.one? { |word| word == type }
+                                    intConstraint[:type] = hConstraint['type']
+                                else
+                                    responseObj[:readerExecutionMessages] << 'Constraint type must be use, legal, or security'
+                                    responseObj[:readerExecutionPass] = false
+                                    return nil
+                                end
+                            end
+                        end
+                        if intConstraint[:type].nil? || intConstraint[:type] == ''
+                            responseObj[:readerExecutionMessages] << 'Constraint type declaration is missing'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # constraint - use limitation [] (required if type='use')
+                        if hConstraint.has_key?('useLimitation')
+                            hConstraint['useLimitation'].each do |item|
+                                if item != ''
+                                    intConstraint[:useLimitation] << item
+                                end
+                            end
+                        end
+
+                        # constraint - scope
+                        if hConstraint.has_key?('scope')
+                            hObject = hConstraint['scope']
+                            unless hObject.empty?
+                                hReturn = Scope.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intConstraint[:scope] = hReturn
+                                end
+                            end
+                        end
+
+                        # constraint - graphic [graphic]
+                        if hConstraint.has_key?('graphic')
+                            aGraphic = hConstraint['graphic']
+                            aGraphic.each do |item|
+                                hGraphic = Graphic.unpack(item, responseObj)
+                                unless hGraphic.nil?
+                                    intConstraint[:graphic] << hGraphic
+                                end
+                            end
+                        end
+
+                        # constraint - reference [citation]
+                        if hConstraint.has_key?('reference')
+                            aReference = hConstraint['reference']
+                            aReference.each do |item|
+                                hReference = Citation.unpack(item, responseObj)
+                                unless hReference.nil?
+                                    intConstraint[:reference] << hReference
+                                end
+                            end
+                        end
+
+                        # constraint - releasability
+                        if hConstraint.has_key?('releasability')
+                            hObject = hConstraint['releasability']
+                            unless hObject.empty?
+                                hReturn = Releasability.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intConstraint[:releasability] = hReturn
+                                end
+                            end
+                        end
+
+                        # constraint - responsible party []
+                        if hConstraint.has_key?('responsibleParty')
+                            aRParty = hConstraint['responsibleParty']
+                            aRParty.each do |item|
+                                hParty = ResponsibleParty.unpack(item, responseObj)
+                                unless hParty.nil?
+                                    intConstraint[:responsibleParty] << hParty
+                                end
+                            end
+                        end
+
+                        if type == 'legal'
+                            if hConstraint.has_key?('legal')
+                                hObject = hConstraint['legal']
+                                unless hObject.empty?
+                                    hReturn = LegalConstraint.unpack(hObject, responseObj)
+                                    unless hReturn.nil?
+                                        intConstraint[:legalConstraint] = hReturn
+                                    end
+                                end
+                            end
+                            if intConstraint[:legalConstraint].empty?
+                                responseObj[:readerExecutionMessages] << 'Legal Constraint object is missing or empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        end
+
+                        if type == 'security'
+                            if hConstraint.has_key?('security')
+                                hObject = hConstraint['security']
+                                unless hObject.empty?
+                                    hReturn = SecurityConstraint.unpack(hObject, responseObj)
+                                    unless hReturn.nil?
+                                        intConstraint[:securityConstraint] = hReturn
+                                    end
+                                end
+                            end
+                            if intConstraint[:securityConstraint].empty?
+                                responseObj[:readerExecutionMessages] << 'Security Constraint object is missing or empty'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        end
+
+                        return intConstraint
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,172 @@
+# unpack contact
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-23 original script
+
+require_relative 'module_onlineResource'
+require_relative 'module_phone'
+require_relative 'module_address'
+require_relative 'module_graphic'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Contact
+
+                    def self.unpack(hContact, responseObj)
+
+
+                        # return nil object if input is empty
+                        if hContact.empty?
+                            responseObj[:readerExecutionMessages] << 'Contact object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intContact = intMetadataClass.newContact
+
+                        # contact - contact id (required)
+                        if hContact.has_key?('contactId')
+                            intContact[:contactId] = hContact['contactId']
+                        end
+                        if intContact[:contactId].nil? || intContact[:contactId] == ''
+                            responseObj[:readerExecutionMessages] << 'Contact is missing contactId'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # contact - is organization (required)
+                        if hContact.has_key?('isOrganization')
+                            if hContact['isOrganization'] === true
+                                intContact[:isOrganization] = true
+                            end
+                        end
+
+                        # contact - position name
+                        if hContact.has_key?('positionName')
+                            if hContact['positionName'] != ''
+                                intContact[:positionName] = hContact['positionName']
+                            end
+                        end
+
+                        # contact - name (required if ...)
+                        # ... isOrganization = true
+                        # ... isOrganization = false && positionName = nil
+                        if hContact.has_key?('name')
+                            if hContact['name'] != ''
+                                intContact[:name] = hContact['name']
+                            end
+                        end
+                        if intContact[:name].nil? || intContact[:name] == ''
+                            if intContact[:isOrganization] === true
+                                responseObj[:readerExecutionMessages] << 'Organization contact is missing name'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                            if intContact[:positionName].nil? || intContact[:positionName] == ''
+                                responseObj[:readerExecutionMessages] << 'Individual contact is missing name and position'
+                                responseObj[:readerExecutionPass] = false
+                                return nil
+                            end
+                        end
+
+                        # contact - member of organization []
+                        if hContact.has_key?('memberOfOrganization')
+                            hContact['memberOfOrganization'].each do |item|
+                                if item != ''
+                                    intContact[:memberOfOrgs] << item
+                                end
+                            end
+                        end
+
+                        # contact - logo graphic [graphic]
+                        if hContact.has_key?('logoGraphic')
+                            aItems = hContact['logoGraphic']
+                            aItems.each do |item|
+                                hReturn = Graphic.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intContact[:logos] << hReturn
+                                end
+                            end
+                        end
+
+                        # contact - phone [phone]
+                        if hContact.has_key?('phone')
+                            aItems = hContact['phone']
+                            aItems.each do |item|
+                                hReturn = Phone.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intContact[:phones] << hReturn
+                                end
+                            end
+                        end
+
+                        # contact - address [address]
+                        if hContact.has_key?('address')
+                            aItems = hContact['address']
+                            aItems.each do |item|
+                                hReturn = Address.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intContact[:addresses] << hReturn
+                                end
+                            end
+                        end
+
+                        # contact - electronic mail addresses []
+                        if hContact.has_key?('electronicMailAddress')
+                            hContact['electronicMailAddress'].each do |item|
+                                if item != ''
+                                    intContact[:eMailList] << item
+                                end
+                            end
+                        end
+
+                        # contact - online resource [onlineResource]
+                        if hContact.has_key?('onlineResource')
+                            aItems = hContact['onlineResource']
+                            aItems.each do |item|
+                                hReturn = OnlineResource.unpack(item, responseObj)
+                                unless hReturn.nil?
+                                    intContact[:onlineResources] << hReturn
+                                end
+                            end
+                        end
+
+                        # contact - hours of service []
+                        if hContact.has_key?('hoursOfService')
+                            hContact['hoursOfService'].each do |item|
+                                if item != ''
+                                    intContact[:hoursOfService] << item
+                                end
+                            end
+                        end
+
+                        # contact - contact instructions
+                        if hContact.has_key?('contactInstructions')
+                            if hContact['contactInstructions'] != ''
+                                intContact[:contactInstructions] = hContact['contactInstructions']
+                            end
+                        end
+
+                        # contact - contact type
+                        if hContact.has_key?('contactType')
+                            if hContact['contactType'] != ''
+                                intContact[:contactType] = hContact['contactType']
+                            end
+                        end
+
+                        return intContact
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,96 @@
+# unpack content information
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-18 original script
+
+require_relative 'module_identifier'
+require_relative 'module_attributeGroup'
+require_relative 'module_imageDescription'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module CoverageDescription
+
+                    def self.unpack(hContent, responseObj)
+
+                        # return nil object if input is empty
+                        if hContent.empty?
+                            responseObj[:readerExecutionMessages] << 'Content Info object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intContent = intMetadataClass.newCoverageDescription
+
+                        # content information - coverage name (required)
+                        if hContent.has_key?('coverageName')
+                            if hContent['coverageName'] != ''
+                                intContent[:coverageName] = hContent['coverageName']
+                            end
+                        end
+                        if intContent[:coverageName].nil?
+                            responseObj[:readerExecutionMessages] << 'Content Info attribute coverageName is missing '
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # content information - coverage description (required)
+                        if hContent.has_key?('coverageDescription')
+                            if hContent['coverageDescription'] != ''
+                                intContent[:coverageDescription] = hContent['coverageDescription']
+                            end
+                        end
+                        if intContent[:coverageDescription].nil?
+                            responseObj[:readerExecutionMessages] << 'Content Info attribute coverageDescription is missing '
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # content information - processing level code
+                        if hContent.has_key?('processingLevelCode')
+                            hObject = hContent['processingLevelCode']
+                            unless hObject.empty?
+                                hReturn = Identifier.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intContent[:processingLevelCode] = hReturn
+                                end
+                            end
+                        end
+
+                        # content information - attribute group []
+                        if hContent.has_key?('attributeGroup')
+                            hContent['attributeGroup'].each do |item|
+                                hAttGrp = AttributeGroup.unpack(item, responseObj)
+                                unless hAttGrp.nil?
+                                    intContent[:attributeGroups] << hAttGrp
+                                end
+                            end
+                        end
+
+                        # content information - image description
+                        if hContent.has_key?('imageDescription')
+                            hObject = hContent['imageDescription']
+                            unless hObject.empty?
+                                hReturn = ImageDescription.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intContent[:imageDescription] = hReturn
+                                end
+                            end
+                        end
+
+                        return intContent
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end