adiwg-mdtranslator 2.0.0rc11 → 2.0.0rc13

data/lib/adiwg/mdtranslator/readers/mdReaders.rb

@@ -1,69 +1,69 @@
 # MdTranslator - controller for evaluating and directing readers
 
 # History:
-#   Stan Smith 2016-11-12 refactored for mdTranslator 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 (hResponseObj)
-#   Stan Smith 2015-03-04 changed method of setting $WriterNS
-#   Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
+#  Stan Smith 2016-11-12 refactored for mdTranslator 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 (hResponseObj)
+#  Stan Smith 2015-03-04 changed method of setting $WriterNS
+#  Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
 # 	Stan Smith 2014-12-11 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
+   module Mdtranslator
+      module Readers
 
-            def self.handleReader(file, hResponseObj)
+         def self.handleReader(file, hResponseObj)
 
-                # use ':readerRequested' from hResponseObj to build directory path to reader
-                # reader's high level folder must be placed in 'lib/adiwg/mdtranslator/readers/'
-                # reader's code must must be in folder named '{reader}'
-                # '{reader}' must contain a module named '{reader}_reader.rb'
-                # '{reader}_reader.rb' must have a method named 'readFile()'
-                # 'readFile()' must pass two parameters (file, hResponseObj)
-                # all reader modules and classes must remain in their private namespace
-                # reader namespace is 'ADIWG::Mdtranslator::Readers::{reader}'
+            # use ':readerRequested' from hResponseObj to build directory path to reader
+            # reader's high level folder must be placed in 'lib/adiwg/mdtranslator/readers/'
+            # reader's code must must be in folder named '{reader}'
+            # '{reader}' must contain a module named '{reader}_reader.rb'
+            # '{reader}_reader.rb' must have a method named 'readFile()'
+            # 'readFile()' must pass two parameters (file, hResponseObj)
+            # all reader modules and classes must remain in their private namespace
+            # reader namespace is 'ADIWG::Mdtranslator::Readers::{reader}'
 
-                # reader high-level folder
-                thisDir = File.dirname(File.expand_path(__FILE__))
-                readerDir = File.join(thisDir, hResponseObj[:readerRequested])
-                if File.directory?(readerDir)
+            # reader high-level folder
+            thisDir = File.dirname(File.expand_path(__FILE__))
+            readerDir = File.join(thisDir, hResponseObj[:readerRequested])
+            if File.directory?(readerDir)
 
-                    # reader folder
-                    readerModule = File.join(readerDir, hResponseObj[:readerRequested] + '_reader')
-                    require readerModule
+               # reader folder
+               readerModule = File.join(readerDir, hResponseObj[:readerRequested] + '_reader')
+               require readerModule
 
-                    # reader namespace
-                    readerNS = hResponseObj[:readerRequested].dup
-                    readerNS[0] = readerNS[0].upcase
+               # reader namespace
+               readerNS = hResponseObj[:readerRequested].dup
+               readerNS[0] = readerNS[0].upcase
 
-                    # reader will return intObj and updated hResponseObj
-                    return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, hResponseObj)
-
-                else
-                    hResponseObj[:readerValidationMessages] << "Requested reader '#{hResponseObj[:readerRequested]}' cannot be found."
-                    hResponseObj[:readerValidationPass] = false
-                    return {}
-                end
+               # reader will return intObj and updated hResponseObj
+               return ADIWG::Mdtranslator::Readers.const_get(readerNS).readFile(file, hResponseObj)
 
+            else
+               hResponseObj[:readerValidationMessages] << "Requested reader '#{hResponseObj[:readerRequested]}' cannot be found."
+               hResponseObj[:readerValidationPass] = false
+               return {}
             end
 
-            # return reader readme text
-            # this is called from the Rails API
-            def self.get_reader_readme(reader)
+         end
 
-                thisDir = File.dirname(File.expand_path(__FILE__))
-                path = File.join(thisDir, reader, 'readme.md')
-                if File.exist?(path)
-                    file = File.open(path, 'r')
-                    readmeText = file.read
-                    file.close
-                    return readmeText
-                else
-                    return 'Readme file not found'
-                end
+         # return reader readme text
+         # this is called from the Rails API
+         def self.get_reader_readme(reader)
 
+            thisDir = File.dirname(File.expand_path(__FILE__))
+            path = File.join(thisDir, reader, 'readme.md')
+            if File.exist?(path)
+               file = File.open(path, 'r')
+               readmeText = file.read
+               file.close
+               return readmeText
+            else
+               return 'Readme file not found'
             end
 
