adiwg-mdtranslator 1.4.0 → 2.0.0rc2

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

@@ -0,0 +1,82 @@
+# unpack online resources
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	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 2013-09-25 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module OnlineResource
+
+                    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
+
+                        # 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 protocol
+                        if hOnlineRes.has_key?('protocol')
+                            if 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 description
+                        if hOnlineRes.has_key?('description')
+                            if 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
+
+                        return intOLRes
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,68 @@
+# unpack order process
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-21 original script
+
+require_relative 'module_dateTime'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module OrderProcess
+
+                    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
+
+                        # order process - fees
+                        if hOrder.has_key?('fees')
+                            if hOrder['fees'] != ''
+                                intOrder[:fees] = hOrder['fees']
+                            end
+                        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 - ordering instructions
+                        if hOrder.has_key?('orderingInstructions')
+                            if hOrder['orderingInstructions'] != ''
+                                intOrder[:orderingInstructions] = hOrder['orderingInstructions']
+                            end
+                        end
+
+                        # order process - turnaround
+                        if hOrder.has_key?('turnaround')
+                            if hOrder['turnaround'] != ''
+                                intOrder[:turnaround] = hOrder['turnaround']
+                            end
+                        end
+
+                        return intOrder
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,79 @@
+# unpack party
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-09 original script
+
+require_relative 'module_mdJson'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Party
+
+                    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
+
+                        # 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 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 - 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
+                        end
+
+                        return intParty
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,68 @@
+# unpack phone
+# 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 2013-12-16 original script
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Phone
+
+                    def self.unpack(hPhone, responseObj)
+
+                        # 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
+
+                        # 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 - phoneName
+                        if hPhone.has_key?('phoneName')
+                            if 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
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,113 @@
+# unpack process step
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-10-15 refactored for mdJson 2.0
+#   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-07-03 resolve require statements using Mdtranslator.reader_module
+# 	Stan Smith 2013-11-26 original script
+
+require_relative 'module_timePeriod'
+require_relative 'module_responsibleParty'
+require_relative 'module_citation'
+require_relative 'module_scope'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module ProcessStep
+
+                    def self.unpack(hProcStep, responseObj)
+
+                        # return nil object if input is empty
+                        if hProcStep.empty?
+                            responseObj[:readerExecutionMessages] << 'Process Step object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intProcStep = intMetadataClass.newProcessStep
+
+                        # process step - step ID
+                        if hProcStep.has_key?('stepId')
+                            if hProcStep['stepId'] != ''
+                                intProcStep[:stepId] = hProcStep['stepId']
+                            end
+                        end
+
+                        # 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[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # process step - rationale
+                        if hProcStep.has_key?('rationale')
+                            if hProcStep['rationale'] != ''
+                                intProcStep[:rationale] = hProcStep['rationale']
+                            end
+                        end
+
+                        # process step - time period
+                        if hProcStep.has_key?('timePeriod')
+                            hObject = hProcStep['timePeriod']
+                            unless hObject.empty?
+                                hReturn = TimePeriod.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intProcStep[:timePeriod] = hReturn
+                                end
+                            end
+                        end
+
+                        # process step - step processors [responsible party]
+                        if hProcStep.has_key?('processor')
+                            aProc = hProcStep['processor']
+                            aProc.each do |item|
+                                hParty = ResponsibleParty.unpack(item, responseObj)
+                                unless hParty.nil?
+                                    intProcStep[:processors] << hParty
+                                end
+                            end
+                        end
+
+                        # process step - reference [citation]
+                        if hProcStep.has_key?('reference')
+                            aReference = hProcStep['reference']
+                            aReference.each do |item|
+                                hReference = Citation.unpack(item, responseObj)
+                                unless hReference.nil?
+                                    intProcStep[:references] << hReference
+                                end
+                            end
+                        end
+
+                        # process step - scope {scope}
+                        if hProcStep.has_key?('scope')
+                            hObject = hProcStep['scope']
+                            unless hObject.empty?
+                                hReturn = Scope.unpack(hObject, responseObj)
+                                unless hReturn.nil?
+                                    intProcStep[:scope] = hReturn
+                                end
+                            end
+                        end
+
+                        return intProcStep
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,71 @@
+# unpack releasability
+# Reader - ADIwg JSON to internal data structure
+
+# History:
+# 	Stan Smith 2016-10-15 original script
+
+require_relative 'module_responsibleParty'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Releasability
+
+                    def self.unpack(hRelease, responseObj)
+
+                        # return nil object if input is empty
+                        if hRelease.empty?
+                            responseObj[:readerExecutionMessages] << 'Releasability object is empty'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intRelease = intMetadataClass.newRelease
+
+                        # releasability - addressee [responsibleParty]
+                        if hRelease.has_key?('addressee')
+                            aRParty = hRelease['addressee']
+                            aRParty.each do |item|
+                                hParty = ResponsibleParty.unpack(item, responseObj)
+                                unless hParty.nil?
+                                    intRelease[:addressee] << hParty
+                                end
+                            end
+                        end
+
+                        # releasability - statement
+                        if hRelease.has_key?('statement')
+                            if hRelease['statement'] != ''
+                                intRelease[:statement] = hRelease['statement']
+                            end
+                        end
+
+                        # releasability - dissemination constraint []
+                        if hRelease.has_key?('disseminationConstraint')
+                            hRelease['disseminationConstraint'].each do |item|
+                                if item != ''
+                                    intRelease[:disseminationConstraint] << item
+                                end
+                            end
+                        end
+
+                        if intRelease[:addressee].empty? && intRelease[:statement].nil?
+                            responseObj[:readerExecutionMessages] << 'Releasability must have at least one addressee or statement'
+                            responseObj[:readerExecutionPass] = false
+                            return nil
+                        end
+
+                        return intRelease
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end