rcap 1.0.1 → 1.1.0

data/lib/rcap/cap_1_0/parameter.rb

@@ -0,0 +1,71 @@
+module RCAP
+  module CAP_1_0
+    # A Parameter object is valid if
+    # * it has a name
+    # * it has a value
+    class Parameter
+      include Validation
+
+      validates_presence_of( :name, :value )
+
+      attr_accessor( :name, :value )
+
+      XML_ELEMENT_NAME   = "parameter" # :nodoc:
+      NAME_ELEMENT_NAME  = "valueName" # :nodoc:
+      VALUE_ELEMENT_NAME = "value"     # :nodoc:
+
+      XPATH       = "cap:#{ XML_ELEMENT_NAME }"     # :nodoc:
+      NAME_XPATH  = "cap:#{ NAME_ELEMENT_NAME }"    # :nodoc:
+      VALUE_XPATH = "cap:#{ VALUE_ELEMENT_NAME }"   # :nodoc:
+
+      def initialize( attributes = {} )
+        @name = attributes[ :name ]
+        @value = attributes[ :value ]
+      end
+
+      def to_xml_element # :nodoc:
+        xml_element = REXML::Element.new( self.class::XML_ELEMENT_NAME )
+        xml_element.add_text( "#{ self.name }=#{ self.value }")
+        xml_element
+      end
+
+      def to_xml # :nodoc:
+        self.to_xml_element.to_s
+      end
+
+      def inspect # :nodoc:
+        "#{ self.name }: #{ self.value }"
+      end
+
+      # Returns a string representation of the parameter of the form
+      #  name: value
+      def to_s
+        self.inspect
+      end
+
+      def self.from_xml_element( parameter_xml_element ) # :nodoc:
+        self.new( self.parse_parameter( parameter_xml_element.text ))
+      end
+
+      # Two parameters are equivalent if they have the same name and value.
+      def ==( other )
+        [ self.name, self.value ] == [ other.name, other.value ]
+      end
+
+      def to_h # :nodoc:
+        RCAP.attribute_values_to_hash( [ self.name, self.value ])
+      end
+
+      def self.from_h( hash ) # :nodoc:
+        key = hash.keys.first
+        self.new( :name => key, :value => hash[ key ])
+      end
+
+      def self.parse_parameter( parameter_string ) # :nodoc:
+        name, value = parameter_string.split("=")
+        { :name  => name,
+          :value => value }
+      end
+    end
+  end
+end

data/lib/rcap/cap_1_0/point.rb

@@ -0,0 +1,55 @@
+module RCAP
+  module CAP_1_0
+    # A Point object is valid if
+    # * it has a lattitude within the minimum and maximum lattitude values
+    # * it has a longitude within the minimum and maximum longitude values
+    class Point
+      include Validation
+
+      MAX_LONGITUDE = 180
+      MIN_LONGITUDE = -180
+      MAX_LATTITUDE = 90
+      MIN_LATTITUDE= -90
+
+      attr_accessor( :lattitude )
+      attr_accessor( :longitude )
+
+      validates_numericality_of( :lattitude, :longitude )
+      validates_inclusion_of( :lattitude, :in => MIN_LATTITUDE..MAX_LATTITUDE )
+      validates_inclusion_of( :longitude, :in => MIN_LONGITUDE..MAX_LONGITUDE)
+
+      def initialize( attributes = {} )
+        @lattitude = attributes[ :lattitude ]
+        @longitude = attributes[ :longitude ]
+      end
+
+      # Returns a string representation of the point of the form
+      #  lattitude,longitude
+      def to_s
+        "#{ self.lattitude },#{ self.longitude }"
+      end
+
+      def inspect # :nodoc:
+        '('+self.to_s+')'
+      end
+
+      # Two points are equivalent if they have the same lattitude and longitude
+      def ==( other )
+        [ self.lattitude, self.longitude ] == [ other.lattitude, other.longitude ]
+      end
+
+      LATTITUDE_KEY = 'lattitude'  # :nodoc:
+      LONGITUDE_KEY = 'longitude'  # :nodoc:
+
+      def to_h # :nodoc:
+        RCAP.attribute_values_to_hash(
+          [ LATTITUDE_KEY, self.lattitude ],
+          [ LONGITUDE_KEY, self.longitude ])
+      end
+
+      def self.from_h( point_hash ) # :nodoc:
+        self.new( :lattitude => point_hash[ LATTITUDE_KEY ], :longitude => point_hash[ LONGITUDE_KEY ])
+      end
+    end
+  end
+end

