rcap 0.1

data/spec/geocode_spec.rb

@@ -0,0 +1,26 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Geocode ) do
+  context( 'when initialised' ) do
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_geocode = RCAP::Geocode.new( :name => 'name', :value => 'value' )
+        @alert = RCAP::Alert.new( :infos => RCAP::Info.new( :areas => RCAP::Area.new( :geocodes => @original_geocode )))
+        @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 )
+				@geocode_xml_element = RCAP.xpath_first( @area_xml_element, RCAP::Geocode::XPATH )
+				@geocode = RCAP::Geocode.from_xml_element( @geocode_xml_element )
+      end
+
+      it( 'should parse the name correctly' ) do
+        @geocode.name.should == @original_geocode.name
+      end
+
+      it( 'should parse the value correctly' ) do
+        @geocode.value.should == @original_geocode.value
+      end
+    end
+  end
+end

data/spec/info_spec.rb

@@ -0,0 +1,119 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Info ) do
+  context( 'on initialisation' ) do
+    before( :each ) do
+      @info = RCAP::Info.new
+    end
+
+    it( 'should have a default language of en-US' ) { @info.language.should == 'en-US' }
+    it( 'should have no categories' )               { @info.categories.should( be_empty )}
+    it( 'should have no event' )                    { @info.event.should( be_nil )}
+    it( 'should have no response types' )           { @info.response_types.should( be_empty )}
+    it( 'should have no urgency' )                  { @info.urgency.should( be_nil )}
+    it( 'should have no severity' )                 { @info.severity.should( be_nil )}
+    it( 'should have no certainty' )                { @info.certainty.should( be_nil )}
+    it( 'should have no audience' )                 { @info.audience.should( be_nil )}
+    it( 'should have no event_codes' )              { @info.event_codes.should( be_empty )}
+    it( 'should have no effective datetime' )       { @info.effective.should( be_nil )}
+    it( 'should have no onset datetime' )           { @info.onset.should( be_nil )}
+    it( 'should have no expires datetime' )         { @info.expires.should( be_nil )}
+    it( 'should have no sender name ' )             { @info.sender_name.should( be_nil )}
+    it( 'should have no headline' )                 { @info.headline.should( be_nil )}
+    it( 'should have no description' )              { @info.description.should( be_nil )}
+    it( 'should have no instruction' )              { @info.instruction.should( be_nil )}
+    it( 'should have no web' )                      { @info.web.should( be_nil )}
+    it( 'should have no contact' )                  { @info.contact.should( be_nil )}
+    it( 'should have no parameters' )               { @info.parameters.should( be_empty )}
+
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_info = RCAP::Info.new( :categories     => [ RCAP::Info::CATEGORY_GEO, RCAP::Info::CATEGORY_FIRE ],
+                                        :event          => 'Event Description',
+                                        :response_types => [ RCAP::Info::RESPONSE_TYPE_MONITOR, RCAP::Info::RESPONSE_TYPE_ASSESS ],
+                                        :urgency        => RCAP::Info::URGENCY_IMMEDIATE,
+                                        :severity       => RCAP::Info::SEVERITY_EXTREME,
+                                        :certainty      => RCAP::Info::CERTAINTY_OBSERVED,
+                                        :audience       => 'Audience',
+                                        :effective      => DateTime.now,
+                                        :onset          => DateTime.now + 1,
+                                        :expires        => DateTime.now + 2,
+                                        :sender_name    => 'Sender Name',
+                                        :headline       => 'Headline',
+                                        :description    => 'Description',
+                                        :instruction    => 'Instruction',
+                                        :web            => 'http://website',
+                                        :contact        => 'contact@address',
+                                        :event_codes => [ RCAP::EventCode.new( :name => 'name1', :value => 'value1' ),
+                                                          RCAP::EventCode.new( :name => 'name2', :value => 'value2' )],
+                                        :parameters => [ RCAP::Parameter.new( :name => 'name1', :value => 'value1' ),
+                                                         RCAP::Parameter.new( :name => 'name2', :value => 'value2' )],
+                                        :areas => [ RCAP::Area.new( :area_desc => 'Area1' ),
+                                          RCAP::Area.new( :area_desc => 'Area2' )]
+                                      )
+        @alert = RCAP::Alert.new( :infos => @original_info )
+				@xml_string = @alert.to_xml
+				@xml_document = REXML::Document.new( @xml_string )
+        @info = RCAP::Info.from_xml_element( RCAP.xpath_first( @xml_document.root, RCAP::Info::XPATH ))
+      end
+      it( 'should parse categories correctly' ){     @info .categories.should     ==    @original_info.categories }
+      it( 'should parse event correctly' ){          @info .event.should          ==    @original_info.event }
+      it( 'should parse response_types correctly' ){ @info .response_types.should ==    @original_info.response_types }
+      it( 'should parse urgency correctly' ){        @info .urgency.should        ==    @original_info.urgency }
+      it( 'should parse severity correctly' ){       @info .severity.should       ==    @original_info.severity }
+      it( 'should parse certainty correctly' ){      @info .certainty.should      ==    @original_info.certainty }
+      it( 'should parse audience correctly' ){       @info .audience.should       ==    @original_info.audience }
+      it( 'should parse effective correctly' ){      @info .effective.should( be_close( @original_info.effective, Rational( 1, 86400 )))}
+      it( 'should parse onset correctly' ){          @info .onset.should( be_close(     @original_info.onset, Rational( 1, 86400 )))}
+      it( 'should parse expires correctly' ){        @info .expires.should( be_close(   @original_info.expires, Rational( 1, 86400 )))}
+      it( 'should parse sender_name correctly' ){    @info .sender_name.should    ==    @original_info.sender_name }
+      it( 'should parse headline correctly' ){       @info .headline.should       ==    @original_info.headline }
+      it( 'should parse description correctly' ){    @info .description.should    ==    @original_info.description }
+      it( 'should parse instruction correctly' ){    @info .instruction.should    ==    @original_info.instruction }
+      it( 'should parse web correctly' ){            @info .web.should            ==    @original_info.web }
+      it( 'should parse contact correctly' ){        @info .contact.should        ==    @original_info.contact }
+      it( 'should parse event_codes correctly' ){    @info .event_codes.should    ==    @original_info.event_codes }
+      it( 'should parse parameters correctly' ){     @info .parameters.should     ==    @original_info.parameters }
+      it( 'should parse resources correctly' ){      @info .resources.should      ==    @original_info.resources }
+      it( 'should parse areas correctly' ){          @info .areas.should          ==    @original_info.areas }
+    end
+  end
+
+  context( 'is not valid if it' ) do
+    before( :each ) 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.valid?
+      puts @info.errors.full_messages
+      @info.should( be_valid )
+    end
+    
+    it( 'does not have an event' ) do
+      @info.event = nil
+      @info.should_not( be_valid )
+    end
+
+    it( 'does not have categories' ) do
+      @info.categories.clear
+      @info.should_not( be_valid )
+    end
+
+    it( 'does not have an urgency' ) do
+      @info.urgency = nil
+      @info.should_not( be_valid )
+    end
+
+    it( 'does not have an severity' ) do
+      @info.severity = nil
+      @info.should_not( be_valid )
+    end
+
+    it( 'does not have an certainty' ) do
+      @info.certainty = nil
+      @info.should_not( be_valid )
+    end
+  end
+end

