grape 0.13.0 → 0.14.0

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

@@ -1,22 +1,22 @@
 require 'spec_helper'
 
 describe Grape::Validations::ValuesValidator do
-  class ValuesModel
-    DEFAULT_VALUES = ['valid-type1', 'valid-type2', 'valid-type3']
-    class << self
-      def values
-        @values ||= []
-        [DEFAULT_VALUES + @values].flatten.uniq
-      end
+  module ValidationsSpec
+    class ValuesModel
+      DEFAULT_VALUES = ['valid-type1', 'valid-type2', 'valid-type3']
+      class << self
+        def values
+          @values ||= []
+          [DEFAULT_VALUES + @values].flatten.uniq
+        end
 
-      def add_value(value)
-        @values ||= []
-        @values << value
+        def add_value(value)
+          @values ||= []
+          @values << value
+        end
       end
     end
-  end
 
-  module ValidationsSpec
     module ValuesValidatorSpec
       class API < Grape::API
         default_format :json
@@ -129,7 +129,7 @@ describe Grape::Validations::ValuesValidator do
   end
 
   it 'does not validate updated values without proc' do
-    ValuesModel.add_value('valid-type4')
+    ValidationsSpec::ValuesModel.add_value('valid-type4')
 
     get('/', type: 'valid-type4')
     expect(last_response.status).to eq 400
@@ -137,7 +137,7 @@ describe Grape::Validations::ValuesValidator do
   end
 
   it 'validates against values in a proc' do
-    ValuesModel.add_value('valid-type4')
+    ValidationsSpec::ValuesModel.add_value('valid-type4')
 
     get('/lambda', type: 'valid-type4')
     expect(last_response.status).to eq 200
@@ -163,7 +163,7 @@ describe Grape::Validations::ValuesValidator do
   it 'raises IncompatibleOptionValues on an invalid default value from proc' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], default: ValuesModel.values.sample + '_invalid' }
+      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], default: ValidationsSpec::ValuesModel.values.sample + '_invalid' }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 

data/spec/grape/validations_spec.rb

@@ -318,6 +318,35 @@ describe Grape::Validations do
       end
     end
 
+    context 'hash with a required param with validation' do
+      before do
+        subject.params do
+          requires :items, type: Hash do
+            requires :key, type: String, values: %w(a b)
+          end
+        end
+        subject.get '/required' do
+          'required works'
+        end
+      end
+
+      it 'errors when param is not a Hash' do
+        get '/required', items: 'not a hash'
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('items is invalid, items[key] is missing, items[key] is invalid')
+
+        get '/required', items: [{ key: 'hash in array' }]
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('items is invalid, items[0][key] does not have a valid value')
+      end
+
+      it 'works when all params match' do
+        get '/required', items: { key: 'a' }
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('required works')
+      end
+    end
+
     context 'group' do
       before do
         subject.params do
@@ -374,10 +403,11 @@ describe Grape::Validations do
     end
 
     context 'custom validator for a Hash' do
-      module DateRangeValidations
-        class DateRangeValidator < Grape::Validations::Base
-          def validate_param!(attr_name, params)
-            unless params[attr_name][:from] <= params[attr_name][:to]
+      module ValuesSpec
+        module DateRangeValidations
+          class DateRangeValidator < Grape::Validations::Base
+            def validate_param!(attr_name, params)
+              return if params[attr_name][:from] <= params[attr_name][:to]
               fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "'from' must be lower or equal to 'to'"
             end
           end
@@ -462,7 +492,7 @@ describe Grape::Validations do
         # NOTE: with body parameters in json or XML or similar this
         # should actually fail with: children[parents][name] is missing.
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[parents] is missing')
+        expect(last_response.body).to eq('children[0][parents] is missing')
       end
 
       it 'safely handles empty arrays and blank parameters' do
@@ -473,7 +503,7 @@ describe Grape::Validations do
         expect(last_response.body).to eq('children is missing')
         get '/within_array', children: [name: 'Jay']
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[parents] is missing')
+        expect(last_response.body).to eq('children[0][parents] is missing')
       end
 
       it 'errors when param is not an Array' do
@@ -488,7 +518,7 @@ describe Grape::Validations do
 
         get '/within_array', children: [name: 'Jay', parents: { name: 'Fred' }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[parents] is invalid')
+        expect(last_response.body).to eq('children[0][parents] is invalid')
       end
     end
 
@@ -614,7 +644,7 @@ describe Grape::Validations do
           { name: 'Job', parents: [{ name: 'Joy' }] }
         ]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[parents][name] is missing')
+        expect(last_response.body).to eq('children[0][parents][0][name] is missing')
       end
 
       it 'safely handles empty arrays and blank parameters' do