-        end
-    end
+         end
+
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_body.rb

@@ -0,0 +1,41 @@
+# unpack body / summary
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-19 original script
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Body
+
+               def self.unpack(hSbJson, hResourceInfo, hResponseObj)
+
+                  # body
+                  if hSbJson.has_key?('body')
+                     sbAbstract = hSbJson['body']
+                     unless sbAbstract.nil? || sbAbstract == ''
+                        hResourceInfo[:abstract] = sbAbstract
+                     end
+                  end
+
+                  # summary
+                  if hSbJson.has_key?('summary')
+                     sbShort = hSbJson['summary']
+                     unless sbShort.nil? || sbShort == ''
+                        hResourceInfo[:shortAbstract] = sbShort
+                     end
+                  end
+
+                  return hResourceInfo
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,32 @@
+# unpack citation
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-19 original script
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Citation
+
+               def self.unpack(hSbJson, hCitation, hResponseObj)
+
+                  if hSbJson.has_key?('citation')
+                     sbCitation = hSbJson['citation']
+                     unless sbCitation.nil? || sbCitation == ''
+                        hCitation[:otherDetails][0] = sbCitation
+                     end
+                  end
+
+                  return hCitation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_id.rb

@@ -0,0 +1,35 @@
+# unpack id
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-14 original script
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Id
+
+               def self.unpack(hSbJson, hIdentifier, hResponseObj)
+
+                  # title
+                  if hSbJson.has_key?('id')
+                     sbId = hSbJson['id']
+                     unless sbId.nil? || sbId == ''
+                        hIdentifier[:identifier] = sbId
+                        hIdentifier[:namespace] = 'gov.sciencebase.catalog'
+                        hIdentifier[:description] = 'USGS ScienceBase Identifier'
+                     end
+                  end
+
+                  return hIdentifier
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_identifier.rb

@@ -0,0 +1,46 @@
+# unpack identifier
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-19 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Identifier
+
+               # instance classes needed in script
+               @intMetadataClass = InternalMetadata.new
+
+               def self.unpack(hSbJson, hCitation, hResponseObj)
+
+                  hSbJson['identifiers'].each_with_index do |hSbIdentifier, i|
+                     hIdentifier = @intMetadataClass.newIdentifier
+
+                     unless hSbIdentifier['type'].nil? || hSbIdentifier['type'] == ''
+                        hIdentifier[:description] = hSbIdentifier['type']
+                     end
+                     unless hSbIdentifier['scheme'].nil? || hSbIdentifier['scheme'] == ''
+                        hIdentifier[:namespace] = hSbIdentifier['scheme']
+                     end
+                     unless hSbIdentifier['key'].nil? || hSbIdentifier['key'] == ''
+                        hIdentifier[:identifier] = hSbIdentifier['key']
+                     end
+
+                     hCitation[:identifiers] << hIdentifier
+                  end
+
+                  return hCitation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_provenance.rb

@@ -0,0 +1,59 @@
+# unpack provenance
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-20 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Provenance
+
+               def self.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  # title
+                  if hSbJson.has_key?('provenance')
+                     hSbProv = hSbJson['provenance']
+
+                     if hSbProv.has_key?('dateCreated')
+                        unless hSbProv['dateCreated'].nil? || hSbProv['dateCreated'] == ''
+                           hDate = intMetadataClass.newDate
+                           hReturn = AdiwgDateTimeFun.dateTimeFromString(hSbProv['dateCreated'])
+                           hDate[:date] = hReturn[0]
+                           hDate[:dateResolution] = hReturn[1]
+                           hDate[:dateType] = 'creation'
+                           hCitation[:dates] << hDate
+                        end
+                     end
+
+                     if hSbProv.has_key?('lastUpdated')
+                        unless hSbProv['lastUpdated'].nil? || hSbProv['lastUpdated'] == ''
+                           hDate = intMetadataClass.newDate
+                           hReturn = AdiwgDateTimeFun.dateTimeFromString(hSbProv['lastUpdated'])
+                           hDate[:date] = hReturn[0]
+                           hDate[:dateResolution] = hReturn[1]
+                           hDate[:dateType] = 'lastUpdate'
+                           hCitation[:dates] << hDate
+                        end
+                     end
+
+                  end
+
+                  return hCitation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_purpose.rb

