voruby 1.0.1

data/lib/voruby/resources/openskynode/openskynode_v0_1.rb

@@ -0,0 +1,54 @@
+require 'voruby/resources/openskynode/loader'
+
+require 'voruby/resources/voresource/voresource_v0_10'
+require 'voruby/resources/vodataservice/vodataservice_v0_5'
+
+include VORuby::Resources::VOResource::V0_10
+include VORuby::Resources::VODataService::V0_5
+
+module VORuby
+  module Resources
+    module OpenSkyNode
+      module V0_1
+        
+        # Forward declarations
+        class OpenSkyNode < TabularSkyService; end
+        class OSNCapRestriction < Capability; end
+        class OSNCapability < OSNCapRestriction; end
+        
+        
+        #  Registry data for the  standard openskynode service.
+        class OpenSkyNode
+          object_node :capability, 'capability', :class => OSNCapability, :optional => false
+        end
+        
+        # An abstract capability that sets the standardURL to the OpenSkyNode standard definition.
+        class OSNCapRestriction
+          object_node :standard_id, 'StandardID', :class => IdentifierURI, :optional => true
+          object_node :standard_url, 'StandardURL', :class => AnyURI, :optional => true,
+            :default_value => 'http://www.ivoa.net/internal/IVOA/IvoaVOQL/SkyNodeInterface-0.7.4.pdf'
+        end
+        
+        # The capabilities of an OpenSkyNode implementation.  It includes required  parameters for OpenSkyQuery portal.
+        class OSNCapability
+          # indicates level of compliance: full, basic, partial for OSN. A full node
+    			# must implement all the methods of the Spec including ExecutePlan.
+    			# A Basic node only needs performQuery, tables, columns and availability.
+          text_node :compliance, 'Compliance', :optional => false
+          # table name which contains the main positions and key - used by the query builder on the portal
+          text_node :primary_table, 'PrimaryTable', :optional => false
+          # the primary key of the primary Table - used by the query builder on the portal
+          text_node :primary_key, 'PrimaryKey', :optional => false
+          
+          # the latitude Earth position of archive (GPS)
+          numeric_node :latitude, 'Latitude', :optional => false
+          # the longitude Earth position of archive (GPS)
+          numeric_node :longitude, 'Longitude', :optional => false
+          # maximum records the service will return
+          numeric_node :max_records, 'MaxRecords', :optional => false
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/sia/loader.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'xml/mapping'
+
+require 'voruby/loader'
+

data/lib/voruby/resources/sia/sia.rb

@@ -0,0 +1,9 @@
+require 'voruby/resources/sia/sia_v1_0'
+
+module VORuby
+  module Resources
+    module SIA
+      #include SIA::V1_0
+    end
+  end
+end

data/lib/voruby/resources/sia/sia_v0_6.rb

@@ -0,0 +1,90 @@
+require 'voruby/resources/sia/loader'
+
+require 'voruby/resources/voresource/voresource_v0_9'
+require 'voruby/resources/vodataservice/vodataservice_v0_3'
+
+include VORuby::Resources::VOResource::V0_9
+include VORuby::Resources::VODataService::V0_3
+
+module VORuby
+  module Resources
+    module SIA
+      module V0_6
+        
+        # Forward declarations
+        class SimpleImageAccessType < Capability; end
+        class SimpleImageAccess < SimpleImageAccessType; end
+        class MaxRecords; end
+        class MaxFileSize; end
+        class MaxQueryRegionSize; end
+        class MaxImageExtent; end
+        class MaxImageSize; end
+        class ImageServiceType; end
+        
+        # The capabilities of an SIA implementation.  It includes
+        # the listing of the columns that appear in image query
+        # output VOTable and SIA-specific metadata.
+        class SimpleImageAccess; end
+        class SimpleImageAccessType
+          object_node :image_service_type, 'ImageServiceType', :class => ImageServiceType, :optional => false
+          object_node :max_query_region_size, 'MaxQueryRegionSize', :class => MaxQueryRegionSize, :optional => false
+          object_node :max_image_extent, 'MaxImageExtent', :class => MaxImageExtent, :optional => false
+          object_node :max_image_size, 'MaxImageSize', :class => MaxImageSize, :optional => false
+          object_node :max_file_size, 'MaxFileSize', :class => MaxFileSize, :optional => false
+          object_node :max_records, 'MaxRecords', :class => MaxRecords, :optional => false
+        end
+        
+        # The largest number of records that the Image Query web method will return.
+        class MaxRecords
+          include XML::Mapping
+          
+          numeric_node :value, '', :optional => false
+        end
+        
+        # The maximum image file size in bytes.
+        class MaxFileSize
+          include XML::Mapping
+          
+          numeric_node :value, '', :optional => false
+        end
+        
+        # The maximum image query region size, expressed in decimal
+        # degrees. A value of 360 degrees indicates that there is no limit
+        # and the entire data collection (entire sky) can be queried.
+        class MaxQueryRegionSize
+          include XML::Mapping
+          
+          numeric_node :long, 'long', :optional => false
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        # The maximum image query region size, expressed in decimal
+        # degrees. A value of 360 degrees indicates that there is no limit
+        # and the entire data collection (entire sky) can be requested.
+        class MaxImageExtent
+          include XML::Mapping
+          
+          numeric_node :long, 'long', :optional => false
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        # The largest image (in terms of pixels) that can be requested.
+        class MaxImageSize
+          include XML::Mapping
+          
+          numeric_node :long, 'long', :optional => false
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        # The class of image service: Cutout, Mosaic, Atlas, Pointed.
+        class ImageServiceType
+          include XML::Mapping
+          
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['Cutout', 'Mosaic', 'Atlas', 'Pointed']
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/sia/sia_v0_7.rb