data/lib/rcap/cap_1_0/polygon.rb

@@ -0,0 +1,89 @@
+module RCAP
+  module CAP_1_0
+    # A Polygon object is valid if
+    # * it has a minimum of three points
+    # * each Point object in the points collection is valid
+    class Polygon
+      include Validation
+
+      # Collection of Point objects.
+      attr_reader( :points )
+
+      validates_length_of( :points, :minimum => 3 )
+      validates_collection_of( :points )
+
+      XML_ELEMENT_NAME = 'polygon'                   # :nodoc:
+      XPATH            = "cap:#{ XML_ELEMENT_NAME }" # :nodoc:
+
+      def initialize( attributes = {})
+        @points = Array( attributes[ :points ])
+      end
+
+      # Creates a new Point object and adds it to the points array. The
+      # poitn_attributes are passed as a parameter to Point.new.
+      def add_point( point_attributes = {})
+        point = Point.new( point_attributes )
+        self.points << point
+        point
+      end
+
+      # Returns a string representation of the polygon of the form
+      #  points[0] points[1] points[2] ... points[n-1] points[0]
+      # where each point is formatted with Point#to_s
+      def to_s
+        (@points + [ @points.first ]).join( ' ' )
+      end
+
+      def inspect # :nodoc:
+        "(#{ @points.map{|point| point.inspect}.join(', ')})"
+      end
+
+      def to_xml_element # :nodoc:
+        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
+        xml_element.add_text( self.to_s )
+        xml_element
+      end
+
+      # Two polygons are equivalent if their collection of points is equivalent.
+      def ==( other )
+        self.points == other.points
+      end
+
+      def self.parse_polygon_string( polygon_string ) # :nodoc:
+        polygon_string.split( ' ' ).map{ |coordinate_string| coordinate_string.split( ',' ).map{|coordinate| coordinate.to_f }}
+      end
+
+      def self.from_xml_element( polygon_xml_element ) # :nodoc:
+        if !polygon_xml_element.text.nil? && !polygon_xml_element.text.empty?
+          coordinates = self.parse_polygon_string( polygon_xml_element.text )
+          points = coordinates.map{ |lattitude, longitude| Point.new( :lattitude => lattitude, :longitude => longitude )}[0..-2]
+          polygon = self.new( :points => points )
+        else
+          self.new
+        end
+      end
+
+
+      def to_yaml( options = {} ) # :nodoc:
+        yaml_points = self.points.map{ |point| [ point.lattitude, point.longitude ]}
+        def yaml_points.to_yaml_style; :inline; end
+
+        yaml_points.to_yaml( options )
+      end
+
+      def self.from_yaml_data( polygon_yaml_data ) # :nodoc:
+        self.new( :points => Array( polygon_yaml_data ).map{ |lattitude, longitude| Point.new( :lattitude => lattitude, :longitude => longitude )})
+      end
+
+      POINTS_KEY  = 'points' # :nodoc:
+
+      def to_h # :nodoc:
+        { POINTS_KEY => self.points.map{ |point| point.to_h }}
+      end
+
+      def self.from_h( polygon_hash ) # :nodoc:
+        self.new( :points => polygon_hash[ POINTS_KEY ].map{ |point_hash| Point.from_h( point_hash )})
+      end
+    end
+  end
+end

data/lib/rcap/cap_1_0/resource.rb