data/spec/point_spec.rb

@@ -0,0 +1,34 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Point ) do
+  describe( 'is not valid if' ) do
+    before( :each ) do
+      @point = RCAP::Point.new( :lattitude => 0, :longitude => 0 )
+      @point.should( be_valid )
+    end
+
+    it( 'does not have a longitude defined' ) do
+      @point.longitude = nil
+      @point.should_not( be_valid )
+    end
+
+    it( 'does not have a valid longitude' ) do
+      @point.longitude = RCAP::Point::MAX_LONGITUDE + 1
+      @point.should_not( be_valid )
+      @point.longitude = RCAP::Point::MIN_LONGITUDE - 1
+      @point.should_not( be_valid )
+    end
+
+    it( 'does not have a lattitude defined' ) do
+      @point.lattitude = nil
+      @point.should_not( be_valid )
+    end
+
+    it( 'does not have a valid lattitude' ) do
+      @point.lattitude = RCAP::Point::MAX_LATTITUDE + 1
+      @point.should_not( be_valid )
+      @point.lattitude = RCAP::Point::MIN_LATTITUDE - 1
+      @point.should_not( be_valid )
+    end
+  end
+end

data/spec/polygon_spec.rb

@@ -0,0 +1,45 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Polygon ) do
+  describe( 'is not valid if it' ) do
+    before( :each ) do
+      @polygon = RCAP::Polygon.new
+      3.times do
+        @polygon.points << RCAP::Point.new( :lattitude => 0, :longitude => 0 )
+      end
+      @polygon.should( be_valid )
+    end
+
+    it( 'does not have any points' ) do
+      @polygon.points.clear
+      @polygon.should_not( be_valid )
+    end
+
+    it( 'does not have a valid collection of points' ) do
+      @polygon.points.first.lattitude = nil
+      @polygon.should_not( be_valid )
+    end
+  end
+
+  context( 'on initialization' ) do
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_polygon = RCAP::Polygon.new( :points => Array.new(3){|i| RCAP::Point.new( :lattitude => i, :longitude => i )})
+        @alert = RCAP::Alert.new( :infos => RCAP::Info.new( :areas => RCAP::Area.new( :polygons => @original_polygon )))
+        @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 )
+        @polygon_element = RCAP.xpath_first( @area_element, RCAP::Polygon::XPATH )
+        @polygon = RCAP::Polygon.from_xml_element( @polygon_element )
+      end
+
+      it( 'should parse all the points' ) do
+        @polygon.points.zip( @original_polygon.points ).each do |point, original_point|
+          point.lattitude.should == original_point.lattitude
+          point.longitude.should == original_point.longitude
+        end
+      end
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,74 @@
+require 'spec/spec_helper'
+
+describe( RCAP::Resource ) do
+  context( 'on initialisation' ) do
+    before( :each ) do
+      @resource = RCAP::Resource.new
+    end
+
+    it( 'should have no mime_type' ){ @resource.mime_type.should( be_nil )}    
+    it( 'should have no size' ){ @resource.size.should( be_nil )}         
+    it( 'should have no uri' ){ @resource.uri.should( be_nil )}          
+    it( 'should have no deref_uri' ){ @resource.deref_uri.should( be_nil )}    
+    it( 'should have no digest' ){ @resource.digest.should( be_nil )}       
+    it( 'should have no resource_desc' ){ @resource.resource_desc.should( be_nil )}
+
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_resource = RCAP::Resource.new
+        @original_resource.resource_desc = "Image of incident"
+        @original_resource.uri           = "http://capetown.gov.za/cap/resources/image.png"
+        @original_resource.mime_type     = 'image/png'
+        @original_resource.deref_uri     = "IMAGE DATA"
+        @original_resource.size          = "20480"
+        @original_resource.digest        = "2048"
+
+        @alert = RCAP::Alert.new( :infos => RCAP::Info.new( :resources => @original_resource ))
+        @xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @info_element = RCAP.xpath_first( @xml_document.root, RCAP::Info::XPATH )
+				@resource_element = RCAP.xpath_first( @info_element, RCAP::Resource::XPATH )
+        @resource_element.should_not( be_nil )
+        @resource = RCAP::Resource.from_xml_element( @resource_element )
+      end
+
+      it( 'should parse resource_desc correctly' ) do
+        @resource.resource_desc.should == @original_resource.resource_desc
+      end
+
+      it( 'should parse uri correctly' ) do
+        @resource.uri.should == @original_resource.uri
+      end
+
+      it( 'should parse mime_type correctly' ) do
+        @resource.mime_type.should == @original_resource.mime_type
+      end
+
+      it( 'should parse deref_uri correctly' ) do
+        @resource.deref_uri.should == @original_resource.deref_uri
+      end
+
+      it( 'should parse size correctly' ) do
+        @resource.size.should == @original_resource.size
+      end
+
+      it( 'should parse digest correctly' ) do
+        @resource.digest.should == @original_resource.digest
+      end
+    end
+  end
+
+  context( 'which is valid' ) do
+    before( :each ) do
+      @resource = RCAP::Resource.new( :resource_desc => 'Resource Description' )
+      @resource.should( be_valid )
+    end
+
+    describe( 'should not be valid if it' ) do
+      it( 'does not have a resource description (resource_desc)' ) do
+        @resource.resource_desc = nil
+        @resource.should_not( be_valid )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'lib/rcap'
+
+def random_circle_hash
+  { :lattitude => rand( 360 ) - 180,
+    :longitude => rand( 180 ) - 90,
+    :radius => rand( 50 ) }
+end

