rcap 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: fcde72aed04c8e2fc3fb4438f7aa0efa8c4ea742
-  data.tar.gz: c4da4ef49d6baa85a8ed1c2d8f6483911f7c8d83
-SHA512: 
-  metadata.gz: dc204739fd9dadf31a5b8681534dc0f432f3cedee19f5d4c867532273a4da3d68fa4e5f54cea9f62c73b323832a437449efdcf0c12e5cdc92443874bbfeec78f
-  data.tar.gz: 1f12805f57d4ccb6c445b9995d5d43028b7987555ed149847c1f1520bc4d38ca6114d50f3c5c465e84d05c7a6c394b96e3709c04f2e7a3b3aace14c1f79feb72
+---
+SHA1:
+  metadata.gz: 1bb205d2fab692f7bd6b270029a96918a32eea19
+  data.tar.gz: fd94605d3d3a99040c3cf183cc873f0db15dd64b
+SHA512:
+  metadata.gz: a3c720fc8e87dddd70b4dc92f03d2eab1ff21875c33b9c83b8b714e35e4fa0bdb1d065c945b67c55d9bac02f037ac8941172eff5e943fb6209871a6095cd2126
+  data.tar.gz: 93bf5df1405126c70f80894da9bf0b40b10f8089c17d8877d0c92e6c0fb047475ef843aceaadc5cdd5a48d5691b7a17b044628c4821aca5bbee21653928d5eac

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Change Log
 ==========
 
+## 2.3.0 - 6 March 2014
+
+* Fixed YAML import and export. 
+* Ruby 2.1 tested
+
 ## 2.2.1 - 16 April 2013
 
 * Added RCAP::Info to initialise an Info object semi-independently from an Alert.

data/README.md

@@ -24,7 +24,7 @@ Installation
 
 RCAP is distributed as a Ruby gem and is available from [Rubygems.org](http://rubygems.org). From the command line you can install it with the gem command:
 
-    $ gem install rcap
+    gem install rcap
 
 The gem is also available for download and manual installation at [www.aimred.com/gems](http://www.aimred.com/gems).
 
@@ -36,9 +36,8 @@ Usage
 RCAP uses a 'builder' style syntax to create alerts. 
 
     require 'rcap'
-    include RCAP::CAP_1_2 
 
-    alert = Alert.new do |alert|
+    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
@@ -121,7 +120,7 @@ To parse an alert from a XML:
 
 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 = Info.new do |info|
+    info = RCAP::CAP_1_2::Info.new do |info|
       info.event = 'Liquid Petroleoum Tanker Fire'
       info.language   = 'en-ZA'
       info.categories << Info::CATEGORY_TRANSPORT
@@ -161,7 +160,7 @@ Authors
 Change Log
 ----------
 
-[CHANGELOG](CHANGELOG.html)
+[CHANGELOG](file.CHANGELOG.html)
 
 License
 -------

data/lib/rcap/base/alert.rb

@@ -309,7 +309,7 @@ module RCAP
                                        [ NOTE_YAML,        @note ],
                                        [ REFERENCES_YAML,  @references ],
                                        [ INCIDENTS_YAML,   @incidents ],
-                                       [ INFOS_YAML,       @infos ]).to_yaml( options )
+                                       [ INFOS_YAML,       @infos.map( &:to_yaml_data )]).to_yaml( options )
       end
 
       # Initialise an Alert object from a YAML string. Any object that is a subclass of IO (e.g. File) can be passed in.

data/lib/rcap/base/area.rb

@@ -150,14 +150,19 @@ module RCAP
       GEOCODES_YAML  = 'Geocodes'
       POLYGONS_YAML  = 'Polygons'
 
-      # @return [String] YAML representation of object
-      def to_yaml( options = {} )
+      # @return [Hash] 
+      def to_yaml_data
         RCAP.attribute_values_to_hash( [ AREA_DESC_YAML, @area_desc ],
                                        [ ALTITUDE_YAML,  @altitude ],
                                        [ CEILING_YAML,   @ceiling ],
                                        [ CIRCLES_YAML,   @circles.map{ |circle| circle.to_a }],
                                        [ GEOCODES_YAML,  @geocodes.inject({}){|h,geocode| h.merge( geocode.name => geocode.value )}],
-                                       [ POLYGONS_YAML,  @polygons ]).to_yaml( options )
+                                       [ POLYGONS_YAML,  @polygons.map( &:to_yaml_data )])
+      end
+
+      # @return [String] YAML representation of object
+      def to_yaml( options = {} )
+        self.to_yaml_data.to_yaml( options )
       end
 
       # @param [Hash] area_yaml_data

data/lib/rcap/base/info.rb

@@ -335,8 +335,8 @@ module RCAP
       RESOURCES_YAML      = 'Resources'
       AREAS_YAML          = 'Areas'
 
-      # @return [String]
-      def to_yaml( options = {} )
+      # @return [Hash]
+      def to_yaml_data
         parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
 
         RCAP.attribute_values_to_hash( [ LANGUAGE_YAML,       @language ],
@@ -357,8 +357,13 @@ module RCAP
                                        [ CONTACT_YAML,        @contact ],
                                        [ EVENT_CODES_YAML,    @event_codes.inject({}, &parameter_to_hash )],
                                        [ PARAMETERS_YAML,     @parameters.inject({}, &parameter_to_hash )],
-                                       [ RESOURCES_YAML,      @resources ],
-                                       [ AREAS_YAML,          @areas ]).to_yaml( options )
+                                       [ RESOURCES_YAML,      @resources.map( &:to_yaml_data )],
+                                       [ AREAS_YAML,          @areas.map(&:to_yaml_data )])
+      end
+
+      # @return [String]
+      def to_yaml( options = {} )
+        self.to_yaml_data.to_yaml( options )
       end
 
       # @param [Hash] info_yaml_data

data/lib/rcap/base/polygon.rb

@@ -92,9 +92,14 @@ module RCAP
         end
       end
 
+      # @return [Hash]
+      def to_yaml_data
+        @points.map{ |point| [ point.lattitude, point.longitude ]}
+      end
+
       # @return [String]
       def to_yaml( options = {} )
-        @points.map{ |point| [ point.lattitude, point.longitude ]}.to_yaml( options )
+        self.to_yaml_data.to_yaml( options )
       end
 
       POINTS_KEY  = 'points'

data/lib/rcap/base/resource.rb

@@ -63,9 +63,9 @@ module RCAP
         end
       end
 
-      # Calculates the SHA-1 hash and size of the contents of {#deref_uri}.
+      # Calculates the SHA-1 hash and size of the contents of {RCAP::Base::Resource#deref_uri}.
       # Returns an array containing the size (in bytes) and SHA-1 hash if
-      # {#deref_uri} is present otherwise returns nil.
+      # {RCAP::Base::Resource#deref_uri} is present otherwise returns nil.
       #
       # @return [nil,Array(Integer,String)]
       def calculate_hash_and_size
@@ -76,7 +76,7 @@ module RCAP
         end
       end
 
-      # The decoded contents of {#deref_uri} if present otherwise nil.
+      # The decoded contents of {RCAP::Base::Resource#deref_uri} if present otherwise nil.
       #
       # @return [nil,String]
       def decoded_deref_uri
@@ -115,14 +115,18 @@ module RCAP
       SIZE_YAML          = "Size"
       DIGEST_YAML        = "Digest"
 
-      # @param [Hash] options
-      # @return [String]
-      def to_yaml( options = {} )
+      def to_yaml_data
         RCAP.attribute_values_to_hash( [ RESOURCE_DESC_YAML, @resource_desc ],
                                        [ URI_YAML,           @uri ],
                                        [ MIME_TYPE_YAML,     @mime_type ],
                                        [ SIZE_YAML,          @size ],
-                                       [ DIGEST_YAML,        @digest ]).to_yaml( options )
+                                       [ DIGEST_YAML,        @digest ])
+      end
+
+      # @param [Hash] options
+      # @return [String]
+      def to_yaml( options = {} )
+        self.to_yaml_data.to_yaml( options )
       end
 
       # @param [Hash] resource_yaml_data

data/lib/rcap/cap_1_0/alert.rb

@@ -117,7 +117,7 @@ module RCAP
                                        [ NOTE_YAML,        @note ],
                                        [ REFERENCES_YAML,  @references ],
                                        [ INCIDENTS_YAML,   @incidents ],
-                                       [ INFOS_YAML,       @infos ]).to_yaml( options )
+                                       [ INFOS_YAML,       @infos.map( &:to_yaml_data )]).to_yaml( options )
       end
 
       # @param [Hash] alert_yaml_data

data/lib/rcap/cap_1_1/info.rb

@@ -190,9 +190,9 @@ module RCAP
 
       RESPONSE_TYPES_YAML = 'Response Types'
 
