rcap 0.1

data/lib/rcap/utilities.rb

@@ -0,0 +1,50 @@
+ALLOWED_CHARACTERS = /[^\s&<]+/ # :nodoc:
+
+class Array # :nodoc:
+  def to_s_for_cap
+    self.map{ |element| element.to_s.for_cap_list }.join( ' ' )
+  end
+end
+
+class String # :nodoc:
+  CAP_LIST_REGEX = /"([\w\s]+)"|(\S+)/
+  WHITESPACE_REGEX = /^\s+$/ 
+
+  def for_cap_list
+    if self =~ /\s/
+      '"'+self+'"'
+    else
+      self
+    end
+  end
+
+  def unpack_cap_list
+    self.split( CAP_LIST_REGEX ).reject{ |match| match == "" || match =~ WHITESPACE_REGEX }  
+  end
+end
+
+class DateTime # :nodoc:
+	alias inspect to_s
+  alias to_s_for_cap to_s
+end
+
+class Time # :nodoc:
+  def to_s_for_cap
+
+  end
+end
+
+module RCAP # :nodoc:
+	def self.xpath_text( xml_element, xpath ) 
+		element = self.xpath_first( xml_element, xpath )
+		element.text if element
+	end
+
+	def self.xpath_first( xml_element, xpath )
+		REXML::XPath.first( xml_element, xpath, { 'cap' => RCAP::XMLNS })
+	end
+
+	def self.xpath_match( xml_element, xpath )
+		REXML::XPath.match( xml_element, xpath, { 'cap' => RCAP::XMLNS })
+	end
+end

data/lib/rcap/validations.rb

