rcap 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bb205d2fab692f7bd6b270029a96918a32eea19
-  data.tar.gz: fd94605d3d3a99040c3cf183cc873f0db15dd64b
+  metadata.gz: 548ad24cc10525bee68f71efb84786a0f490419f
+  data.tar.gz: 4baf6cbd9b0b98973f139181d69a968b3c16dc50
 SHA512:
-  metadata.gz: a3c720fc8e87dddd70b4dc92f03d2eab1ff21875c33b9c83b8b714e35e4fa0bdb1d065c945b67c55d9bac02f037ac8941172eff5e943fb6209871a6095cd2126
-  data.tar.gz: 93bf5df1405126c70f80894da9bf0b40b10f8089c17d8877d0c92e6c0fb047475ef843aceaadc5cdd5a48d5691b7a17b044628c4821aca5bbee21653928d5eac
+  metadata.gz: 11bf3c92150c6ce9585e675208ce7553427e83c10de6a0d91fa50919c038eba254c2eefaf7902fedccb60109949d2f2a58eecb3297fa28ea526498be8e92b50f
+  data.tar.gz: e0660c2f73fd50bdd268221b496e32d018a2a86c55734ca31ec3c11e66bddad4445eea4efd6de6c92739812203b19a7eae1da19470447d76090483d75631c217

data/.gitignore

@@ -6,3 +6,4 @@ tags
 .bundle
 Gemfile.lock
 .yardoc
+*.sublime-*

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Change Log
 ==========
 
+## 2.4.0 - 29 July 2014
+
+* Removed assistance gem and extracted validations into a local file. (David van Geest)
+
 ## 2.3.0 - 6 March 2014
 
 * Fixed YAML import and export. 

data/README.md

@@ -13,7 +13,6 @@ Dependencies
 
 RCAP depends on the following gems
 
