despecable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a990382ac0e881252fdba00bb3da79c83efd94b
-  data.tar.gz: 968824fbdd35b569e35480c1ff8e44e56e8d9f37
+  metadata.gz: 290a992d2845a837ff7ce19c2fab3dccb6777fcd
+  data.tar.gz: 4e6bda047e215fc133e20ad56c02ebc417719798
 SHA512:
-  metadata.gz: ec7b8ba68446f1e2b6ecc3b1695fae9794044ea19e166ca690bfa632b982f20558db7e6037068d76127c8181a3bf2a2866a6f86e8b8cd0580676c3dbd827896c
-  data.tar.gz: a6267c9f73c3545f0967954bc36d80bf7ca2aa020b77f2f0f90363a560832db8123fbdb69b6cd7a6cd233f6fddca2c300f1c3d4cd68313713117737e47747931
+  metadata.gz: c59f54e988d690ce171d1cfada645fa3790d4e3435cab086e16d3d8988aee03ca315446b87b82d02cd4763e1b3702e6ecd6db134de645d35963134d2352957fc
+  data.tar.gz: cc348e49a9cea4d797f788e0d9e1b5abbeb7ff3c778e552622a3cc9508b6a93862d3d3fe23805d8845d2e6ab9913aabc5c90871b37e5aa902d07a388b1d485b4

data/lib/despecable/errors/despecable_error.rb

@@ -1,15 +1,15 @@
 class Despecable::DespecableError < StandardError
-  def despecable_message
-    message == self.class.to_s ? nil : message
-  end
+  attr_accessor :parameters
+  protected :parameters=
 
-  def insert_name_here(name)
-    msg = introduction(name)
-    msg += " " + despecable_message unless despecable_message.nil?
-    return exception(msg)
+  def initialize(*args, parameters: [])
+    @parameters = [*parameters].map(&:to_s)
+    super(*args)
   end
 
-  def introduction(name)
-    "Invalid value for parameter #{name}."
+  def exception(*args)
+    ex = super
+    ex.parameters = @parameters
+    return ex
   end
 end

data/lib/despecable/errors/unrecognized_parameter_error.rb

@@ -1,5 +1,5 @@
 class Despecable::UnrecognizedParameterError < Despecable::DespecableError
-  def intro_message(name)
-    "Unrecognized parameter name: '#{name}'"
+  def introduction(name)
+    "Unrecognized parameter '#{name}'"
   end
 end

data/lib/despecable/me.rb

@@ -7,7 +7,7 @@ module Despecable
     # pass in request.query_parameters (GET) and/or request.request_parameters (POST)
     # for supplied_params to correctly get only the user-supplied parameters.
     def initialize(params, supplied_params = nil)
-      @supplied_params = (supplied_params || params).deep_dup
+      @supplied_params = (supplied_params || params).dup
       @params = params
       @specd = []
     end
@@ -27,7 +27,8 @@ module Despecable
     def despecably_strict
       if !unspecd.empty?
         list = unspecd.map{|x| "'#{x}'"}.join(", ")
-        raise Despecable::UnrecognizedParameterError, "Unrecognized parameters: #{list}"
+        error = Despecable::UnrecognizedParameterError.new("Unrecognized parameters supplied: #{list}", parameters: unspecd)
+        raise error
       end
     end
   end

data/lib/despecable/spectacles.rb

@@ -9,72 +9,72 @@ module Despecable
       value.to_s.split(",")
     end
 
-    def read(value, type, options)
-      value = public_send(type, value) unless value.nil?
-      validate_param(value, options)
+    def read(name, value, type, options)
+      value = public_send(type, name, value) unless value.nil?
+      validate_param(name, value, options)
       return value
     end
 
-    def validate_param(value, options)
-      validate_param_presence(value) if options[:required]
-      validate_param_value(value, options[:in]) if options.key?(:in) && !value.nil?
+    def validate_param(name, value, options)
+      validate_param_presence(name, value) if options[:required]
+      validate_param_value(name, value, options[:in]) if options.key?(:in) && !value.nil?
     end
 
