sinatra-dry_param 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b962e8ac60d8efb56b2038012e96ca363814ff635397f01efc4873f392bf563
-  data.tar.gz: d4bd1dcbd7dac7f2e65b84cf072c52d7ba03d52844770088c7e25dc2383af8f8
+  metadata.gz: b6463c4978cf3eaed12b4d8ee9eedc2100b6fefb5f99b0c20e95cc9185f4eb3a
+  data.tar.gz: 2580d83d97408439d5a041729394adda20084fc55f7ddb6828b4d4016dddfee1
 SHA512:
-  metadata.gz: a75b6b7610cc7e20bcb0af13184d0a366760ef1776a98c6c1f533145ed328663b8a9ed2b038c68302b1b4b70e1e4788f37d4ca8d8ef8b8479dceacf74559154b
-  data.tar.gz: 7bb89004a2bd622696b2dde679c5d6657e6f818491b802ecc842e7ec8c45c78727343e3d99d77b1c3c55b01223cd7203889e6a624d03ec5667b28ccb93eae145
+  metadata.gz: 10a5a61f6f752898d49db7370f728962348b62ae2f527d3071c22abf4e8ff9aef0156debc21c9e9f9af6c4384d5d200c413ffa3f67f0312b65fbe2a1cb83979a
+  data.tar.gz: 2109f819e752c331500f2689ae170e460dcb6bcfbadf138f87d5bd15840fafe7718a6ebe6efb4d568f70181cb03c33681458c8993188c540d8f4779ba9a10397

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+.byebug_history
+
+Gemfile.lock

data/.travis.yml

@@ -1,7 +1,10 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.2
-before_install: gem install bundler -v 1.17.2
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - jruby-9.2.7.0
+before_install:
+  - gem install bundler -v 1.17.3

data/README.md

