adiwg-mdtranslator 1.3.0 → 1.4.0.beta1

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_resourceIdentifier.rb

@@ -0,0 +1,23 @@
+require 'jbuilder'
+require_relative 'mdJson_citation'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module ResourceIdentifier
+          def self.build(ident)
+            Jbuilder.new do |json|
+              json.identifier ident[:identifier]
+              json.namespace ident[:identifierNamespace]
+              json.version ident[:identifierVersion]
+              json.description ident[:identifierDescription]
+              json.type ident[:identifierType]
+              json.authority Citation.build(ident[:identifierCitation]) unless ident[:identifierCitation].empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_resourceInfo.rb

@@ -0,0 +1,69 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_citation'
+require_relative 'mdJson_timePeriod'
+require_relative 'mdJson_responsibleParty'
+require_relative 'mdJson_locale'
+require_relative 'mdJson_format'
+require_relative 'mdJson_keyword'
+require_relative 'mdJson_resourceMaintenance'
+require_relative 'mdJson_usage'
+require_relative 'mdJson_graphicOverview'
+require_relative 'mdJson_constraint'
+require_relative 'mdJson_taxonomy'
+require_relative 'mdJson_spatialreference'
+require_relative 'mdJson_extent'
+require_relative 'mdJson_gridInfo'
+require_relative 'mdJson_coverageInfo'
+require_relative 'mdJson_dataQuality'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module ResourceInfo
+          extend MdJson::Base
+
+          def self.build(_info)
+            Jbuilder.new do |json|
+              json.resourceType _info[:resourceType]
+              json.citation Citation.build(_info[:citation])
+              json.resourceTimePeriod TimePeriod.build(_info[:timePeriod]) # unless _info[:timePeriod].empty?
+              json.pointOfContact json_map(_info[:pointsOfContact], ResponsibleParty)
+              json.abstract _info[:abstract]
+              json.shortAbstract _info[:shortAbstract]
+              json.status _info[:status]
+              json.hasMapLocation _info[:hasMapLocation?]
+              json.hasDataAvailable _info[:hasDataAvailable?]
+              json.language (_info[:resourceLanguages])
+              json.characterSet (_info[:resourceCharacterSets])
+              json.locale json_map(_info[:resourceLocales], Locale)
+              json.purpose _info[:purpose]
+              json.credit (_info[:credits])
+              json.topicCategory (_info[:topicCategories])
+              json.environmentDescription _info[:environmentDescription]
+              json.resourceNativeFormat json_map(_info[:resourceFormats], Format)
+              json.keyword json_map(_info[:descriptiveKeywords], Keyword)
+              json.resourceMaintenance json_map(_info[:resourceMaint], ResourceMaintenance)
+              json.resourceSpecificUsage json_map(_info[:resourceUses], Usage)
+              json.graphicOverview json_map(_info[:graphicOverview], GraphicOverview)
+              json.constraint Constraint.build(_info[:useConstraints], _info[:legalConstraints], _info[:securityConstraints])
+              json.taxonomy Taxonomy.build(_info[:taxonomy])
+              json.spatialReferenceSystem SpatialReference.build(_info[:spatialReferenceSystem])
+              json.spatialResolution (_info[:spatialResolutions]) do |sr|
+                json.equivalentScale sr[:equivalentScale]
+                json.distance sr[:distance]
+                json.uom sr[:distanceUOM]
+              end
+              json.extent json_map(_info[:extents], Extent)
+              json.gridInfo json_map(_info[:gridInfo], GridInfo)
+              json.coverageInfo json_map(_info[:coverageInfo], CoverageInfo)
+              json.dataQualityInfo json_map(_info[:dataQualityInfo], DataQuality)
+              json.supplementalInfo _info[:supplementalInfo]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_resourceMaintenance.rb

@@ -0,0 +1,23 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_responsibleParty'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module ResourceMaintenance
+          extend MdJson::Base
+          
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.maintenanceFrequency intObj[:maintFreq]
+              json.maintenanceNote (intObj[:maintNotes])
+              json.maintenanceContact json_map(intObj[:maintContacts], ResponsibleParty)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_responsibleParty.rb

@@ -0,0 +1,18 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module ResponsibleParty
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.contactId intObj[:contactId]
+              json.role intObj[:roleName]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_spatialreference.rb

@@ -0,0 +1,19 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module SpatialReference
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.name(intObj[:sRNames])
+              json.epsgNumber(intObj[:sREPSGs])
+              json.wkt(intObj[:sRWKTs])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_taxon.rb

@@ -0,0 +1,19 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Taxon
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.taxonRank (intObj[:taxRankName])
+              json.taxonValue (intObj[:taxRankValue])
+              json.common (intObj[:commonName])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_taxonomy.rb