-* [Assistance](http://assistance.rubyforge.org)
 * [UUIDTools](http://uuidtools.rubyforge.org)
 * [JSON](http://json.rubyforge.org)
 
@@ -33,7 +32,7 @@ Usage
 
 ### Creating an Alert
 
-RCAP uses a 'builder' style syntax to create alerts. 
+RCAP uses a 'builder' style syntax to create alerts.
 
     require 'rcap'
 
@@ -41,13 +40,13 @@ RCAP uses a 'builder' style syntax to create alerts.
       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.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.categories  << Info::CATEGORY_FIRE
         info.urgency     = Info::URGENCY_IMMEDIATE
         info.severity    = Info::SEVERITY_SEVERE
         info.certainty   = Info::CERTAINTY_OBSERVED
@@ -55,18 +54,18 @@ RCAP uses a 'builder' style syntax to create alerts.
         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.' 
-    
+                            alternate routes.'
+
         info.add_area do |area|
-          area.area_desc = 'N2 Highway/R300 Interchange' 
+          area.area_desc = 'N2 Highway/R300 Interchange'
           area.add_geocode do |geocode|
             geocode.name  = 'Intersection'
-            geocode.value = 'N2-15' 
+            geocode.value = 'N2-15'
           end
         end
       end
     end
-   
+
     # Accessing attributes
     puts alert.status                 # "Actual"
     info = alert.infos.first
@@ -128,7 +127,7 @@ The RCAP API aims to codify as many of the rules of the CAP XML format into vali
       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 }" }
 
@@ -146,7 +145,7 @@ 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)
+* A CAP Validator based on RCAP can be found at [http://capvalidator.herokuapp.com](http://capvalidator.herokuapp.com)
 
 Authors
 -------
@@ -156,6 +155,7 @@ Authors
 ### Contributors
 
 * Earle Clubb - http://github.com/eclubb
+* David van Geest - https://github.com/DWvanGeest
 
 Change Log
 ----------

data/lib/assistance/extract_options.rb

@@ -0,0 +1,14 @@
+# Array extensions
+class Array
+  # Removes and returns the last member of the array if it is a hash. Otherwise,
+  # an empty hash is returned This method is useful when writing methods that
+  # take an options hash as the last parameter. For example:
+  #
+  #   def validate_each(*args, &block)
+  #     opts = args.extract_options!
+  #     ...
+  #   end
+  def extract_options!
+    last.is_a?(Hash) ? pop : {}
+  end
+end

data/lib/assistance/validation.rb

@@ -0,0 +1,251 @@
+# This file is ripped directly from the no-longer-maintained assistance gem. Other code in that gem
+# was causing issues, so I'm putting the needed code directly in rcap as a workaround.
+
+# See https://github.com/farrel/RCAP/issues/4
+
+# The Validations module provides validation capabilities as a mixin. When
+# included into a class, it enhances the class with class and instance
+# methods for defining validations and validating class instances.
+#
+# The Validation emulates the validation capabilities of ActiveRecord, and
+# provides methods for validating acceptance, confirmation, presence, format,
+# length and numericality of attributes.
+#
+# To use validations, you need to include the Validation module in your
+# class:
+#
+#   class MyClass
+#     include Validation
+#     validates_length_of :password, :minimum => 6
+#   end
+module Validation
+  # Includes the Validation class methods into the including class.
+  def self.included(c)
+    c.extend ClassMethods
+  end
+
+  # Returns the validation errors associated with the object.
+  def errors
+    @errors ||= Errors.new
+  end
+
+  # Validates the object.
+  def validate
+    errors.clear
+    self.class.validate(self)
+  end
+
+  # Validates the object and returns true if no errors are reported.
+  def valid?
+    validate
+    errors.empty?
+  end
+
+  # Validation::Errors represents validation errors.
+  class Errors
+    # Initializes a new instance of validation errors.
+    def initialize
+      @errors = Hash.new {|h, k| h[k] = []}
+    end
+
+    # Returns true if no errors are stored.
+    def empty?
+      @errors.empty?
+    end
+
+    # Clears all errors.
+    def clear
+      @errors.clear
+    end
+
+    # Returns the errors for the given attribute.
+    def on(att)
+      @errors[att]
+    end
+    alias_method :[], :on
+
+    # Adds an error for the given attribute.
+    def add(att, msg)
+      @errors[att] << msg
+    end
+
+    # Returns an array of fully-formatted error messages.
+    def full_messages
+      @errors.inject([]) do |m, kv| att, errors = *kv
+        errors.each {|e| m << "#{att} #{e}"}
+        m
+      end
+    end
+  end
+
+  # The Generator class is used to generate validation definitions using
+  # the validates {} idiom.
+  class Generator
+    # Initializes a new generator.
+    def initialize(receiver ,&block)
+      @receiver = receiver
+      instance_eval(&block)
+    end
+
+    # Delegates method calls to the receiver by calling receiver.validates_xxx.
+    def method_missing(m, *args, &block)
+      @receiver.send(:"validates_#{m}", *args, &block)
+    end
+  end
+
+  # Validation class methods.
+  module ClassMethods
+    # Defines validations by converting a longhand block into a series of
+    # shorthand definitions. For example:
+    #
+    #   class MyClass
+    #     include Validation
+    #     validates do
+    #       length_of :name, :minimum => 6
+    #       length_of :password, :minimum => 8
+    #     end
+    #   end
+    #
+    # is equivalent to:
+    #   class MyClass
+    #     include Validation
+    #     validates_length_of :name, :minimum => 6
+    #     validates_length_of :password, :minimum => 8
+    #   end
+    def validates(&block)
+      Generator.new(self, &block)
+    end
+
+    # Returns the validations hash for the class.
+    def validations
+      @validations ||= Hash.new {|h, k| h[k] = []}
+    end
+
+    # Returns true if validations are defined.
+    def has_validations?
+      !validations.empty?
+    end
+
+    # Validates the given instance.
+    def validate(o)
+      if superclass.respond_to?(:validate) && !@skip_superclass_validations
+        superclass.validate(o)
+      end
+      validations.each do |att, procs|
+        v = o.send(att)
+        procs.each {|p| p[o, att, v]}
+      end
+    end
+
+    def skip_superclass_validations
+      @skip_superclass_validations = true
+    end
+
+    # Adds a validation for each of the given attributes using the supplied
+    # block. The block must accept three arguments: instance, attribute and
+    # value, e.g.:
+    #
+    #   validates_each :name, :password do |object, attribute, value|
+    #     object.errors[attribute] << 'is not nice' unless value.nice?
+    #   end
+    def validates_each(*atts, &block)
+      atts.each {|a| validations[a] << block}
+    end
+
+    # Validates acceptance of an attribute.
+    def validates_acceptance_of(*atts)
+      opts = {
+        :message => 'is not accepted',
+        :allow_nil => true,
+        :accept => '1'
+      }.merge!(atts.extract_options!)
+
+      validates_each(*atts) do |o, a, v|
+        next if (v.nil? && opts[:allow_nil]) || (v.blank? && opts[:allow_blank])
+        o.errors[a] << opts[:message] unless v == opts[:accept]
+      end
+    end
+
+    # Validates confirmation of an attribute.
+    def validates_confirmation_of(*atts)
+      opts = {
+        :message => 'is not confirmed',
+      }.merge!(atts.extract_options!)
+
+      validates_each(*atts) do |o, a, v|
+        next if (v.nil? && opts[:allow_nil]) || (v.blank? && opts[:allow_blank])
+        c = o.send(:"#{a}_confirmation")
+        o.errors[a] << opts[:message] unless v == c
+      end
+    end
+
+    # Validates the format of an attribute.
+    def validates_format_of(*atts)
+      opts = {
+        :message => 'is invalid',
+      }.merge!(atts.extract_options!)
+
+      unless opts[:with].is_a?(Regexp)
+        raise ArgumentError, "A regular expression must be supplied as the :with option of the options hash"
+      end
+
+      validates_each(*atts) do |o, a, v|
+        next if (v.nil? && opts[:allow_nil]) || (v.blank? && opts[:allow_blank])
+        o.errors[a] << opts[:message] unless v.to_s =~ opts[:with]
+      end
+    end
+
+    # Validates the length of an attribute.
+    def validates_length_of(*atts)
+      opts = {
+        :too_long     => 'is too long',
+        :too_short    => 'is too short',
+        :wrong_length => 'is the wrong length'
+      }.merge!(atts.extract_options!)
+
+      validates_each(*atts) do |o, a, v|
+        next if (v.nil? && opts[:allow_nil]) || (v.blank? && opts[:allow_blank])
+        if m = opts[:maximum]
+          o.errors[a] << (opts[:message] || opts[:too_long]) unless v && v.size <= m
+        end
+        if m = opts[:minimum]
+          o.errors[a] << (opts[:message] || opts[:too_short]) unless v && v.size >= m
+        end
+        if i = opts[:is]
+          o.errors[a] << (opts[:message] || opts[:wrong_length]) unless v && v.size == i
+        end
+        if w = opts[:within]
+          o.errors[a] << (opts[:message] || opts[:wrong_length]) unless v && w.include?(v.size)
+        end
+      end
+    end
+
+    NUMBER_RE = /^\d*\.{0,1}\d+$/
+    INTEGER_RE = /\A[+-]?\d+\Z/
+
+    # Validates whether an attribute is a number.
+    def validates_numericality_of(*atts)
+      opts = {
+        :message => 'is not a number',
+      }.merge!(atts.extract_options!)
+
+      re = opts[:only_integer] ? INTEGER_RE : NUMBER_RE
+
+      validates_each(*atts) do |o, a, v|
+        next if (v.nil? && opts[:allow_nil]) || (v.blank? && opts[:allow_blank])
+        o.errors[a] << opts[:message] unless v.to_s =~ re
+      end
+    end
+
+    # Validates the presence of an attribute.
+    def validates_presence_of(*atts)
+      opts = {
+        :message => 'is not present',
+      }.merge!(atts.extract_options!)
+
+      validates_each(*atts) do |o, a, v|
+        o.errors[a] << opts[:message] unless v && !v.blank?
+      end
+    end
+  end
+end

data/lib/rcap/extensions/array.rb

@@ -8,4 +8,8 @@ class Array
   def to_s_for_cap
     self.map{ |element| element.to_s.for_cap_list }.join( ' ' )
   end
+
+  def blank?
+    empty?
+  end
 end

data/lib/rcap/extensions/date_time.rb

@@ -10,6 +10,10 @@ class DateTime
     t.sub(/\+(00:\d\d)$/, '-\1')
   end
 
+  def blank?
+    false
+  end
+
   private
   def utc_hours_offset
     self.offset * 24

data/lib/rcap/extensions/fixnum.rb

@@ -0,0 +1,5 @@
+class Fixnum
+  def blank?
+    false
+  end
+end

data/lib/rcap/extensions/float.rb

@@ -0,0 +1,5 @@
+class Float
+  def blank?
+    false
+  end
+end

data/lib/rcap/extensions/nil_class.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def blank?
+    true
+  end
+end

data/lib/rcap/extensions/string.rb

@@ -26,4 +26,8 @@ class String
   def unpack_cap_list
     self.split( CAP_LIST_REGEX ).reject{ |match| match == "" || match =~ WHITESPACE_REGEX }
   end
+
+  def blank?
+    empty?
+  end
 end

data/lib/rcap/version.rb

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

data/lib/rcap.rb

@@ -1,6 +1,5 @@
 # System and require libs
 require 'date'
-require 'assistance'
 require 'uuidtools'
 require 'yaml'
 require 'json'
@@ -10,7 +9,14 @@ require 'open-uri'
 require 'base64'
 require 'digest/sha1'
 
+# these files are taken from the defunct assitance gem and are included as source in this gem
+require 'assistance/extract_options'
+require 'assistance/validation'
+
 # Extensions
+require 'rcap/extensions/nil_class'
+require 'rcap/extensions/fixnum'
+require 'rcap/extensions/float'
 require 'rcap/extensions/array'
 require 'rcap/extensions/string'
 require 'rcap/extensions/date_time'

data/rcap.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   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')
 

data/spec/alert_spec.rb

@@ -257,7 +257,7 @@ describe( RCAP::Alert ) do
 
         @alert.infos.size.should == 2
         info = @alert.infos.first
-        info.categories.include?( RCAP::CAP_1_1::Info::CATEGORY_GEO ).should( be_true )
+        info.categories.include?( RCAP::CAP_1_1::Info::CATEGORY_GEO ).should eq true
 
         info.areas.size.should == 1
         area = info.areas.first

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rcap
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Farrel Lifson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: assistance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.5
-  type: :runtime
-  prerelease: false
-  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
@@ -109,6 +95,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- lib/assistance/extract_options.rb
+- lib/assistance/validation.rb
 - lib/rcap.rb
 - lib/rcap/alert.rb
 - lib/rcap/base/alert.rb
@@ -155,6 +143,9 @@ files:
 - lib/rcap/extensions/array.rb
 - lib/rcap/extensions/date.rb
 - lib/rcap/extensions/date_time.rb
+- lib/rcap/extensions/fixnum.rb
+- lib/rcap/extensions/float.rb
+- lib/rcap/extensions/nil_class.rb
 - lib/rcap/extensions/string.rb
 - lib/rcap/extensions/time.rb
 - lib/rcap/info.rb