grape 0.19.2 → 1.0.0

data/spec/grape/validations/validators/except_values_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe Grape::Validations::ExceptValuesValidator do
+  module ValidationsSpec
+    class ExceptValuesModel
+      DEFAULT_EXCEPTS = ['invalid-type1', 'invalid-type2', 'invalid-type3'].freeze
+      class << self
+        attr_accessor :excepts
+        def excepts
+          @excepts ||= []
+          [DEFAULT_EXCEPTS + @excepts].flatten.uniq
+        end
+      end
+    end
+
+    TEST_CASES = {
+      req_except: {
+        requires: { except_values: ExceptValuesModel.excepts },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'invalid-type3', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json }
+        ]
+      },
+      req_except_hash: {
+        requires: { except_values: { value: ExceptValuesModel.excepts } },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'invalid-type3', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json }
+        ]
+      },
+      req_except_custom_message: {
+        requires: { except_values: { value: ExceptValuesModel.excepts, message: 'is not allowed' } },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type is not allowed' }.to_json },
+          { value: 'invalid-type3', rc: 400, body: { error: 'type is not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json }
+        ]
+      },
+      req_except_no_value: {
+        requires: { except_values: { message: 'is not allowed' } },
+        tests: [
+          { value: 'invalid-type1', rc: 200, body: { type: 'invalid-type1' }.to_json }
+        ]
+      },
+      req_except_empty: {
+        requires: { except_values: [] },
+        tests: [
+          { value: 'invalid-type1', rc: 200, body: { type: 'invalid-type1' }.to_json }
+        ]
+      },
+      req_except_lambda: {
+        requires: { except_values: -> { ExceptValuesModel.excepts } },
+        add_excepts: ['invalid-type4'],
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'invalid-type4', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json }
+        ]
+      },
+      req_except_lambda_custom_message: {
+        requires: { except_values: { value: -> { ExceptValuesModel.excepts }, message: 'is not allowed' } },
+        add_excepts: ['invalid-type4'],
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type is not allowed' }.to_json },
+          { value: 'invalid-type4', rc: 400, body: { error: 'type is not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json }
+        ]
+      },
+      opt_except_default: {
+        optional: { except_values: ExceptValuesModel.excepts, default: 'valid-type2' },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'invalid-type3', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json },
+          { rc: 200, body: { type: 'valid-type2' }.to_json }
+        ]
+      },
+      opt_except_lambda_default: {
+        optional: { except_values: -> { ExceptValuesModel.excepts }, default: 'valid-type2' },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'invalid-type3', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 'valid-type', rc: 200, body: { type: 'valid-type' }.to_json },
+          { rc: 200, body: { type: 'valid-type2' }.to_json }
+        ]
+      },
+      req_except_type_coerce: {
+        requires: { type: Integer, except_values: [10, 11] },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type is invalid' }.to_json },
+          { value: 11, rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: '11', rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: '3', rc: 200, body: { type: 3 }.to_json },
+          { value: 3, rc: 200, body: { type: 3 }.to_json }
+        ]
+      },
+      opt_except_type_coerce_default: {
+        optional: { type: Integer, except_values: [10, 11], default: 12 },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type is invalid' }.to_json },
+          { value: 10, rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: '3', rc: 200, body: { type: 3 }.to_json },
+          { value: 3, rc: 200, body: { type: 3 }.to_json },
+          { rc: 200, body: { type: 12 }.to_json }
+        ]
+      },
+      opt_except_array_type_coerce_default: {
+        optional: { type: Array[Integer], except_values: [10, 11], default: 12 },
+        tests: [
+          { value: 'invalid-type1', rc: 400, body: { error: 'type is invalid' }.to_json },
+          { value: 10, rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: [10], rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: ['3'], rc: 200, body: { type: [3] }.to_json },
+          { value: [3], rc: 200, body: { type: [3] }.to_json },
+          { rc: 200, body: { type: 12 }.to_json }
+        ]
+      },
+      req_except_range: {
+        optional: { type: Integer, except_values: 10..12 },
+        tests: [
+          { value: 11, rc: 400, body: { error: 'type has a value not allowed' }.to_json },
+          { value: 13, rc: 200, body: { type: 13 }.to_json }
+        ]
+      }
+    }.freeze
+
+    module ExceptValidatorSpec
+      class API < Grape::API
+        default_format :json
+
+        TEST_CASES.each_with_index do |(k, v), _i|
+          params do
+            requires :type, v[:requires] if v.key? :requires
+            optional :type, v[:optional] if v.key? :optional
+          end
+          get k do
+            { type: params[:type] }
+          end
+        end
+      end
+    end
+  end
+
+  it 'raises IncompatibleOptionValues on a default value in exclude' do
+    subject = Class.new(Grape::API)
+    expect do
+      subject.params do
+        optional :type, except_values: ValidationsSpec::ExceptValuesModel.excepts,
+                        default: ValidationsSpec::ExceptValuesModel.excepts.sample
+      end
+    end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+  end
+
+  it 'raises IncompatibleOptionValues when a default array has excluded values' do
+    subject = Class.new(Grape::API)
+    expect do
+      subject.params do
+        optional :type, type: Array[Integer],
+                        except_values: 10..12,
+                        default: [8, 9, 10]
+      end
+    end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+  end
+
+  it 'raises IncompatibleOptionValues when type is incompatible with values array' do
+    subject = Class.new(Grape::API)
+    expect do
+      subject.params { optional :type, except_values: ['valid-type1', 'valid-type2', 'valid-type3'], type: Symbol }
+    end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+  end
+
+  def app
+    ValidationsSpec::ExceptValidatorSpec::API
+  end
+
+  ValidationsSpec::TEST_CASES.each_with_index do |(k, v), i|
+    v[:tests].each do |t|
+      it "#{i}: #{k} - #{t[:value]}" do
+        ValidationsSpec::ExceptValuesModel.excepts = v[:add_excepts] if v.key? :add_excepts
+        body = {}
+        body[:type] = t[:value] if t.key? :value
+        get k.to_s, **body
+        expect(last_response.status).to eq t[:rc]
+        expect(last_response.body).to eq t[:body]
+        ValidationsSpec::ExceptValuesModel.excepts = nil
+      end
+    end
+  end
+end