@@ -0,0 +1,132 @@
+module RCAP
+  module CAP_1_0
+    # A Resourse object is valid if
+    # * it has a resource description
+    class Resource
+      include Validation
+
+      # Resource Description
+      attr_accessor( :resource_desc )
+      attr_accessor( :mime_type )
+      # Expressed in bytes
+      attr_accessor( :size )
+      # Resource location
+      attr_accessor( :uri )
+      # SHA-1 hash of contents of resource
+      attr_accessor( :digest )
+
+      validates_presence_of( :resource_desc )
+
+      XML_ELEMENT_NAME           = 'resource'     # :nodoc:
+      MIME_TYPE_ELEMENT_NAME     = 'mimeType'     # :nodoc:
+      SIZE_ELEMENT_NAME          = 'size'         # :nodoc:
+      URI_ELEMENT_NAME           = 'uri'          # :nodoc:
+      DIGEST_ELEMENT_NAME        = 'digest'       # :nodoc:
+      RESOURCE_DESC_ELEMENT_NAME = 'resourceDesc' # :nodoc:
+
+      XPATH               = "cap:#{ XML_ELEMENT_NAME }"           # :nodoc:
+      MIME_TYPE_XPATH     = "cap:#{ MIME_TYPE_ELEMENT_NAME }"     # :nodoc:
+      SIZE_XPATH          = "cap:#{ SIZE_ELEMENT_NAME }"          # :nodoc:
+      URI_XPATH           = "cap:#{ URI_ELEMENT_NAME }"           # :nodoc:
+      DIGEST_XPATH        = "cap:#{ DIGEST_ELEMENT_NAME }"        # :nodoc:
+      RESOURCE_DESC_XPATH = "cap:#{ RESOURCE_DESC_ELEMENT_NAME }" # :nodoc:
+
+      def initialize( attributes = {} )
+        @mime_type     = attributes[ :mime_type ]
+        @size          = attributes[ :size ]
+        @uri           = attributes[ :uri ]
+        @digest        = attributes[ :digest ]
+        @resource_desc = attributes[ :resource_desc ]
+      end
+
+      def to_xml_element # :nodoc:
+        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
+        xml_element.add_element( RESOURCE_DESC_ELEMENT_NAME ).add_text( self.resource_desc )
+        xml_element.add_element( MIME_TYPE_ELEMENT_NAME ).add_text( self.mime_type ) if self.mime_type
+        xml_element.add_element( SIZE_ELEMENT_NAME ).add_text( self.size )           if self.size
+        xml_element.add_element( URI_ELEMENT_NAME ).add_text( self.uri )             if self.uri
+        xml_element.add_element( DIGEST_ELEMENT_NAME ).add_text( self.digest )       if self.digest
+        xml_element
+      end
+
+      # If size is defined returns the size in kilobytes
+      def size_in_kb
+        if self.size
+          self.size.to_f/1024
+        end
+      end
+
+      def to_xml # :nodoc:
+        self.to_xml_element.to_s
+      end
+
+      def inspect # :nodoc:
+        [ self.resource_desc, self.uri, self.mime_type, self.size ? format( "%.1fKB", self.size_in_kb ) : nil ].compact.join(' - ')
+      end
+
+      # Returns a string representation of the resource of the form
+      #  resource_desc
+      def to_s
+        self.resource_desc
+      end
+
+      def self.from_xml_element( resource_xml_element ) # :nodoc:
+        resource = self.new( :resource_desc => RCAP.xpath_text( resource_xml_element, RESOURCE_DESC_XPATH, Alert::XMLNS ),
+                            :uri           => RCAP.xpath_text( resource_xml_element, URI_XPATH, Alert::XMLNS ),
+                            :mime_type     => RCAP.xpath_text( resource_xml_element, MIME_TYPE_XPATH, Alert::XMLNS ),
+                            :size          => RCAP.xpath_text( resource_xml_element, SIZE_XPATH, Alert::XMLNS ),
+                            :digest        => RCAP.xpath_text( resource_xml_element, DIGEST_XPATH, Alert::XMLNS ))
+      end
+
+      RESOURCE_DESC_YAML = "Resource Description" # :nodoc:
+      URI_YAML           = "URI"                  # :nodoc:
+      MIME_TYPE_YAML     = "Mime Type"            # :nodoc:
+      SIZE_YAML          = "Size"                 # :nodoc:
+      DIGEST_YAML        = "Digest"               # :nodoc:
+
+      def to_yaml( options ) # :nodoc:
+        RCAP.attribute_values_to_hash(
+          [ RESOURCE_DESC_YAML, self.resource_desc ],
+          [ URI_YAML,           self.uri ],
+          [ MIME_TYPE_YAML,     self.mime_type ],
+          [ SIZE_YAML,          self.size ],
+          [ DIGEST_YAML,        self.digest ]
+        ).to_yaml( options )
+      end
+
+      def self.from_yaml_data( resource_yaml_data ) # :nodoc:
+        self.new(
+          :resource_desc => reource_yaml_data[ RESOURCE_DESC_YAML ],
+          :uri           => reource_yaml_data[ URI_YAML ],
+          :mime_type     => reource_yaml_data[ MIME_TYPE_YAML ],
+          :size          => reource_yaml_data[ SIZE_YAML ],
+          :digest        => reource_yaml_data[ DIGEST_YAML ]
+        )
+      end
+
+      RESOURCE_DESC_KEY = 'resource_desc' # :nodoc:
+      URI_KEY           = 'uri'           # :nodoc:
+      MIME_TYPE_KEY     = 'mime_type'     # :nodoc:
+      SIZE_KEY          = 'size'          # :nodoc:
+      DIGEST_KEY        = 'digest'        # :nodoc:
+
+      def to_h # :nodoc:
+        RCAP.attribute_values_to_hash(
+          [ RESOURCE_DESC_KEY, self.resource_desc ],
+          [ URI_KEY,           self.uri],
+          [ MIME_TYPE_KEY,     self.mime_type],
+          [ SIZE_KEY,          self.size ],
+          [ DIGEST_KEY,        self.digest ])
+      end
+
+      def self.from_h( resource_hash ) # :nodoc:
+        self.new(
+          :resource_desc => resource_hash[ RESOURCE_DESC_KEY ],
+          :uri           => resource_hash[ URI_KEY ],
+          :mime_type     => resource_hash[ MIME_TYPE_KEY ],
+          :size          => resource_hash[ SIZE_KEY ],
+          :digest        => resource_hash[ DIGEST_KEY ])
+      end
+    end
+  end
+end

