allowed_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2603a57ec1250a74784b8a554f116248cb9ff869
+  data.tar.gz: d61ea3df8b87d9e83b6a7012a3eb0e2d92ec313c
+SHA512:
+  metadata.gz: 8762d755093bf557a7ed4314f58d3321319ae3f09fc55837718733cd610d9b1a8bbabc4b59c26dfcd1048083261360a8fed14e90ae2fec6123eecbc9bbcbfb08
+  data.tar.gz: 4a17cbfc92b86766d26bf8be2f90a7ecba93fbcbdf6ae37a539f3eaf37e587b25b931488acce668f904c1b46c07f59217a0715838ebebe90bd052ed8da93e340

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# AllowedParams
+
+This gem provides filtering and validations of params
+ 
+```ruby
+
+    class DogsController < ApplicationController
+        include AllowedParams::Helper
+        
+        params do
+            allow :name, presence: true
+            allow :age
+        end
+        def update
+            # do the job
+        end 
+    end
+    
+```
+
+This will validate `params[:name]` and raise `AllowedParams::ValidationError` in case of invalid value.
+`age` param is allowed and not validated. All other params is not allowed.
+
+To allow params on all controllers:
+ 
+```ruby 
+
+    AllowedParams.config.allowed_params = [:format]
+
+```
+
+This project rocks and uses MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'AllowedParams'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/allowed_params/helper.rb

@@ -0,0 +1,36 @@
+require_relative 'validator_builder'
+
+module AllowedParams
+  ValidationError = Class.new(ArgumentError)
+  NotAllowedError = Class.new(ArgumentError)
+
+  module Helper
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def params(&block)
+        builder = ::AllowedParams::ValidatorBuilder.new(self)
+        builder.instance_eval(&block) if block_given?
+        @request_params_validator = builder.validator
+      end
+
+      def method_added(method)
+        if instance_variable_get(:@request_params_validator).present?
+          request_params_validator = @request_params_validator
+          @request_params_validator = nil
+
+          before_filter only: [method] do
+            request_params = request_params_validator.new(params)
+            if request_params.invalid?
+              raise ValidationError, request_params.errors.full_messages.first
+            end
+            if request_params.not_allowed.present?
+              raise NotAllowedError, request_params.not_allowed.join(', ')
+            end
+          end
+        end
+        super
+      end
+    end
+  end
+end

data/lib/allowed_params/model.rb

@@ -0,0 +1,28 @@
+module AllowedParams
+  module Model
+    extend ActiveSupport::Concern
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+
+    module ClassMethods
+      def i18n_scope
+        :allowed_params
+      end
+    end
+
+    def i18n_scope
+      self.class.i18n_scope
+    end
+
+    def new_record?
+      true
+    end
+
+    def persisted?
+      false
+    end
+  end
+end

data/lib/allowed_params/validator_builder.rb

@@ -0,0 +1,49 @@
+require_relative 'model'
+
+module AllowedParams
+  include ActiveSupport::Configurable
+  config.allowed_params = []
+
+  class ValidatorBuilder
+    def initialize(controller)
+      @controller = controller
+      @params = {}
+    end
+
+    def allow(name, options = {})
+      @params[name] = options
+    end
+
+    def validator
+      params_options = @params
+      controller_name = @controller.name.underscore
+
+      Struct.new(*params_options.keys) do
+        include Model
+        attr_reader :params
+        @controller_name = controller_name
+
+        def self.model_name
+          ActiveModel::Name.new(self, nil, @controller_name)
+        end
+
+        params_options.each_pair do |name, validations|
+          if validations.present?
+            validates name, validations
+          end
+        end
+
+        def initialize(params = {})
+          @params = params.except(*Array(AllowedParams.config.allowed_params)).except(:controller, :action)
+          members.each do |name|
+            send(:"#{name}=", params[name])
+          end
+        end
+
+        def not_allowed
+          @params.keys.map(&:to_s) - members.map(&:to_s)
+        end
+      end
+    end
+  end
+end

data/lib/allowed_params/version.rb

@@ -0,0 +1,3 @@
+module AllowedParams
+  VERSION = "0.0.1"
+end

data/lib/allowed_params.rb

@@ -0,0 +1,5 @@
+require 'allowed_params/validator_builder'
+require 'allowed_params/helper'
+
+module AllowedParams
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: allowed_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tema Bolshakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allow to filter and validate params on rails controllers
+email:
+- abolshakov@spbtv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/allowed_params.rb
+- lib/allowed_params/helper.rb
+- lib/allowed_params/model.rb
+- lib/allowed_params/validator_builder.rb
+- lib/allowed_params/version.rb
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Filter params on rails controllers
+test_files: []
+has_rdoc: