module Echosign::Validatable

Public Instance Methods

require_exactly_one(field_group, params) click to toggle source
# File lib/echosign/validatable.rb, line 12
def require_exactly_one(field_group, params)
  set_fields = 0
  field_group.each do |field|
    begin
      validate_field(field, params)
    rescue RequiredParameterError
      next
    else
      set_fields += 1
    end
  end
  raise ParameterError, "Exactly one of #{field_group} should be present" if set_fields != 1
end
require_keys(required_fields, params) click to toggle source
# File lib/echosign/validatable.rb, line 6
def require_keys(required_fields, params)
  required_fields.each do |field|
    validate_field(field, params)
  end
end
validate_field(field, params) click to toggle source

TODO (bernardworthy) A validator accepting a block for conditional execution might be useful. Maybe require_keys should accept a block. Figure out later.

# File lib/echosign/validatable.rb, line 30
def validate_field(field, params)
  begin
    value = params.fetch(field)
    required_error(field) if value.nil? || (value.is_a?(String) && value.empty?)
  rescue KeyError
    required_error(field)
  end
end

Private Instance Methods

blank?(field) click to toggle source

If blank? did not exist, we would need to invent it.

# File lib/echosign/validatable.rb, line 46
def blank?(field)
  field.nil? || field.empty?
end
required_error(field) click to toggle source
# File lib/echosign/validatable.rb, line 41
def required_error(field)
  raise RequiredParameterError, "Nil, empty or missing required parameter: #{field}"
end