rails_param 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79d1fa666d9f249c4e2758fff4fe24be7856eeb8
-  data.tar.gz: c65e6e4d12a12a57667c659157229da75b9ce6c9
+  metadata.gz: 49836118ba306758e4157e7466e8ec67d79222b9
+  data.tar.gz: 48dde691b94c3e089b74e7f8d7279414b53ecf25
 SHA512:
-  metadata.gz: a3c7b0fbafd0072dd049879f47b3c0d892411712dac4ca3c2a0d34d0221b42c5a40c90b732005998c3798920ec964b68961accfccabd3fb6996a88b77a331172
-  data.tar.gz: e0901f1e7eb5bb94f91480925f6b4876b63e3d85168159edf34c3fa4aec6fc98c137b89b7932825e2e323981b185351a17db70a87e56483464d964c26f9a9ab2
+  metadata.gz: d92e097419c2abd3f19c000c39485ec59aba60f214b6266ea25d9f2241aa091250f1e11e4b64cbf8621c621f2c038909e9b7826f162fee1306a4aa6a5683e6d1
+  data.tar.gz: 20a00f69034b111898d91ba86da224e01637bdc13b6ce1a89e316f8bbfcd5364dfbc8238dfbf111c85c191857285fb58d3787c190defa939ab0cb10a741728ee

data/README.md

@@ -1,20 +1,20 @@
 # rails-param
 _Parameter Validation & Type Coercion for Rails_
 
+[![Build Status](https://travis-ci.org/nicolasblanco/rails_param.svg?branch=master)](https://travis-ci.org/nicolasblanco/rails_param)
+
 This is a port of the gem [sinatra-param](https://github.com/mattt/sinatra-param) for the Rails framework.
 All the credits go to [@mattt](https://twitter.com/mattt).
-It has all the features of the sinatra-param gem, I used bang methods (param! and one_of!) to indicate that they are destructive as they change the controller params object and may raise an exception.
+It has all the features of the sinatra-param gem, I used bang methods (like param!) to indicate that they are destructive as they change the controller params object and may raise an exception.
 
 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.
 
-This Rails extension takes a first step to solving this problem on the developer side
+This Rails extension takes a first step to solving this problem on the developer side.
 
 **`rails-param` allows you to declare, validate, and transform endpoint parameters as you would in frameworks like [ActiveModel](http://rubydoc.info/gems/activemodel/3.2.3/frames) or [DataMapper](http://datamapper.org/).**
 
-> Use `rails-param` in combination with [`Rack::PostBodyContentTypeParser` and `Rack::NestedParams`](https://github.com/rack/rack-contrib) to automatically parameterize JSON `POST` bodies and nested parameters.
-
 ## Example
 
 ``` ruby
@@ -25,7 +25,7 @@ This Rails extension takes a first step to solving this problem on the developer
     param! :q,           String, required: true
     param! :categories,  Array
     param! :sort,        String, default: "title"
-    param! :order,       String, in: ["ASC", "DESC"], transform: :upcase, default: "ASC"
+    param! :order,       String, in: %w(asc desc), transform: :downcase, default: "asc"
     param! :price,       String, format: "[<\=>]\s*\$\d+"
 
     {...}
@@ -47,7 +47,8 @@ By declaring parameter types, incoming parameters will automatically be transfor
 
 ### Validations
 
-Encapsulate business logic in a consistent way with validations. If a parameter does not satisfy a particular condition, a `400` error is returned with a message explaining the failure.
+Encapsulate business logic in a consistent way with validations. If a parameter does not satisfy a particular condition, an exception (RailsParam::Param::InvalidParameterError) is raised.
+You may use the [rescue_from](http://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html#method-i-rescue_from) method in your controller to catch this kind of exception.
 
 - `required`
 - `blank`

data/lib/rails_param/param.rb

@@ -15,21 +15,13 @@ module RailsParam
         params[name] = (options[:default].call if options[:default].respond_to?(:call)) || options[:default] if params[name].nil? and options[:default]
         params[name] = options[:transform].to_proc.call(params[name]) if params[name] and options[:transform]
         validate!(params[name], options)
-      # rescue InvalidParameterError => exception
-      #  if options[:raise]
-      #    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, errors: {name => exception.message}}.to_json
-      #  end
-
-      #  # do something with error object
+      rescue InvalidParameterError => exception
+        exception.param, exception.options = name, options
+        raise exception
       end
     end
 
+    # TODO: should we reintegrate this method?
     # def one_of!(*names)
     #   count = 0
     #   names.each do |name|

data/lib/rails_param/version.rb

@@ -1,3 +1,3 @@
 module RailsParam #:nodoc
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_param
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolas Blanco
@@ -44,29 +44,29 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
-description: "\n    Parameter Validation & Type Coercion for Rails\n  "
+        version: 3.2.0
+description: "\n    Parameter Validation and Type Coercion for Rails\n  "
 email: nicolas@nicolasblanco.fr
 executables: []
 extensions: []
@@ -78,7 +78,7 @@ files:
 - lib/rails_param/version.rb
 homepage: http://github.com/nicolasblanco/rails_param
 licenses:
-- WTFPL
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
@@ -100,5 +100,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Parameter Validation & Type Coercion for Rails
+summary: Parameter Validation and Type Coercion for Rails
 test_files: []