-      # @return [String]
-      def to_yaml( options = {} )
-        parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
+      # @return [Hash]
+      def to_yaml_data
+         parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
 
         RCAP.attribute_values_to_hash( [ LANGUAGE_YAML,       @language ],
                                        [ CATEGORIES_YAML,     @categories ],
@@ -213,8 +213,13 @@ module RCAP
                                        [ CONTACT_YAML,        @contact ],
                                        [ EVENT_CODES_YAML,    @event_codes.inject({}, &parameter_to_hash )],
                                        [ PARAMETERS_YAML,     @parameters.inject({}, &parameter_to_hash )],
-                                       [ RESOURCES_YAML,      @resources ],
-                                       [ AREAS_YAML,          @areas ]).to_yaml( options )
+                                       [ RESOURCES_YAML,      @resources.map( &:to_yaml_data )],
+                                       [ AREAS_YAML,          @areas.map( &:to_yaml_data )])
+      end
+
+      # @return [String]
+      def to_yaml( options = {} )
+        self.to_yaml_data.to_yaml( options )
       end
 
       # @param [Hash] info_yaml_data

data/lib/rcap/cap_1_1/resource.rb

@@ -55,15 +55,19 @@ module RCAP
 
       DEREF_URI_YAML     = "Derefrenced URI Data"
 
-      # @param [Hash] options
-      # @return [String]
-      def to_yaml( options = {} )
+      def to_yaml_data
         RCAP.attribute_values_to_hash( [ RESOURCE_DESC_YAML, @resource_desc ],
                                        [ URI_YAML,           @uri ],
                                        [ MIME_TYPE_YAML,     @mime_type ],
                                        [ DEREF_URI_YAML,     @deref_uri ],
                                        [ SIZE_YAML,          @size ],
-                                       [ DIGEST_YAML,        @digest ]).to_yaml( options )
+                                       [ DIGEST_YAML,        @digest ])
+      end
+
+      # @param [Hash] options
+      # @return [String]
+      def to_yaml( options = {} )
+        self.to_yaml_data.to_yaml( options )
       end
 
       # @param [Hash] resource_yaml_data

data/lib/rcap/cap_1_2/info.rb

@@ -164,8 +164,8 @@ module RCAP
 
       RESPONSE_TYPES_YAML = 'Response Types'
 
-      # @return [String]
-      def to_yaml( options = {} )
+      # @return [Hash]
+      def to_yaml_data
         parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
 
         RCAP.attribute_values_to_hash( [ LANGUAGE_YAML,       @language ],
@@ -187,8 +187,13 @@ module RCAP
                                        [ CONTACT_YAML,        @contact ],
                                        [ EVENT_CODES_YAML,    @event_codes.inject({}, &parameter_to_hash )],
                                        [ PARAMETERS_YAML,     @parameters.inject({}, &parameter_to_hash )],
-                                       [ RESOURCES_YAML,      @resources ],
-                                       [ AREAS_YAML,          @areas ]).to_yaml( options )
+                                       [ RESOURCES_YAML,      @resources.map( &:to_yaml_data )],
+                                       [ AREAS_YAML,          @areas.map( &:to_yaml_data )])
+      end
+
+      # @return [String]
+      def to_yaml( options = {} )
+        self.to_yaml_data.to_yaml( options )
       end
 
       # @param [Hash] info_yaml_data

data/lib/rcap/utilities.rb

@@ -131,7 +131,7 @@ module RCAP
   # if the string is given, String#strip and then String#to_f are applied
   # otherwise nil is returned.
   #
-  # @param [String] string
+  # @param [String] number
   # @return [Float,nil]
   def RCAP.to_f_if_given( number )
     if number
@@ -149,7 +149,7 @@ module RCAP
   # if the string is given, String#strip and then String#to_i are applied
   # otherwise nil is returned.
   #
-  # @param [String] string
+  # @param [String] number
   # @return [Integer,nil]
   def RCAP.to_i_if_given( number )
     if number

data/lib/rcap/version.rb

@@ -1,3 +1,3 @@
 module RCAP
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

metadata

@@ -1,87 +1,110 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rcap
-version: !ruby/object:Gem::Version 
-  version: 2.2.1
+version: !ruby/object:Gem::Version
+  version: 2.3.0
 platform: ruby
-authors: 
+authors:
 - Farrel Lifson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: assistance
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.1.5
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: uuidtools
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id006 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-description: A Ruby API providing parsing, generation and validation of CAP(Common Alerting Protocol) messages.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby API providing parsing, generation and validation of CAP(Common
+  Alerting Protocol) messages.
+email:
 - farrel.lifson@aimred.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - CHANGELOG.md
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -190,28 +213,28 @@ files:
 - spec/validations_spec.rb
 homepage: http://www.aimred.com/projects/rcap
 licenses: []
-
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rcap
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: CAP(Common Alerting Protocol) API
-test_files: 
+test_files:
 - spec/alert_spec.rb
 - spec/assets/amber.atom
 - spec/assets/canada.cap