rcap 1.3.1 → 2.0.0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Change Log
 ==========
 
+## 2.0.0 - 17 November 2012
+
+* Changed initialisation to block/builder style
+* Refactored RCAP so protocol versions are subclassed from classes in RCAP::Base module
+
 ## 1.3.1 - 25 February 2012
 
 * Moved XML_PRETTY_PRINTER into RCAP namespace to avoid namespace issues

data/README.md

@@ -8,11 +8,6 @@ The Common Alerting Protocol is a lightweight standard to facilitate the distrib
 
 RCAP currently supports CAP 1.0, 1.1 and 1.2.
 
-Version
--------
-
-1.3.0
-
 Dependencies
 ------------
 
@@ -33,13 +28,6 @@ RCAP is distributed as a Ruby gem and is available from [Rubygems.org](http://ru
 
 The gem is also available for download and manual installation at [www.aimred.com/gems](http://www.aimred.com/gems).
 
-Web resources
--------------
-
-* The RCAP project page can be found at [http://www.aimred.com/projects/rcap](http://www.aimred.com/projects/rcap)
-* The RCAP API docs can be found at [http://www.aimred.com/projects/rcap/api](http://www.aimred.com/projects/rcap/api)
-* A public git repository can be found at [git://github.com/farrel/RCAP.git](git://github.com/farrel/RCAP.git)
-
 Usage
 -----
 
@@ -47,93 +35,52 @@ To include RCAP into your application add the following require
 
     require 'rcap'
 
-All RCAP classes reside in the RCAP namespace but including the RCAP module makes the classes available at the top level without the RCAP prefix.
-
-    include RCAP:CAP_1_2 # Include RCAP:CAP_1_2 module into namespace
-    alert = Alert.new
-
 ### Creating an Alert
 
-    alert = Alert.new( sender:   'cape_town_disaster_relief@capetown.municipal.za',
-                       status:   Alert::STATUS_ACTUAL,
-                       msg_type: Alert::MSG_TYPE_ALERT,
-                       scope:    Alert::SCOPE_PUBLIC )
-   
-    alert.add_info( event:       'Liquid Petroleoum Tanker Fire',
-                    language:    'en-ZA',
-                    categories:  [ Info::CATEGORY_TRANSPORT, Info::CATEGORY_FIRE ],
-                    urgency:     Info::URGENCY_IMMEDIATE,
-                    severity:    Info::SEVERITY_SEVERE,
-                    certainty:   Info::CERTAINTY_OBSERVED,
-                    headline:    'LIQUID PETROLEOUM TANKER FIRE ON N2 INCOMING FREEWAY',
-                    description: 'A liquid petroleoum tanker has caught fire on the N2 incoming freeway 1km
-                                 after the R300 interchange.  Municipal fire fighting crews have been dispatched.
-                                 Traffic control officers are on the scene and have diverted traffic onto
-                                 alternate routes.' )
-   
-    alert.infos.first.add_area( area_desc: 'N2 Highway/R300 Interchange' ).add_geocode( name: 'Intersection', value: 'N2-15' )
+RCAP uses a 'builder' style syntax to create alerts. 
+
+    alert = RCAP::CAP_1_2::Alert.new do |alert|
+      alert.sender   = 'cape_town_disaster_relief@capetown.municipal.za'
+      alert.status   = Alert::STATUS_ACTUAL
+      alert.msg_type = Alert::MSG_TYPE_ALERT
+      alert.scope    = Alert::SCOPE_PUBLIC 
+    
+      alert.add_info do |info|
+        info.event       = 'Liquid Petroleoum Tanker Fire'
+        info.language    = 'en-ZA'
+        info.categories  << Info::CATEGORY_TRANSPORT
+        info.categories  << Info::CATEGORY_FIRE 
+        info.urgency     = Info::URGENCY_IMMEDIATE
+        info.severity    = Info::SEVERITY_SEVERE
+        info.certainty   = Info::CERTAINTY_OBSERVED
+        info.headline    = 'LIQUID PETROLEOUM TANKER FIRE ON N2 INCOMING FREEWAY'
+        info.description = 'A liquid petroleoum tanker has caught fire on the N2 incoming freeway 1km
+                            after the R300 interchange.  Municipal fire fighting crews have been dispatched.
+                            Traffic control officers are on the scene and have diverted traffic onto
+                            alternate routes.' 
+    
+        info.add_area do |area|
+          area.area_desc = 'N2 Highway/R300 Interchange' 
+          area.add_geocode do |geocode|
+            geocode.name  = 'Intersection'
+            geocode.value = 'N2-15' 
+          end
+        end
+      end
+    end
    
     # Accessing attributes
-    alert.status                           # "Actual"
-    alert.infos[0].language                # "en-ZA"
-    alert.infos[0].categories.join( ', ' ) # "Transport, Fire"
-    alert.infos[0].areas[0]                # "N2 Highway/R300 Interchange"
-
-### Parsing an Alert From An External Source
-
-RCAP can parse a CAP alert from a varierty of file formats. Besides the [standard XML](http://www.oasis-emergency.org/cap) representation, [YAML](http://yaml.org) and [JSON](http://json.org) support is also included.
-
-To ensure the correct RCAP Alert object (RCAP::CAP_1_1::Alert or RCAP::CAP_1_2::Alert) is returned from an external source, a number of factories are defined in the RCAP::Alert module. If the version of the document to be parsed can not be ascertained a CAP 1.2 document will be assumed.
-
-#### From XML
-
-RCAP allows for the parsing of a CAP XML string
-
-    alert = RCAP::Alert.from_xml( xml_string )
-
-#### From YAML
-
-Alert messgaes can be read in from text files containing data formatted in [YAML](http://yaml.org) as generated by Alert#to_yaml.
-
-    alert = RCAP::Alert.from_yaml( yaml_string )
-
-#### From JSON
-
-An Alert can also be initialised from a [JSON](http://json.org) string produced by Alert#to_json
-
-    alert = RCAP::Alert.from_json( json_string )
-
-### Validating an alert
-
-The RCAP API aims to codify as many of the rules of the CAP XML format into validation rules that can be checked using the Assistance API. The following Info object has two attributes ('severity' and 'certainty') set to incorrect values.
-
-    info = Info.new( event:      'Liquid Petroleoum Tanker Fire',
-                     language:   'en-ZA',
-                     categories: [ Info::CATEGORY_TRANSPORT, Info::CATEGORY_FIRE ],
-                     urgency:    Info::URGENCY_IMMEDIATE,
-                     severity:   nil,                     # Severity is not assigned
-                     certainty:  'Incorrect Certainty' )  # Certainty is assigned an incorrect value
-   
-    puts "Is info valid: #{ info.valid? }"
-    info.errors.full_messages.each{ |message| puts "Error: #{ message }" }
-
-Will produce the following output:
-
-    Is info valid: false
-    Error: severity is not present
-    Error: certainty can only be assigned the following values: Observed, Likely, Possible, Unlikely, Unknown
-
-All RCAP classes include the Validation module.
-
-A full spec suite using [RSpec](http://www.rspec.info) was used to test the validations and currently numbers over 1000 tests.
+    puts alert.status                 # "Actual"
+    info = alert.infos.first
+    puts info.language                # "en-ZA"
+    puts info.categories.join( ', ' ) # "Transport, Fire"
+    puts info.areas.first             # "N2 Highway/R300 Interchange"
 
 ### Exporting an Alert
 
-#### To XML
+Using the alert message created earlier
 
-Using the alert message created above
-
-    puts alert.to_xml # Print out CAP XML message
+    puts alert.to_xml
 
 Will print the following CAP XML
 
@@ -163,69 +110,49 @@ Will print the following CAP XML
       </info>
     </alert>
 
-#### To YAML
-
-YAML is a plain text serialization format designed to be easily readable and editable by both human and machine. RCAP has custom YAML generation and parsing methods to produce a YAML document that is as human friendly as possible. The following code
-
-    alert.to_yaml
-
-will produce the following YAML document
-
-    ---
-    CAP Version: 1.2
-    Identifier: 2a1ba96d-16e4-4f52-85ea-0258c1440bd5
-    Sender: cape_town_disaster_relief@capetown.municipal.za
-    Sent: 2009-11-19T02:41:29+02:00
-    Status: Actual
-    Message Type: Alert
-    Scope: Public
-    Information:
-    - Language: en-ZA
-      Categories: [Transport, Fire]
-      Event: Liquid Petroleoum Tanker Fire
-      Urgency: Immediate
-      Severity: Severe
-      Certainty: Observed
-      Headline: LIQUID PETROLEOUM TANKER FIRE ON N2 INCOMING FREEWAY
-      Description: |-
-        A liquid petroleoum tanker has caught fire on the N2 incoming freeway 1km
-        after the R300 interchange.  Municipal fire fighting crews have been dispatched.
-        Traffic control officers are on the scene and have diverted traffic onto
-        alternate routes.
-
-Note: If you use Ruby 1.8 the order of the attributes is jumbled due to hashes being unorderd (Ruby 1.9 implements ordered hashes). This does not affect the ability to parse documents generated from RCAP::Alert#to_yaml, it just makes things the output slightly messy.
-
-#### To JSON
-
-JSON is a text serialization format that can be easily loaded in a JavaScript environment.
-
-    alert.to_json
-
-will produce the following JSON string
-
-    {"cap_version":"1.2",
-     "identifier":"0eb97e40-195b-437b-9a01-55fe89691def",
-     "sender":"cape_town_disaster_relief@capetown.municipal.za",
-     "sent":"2011-03-04T15:58:01+02:00",
-     "status":"Actual",
-     "msg_type":"Alert",
-     "scope":"Public",
-     "infos":[
-       {"language":"en-ZA",
-        "categories":["Transport","Fire"],
-        "event":"Liquid Petroleoum Tanker Fire",
-        "urgency":"Immediate",
-        "severity":"Severe",
-        "certainty":"Observed",
-        "headline":"LIQUID PETROLEOUM TANKER FIRE ON N2 INCOMING FREEWAY",
-        "description":"A liquid petroleoum tanker has caught fire on the N2 incoming freeway 1km
-                       after the R300 interchange. Municipal fire fighting crews have been dispatched.
-                       Traffic control officers are on the scene and have diverted traffic onto \nalternate routes."}]}
+### Parsing an Alert From An External Source
+
+RCAP can parse a CAP alert from a varierty of file formats. Besides the [standard XML](http://www.oasis-emergency.org/cap) representation, [YAML](http://yaml.org) and [JSON](http://json.org) support is also included.
+
+To ensure the correct RCAP Alert object (RCAP::CAP_1_1::Alert or RCAP::CAP_1_2::Alert) is returned from an external source, a number of factories are defined in the RCAP::Alert module. If the version of the document to be parsed can not be ascertained a CAP 1.2 document will be assumed.
+
+To parse an alert from a XML:
+
+    alert = RCAP::Alert.from_xml( xml_string )
+
+### Validation
+
+The RCAP API aims to codify as many of the rules of the CAP XML format into validation rules that can be checked using the Assistance API. The following Info object has two attributes ('severity' and 'certainty') set to incorrect values.
+
+    info = RCAP::CAP_1_2::Info.new do |info|
+      info.event = 'Liquid Petroleoum Tanker Fire'
+      info.language   = 'en-ZA'
+      info.categories << Info::CATEGORY_TRANSPORT
+      info.urgency    = Info::URGENCY_IMMEDIATE
+      info.severity   = nil                   # Severity is not assigned
+      info.certainty  = 'Incorrect Certainty' # Certainty is assigned an incorrect value
+    end
    
+    puts "Is info valid: #{ info.valid? }"
+    info.errors.full_messages.each{ |message| puts "Error: #{ message }" }
+
+Will produce the following output:
+
+    Is info valid: false
+    Error: severity is not present
+    Error: certainty can only be assigned the following values: Observed, Likely, Possible, Unlikely, Unknown
 
-### DateTime and Time
+All RCAP classes include the Validation module.
 
-It is highly recommended that when dealing with date and time fields (onset, expires etc) that the DateTime class is used to ensure the correct formatting of dates. The Time class can be used when generating a CAP alert XML message however any CAP alert that is parsed from an external XML source will use DateTime by default.
+A full spec suite using [RSpec](http://www.rspec.info) was used to test the validations and currently numbers over 1000 tests.
+
+Web resources
+-------------
+
+* The RCAP project page can be found at [http://www.aimred.com/projects/rcap](http://www.aimred.com/projects/rcap)
+* The RCAP API docs can be found at [http://www.aimred.com/projects/rcap/api](http://www.aimred.com/projects/rcap/api)
+* A public git repository can be found at [http://github.com/farrel/RCAP](http://github.com/farrel/RCAP)
+* A CAP Validator based on RCAP can be found at [http://capvalidator.heroku.com](http://capvalidator.heroku.com)
 
 Authors
 -------

data/Rakefile

@@ -7,7 +7,7 @@ Bundler::GemHelper.install_tasks
 
 YARD::Rake::YardocTask.new do |t|
   t.files = ['lib/**/*.rb' ]
-  t.options += [ '--title', "RCAP Ruby API" ]
+  t.options += [ '--title', "RCAP - Common Alerting Protocol for Ruby" ]
   t.options += [ '--main', 'README.md']
   t.options += [ '--files', 'CHANGELOG.md' ]
   t.options += [ '--output-dir', 'doc' ]

data/lib/rcap/alert.rb

@@ -10,7 +10,7 @@ module RCAP
     # Initialise a RCAP Alert from a XML document.
     #
     # @param [IO,String] xml CAP alert in XML format. Can be a String or any IO object.
-    # @param [String] namespace_key The XML namespace that the CAP alert is in. If omitted  
+    # @param [String] namespace_key The XML namespace that the CAP alert is in. If omitted
     #  the namespace of the document is inspected and a CAP_1_0::Alert, CAP_1_1::Alert
     #  or CAP_1_2::Alert is instantiated accordingly. If no namespace can be detected
     #  a CAP 1.2 message will be assumed.
@@ -66,7 +66,7 @@ module RCAP
     #
     # @param [Hash] hash Alert as a Ruby hash.
     # @return [ RCAP::CAP_1_0::Alert, RCAP::CAP_1_1::Alert, RCAP::CAP_1_2::Alert ]
-    def self.from_h( hash ) 
+    def self.from_h( hash )
       case hash[ JSON_CAP_VERSION_KEY ]
       when CAP_1_0::Alert::CAP_VERSION
         CAP_1_0::Alert.from_h( hash )