rcap 1.2.0 → 1.2.1

data/.gitignore

@@ -5,3 +5,4 @@ tags
 *.gem
 .bundle
 Gemfile.lock
+.yardoc

data/CHANGELOG.rdoc

@@ -1,5 +1,13 @@
 = Change Log
 
+== 1.2.1 - 27 October 2011
+
+* Fixed bug initialising 'audience' attribute in Info class 
+* Added CAP/Atom files from Google CAP Library project into specs 
+* Organised extension code into separate file
+* Modifed RCAP::Alert.from_xml to auto-detect the XML namespace and CAP version. Will default to CAP 1.2 if no
+namespace is found.
+
 == 1.2.0 - 17 July 2011
 
 * CAP 1.1 and CAP 1.2 - Resource#dereference_uri! fetches data from Resource#uri and sets Resource#deref_uri 

data/Rakefile

@@ -1,10 +1,12 @@
+require 'rubygems'
 require 'bundler'
-require 'hanna/rdoctask'
+
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
 
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.main = 'README.rdoc'
   rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'lib/**/*.rb')
   rdoc.rdoc_dir = 'doc'

data/lib/extensions/array.rb

@@ -0,0 +1,5 @@
+class Array # :nodoc:
+  def to_s_for_cap
+    self.map{ |element| element.to_s.for_cap_list }.join( ' ' )
+  end
+end

data/lib/extensions/date_time.rb

@@ -0,0 +1,16 @@
+class DateTime # :nodoc:
+  RCAP_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S"
+  RCAP_ZONE_FORMAT = "%+03i:00"
+
+  alias inspect to_s
+
+  def to_s_for_cap
+    t = self.strftime( RCAP_TIME_FORMAT ) + format( RCAP_ZONE_FORMAT , utc_hours_offset )
+    t.sub(/\+(00:\d\d)$/, '-\1')
+  end
+
+  private
+  def utc_hours_offset
+    self.offset * 24
+  end
+end

data/lib/extensions/string.rb

@@ -0,0 +1,16 @@
+class String # :nodoc:
+  CAP_LIST_REGEX = Regexp.new( '"([\w\s]+)"|(\S+)' )
+  WHITESPACE_REGEX = Regexp.new('^\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

data/lib/extensions/time.rb

@@ -0,0 +1,14 @@
+class Time # :nodoc:
+  RCAP_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S"
+  RCAP_ZONE_FORMAT = "%+03i:00"
+
+  def to_s_for_cap
+    t = self.strftime( RCAP_TIME_FORMAT ) + format( RCAP_ZONE_FORMAT , utc_hours_offset )
+    t.sub(/\+(00:\d\d)$/, '-\1')
+  end
+
+  private
+  def utc_hours_offset
+    self.utc_offset/3600
+  end
+end

data/lib/rcap.rb

@@ -9,11 +9,15 @@ require 'rexml/formatters/pretty'
 require 'open-uri'
 require 'base64'
 require 'digest/sha1'
+# Extensions
+require 'extensions/array'
+require 'extensions/string'
+require 'extensions/date_time'
+require 'extensions/time'
 # RCAP
 require 'rcap/version'
 require 'rcap/utilities'
 require 'rcap/validations'
-require 'rcap/alert'
 require 'rcap/cap_1_0/alert'
 require 'rcap/cap_1_0/parameter'
 require 'rcap/cap_1_0/event_code'
@@ -44,5 +48,6 @@ require 'rcap/cap_1_2/circle'
 require 'rcap/cap_1_2/polygon'
 require 'rcap/cap_1_2/geocode'
 require 'rcap/cap_1_2/area'
+require 'rcap/alert'
 # Configuration
 require 'config'

data/lib/rcap/alert.rb

@@ -5,13 +5,20 @@ module RCAP
     YAML_CAP_VERSION_KEY = "CAP Version"
     JSON_CAP_VERSION_KEY = "cap_version"
 
+    CAP_NAMESPACES = [ RCAP::CAP_1_0::Alert::XMLNS, RCAP::CAP_1_1::Alert::XMLNS, RCAP::CAP_1_2::Alert::XMLNS ]
+
     # Initialise a RCAP Alert from a XML document. The namespace of the
     # document is inspected and a CAP_1_0::Alert, CAP_1_1::Alert
     # or CAP_1_2::Alert is instantiated.
-    def self.from_xml( xml, namespace_key = XMLNS_KEY )
+    #
+    # The namespace key ('cap' if the CAP document is stored under 'xmlns:cap')
+    # can be specified explicitly by passing it in as a second parameter.
+    def self.from_xml( xml, namespace_key = nil )
       xml_document = REXML::Document.new( xml )
+      document_namespaces = xml_document.root.namespaces.invert
+      namespace = namespace_key || CAP_NAMESPACES.find{ |namepsace| document_namespaces[ namepsace ]}
 
-      case xml_document.root.namespaces[ namespace_key ]
+      case namespace
       when CAP_1_0::Alert::XMLNS
         CAP_1_0::Alert.from_xml_document( xml_document )
       when CAP_1_1::Alert::XMLNS
@@ -19,7 +26,6 @@ module RCAP
       else
         CAP_1_2::Alert.from_xml_document( xml_document )
       end
-
     end
 
     # Initialise a RCAP Alert from a YAML document produced by

data/lib/rcap/cap_1_0/area.rb

@@ -126,14 +126,11 @@ module RCAP
       POLYGONS_YAML  = 'Polygons'         # :nodoc:
 
       def to_yaml( options = {} ) # :nodoc:
-        circles_yaml = self.circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]}
-        def circles_yaml.to_yaml_style; :inline; end
-
         RCAP.attribute_values_to_hash(
           [ AREA_DESC_YAML, self.area_desc ],
           [ ALTITUDE_YAML,  self.altitude ],
           [ CEILING_YAML,   self.ceiling ],
-          [ CIRCLES_YAML,   circles_yaml ],
+          [ CIRCLES_YAML,   self.circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]} ],
           [ GEOCODES_YAML,  self.geocodes.inject({}){|h,geocode| h.merge( geocode.name => geocode.value )}],
           [ POLYGONS_YAML,  self.polygons ]
         ).to_yaml( options )