data/lib/rcap/cap_1_1/event_code.rb

@@ -1,22 +1,8 @@
 module RCAP
   module CAP_1_1
     class EventCode < Parameter
-
       XML_ELEMENT_NAME = 'eventCode' # :nodoc:
-
       XPATH = "cap:#{ XML_ELEMENT_NAME }" # :nodoc:
-
-      def to_xml_element # :nodoc:
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_element( NAME_ELEMENT_NAME ).add_text( self.name )
-        xml_element.add_element( VALUE_ELEMENT_NAME ).add_text( self.value )
-        xml_element
-      end
-
-      def self.from_xml_element( event_code_xml_element ) # :nodoc:
-        EventCode.new( :name  => RCAP.xpath_text( event_code_xml_element, NAME_XPATH, Alert::XMLNS ),
-                      :value => RCAP.xpath_text( event_code_xml_element, VALUE_XPATH, Alert::XMLNS ))
-      end
     end
   end
 end

data/lib/rcap/cap_1_1/geocode.rb

@@ -1,22 +1,8 @@
 module RCAP
   module CAP_1_1
     class Geocode < Parameter
-
       XML_ELEMENT_NAME = 'geocode' # :nodoc:
-
       XPATH = "cap:#{ XML_ELEMENT_NAME }" # :nodoc:
