rcap 2.4.1 → 2.7.3

data/lib/rcap/cap_1_0/alert.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
     # An Alert object is valid if
     # * it has an identifier
     # * it has a sender
@@ -10,12 +11,11 @@ module RCAP
     # * it has a valid scope value
     # * all Info objects contained in infos are valid
     class Alert < RCAP::Base::Alert
-
-      XMLNS = "http://www.incident.com/cap/1.0"
-      CAP_VERSION = "1.0"
+      XMLNS = 'http://www.incident.com/cap/1.0'
+      CAP_VERSION = '1.0'
 
       # @return [String]
-      attr_accessor( :password )
+      attr_accessor(:password)
 
       # @return [String]
       def xmlns
@@ -27,138 +27,137 @@ module RCAP
         Info
       end
 
-      PASSWORD_ELEMENT_NAME    = 'password'
+      PASSWORD_ELEMENT_NAME = 'password'
 
       # @return [REXML::Element]
       def to_xml_element
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_namespace( XMLNS )
-        xml_element.add_element( IDENTIFIER_ELEMENT_NAME ).add_text( @identifier )   if @identifier
-        xml_element.add_element( SENDER_ELEMENT_NAME ).add_text( @sender )           if @sender
-        xml_element.add_element( SENT_ELEMENT_NAME ).add_text( @sent.to_s_for_cap )  if @sent
-        xml_element.add_element( STATUS_ELEMENT_NAME ).add_text( @status )           if @status
-        xml_element.add_element( MSG_TYPE_ELEMENT_NAME ).add_text( @msg_type )       if @msg_type
-        xml_element.add_element( PASSWORD_ELEMENT_NAME ).add_text( @password )       if @password
-        xml_element.add_element( SOURCE_ELEMENT_NAME ).add_text( @source )           if @source
-        xml_element.add_element( SCOPE_ELEMENT_NAME ).add_text( @scope )             if @scope
-        xml_element.add_element( RESTRICTION_ELEMENT_NAME ).add_text( @restriction ) if @restriction
+        xml_element = REXML::Element.new(XML_ELEMENT_NAME)
+        xml_element.add_namespace(XMLNS)
+        xml_element.add_element(IDENTIFIER_ELEMENT_NAME).add_text(@identifier)   if @identifier
+        xml_element.add_element(SENDER_ELEMENT_NAME).add_text(@sender)           if @sender
+        xml_element.add_element(SENT_ELEMENT_NAME).add_text(@sent.to_s_for_cap)  if @sent
+        xml_element.add_element(STATUS_ELEMENT_NAME).add_text(@status)           if @status
+        xml_element.add_element(MSG_TYPE_ELEMENT_NAME).add_text(@msg_type)       if @msg_type
+        xml_element.add_element(PASSWORD_ELEMENT_NAME).add_text(@password)       if @password
+        xml_element.add_element(SOURCE_ELEMENT_NAME).add_text(@source)           if @source
+        xml_element.add_element(SCOPE_ELEMENT_NAME).add_text(@scope)             if @scope
+        xml_element.add_element(RESTRICTION_ELEMENT_NAME).add_text(@restriction) if @restriction
         if @addresses.any?
-          xml_element.add_element( ADDRESSES_ELEMENT_NAME ).add_text( @addresses.to_s_for_cap )
+          xml_element.add_element(ADDRESSES_ELEMENT_NAME).add_text(@addresses.to_s_for_cap)
         end
         @codes.each do |code|
-          xml_element.add_element( CODE_ELEMENT_NAME ).add_text( code )
+          xml_element.add_element(CODE_ELEMENT_NAME).add_text(code)
         end
-        xml_element.add_element( NOTE_ELEMENT_NAME ).add_text( @note ) if @note
+        xml_element.add_element(NOTE_ELEMENT_NAME).add_text(@note) if @note
         if @references.any?
-          xml_element.add_element( REFERENCES_ELEMENT_NAME ).add_text( @references.join( ' ' ))
+          xml_element.add_element(REFERENCES_ELEMENT_NAME).add_text(@references.join(' '))
         end
         if @incidents.any?
-          xml_element.add_element( INCIDENTS_ELEMENT_NAME ).add_text( @incidents.join( ' ' ))
+          xml_element.add_element(INCIDENTS_ELEMENT_NAME).add_text(@incidents.join(' '))
         end
         @infos.each do |info|
-          xml_element.add_element( info.to_xml_element )
+          xml_element.add_element(info.to_xml_element)
         end
         xml_element
       end
 
       # @return [String]
       def inspect