@@ -0,0 +1,32 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_citation'
+require_relative 'mdJson_responsibleParty'
+require_relative 'mdJson_taxon'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Taxonomy
+          extend MdJson::Base
+
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.classificationSystem json_map(intObj[:taxClassSys], Citation)
+              json.taxonGeneralScope intObj[:taxGeneralScope]
+              json.observer json_map(intObj[:taxObservers], ResponsibleParty)
+              json.taxonomicProcedure intObj[:taxIdProcedures]
+              json.voucher do
+                voucher = intObj[:taxVoucher]
+                json.specimen voucher.nil? ? nil : voucher[:specimen]
+                json.repository voucher.nil? ? nil : ResponsibleParty.build(voucher[:repository])
+              end
+              json.taxonClass json_map(intObj[:taxClasses], Taxon)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_temporalElement.rb

@@ -0,0 +1,38 @@
+require 'jbuilder'
+
+require_relative 'mdJson_base'
+require_relative 'mdJson_timePeriod'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module TemporalElement
+          extend MdJson::Base
+
+          def self.build(intObj)
+            remap = {
+              date: [],
+              timeInstant: [],
+              timePeriod: []
+            }
+
+            intObj.each do |obj|
+              obj.each { |key, value| remap[key] << value unless value.empty? }
+            end
+
+            Jbuilder.new do |json|
+              json.timeInstant(remap[:timeInstant]) do |ti|
+                json.id ti[:timeId]
+                json.description ti[:description]
+                json.timePosition ti[:timePosition][:dateTime] unless ti[:timePosition].nil?
+              end unless remap[:timeInstant].empty?
+              json.timePeriod json_map(remap[:timePeriod], TimePeriod)
+              json.date(remap[:date]) { |dt| json.merge! dt[:dateTime] } unless remap[:date].empty?
+            end unless remap[:date].empty? && remap[:timeInstant].empty? && remap[:timePeriod].empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_timePeriod.rb

@@ -0,0 +1,20 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module TimePeriod
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.id intObj[:timeId]
+              json.description intObj[:description]
+              json.beginPosition intObj[:beginTime][:dateTime] unless intObj[:beginTime].nil?
+              json.endPosition intObj[:endTime][:dateTime] unless intObj[:endTime].nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_transferOption.rb

@@ -0,0 +1,33 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_onlineResource'
+require_relative 'mdJson_format'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module TransferOption
+          extend MdJson::Base
+
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.distributorFormat json_map(intObj[:dist], Format)
+              json.transferSize intObj[:transferSize]
+              json.transferSizeUnits intObj[:transferSizeUnits]
+              json.online json_map(intObj[:online], OnlineResource)
+              json.offline do
+                off = intObj[:offline]
+                json.name off[:mediumType]
+                json.mediumCapacity off[:mediumCapacity]
+                json.mediumCapacityUnits off[:mediumCapacityUnits]
+                json.mediumFormat off[:mediumFormat]
+                json.mediumNote off[:mediumNote]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_usage.rb

@@ -0,0 +1,23 @@
+require 'jbuilder'
+require_relative 'mdJson_base'
+require_relative 'mdJson_responsibleParty'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module Usage
+          extend MdJson::Base
+
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.specificUsage intObj[:specificUsage]
+              json.userDeterminedLimitation (intObj[:userLimits])
+              json.userContactInfo json_map(intObj[:userContacts], ResponsibleParty)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/sections/mdJson_verticalElement.rb

@@ -0,0 +1,20 @@
+require 'jbuilder'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module MdJson
+        module VerticalElement
+          def self.build(intObj)
+            Jbuilder.new do |json|
+              json.minimumValue intObj[:minValue]
+              json.maximumValue intObj[:maxValue]
+              json.verticalCRSTitle intObj[:crsTitle]
+              json.verticalCRSUri intObj[:crsURI]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adiwg/mdtranslator/writers/mdJson/version.rb

@@ -0,0 +1,13 @@
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module MdJson
+
+                # current version of mdJson writer,
+                # corresponds to mdJson output
+                VERSION = '1.1.0'
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,12 @@
+
+## sbJson
+
+### Supported versions
+
+> 0.0.x
+
+### Writer 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/writers/sbJson/sbJson_writer.rb