@@ -0,0 +1,32 @@
+# unpack purpose
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-19 original script
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Purpose
+
+               def self.unpack(hSbJson, hResourceInfo, hResponseObj)
+
+                  if hSbJson.has_key?('purpose')
+                     sbPurpose = hSbJson['purpose']
+                     unless sbPurpose.nil? || sbPurpose == ''
+                        hResourceInfo[:purpose] = sbPurpose
+                     end
+                  end
+
+                  return hResourceInfo
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_rights.rb

@@ -0,0 +1,43 @@
+# unpack rights
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-19 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Rights
+
+               def self.unpack(hSbJson, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  hConstraint = intMetadataClass.newConstraint
+                  hLegal = intMetadataClass.newLegalConstraint
+
+                  if hSbJson.has_key?('rights')
+                     sbRights = hSbJson['rights']
+                     unless sbRights.nil? || sbRights == ''
+                        hConstraint[:type] = 'legal'
+                        hLegal[:otherCons][0] = sbRights
+                        hConstraint[:legalConstraint] = hLegal
+                        return hConstraint
+                     end
+                  end
+
+                  return nil
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_sbJson.rb

@@ -0,0 +1,106 @@
+# unpack sbJson
+# Reader - sbJson to internal data structure
+
+# History:
+#  Stan Smith 2017-06-12 refactor for mdTranslator 2.0
+#  Josh Bradley original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require_relative 'module_titles'
+require_relative 'module_id'
+require_relative 'module_body'
+require_relative 'module_citation'
+require_relative 'module_identifier'
+require_relative 'module_purpose'
+require_relative 'module_rights'
+require_relative 'module_provenance'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module SbJson
+
+               def self.unpack(hSbJson, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  intObj = intMetadataClass.newBase
+
+                  # build basic mdTranslator internal object
+                  hMetadata = intMetadataClass.newMetadata
+                  hMetadataInfo = intMetadataClass.newMetadataInfo
+                  hResourceInfo = intMetadataClass.newResourceInfo
+                  hCitation = intMetadataClass.newCitation
+
+                  hResourceInfo[:citation] = hCitation
+                  hMetadata[:metadataInfo] = hMetadataInfo
+                  hMetadata[:resourceInfo] = hResourceInfo
+                  intObj[:metadata] = hMetadata
+
+                  # titles / alternateTitles
+                  Title.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # id
+                  Id.unpack(hSbJson, hMetadataInfo[:metadataIdentifier], hResponseObj)
+
+                  # body / summary
+                  Body.unpack(hSbJson, hResourceInfo, hResponseObj)
+
+                  # citation
+                  Citation.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # identifier
+                  Identifier.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # purpose
+                  Purpose.unpack(hSbJson, hResourceInfo, hResponseObj)
+
+                  # rights
+                  hReturn = Rights.unpack(hSbJson, hResponseObj)
+                  hResourceInfo[:constraints] << hReturn unless hReturn.nil?
+
+                  # provenance
+                  Provenance.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # materialRequestInstructions
+
+                  # something goes here
+                  @contacts = []
+
+                  return intObj
+
+               end
+
+               # find the array pointer and type for a contact
+               def self.findContact(contactId)
+
+                  contactIndex = nil
+                  contactType = nil
+                  @contacts.each_with_index do |contact, i|
+                     if contact[:contactId] == contactId
+                        contactIndex = i
+                        if contact[:isOrganization]
+                           contactType = 'organization'
+                        else
+                           contactType = 'individual'
+                        end
+                     end
+                  end
+                  return contactIndex, contactType
+
+               end
+
+               # set contacts array for reader test modules
+               def self.setContacts(contacts)
+                  @contacts = contacts
+               end
+
+            end
+
+         end
+      end
+   end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules/module_titles.rb

@@ -0,0 +1,42 @@
+# unpack titles
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-13 original script
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Title
+
+               def self.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # title
+                  if hSbJson.has_key?('title')
+                     title = hSbJson['title']
+                     unless title.nil? || title == ''
+                        hCitation[:title] = title
+                     end
+                  end
+
+                  # alternate titles []
+                  if hSbJson.has_key?('alternateTitles')
+                     hSbJson['alternateTitles'].each do |item|
+                        unless item.nil? || item == ''
+                           hCitation[:alternateTitles] << item
+                        end
+                     end
+                  end
+
+                  return hCitation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end