sinatra-param 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf5f1311ba75a60c4d17f503747120635cb7136e
-  data.tar.gz: b46df70795c76b593aac58002e2b97119838c545
+  metadata.gz: b64e12a2936520c3207c50339213644d8610709c
+  data.tar.gz: 41d317945c4128feb98c69f096797fc380932d38
 SHA512:
-  metadata.gz: 653a105893940b08c122286974d4b85096063364c41c2b15ac1fafe7aede753cd9522ba70a97cee11063973296cb3189141b34c1e4ae2e585e8e5948c22439c0
-  data.tar.gz: 93bbae31f59d4a92fd3bb899e545bde01af2e5dc032cba714cabb747fba2910994c6b4147961bec0d23010d6b1606aa7e2bde7c196723653c36021af59ceba53
+  metadata.gz: fef20f2728a516b7c19d85058d27119e9976e49f5f20d8a238de837c0637f7ad3fb2abc368ba48aa8a55ff8bcd8c93da48792bbba18c4ad47e48b8c95b79ea30
+  data.tar.gz: e1aa8c9c2f62bf7c44e349401aae77f880b27a40c7d1109e00a54256ac01ce489315aff0756f0214a4ea3fee11af7361b86186f45fe43d427be87568a999243c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sinatra-param (1.0.3)
+    sinatra-param (1.1.0)
       sinatra (~> 1.3)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     diff-lcs (1.2.4)
     multi_json (1.7.2)
     rack (1.5.2)
-    rack-protection (1.5.1)
+    rack-protection (1.5.2)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)

data/README.md

@@ -3,7 +3,7 @@ _Parameter Contracts for Sinatra_
 
 REST conventions take the guesswork out of designing and consuming web APIs. Simply `GET`, `POST`, `PATCH`, or `DELETE` resource endpoints, and you get what you'd expect.
 
-However, when it comes to figuring out what parameters are expected... well, all bets are off. 
+However, when it comes to figuring out what parameters are expected... well, all bets are off.
 
 This Sinatra extension takes a first step to solving this problem on the developer side
 
@@ -66,6 +66,35 @@ Passing a `default` option will provide a default value for a parameter if none
 
 Use the `transform` option to take even more of the business logic of parameter I/O out of your code. Anything that responds to `to_proc` (including Procs and symbols) will do.
 
+### Exceptions
+
+By default, when a parameter precondition fails, `Sinatra::Param` will `halt 400` with an error message:
+
+```json
+{
+    "errors": {
+        "order": "Param must be within [\"ASC\", \"DESC\"]"
+    },
+    "message": "Invalid parameter, order"
+}
+```
+
+To change this, you can set `:raise_sinatra_param_exceptions` to `true`, and intercept `Sinatra::Param::InvalidParameterError` with a Sinatra `error do...end` block. _(To make this work in development, set `:show_exceptions` to `false`)_:
+
+```ruby
+set :raise_sinatra_param_exceptions, true
+
+error Sinatra::Param::InvalidParameterError do
+    {error: "#{env['sinatra.error'].param} is invalid"}.to_json
+end
+```
+
+Custom exception handling can also be enabled on an individual parameter basis, by passing the `raise` option:
+
+```ruby
+param :order, String, in: ["ASC", "DESC"], raise: true
+```
+
 ## Contact
 
 Mattt Thompson

data/lib/sinatra/param/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Param
-    VERSION = '1.0.3'
+    VERSION = '1.1.0'
   end
 end

data/lib/sinatra/param.rb

@@ -7,7 +7,9 @@ module Sinatra
   module Param
     Boolean = :boolean
 
-    class InvalidParameterError < StandardError; end
+    class InvalidParameterError < StandardError
+      attr_accessor :param, :options
+    end
 
     def param(name, type, options = {})
       name = name.to_s
@@ -19,10 +21,15 @@ module Sinatra
         params[name] = options[:default] if params[name].nil? and options[:default]
         params[name] = options[:transform].to_proc.call(params[name]) if options[:transform]
         validate!(params[name], options)
-      rescue
-        error = "Invalid parameter, #{name}"
+      rescue InvalidParameterError => exception
+        if options[:raise] or (settings.raise_sinatra_param_exceptions rescue false)
+          exception.param, exception.options = name, options
+          raise exception
+        end
+
+        error = "Invalid Parameter: #{name}"
         if content_type and content_type.match(mime_type(:json))
-          error = {message: error}.to_json
+          error = {message: error, errors: {name => exception.message}}.to_json
         end
 
         halt 400, error
@@ -67,9 +74,9 @@ module Sinatra
       options.each do |key, value|
         case key
         when :required
-          raise InvalidParameterError if value && param.nil?
+          raise InvalidParameterError, "Parameter is required" if value && param.nil?
         when :blank
-          raise InvalidParameterError if !value && case param
+          raise InvalidParameterError, "Parameter cannot be blank" if !value && case param
               when String
                 !(/\S/ === param)
               when Array, Hash
@@ -78,22 +85,22 @@ module Sinatra
                 param.nil?
             end
         when :is
-          raise InvalidParameterError unless value === param
+          raise InvalidParameterError, "Parameter must be #{value}" unless value === param
         when :in, :within, :range
-          raise InvalidParameterError unless param.nil? || case value
+          raise InvalidParameterError, "Parameter must be within #{value}" unless param.nil? || case value
               when Range
                 value.include?(param)
               else
                 Array(value).include?(param)
               end
         when :min
-          raise InvalidParameterError unless param.nil? || value <= param
+          raise InvalidParameterError, "Parameter cannot be less than #{value}" unless param.nil? || value <= param
         when :max
-          raise InvalidParameterError unless param.nil? || value >= param
+          raise InvalidParameterError, "Parameter cannot be greater than #{value}" unless param.nil? || value >= param
         when :min_length
-          raise InvalidParameterError unless param.nil? || value <= param.length
+          raise InvalidParameterError, "Parameter cannot have length less than #{value}" unless param.nil? || value <= param.length
         when :max_length
-          raise InvalidParameterError unless param.nil? || value >= param.length
+          raise InvalidParameterError, "Parameter cannot have length greater than #{value}" unless param.nil? || value >= param.length
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Mattt Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Parameter Contracts for Sinatra