sinatra-param 1.4.0 → 1.5.0

data/example/Gemfile

@@ -1,7 +1,7 @@
-ruby '2.0.0'
+ruby '2.4.1'
 source "https://rubygems.org"
 
-gem 'sinatra', require: 'sinatra/base'
+gem 'json', '~> 2.1.0'
+gem 'sinatra', '~> 2.0.1', require: 'sinatra/base'
 gem 'sinatra-param', path: File.join(__FILE__, "../.."), require: 'sinatra/param'
-gem 'json'
-gem 'unicorn'
+gem 'unicorn', '~> 5.4.0'

data/example/Gemfile.lock

@@ -1,33 +1,40 @@
 PATH
   remote: /Users/mattt/Code/Ruby/sinatra-param
   specs:
-    sinatra-param (0.1.3)
-      sinatra (~> 1.3)
+    sinatra-param (1.4.0)
+      sinatra (>= 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    json (1.8.1)
-    kgio (2.8.1)
-    rack (1.5.2)
-    rack-protection (1.5.0)
+    json (2.1.0)
+    kgio (2.11.2)
+    mustermann (1.0.2)
+    rack (2.0.4)
+    rack-protection (2.0.1)
       rack
-    raindrops (0.12.0)
-    sinatra (1.4.3)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
-    tilt (1.4.1)
-    unicorn (4.6.3)
+    raindrops (0.19.0)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    tilt (2.0.8)
+    unicorn (5.4.0)
       kgio (~> 2.6)
-      rack
       raindrops (~> 0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  json
-  sinatra
+  json (~> 2.1.0)
+  sinatra (~> 2.0.1)
   sinatra-param!
-  unicorn
+  unicorn (~> 5.4.0)
+
+RUBY VERSION
+   ruby 2.4.1p111
+
+BUNDLED WITH
+   1.16.0

data/lib/sinatra/param.rb

@@ -14,23 +14,26 @@ module Sinatra
     def param(name, type, options = {})
       name = name.to_s
 
-      return unless params.member?(name) or options[:default] or options[:required]
+      return unless params.member?(name) or options.has_key?(:default) or options[:required]
 
       begin
         params[name] = coerce(params[name], type, options)
-        params[name] = (options[:default].call if options[:default].respond_to?(:call)) || options[:default] if params[name].nil? and options[:default]
+        params[name] = (options[:default].call if options[:default].respond_to?(:call)) || options[:default] if params[name].nil? and options.has_key?(:default)
         params[name] = options[:transform].to_proc.call(params[name]) if params[name] and options[:transform]
         validate!(params[name], options)
+        params[name]
       rescue InvalidParameterError => exception
         if options[:raise] or (settings.raise_sinatra_param_exceptions rescue false)
           exception.param, exception.options = name, options
           raise exception
         end
 
-        error = exception.to_s
+        error = options[:message] || exception.to_s
 
         if content_type and content_type.match(mime_type(:json))
           error = {message: error, errors: {name => exception.message}}.to_json
+        else
+          content_type 'text/plain'
         end
 
         halt 400, error

data/lib/sinatra/param/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Param
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

data/sinatra-param.gemspec

@@ -4,15 +4,15 @@ require File.expand_path('../lib/sinatra/param/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = "sinatra-param"
   s.license     = "MIT"
-  s.authors     = ["Mattt Thompson"]
-  s.email       = "m@mattt.me"
+  s.authors     = ["Mattt"]
+  s.email       = "mattt@me.com"
   s.homepage    = "https://github.com/mattt/sinatra-param"
   s.version     = Sinatra::Param::VERSION
   s.platform    = Gem::Platform::RUBY
   s.summary     = "Parameter Validation & Type Coercion for Sinatra."
   s.description = "sinatra-param allows you to declare, validate, and transform endpoint parameters as you would in frameworks like ActiveModel or DataMapper."
 
-  s.add_dependency "sinatra", "~> 1.3"
+  s.add_dependency "sinatra", ">= 1.3"
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"

data/spec/dummy/app.rb

@@ -261,4 +261,14 @@ class App < Sinatra::Base
       message: 'OK'
     }.to_json
   end
+
+  get '/xml' do
+    content_type :xml
+    param :a, Integer, within: 1..10, required: true
+  end
+
+  get '/custommessage' do
+    param :a, Integer, within: 1..10, required: true,
+      message: "'a' must be less than 10"
+  end
 end

data/spec/parameter_raise_spec.rb

@@ -5,7 +5,7 @@ describe 'Exception' do
     it 'should raise error when option is specified' do
       expect {
         get('/raise/validation/required')
-      }.to raise_error
+      }.to raise_error Sinatra::Param::InvalidParameterError
     end
   end
 
@@ -13,13 +13,13 @@ describe 'Exception' do
     params = {a: 1, b: 2, c: 3}
     expect {
       get('/raise/one_of/3', params)
-    }.to raise_error
+    }.to raise_error Sinatra::Param::InvalidParameterError
   end
 
   it 'should raise error when no parameters are specified' do
     params = {}
     expect {
       get('/raise/any_of', params)
-    }.to raise_error
+    }.to raise_error Sinatra::Param::InvalidParameterError
   end
 end