data/lib/rcap/cap_1_0/info.rb

@@ -139,6 +139,7 @@ module RCAP
       def initialize( attributes = {} )
         @language       = attributes[ :language ] || DEFAULT_LANGUAGE
         @categories     = Array( attributes[ :categories ])
+        @audience       = attributes [ :audience ]
         @event          = attributes [ :event ]
         @urgency        = attributes[ :urgency ]
         @severity       = attributes[ :severity ]
@@ -310,13 +311,10 @@ module RCAP
       AREAS_YAML          = 'Areas'          # :nodoc:
 
       def to_yaml( options = {} ) # :nodoc:
-        categories_yaml = self.categories
-        def categories_yaml.to_yaml_style; :inline; end
-
         parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
 
         RCAP.attribute_values_to_hash( [ LANGUAGE_YAML,       self.language ],
-                                       [ CATEGORIES_YAML,     categories_yaml ],
+                                       [ CATEGORIES_YAML,     self.categories ],
                                        [ EVENT_YAML,          self.event ],
                                        [ URGENCY_YAML,        self.urgency ],
                                        [ SEVERITY_YAML,       self.severity ],

data/lib/rcap/cap_1_0/polygon.rb

@@ -65,10 +65,7 @@ module RCAP
 
 
       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 )
+        self.points.map{ |point| [ point.lattitude, point.longitude ]}.to_yaml( options )
       end
 
       def self.from_yaml_data( polygon_yaml_data ) # :nodoc:

data/lib/rcap/cap_1_1/area.rb

@@ -126,14 +126,11 @@ module RCAP
       POLYGONS_YAML  = 'Polygons'         # :nodoc:
 
       def to_yaml( options = {} ) # :nodoc:
-        circles_yaml = self.circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]}
-        def circles_yaml.to_yaml_style; :inline; end
-
         RCAP.attribute_values_to_hash(
           [ AREA_DESC_YAML, self.area_desc ],
           [ ALTITUDE_YAML,  self.altitude ],
           [ CEILING_YAML,   self.ceiling ],
-          [ CIRCLES_YAML,   circles_yaml ],
+          [ CIRCLES_YAML,   self.circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]}],
           [ GEOCODES_YAML,  self.geocodes.inject({}){|h,geocode| h.merge( geocode.name => geocode.value )}],
           [ POLYGONS_YAML,  self.polygons ]
         ).to_yaml( options )

data/lib/rcap/cap_1_1/info.rb

@@ -157,6 +157,7 @@ module RCAP
       def initialize( attributes = {} )
         @language       = attributes[ :language ] || DEFAULT_LANGUAGE
         @categories     = Array( attributes[ :categories ])
+        @audience       = attributes [ :audience ]
         @event          = attributes [ :event ]
         @response_types = Array( attributes[ :response_types ])
         @urgency        = attributes[ :urgency ]
@@ -335,19 +336,13 @@ module RCAP
       AREAS_YAML          = 'Areas'          # :nodoc:
 
       def to_yaml( options = {} ) # :nodoc:
