rcap 1.3.0 → 1.3.1

data/lib/rcap/config.rb

@@ -0,0 +1,4 @@
+module RCAP
+  XML_PRETTY_PRINTER = REXML::Formatters::Pretty.new( 2 )
+  XML_PRETTY_PRINTER.compact = true
+end

data/lib/rcap/utilities.rb

@@ -1,23 +1,61 @@
-ALLOWED_CHARACTERS = /[^\s&<]+/ # :nodoc:
+ALLOWED_CHARACTERS = /[^\s&<]+/ 
 
-module RCAP # :nodoc:
+module RCAP  
+  # Returns a randomly generated UUID string
+  #
+  # @return [String] UUID string
   def self.generate_identifier
     UUIDTools::UUID.random_create.to_s
   end
 
+  # Returns the text of the first descendent that matches the given XPath
+  # expression.
+  #
+  # @param [REXML::Element] xml_element Element to start matching from.
+  # @param [String] xpath XPath expression
+  # @param [String] namepsace Namespace in which to do the matching
+  # @return [String,nil] Text content of element matching XPath query or nil 
   def self.xpath_text( xml_element, xpath, namespace )
     element = self.xpath_first( xml_element, xpath, namespace )
     element.text if element
   end
 
+  # Returns first descendent that matches the given XPath expression.
+  #
+  # @param [REXML::Element] xml_element Element to start matching from.
+  # @param [String] xpath XPath expression
+  # @param [String] namepsace Namespace in which to do the matching
+  # @return [REXML::Element,nil] Element matching XPath query or nil
   def self.xpath_first( xml_element, xpath, namespace )
     REXML::XPath.first( xml_element, xpath, { 'cap' => namespace })
   end
 
+  # Returns all descendents that match the given XPath expression.
+  #
+  # @param [REXML::Element] xml_element Element to start matching from.
+  # @param [String] xpath XPath expression
+  # @param [String] namepsace Namespace in which to do the matching
+  # @return [Array<REXML::Element>] Collection of elements matching XPath query 
   def self.xpath_match( xml_element, xpath, namespace )
     REXML::XPath.match( xml_element, xpath, { 'cap' => namespace })
   end
 
+  # Formats output for inspect
+  #
+  # @param [String] header Output header
+  # @param [String] inspect_string String to be output
+  # @return [String] Formatted output for inspect
+  #
+  # @example
+  #  RCAP.format_lines_for_inspect( 'Test', 'one\ntwo\nthree' ) 
+  #  # returns
+  #  # .-------.
+  #  # | Test  |
+  #  # |-------|
+  #  # | one   |
+  #  # | two   |
+  #  # | three |
+  #  # '-------'
   def self.format_lines_for_inspect( header, inspect_string )
     max_line_length = inspect_string.lines.map{ |line| line.chomp.length }.max
     "\n." + '-' * (max_line_length + 2) + ".\n"+
@@ -27,10 +65,21 @@ module RCAP # :nodoc:
       "'" + '-' * ( max_line_length + 2 ) + "'\n"
   end
 
+  # Converts an array of key value pairs into a hash, excluding any value that is nil or empty
+  #
+  # @param [Array<Array(Object,Object)>] attribte_values An array of arrays of key/value pairs
+  # @return [Hash] Hash of attributes
+  #
+  # @example
+  #  RCAP.attribute_values_to_hash( ['a', 1], ['b' , []]) # => { 'a' => 1 }
   def self.attribute_values_to_hash( *attribute_values )
     Hash[ *attribute_values.reject{ |key, value| value.nil? || ( value.respond_to?( :'empty?' ) && value.empty? )}.flatten( 1 )]
   end
 
+  # Calls #to_s_for_cap on the object it it responds to that otherwise just calls #to_s
+  #
+  # @param [#to_s, #to_s_for_cap] 
+  # @return [String]
   def self.to_s_for_cap( object )
     if object
       if object.respond_to?( :to_s_for_cap )
@@ -41,6 +90,10 @@ module RCAP # :nodoc:
     end
   end
 
+  # If the parameter is a string the datetime is parsed out of it, otherwise returns nil.
+  #
+  # @param [String] date_string String to parse 
+  # @return [String,nil]
   def self.parse_datetime( date_string )
     if date_string.is_a?( String )
       DateTime.parse( date_string )