@@ -1,8 +1,8 @@
 # Sinatra::DryParam
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sinatra/dry_param`. To experiment with that code, run `bin/console` for an interactive prompt.
+This sinatra extension provides easy interfaces for validating params. It serves both schema validation and strong-params feature.
 
-TODO: Delete this and the text above, and describe your gem
+Validation is processed by [dry-schema](https://github.com/dry-rb/dry-schema), provides robust type and schema validation.
 
 ## Installation
 
@@ -22,7 +22,139 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Register and use the extension in your sinatra app, for classic style sinatra app:
+
+
+```ruby
+require 'sinatra'
+require 'sinatra/dry_param'
+
+params do
+  required(:name).filled(:string)
+end
+
+get '/hello' do
+  data = validate_params
+  h "Hello #{data[:name]}!"
+end
+```
+
+Or for modular style sinatra app:
+
+```ruby
+require 'sinatra/base'
+require 'sinatra/dry_param'
+
+class App < Sinatra::Base
+  register Sinatra::DryParam
+
+  params do
+    required(:name).filled(:string)
+  end
+
+  get '/hello' do
+    data = validate_params
+    h "Hello #{data[:name]}!"
+  end
+end
+```
+
+### Define params schemas
+
+One or more schemas can be defined using method `::params`, distinguised by names:
+
+```ruby
+class App < Sinatra::Base
+  register Sinatra::DryParam
+
+  params do
+    # dry-schema definitions
+  end
+
+  params :paging do
+    # different name as :paging
+  end
+
+  params do
+    # Override the previous schema in whole class scope.
+    # Should only override parent class' schemas.
+  end
+
+  get '/' do
+    validate_params                          # Use the default schema to validate params
+    validate_params :dry, params             # Same with above line, the default schema name is :dry
+    validate_params :paging, params[:paging] # Use the :paging schema to validate one param
+  end
+```
+
+### Schema definition
+
+The block passed in `::params` is the block passed to `Dry::Schema.Params` of dry-schema.
+
+For syntax of schema definition, please refer to dry-schema [documentation](https://dry-rb.org/gems/dry-schema/).
+
+### Reusing param schemas
+
+Defined params can be retrieved as app settings, using the schema name with `"_params"` suffix.
+
+```ruby
+  settings.dry_params
+  settings.paging_params
+```
+
+And we can reuse schemas as how dry-schema is [reused](https://dry-rb.org/gems/dry-schema/reusing-schemas/)
+
+```ruby
+  params :address do
+    required(:city).filled(:string)
+    required(:street).filled(:string)
+    required(:zipcode).filled(:string)
+  end
+
+  params do
+    required(:email).filled(:string)
+    required(:name).filled(:string)
+    required(:address).hash(settings.address_params)
+  end
+
+  post '/users' do
+    input = validate_params
+    User.create_with_address(input)
+  end
+```
+
+### Render response
+
+By default, if `validate_params` failed, the action is halted with status 400 and render errors.
+
+```ruby
+params do
+  required(:page).filled(:integer, gt?: 0)
+  required(:per_page).filled(:integer, gt?: 0)
+end
+
+get '/' do
+  validate_params
+end
+
+#client
+get '/', page: 0
+#> Response body: { "page": ['must be greater than 0'], "per_page": ['is missing'] }
+```
+
+You can customize the behavior with this enable setting `raise_dry_param_exceptions` and catch the exception:
+
+```ruby
+class App < Sinatra::Base
+  register Sinatra::DryParam
+
+  enable :raise_dry_param_exceptions
+
+  error Sinatra::DryParam::InvalidParamsError do
+    "Your params is not valid: " + env['sinatra.error'].results.to_h.to_s
+  end
+end
+```
 
 ## Development
 
@@ -32,7 +164,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sinatra-dry_param. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tiev/sinatra-dry_param. 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.
 
 ## License
 
@@ -40,4 +172,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Sinatra::DryParam project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sinatra-dry_param/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Sinatra::DryParam project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tiev/sinatra-dry_param/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/sinatra-dry_param.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sinatra/dry_param'

data/lib/sinatra/dry_param.rb

@@ -5,19 +5,38 @@ require 'sinatra/dry_param/version'
 
 module Sinatra
   module DryParam
-    class Error < StandardError; end
+    class InvalidParamsError < StandardError
+      attr_reader :results
+
+      def initialize(msg, results)
+        @results = results
+        super(msg)
+      end
+    end
 
     module Helpers
-      def validate_params
-        schema = Dry::Schema.Params
-        schema.call(params)
+      def validate_params(name = :dry, prs = params)
+        result = settings.send("#{name}_params").call(prs)
+        if result.success?
+          result.to_h
+        else
+          raise InvalidParamsError.new(result.errors.to_h.to_s, result.errors) if settings.raise_dry_param_exceptions?
+
+          halt 400, result.errors.to_h.to_json
+        end
       end
     end
 
+    def params(name = :dry, schema: nil, &block)
+      schema ||= Dry::Schema.Params(&block)
+      set "#{name}_params", schema
+    end
+
     def self.registered(app)
       require 'dry/schema'
-
       app.helpers DryParam::Helpers
+
+      app.disable :raise_dry_param_exceptions
     end
   end
 

data/lib/sinatra/dry_param/version.rb

@@ -2,6 +2,6 @@
 
 module Sinatra
   module DryParam
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/sinatra-dry_param.gemspec

@@ -23,12 +23,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4'
 
+  spec.add_runtime_dependency 'dry-schema', '>= 0.3.0'
   spec.add_runtime_dependency 'sinatra', '>= 2.0'
-  spec.add_runtime_dependency 'dry-schema', '>= 0.5.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,87 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-dry_param
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Viet (Drake) Tran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: dry-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: dry-schema
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   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
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -106,12 +106,12 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/sinatra-dry_param.rb
 - lib/sinatra/dry_param.rb
 - lib/sinatra/dry_param/version.rb
 - sinatra-dry_param.gemspec
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sinatra-dry_param (0.0.1)
-      dry-schema (>= 0.5.1)
-      sinatra (>= 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    dry-configurable (0.8.2)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-    dry-container (0.7.0)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.7)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.2)
-    dry-inflector (0.1.2)
-    dry-initializer (2.5.0)
-    dry-logic (0.6.1)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-schema (0.5.1)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.8, >= 0.8.0)
-      dry-core (~> 0.2, >= 0.2.1)
-      dry-equalizer (~> 0.2)
-      dry-initializer (~> 2.4)
-      dry-logic (~> 0.6, >= 0.6.0)
-      dry-types (~> 0.15, >= 0.15.0)
-    dry-types (0.15.0)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.2, >= 0.2.2)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 0.5, >= 0.5)
-    mustermann (1.0.3)
-    rack (2.0.7)
-    rack-protection (2.0.5)
-      rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sinatra (2.0.5)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.5)
-      tilt (~> 2.0)
-    tilt (2.0.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  rack-test
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  sinatra-dry_param!
-
-BUNDLED WITH
-   1.17.2