data/spec/parameter_type_coercion_spec.rb

@@ -168,5 +168,21 @@ describe 'Parameter Types' do
         end
       end
     end
+
+    it 'coerces default booleans to true when default is true and its not provided' do
+      get('/default/boolean/true') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to be true
+        expect(JSON.parse(response.body)['arg']).to_not be_nil
+      end
+    end
+
+    it 'coerces default booleans to false when default is false and its not provided' do
+      get('/default/boolean/false') do |response|
+        expect(response.status).to eql 200
+        expect(JSON.parse(response.body)['arg']).to be false
+        expect(JSON.parse(response.body)['arg']).to_not be_nil
+      end
+    end
   end
 end

data/spec/parameter_validations_spec.rb

@@ -191,4 +191,26 @@ describe 'Parameter Validations' do
       end
     end
   end
+
+  context 'content-type header' do
+    it 'returns application/json for JSON APIs' do
+      get('/validation/max_length', arg: 'reallylongstringlongerthanmax') do |response|
+        expect(response.headers['Content-Type']).to eq('application/json')
+      end
+    end
+
+    it 'returns text/plain for non-JSON APIs' do
+      get('/xml', arg: 'reallylongstringlongerthanmax') do |response|
+        expect(response.headers['Content-Type']).to include('text/plain')
+      end
+    end
+  end
+
+  context 'custom message ' do
+    it 'returns a custom message when configured' do
+      get('/custommessage') do |response|
+        expect(JSON.parse(response.body)['message']).to eq("'a' must be less than 10")
+      end
+    end
+  end
 end

metadata

@@ -1,148 +1,170 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
-- Mattt Thompson
+- Mattt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   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: simplecov
   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-param allows you to declare, validate, and transform endpoint
   parameters as you would in frameworks like ActiveModel or DataMapper.