data/lib/rcap/validations.rb

@@ -1,5 +1,5 @@
-module Validation  # :nodoc:
-  module ClassMethods # :nodoc:
+module Validation  
+  module ClassMethods 
 
     CAP_NUMBER_REGEX  = Regexp.new( '^-{0,1}\d*\.{0,1}\d+$' )
     CAP_INTEGER_REGEX = Regexp.new( '\-{0,1}A[+-]?\d+\Z' )

data/lib/rcap/version.rb

@@ -1,3 +1,3 @@
 module RCAP
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/rcap.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.extra_rdoc_files = ['README.rdoc','CHANGELOG.rdoc']
+  s.extra_rdoc_files = ['README.md','CHANGELOG.md']
   s.add_dependency('assistance', '>= 0.1.5')
   s.add_dependency('json', '>= 1.5.1')
   s.add_dependency('uuidtools', '>= 2.1.2')
 
   s.add_development_dependency( 'rspec', '>= 2.5.0' )
-  s.add_development_dependency( 'rdoc' )
+  s.add_development_dependency( 'yard' )
   s.add_development_dependency( 'webmock' )
 end

data/spec/cap_1_0/parameter_spec.rb

@@ -40,9 +40,13 @@ describe( RCAP::CAP_1_0::Parameter ) do
   end
 
   describe( '.parse_parameter' ) do
-    it( 'should parse the content correctly' ) do
+    it( 'should parse valid content correctly' ) do
       RCAP::CAP_1_0::Parameter.parse_parameter( "name=value" ).should == { :name => 'name', :value => 'value' }
     end
+
+    it( 'should parse invalid content correctly' ) do
+      RCAP::CAP_1_0::Parameter.parse_parameter( 'name' ).should == nil
+    end
   end
 
   describe( '.to_xml_element' ) do

data/spec/cap_1_1/resource_spec.rb

@@ -199,5 +199,11 @@ describe( RCAP::CAP_1_1::Resource ) do
         lambda{ @resource.calculate_hash_and_size }.should( change( @resource, :size ).to( @encoded_content.bytesize ))
       end
     end
+
+    describe( '#decoded_deref_uri' ) do
+      it( 'should return the original content' ) do
+        @resource.decoded_deref_uri.should == @content
+      end
+    end
   end
 end

data/spec/cap_1_2/alert_spec.rb

@@ -229,5 +229,13 @@ describe( RCAP::CAP_1_2::Alert ) do
         @alert.infos.size.should == 1
       end
     end
+
+    describe( '#to_xml' ) do
+      context( 'with pretty_print = true' ) do
+        it( 'should not raise an exception' ) do
+          lambda{ @alert.to_xml( true ) }.should_not( raise_exception )
+        end
+      end
+    end
   end
 end

data/spec/cap_1_2/resource_spec.rb

@@ -173,7 +173,7 @@ describe( RCAP::CAP_1_2::Resource ) do
       stub_request( :get, @resource.uri ).to_return( :status => 200, :body => @content )
     end
 
-    describe( '#dereference_uri!' ) do
+    describe( 'calling dereference_uri!' ) do
       it( 'should fetch the content and store it in deref_uri as Base64 encoded content' ) do
         lambda{ @resource.dereference_uri! }.should( change( @resource, :deref_uri ).to( @encoded_content ))
       end
@@ -192,7 +192,7 @@ describe( RCAP::CAP_1_2::Resource ) do
     before( :each ) do 
       @content = "1,2\n3,4"
       @encoded_content = Base64.encode64( @content )
-      @resource = RCAP::CAP_1_1::Resource.new( :resource_desc => 'Resource Description', :mime_type => 'text/csv', :uri => 'http://tempuri.org/resource.csv', :deref_uri => @encoded_content )
+      @resource = RCAP::CAP_1_2::Resource.new( :resource_desc => 'Resource Description', :mime_type => 'text/csv', :uri => 'http://tempuri.org/resource.csv', :deref_uri => @encoded_content )
     end
 
     describe( '#calculate_hash_and_size' ) do
@@ -204,5 +204,11 @@ describe( RCAP::CAP_1_2::Resource ) do
         lambda{ @resource.calculate_hash_and_size }.should( change( @resource, :size ).to( @encoded_content.bytesize ))
       end
     end
