rcap 2.0.2 → 2.1.0

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 Change Log
 ==========
 
+## 2.1.0 - 12 January 2013
+
+* RCAP.attribute_values_to_hash now does not filter out values that are empty, only nil.
+
+## 2.0.2
+
+* Fixed typo
+
+## 2.0.1
+
+* Use CAP date format in Alert reference and to_s
+
 ## 2.0.0 - 17 November 2012
 
 * Changed initialisation to block/builder style

data/README.md

@@ -31,15 +31,14 @@ The gem is also available for download and manual installation at [www.aimred.co
 Usage
 -----
 
-To include RCAP into your application add the following require
-
-    require 'rcap'
-
 ### Creating an Alert
 
 RCAP uses a 'builder' style syntax to create alerts. 
 
-    alert = RCAP::CAP_1_2::Alert.new do |alert|
+    require 'rcap'
+    include RCAP::CAP_1_2 
+
+    alert = 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
@@ -112,8 +111,6 @@ Will print the following CAP XML
 
 ### 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:
@@ -122,9 +119,9 @@ To parse an alert from a XML:
 
 ### 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.
+The RCAP API aims to codify as many of the rules of the CAP XML format into validation rules. The following Info object has two attributes ('severity' and 'certainty') set to incorrect values.
 
-    info = RCAP::CAP_1_2::Info.new do |info|
+    info = Info.new do |info|
       info.event = 'Liquid Petroleoum Tanker Fire'
       info.language   = 'en-ZA'
       info.categories << Info::CATEGORY_TRANSPORT
@@ -142,8 +139,6 @@ Will produce the following output:
     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.
 
 Web resources
@@ -166,14 +161,14 @@ Authors
 Change Log
 ----------
 
-[CHANGELOG](file.CHANGELOG.html)
+[CHANGELOG](CHANGELOG.html)
 
 License
 -------
 
 RCAP is released under the BSD License.
 
-Copyright 2010 - 2011 AIMRED CC. All rights reserved.
+Copyright 2010 - 2013 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:
 

data/lib/rcap/utilities.rb

@@ -65,15 +65,15 @@ module RCAP
       "'" + '-' * ( max_line_length + 2 ) + "'\n"
   end
 
-  # Converts an array of key value pairs into a hash, excluding any value that is nil or empty
+  # Converts an array of key value pairs into a hash, excluding any value that is nil.
   #
   # @param [Array<Array(Object,Object)>] attribute_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 }
+  #  RCAP.attribute_values_to_hash( ['a', 1], ['b' , nil ]) # => { '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 )]
+    Hash[ *attribute_values.reject{ |key, value| value.nil? }.flatten( 1 )]
   end
 
   # Calls #to_s_for_cap on the object it it responds to that otherwise just calls #to_s

data/lib/rcap/version.rb

@@ -1,3 +1,3 @@
 module RCAP
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

data/spec/extensions_spec.rb

@@ -60,10 +60,6 @@ describe( String ) do
       RCAP.attribute_values_to_hash( ["a", nil ]).should == {}
     end
 
-    it( 'should reject empty values' ) do
-      RCAP.attribute_values_to_hash( ["a", []]).should == {}
-    end
-
     it( 'should not reject non-nil and non-empty values' ) do
       RCAP.attribute_values_to_hash( [ "a", 1 ], [ "b", [ 2 ]]).should == { "a" => 1, "b" => [ 2 ]}
     end

metadata

@@ -2,7 +2,7 @@
 name: rcap
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors: 
 - Farrel Lifson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-09 00:00:00 Z
+date: 2013-01-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assistance