data/spec/utilities_spec.rb

@@ -0,0 +1,57 @@
+require 'spec/spec_helper'
+
+describe( Array ) do
+  describe( 'to_s_for_cap' ) do
+    context( 'with an element containing white space' ) do
+      before( :all ) do
+        @list = [ 'one', 'white space', 'three' ]
+      end
+
+      it( 'should format the list correctly' ) do
+        @list.to_s_for_cap.should == 'one "white space" three'
+      end
+    end
+
+    context( 'without an element containing white space' ) do
+      before( :all ) do
+        @list = [ 'one', 'two', 'three' ]
+      end
+      it( 'should format the list correctly' ) do
+        @list.to_s_for_cap.should == 'one two three'
+      end
+    end
+  end
+end
+
+describe( String ) do
+  describe( 'for_cap_list' ) do
+    context( 'with white space' ) do
+      before( :all ) do
+        @string = 'white space'
+      end
+
+      it( 'should format the string correctly' ) do
+        @string.for_cap_list.should == '"white space"'
+      end
+    end
+
+    context( 'without white space' ) do
+      before( :all ) do
+        @string= 'one'
+      end
+      it( 'should format the string correctly' ) do
+        @string.for_cap_list.should == 'one'
+      end
+    end
+  end
+
+  describe( 'unpack_cap_list' ) do
+    it( 'shoud unpack strings in quotes correctly' ) do
+      'Item1 "Item 2" Item3'.unpack_cap_list.should == [ "Item1", "Item 2", "Item3" ]
+    end
+
+    it( 'should unpack strings correclty' ) do
+      'Item1 Item2 Item3'.unpack_cap_list.should == [ "Item1", "Item2", "Item3" ]
+    end
+  end
+end