-        response_types_yaml = self.response_types
-        def response_types_yaml.to_yaml_style; :inline; end
-
-        categories_yaml = self.categories
-        def categories_yaml.to_yaml_style; :inline; end
-
         parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
 
         RCAP.attribute_values_to_hash(
           [ LANGUAGE_YAML,       self.language ],
-          [ CATEGORIES_YAML,     categories_yaml ],
+          [ CATEGORIES_YAML,     self.categories ],
           [ EVENT_YAML,          self.event ],
-          [ RESPONSE_TYPES_YAML, response_types_yaml ],
+          [ RESPONSE_TYPES_YAML, self.response_types ],
           [ URGENCY_YAML,        self.urgency ],
           [ SEVERITY_YAML,       self.severity ],
           [ CERTAINTY_YAML,      self.certainty ],

data/lib/rcap/cap_1_1/polygon.rb

@@ -65,10 +65,7 @@ module RCAP
 
 
       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 )
+        self.points.map{ |point| [ point.lattitude, point.longitude ]}.to_yaml( options )
       end
 
       def self.from_yaml_data( polygon_yaml_data ) # :nodoc:

data/lib/rcap/cap_1_2/area.rb

@@ -126,14 +126,11 @@ module RCAP
       POLYGONS_YAML  = 'Polygons'         # :nodoc:
 
       def to_yaml( options = {} ) # :nodoc:
-        circles_yaml = self.circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]}
-        def circles_yaml.to_yaml_style; :inline; end
-
         RCAP.attribute_values_to_hash(
           [ AREA_DESC_YAML,  self.area_desc ],
           [ ALTITUDE_YAML,   self.altitude ],
           [ CEILING_YAML,    self.ceiling ],
-          [ CIRCLES_YAML,    circles_yaml ],
+          [ CIRCLES_YAML,    self.circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]} ],
           [ GEOCODES_YAML,   self.geocodes.inject({}){|h,geocode| h.merge( geocode.name => geocode.value )}],
           [ POLYGONS_YAML,   self.polygons ]
         ).to_yaml( options )

data/lib/rcap/cap_1_2/info.rb

@@ -159,6 +159,7 @@ module RCAP
       def initialize( attributes = {} )
         @language       = attributes[ :language ] || DEFAULT_LANGUAGE
         @categories     = Array( attributes[ :categories ])
+        @audience       = attributes [ :audience ]
         @event          = attributes [ :event ]
         @response_types = Array( attributes[ :response_types ])
         @urgency        = attributes[ :urgency ]
@@ -337,18 +338,12 @@ module RCAP
       AREAS_YAML          = 'Areas'          # :nodoc:
 
       def to_yaml( options = {} ) # :nodoc:
-        response_types_yaml = self.response_types
-        def response_types_yaml.to_yaml_style; :inline; end
-
-        categories_yaml = self.categories
-        def categories_yaml.to_yaml_style; :inline; end
-
         parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
 
         RCAP.attribute_values_to_hash( [ LANGUAGE_YAML,       self.language ],
-                                       [ CATEGORIES_YAML,     categories_yaml ],
+                                       [ CATEGORIES_YAML,     self.categories ],
                                        [ EVENT_YAML,          self.event ],
-                                       [ RESPONSE_TYPES_YAML, response_types_yaml ],
+                                       [ RESPONSE_TYPES_YAML, self.response_types ],
                                        [ URGENCY_YAML,        self.urgency ],
                                        [ SEVERITY_YAML,       self.severity ],
                                        [ CERTAINTY_YAML,      self.certainty ],

data/lib/rcap/cap_1_2/polygon.rb

@@ -66,10 +66,7 @@ module RCAP
 
 
       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 )
+        self.points.map{ |point| [ point.lattitude, point.longitude ]}.to_yaml( options )
       end
 
       def self.from_yaml_data( polygon_yaml_data ) # :nodoc:

data/lib/rcap/utilities.rb

@@ -1,47 +1,5 @@
 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 = Regexp.new( '"([\w\s]+)"|(\S+)' )
-  WHITESPACE_REGEX = Regexp.new('^\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:
-  RCAP_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S"
-  RCAP_ZONE_FORMAT = "%+03i:00"
-
-  def to_s_for_cap
-    t = self.strftime( RCAP_TIME_FORMAT ) + format( RCAP_ZONE_FORMAT , self.utc_hours_offset )
-    t.sub(/\+(00:\d\d)$/, '-\1')
-  end
-
-  def utc_hours_offset
-    self.utc_offset/3600
-  end
-end
-
 module RCAP # :nodoc:
   def self.generate_identifier
     UUIDTools::UUID.random_create.to_s

data/lib/rcap/version.rb

@@ -1,3 +1,3 @@
 module RCAP
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/rcap.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$:.unshift File.expand_path('../lib', __FILE__)
 require 'rcap/version'
 
 Gem::Specification.new do |s|
@@ -25,6 +25,6 @@ Gem::Specification.new do |s|
   s.add_dependency('uuidtools', '>= 2.1.2')
 
   s.add_development_dependency( 'rspec', '>= 2.5.0' )
-  s.add_development_dependency( 'hanna', '>= 0.1.12' )
+  s.add_development_dependency( 'rdoc' )
   s.add_development_dependency( 'webmock' )
 end

data/spec/alert_spec.rb

@@ -17,8 +17,6 @@ describe( RCAP::Alert ) do
                                                     :infos => [ RCAP::CAP_1_0::Info.new, RCAP::CAP_1_0::Info.new ])
       end
 
