sinatra-validation 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19d3baa6aa52b1f1456f8f3f9062d800e2bef90d
-  data.tar.gz: a73f583804f69227267c156a84807dee73aecc63
+SHA256:
+  metadata.gz: aa3a3b73cd49ac6a0b7b6e8aa3c4398e40dae9abb464a59ecc2dec9952ac3f23
+  data.tar.gz: 1d4a20b3554ed689d80b4dd524e1fd6aebf6e315c7e5de45c905f3d7faae379c
 SHA512:
-  metadata.gz: 3b392f0906b84e75661aeede4083f1562d7d36046100c056d9d74b0de6ff50a95c048263341e2ac3088657abe42fd16cf921b24e78d35ed7da9f5965e0e54b59
-  data.tar.gz: d2ea2847d51c5c5ac9d70398616514b3292b4eaee9c6f2b97904f5172390a9f8deed1d0962f8155621fdedcd9a598440b7b73c61067a8791061b99b032b567ca
+  metadata.gz: 54e9deffe50aa5f7e3b5a660a84b777881fc1829083a0d8f16c02cd2d204d3072d835f937d4e2013643b258883d49461f3343678e0bda3d10b1ac47a2c5bc195
+  data.tar.gz: b542a570e3ea3a817230c759630f49a37b22ce34b8c12e3019377acc0add144446313eac1b23f647e9caac12f6457be5253d1088e37956f62e621b7922c631c6

data/.circleci/config.yml

@@ -0,0 +1,20 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.6
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - run: 
+          name: install deps
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - run: 
+          name: run tests
+          command: |
+            bundle exec rake spec

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby '2.6.6'
 
 # Specify your gem's dependencies in sinatra-validation.gemspec
 gemspec

data/README.md

@@ -1,4 +1,5 @@
 # Sinatra::Validation
+[![Gem Version](https://badge.fury.io/rb/sinatra-validation.svg)](https://badge.fury.io/rb/sinatra-validation)
 [![CircleCI](https://circleci.com/gh/IzumiSy/sinatra-validation.svg?style=shield)](https://circleci.com/gh/IzumiSy/sinatra-validation)
 
 > Sinatra extension for request parameter validation powered with dry-validation
@@ -28,8 +29,10 @@ Now you can use `validates` helper in your routes. The validation logic itself i
 ```ruby
   get '/basic' do
     validates do
-      required("name").filled(:str?)
-      required("age").filled(:str?)
+      params do
+        required("name").filled(:str?)
+        required("age").filled(:str?)
+      end
     end
 
     ...
@@ -42,8 +45,10 @@ You can suppress the default behavior which `validates` helper halts with 400 wh
 ```ruby
   get '/silent' do
     result = validates silent: true do
-      required("name").filled(:str?)
-      required("age").filled(:str?)
+      params do
+        required("name").filled(:str?)
+        required("age").filled(:str?)
+      end
     end
 
     p result # <struct Sinatra::Validation::Result params={"name"=>"justine"}, messages=["age is missing"]>
@@ -58,10 +63,12 @@ By default, `validates` helper halts with 400, but if you set the option `raise`
   get '/raise' do
     begin
       validates raise: true do
-        required("name").filled(:str?)
+        params do
+          required("name").filled(:str?)
+        end
       end
-    rescue => exception
-      p exception # <Sinatra::Validation::InvalidParameterError: {:params=>{}, :messages=>["name is missing"]}>
+    rescue => e
+      p e.result # <Sinatra::Validation::InvalidParameterError: {:params=>{}, :messages=>["name is missing"]}>
     end
 
     ...
@@ -72,7 +79,7 @@ if you want to enable this option to all validations, you can do `enable :raise_
   enable :raise_sinatra_validation_exception
 
   error Sinatra::Validation::InvalidParameterError do
-    # do something
+    # do anything you want
   end
 ```
 
@@ -82,6 +89,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Test
+
+```bash
+$ bundle install
+$ rake
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/IzumiSy/sinatra-validation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/example/Gemfile.lock

@@ -1,62 +1,59 @@
 PATH
-  remote: /home/izumisy/Devs/sinatra-validation
+  remote: /Users/izumi/Devs/sinatra-validation
   specs:
-    sinatra-validation (0.1.0)
-      dry-validation
-      sinatra
-      sinatra-contrib
+    sinatra-validation (0.3.2)
+      dry-validation (~> 1.3)
+      rack (>= 2.0.6)
+      sinatra (~> 2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    backports (3.10.3)
-    concurrent-ruby (1.0.5)
-    dry-configurable (0.7.0)
+    concurrent-ruby (1.1.9)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-    dry-container (0.6.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.1)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.0)
-    dry-logic (0.4.2)
-      dry-container (~> 0.2, >= 0.2.6)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-types (0.12.2)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1)
       dry-container (~> 0.3)
-      dry-core (~> 0.2, >= 0.2.1)
-      dry-equalizer (~> 0.2)
-      dry-logic (~> 0.4, >= 0.4.2)
-      inflecto (~> 0.0.0, >= 0.0.2)
-    dry-validation (0.11.1)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.7.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-      dry-core (~> 0.2, >= 0.2.1)
-      dry-equalizer (~> 0.2)
-      dry-logic (~> 0.4, >= 0.4.0)
-      dry-types (~> 0.12.0)
-    inflecto (0.0.2)
-    multi_json (1.12.2)
-    mustermann (1.0.1)
-    rack (2.0.3)
-    rack-protection (2.0.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.8, >= 1.8.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
-    sinatra (2.0.0)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
-    sinatra-contrib (2.0.0)
-      backports (>= 2.0)
-      multi_json
-      mustermann (~> 1.0)
-      rack-protection (= 2.0.0)
-      sinatra (= 2.0.0)
-      tilt (>= 1.3, < 3)
-    tilt (2.0.8)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -66,4 +63,4 @@ DEPENDENCIES
   sinatra-validation!
 
 BUNDLED WITH
-   1.14.6
+   1.17.2

data/example/app.rb

@@ -1,15 +1,33 @@
+require 'rack/contrib'
 require 'sinatra'
 require 'sinatra/base'
 require 'sinatra/validation'
+require 'pry' if development? or test?
 
 class Application < Sinatra::Base
   configure do
     register Sinatra::Validation
+
+    use Rack::JSONBodyParser
+  end
+
+  post '/post' do
+    content_type :json
+
+    validates do
+      params do
+        required(:name).filled(:str?)
+      end
+    end
+
+    'ok'
   end
 
   get '/basic' do
     validates do
-      required('name').filled(:str?)
+      params do
+        required(:name).filled(:str?)
+      end
     end
 
     'ok'
@@ -18,20 +36,44 @@ class Application < Sinatra::Base
   get '/silent' do
     content_type :json
 
-    result = validates silent: true do
-      required('name').filled(:str?)
+    validates silent: true do
+      params do
+        required(:name).filled(:str?)
+      end
     end
 
-    p result
-
     'ok'
   end
 
   get '/raise' do
-    validates raise: true do
-      required('name').filled(:str?)
+    begin
+      validates raise: true do
+        params do
+          required(:name).filled(:str?)
+        end
+      end
+
+      'ok'
+    rescue Sinatra::Validation::InvalidParameterError => e
+      halt 500, 'invalid'
     end
+  end
 
-    'ok'
+  get '/filter' do
+    validates filter_unpermitted_params: true do
+      params do
+        optional(:allowed).filled(:str?)
+      end
+    end
+    params.map{|k, v| "#{k}=#{v}"}.join(' ')
+  end
+
+  get '/result' do
+    result = validates do
+      params do
+        optional(:allowed).filled(:str?)
+      end
+    end
+    result.params.map{|k, v| "#{k}=#{v}"}.join(' ')
   end
 end

data/lib/sinatra/validation/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Validation
-    VERSION = "0.1.0"
+    VERSION = "0.3.2"
   end
 end

data/lib/sinatra/validation.rb

@@ -4,33 +4,53 @@ require "dry-validation"
 module Sinatra
   module Validation
     class InvalidParameterError < StandardError
-      attr_accessor :params, :messages
+      attr_reader :result
+
+      def initialize(result) 
+        @result = result
+      end
     end
 
-    class Result < Struct.new("Result", :params, :messages)
+    class Result
+      attr_reader :params, :messages
+
+      def initialize(params)
+        @params = params
+      end
+
+      def with_message(errors)
+        @messages = errors.to_h.map { |key, message| "#{key.to_s} #{message.first}" }
+        self
+      end
     end
 
     module Helpers
       def validates(options = {}, &block)
-        schema = Dry::Validation.Schema(&block)
+        schema = Class.new(Dry::Validation::Contract, &block).new
         validation = schema.call(params)
+        result = Result.new(Sinatra::IndifferentHash[validation.to_h])
+          .with_message(validation.errors)
 
-        if validation.success?
-          return Result.new(validation.output)
+        if options[:filter_unpermitted_params] || settings.filter_unpermitted_params
+          params.replace validation.to_h
         end
 
-        errors = validation.messages(full: true).values.flatten;
         if options[:silent] || settings.silent_validation
-          return Result.new(validation.output, errors)
+          return result
+        end
+
+        if validation.failure?
+          raise InvalidParameterError.new(result)
         end
 
-        raise InvalidParameterError.new(params: validation.output, messages: errors)
+        result
       rescue InvalidParameterError => exception
         if options[:raise] || settings.raise_sinatra_validation_exception
           raise exception
         end
 
-        error = exception.to_s
+        errors = exception.result.messages
+        error = errors.first
 
         if content_type && content_type.match(mime_type(:json))
           error = { errors: errors }.to_json
@@ -44,6 +64,7 @@ module Sinatra
       app.helpers Validation::Helpers
       app.set :silent_validation, false
       app.set :raise_sinatra_validation_exception, false
+      app.set :filter_unpermitted_params, false
     end
   end
 end

data/sinatra-validation.gemspec

@@ -21,12 +21,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'sinatra'
-  spec.add_dependency 'sinatra-contrib'
-  spec.add_dependency 'dry-validation'
+  spec.add_dependency 'sinatra', '~> 2.1.0'
+  spec.add_dependency 'rack', '>= 2.0.6'
+  spec.add_dependency 'dry-validation', '~> 1.3'
 
-  spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-contrib"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-validation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - IzumiSy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: sinatra-contrib
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.6
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
 description: ' "sinatra-validation is a gem to define parameter validation with dry-validation"'
 email:
 - beetle-noise@gmx.com
@@ -115,9 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -136,7 +151,7 @@ homepage: https://github.com/IzumiSy/sinatra-validation
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,9 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: '"Sinatra extension for request parameter validation"'
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.14.6