@@ -0,0 +1,89 @@
+require 'voruby/resources/sia/loader'
+
+require 'voruby/resources/voresource/voresource_v0_10'
+require 'voruby/resources/vodataservice/vodataservice_v0_5'
+
+include VORuby::Resources::VOResource::V0_10
+include VORuby::Resources::VODataService::V0_5
+
+module VORuby
+  module Resources
+    module SIA
+      module V0_7
+        
+        # Forward declarations
+        class SimpleImageAccess < TabularSkyService; end
+        class SIACapRestriction < Capability; end
+        class SIACapability < SIACapRestriction; end
+        class SkySize; end
+        class ImageSize; end
+        class ImageServiceType; end
+        
+        # The capabilities of an SIA implementation.  It includes
+        # the listing of the columns that appear in image query
+        # output VOTable and SIA-specific metadata.
+        class SimpleImageAccess
+          # a description of the behavior and limitations of the SIA implementation
+          object_node :capability, 'capability', :class => SIACapability, :optional => false
+        end
+        
+        # An abstract capability that sets the standardURL to the ConeSearch standard definition,
+        class SIACapRestriction
+          object_node :standard_id, '@standardID', :class => IdentifierURI, :optional => true
+          object_node :standard_url, '@standardURL', :class => AnyURI, :optional => true,
+            :default_value => 'http://www.us-vo.org/metadata/sia.html'
+        end
+        
+        # The capabilities of an SIA implementation.
+        class SIACapability
+          # the class of image service: Cutout, Mosaic, Atlas, Pointed
+          object_node :image_service_type, 'imageServiceType', :class => ImageServiceType, :optional => false
+          # the maximum image query region size, expressed in 
+          # decimal degrees. A value of 360 degrees indicates that 
+          # there is no limit and the entire data collection 
+          # (entire sky) can be queried.
+          object_node :max_query_region_size, 'maxQueryRegionSize', :class => SkySize, :optional => false
+          # the maximum image query region size, expressed in 
+          # decimal degrees. A value of 360 degrees indicates 
+          # that there is no limit and the entire data collection 
+          # (entire sky) can be requested.
+          object_node :max_image_extent, 'maxImageExtent', :class => SkySize, :optional => false
+          # the largest image (in terms of pixels) that can be requested.
+          object_node :max_image_size, 'maxImageSize', :class => ImageSize, :optional => false
+          
+          # the maximum image file size in bytes
+          numeric_node :max_file_size, 'maxFileSize', :optional => false
+          # the largest number of records that the Image Query web method will return
+          numeric_node :max_records, 'maxRecords', :optional => false
+        end
+        
+        class SkySize
+          include XML::Mapping
+          
+          # the maximum size in the longitude (R.A.) direction
+          numeric_node :long, 'long', :optional => false
+          # the maximum size in the latitdude (Dec.) direction
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        class ImageSize
+          include XML::Mapping
+          
+          # the image size in the longitude (R.A.) direction in pixels
+          numeric_node :long, 'long', :optional => false
+          # the image size in the latitdude (Dec.) direction in pixels
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        # the class of image service: Cutout, Mosaic, Atlas, Pointed
+        class ImageServiceType
+          include XML::Mapping
+          
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['Cutout', 'Mosaic', 'Atlas', 'Pointed']
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/sia/sia_v1_0.rb