-
-
       shared_examples_for( 'it has parsed a CAP 1.0 alert correctly' ) do
         it( 'should use the correct CAP Version' ){ @alert.class.should       == RCAP::CAP_1_0::Alert }
         it( 'should parse identifier correctly' ) { @alert.identifier.should  == @original_alert.identifier }
@@ -81,8 +79,6 @@ describe( RCAP::Alert ) do
                                                     :infos => [ RCAP::CAP_1_1::Info.new, RCAP::CAP_1_1::Info.new ])
       end
 
-
-
       shared_examples_for( 'it has parsed a CAP 1.1 alert correctly' ) do
         it( 'should use the correct CAP Version' ){ @alert.class.should       == RCAP::CAP_1_1::Alert }
         it( 'should parse identifier correctly' ) { @alert.identifier.should  == @original_alert.identifier }
@@ -145,8 +141,6 @@ describe( RCAP::Alert ) do
                                                     :infos => [ RCAP::CAP_1_2::Info.new, RCAP::CAP_1_2::Info.new ])
       end
 
-
-
       shared_examples_for( 'it has parsed a CAP 1.2 alert correctly' ) do
         it( 'should use the correct CAP Version' ){ @alert.class.should       == RCAP::CAP_1_2::Alert }
         it( 'should parse identifier correctly' ) { @alert.identifier.should  == @original_alert.identifier }
@@ -193,4 +187,77 @@ describe( RCAP::Alert ) do
       end
     end
   end
+
+  describe( 'external file' ) do
+    def load_file( file_name ) 
+      File.open( File.join( File.dirname( __FILE__ ), 'assets', file_name )){|f| f.read }
+    end
+
+    describe( "'invalid.cap'" ) do
+      before( :each ) do
+        @alert = RCAP::Alert.from_xml( load_file( 'invalid.cap' ))
+      end
+
+      it( 'should not be valid' ) do
+        @alert.should_not( be_valid )
+      end
+
+      it( 'should be invalid because scope is missing' ) do
+        @alert.valid?
+        @alert.errors.on( :scope ).should_not( be_empty )
+      end
+    end
+
+    describe( "'earthquake.cap'" ) do
+      before( :each ) do
+        @alert = RCAP::Alert.from_xml( load_file( 'earthquake.cap' ))
+      end
+
+      it( 'should be valid' ) do
+        @alert.should( be_valid )
+      end
+
+      it( 'should parse the alert correctly' ) do
+        @alert.class.should == RCAP::CAP_1_1::Alert
+        @alert.status.should == RCAP::CAP_1_1::Alert::STATUS_ACTUAL
+        @alert.msg_type.should == RCAP::CAP_1_1::Alert::MSG_TYPE_ALERT
+        @alert.scope.should == RCAP::CAP_1_1::Alert::SCOPE_PUBLIC
+
+        @alert.infos.size.should == 2
+        info = @alert.infos.first
+        info.categories.include?( RCAP::CAP_1_1::Info::CATEGORY_GEO ).should( be_true )
+
+        info.areas.size.should == 1
+        area = info.areas.first
+
+        area.circles.size.should == 1
+        circle = area.circles.first
+        circle.lattitude.should == -16.053
+        circle.longitude.should == -173.274
+        circle.radius.should == 0
+      end
+    end
+
+    describe( "'canada.cap'" ) do
+      before( :each ) do
+        @alert = RCAP::Alert.from_xml( load_file( 'canada.cap' ))
+      end
+
+      it( 'should be valid' ) do
+        @alert.should( be_valid )
+      end
+
+      it( 'should parse the alert correctly' ) do
+        @alert.class.should == RCAP::CAP_1_1::Alert
+        @alert.status.should == RCAP::CAP_1_1::Alert::STATUS_ACTUAL
+        @alert.msg_type.should == RCAP::CAP_1_1::Alert::MSG_TYPE_UPDATE
+        @alert.scope.should == RCAP::CAP_1_1::Alert::SCOPE_PUBLIC
+        @alert.identifier.should == "CA-EC-CWTO-2011-138776"
+
+        @alert.infos.size.should == 2
+        info = @alert.infos.first
+        info.event_codes.first.value = 'storm'
+      end
+    end
+  end
 end