params_for 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0dbdd78b6a02ac4ceed14c171469d058e2563c7
+  data.tar.gz: 27ae31f222ad064a9e1a991510f29d2f797f98c2
+SHA512:
+  metadata.gz: d863599ede3d87d9a7554a138119512fa6a168a05b45c56b28bf1e47946ea649dba49b2405553588566022b97e116ec38c174e99365bd7127f09cae5828a9996
+  data.tar.gz: 0a774e716966a38dd460e15907ffae3bb515b6f4d9512f4bd8590bb15cedbb76f6164e14a04872c77308af696c0aa254d26aa4ceb5016017d111b5e7dc95f075

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in params_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 andresbravog
+
+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,93 @@
+# ParamsFor
+
+Use service objects and the power of `ActiveModel::Validations` to easy validate params in controller.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'params_for'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install params_validator
+
+## Usage
+
+In your controller:
+
+
+```Ruby
+# app/controllers/fancy_controller.rb
+
+class Fancycontroller < ApplicationController
+  include ParamsValidator::Connectors::ParamsFor
+
+  params_for :fancy, only: [:create]
+
+  # Creates a Fancy object by checking and validating params
+  # before that
+  #
+  def create
+    ...
+    @fancy = Fancy.new(fancy_params)
+    ...
+  end
+end
+```
+
+Or you can play with it yourself
+
+```Ruby
+# app/controllers/fancy_controller.rb
+
+class Fancycontroller < ApplicationController
+  include ParamsValidator::Connectors::ParamsFor
+
+  # Creates a Fancy object by checking and validating params
+  # before that
+  #
+  def create
+    ...
+    @fancy = Fancy.new(fancy_params)
+    ...
+  end
+
+  protected
+
+  # Strong params delegated to ParamValidator::Fancy
+  # and memoized in @fancy_params var returned by this method
+  #
+  # @return [HashwithIndifferentAccess]
+  def fancy_params
+    params_for :fancy
+  end
+end
+```
+
+Some place in your application ( suggested `app/validators/params_validator/` )
+
+```Ruby
+  # app/validators/param_validator/fancy.rb
+
+  class ParamValidator::Fancy < ParamValidator::Base
+    attr_accessor :user_id, :fancy_name, :fancy_description
+
+    validates :user_id, :fancy_name, presence: true
+    validates :user_id, integer: true
+  end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/params_validator/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/params_validator/base.rb

@@ -0,0 +1,84 @@
+# app/validators/param_validator/base.rb
+
+module ParamsValidator
+  class Base
+    include ActiveModel::Validations
+
+    # Memoizes the accessor atrributes in the @attributes variable to be able
+    # to list them and access them
+    #
+    def self.attr_accessor(*vars)
+      @attributes ||= []
+      @attributes.concat vars
+      super(*vars)
+    end
+
+    # Accessor method to the memoized attrubutes setted by the attr_accessor method
+    #
+    # @return [Array(Symbols)]
+    def self.attributes
+      @attributes ||= []
+
+      super_attributes = superclass.attributes if superclass && superclass.respond_to?(:attributes)
+      (super_attributes || []) + @attributes
+    end
+
+    # Initializes the param validator object with the given controller params
+    # HashwithIndifferentAccess object and feeds any defined attribute with the given param key
+    # if they exists
+    #
+    def initialize(params = {})
+      params.each do |key, value|
+        attribute?(key) && send("#{key}=", value)
+      end
+    end
+
+    # Alias for the attributes class method
+    #
+    # @return [Array(Symbol)]
+    def attributes
+      self.class.attributes
+    end
+
+    # Returns the given attibutes validated and parsed if needed
+    # to be used in the controller
+    #
+    # @return [HashWithIndifferentAccess]
+    def to_params
+      ::HashWithIndifferentAccess.new(attributes_hash)
+    end
+
+    private
+
+    # Whenever the given they is a valid attribute or not
+    #
+    # @return [Boolean]
+    def attribute?(key)
+      self.class.instance_methods.include? key.to_sym
+    end
+
+    # Return the attributes of the validator filtered by
+    # attributes has been set in the initializer with params
+    #
+    # @return [Array<Symbol>]
+    def settled_attributes
+      instance_vars = self.instance_variables.map do |attr|
+        attr.to_s[1..-1].to_sym
+      end
+
+      instance_vars & attributes
+    end
+
+    # Return a hash with the attributes and values that
+    # will be sent to the controller
+    #
+    # @return [Hash] {attribute1: value, attribute2: value}
+    def attributes_hash
+      settled_attributes.inject({}) do |out, attribute|
+        value = public_send(attribute)
+        out[attribute] = value
+        out
+      end
+    end
+  end
+end

data/lib/params_validator/connectors/params_for.rb

@@ -0,0 +1,55 @@
+require 'active_support/concern'
+
+module ParamsValidator
+  module Connectors
+    module ParamsFor
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Define params for and before_action all in the same method
+        #
+        # @param name [Symbol] camelcased validator class name
+        # @param options [Hash] optional
+        # @option options [Boolean] :class class of the validator
+        # @option options [Array] any option that before_action takes
+        def params_for(name, options = {})
+          method_name = "#{name}_params"
+          define_method(method_name) do
+            return params_for(name, options)
+          end
+          return if options[:before_action] == false
+          send(:before_action, method_name.to_sym, options)
+        end
+      end
+
+      private
+
+      # Strong params checker
+      #
+      # @param name [Symbol] camelcased validator class name
+      # @param options [Hash] optional
+      # @option options [Boolean] :class class of the validator
+      # @return [Hash]
+      def params_for(name, options = {})
+        instance_var_name = "@#{name.to_s}_params"
+        instance_var = instance_variable_get(instance_var_name)
+        return instance_var if instance_var.present?
+
+        if options[:class]
+          validator_klass = options[:class]
+        else
+          validator_name = "ParamsValidator::#{name.to_s.classify}"
+          validator_klass = validator_name.constantize
+        end
+
+        validator = validator_klass.new(params)
+
+        unless validator.valid?
+          render status: :bad_request, json: validator.errors.to_json and return false
+        end
+
+        instance_variable_set(instance_var_name, validator.to_params)
+      end
+    end
+  end
+end

data/lib/params_validator/version.rb

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

data/lib/params_validator.rb

@@ -0,0 +1,12 @@
+require 'active_support/hash_with_indifferent_access'
+require 'active_model'
+require 'params_validator/version'
+
+module ParamsValidator
+
+  autoload :Base,  'params_validator/base'
+
+  module Connectors
+    autoload :ParamsFor,  'params_validator/connectors/params_for'
+  end
+end

data/params_for.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'params_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "params_for"
+  spec.version       = ParamsValidator::VERSION
+  spec.authors       = ["andresbravog"]
+  spec.email         = ["andresbravog@gmail.com"]
+  spec.summary       = %q{Params Validatior for controllers using active_model validations.}
+  spec.description   = %q{With Params validator oyu should be able to perform controller params validation easy and with any kind of type, format, or custom validation you already know and use in oyur models. }
+  spec.homepage      = "https://github.com/andresbravog/params_for"
+  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 "activemodel"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'actionpack', '>= 3.0.0'
+  spec.add_development_dependency 'railties', '>= 3.0.0'
+end

data/spec/params_validator/base_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe ParamsValidator::Base do
+
+  let(:validator_klass) do
+    unless defined?(DummyValidator)
+      class DummyValidator < ParamsValidator::Base
+        attr_accessor :id, :name, :type
+
+        validates :type, inclusion: { in: %w{task project}, allow_nil: true }
+      end
+    end
+    DummyValidator
+  end
+  let(:validator) do
+    validator_klass.new(id: 'asd', name: 3, new_param: 'ads')
+  end
+
+  describe 'attr_accessor' do
+    it 'assigns every attribute accessor to a attributes variable' do
+      expect(validator_klass.attributes).to eql([:id, :name, :type])
+    end
+  end
+  describe 'initialize' do
+    it 'assigns the given param to the attribute if exists' do
+      expect(validator.id).to eql('asd')
+    end
+    it 'not assigns the given param to the attribute if not exists' do
+      expect { validator.new_param }.to raise_error
+    end
+  end
+  describe 'to_params' do
+    it 'returns a hash with indifferent access' do
+      expect(validator.to_params.class).to eql(HashWithIndifferentAccess)
+    end
+    it 'uses attributes_hash to create the hash' do
+      expect(HashWithIndifferentAccess).to receive(:new).with(validator.send(:attributes_hash))
+
+      validator.to_params
+    end
+  end
+
+  describe 'attributes_hash' do
+    let(:validator_klass_with_modified_accessor) do
+      unless defined?(NewDummyValidator)
+        class NewDummyValidator < ParamsValidator::Base
+          attr_accessor :id, :name
+
+          def id
+            'foo'
+          end
+        end
+      end
+      NewDummyValidator
+    end
+    let(:validator_with_modified_accessor) do
+      validator_klass_with_modified_accessor.new(
+        id: 'asd',
+        name: 3,
+        new_param: 'ads'
+      )
+    end
+
+    let(:validator_with_only_one_attribute_set) do
+      validator_klass_with_modified_accessor.new(
+        name: 3,
+        param_to_ignore: 'ads'
+      )
+    end
+
+    it 'is protected' do
+      expect { validator.attributes_hash }.to raise_error
+    end
+    it 'returns a hash' do
+      expect(validator.send(:attributes_hash).class).to eql(Hash)
+    end
+    it 'contains every attribute' do
+      [:id, :name].each do |attribute|
+        expect(validator.send(:attributes_hash)).to include(attribute)
+      end
+    end
+
+    it 'contains attributes set to nil if the nil is explicit' do
+      validator.id = nil
+      expect(validator.send(:attributes_hash)).to include(:id)
+    end
+
+    it 'uses accessors to get the attributes' do
+      expect(validator_with_modified_accessor.send(:attributes_hash)[:id]).to eql('foo')
+    end
+
+    it 'return only the attributes explicitly set' do
+      expect(validator_with_only_one_attribute_set.send(:attributes_hash).keys).to eq([:name])
+    end
+
+    it 'is valid with no type given' do
+      expect(validator).to be_valid
+    end
+  end
+end

data/spec/params_validator/connectors/params_for_spec.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'spec_helper'
+
+describe DummyController, type: :controller do
+
+  describe '.params_for' do
+    it 'defines a before_action with given attributes'
+    it 'defines a instance method to retrieve the params'
+    it 'uses the class option if given'
+  end
+
+  describe '.index' do
+    let(:valid_params) { { id: 123, name: 'new_name' } }
+    let(:response_data) { JSON.parse(subject.body) }
+    before { get :index, valid_params }
+    subject { response }
+
+    it { should be_success }
+    it { expect(response_data).to include('id') }
+    it { expect(response_data['id']).to eql('123') }
+    it { expect(response_data).to include('name') }
+    it { expect(response_data['name']).to eql('new_name') }
+
+    context 'whithout id param' do
+      let(:valid_params) { { id: nil, name: 'new_name' } }
+
+      it { expect(subject.status).to eql(400) }
+      it { expect(response_data['id']).to include('can\'t be blank') }
+    end
+    context 'with a different param' do
+      let(:valid_params) { { id: 123, other_param: 'new_value' } }
+
+      it { should be_success }
+      it { expect(response_data).to_not include('other_param') }
+    end
+  end
+end

data/spec/shared/support/dummy_controller.rb

@@ -0,0 +1,67 @@
+require 'action_controller'
+require 'params_validator'
+require 'ostruct'
+
+module Rails
+  def self.application
+    @application ||= begin
+      routes = ActionDispatch::Routing::RouteSet.new
+      OpenStruct.new(:routes => routes, :env_config => {})
+    end
+  end
+
+  def self.app
+    application
+  end
+end
+
+module ControllerExampleGroup
+  def self.included(base)
+    base.extend ClassMethods
+    base.send(:include, ActionController::TestCase::Behavior)
+
+    base.prepend_before do
+      @routes = Rails.application.routes
+      @controller = described_class.new
+    end
+  end
+
+  module ClassMethods
+    def setup(*methods)
+      methods.each do |method|
+        if method.to_s =~ /^setup_(fixtures|controller_request_and_response)$/
+          prepend_before { send method }
+        else
+          before         { send method }
+        end
+      end
+    end
+
+    def teardown(*methods)
+      methods.each { |method| after { send method } }
+    end
+  end
+end
+
+Rails.application.routes.draw do
+  resources :dummy, only: [:index]
+end
+
+class ParamsValidator::Dummy < ParamsValidator::Base
+  attr_accessor :id, :name
+
+  validates :id, presence: true
+end
+
+
+class DummyController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  include ParamsValidator::Connectors::ParamsFor
+
+  params_for :dummy
+
+  def index
+    render status: 200, json: dummy_params.to_json
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# require "codeclimate-test-reporter"
+# CodeClimate::TestReporter.start
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'params_validator'
+require 'rspec'
+require 'pry'
+
+# Requires support files
+Dir[File.join(File.dirname(__FILE__), 'shared/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.include ControllerExampleGroup, type: :controller
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: params_for
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- andresbravog
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 'With Params validator oyu should be able to perform controller params
+  validation easy and with any kind of type, format, or custom validation you already
+  know and use in oyur models. '
+email:
+- andresbravog@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/params_validator.rb
+- lib/params_validator/base.rb
+- lib/params_validator/connectors/params_for.rb
+- lib/params_validator/version.rb
+- params_for.gemspec
+- spec/params_validator/base_spec.rb
+- spec/params_validator/connectors/params_for_spec.rb
+- spec/shared/support/dummy_controller.rb
+- spec/spec_helper.rb
+homepage: https://github.com/andresbravog/params_for
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Params Validatior for controllers using active_model validations.
+test_files:
+- spec/params_validator/base_spec.rb
+- spec/params_validator/connectors/params_for_spec.rb
+- spec/shared/support/dummy_controller.rb
+- spec/spec_helper.rb