-
-      def to_xml_element # :nodoc:
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_element( NAME_ELEMENT_NAME ).add_text( @name )
-        xml_element.add_element( VALUE_ELEMENT_NAME ).add_text( @value )
-        xml_element
-      end
-
-      def self.from_xml_element( geocode_xml_element ) # :nodoc:
-        self.new( :name  => RCAP.xpath_text( geocode_xml_element, NAME_XPATH, Alert::XMLNS ),
-                 :value => RCAP.xpath_text( geocode_xml_element, VALUE_XPATH, Alert::XMLNS ))
-      end
     end
   end
 end

data/lib/rcap/cap_1_1/parameter.rb

@@ -24,9 +24,9 @@ module RCAP
       end
 
       def to_xml_element # :nodoc:
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_element( NAME_ELEMENT_NAME ).add_text( self.name )
-        xml_element.add_element( VALUE_ELEMENT_NAME ).add_text( self.value )
+        xml_element = REXML::Element.new( self.class::XML_ELEMENT_NAME )
+        xml_element.add_element( self.class::NAME_ELEMENT_NAME ).add_text( self.name )
+        xml_element.add_element( self.class::VALUE_ELEMENT_NAME ).add_text( self.value )
         xml_element
       end
 
@@ -45,8 +45,8 @@ module RCAP
       end
 
       def self.from_xml_element( parameter_xml_element ) # :nodoc:
-        Parameter.new( :name  => RCAP.xpath_text( parameter_xml_element, NAME_XPATH, Alert::XMLNS ),
-                      :value => RCAP.xpath_text( parameter_xml_element, VALUE_XPATH, Alert::XMLNS ))
+        Parameter.new( :name  => RCAP.xpath_text( parameter_xml_element, self::NAME_XPATH, Alert::XMLNS ),
+                      :value => RCAP.xpath_text( parameter_xml_element, self::VALUE_XPATH, Alert::XMLNS ))
       end
 
       # Two parameters are equivalent if they have the same name and value.

data/lib/rcap/cap_1_1/resource.rb

@@ -134,11 +134,11 @@ module RCAP
       def self.from_h( resource_hash ) # :nodoc:
         self.new(
           :resource_desc => resource_hash[ RESOURCE_DESC_KEY ],
-          :uri => resource_hash[ URI_KEY ],
-          :mime_type => resource_hash[ MIME_TYPE_KEY ],
-          :deref_uri => resource_hash[ DEREF_URI_KEY ],
-          :size => resource_hash[ SIZE_KEY ],
-          :digest => resource_hash[ DIGEST_KEY ])
+          :uri           => resource_hash[ URI_KEY ],
+          :mime_type     => resource_hash[ MIME_TYPE_KEY ],
+          :deref_uri     => resource_hash[ DEREF_URI_KEY ],
+          :size          => resource_hash[ SIZE_KEY ],
+          :digest        => resource_hash[ DIGEST_KEY ])
       end
     end
   end

data/lib/rcap/cap_1_2/event_code.rb

@@ -1,22 +1,8 @@
 module RCAP
   module CAP_1_2
     class EventCode < Parameter
-
       XML_ELEMENT_NAME = 'eventCode' # :nodoc:
-
       XPATH = "cap:#{ XML_ELEMENT_NAME }" # :nodoc:
-
-      def to_xml_element # :nodoc:
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_element( NAME_ELEMENT_NAME ).add_text( self.name )
-        xml_element.add_element( VALUE_ELEMENT_NAME ).add_text( self.value )
-        xml_element
-      end
-
-      def self.from_xml_element( event_code_xml_element ) # :nodoc:
-        EventCode.new( :name  => RCAP.xpath_text( event_code_xml_element, NAME_XPATH, Alert::XMLNS ),
-                      :value => RCAP.xpath_text( event_code_xml_element, VALUE_XPATH, Alert::XMLNS ))
-      end
     end
   end
 end