@@ -0,0 +1,122 @@
+require 'voruby/resources/sia/loader'
+
+require 'voruby/resources/voresource/voresource_v1_0'
+require 'voruby/resources/vodataservice/vodataservice_v1_0'
+
+include VORuby::Resources::VOResource::V1_0
+include VORuby::Resources::VODataService::V1_0
+
+module VORuby
+  module Resources
+    module SIA
+      module V1_0
+        
+        # Forward declarations
+        class SIACapRestriction < Capability; end
+        class SimpleImageAccess < SIACapRestriction; end
+        class SkySize; end
+        class SkyPos; end
+        class ImageSize; end
+        class ImageServiceType; end
+        class Query; end
+        
+        # An abstract capability that fixes the standardID to the IVOA ID for the ConeSearch standard.
+        class SIACapRestriction
+          text_node :description, 'description', :optional => true
+          text_node :standard_id, 'standardID', :class => IdentifierURI, :optional => false,
+            :default_value => 'ivo://ivoa.net/std/SIA'
+          
+          array_node :validation_levels, 'validationLevel', :class => Validation, :optional => true, :default_value => []
+          array_node :interfaces, 'interface', :class => Interface, :optional => true, :default_value => []
+          
+          def standard_id
+            id = IdentifierURI.new
+            id.value = 'ivo://ivoa.net/std/SIA'
+            
+            return id
+          end
+        end
+        
+        # The capabilities of an SIA implementation.
+        class SimpleImageAccess
+          # the class of image service: Cutout, Mosaic, Atlas, Pointed
+          object_node :image_service_type, 'imageServiceType', :class => ImageServiceType, :optional => false
+          # the maximum image query region size, expressed in 
+          # decimal degrees. A value of 360 degrees indicates that 
+          # there is no limit and the entire data collection 
+          # (entire sky) can be queried.
+          object_node :max_query_region_size, 'maxQueryRegionSize', :class => SkySize, :optional => false
+          # the maximum image query region size, expressed in 
+          # decimal degrees. A value of 360 degrees indicates 
+          # that there is no limit and the entire data collection 
+          # (entire sky) can be requested.
+          object_node :max_image_extent, 'maxImageExtent', :class => SkySize, :optional => false
+          # the largest image (in terms of pixels) that can be requested
+          object_node :max_image_size, 'maxImageSize', :class => ImageSize, :optional => false
+          # a set of query parameters that is expected to produce at least one matched record which
+          # can be used to test the service.
+          object_node :test_query, 'testQuery', :class => Query, :optional => true
+          
+          # the maximum image file size in bytes
+          numeric_node :max_file_size, 'maxFileSize', :optional => false
+          numeric_node :max_records, 'maxRecords', :optional => false
+        end
+        
+        class SkySize
+          include XML::Mapping
+          
+          # the maximum size in the longitude (R.A.) direction 
+          numeric_node :long, 'long', :optional => false
+          # the maximum size in the latitdude (Dec.) direction
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        class SkyPos
+          include XML::Mapping
+          
+          # the sky position in the longitude (R.A.) direction
+          numeric_node :long, 'long', :optional => false
+          # the sky position in the latitdude (Dec.) direction
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        class ImageSize
+          include XML::Mapping
+          
+          # the image size in the longitude (R.A.) direction in pixels
+          numeric_node :long, 'long', :optional => false
+          # the image size in the latitdude (Dec.) direction in pixels
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        # The class of image service: Cutout, Mosaic, Atlas, Pointed.
+        class ImageServiceType
+          include XML::Mapping
+          
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['Cutout', 'Mosaic', 'Atlas', 'Pointed']
+        end
+        
+        # A query to be sent to the service.
+        class Query
+          include XML::Mapping
+          
+          # the right ascension of the search cone's center in decimal degrees
+          object_node :pos, 'pos', :class => SkyPos, :optional => true
+          # the declination of the search cone's center in decimal degrees
+          object_node :size, 'size', :class => SkySize, :optional => true
+          
+          # the verbosity level to use where 0 means the bare
+          # minimum set of columns and 3 means the full set of available columns
+          numeric_node :verb, 'verb', :optional => true
+          
+          # any extra (particularly non-standard) parameters that must 
+          # be provided (apart from what is part of base URL given by 
+          # the accessURL element).
+          text_node :extras, 'extras', :optional => true
+        end
+        
+      end
+    end
+  end
+end

data/lib/voruby/resources/stsci.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'xml/mapping'
+
+require 'voruby/resources/loader'
+
+# STScI's registry uses the following resource versions...
+require 'voruby/resources/voresource/voresource_v0_10'
+require 'voruby/resources/vodataservice/vodataservice_v0_5'
+require 'voruby/resources/voregistry/voregistry_v0_3'
+require 'voruby/resources/conesearch/conesearch_v0_3'
+require 'voruby/resources/openskynode/openskynode_v0_1'
+require 'voruby/resources/sia/sia_v0_7'
+
+module VORuby
+  module Resources
+    module STScI
+      
+      # Forward declarations
+      class ArrayOfResource; end
+      
+      $ResourceUnmarshaller = Resources::namespace_dispatcher(
+        'VORuby::Resources::VOResource::V0_10', 'Resource', Resource
+      )
+      
+      class ArrayOfResource
+        include XML::Mapping
+
+        array_node :resources, 'Resource', :unmarshaller => $ResourceUnmarshaller, :optional => false, :default_value => []
+      end
+      
+      # STScI's registry has some quirks which we'd like to clean up a bit.
+      def self.clean(doc)
+        return STScI::remove_empty_elements(STScI::remove_invalid_ivo_ids(doc))
+      end
+
+      # STScI occasionally puts 'NOT PROVIDED' or '' in the ivo-id attribute of (in particular) the publisher element which is not valid.
+      # This removes the ivo-id in that situation.
+      def self.remove_invalid_ivo_ids(doc)
+        doc.elements.each('//*[@ivo-id="NOT PROVIDED" or @ivo-id=""]'){ |el|
+          el.delete_attribute('ivo-id')
+        }
+
+        return doc
+      end
+      
+      # Sometimes STScI puts empty elements (no attributes at all) into its resource definitions
+      # (particularly in the curation element). I don't think this is valid--if an element exists at all, it
+      # should have *some* kind of content.  Therefore I remove all elements who have no attributes and no children.
+      def self.remove_empty_elements(doc)
+        doc.elements.each('//*'){ |el|
+          el.parent.delete_element(el) if !el.has_attributes? and !el.has_elements? and !el.has_text?
+        }
+        
+        return doc
+      end
+      
+    end
+  end
+end

data/lib/voruby/resources/vodataservice/coverage_v0_2.rb

@@ -0,0 +1,195 @@
+require 'voruby/resources/vodataservice/loader'
+
+module VORuby
+  module Resources
+    module VODataServiceCoverage
+      module V0_2
+        
+        # Forward declarations
+        class Coverage < CoverageType; end
+        class SpatialType; end
+        class Spatial < SpatialType; end
+        class RegionType; end
+        class Region < RegionType; end
+        class AllSky < RegionType; end
+        class CoordFrameType; end
+        class CoordFrame < CoordFrameType; end
+        class CoordRangeType < RegionType; end
+        class CircleRegionType < RegionType; end
+        class CircleRegion < CirlceRegionType; end
+        class PositionType; end
+        class CenterPosition < PositionType; end
+        class SpatialResolution; end
+        class RegionOfRegard; end
+        class TemporalType; end
+        class Temporal < TemporalType; end
+        class StartTime; end
+        class EndTime; end
+        class TemporalResolution; end
+        class SpectralType; end
+        class Spectral < SpectralType; end
+        class WavebandType; end
+        class Waveband < WavebandType; end
+        class WavelengthRangeType; end
+        class WavelengthRange < WavelengthRangeType; end
+        class SpectralResolution; end
+        class MinMaxRange; end
+        
+        # Extent of the content of the resource over space, time, and frequency.
+        class Coverage; end
+        class CoverageType
+          include XML::Mapping
+          
+          object_node :spatial, 'Spatial', :class => Spatial, :optional => true
+          object_node :spectral, 'Spectral', :class => Spectral, :optional => true
+          object_node :temporal, 'Temporal', :class => Temporal, :optional => true
+        end
+        
+        # The spatial coverage of a resource.
+        class Spatial; end
+        class SpatialType
+          include XML::Mapping
+          
+          object_node :spatial_resolution, 'SpatialResolution', :class => SpatialResolution, :optional => true
+          object_node :region_of_regard, 'RegionOfRegard', :class => RegionOfRegard, :optional => true
+          
+          array_node :regions, 'Region', :class => Region, :optional => true, :default_value => []
+        end
+        
+        # A coverage area of the sky.
+        class Region; end
+        class RegionType
+          include XML::Mapping
+        end
+        
+        # A coverage area covering the entire sky.
+        class AllSky; end
+        
+        # A coordinate system frame.
+        class CoordFrame; end
+        class CoordFrameType
+          include XML::Mapping
+          
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['ICRS', 'FK5', 'FK4', 'ECL', 'GAL', 'SGAL']
+        end
+        
+        # A coverage area of the sky characterized by a range of longitude and latitude.
+        class CoordRange; end
+        class CoordRangeType
+          object_node :coord_frame, 'CoordFrame', :class => CoordFrame, :optional => false
+          object_node :long, 'long', :class => MinMaxRange, :optional => false
+          object_node :lat, 'lat', :class => MinMaxRange, :optional => false
+        end
+        
+        class MinMaxRange
+          require XML::Mapping
+          
+          numeric_node :min, 'min', :optional => false
+          numeric_node :max, 'max', :optional => false
+        end
+        
+        # A coverage area of the sky characterized by a central position and angular radius.
+        class CircleRegion; end
+        class CircleRegionType
+          numeric_node :radius, 'radius', :optional => false
+          
+          object_node :coord_frame, 'CoordFrame', :class => CoordFrame, :optional => false
+          object_node :center_position, 'CenterPosition', :class => CenterPosition, :optional => false
+        end
+        
+        # The position of the center of some region of the sky.
+        class CenterPosition; end
+        class PositionType
+          include XML::Mapping
+          
+          numeric_node :long, 'long', :optional => false
+          numeric_node :lat, 'lat', :optional => false
+        end
+        
+        # The spatial (angular) resolution that is typical of the observations of interest, in decimal degrees.
+        class SpatialResolution
+          include XML::Mapping
+          
+          numeric_node :value, '', :optional => false
+        end
+        
+        # The intrinsic size scale, given in arcseconds, associated with data items contained in a resource.
+        class RegionOfRegard
+          include XML::Mapping
+          
+          numeric_node :value, '', :optional => false
+        end
+        
+        # The temporal coverage of a resource.
+        class Temporal; end
+        class TemporalType
+          include XML::Mapping
+          
+          object_node :start_time, 'StartTime', :class => StartTime, :optional => true
+          object_node :end_time, 'EndTime', :class => EndTime, :optional => true
+          object_node :temporal_resolution, 'TemporalResolution', :class => TemporalResolution, :optional => true
+        end
+        
+        # The earliest temporal coverage of the resource.
+        class StartTime
+          include XML::Mapping
+          
+          date_time_node :value, '', :optional => false
+        end
+        
+        # The latest temporal coverage of the resource.
+        class EndTime
+          include XML::Mapping
+          
+          date_time_node :value, '', :optional => false
+        end
+        
+        # The temporal resolution that is typical of the observations of interest, in seconds.
+        class TemporalResolution
+          include XML::Mapping
+          
+          numeric_node :value, '', :optional => false
+        end
+        
+        # The spectral coverage of a resource.
+        class Spectral; end
+        class SpectralType
+          include XML::Mapping
+          
+          object_node :wavelength_range, 'WavelengthRange', :class => WavelengthRange, :optional => true
+          object_node :spectral_resolution, 'SpectralResolution', :class => SpectralResolution, :optional => true
+          
+          array_node :wavebands, 'Waveband', :class => Waveband, :optional => true, :default_value => []
+        end
+        
+        # A named spectral region of the electro-magnetic spectrum.
+        class Waveband; end
+        class WavebandType
+          include XML::Mapping
+          
+          text_enumeration_node :value, '', :optional => false,
+            :choices => ['Radio', 'Millimeter', 'Infrared', 'Optical', 'UV', 'EUV', 'X-ray', 'Gamma-ray']
+        end
+        
+        # A range of the electro-magnetic spectrum specified by a lower and upper wavelength limit.
+        class WavelengthRange; end
+        class WavelengthRangeType
+          include XML::Mapping
+          
+          numeric_node :min, 'min', :optional => false
+          numeric_node :max, 'max', :optional => false
+        end
+        
+        # The spectral resolution that is typical of the observations of interest, given as a ratio of the wavelength
+        # width (delta-lambda) to the observing wavelength (lambda).
+        class SpectralResolution
+          include XML::Mapping
+          
+          numeric_node :value, '', :optional => false
+        end
+        
+      end
+    end
+  end
+end