@@ -0,0 +1,116 @@
+module Validation  # :nodoc: 
+  module ClassMethods # :nodoc:
+
+		NUMBER_RE  = /^-{0,1}\d*\.{0,1}\d+$/
+		INTEGER_RE = /\-{0,1}A[+-]?\d+\Z/
+
+    def validates_inclusion_of( *attributes )
+      options = { 
+        :message => 'is not in the required range' 
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, value|
+        next if ( value.nil? && options[ :allow_nil ]) || ( value.blank? && options[ :allow_blank ])
+        unless options[ :in ].include?( value )
+          object.errors[ attribute ] << options[ :message ]
+        end
+      end
+    end
+
+    def validates_inclusion_of_members_of( *attributes )
+      options = {
+        :message => 'contains members that are not valid'
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, collection|
+        next if ( collection.nil? && options[ :allow_nil ]) || (collection.blank? && options[ :allow_blank ])
+        unless collection.all?{ |member| options[ :in ].include?( member )}
+          object.errors[ attribute ] << options[ :message ]
+        end
+      end
+    end
+
+    def validates_length_of_members_of( *attributes )
+      options = {
+        :message => 'contains members with incorrect length'
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, collection|
+        next if ( collection.nil? && options[ :allow_nil ]) || (collection.blank? && options[ :allow_blank ])
+        unless options[ :minimum ] && collection.length >= options[ :minimum ]
+          object.errors[ attribute ] << options[ :message ]
+        end
+      end
+    end
+
+    def validates_validity_of( *attributes )
+      options = {
+        :message => 'is not valid'
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, value|
+        next if ( value.nil? && options[ :allow_nil ]) || ( value.blank? && options[ :allow_blank ])
+        unless value && value.valid?
+          object.errors[ attribute ] << options[ :message ]
+        end
+      end
+    end
+
+    def validates_collection_of( *attributes )
+      options = {
+        :message => 'contains an invalid element'
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, collection|
+        next if ( collection.nil? && options[ :allow_nil ]) || ( collection.blank? && options[ :allow_blank ])
+        unless collection.all?{ |element| element.valid? }
+          object.errors[ attribute ] << options[ :message ]
+        end
+      end
+    end
+
+    def validates_dependency_of( *attributes )
+      options = {
+        :message => 'is dependent on :attribute being defined'
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, value|
+        contingent_on_value = object.send( options[ :on ])
+        next if ( value.nil? && options[ :allow_nil ]) || ( value.blank? && options[ :allow_blank ])
+        unless value.blank? || !value.blank? && !contingent_on_value.blank? && ( options[ :with_value ].nil? || contingent_on_value == options[ :with_value ])
+          object.errors[ attribute ] << options[ :message ].gsub( /:attribute/, options[ :on ].to_s )
+        end
+      end
+    end
+
+		def validates_numericality_of( *attributes )
+			options = {
+				:message => 'is not a number',
+			}.merge!(attributes.extract_options!)
+
+			re = options[:only_integer] ? INTEGER_RE : NUMBER_RE
+
+			validates_each( *attributes ) do |object, attribute, value|
+				next if (value.nil? && options[ :allow_nil ]) || (value.blank? && options[ :allow_blank ])
+				unless ( value.to_s =~ re ) &&
+					( options[ :greater_than ].nil? || value && value > options[ :greater_than ])
+					object.errors[ attribute ] << options[ :message ] 
+				end
+			end
+		end
+
+
+    def validates_responsiveness_of( *attributes )
+      options = {
+        :message => 'does not respond to the given method'
+      }.merge!( attributes.extract_options! )
+
+      validates_each( *attributes ) do |object, attribute, value|
+        next if ( collection.nil? && options[ :allow_nil ]) || ( collection.blank? && options[ :allow_blank ])
+        unless options[ :to ].all?{ |method_name| object.respond_to?( method_name )}
+          object.errors[ attribute ] << options [ :message ]
+        end
+      end
+    end
+  end
+end

data/spec/alert_spec.rb

@@ -0,0 +1,132 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Alert ) do
+  context( 'on initialisation' ) do
+    before( :each )  do
+      @alert = RCAP::Alert.new
+    end
+
+    it( 'should have a default identifier' ){ @alert.identifier.should_not( be_nil )}
+    it( 'should not have a sender' ){ @alert.sender.should( be_nil )}
+    it( 'should have a default sent time' ){ @alert.sent.should_not( be_nil )}
+    it( 'should not have a status' ){ @alert.status.should( be_nil )}
+    it( 'should not have a scope' ){ @alert.scope.should( be_nil )}
+    it( 'should not have a source'){ @alert.source.should( be_nil )}
+    it( 'should not have a restriction'){ @alert.restriction.should( be_nil )}
+    it( 'should not have any addresses' ){ @alert.addresses.should( be_empty )}
+    it( 'should not have a code' ){ @alert.code.should( be_nil )}
+    it( 'should not have a note' ){ @alert.note.should( be_nil )}
+    it( 'should not have any references' ){ @alert.references.should( be_empty )}
+    it( 'should not have any incidents' ){ @alert.incidents.should( be_empty )}
+    it( 'should not have any infos' ){ @alert.infos.should( be_empty )}
+
+		context( 'from XML' ) do
+			before( :each ) do
+				@original_alert = RCAP::Alert.new( :sender => 'Sender',
+													 :status => RCAP::Alert::STATUS_TEST,
+													 :scope => RCAP::Alert::SCOPE_PUBLIC,
+													 :source => 'Source',
+													 :restriction => 'No Restriction',
+													 :addresses => [ 'Address 1', 'Address 2'],
+													 :code => 'Code',
+													 :note => 'Note',
+													 :references => [ RCAP::Alert.new( :sender => 'Sender1' ).to_reference, RCAP::Alert.new( :sender => 'Sender2' ).to_reference ],
+													 :incidents => [ 'Incident1', 'Incident2' ],
+													 :infos => [ RCAP::Info.new, RCAP::Info.new ])
+				@xml_string = @original_alert.to_xml
+				@xml_document = REXML::Document.new( @xml_string )
+				@alert_element = @xml_document.root
+				@alert = RCAP::Alert.from_xml_element( @alert_element )
+			end
+
+			it( 'should parse identifier correctly' ){ @alert.identifier.should == @original_alert.identifier }
+			it( 'should parse sender correctly' ){ @alert.sender.should == @original_alert.sender }
+			it( 'should parse sent correctly' ){ @alert.sent.should( be_close( @original_alert.sent, Rational( 1, 86400 )))}
+			it( 'should parse status correctly' ){ @alert.status.should == @original_alert.status }
+			it( 'should parse msg_type correctly' ){ @alert.msg_type.should == @original_alert.msg_type }
+			it( 'should parse source correctly' ){ @alert.source.should == @original_alert.source }
+			it( 'should parse scope correctly' ){ @alert.scope.should == @original_alert.scope }
+			it( 'should parse restriction correctly' ){ @alert.restriction.should == @original_alert.restriction }
+			it( 'should parse addresses correctly' ){ @alert.addresses.should == @original_alert.addresses }
+			it( 'should parse code correctly' ){ @alert.code.should == @original_alert.code }
+			it( 'should parse note correctly' ){ @alert.note.should == @original_alert.note }
+			it( 'should parse references correctly' ){ @alert.references.should == @original_alert.references }
+      it( 'should parse incidents correctly' ){ @alert.incidents.should == @original_alert.incidents }
+      it( 'should parse infos correctly' ) do 
+        @alert.infos.size.should == @original_alert.infos.size 
+        @alert.infos.each{ |info| info.class.should == RCAP::Info }
+      end
+    end
+  end
+
+  describe( 'is not valid if it' ) do
+    before( :each ) do
+      @alert = RCAP::Alert.new( :sender => "cap@tempuri.org",
+                              :status => RCAP::Alert::STATUS_TEST,
+                              :msg_type => RCAP::Alert::MSG_TYPE_ALERT,
+                              :scope => RCAP::Alert::SCOPE_PUBLIC )
+      @alert.should( be_valid )
+    end
+
+    it( 'does not have a identifier' ) do
+      @alert.identifier = nil
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a sender' ) do
+      @alert.sender = nil
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a sent time (sent)' ) do
+      @alert.sent = nil
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a status' ) do
+      @alert.status = nil
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a message type (msg_type)' ) do
+      @alert.msg_type = nil
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a scope' ) do
+      @alert.scope = nil
+      @alert.should_not( be_valid )
+    end
+
+
+    it( 'does not have a valid status' ) do
+      @alert.status = 'incorrect value'
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a valid message type msg_type' ) do
+      @alert.msg_type = 'incorrect value'
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have a valid scope' ) do
+      @alert.scope = 'incorrect value'
+      @alert.should_not( be_valid )
+    end
+
+
+    context( 'has an info element and it' ) do
+      it( 'is not valid' ) do
+        @info = RCAP::Info.new( :event => 'Info Event',
+                              :categories => RCAP::Info::CATEGORY_GEO,
+                              :urgency => RCAP::Info::URGENCY_IMMEDIATE,
+                              :severity => RCAP::Info::SEVERITY_EXTREME,
+                              :certainty => RCAP::Info::CERTAINTY_OBSERVED )
+        @info.event = nil
+        @alert.infos << @info
+        @info.should_not( be_valid )
+        @alert.should_not( be_valid )
+      end
+    end
+  end
+end

data/spec/area_spec.rb

@@ -0,0 +1,120 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Area ) do
+	context( 'on initialisation' ) do
+		before( :each ) do
+			@area = RCAP::Area.new
+		end
+
+		# Atomic
+		it( 'should not have a area_desc' ){ @area.area_desc.should( be_nil )}
+		it( 'should not have a altitude' ){ @area.altitude.should( be_nil )}
+		it( 'should not have a ceiling' ){ @area.ceiling.should( be_nil )}
+		
+		# Group
+		it( 'should have an empty polygons' ){ @area.polygons.should( be_empty )}
+		it( 'should have an empty circles' ){ @area.circles.should( be_empty )}
+		it( 'should have an empty geocodes' ){ @area.geocodes.should( be_empty )}
+
+		context( 'from XML' ) do
+			before( :each ) do
+				@original_area = RCAP::Area.new( :area_desc => 'Area Description',
+																			 :altitude => 100,
+																			 :ceiling => 200,
+																			 :circles => RCAP::Circle.new( :point => RCAP::Point.new( :lattitude => 0, :longitude => 0 ), :radius => 100 ),
+																			 :geocodes => RCAP::Geocode.new( :name => 'name', :value => 'value' ),
+																			 :polygons => RCAP::Polygon.new( :points => RCAP::Point.new( :lattitude =>1, :longitude => 1 ))) 
+
+				@alert = RCAP::Alert.new( :infos => RCAP::Info.new( :areas => @original_area ))
+				@xml_string = @alert.to_xml
+				@xml_document = REXML::Document.new( @xml_string )
+				@info_xml_element = RCAP.xpath_first( @xml_document.root, RCAP::Info::XPATH )
+				@area_xml_element = RCAP.xpath_first( @info_xml_element, RCAP::Area::XPATH )
+				@area = RCAP::Area.from_xml_element( @area_xml_element )
+			end
+
+			it( 'should parse the area_desc correctly' ) do
+				@area.area_desc.should == @original_area.area_desc
+			end
+
+			it( 'should parse the altitude correctly' ) do
+				@area.altitude.should == @original_area.altitude
+			end
+
+			it( 'should parse the ceiling correctly' ) do
+				@area.ceiling.should == @original_area.ceiling
+			end
+			
+			it( 'should parse the circles correctly' ) do
+				@area.circles.should == @original_area.circles
+			end
+
+			it( 'should parse the geocodes correctly' ) do
+				@area.geocodes.should == @original_area.geocodes
+			end
+
+			it( 'should parse the polygons correctly' ) do
+				@area.polygons.should == @original_area.polygons
+			end
+		end
+	end
+
+  context( 'is not valid if' ) do
+    before( :each ) do
+      @area = RCAP::Area.new( :area_desc => "Cape Town Metropole" )
+      @area.should( be_valid )
+    end
+
+    it( 'does not have an area descrtiption (area_desc)') do
+      @area.area_desc = nil
+      @area.should_not( be_valid )
+    end
+
+    it( 'has a ceiling defined but no altitude' ) do
+      @area.ceiling = 1
+      @area.altitude = nil
+      @area.should_not( be_valid )
+    end
+
+    context( 'it contains circles and it' ) do
+      before( :each ) do
+        @area.circles << RCAP::Circle.new( :point => RCAP::Point.new( :lattitude => 0, :longitude => 0 ), :radius => 1)
+        @area.should( be_valid )
+      end
+
+      it( 'has an invalid circle' ) do
+        @area.circles.first.point.lattitude = nil
+        @area.should_not( be_valid )
+      end
+    end
+
+    context( 'it contains polygons and it' ) do
+      before( :each ) do
+        @polygon = RCAP::Polygon.new
+        @polygon.points.push( RCAP::Point.new( :lattitude => 0, :longitude => 0 ),
+                             RCAP::Point.new( :lattitude => 0, :longitude => 1 ),
+                             RCAP::Point.new( :lattitude => 1, :longitude => 0 ))
+        @area.polygons << @polygon
+        @area.should( be_valid )
+      end
+
+      it( 'has an invalid polygon' ) do
+        @polygon.points.first.lattitude = nil
+        @area.should_not( be_valid )
+      end
+    end
+
+    context( 'it contains geocodes and it' ) do
+      before( :each ) do
+        @geocode = RCAP::Geocode.new( :name => 'foo', :value => 'bar' )
+        @area.geocodes << @geocode
+        @area.should( be_valid )
+      end
+
+      it( 'has an invalid geocode' ) do
+        @geocode.value = nil
+        @area.should_not( be_valid )
+      end
+    end
+  end
+end

data/spec/circle_spec.rb

@@ -0,0 +1,59 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Circle ) do
+  describe( 'should not be valid if' ) do
+    before( :each ) do
+      @circle = RCAP::Circle.new( :point => RCAP::Point.new( :lattitude => 0, :longitude => 0 ), :radius => 1 )
+      @circle.should( be_valid )
+    end
+
+    it( 'does not have a point defined' ) do
+      @circle.point = nil
+      @circle.should_not( be_valid )
+    end
+    
+    it( 'does not have a valid point' ) do
+      @circle.point.longitude = nil
+      @circle.should_not( be_valid )
+    end
+    it( 'does not have a radius defined' ) do
+      @circle.radius = nil
+      @circle.should_not( be_valid )
+    end
+
+    it( 'does not have a numeric radius' ) do
+      @circle.radius = "not a number"
+      @circle.should_not( be_valid )
+    end
+
+    it( 'does not have a positive radius' ) do
+      @circle.radius = -1
+      @circle.should_not( be_valid )
+    end
+  end
+
+	context( 'on initialisation' ) do
+		context( 'from XML' ) do
+			before( :each ) do
+				@original_circle = RCAP::Circle.new( :radius => 10.5,
+																					 :point => RCAP::Point.new( :lattitude => 30, :longitude => 60 ))
+				@alert = RCAP::Alert.new( :infos => RCAP::Info.new( :areas => RCAP::Area.new( :circles => @original_circle )))
+				@xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+				@info_element = RCAP.xpath_first( @xml_document.root, RCAP::Info::XPATH )
+				@area_element = RCAP.xpath_first( @info_element, RCAP::Area::XPATH )
+				@circle_element = RCAP.xpath_first( @area_element, RCAP::Circle::XPATH )
+				@circle = RCAP::Circle.from_xml_element( @circle_element )
+			end
+
+			it( 'should parse the radius correctly' ) do
+				@circle.radius.should == @original_circle.radius
+			end
+
+			it( 'should parse the point correctly' ) do
+				@circle.point.lattitude.should == @original_circle.point.lattitude
+				@circle.point.longitude.should == @original_circle.point.longitude
+			end
+		end
+	end
+end