@@ -0,0 +1,126 @@
+require 'jbuilder'
+require_relative 'version'
+require_relative 'sections/sbJson_base'
+require_relative 'sections/sbJson_contact'
+require_relative 'sections/sbJson_identifier'
+require_relative 'sections/sbJson_spatial'
+
+module ADIWG
+  module Mdtranslator
+    module Writers
+      module SbJson
+        extend SbJson::Base
+        def self.startWriter(_intObj, responseObj, _paramsObj)
+          @intObj = _intObj
+
+          # set output flag for null properties
+          Jbuilder.ignore_nil(!responseObj[:writerShowTags])
+          # set the format of the output file based on the writer specified
+          responseObj[:writerFormat] = 'sbJson'
+          responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::SbJson::VERSION
+
+          rInfo = _intObj[:metadata][:resourceInfo]
+          dInfo = _intObj[:metadata][:distributorInfo]
+          cite = rInfo[:citation]
+          ids = cite[:citResourceIds]
+
+          metadata = Jbuilder.new do |json|
+            json.identifiers json_map(ids, Identifier)
+            json.title cite[:citTitle]
+            json.alternateTitles([cite[:citAltTitle]]) unless cite[:citAltTitle].nil?
+            json.body rInfo[:abstract]
+            json.citation do
+              names = cite[:citResponsibleParty].map do |rp|
+                cnt = getContact(rp[:contactId])
+                cnt[:indName]
+              end
+              names = names.select! { |s| s }.nil? ? 'Unknown' : names.join(', ')
+              dates = cite[:citDate].map { |dt| dt[:dateTime].strftime('%F') + '(' + dt[:dateType] + ')' }
+              url = cite[:citOlResources].map { |ol| ol[:olResURI] }
+              json.merge! sprintf('%s, %s, %s, %s', names, dates.join(', '), cite[:citTitle], url.join(', '))
+            end
+            json.purpose rInfo[:purpose]
+
+            legal = []
+            rInfo[:legalConstraints].each do |lc|
+              legal += lc[:accessCodes] += lc[:useCodes] += lc[:otherCons]
+            end
+            json.rights legal.empty? ? nil : legal.join('; ')
+            json.provenance do
+              json.annotation 'Generated using the ADIwg mdTranslator, http://mdtranslator.adiwg.org'
+            end
+
+            mri = []
+            dInfo.each { |di| di[:distOrderProcs].each { |dop| mri << dop[:orderInstructions] } }
+            json.materialRequestInstructions mri.empty? ? nil : mri.join('; ')
+
+            json.contacts json_map(_intObj[:contacts].select! { |c| !(c[:internal]) }, Contact)
+
+            # grab links from citation, additionalDocumentation, distributionInfo
+            wl = []
+            wl += cite[:citOlResources]
+            dInfo.each { |di| di[:distTransOptions].each { |dto| wl += dto[:online] } }
+            _intObj[:metadata][:additionalDocuments].each { |ad| wl += ad[:citation][:citOlResources] }
+
+            json.webLinks(wl) do |lnk|
+              json.type 'webLink'
+              json.typeLabel 'Web Link'
+              json.uri lnk[:olResURI]
+              json.title lnk[:olResName]
+            end unless wl.empty?
+
+            tags = []
+            rInfo[:topicCategories].each do |tc|
+              tags << { type: 'Label',
+                        scheme: 'ISO 19115 Topic Categories',
+                        name: tc }
+            end
+            rInfo[:descriptiveKeywords].each do |kw|
+              type = kw[:keyTheCitation].fetch(:citTitle, kw[:keywordType]) || 'Theme'
+              scheme = kw[:keyTheCitation].fetch(:citOlResources, [])
+              kw[:keyword].each do |_k|
+                tags << { type: type,
+                          scheme: scheme.empty? ? 'None' : scheme.first[:olResURI],
+                          name: _k }
+              end
+            end
+            json.tags(tags)
+
+            dates = cite[:citDate]
+            tp = rInfo[:timePeriod]
+            unless  tp.empty?
+              dates << { dateType: 'Start', dateTime: tp[:beginTime][:dateTime].to_datetime
+              } unless tp[:beginTime].empty?
+              dates << { dateType: 'End', dateTime: tp[:endTime][:dateTime].to_datetime
+              } unless tp[:endTime].empty?
+
+            end
+            json.dates(dates) do |dt|
+              json.type dt[:dateType]
+              json.dateString dt[:dateTime].strftime('%F')
+              json.label dt[:dateType].split(/(?=[A-Z])/).join(' ').capitalize
+            end
+
+            json.spatial Spatial.build(rInfo[:extents])
+          end
+          # set writer pass to true if no messages
+          # false or warning will be set by code that places the message
+          responseObj[:writerPass] = true if responseObj[:writerMessages].empty?
+
+          # j = JSON.parse(metadata.target!)
+          # puts JSON.pretty_generate(j)
+
+          metadata.target!
+        end
+
+        # find contact in contact array and return the contact hash
+        def self.getContact(contactID)
+          @intObj[:contacts].each do |hContact|
+            return hContact if hContact[:contactId] == contactID
+          end
+          {}
+        end
+      end
+    end
+  end
+end