require_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92f164541ed22482a707740abf2ac7090156341e
+  data.tar.gz: 4c7920d9b7410ff7e6a49e79d4a3bc6cff0a4d07
+SHA512:
+  metadata.gz: bfbd01a5edfb59416c3ab80914c3fdcb0beb042269a0d60c6e399c273f7d674b621c012ed921e23f9c64d99fd736082e441cffcb9729202141fa47f3340d660d
+  data.tar.gz: a86a352e6bc3e9beece792639c37f51cde05783d011d7c7e2f99b2c8a7529e3d01999c228f2156135f7bf0980c60f2d2b39b369ea1de2a01b613314c45f3006b

data/README.md

@@ -0,0 +1,54 @@
+# require_params
+require_params ensures that parameters that your API actions require are present.
+
+## Usage
+Include `RequireParams` to your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::API
+  include RequireParams
+end
+```
+
+Use the `require_params` class method in your controllers to specify which parameters are required for which actions:
+
+```ruby
+class UsersController < ApplicationController
+  require_params [:username, :email, :password], only: :create
+
+  def create
+    # Do important stuff here
+  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: [{
+    username: ["is missing"],
+    password: ["is missing"]
+  }]
+}
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'require_params'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install require_params
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RequireParams'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/require_params/version.rb

@@ -0,0 +1,3 @@
+module RequireParams
+  VERSION = '0.0.1'
+end

data/lib/require_params.rb

@@ -0,0 +1,15 @@
+module RequireParams
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def require_params(required_params, options = {})
+      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
+        end
+      end
+    end
+  end
+end

data/lib/tasks/require_params_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :require_params do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: require_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yihang Ho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: require_params ensures that parameters that your Rails API actions require
+  are present.
+email:
+- hoyihang5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/require_params.rb
+- lib/require_params/version.rb
+- lib/tasks/require_params_tasks.rake
+homepage: https://github.com/yihangho/require_params
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ensure that all the parameters required by your actions are present.
+test_files: []