explicit-parameters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bd7f4d53421eeef0b59aef942588c4796600ccc
+  data.tar.gz: df62f44750a434068d5ee6dc03d19805a4b736db
+SHA512:
+  metadata.gz: fab71e754354bfb120bd38a17e08f7d16af14e5b6dbc240a55ab3d95b785d83a86d81bf12f293d3ea5dd213d678f6bc1f82ba08d519a94deb32565b9df658836
+  data.tar.gz: 6180cc1a0871ca98b71a40b1f5ab8ce317e558fbe48f28961213981e04f929b5e040dc5e08dc5b4c39d667c62b8637ca5e49b84e544d28ec1aac7b4048cfad28

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  2.2
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jean Boussier
+
+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,49 @@
+# ExplicitParameters
+
+[![Build Status](https://secure.travis-ci.org/byroot/explicit-parameters.png)](http://travis-ci.org/byroot/explicit-parameters)
+[![Gem Version](https://badge.fury.io/rb/explicit-parameters.png)](http://badge.fury.io/rb/explicit-parameters)
+
+
+Explicit parameters validation and casting for Rails APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'explicit_parameters'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Example:
+
+```ruby
+class DummyController < ApiController
+  params do
+    requires :search, String
+    accepts :limit, Integer, default: 30
+
+    validates :limit, :numericality: {greater_than: 0, less_than_or_equal_to: 100}
+  end
+  def index
+    Dummy.search(params.search).limit(params.limit)
+  end
+end
+```
+
+## TODO
+
+- Real README
+
+## Contributing
+
+1. Fork it ( https://github.com/byroot/explicit_parameters/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,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/explicit-parameters.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'explicit_parameters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'explicit-parameters'
+  spec.version       = ExplicitParameters::VERSION
+  spec.authors       = ['Jean Boussier']
+  spec.email         = ['jean.boussier@gmail.com']
+  spec.summary       = %q{Explicit parameters validation and casting for Rails APIs}
+  spec.homepage      = 'https://github.com/byroot/explicit-parameters'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split(?\0)
+  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 'actionpack', '~> 4.0'
+  spec.add_dependency 'activemodel', '~> 4.0'
+  spec.add_dependency 'virtus', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/explicit-parameters.rb

@@ -0,0 +1 @@
+require 'explicit_parameters'

data/lib/explicit_parameters.rb

@@ -0,0 +1,10 @@
+module ExplicitParameters
+  BaseError = Class.new(StandardError)
+  InvalidParameters = Class.new(BaseError)
+end
+
+require 'explicit_parameters/version'
+require 'explicit_parameters/parameters'
+require 'explicit_parameters/controller'
+
+require 'explicit_parameters/railtie' if defined? Rails

data/lib/explicit_parameters/controller.rb

@@ -0,0 +1,49 @@
+module ExplicitParameters
+  module Controller
+    extend ActiveSupport::Concern
+
+    Boolean = Axiom::Types::Boolean
+
+    class << self
+      attr_accessor :last_parameters
+    end
+
+    included do
+      self.parameters = {}
+      rescue_from ExplicitParameters::InvalidParameters, with: :render_parameters_error
+    end
+
+    module ClassMethods
+      attr_accessor :parameters
+
+      def method_added(action)
+        return unless Controller.last_parameters
+        parameters[action.to_s] = Controller.last_parameters
+        const_set("#{action.to_s.camelize}Parameters", Controller.last_parameters)
+        Controller.last_parameters = nil
+      end
+
+      def params(&block)
+        Controller.last_parameters = ExplicitParameters::Parameters.define(&block)
+      end
+
+      def parse_parameters_for(action_name, params)
+        if declaration = parameters[action_name]
+          declaration.parse!(params)
+        else
+          params
+        end
+      end
+    end
+
+    private
+
+    def params
+      @validated_params ||= self.class.parse_parameters_for(action_name, super)
+    end
+
+    def render_parameters_error(error)
+      render json: error.message, status: :unprocessable_entity
+    end
+  end
+end

data/lib/explicit_parameters/parameters.rb

@@ -0,0 +1,82 @@
+require 'virtus'
+require 'active_model'
+
+module ExplicitParameters
+  class Parameters
+    include Virtus.model
+    include ActiveModel::Validations
+    include Enumerable
+
+    class CoercionValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        record.validate_attribute_coercion!(attribute, value)
+      end
+    end
+
+    class RequiredValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        record.validate_attribute_provided!(attribute, value)
+      end
+    end
+
+    class << self
+      def parse!(params)
+        new(params).validate!
+      end
+
+      def define(&block)
+        Class.new(self, &block)
+      end
+
+      def requires(name, type, options = {}, &block)
+        accepts(name, type, options.merge(required: true))
+      end
+
+      def accepts(name, type, options = {}, &block)
+        attribute(name, type, options.slice(:default, :required))
+        validations = options.except(:default)
+        validations[:coercion] = true
+        validates(name, validations)
+      end
+
+      def optional_attributes
+        @optional_attributes ||= []
+      end
+    end
+
+    def initialize(attributes = {})
+      @original_attributes = attributes.stringify_keys
+      super
+    end
+
+    def validate!
+      raise InvalidParameters.new({errors: errors}.to_json) unless valid?
+      self
+    end
+
+    def validate_attribute_provided!(attribute_name, value)
+      errors.add attribute_name, "is required" unless @original_attributes.key?(attribute_name.to_s)
+    end
+
+    def validate_attribute_coercion!(attribute_name, value)
+      return unless @original_attributes.key?(attribute_name.to_s)
+      attribute = attribute_set[attribute_name]
+      return if value.nil? && !attribute.required?
+      return if attribute.value_coerced?(value)
+      errors.add attribute_name, "#{@original_attributes[attribute_name].inspect} is not a valid #{attribute.type.name.demodulize}"
+    end
+
+    def to_hash
+      super.except(*missing_attributes)
+    end
+
+    delegate :each, to: :to_hash
+    delegate :[], to: :@original_attributes
+
+    private
+
+    def missing_attributes
+      @missing_attributes ||= (attribute_set.map(&:name).map(&:to_s) - @original_attributes.keys).map(&:to_sym)
+    end
+  end
+end

data/lib/explicit_parameters/railtie.rb

@@ -0,0 +1,9 @@
+module ExplicitParameters
+  class Railtie < ::Rails::Railtie
+    initializer 'explicit_parameters.controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include ExplicitParameters::Controller
+      end
+    end
+  end
+end

data/lib/explicit_parameters/version.rb

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

data/spec/controller_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class DummyController < ActionController::Base
+  include ExplicitParameters::Controller
+
+  params do
+    accepts :page_size, Integer
+    accepts :published, Boolean, default: false
+  end
+  def index
+    render json: {value: params.page_size, type: params.page_size.class.name}
+  end
+
+  def no_declaration
+    render text: 'OK'
+  end
+
+end
+
+RSpec.describe DummyController do
+  it 'is optional' do
+    get :no_declaration
+    expect(response.code).to be == '200'
+  end
+
+  it 'coerce parameters to the required type' do
+    get :index, page_size: '42'
+    expect(json_response).to be == {value: 42, type: 'Fixnum'}
+  end
+
+  it 'returns a 422 if parameters are invalid' do
+    get :index, page_size: 'foobar'
+    expect(response.code).to be == '422'
+  end
+
+  it 'returns the list of errors if parameters are invalid' do
+    get :index, page_size: 'foobar'
+    expect(json_response).to be == {errors: {page_size: ['"foobar" is not a valid Integer']}}
+  end
+
+  private
+
+  attr_reader :response
+
+  def json_response
+    JSON.load(response.body).deep_symbolize_keys
+  end
+
+  def get(action, parameters = {})
+    request(action, 'GET', query: parameters)
+  end
+
+  def request(action, method, query: {}, body: '')
+    rack_response = subject.dispatch(action, ActionDispatch::Request.new(
+      'REQUEST_METHOD' => method,
+      'QUERY_STRING' => query.to_query,
+      'rack.input' => StringIO.new(body)
+    ))
+    @response = ActionDispatch::Response.new(*rack_response)
+  end
+end

data/spec/parameters_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe ExplicitParameters::Parameters do
+  TestParameters = ExplicitParameters::Parameters.define do
+    requires :id, Integer
+    accepts :name, String
+    accepts :title, String, default: 'Untitled'
+
+    validates :id, numericality: {greater_than: 0}
+  end
+
+  let :parameters do
+    {
+      'id' => '42',
+      'name' => 'George',
+      'unexpected' => 'parameter',
+    }
+  end
+
+  let(:params) { TestParameters.parse!(parameters.with_indifferent_access) }
+
+  it 'casts parameters to the declared type' do
+    expect(params.id).to be == 42
+  end
+
+  it 'provides the default if the parameter is missing' do
+    expect(params.title).to be == 'Untitled'
+  end
+
+  it 'ignores unexpected parameters during iteration' do
+    params.each do |name, value|
+      expect(name).to_not be == 'unexpected'
+    end
+  end
+
+  it 'allows access to raw parameters when accessed like a Hash' do
+    expect(params[:id]).to be == '42'
+    expect(params[:unexpected]).to be == 'parameter'
+  end
+
+  it 'can perform any type of active model validations' do
+    message = {errors: {id: ['must be greater than 0']}}.to_json
+    expect {
+      TestParameters.parse!('id' => -1)
+    }.to raise_error(ExplicitParameters::InvalidParameters, message)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'action_controller'
+require 'explicit_parameters'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: explicit-parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: 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'
+description: 
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- explicit-parameters.gemspec
+- lib/explicit-parameters.rb
+- lib/explicit_parameters.rb
+- lib/explicit_parameters/controller.rb
+- lib/explicit_parameters/parameters.rb
+- lib/explicit_parameters/railtie.rb
+- lib/explicit_parameters/version.rb
+- spec/controller_spec.rb
+- spec/parameters_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/byroot/explicit-parameters
+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: Explicit parameters validation and casting for Rails APIs
+test_files:
+- spec/controller_spec.rb
+- spec/parameters_spec.rb
+- spec/spec_helper.rb