require_params 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75c998b48e9072ddd92bd225f4565accf8bfd4ac
-  data.tar.gz: 9336380aa0a414434867642e389f381d8376bae7
+  metadata.gz: 0b3dfa28e4c406d3ad1841f6e712ba323127c4e0
+  data.tar.gz: b48abd42fbb806d276602b74e0d950c87172ad34
 SHA512:
-  metadata.gz: d8818d675b8d04142b1fc600193d26cf94e262ae137832645a9ea59a6000575e1b4f761d6a8c3f65a11e490f3c644595813142baabe0db2c815829f9e67d1b25
-  data.tar.gz: fdaafb00511f4699d1711db6ff89c5290b293344933e5505570d136c232e22891608de83b92fea6076515053103cc1a064b45888c86d23c6b7f6596e5c837e9e
+  metadata.gz: 479e8f2b3eebad8bacc71cebeac2e0089eac664966c0a5934186120d64fac3dce8ea385f6c0d614f4e35850cae0c6ac885ee113a81516d54fdbc03ff22d417f3
+  data.tar.gz: 36231c2d7765dbba05b9aed107c054861f80db66790a5b75af0912c6d423a903af0aa14f6eb7ae7627e664cd75768860fbfdd8f18a15b966e7a28e4f39265ab6

data/README.md

@@ -22,17 +22,41 @@ class UsersController < ApplicationController
 end
 ```
 
+`require_params` can be called multiple times for each actions:
+
+```ruby
+class UsersController < ApplicationController
+  require_params [:username, :password]
+  require_params [:email], only: :create
+
+  # Equivalent to calling
+  # require_params [:username, :password, :email], only: :create
+  # require_params [:username, :password], except: :create
+
+  def create
+    # Make a new user
+  end
+
+  def sign_in
+    # Signs in user
+  end
+end
+```
+
 If any one of the required parameters is missing, your action handler will not be called at all. Instead, an error hash that looks like this will be served with 400 Bad Request:
 
 ```ruby
 {
-  errors: [{
+  errors: {
     username: ["is missing"],
     password: ["is missing"]
-  }]
+  }
 }
 ```
 
+### Internals
+`require_params` is backed by `prepend_before_action`. As a result, it can be guaranteed that by the time your `before_action` hooks and actions are executed, the required parameters are present.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -50,5 +74,13 @@ Or install it yourself as:
 $ gem install require_params
 ```
 
+Include `RequireParams` to your controllers:
+
+```ruby
+class ApplicationController < ActionController::API
+  include RequireParams
+end
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/require_params.rb

@@ -1,15 +1,30 @@
 module RequireParams
   extend ActiveSupport::Concern
 
+  included do
+    prepend_before_action :require_params_error_emitter
+  end
+
   module ClassMethods
     def require_params(required_params, options = {})
       prepend_before_action options do
-        missing_params = required_params.reject { |x| params.has_key?(x) }
-        if missing_params.any?
-          render json: { errors: missing_params.map { |x| {x => ["is missing"]}} }, status: :bad_request
-          false
+        required_params.each do |x|
+          missing_params << x unless params.has_key?(x)
         end
       end
     end
   end
+
+  private
+
+  def missing_params
+    @_missing_params ||= []
+  end
+
+  def require_params_error_emitter
+    if missing_params.any?
+      render json: { errors: Hash[@_missing_params.map { |x| [x, ["is missing"]] }] }, status: :bad_request
+      false
+    end
+  end
 end

data/lib/require_params/version.rb

@@ -1,3 +1,3 @@
 module RequireParams
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: require_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yihang Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails