adiwg-mdtranslator 2.0.0rc13 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6dae2d4d0b4f056465097adf48a786332a8e1ac
-  data.tar.gz: 4d120c45abcf7459c45271c4e4a626e4bc2aa426
+  metadata.gz: eaa279b686cbbf45cc0066e9aef52a6c72604444
+  data.tar.gz: a88be00a70a91aae1cfb0d77ac333b758731c5e7
 SHA512:
-  metadata.gz: 59a2afd957514a20c5d2497d6627a08516dcfb40df807fb9fcbd6039263bb83ec512717b141abfe43153b91fe4430877e360964bdcdb51c82e195826c9017941
-  data.tar.gz: 1e080a421fad0efb0139437922a021d5b7402c252ed2dda1ca3fbd0695eed882309c2f345a4170e015606142689a17364914b1784df99c7ccce3610568412c4f
+  metadata.gz: e755033a24e274d7af87523e5209a65d8b9b046a9e4967be02d407657475c8983c45fa1fb97260f9422ea39530f8e10e7f5456ff4afc4183800006ba813af0ff
+  data.tar.gz: a23c434be20d0309294c36133f2bcb2099883198c46c3fde5701361dfba854798ba156dbc2a5cb9916b7ae3aa213d58fb84126fbb88a70634698043c2132cdfc

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