data/spec/grape/validations/validators/values_spec.rb

@@ -75,6 +75,13 @@ describe Grape::Validations::ValuesValidator do
         end
         get '/empty'
 
+        params do
+          optional :type, values: { value: ValuesModel.values }, default: 'valid-type2'
+        end
+        get '/default/hash/valid' do
+          { type: params[:type] }
+        end
+
         params do
           optional :type, values: ValuesModel.values, default: 'valid-type2'
         end
@@ -82,6 +89,13 @@ describe Grape::Validations::ValuesValidator do
           { type: params[:type] }
         end
 
+        params do
+          optional :type, values: { except: ValuesModel.excepts }, default: 'valid-type2'
+        end
+        get '/default/except' do
+          { type: params[:type] }
+        end
+
         params do
           optional :type, values: -> { ValuesModel.values }, default: 'valid-type2'
         end
@@ -89,6 +103,13 @@ describe Grape::Validations::ValuesValidator do
           { type: params[:type] }
         end
 
+        params do
+          requires :type, values: ->(v) { ValuesModel.values.include? v }
+        end
+        get '/lambda_val' do
+          { type: params[:type] }
+        end
+
         params do
           requires :type, values: -> { [] }
         end
@@ -143,6 +164,13 @@ describe Grape::Validations::ValuesValidator do
           { type: params[:type] }
         end
 
+        params do
+          requires :type, type: String, values: { except: ValuesModel.excepts }
+        end
+        get '/except/exclusive/type' do
+          { type: params[:type] }
+        end
+
         params do
           requires :type, values: { except: -> { ValuesModel.excepts } }
         end
@@ -150,6 +178,13 @@ describe Grape::Validations::ValuesValidator do
           { type: params[:type] }
         end
 
+        params do
+          requires :type, type: String, values: { except: -> { ValuesModel.excepts } }
+        end
+        get '/except/exclusive/lambda/type' do
+          { type: params[:type] }
+        end
+
         params do
           requires :type, type: Integer, values: { except: -> { [3, 4, 5] } }
         end
@@ -282,6 +317,18 @@ describe Grape::Validations::ValuesValidator do
     expect(last_response.body).to eq({ type: 'valid-type2' }.to_json)
   end
 
