adiwg-mdtranslator 1.3.0 → 1.4.0.beta1

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/module_responsibleParty.rb

@@ -0,0 +1,53 @@
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                module ResponsibleParty
+
+                    def self.unpack(hRParty, responseObj)
+
+                        # return nil object if input is empty
+                        intResById = nil
+                        return if hRParty.empty?
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intResById = intMetadataClass.newRespParty
+
+                        # responsible party - contact
+                        if hRParty.has_key?('contactId')
+                            s = hRParty['contactId']
+                            if s != ''
+                                intResById[:contactId] = s
+                                if (!ADIWG::Mdtranslator::Readers::SbJson.findContact(s))
+                                    responseObj[:readerExecutionPass] = false
+                                    responseObj[:readerExecutionMessages] << "Responsible Party contact ID #{s} does not match with any contact provided\n"
+                                end
+                            else
+                                responseObj[:readerExecutionPass] = false
+                                responseObj[:readerExecutionMessages] << 'Responsible Party is missing the contact ID\n'
+                            end
+                        end
+
+                        # responsible party - role - required
+                        if hRParty.has_key?('role')
+                            s = hRParty['role']
+                            if s != ''
+                                intResById[:roleName] = s
+                            else
+                                responseObj[:readerExecutionPass] = false
+                                responseObj[:readerExecutionMessages] << 'Responsible Party is missing the contact role\n'
+                            end
+                        end
+
+                        return intResById
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,52 @@
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_contacts')
+require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_metadata')
+#require ADIWG::Mdtranslator::Readers::SbJson.readerModule('module_dataDictionary')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                def self.unpack(intObj, hSbJson, responseObj)
+
+                    # get json schema name and version
+                    hVersion = hSbJson['version']
+                    intObj[:schema][:name] = hVersion['name']
+                    intObj[:schema][:version] = hVersion['version']
+
+                    # contact array
+                    # load the array of contacts from the json input
+                    if hSbJson.has_key?('contacts')
+                    	aContacts = hSbJson['contacts']
+                    	aContacts.each do |hContact|
+                    		unless hContact.empty?
+                    			intObj[:contacts] << Contact.unpack(hContact, responseObj)
+                    		end
+                    	end
+                    end
+                    # add default contacts
+                    intObj[:contacts].concat(Contact.setDefaultContacts)
+
+                    # metadata section
+                    # load metadata from the hash object
+                    intObj[:metadata] = Metadata.unpack(hSbJson, responseObj, intObj)
+
+                    # # data dictionary section
+                    # if hSbJson.has_key?('dataDictionary')
+                    #     aDictionary = hSbJson['dataDictionary']
+                    #     aDictionary.each do |hDictionary|
+                    #         unless hDictionary.empty?
+                    #             intObj[:dataDictionary] << DataDictionary.unpack(hDictionary, responseObj)
+                    #         end
+                    #     end
+                    # end
+
+                    # return ADIwg internal container
+                    return intObj
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/modules_v0/version.rb

@@ -0,0 +1,12 @@
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                # current version of sbJson reader
+                VERSION = '0.0.0'
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/readme.md

