rcap 0.4 → 1.0.0.rc.1

data/spec/{point_spec.rb → cap_1_1/point_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe( RCAP::Point ) do
+describe( RCAP::CAP_1_1::Point ) do
   describe( 'is not valid if' ) do
     before( :each ) do
-      @point = RCAP::Point.new( :lattitude => 0, :longitude => 0 )
+      @point = RCAP::CAP_1_1::Point.new( :lattitude => 0, :longitude => 0 )
       @point.should( be_valid )
     end
 
@@ -13,9 +13,9 @@ describe( RCAP::Point ) do
     end
 
     it( 'does not have a valid longitude' ) do
-      @point.longitude = RCAP::Point::MAX_LONGITUDE + 1
+      @point.longitude = RCAP::CAP_1_1::Point::MAX_LONGITUDE + 1
       @point.should_not( be_valid )
-      @point.longitude = RCAP::Point::MIN_LONGITUDE - 1
+      @point.longitude = RCAP::CAP_1_1::Point::MIN_LONGITUDE - 1
       @point.should_not( be_valid )
     end
 
@@ -25,21 +25,21 @@ describe( RCAP::Point ) do
     end
 
     it( 'does not have a valid lattitude' ) do
-      @point.lattitude = RCAP::Point::MAX_LATTITUDE + 1
+      @point.lattitude = RCAP::CAP_1_1::Point::MAX_LATTITUDE + 1
       @point.should_not( be_valid )
-      @point.lattitude = RCAP::Point::MIN_LATTITUDE - 1
+      @point.lattitude = RCAP::CAP_1_1::Point::MIN_LATTITUDE - 1
       @point.should_not( be_valid )
     end
   end
 
   context( 'when exported' ) do
     before( :each ) do
-      @point = RCAP::Point.new( :lattitude => 1, :longitude => 1 )
+      @point = RCAP::CAP_1_1::Point.new( :lattitude => 1, :longitude => 1 )
     end
 
     context( 'to hash' ) do
       it( 'should export correctly' ) do
-        @point.to_h.should == { RCAP::Point::LATTITUDE_KEY => 1, RCAP::Point::LONGITUDE_KEY => 1 }
+        @point.to_h.should == { RCAP::CAP_1_1::Point::LATTITUDE_KEY => 1, RCAP::CAP_1_1::Point::LONGITUDE_KEY => 1 }
       end
     end
   end

data/spec/cap_1_1/polygon_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_1::Polygon ) do
+  describe( 'is not valid if it' ) do
+    before( :each ) do
+      @polygon = RCAP::CAP_1_1::Polygon.new
+      3.times do
+        @polygon.points << RCAP::CAP_1_1::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::CAP_1_1::Polygon.new( :points => Array.new(3){|i| RCAP::CAP_1_1::Point.new( :lattitude => i, :longitude => i )})
+        @empty_original_polygon = RCAP::CAP_1_1::Polygon.new()
+        @alert = RCAP::CAP_1_1::Alert.new( :infos => RCAP::CAP_1_1::Info.new( :areas => RCAP::CAP_1_1::Area.new( :polygons => [@original_polygon, @empty_original_polygon] )))
+        @xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @info_element = RCAP.xpath_first( @xml_document.root, RCAP::CAP_1_1::Info::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @area_element = RCAP.xpath_first( @info_element, RCAP::CAP_1_1::Area::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @polygon_element = RCAP.xpath_first( @area_element, RCAP::CAP_1_1::Polygon::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @polygon = RCAP::CAP_1_1::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
+
+      it 'should allow empty polygon xml elements' do
+        empty_polygon_element = RCAP.xpath_match( @area_element, RCAP::CAP_1_1::Polygon::XPATH, RCAP::CAP_1_1::Alert::XMLNS )[1]
+        empty_polygon = RCAP::CAP_1_1::Polygon.from_xml_element( empty_polygon_element )
+        empty_polygon.should == @empty_original_polygon
+      end
+    end
+
+    context( 'from a hash' ) do
+      before( :each ) do
+        @polygon = RCAP::CAP_1_1::Polygon.new( :points => Array.new(3){|i| RCAP::CAP_1_1::Point.new( :lattitude => i, :longitude => i )})
+      end
+
+      it( 'should load all the points' ) do
+        @new_polygon = RCAP::CAP_1_1::Polygon.from_h( @polygon.to_h )
+        @new_polygon.points.should == @polygon.points
+      end
+    end
+  end
+
+  context( 'when exported' ) do
+    before( :each ) do
+      @polygon = RCAP::CAP_1_1::Polygon.new( :points => Array.new(3){|i| RCAP::CAP_1_1::Point.new( :lattitude => i, :longitude => i )})
+    end
+
+    context( 'to a hash' ) do
+      it( 'should export correctly' ) do
+        @polygon.to_h.should == { RCAP::CAP_1_1::Polygon::POINTS_KEY => @polygon.points.map{ |point| point.to_h }}
+      end
+    end
+  end
+
+  describe( 'instance methods' ) do
+    before( :each ) do
+      @polygon = RCAP::CAP_1_1::Polygon.new
+    end
+
+    describe( '#add_point' ) do
+      before( :each ) do
+        @point = @polygon.add_point( lattitude: 1, longitude: 1 )
+      end
+
+      it( 'should return a 1.1 Point' ) do
+        @point.class.should == RCAP::CAP_1_1::Point
+        @point.lattitude.should == 1
+        @point.longitude.should == 1
+      end
+
+      it( 'should add a Point to the points attribute' ) do
+        @polygon.points.size.should == 1
+      end
+    end
+  end
+end

data/spec/{resource_spec.rb → cap_1_1/resource_spec.rb}

@@ -1,21 +1,21 @@
 require 'spec_helper'
 
-describe( RCAP::Resource ) do
+describe( RCAP::CAP_1_1::Resource ) do
   context( 'on initialisation' ) do
     before( :each ) do
-      @resource = RCAP::Resource.new
+      @resource = RCAP::CAP_1_1::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 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 = RCAP::CAP_1_1::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'
@@ -23,13 +23,13 @@ describe( RCAP::Resource ) do
         @original_resource.size          = "20480"
         @original_resource.digest        = "2048"
 
-        @alert = RCAP::Alert.new( :infos => RCAP::Info.new( :resources => @original_resource ))
+        @alert = RCAP::CAP_1_1::Alert.new( :infos => RCAP::CAP_1_1::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 )
+        @info_element = RCAP.xpath_first( @xml_document.root, RCAP::CAP_1_1::Info::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @resource_element = RCAP.xpath_first( @info_element, RCAP::CAP_1_1::Resource::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
         @resource_element.should_not( be_nil )
-        @resource = RCAP::Resource.from_xml_element( @resource_element )
+        @resource = RCAP::CAP_1_1::Resource.from_xml_element( @resource_element )
       end
 
       it( 'should parse resource_desc correctly' ) do
@@ -60,7 +60,7 @@ describe( RCAP::Resource ) do
 
     context( 'from a hash' ) do
       before( :each ) do
-        @original_resource = RCAP::Resource.new
+        @original_resource = RCAP::CAP_1_1::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'
@@ -68,7 +68,7 @@ describe( RCAP::Resource ) do
         @original_resource.size          = "20480"
         @original_resource.digest        = "2048"
 
-        @resource = RCAP::Resource.from_h( @original_resource.to_h )
+        @resource = RCAP::CAP_1_1::Resource.from_h( @original_resource.to_h )
       end
 
       it( 'should parse resource_desc correctly' ) do
@@ -100,7 +100,7 @@ describe( RCAP::Resource ) do
 
   context( 'when exported' ) do
     before( :each ) do
-      @resource = RCAP::Resource.new
+      @resource = RCAP::CAP_1_1::Resource.new
       @resource.resource_desc = "Image of incident"
       @resource.uri           = "http://capetown.gov.za/cap/resources/image.png"
       @resource.mime_type     = 'image/png'
@@ -115,34 +115,34 @@ describe( RCAP::Resource ) do
       end
 
       it( 'should set the resource description' ) do
-        @resource_hash[ RCAP::Resource::RESOURCE_DESC_KEY ].should == @resource.resource_desc
+        @resource_hash[ RCAP::CAP_1_1::Resource::RESOURCE_DESC_KEY ].should == @resource.resource_desc
       end
 
       it( 'should set the mime type' ) do
-        @resource_hash[ RCAP::Resource::MIME_TYPE_KEY ].should == @resource.mime_type
+        @resource_hash[ RCAP::CAP_1_1::Resource::MIME_TYPE_KEY ].should == @resource.mime_type
       end
 
       it( 'should set the size' ) do
-        @resource_hash[ RCAP::Resource::SIZE_KEY ].should == @resource.size
+        @resource_hash[ RCAP::CAP_1_1::Resource::SIZE_KEY ].should == @resource.size
       end
 
       it( 'should set the URI' ) do
-        @resource_hash[ RCAP::Resource::URI_KEY ].should == @resource.uri
+        @resource_hash[ RCAP::CAP_1_1::Resource::URI_KEY ].should == @resource.uri
       end
 
       it( 'should set the dereferenced URI' ) do
-        @resource_hash[ RCAP::Resource::DEREF_URI_KEY ].should == @resource.deref_uri
-      end 
+        @resource_hash[ RCAP::CAP_1_1::Resource::DEREF_URI_KEY ].should == @resource.deref_uri
+      end
 
       it( 'should set the digest' ) do
-        @resource_hash[ RCAP::Resource::DIGEST_KEY ].should == @resource.digest
-      end 
+        @resource_hash[ RCAP::CAP_1_1::Resource::DIGEST_KEY ].should == @resource.digest
+      end
     end
   end
 
   context( 'which is valid' ) do
     before( :each ) do
-      @resource = RCAP::Resource.new( :resource_desc => 'Resource Description' )
+      @resource = RCAP::CAP_1_1::Resource.new( :resource_desc => 'Resource Description' )
       @resource.should( be_valid )
     end
 

data/spec/cap_1_2/alert_spec.rb

@@ -0,0 +1,233 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_2::Alert ) do
+  context( 'on initialisation' ) do
+    before( :each )  do
+      @alert = RCAP::CAP_1_2::Alert.new
+    end
+
+    it( 'should not have a identifier' ){ @alert.identifier.should( be_nil )}
+    it( 'should not have a sender' ){ @alert.sender.should( be_nil )}
+    it( 'should not have a sent time' ){ @alert.sent.should( 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 any codes' ){ @alert.codes.should( be_empty )}
+    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 )}
+
+    shared_examples_for( "a successfully parsed CAP 1.2 alert" ) do
+      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_within( 1 ).of( @original_alert.sent ))}
+      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 codes correctly' )      { @alert.codes              == @original_alert.codes }
+      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::CAP_1_2::Info }
+      end
+    end
+
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_alert = RCAP::CAP_1_2::Alert.new( :sender      => 'Sender',
+                                                    :sent        => DateTime.now,
+                                                    :status      => RCAP::CAP_1_2::Alert::STATUS_TEST,
+                                                    :scope       => RCAP::CAP_1_2::Alert::SCOPE_PUBLIC,
+                                                    :source      => 'Source',
+                                                    :restriction => 'No Restriction',
+                                                    :addresses   => [ 'Address 1', 'Address 2'],
+                                                    :codes       => [ 'Code1', 'Code2' ],
+                                                    :note        => 'Note',
+                                                    :references  => [ RCAP::CAP_1_2::Alert.new( :sender => 'Sender1' ).to_reference, RCAP::CAP_1_2::Alert.new( :sender => 'Sender2' ).to_reference ],
+                                                    :incidents   => [ 'Incident1', 'Incident2' ],
+                                                    :infos       => [ RCAP::CAP_1_2::Info.new, RCAP::CAP_1_2::Info.new ])
+        @xml_string = @original_alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @alert_element = @xml_document.root
+        @alert = RCAP::CAP_1_2::Alert.from_xml_element( @alert_element )
+      end
+
+      it_should_behave_like( "a successfully parsed CAP 1.2 alert" )
+
+    end
+
+    context( 'from YAML' ) do
+      before( :each ) do
+        @original_alert = RCAP::CAP_1_2::Alert.new( :sender      => 'Sender',
+                                                    :sent        => DateTime.now,
+                                                    :status      => RCAP::CAP_1_2::Alert::STATUS_TEST,
+                                                    :scope       => RCAP::CAP_1_2::Alert::SCOPE_PUBLIC,
+                                                    :source      => 'Source',
+                                                    :restriction => 'No Restriction',
+                                                    :addresses   => [ 'Address 1', 'Address 2'],
+                                                    :codes       => [ 'Code1', 'Code2' ],
+                                                    :note        => 'Note',
+                                                    :references  => [ RCAP::CAP_1_2::Alert.new( :sender => 'Sender1' ).to_reference, RCAP::CAP_1_2::Alert.new( :sender => 'Sender2' ).to_reference ],
+                                                    :incidents   => [ 'Incident1', 'Incident2' ],
+                                                    :infos       => [ RCAP::CAP_1_2::Info.new, RCAP::CAP_1_2::Info.new ])
+        @yaml_string = @original_alert.to_yaml
+        @alert = RCAP::CAP_1_2::Alert.from_yaml( @yaml_string )
+      end
+
+      it_should_behave_like( "a successfully parsed CAP 1.2 alert" )
+    end
+
+    context( 'from a hash' ) do
+      before( :each ) do
+        @original_alert = RCAP::CAP_1_2::Alert.new( :sender      => 'Sender',
+                                                    :sent        => DateTime.now,
+                                                    :status      => RCAP::CAP_1_2::Alert::STATUS_TEST,
+                                                    :scope       => RCAP::CAP_1_2::Alert::SCOPE_PUBLIC,
+                                                    :source      => 'Source',
+                                                    :restriction => 'No Restriction',
+                                                    :addresses   => [ 'Address 1', 'Address 2'],
+                                                    :codes       => [ 'Code1', 'Code2' ],
+                                                    :note        => 'Note',
+                                                    :references  => [ RCAP::CAP_1_2::Alert.new( :sender => 'Sender1' ).to_reference, RCAP::CAP_1_2::Alert.new( :sender => 'Sender2' ).to_reference ],
+                                                    :incidents   => [ 'Incident1', 'Incident2' ],
+                                                    :infos       => [ RCAP::CAP_1_2::Info.new, RCAP::CAP_1_2::Info.new ])
+        @alert = RCAP::CAP_1_2::Alert.from_h( @original_alert.to_h )
+      end
+
+      it_should_behave_like( "a successfully parsed CAP 1.2 alert" )
+    end
+
+    context( 'from JSON' ) do
+      before( :each ) do
+        @original_alert = RCAP::CAP_1_2::Alert.new( :sender      => 'Sender',
+                                                    :sent        => DateTime.now,
+                                                    :status      => RCAP::CAP_1_2::Alert::STATUS_TEST,
+                                                    :scope       => RCAP::CAP_1_2::Alert::SCOPE_PUBLIC,
+                                                    :source      => 'Source',
+                                                    :restriction => 'No Restriction',
+                                                    :addresses   => [ 'Address 1', 'Address 2'],
+                                                    :codes       => [ 'Code1', 'Code2' ],
+                                                    :note        => 'Note',
+                                                    :references  => [ RCAP::CAP_1_2::Alert.new( :sender => 'Sender1' ).to_reference, RCAP::CAP_1_2::Alert.new( :sender => 'Sender2' ).to_reference ],
+                                                    :incidents   => [ 'Incident1', 'Incident2' ],
+                                                    :infos       => [ RCAP::CAP_1_2::Info.new, RCAP::CAP_1_2::Info.new ])
+        @alert = RCAP::CAP_1_2::Alert.from_json( @original_alert.to_json )
+      end
+
+      it_should_behave_like( "a successfully parsed CAP 1.2 alert" )
+    end
+  end
+
+  describe( 'is not valid if it' ) do
+    before( :each ) do
+      @alert = RCAP::CAP_1_2::Alert.new( :identifier => 'Identifier',
+                                         :sender     => "cap@tempuri.org",
+                                         :sent       => DateTime.now,
+                                         :status     => RCAP::CAP_1_2::Alert::STATUS_TEST,
+                                         :msg_type   => RCAP::CAP_1_2::Alert::MSG_TYPE_ALERT,
+                                         :scope      => RCAP::CAP_1_2::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
+
+    it( 'does not have a restriction with a Restricted scope' ) do
+      @alert.scope = RCAP::CAP_1_2::Alert::SCOPE_RESTRICTED
+      @alert.restriction = nil
+      @alert.should_not( be_valid )
+    end
+
+    it( 'does not have any addresses with a Private scope' ) do
+      @alert.scope = RCAP::CAP_1_2::Alert::SCOPE_PRIVATE
+      @alert.addresses.clear
+      @alert.should_not( be_valid )
+    end
+
+    context( 'has an info element and it' ) do
+      it( 'is not valid' ) do
+        @info = RCAP::CAP_1_2::Info.new( :event => 'Info Event',
+                              :categories => RCAP::CAP_1_2::Info::CATEGORY_GEO,
+                              :urgency => RCAP::CAP_1_2::Info::URGENCY_IMMEDIATE,
+                              :severity => RCAP::CAP_1_2::Info::SEVERITY_EXTREME,
+                              :certainty => RCAP::CAP_1_2::Info::CERTAINTY_OBSERVED )
+        @info.event = nil
+        @alert.infos << @info
+        @info.should_not( be_valid )
+        @alert.should_not( be_valid )
+      end
+    end
+  end
+
+  describe( 'instance methods' ) do
+    before( :each ) do
+      @alert = RCAP::CAP_1_2::Alert.new
+    end
+
+    describe( '#add_info' ) do
+      before( :each ) do
+        @info = @alert.add_info( :urgency => 'urgent' )
+        @info.urgency.should == 'urgent'
+      end
+
+      it( 'should return a CAP 1.2 Info object' ) do
+        @info.class.should == RCAP::CAP_1_2::Info
+      end
+
+      it( 'should add an Info object to the infos array' ) do
+        @alert.infos.size.should == 1
+      end
+    end
+  end
+end