@@ -0,0 +1,47 @@
+# unpack browse category
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-22 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/writers/sbJson/sections/sbJson_codelists'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module BrowseCategory
+
+               @Namespace = ADIWG::Mdtranslator::Writers::SbJson
+
+               def self.unpack(hSbJson, hResourceInfo, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  if hSbJson.has_key?('browseCategories')
+                     hSbJson['browseCategories'].each do |category|
+                        hResType = intMetadataClass.newResourceType
+                        scope = @Namespace::Codelists.codelist_iso_to_sb('iso_sb_scope', :sbCode => category)
+                        if scope.nil?
+                           hResType[:type] = 'dataset'
+                           hResType[:name] = category
+                        else
+                           hResType[:type] = scope
+                        end
+                        hResourceInfo[:resourceTypes] << hResType
+                     end
+                  end
+
+                  return hResourceInfo
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,79 @@
+# unpack budget facet
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-25 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Budget
+
+               def self.unpack(hFacet, hMetadata, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                     if hFacet.has_key?('annualBudgets')
+                        hFacet['annualBudgets'].each do |hBudget|
+
+                           hFunding = intMetadataClass.newFunding
+
+                           # funding source
+                           # ignore source and recipient
+                           if hBudget.has_key?('fundingSources')
+                              hBudget['fundingSources'].each do |hSource|
+                                 hAllocation = intMetadataClass.newAllocation
+                                 if hSource.has_key?('amount')
+                                    unless hSource['amount'].nil? || hSource == ''
+                                       hAllocation[:amount] = hSource['amount']
+                                    end
+                                 end
+                                 if hSource.has_key?('matching')
+                                    if !!hSource['matching'] == hSource['matching']
+                                       hAllocation[:matching] = hSource['matching']
+                                    else
+                                       hAllocation[:matching] = false
+                                    end
+                                 end
+
+                                 hFunding[:allocations] << hAllocation
+                              end
+                           end
+
+                           # year
+                           if hBudget.has_key?('year')
+                              unless hBudget['year'].nil? || hBudget['year'] == ''
+                                 hPeriod = intMetadataClass.newTimePeriod
+                                 hDateTime = intMetadataClass.newDateTime
+                                 aReturn = AdiwgDateTimeFun.dateTimeFromString(hBudget['year'])
+                                 unless aReturn.nil?
+                                    hDateTime[:dateTime] = aReturn[0]
+                                    hDateTime[:dateResolution] = aReturn[1]
+                                    hPeriod[:endDateTime] = hDateTime
+                                    hFunding[:timePeriod] = hPeriod
+                                 end
+                              end
+                           end
+
+                           unless hFunding.empty?
+                              hMetadata[:funding] << hFunding
+                           end
+
+                        end
+                     end
+
+                  return hMetadata
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,248 @@
+# unpack contacts
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-21 original script
+
+require 'uuidtools'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Contact
+
+               def self.unpackAddress(hSbPrimary, hAddress)
+
+                  if hSbPrimary.has_key?('line1')
+                     unless hSbPrimary['line1'].nil? || hSbPrimary['line1'] == ''
+                        hAddress[:deliveryPoints] << hSbPrimary['line1']
+                     end
+                  end
+                  if hSbPrimary.has_key?('line2')
+                     unless hSbPrimary['line2'].nil? || hSbPrimary['line2'] == ''
+                        hAddress[:deliveryPoints] << hSbPrimary['line2']
+                     end
+                  end
+
+                  if hSbPrimary.has_key?('city')
+                     unless hSbPrimary['city'].nil? || hSbPrimary['city'] == ''
+                        hAddress[:city] = hSbPrimary['city']
+                     end
+                  end
+                  if hSbPrimary.has_key?('state')
+                     unless hSbPrimary['state'].nil? || hSbPrimary['state'] == ''
+                        hAddress[:adminArea] = hSbPrimary['state']
+                     end
+                  end
+                  if hSbPrimary.has_key?('zip')
+                     unless hSbPrimary['zip'].nil? || hSbPrimary['zip'] == ''
+                        hAddress[:postalCode] = hSbPrimary['zip']
+                     end
+                  end
+                  if hSbPrimary.has_key?('country')
+                     unless hSbPrimary['country'].nil? || hSbPrimary['country'] == ''
+                        hAddress[:country] = hSbPrimary['country']
+                     end
+                  end
+
+                  return hAddress
+
+               end
+
+               def self.unpack(hSbJson, aContacts, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  if hSbJson.has_key?('contacts')
+
+                     hSbJson['contacts'].each do |hSbContact|
+
+                        hContact = intMetadataClass.newContact
+
+                        hContact[:contactId] = UUIDTools::UUID.random_create.to_s
+
+                        # contact - contactType (required) [ person | organization ]
+                        if hSbContact.has_key?('contactType')
+                           if %w(person organization).include?(hSbContact['contactType'])
+                              hContact[:isOrganization] = true if hSbContact['contactType'] == 'organization'
+                           else
+                              hResponseObj[:readerExecutionMessages] << 'Contact contactType must be person or organization'
+                              hResponseObj[:readerExecutionPass] = false
+                              return nil
+                           end
+                        end
+                        if hSbContact['contactType'].nil? || hSbContact['contactType'] == ''
+                           hResponseObj[:readerExecutionMessages] << 'Contact contactType is missing'
+                           hResponseObj[:readerExecutionPass] = false
+                           return nil
+                        end
+
+                        # contact - name (required)
+                        if hSbContact.has_key?('name')
+                           hContact[:name] = hSbContact['name']
+                        end
+                        if hSbContact['name'].nil? || hSbContact['name'] == ''
+                           hResponseObj[:readerExecutionMessages] << 'Contact name is missing'
+                           hResponseObj[:readerExecutionPass] = false
+                           return nil
+                        end
+
+                        if hSbContact.has_key?('jobTitle')
+                           unless hSbContact['jobTitle'].nil? || hSbContact['jobTitle'] == ''
+                              hContact[:positionName] = hSbContact['jobTitle']
+                           end
+                        end
+
+                        # logos
+                        if hSbContact.has_key?('logoUrl')
+                           unless hSbContact['logoUrl'].nil? || hSbContact['logoUrl'] == ''
+                              hGraphic = intMetadataClass.newGraphic
+                              hOlRes = intMetadataClass.newOnlineResource
+                              hGraphic[:graphicName] = 'logoUrl'
+                              hOlRes[:olResURI] = hSbContact['logoUrl']
+                              hGraphic[:graphicURI] << hOlRes
+                              hContact[:logos] << hGraphic
+                           end
+                        end
+                        if hSbContact.has_key?('smallLogoUrl')
+                           unless hSbContact['smallLogoUrl'].nil? || hSbContact['smallLogoUrl'] == ''
+                              hGraphic = intMetadataClass.newGraphic
+                              hOlRes = intMetadataClass.newOnlineResource
+                              hGraphic[:graphicName] = 'smallLogoUrl'
+                              hOlRes[:olResURI] = hSbContact['smallLogoUrl']
+                              hGraphic[:graphicURI] << hOlRes
+                              hContact[:logos] << hGraphic
+                           end
+                        end
+
+                        # primary location
+                        if hSbContact.has_key?('primaryLocation')
+                           unless hSbContact['primaryLocation'].empty?
+
+                              hPrimary = hSbContact['primaryLocation']
+
+                              # phones
+                              if hPrimary.has_key?('officePhone')
+                                 unless hPrimary['officePhone'].nil? || hPrimary['officePhone'] == ''
+                                    hPhone = intMetadataClass.newPhone
+                                    hPhone[:phoneNumber] = hPrimary['officePhone']
+                                    hPhone[:phoneServiceTypes] << 'voice'
+                                    hContact[:phones] << hPhone
+                                 end
+                              end
+                              if hPrimary.has_key?('faxPhone')
+                                 unless hPrimary['faxPhone'].nil? || hPrimary['faxPhone'] == ''
+                                    hPhone = intMetadataClass.newPhone
+                                    hPhone[:phoneNumber] = hPrimary['faxPhone']
+                                    hPhone[:phoneServiceTypes] << 'facsimile'
+                                    hContact[:phones] << hPhone
+                                 end
+                              end
+                              if hPrimary.has_key?('ttyPhone')
+                                 unless hPrimary['ttyPhone'].nil? || hPrimary['ttyPhone'] == ''
+                                    hPhone = intMetadataClass.newPhone
+                                    hPhone[:phoneNumber] = hPrimary['ttyPhone']
+                                    hPhone[:phoneServiceTypes] << 'tty'
+                                    hContact[:phones] << hPhone
+                                 end
+                              end
+
+                              # street address
+                              if hPrimary.has_key?('streetAddress')
+                                 unless hPrimary['streetAddress'].empty?
+                                    hAddress = intMetadataClass.newAddress
+                                    hAddress[:addressTypes] << 'physical'
+
+                                    if hPrimary.has_key?('name')
+                                       unless hPrimary['name'].nil? || hPrimary['name'] == ''
+                                          hAddress[:description] = hPrimary['name']
+                                       end
+                                    end
+
+                                    hContact[:addresses] << unpackAddress(hPrimary['streetAddress'], hAddress)
+                                 end
+                              end
+
+                              # mailing address
+                              if hPrimary.has_key?('mailAddress')
+                                 unless hPrimary['mailAddress'].empty?
+                                    hAddress = intMetadataClass.newAddress
+                                    hAddress[:addressTypes] << 'mailing'
+
+                                    if hPrimary.has_key?('name')
+                                       unless hPrimary['name'].nil? || hPrimary['name'] == ''
+                                          hAddress[:description] = hPrimary['name']
+                                       end
+                                    end
+
+                                    hContact[:addresses] << unpackAddress(hPrimary['mailAddress'], hAddress)
+                                 end
+                              end
+
+
+                           end
+                        end
+
+                        # email / hours of service / contact instructions
+                        if hSbContact.has_key?('email')
+                           unless hSbContact['email'].nil? || hSbContact['email'] == ''
+                              hContact[:eMailList] << hSbContact['email']
+                           end
+                        end
+                        if hSbContact.has_key?('hours')
+                           unless hSbContact['hours'].nil? || hSbContact['hours'] == ''
+                              hContact[:hoursOfService] << hSbContact['hours']
+                           end
+                        end
+                        if hSbContact.has_key?('instructions')
+                           unless hSbContact['instructions'].nil? || hSbContact['instructions'] == ''
+                              hContact[:contactInstructions] = hSbContact['instructions']
+                           end
+                        end
+
+                        # contact - type (required)
+                        if hSbContact.has_key?('type')
+                           hContact[:contactType] = hSbContact['type']
+                        end
+                        if hSbContact['type'].nil? || hSbContact['type'] == ''
+                           hResponseObj[:readerExecutionMessages] << 'Contact type is missing'
+                           hResponseObj[:readerExecutionPass] = false
+                           return nil
+                        end
+
+                        # member of organization
+                        hContactOrg = {}
+                        if hSbContact.has_key?('organization')
+                           if hSbContact['organization'].has_key?('displayText')
+                              sbText = hSbContact['organization']['displayText']
+                              unless sbText.nil? || sbText == ''
+                                 hContactOrg = intMetadataClass.newContact
+                                 hContactOrg[:contactId] = UUIDTools::UUID.random_create.to_s
+                                 hContactOrg[:isOrganization] = true
+                                 hContactOrg[:name] = sbText
+                                 hContact[:memberOfOrgs] << hContactOrg[:contactId]
+                              end
+                           end
+                        end
+
+                        aContacts << hContact
+                        aContacts << hContactOrg unless hContactOrg.empty?
+
+                     end
+
+                  end
+
+                  return aContacts
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,49 @@
+# unpack dates
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-25 original script
+
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/writers/sbJson/sections/sbJson_codelists'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Date
+
+               @Namespace = ADIWG::Mdtranslator::Writers::SbJson
+
+               def self.unpack(hSbJson, hCitation, hResponseObj)
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+
+                  if hSbJson.has_key?('dates')
+                     hSbJson['dates'].each do |hSbDate|
+                        hDate = intMetadataClass.newDate
+                        aReturn = AdiwgDateTimeFun.dateTimeFromString(hSbDate['dateString'])
+                        unless aReturn.nil?
+                           hDate[:date] = aReturn[0]
+                           hDate[:dateResolution] = aReturn[1]
+                           hDate[:description] = hSbDate['label']
+                           type = @Namespace::Codelists.codelist_iso_to_sb('iso_sb_date', :sbCode => hSbDate['type'])
+                           type = type.nil? ? hSbDate['type'] : type
+                           hDate[:dateType] = type
+                           hCitation[:dates] << hDate
+                        end
+                     end
+                  end
+
+                  return hCitation
+
+               end
+
+            end
+
+         end
+      end
+   end
+end

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

@@ -0,0 +1,62 @@
+# unpack extent
+# Reader - ScienceBase JSON to internal data structure
+
+# History:
+#   Stan Smith 2016-06-28 original script
+
+require 'json'
+require 'open-uri'
+require 'adiwg/mdtranslator/readers/mdJson/modules/module_extent'
+
+module ADIWG
+   module Mdtranslator
+      module Readers
+         module SbJson
+
+            module Extent
+
+               def self.unpack(extentId, hResponseObj)
+
+                  begin
+                     extentAdd = "http://www.sciencebase.gov/catalog/extent/#{extentId}?format=geojson"
+                     web_contents = open(extentAdd, :read_timeout => 30) { |f| f.read }
+                  rescue => readErr
+                     hResponseObj[:readerExecutionMessages] << 'ScienceBase read failed - see following message(s):\n'
+                     hResponseObj[:readerExecutionMessages] << readErr.to_s.slice(0, 300)
+                     return {}
+                  else
+                     # parse geoJson file
+                     begin
+                        hGeoJson = JSON.parse(web_contents)
+                     rescue JSON::JSONError => parseErr
+                        hResponseObj[:readerExecutionMessages] << 'Parsing sbJson failed - see following message(s):\n'
+                        hResponseObj[:readerExecutionMessages] << parseErr.to_s.slice(0, 300)
+                        return {}
+                     end
+                     mdJson = {
+                        'description' => 'Extent extracted from ScienceBase',
+                        'geographicExtent' => [
+                           {
+                              'containsData' => true,
+                              'identifier' => {
+                                 'identifier' => ''
+                              },
+                              'geographicElement' => []
+                           }
+                        ]
+                     }
+                     mdJson['geographicExtent'][0]['identifier']['identifier'] = extentId.to_s
+                     mdJson['geographicExtent'][0]['identifier']['namespace'] = 'gov.sciencebase.catalog'
+                     mdJson['geographicExtent'][0]['geographicElement'] << hGeoJson
+                     hExtent = ADIWG::Mdtranslator::Readers::MdJson::Extent.unpack(mdJson, hResponseObj)
+                     return hExtent
+                  end
+
+               end
+
+            end
+
+         end
+      end
+   end
+end