@@ -622,7 +652,7 @@ describe Grape::Validations do
         expect(last_response.status).to eq(200)
         put_with_json '/within_array', children: [name: 'Jay']
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[parents] is missing')
+        expect(last_response.body).to eq('children[0][parents] is missing')
       end
     end
 
@@ -653,7 +683,7 @@ describe Grape::Validations do
       it 'errors when group is present, but required param is not' do
         get '/optional_group', items: [{ not_key: 'foo' }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[key] is missing')
+        expect(last_response.body).to eq('items[0][key] is missing')
       end
 
       it "errors when param is present but isn't an Array" do
@@ -697,7 +727,7 @@ describe Grape::Validations do
       it 'does internal validations if the outer group is present' do
         get '/nested_optional_group', items: [{ key: 'foo' }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[required_subitems] is missing')
+        expect(last_response.body).to eq('items[0][required_subitems] is missing')
 
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }] }]
         expect(last_response.status).to eq(200)
@@ -707,7 +737,7 @@ describe Grape::Validations do
       it 'handles deep nesting' do
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }], optional_subitems: [{ not_value: 'baz' }] }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[optional_subitems][value] is missing')
+        expect(last_response.body).to eq('items[0][optional_subitems][0][value] is missing')
 
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }], optional_subitems: [{ value: 'baz' }] }]
         expect(last_response.status).to eq(200)
@@ -717,7 +747,7 @@ describe Grape::Validations do
       it 'handles validation within arrays' do
         get '/nested_optional_group', items: [{ key: 'foo' }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[required_subitems] is missing')
+        expect(last_response.body).to eq('items[0][required_subitems] is missing')
 
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }] }]
         expect(last_response.status).to eq(200)
@@ -725,7 +755,7 @@ describe Grape::Validations do
 
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }], optional_subitems: [{ not_value: 'baz' }] }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[optional_subitems][value] is missing')
+        expect(last_response.body).to eq('items[0][optional_subitems][0][value] is missing')
       end
 
       it 'adds to declared parameters' do
@@ -763,9 +793,8 @@ describe Grape::Validations do
       module CustomValidations
         class Customvalidator < Grape::Validations::Base
           def validate_param!(attr_name, params)
-            unless params[attr_name] == 'im custom'
-              fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: 'is not custom!'
-            end
+            return if params[attr_name] == 'im custom'
+            fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: 'is not custom!'
           end
         end
       end
@@ -912,9 +941,8 @@ describe Grape::Validations do
         module CustomValidations
           class CustomvalidatorWithOptions < Grape::Validations::Base
             def validate_param!(attr_name, params)
-              unless params[attr_name] == @option[:text]
-                fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: @option[:error_message]
-              end
+              return if params[attr_name] == @option[:text]
+              fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: @option[:error_message]
             end
           end
         end
@@ -950,25 +978,26 @@ describe Grape::Validations do
         end
 
         it 'in helper module which kind of Grape::DSL::Helpers::BaseHelper' do
-          module SharedParams
+          shared_params = Module.new do
             extend Grape::DSL::Helpers::BaseHelper
             params :pagination do
             end
           end
-          subject.helpers SharedParams
+          subject.helpers shared_params
         end
       end
 
       context 'can be included in usual params' do
         before do
-          module SharedParams
+          shared_params = Module.new do
             extend Grape::DSL::Helpers::BaseHelper
             params :period do
               optional :start_date
               optional :end_date
             end
           end
-          subject.helpers SharedParams
+
+          subject.helpers shared_params
 
           subject.helpers do
             params :pagination do

data/spec/shared/versioning_examples.rb

@@ -3,7 +3,7 @@ shared_examples_for 'versioning' do
     subject.format :txt
     subject.version 'v1', macro_options
     subject.get :hello do
-      "Version: #{request.env['api.version'] }"
+      "Version: #{request.env['api.version']}"
     end
     versioned_get '/hello', 'v1', macro_options
     expect(last_response.body).to eql 'Version: v1'
@@ -14,7 +14,7 @@ shared_examples_for 'versioning' do
     subject.prefix 'api'
     subject.version 'v1', macro_options
     subject.get :hello do
-      "Version: #{request.env['api.version'] }"
+      "Version: #{request.env['api.version']}"
     end
     versioned_get '/hello', 'v1', macro_options.merge(prefix: 'api')
     expect(last_response.body).to eql 'Version: v1'

data/spec/spec_helper.rb

@@ -12,7 +12,6 @@ require 'json'
 require 'rack/test'
 require 'base64'
 require 'cookiejar'
-require 'json'
 require 'mime/types'
 
 Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|

