action_params_sanitizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38d2b8dd48af0275ab3810b63f04fe4aabdca560
+  data.tar.gz: 50a8184913e36c7fb221fb527b3fcc55394ed0b5
+SHA512:
+  metadata.gz: 48bb4d1ef1d127e094f1d69f84012f2fb59334f83667f317607b2008d2136d5103266e5e2cef4e606dc221dfa5316e2ce4896307c30fc87b26ee4a553bea82c9
+  data.tar.gz: 62bdfeaca63230ac6bbb26b08d6fab7c82e8e17a0040ecf72390d86a86e9f4bee1205dfb28ec6fffa07b445aec054778fe01190448372ab7841405dca4a613d1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+
+rvm:
+    - 2.1.2
+
+script: 'CODECLIMATE_REPO_TOKEN=85a4bf6c462720b53a31ea40d510834bb603149c27b5c1759cc9d91b73963048  bundle exec rake'
+
+addons:
+    code_climate:
+      repo_token: 85a4bf6c462720b53a31ea40d510834bb603149c27b5c1759cc9d91b73963048

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action_params_sanitizer.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sergey Gernyak
+
+MIT License
+
+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,154 @@
+# ActionParamsSanitizer
+
+[![Code Climate](https://codeclimate.com/github/alterego-labs/action_params_sanitizer/badges/gpa.svg)](https://codeclimate.com/github/alterego-labs/action_params_sanitizer)
+[![Test Coverage](https://codeclimate.com/github/alterego-labs/action_params_sanitizer/badges/coverage.svg)](https://codeclimate.com/github/alterego-labs/action_params_sanitizer)
+[![Build Status](https://travis-ci.org/alterego-labs/action_params_sanitizer.svg)](https://travis-ci.org/alterego-labs/action_params_sanitizer)
+
+Pretty simple objectifying wrapper for action params.
+
+Allows to describe the input parameters with a simple DSL. In result you take:
+
+1. The data encapsulation
+2. Work with the parameters as an object
+3. Easy testable service object
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_params_sanitizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_params_sanitizer
+
+## Usage
+
+### Defining new params sanitizers
+
+Default place for params wrappers is `app/params_sanitizers`. By convention all
+wrappers of one controller must be contained in namespace accordingly to a
+controller name. Name of class is accordingly to a action name. For
+example:
+
+```ruby
+class Users::CreateParamsSanitizer < ActionParamsSanitizer::Base
+end
+```
+
+And the class above must be contained in next folder structure `app/params_sanitizers/users/create_params_sanitizer.rb`.
+
+### Describe single param
+
+For example, input params is:
+
+```json
+{
+  some_key: :some_value,
+  another_key: :another_value
+}
+```
+
+For describing this case use `ActionParamsSanitizer::Base.param` method:
+
+```ruby
+class Users::CreateParamsSanitizer < ActionParamsSanitizer::Base
+  param :some_key
+  param :another_key
+end
+```
+
+Also you may passing keys array:
+
+```ruby
+class Users::CreateParamsSanitizer < ActionParamsSanitizer::Base
+  param :some_key, :another_key
+end
+```
+
+### Describe resource
+
+For example, input params contains resource attributes:
+
+```json
+{
+  user:{
+    email: 'some@mail.com',
+    nickname: 'some_user'
+  }
+}
+```
+
+For describing resource you must use
+`ActionParamsSanitizer::Base.resource` method:
+
+```ruby
+class Users::CreateParamsSanitizer < ActionParamsSanitizer::Base
+  resource :user
+end
+```
+
+By default all subparameters are permitted, but you can specify
+permitted ones:
+
+```ruby
+class Users::CreateParamsSanitizer < ActionParamsSanitizer::Base
+  resource user: [:nickname]
+end
+```
+
+Resource describing creates public method containing resource name and
+`_params` prefix. Looking to example above it will be `user_params`
+method.
+
+### Using in controller
+
+You may calling params sanitizers implicitly and explicitly.
+
+Implicitly calling `create_params` somewhere in `UsersController` will
+instantiate `Users::CreateParamsSanitizer` and return params object.
+
+For calling explicitly see following example:
+
+```ruby
+class UsersController
+  private
+
+  def useful_params
+    Users::SomeAnotherParamsSanitizer.new(params)
+  end
+end
+```
+
+### Scoping single params
+
+In some cases you want to extract single param from resource. Explicit
+scope passing to single param definition will help you:
+
+```ruby
+class Users::CreateParamsSanitizer < ActionParamsSanitizer::Base
+  resource :user
+  param :nickname, scope: -> { user_params }
+end
+```
+
+Scope is a lambda where _self_ takes _Users::CreateParamsSanitizer_ instance.
+
+## Further work
+
+1. Default values for single param
+2. Custom names
+3. Prefix for scoped single params
+4. Ability for permitting and single param access by user role
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/action_params_sanitizer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'rubygems/specification'
+
+task default: :spec
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(--color)
+end

data/action_params_sanitizer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_params_sanitizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_params_sanitizer"
+  spec.version       = ActionParamsSanitizer::VERSION
+  spec.authors       = ["Sergey Gernyak"]
+  spec.email         = ["sergeg1990@gmail.com"]
+  spec.summary       = %q{Pretty simple objectifying wrapper for action params}
+  spec.description   = %q{Allows to describe the input parameters with a simple DSL}
+  spec.homepage      = "https://github.com/alterego-labs/action_params_sanitizer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport",  ">= 4.0.4"
+  spec.add_dependency "actionpack",     ">= 4.0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",         "3.2.0"
+  spec.add_development_dependency "rspec-its",     "1.2.0"
+  spec.add_development_dependency "pry-nav",       "0.2.3"
+end

data/lib/action_params_sanitizer.rb

@@ -0,0 +1,15 @@
+require "action_params_sanitizer/version"
+
+module ActionParamsSanitizer
+  autoload :Base, 'action_params_sanitizer/base.rb'
+
+  module Concerns
+    autoload :SingleParamBuilder, 'action_params_sanitizer/concerns/single_param_builder.rb'
+    autoload :ResourceParamBuilder, 'action_params_sanitizer/concerns/resource_param_builder.rb'
+  end
+
+  module Helpers
+    autoload :Controller, 'action_params_sanitizer/helpers/controller.rb'
+    autoload :SanitizerClassBuilder, 'action_params_sanitizer/helpers/sanitizer_class_builder.rb'
+  end
+end

data/lib/action_params_sanitizer/base.rb

@@ -0,0 +1,4 @@
+class ActionParamsSanitizer::Base < Struct.new(:params)
+  include ActionParamsSanitizer::Concerns::SingleParamBuilder
+  include ActionParamsSanitizer::Concerns::ResourceParamBuilder
+end

data/lib/action_params_sanitizer/concerns/resource_param_builder.rb

@@ -0,0 +1,39 @@
+module ActionParamsSanitizer
+  module Concerns
+    module ResourceParamBuilder
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        def resource(resource)
+          if resource.is_a? Hash
+            define_fetch_params_method(*resource.to_a.first)
+          else
+            define_fetch_params_method resource
+          end
+        end
+
+        private
+
+        def define_fetch_params_method(resource_name, attributes = [])
+          class_eval make_fetch_param_method_code(resource_name, make_permit(attributes))
+        end
+
+        def make_permit(attributes)
+          attributes.any? ? "(#{attributes})" : '!'
+        end
+
+        def make_fetch_param_method_code(resource_name, permit)
+          <<-CODE
+            def #{resource_name}_params
+              params.require(:#{resource_name}).permit#{permit}
+            end
+          CODE
+        end
+      end
+    end
+  end
+end
+
+

data/lib/action_params_sanitizer/concerns/single_param_builder.rb

@@ -0,0 +1,31 @@
+module ActionParamsSanitizer
+  module Concerns
+    module SingleParamBuilder
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        DEFAULT_SCOPE = ->{ params }
+
+        def param(*names, scope: nil)
+          scope = scope || DEFAULT_SCOPE
+          define_single_params [*names], scope
+        end
+
+        private
+
+        def define_single_params(names, scope)
+          names.each { |name| define_single_param_method(name, scope) }
+        end
+
+        def define_single_param_method(name, scope)
+          define_method name do
+            self.instance_exec(&scope)[name]
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/action_params_sanitizer/helpers/controller.rb

@@ -0,0 +1,24 @@
+module ActionParamsSanitizer
+  module Helpers
+    module Controller
+      def method_missing(name, *args, &_block)
+        if params_fetching?(name)
+          build_params_sanitizer(name)
+        else
+          super
+        end
+      end
+
+      private
+
+      def params_fetching?(name)
+        name =~ /_params$/
+      end
+
+      def build_params_sanitizer(name)
+        klass = SanitizerClassBuilder.new(name, self.class.name).build_class
+        klass.new params
+      end
+    end
+  end
+end

data/lib/action_params_sanitizer/helpers/sanitizer_class_builder.rb

@@ -0,0 +1,23 @@
+module ActionParamsSanitizer
+  module Helpers
+    class SanitizerClassBuilder < Struct.new(:method_name, :controller_name)
+      def build_class
+        "#{namespace}::#{sanitizer_class_name}".constantize
+      end
+
+      private
+
+      def namespace
+        controller_name.to_s.gsub(/Controller$/, '')
+      end
+
+      def action
+        method_name.to_s.gsub(/_params$/, '')
+      end
+
+      def sanitizer_class_name
+        "#{action.capitalize}ParamsSanitizer"
+      end
+    end
+  end
+end

data/lib/action_params_sanitizer/railtie.rb

@@ -0,0 +1,9 @@
+module ActionParamsSanitizer
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      ActiveSupport.on_load(:action_controller) do
+        include ActionParamsSanitizer::Helpers::Controller
+      end
+    end
+  end
+end

data/lib/action_params_sanitizer/version.rb

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

data/spec/lib/action_params_sanitizer/base_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ActionParamsSanitizer::Base do
+  subject(:base_sanitizer) { described_class.new(params) }
+
+  let(:params) { ActionController::Parameters.new(raw_params) }
+  let(:raw_params) { {} }
+
+  it { is_expected.to respond_to :params }
+
+  context 'sets params properly' do
+    its(:params) { is_expected.to eq params }
+  end
+end

data/spec/lib/action_params_sanitizer/concerns/resource_param_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class ResourceParamsSanitizer < ActionParamsSanitizer::Base
+  resource :user
+  resource picture: [:url]
+end
+
+describe 'Defining resource params' do
+  subject(:sanitizer) { ResourceParamsSanitizer.new(params) }
+
+  let(:params) { ActionController::Parameters.new(raw_params) }
+  let(:raw_params) do
+    {
+      user: {
+        nickname: 'nickname',
+        email: 'some@mail.com'
+      },
+      picture: {
+        url: 'http://some.url',
+        weight: 200,
+        height: 100
+      }
+    }
+  end
+
+  context 'by default' do
+    it { is_expected.to respond_to :user_params }
+
+    its('user_params.keys') { is_expected.to include('nickname', 'email') }
+  end
+
+  context 'with permitting' do
+    it { is_expected.to respond_to :picture_params }
+
+    its('picture_params.keys') { is_expected.to include('url') }
+    its('picture_params.keys') { is_expected.to_not include('weight', 'height') }
+  end
+end

data/spec/lib/action_params_sanitizer/concerns/single_param_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class SomeParamsSanitizer < ActionParamsSanitizer::Base
+  param :some_single
+  param :another_single, scope: -> { scope_for_another }
+
+  def scope_for_another
+    params[:some_resource]
+  end
+end
+
+describe 'Defining single params' do
+  subject(:sanitizer) { SomeParamsSanitizer.new(params) }
+
+  let(:params) { ActionController::Parameters.new(raw_params) }
+  let(:raw_params) do
+    {
+      some_single: 'single_value',
+      some_resource: {
+        another_single: 'another_value'
+      }
+    }
+  end
+
+  context 'by default' do
+    it { is_expected.to respond_to :some_single }
+
+    its(:some_single) { is_expected.to eq 'single_value' }
+  end
+
+  context 'with scope' do
+    it { is_expected.to respond_to :another_single }
+
+    its(:another_single) { is_expected.to eq 'another_value' }
+  end
+end

data/spec/lib/action_params_sanitizer/helpers/controller_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+class UsersController
+  include ActionParamsSanitizer::Helpers::Controller
+
+  def params
+    {}
+  end
+end
+
+module Users
+  class CreateParamsSanitizer < ActionParamsSanitizer::Base
+  end
+end
+
+describe ActionParamsSanitizer::Helpers::Controller do
+  let(:controller) { UsersController.new }
+
+  context 'provides catching implicitly calling params sanitizer' do
+    subject(:sanitizer) { controller.create_params }
+
+    it { is_expected.to be_kind_of Users::CreateParamsSanitizer }
+  end
+end

data/spec/lib/action_params_sanitizer/helpers/sanitizer_class_builder_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Users
+  class CreateParamsSanitizer
+  end
+
+  module Api
+    class SearchParamsSanitizer
+    end
+  end
+end
+
+describe ActionParamsSanitizer::Helpers::SanitizerClassBuilder do
+  subject(:builder) { described_class.new(method_name, controller_name) }
+
+  context 'when controller is not namespaced' do
+    let(:method_name) { :create }
+    let(:controller_name) { 'UsersController' }
+
+    its(:build_class) { is_expected.to eq Users::CreateParamsSanitizer }
+  end
+
+  context 'when controller is namespaced' do
+    let(:method_name) { :search }
+    let(:controller_name) { 'Users::ApiController' }
+
+    its(:build_class) { is_expected.to eq Users::Api::SearchParamsSanitizer }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rspec/its'
+require 'active_support'
+require 'action_controller'
+require 'action_params_sanitizer'
+require 'pry-nav'
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.order = "random"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: action_params_sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Gernyak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: Allows to describe the input parameters with a simple DSL
+email:
+- sergeg1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_params_sanitizer.gemspec
+- lib/action_params_sanitizer.rb
+- lib/action_params_sanitizer/base.rb
+- lib/action_params_sanitizer/concerns/resource_param_builder.rb
+- lib/action_params_sanitizer/concerns/single_param_builder.rb
+- lib/action_params_sanitizer/helpers/controller.rb
+- lib/action_params_sanitizer/helpers/sanitizer_class_builder.rb
+- lib/action_params_sanitizer/railtie.rb
+- lib/action_params_sanitizer/version.rb
+- spec/lib/action_params_sanitizer/base_spec.rb
+- spec/lib/action_params_sanitizer/concerns/resource_param_spec.rb
+- spec/lib/action_params_sanitizer/concerns/single_param_spec.rb
+- spec/lib/action_params_sanitizer/helpers/controller_spec.rb
+- spec/lib/action_params_sanitizer/helpers/sanitizer_class_builder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alterego-labs/action_params_sanitizer
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Pretty simple objectifying wrapper for action params
+test_files:
+- spec/lib/action_params_sanitizer/base_spec.rb
+- spec/lib/action_params_sanitizer/concerns/resource_param_spec.rb
+- spec/lib/action_params_sanitizer/concerns/single_param_spec.rb
+- spec/lib/action_params_sanitizer/helpers/controller_spec.rb
+- spec/lib/action_params_sanitizer/helpers/sanitizer_class_builder_spec.rb
+- spec/spec_helper.rb