-        alert_inspect = [ "CAP Version:  #{ CAP_VERSION }",
-                          "Identifier:   #{ @identifier }",
-                          "Sender:       #{ @sender }",
-                          "Sent:         #{ @sent }",
-                          "Status:       #{ @status }",
-                          "Message Type: #{ @msg_type }",
-                          "Password:     #{ @password }",
-                          "Source:       #{ @source }",
-                          "Scope:        #{ @scope }",
-                          "Restriction:  #{ @restriction }",
-                          "Addresses:    #{ @addresses.to_s_for_cap }",
-                          "Codes:",
-                          @codes.map{ |code| "  " + code }.join("\n"),
-                          "Note:         #{ @note }",
-                          "References:   #{ @references.join( ' ' )}",
-                          "Incidents:    #{ @incidents.join( ' ')}",
-                          "Information:",
-                          @infos.map{ |info| "  " + info.to_s }.join( "\n" )].join("\n")
-        RCAP.format_lines_for_inspect( 'ALERT', alert_inspect )
+        alert_inspect = ["CAP Version:  #{CAP_VERSION}",
+                         "Identifier:   #{@identifier}",
+                         "Sender:       #{@sender}",
+                         "Sent:         #{@sent}",
+                         "Status:       #{@status}",
+                         "Message Type: #{@msg_type}",
+                         "Password:     #{@password}",
+                         "Source:       #{@source}",
+                         "Scope:        #{@scope}",
+                         "Restriction:  #{@restriction}",
+                         "Addresses:    #{@addresses.to_s_for_cap}",
+                         'Codes:',
+                         @codes.map { |code| '  ' + code }.join("\n"),
+                         "Note:         #{@note}",
+                         'References:',
+                         @references.join("\n "),
+                         "Incidents:    #{@incidents.join(' ')}",
+                         'Information:',
+                         @infos.map { |info| '  ' + info.to_s }.join("\n")].join("\n")
+        RCAP.format_lines_for_inspect('ALERT', alert_inspect)
       end
 
-
-      PASSWORD_XPATH    = "cap:#{ PASSWORD_ELEMENT_NAME }"
+      PASSWORD_XPATH = "cap:#{PASSWORD_ELEMENT_NAME}"
 
       # @param [REXML::Element] alert_xml_element
       # @return [RCAP::CAP_1_0::Alert]
-      def self.from_xml_element( alert_xml_element )
+      def self.from_xml_element(alert_xml_element)
         super.tap do |alert|
-          alert.password = RCAP.xpath_text( alert_xml_element, PASSWORD_XPATH, Alert::XMLNS )
+          alert.password = RCAP.xpath_text(alert_xml_element, PASSWORD_XPATH, Alert::XMLNS)
         end
       end
 
-
-      PASSWORD_YAML    = "Password"
+      PASSWORD_YAML = 'Password'
 
       # Returns a string containing the YAML representation of the alert.
       #
       # @return [String]
-      def to_yaml( options = {} )
-        RCAP.attribute_values_to_hash( [ CAP_VERSION_YAML, CAP_VERSION ],
-                                       [ IDENTIFIER_YAML,  @identifier ],
-                                       [ SENDER_YAML,      @sender ],
-                                       [ SENT_YAML,        @sent ],
-                                       [ STATUS_YAML,      @status ],
-                                       [ MSG_TYPE_YAML,    @msg_type ],
-                                       [ PASSWORD_YAML,    @password ],
-                                       [ SOURCE_YAML,      @source ],
-                                       [ SCOPE_YAML,       @scope ],
-                                       [ RESTRICTION_YAML, @restriction ],
-                                       [ ADDRESSES_YAML,   @addresses ],
-                                       [ CODES_YAML,       @codes ],
-                                       [ NOTE_YAML,        @note ],
-                                       [ REFERENCES_YAML,  @references ],
-                                       [ INCIDENTS_YAML,   @incidents ],
-                                       [ INFOS_YAML,       @infos.map( &:to_yaml_data )]).to_yaml( options )
+      def to_yaml(options = {})
+        RCAP.attribute_values_to_hash([CAP_VERSION_YAML, CAP_VERSION],
+                                      [IDENTIFIER_YAML,  @identifier],
+                                      [SENDER_YAML,      @sender],
+                                      [SENT_YAML,        @sent],
+                                      [STATUS_YAML,      @status],
+                                      [MSG_TYPE_YAML,    @msg_type],
+                                      [PASSWORD_YAML,    @password],
+                                      [SOURCE_YAML,      @source],
+                                      [SCOPE_YAML,       @scope],
+                                      [RESTRICTION_YAML, @restriction],
+                                      [ADDRESSES_YAML,   @addresses],
+                                      [CODES_YAML,       @codes],
+                                      [NOTE_YAML,        @note],
+                                      [REFERENCES_YAML,  @references],
+                                      [INCIDENTS_YAML,   @incidents],
+                                      [INFOS_YAML,       @infos.map(&:to_yaml_data)]).to_yaml(options)
       end
 
       # @param [Hash] alert_yaml_data
       # @return [RCAP::CAP_1_0::Alert]
-      def self.from_yaml_data( alert_yaml_data )
+      def self.from_yaml_data(alert_yaml_data)
         super.tap do |alert|
-          alert.password = RCAP.strip_if_given( alert_yaml_data[ PASSWORD_YAML ])
+          alert.password = RCAP.strip_if_given(alert_yaml_data[PASSWORD_YAML])
         end
       end
 
-      PASSWORD_KEY    = 'password'
+      PASSWORD_KEY = 'password'
 
       # Returns a Hash representation of an Alert object
       #
       # @return [Hash]
       def to_h
-        RCAP.attribute_values_to_hash( [ CAP_VERSION_KEY, CAP_VERSION ],
-                                       [ IDENTIFIER_KEY,   @identifier ],
-                                       [ SENDER_KEY,       @sender ],
-                                       [ SENT_KEY,         RCAP.to_s_for_cap( @sent )],
-                                       [ STATUS_KEY,       @status ],
-                                       [ MSG_TYPE_KEY,     @msg_type ],
-                                       [ PASSWORD_KEY,     @password ],
-                                       [ SOURCE_KEY,       @source ],
-                                       [ SCOPE_KEY,        @scope ],
-                                       [ RESTRICTION_KEY,  @restriction ],
-                                       [ ADDRESSES_KEY,    @addresses ],
-                                       [ CODES_KEY,        @codes ],
-                                       [ NOTE_KEY,         @note ],
-                                       [ REFERENCES_KEY,   @references ],
-                                       [ INCIDENTS_KEY,    @incidents ],
-                                       [ INFOS_KEY,        @infos.map{ |info| info.to_h  }])
+        RCAP.attribute_values_to_hash([CAP_VERSION_KEY, CAP_VERSION],
+                                      [IDENTIFIER_KEY,   @identifier],
+                                      [SENDER_KEY,       @sender],
+                                      [SENT_KEY,         RCAP.to_s_for_cap(@sent)],
+                                      [STATUS_KEY,       @status],
+                                      [MSG_TYPE_KEY,     @msg_type],
+                                      [PASSWORD_KEY,     @password],
+                                      [SOURCE_KEY,       @source],
+                                      [SCOPE_KEY,        @scope],
+                                      [RESTRICTION_KEY,  @restriction],
+                                      [ADDRESSES_KEY,    @addresses],
+                                      [CODES_KEY,        @codes],
+                                      [NOTE_KEY,         @note],
+                                      [REFERENCES_KEY,   @references],
+                                      [INCIDENTS_KEY,    @incidents],
+                                      [INFOS_KEY,        @infos.map(&:to_h)])
       end
 
       # Initialises an Alert object from a Hash produced by Alert#to_h
       #
       # @param [Hash] alert_hash
       # @return [RCAP::CAP_1_0::Alert]
-      def self.from_h( alert_hash )
+      def self.from_h(alert_hash)
         super.tap do |alert|
-          alert.password = RCAP.strip_if_given( alert_hash[ PASSWORD_KEY ])
+          alert.password = RCAP.strip_if_given(alert_hash[PASSWORD_KEY])
         end
       end
     end

data/lib/rcap/cap_1_0/area.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
     # An Area object is valid if
     # * it has an area description
     # * all Circle objects contained in circles are valid
@@ -8,7 +9,6 @@ module RCAP
     # * all Polygon objects contained in polygons are valid
     # * altitude has a value if ceiling is set
     class Area < RCAP::Base::Area
-
       # @return [String]
       def xmlns
         Alert::XMLNS

data/lib/rcap/cap_1_0/circle.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
     # A Circle object is valid if
     # * it has a valid lattitude and longitude
     # * it has a radius with a value greater than zero

data/lib/rcap/cap_1_0/event_code.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # Subclass of {Parameter}
     class EventCode < RCAP::Base::EventCode
       XML_ELEMENT_NAME = 'eventCode'
-      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+      XPATH = "cap:#{XML_ELEMENT_NAME}"
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_0/geocode.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # Subclass of {Parameter}
     class Geocode < RCAP::Base::Geocode
       XML_ELEMENT_NAME = 'geocode'
-      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+      XPATH = "cap:#{XML_ELEMENT_NAME}"
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_0/info.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
     # In Info object is valid if
     # * it has an event
     # * it has an urgency with a valid value
@@ -10,8 +11,7 @@ module RCAP
     # * all Resource objects in the resources collection are valid
     # * all Area objects in the areas collection are valid
     class Info < RCAP::Base::Info
-
-      validates_inclusion_of( :certainty, :allow_nil => true, :in => VALID_CERTAINTIES, :message => "can only be assigned the following values: #{ VALID_CERTAINTIES.join(', ') }")
+      validates_inclusion_of(:certainty, allow_nil: true, in: VALID_CERTAINTIES, message: "can only be assigned the following values: #{VALID_CERTAINTIES.join(', ')}")
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_0/parameter.rb

@@ -1,34 +1,34 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # A Parameter object is valid if
     # * it has a name
-    # * it has a value
     class Parameter < RCAP::Base::Parameter
-
       # @return [REXML::Element]
       def to_xml_element
-        xml_element = REXML::Element.new( self.class::XML_ELEMENT_NAME )
-        xml_element.add_text( "#{ @name }=#{ @value }")
+        xml_element = REXML::Element.new(self.class::XML_ELEMENT_NAME)
+        xml_element.add_text("#{@name}=#{@value}")
         xml_element
       end
 
       # @param [REXML::Element] parameter_xml_element
       # @return [Parameter]
-      def self.from_xml_element( parameter_xml_element )
-        parameter_hash = self.parse_parameter( parameter_xml_element.text )
-        self.new do |parameter|
-          parameter.name   = RCAP.strip_if_given( parameter_hash[ :name ])
-          parameter.value  = RCAP.strip_if_given( parameter_hash[ :value ])
+      def self.from_xml_element(parameter_xml_element)
+        parameter_hash = parse_parameter(parameter_xml_element.text)
+        new do |parameter|
+          parameter.name   = RCAP.strip_if_given(parameter_hash[:name])
+          parameter.value  = RCAP.strip_if_given(parameter_hash[:value])
         end
       end
 
       # @param [String] parameter_string
       # @return [Hash]
-      def self.parse_parameter( parameter_string )
-        name, value = parameter_string.split("=")
+      def self.parse_parameter(parameter_string)
+        name, value = parameter_string.split('=')
         if name && value
-          { :name  => RCAP.strip_if_given( name ),
-            :value => RCAP.strip_if_given( value )}
+          { name: RCAP.strip_if_given(name),
+            value: RCAP.strip_if_given(value) }
         end
       end
     end

data/lib/rcap/cap_1_0/point.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
     # A Point object is valid if
     # * it has a lattitude within the minimum and maximum lattitude values
     # * it has a longitude within the minimum and maximum longitude values

data/lib/rcap/cap_1_0/polygon.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
     # A Polygon object is valid if
-    # * it has a minimum of three points
+    # * if points are given it has a minimum of three points
     # * each Point object in the points collection is valid
     class Polygon < RCAP::Base::Polygon
-
       # @return [Class]
       def point_class
         Point

data/lib/rcap/cap_1_0/resource.rb

@@ -1,11 +1,10 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
-
-
     # A Resource object is valid if
     # * it has a resource description
     class Resource < RCAP::Base::Resource
-
       # @return [String]
       def xmlns
         Alert::XMLNS

data/lib/rcap/cap_1_1/alert.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
-
     # An Alert object is valid if
     # * it has an identifier
     # * it has a sender
@@ -10,13 +11,12 @@ module RCAP
     # * it has a valid scope value
     # * all Info objects contained in infos are valid
     class Alert < RCAP::Base::Alert
+      XMLNS = 'urn:oasis:names:tc:emergency:cap:1.1'
+      CAP_VERSION = '1.1'
 
-      XMLNS = "urn:oasis:names:tc:emergency:cap:1.1"
-      CAP_VERSION = "1.1"
-
-      STATUS_DRAFT    = "Draft"
+      STATUS_DRAFT = 'Draft'
       # Valid values for status
-      VALID_STATUSES = [ STATUS_ACTUAL, STATUS_EXERCISE, STATUS_SYSTEM, STATUS_TEST, STATUS_DRAFT ]
+      VALID_STATUSES = [STATUS_ACTUAL, STATUS_EXERCISE, STATUS_SYSTEM, STATUS_TEST, STATUS_DRAFT].freeze
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_1/area.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
-
     # An Area object is valid if
     # * it has an area description
     # * all Circle objects contained in circles are valid
@@ -8,7 +9,6 @@ module RCAP
     # * all Polygon objects contained in polygons are valid
     # * altitude has a value if ceiling is set
     class Area < RCAP::Base::Area
-
       # @return [String]
       def xmlns
         Alert::XMLNS