rcap 1.0.1 → 1.1.0

data/spec/cap_1_0/parameter_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_0::Parameter ) do
+  context( 'when initialised' ) do
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_parameter = RCAP::CAP_1_0::Parameter.new( :name => 'name', :value => 'value' )
+        @alert = RCAP::CAP_1_0::Alert.new( :infos => RCAP::CAP_1_0::Info.new( :parameters => @original_parameter ))
+        @xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @info_xml_element = RCAP.xpath_first( @xml_document.root, RCAP::CAP_1_0::Info::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @parameter_xml_element = RCAP.xpath_first( @info_xml_element, RCAP::CAP_1_0::Parameter::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @parameter = RCAP::CAP_1_0::Parameter.from_xml_element( @parameter_xml_element )
+      end
+
+      it( 'should parse the name correctly' ) do
+        @parameter.name.should == @original_parameter.name
+      end
+
+      it( 'should parse the value correctly' ) do
+        @parameter.value.should == @original_parameter.value
+      end
+    end
+  end
+
+  context( 'when exported' ) do
+    before( :each ) do
+      @parameter = RCAP::CAP_1_0::Parameter.new( :name => 'name', :value => 'value' )
+    end
+
+    context( 'to a hash' ) do
+      it( 'should export correctly' ) do
+        @parameter.to_h.should == { 'name' => 'value' }
+      end
+    end
+  end
+
+  describe( '.parse_parameter' ) do
+    it( 'should parse the content correctly' ) do
+      RCAP::CAP_1_0::Parameter.parse_parameter( "name=value" ).should == { :name => 'name', :value => 'value' }
+    end
+  end
+
+  describe( '.to_xml_element' ) do
+    before( :each ) do
+      @parameter = RCAP::CAP_1_0::Parameter.new( :name => 'name', :value => 'value' )
+    end
+
+    it( 'should generate an XML element correctly' ) do
+      @parameter.to_xml_element.text.should == 'name=value'
+    end
+  end
+
+  describe( '.from_xml_element' ) do
+    before( :each ) do
+      @parameter = RCAP::CAP_1_0::Parameter.new( :name => 'name', :value => 'value' )
+    end
+
+    it( 'should initialise correctly' ) do
+      parameter = RCAP::CAP_1_0::Parameter.from_xml_element( @parameter.to_xml_element )
+      parameter.name.should == @parameter.name
+      parameter.value.should == @parameter.value
+    end
+  end
+end

data/spec/cap_1_0/point_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_0::Point ) do
+  describe( 'is not valid if' ) do
+    before( :each ) do
+      @point = RCAP::CAP_1_0::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::CAP_1_0::Point::MAX_LONGITUDE + 1
+      @point.should_not( be_valid )
+      @point.longitude = RCAP::CAP_1_0::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::CAP_1_0::Point::MAX_LATTITUDE + 1
+      @point.should_not( be_valid )
+      @point.lattitude = RCAP::CAP_1_0::Point::MIN_LATTITUDE - 1
+      @point.should_not( be_valid )
+    end
+  end
+
+  context( 'when exported' ) do
+    before( :each ) do
+      @point = RCAP::CAP_1_0::Point.new( :lattitude => 1, :longitude => 1 )
+    end
+
+    context( 'to hash' ) do
+      it( 'should export correctly' ) do
+        @point.to_h.should == { RCAP::CAP_1_0::Point::LATTITUDE_KEY => 1, RCAP::CAP_1_0::Point::LONGITUDE_KEY => 1 }
+      end
+    end
+  end
+end

data/spec/cap_1_0/polygon_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_0::Polygon ) do
+  describe( 'is not valid if it' ) do
+    before( :each ) do
+      @polygon = RCAP::CAP_1_0::Polygon.new
+      3.times do
+        @polygon.points << RCAP::CAP_1_0::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_0::Polygon.new( :points => Array.new(3){|i| RCAP::CAP_1_0::Point.new( :lattitude => i, :longitude => i )})
+        @empty_original_polygon = RCAP::CAP_1_0::Polygon.new()
+        @alert = RCAP::CAP_1_0::Alert.new( :infos => RCAP::CAP_1_0::Info.new( :areas => RCAP::CAP_1_0::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_0::Info::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @area_element = RCAP.xpath_first( @info_element, RCAP::CAP_1_0::Area::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @polygon_element = RCAP.xpath_first( @area_element, RCAP::CAP_1_0::Polygon::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @polygon = RCAP::CAP_1_0::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_0::Polygon::XPATH, RCAP::CAP_1_0::Alert::XMLNS )[1]
+        empty_polygon = RCAP::CAP_1_0::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_0::Polygon.new( :points => Array.new(3){|i| RCAP::CAP_1_0::Point.new( :lattitude => i, :longitude => i )})
+      end
+
+      it( 'should load all the points' ) do
+        @new_polygon = RCAP::CAP_1_0::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_0::Polygon.new( :points => Array.new(3){|i| RCAP::CAP_1_0::Point.new( :lattitude => i, :longitude => i )})
+    end
+
+    context( 'to a hash' ) do
+      it( 'should export correctly' ) do
+        @polygon.to_h.should == { RCAP::CAP_1_0::Polygon::POINTS_KEY => @polygon.points.map{ |point| point.to_h }}
+      end
+    end
+  end
+
+  describe( 'instance methods' ) do
+    before( :each ) do
+      @polygon = RCAP::CAP_1_0::Polygon.new
+    end
+
+    describe( '#add_point' ) do
+      before( :each ) do
+        @point = @polygon.add_point( lattitude: 1, longitude: 1 )
+      end
+
+      it( 'should return a 1.0 Point' ) do
+        @point.class.should == RCAP::CAP_1_0::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/cap_1_0/resource_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_0::Resource ) do
+  context( 'on initialisation' ) do
+    before( :each ) do
+      @resource = RCAP::CAP_1_0::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 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::CAP_1_0::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.size          = "20480"
+        @original_resource.digest        = "2048"
+
+        @alert = RCAP::CAP_1_0::Alert.new( :infos => RCAP::CAP_1_0::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::CAP_1_0::Info::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @resource_element = RCAP.xpath_first( @info_element, RCAP::CAP_1_0::Resource::XPATH, RCAP::CAP_1_0::Alert::XMLNS )
+        @resource_element.should_not( be_nil )
+        @resource = RCAP::CAP_1_0::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 size correctly' ) do
+        @resource.size.should == @original_resource.size
+      end
+
+      it( 'should parse digest correctly' ) do
+        @resource.digest.should == @original_resource.digest
+      end
+    end
+
+
+    context( 'from a hash' ) do
+      before( :each ) do
+        @original_resource = RCAP::CAP_1_0::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.size          = "20480"
+        @original_resource.digest        = "2048"
+
+        @resource = RCAP::CAP_1_0::Resource.from_h( @original_resource.to_h )
+      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 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( 'when exported' ) do
+    before( :each ) do
+      @resource = RCAP::CAP_1_0::Resource.new
+      @resource.resource_desc = "Image of incident"
+      @resource.uri           = "http://capetown.gov.za/cap/resources/image.png"
+      @resource.mime_type     = 'image/png'
+      @resource.size          = "20480"
+      @resource.digest        = "2048"
+    end
+
+    context( 'to a hash' ) do
+      before( :each ) do
+        @resource_hash = @resource.to_h
+      end
+
+      it( 'should set the resource description' ) do
+        @resource_hash[ RCAP::CAP_1_0::Resource::RESOURCE_DESC_KEY ].should == @resource.resource_desc
+      end
+
+      it( 'should set the mime type' ) do
+        @resource_hash[ RCAP::CAP_1_0::Resource::MIME_TYPE_KEY ].should == @resource.mime_type
+      end
+
+      it( 'should set the size' ) do
+        @resource_hash[ RCAP::CAP_1_0::Resource::SIZE_KEY ].should == @resource.size
+      end
+
+      it( 'should set the URI' ) do
+        @resource_hash[ RCAP::CAP_1_0::Resource::URI_KEY ].should == @resource.uri
+      end
+
+      it( 'should set the digest' ) do
+        @resource_hash[ RCAP::CAP_1_0::Resource::DIGEST_KEY ].should == @resource.digest
+      end
+    end
+  end
+
+  context( 'which is valid' ) do
+    before( :each ) do
+      @resource = RCAP::CAP_1_0::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/cap_1_1/event_code_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_1::EventCode ) do
+  context( 'when initialised' ) do
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_event_code = RCAP::CAP_1_1::EventCode.new( :name => 'name', :value => 'value' )
+        @alert = RCAP::CAP_1_1::Alert.new( :infos => RCAP::CAP_1_1::Info.new( :event_codes => @original_event_code ))
+        @xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @info_xml_element = RCAP.xpath_first( @xml_document.root, RCAP::CAP_1_1::Info::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @event_code_xml_element = RCAP.xpath_first( @info_xml_element, RCAP::CAP_1_1::EventCode::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @event_code = RCAP::CAP_1_1::EventCode.from_xml_element( @event_code_xml_element )
+      end
+
+      it( 'should parse the name correctly' ) do
+        @event_code.name.should == @original_event_code.name
+      end
+
+      it( 'should parse the value correctly' ) do
+        @event_code.value.should == @original_event_code.value
+      end
+    end
+  end
+
+  context( 'when exported' ) do
+    before( :each ) do
+      @event_code = RCAP::CAP_1_1::EventCode.new( :name => 'name', :value => 'value' )
+    end
+
+    context( 'to a hash' ) do
+      it( 'should export correctly' ) do
+        @event_code.to_h.should == { 'name' => 'value' }
+      end
+    end
+  end
+end
+

data/spec/cap_1_1/parameter_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_1::Parameter ) do
+  context( 'when initialised' ) do
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_parameter = RCAP::CAP_1_1::Parameter.new( :name => 'name', :value => 'value' )
+        @alert = RCAP::CAP_1_1::Alert.new( :infos => RCAP::CAP_1_1::Info.new( :parameters => @original_parameter ))
+        @xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @info_xml_element = RCAP.xpath_first( @xml_document.root, RCAP::CAP_1_1::Info::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @parameter_xml_element = RCAP.xpath_first( @info_xml_element, RCAP::CAP_1_1::Parameter::XPATH, RCAP::CAP_1_1::Alert::XMLNS )
+        @parameter = RCAP::CAP_1_1::Parameter.from_xml_element( @parameter_xml_element )
+      end
+
+      it( 'should parse the name correctly' ) do
+        @parameter.name.should == @original_parameter.name
+      end
+
+      it( 'should parse the value correctly' ) do
+        @parameter.value.should == @original_parameter.value
+      end
+    end
+  end
+
+  context( 'when exported' ) do
+    before( :each ) do
+      @parameter = RCAP::CAP_1_1::Parameter.new( :name => 'name', :value => 'value' )
+    end
+
+    context( 'to a hash' ) do
+      it( 'should export correctly' ) do
+        @parameter.to_h.should == { 'name' => 'value' }
+      end
+    end
+  end
+end

data/spec/cap_1_2/event_code_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe( RCAP::CAP_1_2::EventCode ) do
+  context( 'when initialised' ) do
+    context( 'from XML' ) do
+      before( :each ) do
+        @original_event_code = RCAP::CAP_1_2::EventCode.new( :name => 'name', :value => 'value' )
+        @alert = RCAP::CAP_1_2::Alert.new( :infos => RCAP::CAP_1_2::Info.new( :event_codes => @original_event_code ))
+        @xml_string = @alert.to_xml
+        @xml_document = REXML::Document.new( @xml_string )
+        @info_xml_element = RCAP.xpath_first( @xml_document.root, RCAP::CAP_1_2::Info::XPATH, RCAP::CAP_1_2::Alert::XMLNS )
+        @event_code_xml_element = RCAP.xpath_first( @info_xml_element, RCAP::CAP_1_2::EventCode::XPATH, RCAP::CAP_1_2::Alert::XMLNS )
+        @event_code = RCAP::CAP_1_2::EventCode.from_xml_element( @event_code_xml_element )
+      end
+
+      it( 'should parse the name correctly' ) do
+        @event_code.name.should == @original_event_code.name
+      end
+
+      it( 'should parse the value correctly' ) do
+        @event_code.value.should == @original_event_code.value
+      end
+    end
+  end
+
+  context( 'when exported' ) do
+    before( :each ) do
+      @event_code = RCAP::CAP_1_2::EventCode.new( :name => 'name', :value => 'value' )
+    end
+
+    context( 'to a hash' ) do
+      it( 'should export correctly' ) do
+        @event_code.to_h.should == { 'name' => 'value' }
+      end
+    end
+  end
+end
+