+  it 'allows a default value with except' do
+    get('/default/except')
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to eq({ type: 'valid-type2' }.to_json)
+  end
+
+  it 'allows a valid default value' do
+    get('/default/hash/valid')
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to eq({ type: 'valid-type2' }.to_json)
+  end
+
   it 'allows a proc for values' do
     get('/lambda', type: 'valid-type1')
     expect(last_response.status).to eq 200
@@ -310,6 +357,18 @@ describe Grape::Validations::ValuesValidator do
     expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
   end
 
+  it 'allows value using lambda' do
+    get('/lambda_val', type: 'valid-type1')
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to eq({ type: 'valid-type1' }.to_json)
+  end
+
+  it 'does not allow invalid value using lambda' do
+    get('/lambda_val', type: 'invalid-type')
+    expect(last_response.status).to eq 400
+    expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
+  end
+
   it 'validates against an empty array in a proc' do
     get('/empty_lambda', type: 'any')
     expect(last_response.status).to eq 400
@@ -371,6 +430,13 @@ describe Grape::Validations::ValuesValidator do
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
+  it 'raises IncompatibleOptionValues when except contains a value that is not a kind of the type' do
+    subject = Class.new(Grape::API)
+    expect do
+      subject.params { requires :type, values: { except: [10.5, 11] }, type: Integer }
+    end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+  end
+
   context 'with a lambda values' do
     subject do
       Class.new(Grape::API) do
@@ -451,6 +517,12 @@ describe Grape::Validations::ValuesValidator do
       expect(last_response.body).to eq({ type: 'value' }.to_json)
     end
 
+    it 'allows any other value outside excepts when type is included' do
+      get '/except/exclusive/type', type: 'value'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ type: 'value' }.to_json)
+    end
+
     it 'rejects values that matches except' do
       get '/except/exclusive', type: 'invalid-type1'
       expect(last_response.status).to eq 400
@@ -465,6 +537,12 @@ describe Grape::Validations::ValuesValidator do
   end
 
   context 'exclusive excepts with lambda' do
+    it 'allows any other value outside excepts when type is included' do
+      get '/except/exclusive/lambda/type', type: 'value'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ type: 'value' }.to_json)
+    end
+
     it 'allows any other value outside excepts' do
       get '/except/exclusive/lambda', type: 'value'
       expect(last_response.status).to eq 200

data/spec/integration/multi_json/json_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Grape::Json do
+  it 'uses multi_json' do
+    expect(Grape::Json).to eq(::MultiJson)
+  end
+end

data/spec/integration/multi_xml/xml_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Grape::Xml do
+  it 'uses multi_xml' do
+    expect(Grape::Xml).to eq(::MultiXml)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -66,48 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-- !ruby/object:Gem::Dependency
-  name: multi_xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.2
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +114,9 @@ files:
 - Rakefile
 - UPGRADING.md
 - benchmark/simple.rb
+- benchmark/simple_with_type_coercer.rb
+- gemfiles/multi_json.gemfile
+- gemfiles/multi_xml.gemfile
 - gemfiles/rack_1.5.2.gemfile
 - gemfiles/rack_edge.gemfile
 - gemfiles/rails_3.gemfile
@@ -208,6 +169,12 @@ files:
 - lib/grape/exceptions/validation.rb
 - lib/grape/exceptions/validation_array_errors.rb
 - lib/grape/exceptions/validation_errors.rb
+- lib/grape/extensions/active_support/hash_with_indifferent_access.rb
+- lib/grape/extensions/deep_hash_with_indifferent_access.rb
+- lib/grape/extensions/deep_mergeable_hash.rb
+- lib/grape/extensions/deep_symbolize_hash.rb
+- lib/grape/extensions/hash.rb
+- lib/grape/extensions/hashie/mash.rb
 - lib/grape/formatter.rb
 - lib/grape/formatter/json.rb
 - lib/grape/formatter/serializable_hash.rb
@@ -249,10 +216,12 @@ files:
 - lib/grape/util/env.rb
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
+- lib/grape/util/json.rb
 - lib/grape/util/registrable.rb
 - lib/grape/util/reverse_stackable_values.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/strict_hash_configuration.rb
+- lib/grape/util/xml.rb
 - lib/grape/validations.rb
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/params_scope.rb
@@ -264,6 +233,7 @@ files:
 - lib/grape/validations/types/multiple_type_coercer.rb
 - lib/grape/validations/types/variant_collection_coercer.rb
 - lib/grape/validations/types/virtus_collection_patch.rb
+- lib/grape/validations/validator_factory.rb
 - lib/grape/validations/validators/all_or_none.rb
 - lib/grape/validations/validators/allow_blank.rb
 - lib/grape/validations/validators/at_least_one_of.rb
@@ -271,13 +241,13 @@ files:
 - lib/grape/validations/validators/coerce.rb
 - lib/grape/validations/validators/default.rb
 - lib/grape/validations/validators/exactly_one_of.rb
+- lib/grape/validations/validators/except_values.rb
 - lib/grape/validations/validators/multiple_params_base.rb
 - lib/grape/validations/validators/mutual_exclusion.rb
 - lib/grape/validations/validators/presence.rb
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
-- pkg/grape-0.18.0.gem
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/invalid_format_spec.rb
@@ -316,6 +286,9 @@ files:
 - spec/grape/exceptions/unknown_validator_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
+- spec/grape/extensions/param_builders/hash_spec.rb
+- spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
+- spec/grape/extensions/param_builders/hashie/mash_spec.rb
 - spec/grape/integration/global_namespace_function_spec.rb
 - spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
@@ -344,6 +317,7 @@ files:
 - spec/grape/util/stackable_values_spec.rb
 - spec/grape/util/strict_hash_configuration_spec.rb
 - spec/grape/validations/attributes_iterator_spec.rb
+- spec/grape/validations/instance_behaivour_spec.rb
 - spec/grape/validations/params_scope_spec.rb
 - spec/grape/validations/types_spec.rb
 - spec/grape/validations/validators/all_or_none_spec.rb
@@ -352,12 +326,15 @@ files:
 - spec/grape/validations/validators/coerce_spec.rb
 - spec/grape/validations/validators/default_spec.rb
 - spec/grape/validations/validators/exactly_one_of_spec.rb
+- spec/grape/validations/validators/except_values_spec.rb
 - spec/grape/validations/validators/mutual_exclusion_spec.rb
 - spec/grape/validations/validators/presence_spec.rb
 - spec/grape/validations/validators/regexp_spec.rb
 - spec/grape/validations/validators/values_spec.rb
 - spec/grape/validations/validators/zh-CN.yml
 - spec/grape/validations_spec.rb
+- spec/integration/multi_json/json_spec.rb
+- spec/integration/multi_xml/xml_spec.rb
 - spec/shared/versioning_examples.rb
 - spec/spec_helper.rb
 - spec/support/basic_auth_encode_helpers.rb
@@ -386,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
@@ -429,6 +406,9 @@ test_files:
 - spec/grape/exceptions/unknown_validator_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
+- spec/grape/extensions/param_builders/hash_spec.rb
+- spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
+- spec/grape/extensions/param_builders/hashie/mash_spec.rb
 - spec/grape/integration/global_namespace_function_spec.rb
 - spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
@@ -457,6 +437,7 @@ test_files:
 - spec/grape/util/stackable_values_spec.rb
 - spec/grape/util/strict_hash_configuration_spec.rb
 - spec/grape/validations/attributes_iterator_spec.rb
+- spec/grape/validations/instance_behaivour_spec.rb
 - spec/grape/validations/params_scope_spec.rb
 - spec/grape/validations/types_spec.rb
 - spec/grape/validations/validators/all_or_none_spec.rb
@@ -465,12 +446,15 @@ test_files:
 - spec/grape/validations/validators/coerce_spec.rb
 - spec/grape/validations/validators/default_spec.rb
 - spec/grape/validations/validators/exactly_one_of_spec.rb
+- spec/grape/validations/validators/except_values_spec.rb
 - spec/grape/validations/validators/mutual_exclusion_spec.rb
 - spec/grape/validations/validators/presence_spec.rb
 - spec/grape/validations/validators/regexp_spec.rb
 - spec/grape/validations/validators/values_spec.rb
 - spec/grape/validations/validators/zh-CN.yml
 - spec/grape/validations_spec.rb
+- spec/integration/multi_json/json_spec.rb
+- spec/integration/multi_xml/xml_spec.rb
 - spec/shared/versioning_examples.rb
 - spec/spec_helper.rb
 - spec/support/basic_auth_encode_helpers.rb