data/spec/support/versioned_helpers.rb

@@ -26,13 +26,13 @@ def versioned_headers(options)
   when :header
     {
       'HTTP_ACCEPT' => [
-        "application/vnd.#{options[:vendor] }-#{options[:version] }",
+        "application/vnd.#{options[:vendor]}-#{options[:version]}",
         options[:format]
       ].compact.join('+')
     }
   when :accept_version_header
     {
-      'HTTP_ACCEPT_VERSION' => "#{options[:version] }"
+      'HTTP_ACCEPT_VERSION' => "#{options[:version]}"
     }
   else
     fail ArgumentError.new("unknown versioning strategy: #{options[:using]}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -264,6 +264,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -277,7 +291,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -290,6 +304,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.35.1
 description: A Ruby framework for rapid API development with great conventions.
 email:
 - michael@intridea.com
@@ -297,22 +325,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
-- .travis.yml
-- .yardopts
 - Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
 - RELEASING.md
 - Rakefile
 - UPGRADING.md
+- benchmark/simple.rb
+- gemfiles/rack_1.5.2.gemfile
 - gemfiles/rails_3.gemfile
 - gemfiles/rails_4.gemfile
 - grape.gemspec
@@ -342,6 +367,7 @@ files:
 - lib/grape/exceptions/invalid_accept_header.rb
 - lib/grape/exceptions/invalid_formatter.rb
 - lib/grape/exceptions/invalid_message_body.rb
+- lib/grape/exceptions/invalid_version_header.rb
 - lib/grape/exceptions/invalid_versioner_option.rb
 - lib/grape/exceptions/invalid_with_option_for_represent.rb
 - lib/grape/exceptions/missing_group_type.rb
@@ -360,7 +386,6 @@ files:
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
 - lib/grape/http/headers.rb
-- lib/grape/http/request.rb
 - lib/grape/locale/en.yml
 - lib/grape/middleware/auth/base.rb
 - lib/grape/middleware/auth/dsl.rb
@@ -375,6 +400,7 @@ files:
 - lib/grape/middleware/versioner/accept_version_header.rb
 - lib/grape/middleware/versioner/header.rb
 - lib/grape/middleware/versioner/param.rb
+- lib/grape/middleware/versioner/parse_media_type_patch.rb
 - lib/grape/middleware/versioner/path.rb
 - lib/grape/namespace.rb
 - lib/grape/parser/base.rb
@@ -382,17 +408,26 @@ files:
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
 - lib/grape/presenters/presenter.rb
+- lib/grape/request.rb
 - lib/grape/route.rb
 - lib/grape/util/content_types.rb
+- lib/grape/util/env.rb
 - lib/grape/util/file_response.rb
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
-- lib/grape/util/parameter_types.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/strict_hash_configuration.rb
 - lib/grape/validations.rb
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/params_scope.rb
+- lib/grape/validations/types.rb
+- lib/grape/validations/types/build_coercer.rb
+- lib/grape/validations/types/custom_type_coercer.rb
+- lib/grape/validations/types/file.rb
+- lib/grape/validations/types/json.rb
+- 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/validators/all_or_none.rb
 - lib/grape/validations/validators/allow_blank.rb
 - lib/grape/validations/validators/at_least_one_of.rb
@@ -406,6 +441,7 @@ files:
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
+- pkg/grape-0.13.0.gem
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/nested_helpers_spec.rb
@@ -449,13 +485,14 @@ files:
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/path_spec.rb
 - spec/grape/presenters/presenter_spec.rb
+- spec/grape/request_spec.rb
 - spec/grape/util/inheritable_setting_spec.rb
 - spec/grape/util/inheritable_values_spec.rb
-- spec/grape/util/parameter_types_spec.rb
 - 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/params_scope_spec.rb
+- spec/grape/validations/types_spec.rb
 - spec/grape/validations/validators/all_or_none_spec.rb
 - spec/grape/validations/validators/allow_blank_spec.rb
 - spec/grape/validations/validators/at_least_one_of_spec.rb
@@ -543,13 +580,14 @@ test_files:
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/path_spec.rb
 - spec/grape/presenters/presenter_spec.rb
+- spec/grape/request_spec.rb
 - spec/grape/util/inheritable_setting_spec.rb
 - spec/grape/util/inheritable_values_spec.rb
-- spec/grape/util/parameter_types_spec.rb
 - 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/params_scope_spec.rb
+- spec/grape/validations/types_spec.rb
 - spec/grape/validations/validators/all_or_none_spec.rb
 - spec/grape/validations/validators/allow_blank_spec.rb
 - spec/grape/validations/validators/at_least_one_of_spec.rb