@@ -0,0 +1,12 @@
+
+## sbJson
+
+### Supported versions
+
+> 0.0.x
+
+### Reader for ScienceBase JSON metadata format (sbJSON)
+
+The ScienceBase Item core is based on the Dublin Core Metadata Element Set but also includes other elements that may or may not be associated with other metadata standards that are useful for the core attribution of ScienceBase items. It is used as a means to integrate across multiple metadata standards, conventions, and practices in describing a wide array of scientific data and information assets important to science teams using ScienceBase.
+
+The sbJSON format is fully documented on the [ScienceBase Confluence page](https://my.usgs.gov/confluence/display/sciencebase/ScienceBase+Information+Model).

data/lib/adiwg/mdtranslator/readers/sbJson/sbJson_reader.rb

@@ -0,0 +1,205 @@
+require 'json'
+require_relative 'sbJson_validator'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                def self.readFile(file, responseObj)
+
+                    # set reference to responseObj for use throughout this module
+                    @responseObj = responseObj
+
+                    # receive json file into ruby hash
+                    parseJson(file)
+                    if !@responseObj[:readerStructurePass]
+                        return false
+                    end
+
+                    # set format of file in $response
+                    @responseObj[:readerFormat] = 'json'
+
+                    # check sbJson version name
+                    checkVersionName
+                    if !@responseObj[:readerStructurePass]
+                        return false
+                    end
+
+                    # check sbJson version number
+                    checkVersionNumber
+                    if !@responseObj[:readerStructurePass]
+                        return false
+                    end
+
+                    #validate file against sbJson schema definition
+                    validate(file, @responseObj)
+                    if !@responseObj[:readerValidationPass]
+                        return false
+                    end
+
+                    # load sbJson file into internal object
+                    require readerModule('module_sbJson')
+                    # instance classes needed in script
+                    intMetadataClass = InternalMetadata.new
+
+                    # create new internal metadata container for the reader
+                    @intObj = intMetadataClass.newBase
+
+                    #
+                    ADIWG::Mdtranslator::Readers::SbJson.unpack(@intObj, @hSbJson, @responseObj)
+                    return @intObj
+
+                end
+
+                def self.parseJson(file)
+                    # validate the input file structure
+                    # test for valid json syntax by attempting to parse the file
+                    begin
+                        @hSbJson = JSON.parse(file)
+
+                        # faking the version since sbJSON has no support
+                        @hSbJson['version'] = {
+                          "name" => "sbJson",
+                          "version" => "0.0.0"
+                        }
+
+                        @responseObj[:readerStructurePass] = true
+                    rescue JSON::JSONError => err
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'JSON Parsing Failed - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << err.to_s.slice(0,300)
+                    end
+                end
+
+                def self.checkVersionName
+                    # find version name on the input json file
+                    if @hSbJson.has_key?('version')
+                        hVersion = @hSbJson['version']
+                    else
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << 'The input file is missing the version:{} block.'
+                        return
+                    end
+
+                    # check the version name
+                    if hVersion.has_key?('name')
+                        s = hVersion['name']
+                        if s.nil?
+                            @responseObj[:readerStructurePass] = false
+                            @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            @responseObj[:readerStructureMessages] << 'The input file version: => name: is missing.'
+                            return
+                        end
+                    else
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'name:' attribute."
+                        return
+                    end
+
+                    # check the version name is 'sbJson'
+                    if s != 'sbJson'
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << "The mdTranslator reader expected the input file version: name: to be 'sbJson'."
+                        @responseObj[:readerStructureMessages] << "Version name found was: '#{s}'."
+                    end
+                end
+
+                def self.checkVersionNumber
+                    # find version number on the input json file
+                    hVersion = @hSbJson['version']
+                    if hVersion.has_key?('version')
+                        s = hVersion['version']
+                        if !s.nil?
+                            @responseObj[:readerVersionRequested] = s
+                        end
+                    else
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'version:' number attribute."
+                        return
+                    end
+
+                    # split the version number into its parts
+                    aReqVersion = s.split('.')
+
+                    reqMajor = 0
+                    if !aReqVersion[0].nil?
+                        reqMajor = aReqVersion[0]
+                    end
+
+                    # test if the requested reader major version is supported
+                    # look for a folder with modules for the major version number
+                    dirName = File.join(File.dirname(__FILE__), 'modules_v' + reqMajor)
+                    if !File.directory?(dirName)
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << 'A reader for the requested version is not supported.'
+                        @responseObj[:readerStructureMessages] << "sbJson version requested was '#{s}'"
+                        return false
+                    end
+
+                    # the requested major version is supported
+                    # get the full version number for this major version of sbJson
+                    require File.join(dirName, 'version')
+                    curVersion = ADIWG::Mdtranslator::Readers::SbJson::VERSION
+                    @responseObj[:readerVersionUsed] = curVersion
+                    aCurVersion = curVersion.split('.')
+                    curMinor = aCurVersion[1]
+
+                    # test that minor version number is not exceeded
+                    reqMinor = 0
+                    if !aReqVersion[1].nil?
+                        reqMinor = aReqVersion[1]
+                        if curMinor < reqMinor
+                            @responseObj[:readerStructurePass] = false
+                            @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            @responseObj[:readerStructureMessages] << 'The requested reader minor version is not supported.'
+                            @responseObj[:readerStructureMessages] << "sbJson version requested was '#{s}'"
+                            return false
+                        end
+                    end
+
+                end
+
+                # find the array pointer for a contact
+                def self.findContact(contactId)
+                    pointer = nil
+                    i = 0
+                    @intObj[:contacts].each do |contact|
+                        if contact[:contactId] == contactId
+                            pointer = i
+                        end
+                        i += 1
+                    end
+
+                    return pointer
+                end
+
+                # require modules for the requested version
+                def self.readerModule(moduleName)
+                    majVersion = @responseObj[:readerVersionUsed].split('.')[0]
+                    dirName = File.join(File.dirname(__FILE__), 'modules_v' + majVersion.to_s)
+                    fileName = File.join(dirName, moduleName)
+
+                    # test for the existance of the module in the current sbJson version directory
+                    if !File.exist?(File.join(dirName, moduleName + '.rb'))
+                        # file not found
+                        # ... look for module in previous version directory
+                        # ... note: no previous version directories exist yet
+
+                        # no prior version directory found
+                        # ... file not found
+                        return nil
+                    end
+
+                    return fileName
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/sbJson/sbJson_validator.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'json-schema'
+# temporary json-schema patch
+# waiting for rubygem json-schema patch
+#require 'adiwg/mdtranslator/readers/sbJson/validator.rb'
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module SbJson
+
+                # validate json against the schemas
+                # only one schema version is supported at this time
+                def self.validate(file, responseObj)
+
+                    # begin
+                    #     schema = ADIWG::SbJsonSchemas::Utils.schema_path
+                    #     aValErrs = Array.new
+                    #     if responseObj[:readerValidationLevel] == 'strict'
+                    #         aValErrs = JSON::Validator.fully_validate(schema, file, :strict => true, :errors_as_objects => true)
+                    #     elsif responseObj[:readerValidationLevel] == 'normal'
+                    #         aValErrs = JSON::Validator.fully_validate(schema, file, :errors_as_objects => true)
+                    #     end
+                    #
+                    #     if aValErrs.length > 0
+                    #         responseObj[:readerValidationPass] = false
+                    #         responseObj[:readerValidationMessages] << 'sbJson schema validation Failed - see following message(s):\n'
+                    #         responseObj[:readerValidationMessages] << aValErrs
+                    #         return
+                    #     end
+                    # rescue JSON::Schema::ValidationError
+                    #     responseObj[:readerValidationPass] = false
+                    #     responseObj[:readerValidationMessages] << 'sbJson schema validation Failed - see following message(s):\n'
+                    #     responseObj[:readerValidationMessages] << $!.message
+                    #     return
+                    # end
+
+                    responseObj[:readerValidationPass] = true
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/version.rb

@@ -61,7 +61,6 @@
 module ADIWG
     module Mdtranslator
         # current mdtranslator version
-        VERSION = "1.3.0"
+        VERSION = "1.4.0.beta1"
     end
 end
-

data/lib/adiwg/mdtranslator/writers/html/sections/html_browseGraphic.rb

@@ -41,9 +41,10 @@ module ADIWG
 
                             # browse graphic - URI
                             if !hBrowseG[:bGURI].nil?
+                                s = hBrowseG[:bGURI]
                                 @html.em('URI:')
                                 @html.section(:class=>'block') do
-                                    @html.a(hBrowseG[:bGURI])
+                                    @html.a(s, 'href'=>s)
                                 end
                             end
                         end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_multiGeometry.rb

@@ -11,8 +11,8 @@
 #   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
 #   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_point')
-require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineString')
+#require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_point')
+#require ADIWG::Mdtranslator::Readers::MdJson.readerModule('module_lineString')
 require_relative 'class_point'
 require_relative 'class_lineString'
 require_relative 'class_polygon'
@@ -90,7 +90,7 @@ module ADIWG
                                             aPoints.each do |aCoords|
                                                 intPoint = intMetadataClass.newGeoElement
                                                 intPoint[:elementSrs] = hGeoElement[:elementSrs]
-                                                intPoint[:elementGeometry] = ADIWG::Mdtranslator::Readers::MdJson::Point.unpack(aCoords, 'Point', @responseObj)
+                                                intPoint[:elementGeometry] = ADIWG::Mdtranslator::Point.unpack(aCoords, 'Point', @responseObj)
                                                 pointClass.writeXML(intPoint)
                                             end
                                         end
@@ -102,7 +102,7 @@ module ADIWG
                                             aLines.each do |aCoords|
                                                 intLine = intMetadataClass.newGeoElement
                                                 intLine[:elementSrs] = hGeoElement[:elementSrs]
-                                                intLine[:elementGeometry] = ADIWG::Mdtranslator::Readers::MdJson::LineString.unpack(aCoords, 'LineString', @responseObj)
+                                                intLine[:elementGeometry] = ADIWG::Mdtranslator::LineString.unpack(aCoords, 'LineString', @responseObj)
                                                 lineClass.writeXML(intLine)
                                             end
                                         end
@@ -114,7 +114,7 @@ module ADIWG
                                             aPolygons.each do |aCoords|
                                                 intPolygon = intMetadataClass.newGeoElement
                                                 intPolygon[:elementSrs] = hGeoElement[:elementSrs]
-                                                intPolygon[:elementGeometry] = ADIWG::Mdtranslator::Readers::MdJson::LineString.unpack(aCoords, 'Polygon', @responseObj)
+                                                intPolygon[:elementGeometry] = ADIWG::Mdtranslator::LineString.unpack(aCoords, 'Polygon', @responseObj)
                                                 polygonClass.writeXML(intPolygon)
                                             end
                                         end

data/lib/adiwg/mdtranslator/writers/iso19115_2/classes/class_responsibleParty.rb

@@ -85,7 +85,7 @@ module ADIWG
                                     # responsible party - role - required
                                     s = rParty[:roleName]
                                     if s.nil?
-                                        xml.tag!('gmd:role', {'gco:nilReason' => 'missing'})
+                                        @xml.tag!('gmd:role', {'gco:nilReason' => 'missing'})
                                     else
                                         @xml.tag! 'gmd:role' do
                                             codelistClass.writeXML('iso_role',s)