data/spec/validations_spec.rb

@@ -0,0 +1,95 @@
+require 'spec/spec_helper'
+
+class ObjectWithValidatesCollection
+  include Validation
+  attr_accessor( :collection )
+  validates_collection_of( :collection )
+  def initialize
+    @collection = []
+  end
+end
+
+class DependencyObject
+  include Validation
+  attr_accessor( :dependent_value, :contingent_value )
+  validates_dependency_of( :dependent_value, :on => :contingent_value )
+end
+
+class DependencyWithObject
+  include Validation
+  attr_accessor( :dependent_value, :contingent_value )
+  validates_dependency_of( :dependent_value, :on => :contingent_value, :with_value => true )
+end
+
+describe( Validation::ClassMethods ) do
+  describe( 'validates_collection_of' ) do
+    before( :each ) do
+      @object_with_collection = ObjectWithValidatesCollection.new
+    end
+
+    it( 'should be valid if all the members are valid' ) do
+      @object_with_collection.collection = Array.new(3){ RCAP::Point.new( :lattitude => 0, :longitude => 0 )}
+      @object_with_collection.should( be_valid )
+    end
+
+    it( 'should not be valid some of the members are invalid' ) do
+      @object_with_collection.collection = Array.new( 2 ){ RCAP::Point.new( :lattitude => 0, :longitude => 0 )} + [ RCAP::Point.new( :lattitude => "not a number", :longitude => 0)]
+      @object_with_collection.should_not( be_valid )
+    end
+  end
+
+  describe( 'validates_dependency_of' ) do
+    context( 'without :with_value' ) do
+      before( :each ) do
+        @object = DependencyObject.new
+        @object.dependent_value = true
+        @object.contingent_value = true
+        @object.should( be_valid )
+      end
+
+      it( 'should not be valid if the contigent value is nil' ) do
+        @object.contingent_value = nil
+        @object.should_not( be_valid )
+      end
+      it( 'should be valid if the dependent value is nil' ) do
+        @object.dependent_value = nil
+        @object.should( be_valid )
+      end
+      it( 'should be valid if both are nil' ) do
+        @object.dependent_value = nil
+        @object.contingent_value = nil
+        @object.should( be_valid )
+      end
+    end
+
+    context( 'with :with_value' ) do
+      before( :each ) do
+        @object = DependencyWithObject.new
+        @object.dependent_value = true
+        @object.contingent_value = true
+        @object.should( be_valid )
+      end
+
+      it( 'should not be valid if the contigent value is nil' ) do
+        @object.contingent_value = nil
+        @object.should_not( be_valid )
+      end
+
+      it( 'should not be valid if the contingent value is not the required value' ) do
+        @object.contingent_value = 0
+        @object.should_not( be_valid )
+      end
+
+      it( 'should be valid if the dependent value is nil' ) do
+        @object.dependent_value = nil
+        @object.should( be_valid )
+      end
+
+      it( 'should be valid if both are nil' ) do
+        @object.dependent_value = nil
+        @object.contingent_value = nil
+        @object.should( be_valid )
+      end
+    end
+  end
+end