+
+    describe( '#decoded_deref_uri' ) do
+      it( 'should return the original content' ) do
+        @resource.decoded_deref_uri.should == @content
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rcap
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 3
-  - 0
-  version: 1.3.0
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Farrel Lifson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-15 00:00:00 Z
+date: 2012-02-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assistance
@@ -82,7 +82,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: yard
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -117,15 +117,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
-- CHANGELOG.rdoc
+- README.md
+- CHANGELOG.md
 files: 
 - .gitignore
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
-- lib/config.rb
 - lib/extensions/array.rb
 - lib/extensions/date_time.rb
 - lib/extensions/string.rb
@@ -162,6 +161,7 @@ files:
 - lib/rcap/cap_1_2/point.rb
 - lib/rcap/cap_1_2/polygon.rb
 - lib/rcap/cap_1_2/resource.rb
+- lib/rcap/config.rb
 - lib/rcap/utilities.rb
 - lib/rcap/validations.rb
 - lib/rcap/version.rb
@@ -296,3 +296,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/utilities_spec.rb
 - spec/validations_spec.rb
+has_rdoc: 

data/README.rdoc

@@ -1,247 +0,0 @@
-= RCAP - Common Alerting Protocol for Ruby
-
-== Overview
-
-The Common Alerting Protocol is a lightweight standard to facilitate the distribution of alerting data. RCAP is an implementation of the CAP document protocol in Ruby. It allows for the creation of RCAP messages from Ruby applications and the parsing of external messages.
-
-RCAP currently supports CAP 1.0, 1.1 and 1.2.
-
-== Version
-
-1.3.0
-
-== Dependencies
-
-RCAP depends on the following gems
-
-* Assistance[http://assistance.rubyforge.org]
-* UUIDTools[http://uuidtools.rubyforge.org]
-* JSON[http://json.rubyforge.org]
-
-RCAP uses the REXML API, included in Ruby, to parse and generate XML.
-
-== Installation
-
-RCAP is distributed as a Ruby gem and is available from Rubygems.org[http://rubygems.org].
-
- gem install rcap
-
-The gem is also available for download and manual installtion 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
-* The RCAP API docs can be found at http://www.aimred.com/projects/rcap/api
-* A public git repository can be found at git://github.com/farrel/RCAP.git
-
-== Usage
-
-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( identifier: RCAP.generate_identifier,
-                    sent:       DateTime.now,
-                    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' )
-
- # 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 RCAP::CAP_1_2::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:  'Unknown Certainty' )  # Certainty is assigned in 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.
-
-=== Exporting an Alert
-
-==== To XML
-
-Using the alert message created above
-
- puts alert.to_xml # Print out CAP XML message
-
-Will print the following CAP XML
-
-  <?xml version='1.0'?>
-  <alert xmlns='urn:oasis:names:tc:emergency:cap:1.2'>
-    <identifier>494207a7-f86b-4060-8318-a4b2a3ce565e</identifier>
-    <sender>cape_town_disaster_relief@capetown.municipal.za</sender>
-    <sent>2009-10-26T21:04:51+02:00</sent>
-    <status>Actual</status>
-    <msgType>Alert</msgType>
-    <scope>Public</scope>
-    <info>
-      <language>en-ZA</language>
-      <category>Transport</category>
-      <category>Fire</category>
-      <event>Liquid Petroleoum Tanker Fire</event>
-      <urgency>Immediate</urgency>
-      <severity>Severe</severity>
-      <certainty>Observed</certainty>
-      <headline>LIQUID PETROLEOUM TANKER FIRE ON N2 INCOMING FREEWAY</headline>
-      <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.
-      </description>
-    </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(JavaScript Object Notation) 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."}]}
-
-
-=== DateTime and Time
-
-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.
-
-== Authors
-
-* Farrel Lifson - farrel.lifson@aimred.com - http://www.aimred.com
-
-=== Contributors
-
-* Earle Clubb - http://github.com/eclubb
-
-== License
-
-RCAP is released under the BSD License.
-
-Copyright 2010 - 2011 AIMRED CC. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY AIMRED CC ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AIMRED CC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of AIMRED CC.