-email: m@mattt.me
+email: mattt@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./coverage/assets/0.7.1/application.css
-- ./coverage/assets/0.7.1/application.js
-- ./coverage/assets/0.7.1/fancybox/blank.gif
-- ./coverage/assets/0.7.1/fancybox/fancy_close.png
-- ./coverage/assets/0.7.1/fancybox/fancy_loading.png
-- ./coverage/assets/0.7.1/fancybox/fancy_nav_left.png
-- ./coverage/assets/0.7.1/fancybox/fancy_nav_right.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_e.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_n.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_ne.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_nw.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_s.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_se.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_sw.png
-- ./coverage/assets/0.7.1/fancybox/fancy_shadow_w.png
-- ./coverage/assets/0.7.1/fancybox/fancy_title_left.png
-- ./coverage/assets/0.7.1/fancybox/fancy_title_main.png
-- ./coverage/assets/0.7.1/fancybox/fancy_title_over.png
-- ./coverage/assets/0.7.1/fancybox/fancy_title_right.png
-- ./coverage/assets/0.7.1/fancybox/fancybox-x.png
-- ./coverage/assets/0.7.1/fancybox/fancybox-y.png
-- ./coverage/assets/0.7.1/fancybox/fancybox.png
-- ./coverage/assets/0.7.1/favicon_green.png
-- ./coverage/assets/0.7.1/favicon_red.png
-- ./coverage/assets/0.7.1/favicon_yellow.png
-- ./coverage/assets/0.7.1/loading.gif
-- ./coverage/assets/0.7.1/magnify.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_dadada_1x400.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-icons_222222_256x240.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-icons_2e83ff_256x240.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-icons_454545_256x240.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-icons_888888_256x240.png
-- ./coverage/assets/0.7.1/smoothness/images/ui-icons_cd0a0a_256x240.png
-- ./coverage/index.html
-- ./example/app.rb
-- ./example/config.ru
-- ./example/Gemfile
-- ./example/Gemfile.lock
-- ./example/Procfile
-- ./Gemfile
-- ./Gemfile.lock
-- ./lib/sinatra/param/version.rb
-- ./lib/sinatra/param.rb
-- ./LICENSE
-- ./Rakefile
-- ./README.md
-- ./sinatra-param-1.3.0.gem
-- ./sinatra-param-1.3.1.gem
-- ./sinatra-param.gemspec
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE"
+- "./README.md"
+- "./Rakefile"
+- "./coverage/assets/0.10.2/application.css"
+- "./coverage/assets/0.10.2/application.js"
+- "./coverage/assets/0.10.2/colorbox/border.png"
+- "./coverage/assets/0.10.2/colorbox/controls.png"
+- "./coverage/assets/0.10.2/colorbox/loading.gif"
+- "./coverage/assets/0.10.2/colorbox/loading_background.png"
+- "./coverage/assets/0.10.2/favicon_green.png"
+- "./coverage/assets/0.10.2/favicon_red.png"
+- "./coverage/assets/0.10.2/favicon_yellow.png"
+- "./coverage/assets/0.10.2/loading.gif"
+- "./coverage/assets/0.10.2/magnify.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png"
+- "./coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png"
+- "./coverage/assets/0.7.1/application.css"
+- "./coverage/assets/0.7.1/application.js"
+- "./coverage/assets/0.7.1/fancybox/blank.gif"
+- "./coverage/assets/0.7.1/fancybox/fancy_close.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_loading.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_nav_left.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_nav_right.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_e.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_n.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_ne.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_nw.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_s.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_se.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_sw.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_shadow_w.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_left.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_main.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_over.png"
+- "./coverage/assets/0.7.1/fancybox/fancy_title_right.png"
+- "./coverage/assets/0.7.1/fancybox/fancybox-x.png"
+- "./coverage/assets/0.7.1/fancybox/fancybox-y.png"
+- "./coverage/assets/0.7.1/fancybox/fancybox.png"
+- "./coverage/assets/0.7.1/favicon_green.png"
+- "./coverage/assets/0.7.1/favicon_red.png"
+- "./coverage/assets/0.7.1/favicon_yellow.png"
+- "./coverage/assets/0.7.1/loading.gif"
+- "./coverage/assets/0.7.1/magnify.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_flat_75_ffffff_40x100.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_65_ffffff_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_dadada_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_222222_256x240.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_2e83ff_256x240.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_454545_256x240.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_888888_256x240.png"
+- "./coverage/assets/0.7.1/smoothness/images/ui-icons_cd0a0a_256x240.png"
+- "./coverage/index.html"
+- "./example/Gemfile"
+- "./example/Gemfile.lock"
+- "./example/Procfile"
+- "./example/app.rb"
+- "./example/config.ru"
+- "./lib/sinatra/param.rb"
+- "./lib/sinatra/param/version.rb"
+- "./sinatra-param.gemspec"
 - spec/dummy/app.rb
 - spec/parameter_exclusivity_spec.rb
 - spec/parameter_inclusivity_spec.rb
@@ -162,17 +184,17 @@ 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.1.11
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Parameter Validation & Type Coercion for Sinatra.