-    def validate_param_presence(value)
-      raise Despecable::MissingParameterError if value.nil?
+    def validate_param_presence(name, value)
+      raise Despecable::MissingParameterError.new("Missing required parameter: #{name}", parameters: name) if value.nil?
     end
 
-    def validate_param_value(value, allowed_values)
-      raise Despecable::IncorrectParameterError, "Value received: #{value}." if !allowed_values.include?(value)
+    def validate_param_value(name, value, allowed_values)
+      raise Despecable::IncorrectParameterError.new("Unacceptable value for parameter: #{name}", parameters: name) if !allowed_values.include?(value)
     end
 
-    def integer(value)
+    def integer(name, value)
       Integer(value)
     rescue ArgumentError
       raise unless /^invalid value for Integer/ =~ $!.message
-      raise Despecable::InvalidParameterError, "Required type: integer"
+      raise Despecable::InvalidParameterError.new("Integer type required for parameter: #{name}", parameters: name)
     end
 
-    def float(value)
+    def float(name, value)
       Float(value)
     rescue ArgumentError
       raise unless /^invalid value for Float/ =~ $!.message
-      raise Despecable::InvalidParameterError, "Required type: float"
+      raise Despecable::InvalidParameterError.new("Float type required for parameter: #{name}", parameters: name)
     end
 
-    def string(value)
+    def string(name, value)
       # This is really a no-op.
       value.to_s
     end
 
-    def boolean(value)
+    def boolean(name, value)
       case value.to_s
       when "true", "1" then true
       when "false", "0", nil then false
-      else raise Despecable::InvalidParameterError, "Required type: boolean (1/0 or true/false)"
+      else raise Despecable::InvalidParameterError.new("Boolean type (1/0 or true/false) required for parameter: #{name}", parameters: name)
       end
     end
 
-    def date(value)
+    def date(name, value)
       Date.rfc3339(value + "T00:00:00+00:00")
     rescue ArgumentError
       raise unless $!.message == "invalid date"
-      raise Despecable::InvalidParameterError, "Required type: date (e.g. '2012-12-31')."
+      raise Despecable::InvalidParameterError.new("Date type (e.g. '2012-12-31') required for parameter: #{name}", parameters: name)
     end
 
-    def datetime(value)
+    def datetime(name, value)
       DateTime.rfc3339(value)
     rescue ArgumentError
       raise unless $!.message == "invalid date"
-      raise Despecable::InvalidParameterError, "Required type: rfc3339 datetime (e.g. '2009-06-19T00:00:00-04:00')."
+      raise Despecable::InvalidParameterError.new("Rfc3339 datetime type (e.g. '2009-06-19T00:00:00-04:00') required for parameter: #{name}", parameters: name)
     end
 
-    def file(value)
-      raise Despecable::InvalidParameterError, "Required type: file upload" if !(value.respond_to?(:original_filename) && value.original_filename.present?)
+    def file(name, value)
+      raise Despecable::InvalidParameterError.new("File upload type required for parameter: #{name}" , parameters: name) if !(value.respond_to?(:original_filename) && value.original_filename.present?)
       return value
     end
 
-    def any(value)
+    def any(name, value)
       value
     end
   end

data/lib/despecable/spectator.rb

@@ -48,17 +48,15 @@ module Despecable
         params[name] = options[:default]
       elsif options[:array]
         values = @spectacles.arrayify(params[name])
-        params[name] = values.map{|val| @spectacles.read(val, type, options)}
+        params[name] = values.map{|val| @spectacles.read(name, val, type, options)}
       elsif options[:arrayable] && @spectacles.arrayable?(params[name])
         # TODO: deprecate arrayable in favor of array
         values = @spectacles.arrayify(params[name])
-        params[name] = values.map{|val| @spectacles.read(val, type, options)}
+        params[name] = values.map{|val| @spectacles.read(name, val, type, options)}
       else
-        value = @spectacles.read(params[name], type, options)
+        value = @spectacles.read(name, params[name], type, options)
         params[name] = value if params.key?(name)
       end
-    rescue ::Despecable::DespecableError
-      ::Kernel.raise $!.insert_name_here(name)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: despecable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Schwartz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-14 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec