grape 0.19.2 → 1.0.0

data/Rakefile

@@ -7,6 +7,7 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.exclude_pattern = 'spec/integration/**/*_spec.rb'
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|

data/UPGRADING.md

@@ -1,6 +1,95 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 1.0.0
+
+#### Changes in XML and JSON Parsers
+
+Grape no longer uses `multi_json` or `multi_xml` by default and uses `JSON` and `ActiveSupport::XmlMini` instead. This has no visible impact on JSON processing, but the default behavior of the XML parser has changed. For example, an XML POST containing `<user>Bobby T.</user>` was parsed as `Bobby T.` with `multi_xml`, and as now parsed as `{"__content__"=>"Bobby T."}` with `XmlMini`.
+
+If you were using `MultiJson.load`, `MultiJson.dump` or `MultiXml.parse`, you can substitute those with `Grape::Json.load`, `Grape::Json.dump`, `::Grape::Xml.parse`, or directly with `JSON.load`, `JSON.dump`, `XmlMini.parse`, etc.
+
+To restore previous behavior, add `multi_json` or `multi_xml` to your `Gemfile` and `require` it.
+
+See [#1623](https://github.com/ruby-grape/grape/pull/1623) for more information.
+
+#### Changes in Parameter Class
+
+The default class for `params` has changed from `Hashie::Mash` to `ActiveSupport::HashWithIndifferentAccess` and the `hashie` dependency has been removed. This means that by default you can no longer access parameters by method name.
+
+```ruby
+class API < Grape::API
+  params do
+    optional :color, type: String
+  end
+  get do
+    params[:color] # use params[:color] instead of params.color
+  end
+end
+```
+
+To restore the behavior of prior versions, add `hashie` to your `Gemfile` and `include Grape::Extensions::Hashie::Mash::ParamBuilder` in your API.
+
+```ruby
+class API < Grape::API
+  include Grape::Extensions::Hashie::Mash::ParamBuilder
+
+  params do
+    optional :color, type: String
+  end
+  get do
+    # params.color works
+  end
+end
+```
+
+This behavior can also be overridden on individual parameter blocks using `build_with`.
+
+```ruby
+params do
+  build_with Grape::Extensions::Hash::ParamBuilder
+  optional :color, type: String
+end
+```
+
+If you're constructing your own `Grape::Request` in a middleware, you can pass different parameter handlers to create the desired `params` class with `build_params_with`.
+
+```ruby
+def request
+  Grape::Request.new(env, build_params_with: Grape::Extensions::Hashie::Mash::ParamBuilder)
+end
+```
+
+See [#1610](https://github.com/ruby-grape/grape/pull/1610) for more information.
+
+#### The `except`, `except_message`, and `proc` options of the `values` validator are deprecated.
+
+The new `except_values` validator should be used in place of the `except` and `except_message` options of
+the `values` validator.
+
+Arity one Procs may now be used directly as the `values` option to explicitly test param values.
+
+**Deprecated**
+```ruby
+params do
+  requires :a, values: { value: 0..99, except: [3] }
+  requires :b, values: { value: 0..99, except: [3], except_message: 'not allowed' }
+  requires :c, values: { except: ['admin'] }
+  requires :d, values: { proc: -> (v) { v.even? } }
+end
+```
+**New**
+```ruby
+params do
+  requires :a, values: 0..99, except_values: [3]
+  requires :b, values: 0..99, except_values: { value: [3], message: 'not allowed' }
+  requires :c, except_values: ['admin']
+  requires :d, values: -> (v) { v.even? }
+end
+```
+
+See [#1616](https://github.com/ruby-grape/grape/pull/1616) for more information.
+
 ### Upgrading to >= 0.19.1
 
 #### DELETE now defaults to status code 200 for responses with a body, or 204 otherwise

data/benchmark/simple_with_type_coercer.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'grape'
+require 'benchmark/ips'
+
+api = Class.new(Grape::API) do
+  prefix :api
+  version 'v1', using: :path
+  params do
+    requires :param, type: Array[String]
+  end
+  get '/' do
+    'hello'
+  end
+end
+
+env = Rack::MockRequest.env_for('/api/v1?param=value', method: 'GET')
+
+Benchmark.ips do |ips|
+  ips.report('simple_with_type_coercer') do
+    api.call(env)
+  end
+end

data/gemfiles/multi_json.gemfile

@@ -0,0 +1,36 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'multi_json', require: 'multi_json'
+
+group :development, :test do
+  gem 'bundler'
+  gem 'rake'
+  gem 'rubocop', '0.47.0'
+  gem 'hashie'
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'yard'
+  gem 'appraisal'
+  gem 'benchmark-ips'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem 'grape-entity', '~> 0.6'
+  gem 'maruku'
+  gem 'rack-test'
+  gem 'rspec', '~> 3.0'
+  gem 'cookiejar'
+  gem 'rack-jsonp', require: 'rack/jsonp'
+  gem 'mime-types'
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
+  gem 'coveralls', '~> 0.8.17', require: false
+end
+
+gemspec path: '../'

data/gemfiles/multi_xml.gemfile

@@ -0,0 +1,36 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'multi_xml', require: 'multi_xml'
+
+group :development, :test do
+  gem 'bundler'
+  gem 'rake'
+  gem 'rubocop', '0.47.0'
+  gem 'hashie'
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'yard'
+  gem 'appraisal'
+  gem 'benchmark-ips'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem 'grape-entity', '~> 0.6'
+  gem 'maruku'
+  gem 'rack-test'
+  gem 'rspec', '~> 3.0'
+  gem 'cookiejar'
+  gem 'rack-jsonp', require: 'rack/jsonp'
+  gem 'mime-types'
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
+  gem 'coveralls', '~> 0.8.17', require: false
+end
+
+gemspec path: '../'

data/gemfiles/rack_1.5.2.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie'
 end
 
 group :development do

data/gemfiles/rack_edge.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie'
 end
 
 group :development do

data/gemfiles/rails_3.gemfile

@@ -9,6 +9,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie'
 end
 
 group :development do

data/gemfiles/rails_4.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie'
 end
 
 group :development do

data/gemfiles/rails_5.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie'
 end
 
 group :development do

data/gemfiles/rails_edge.gemfile

@@ -8,6 +8,7 @@ group :development, :test do
   gem 'bundler'
   gem 'rake'
   gem 'rubocop', '0.47.0'
+  gem 'hashie'
 end
 
 group :development do

data/grape.gemspec

@@ -16,9 +16,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'mustermann-grape', '~> 1.0.0'
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'activesupport'
-  s.add_runtime_dependency 'multi_json', '>= 1.3.2'
-  s.add_runtime_dependency 'multi_xml', '>= 0.5.2'
-  s.add_runtime_dependency 'hashie', '>= 2.1.0'
   s.add_runtime_dependency 'virtus', '>= 1.0.0'
   s.add_runtime_dependency 'builder'
 

data/lib/grape.rb

@@ -4,7 +4,6 @@ require 'rack/builder'
 require 'rack/accept'
 require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
-require 'hashie'
 require 'set'
 require 'active_support/version'
 require 'active_support/core_ext/hash/indifferent_access'
@@ -17,8 +16,6 @@ require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
-require 'multi_json'
-require 'multi_xml'
 require 'i18n'
 require 'thread'
 
@@ -27,7 +24,7 @@ require 'virtus'
 I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
 
 module Grape
-  extend ActiveSupport::Autoload
+  extend ::ActiveSupport::Autoload
 
   eager_autoload do
     autoload :API
@@ -45,17 +42,19 @@ module Grape
     autoload :Parser
     autoload :Request
     autoload :Env, 'grape/util/env'
+    autoload :Json, 'grape/util/json'
+    autoload :Xml, 'grape/util/xml'
   end
 
   module Http
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     eager_autoload do
       autoload :Headers
     end
   end
 
   module Exceptions
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Base
     autoload :Validation
     autoload :ValidationArrayErrors
@@ -78,16 +77,38 @@ module Grape
     autoload :MethodNotAllowed
   end
 
+  module Extensions
+    extend ::ActiveSupport::Autoload
+
+    autoload :DeepMergeableHash
+    autoload :DeepSymbolizeHash
+    autoload :DeepHashWithIndifferentAccess
+    autoload :Hash
+
+    module ActiveSupport
+      extend ::ActiveSupport::Autoload
+
+      autoload :HashWithIndifferentAccess
+    end
+
+    module Hashie
+      extend ::ActiveSupport::Autoload
+
+      autoload :Mash
+    end
+  end
+
   module Middleware
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Base
     autoload :Versioner
     autoload :Formatter
     autoload :Error
     autoload :Globals
+    autoload :Stack
 
     module Auth
-      extend ActiveSupport::Autoload
+      extend ::ActiveSupport::Autoload
       autoload :Base
       autoload :DSL
       autoload :StrategyInfo
@@ -95,7 +116,7 @@ module Grape
     end
 
     module Versioner
-      extend ActiveSupport::Autoload
+      extend ::ActiveSupport::Autoload
       autoload :Path
       autoload :Header
       autoload :Param
@@ -104,7 +125,7 @@ module Grape
   end
 
   module Util
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :InheritableValues
     autoload :StackableValues
     autoload :ReverseStackableValues
@@ -114,7 +135,7 @@ module Grape
   end
 
   module ErrorFormatter
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Base
     autoload :Json
     autoload :Txt
@@ -122,7 +143,7 @@ module Grape
   end
 
   module Formatter
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Json
     autoload :SerializableHash
     autoload :Txt
@@ -130,13 +151,13 @@ module Grape
   end
 
   module Parser
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Json
     autoload :Xml
   end
 
   module DSL
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     eager_autoload do
       autoload :API
       autoload :Callbacks
@@ -155,17 +176,17 @@ module Grape
   end
 
   class API
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Helpers
   end
 
   module Presenters
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :Presenter
   end
 
   module ServeFile
-    extend ActiveSupport::Autoload
+    extend ::ActiveSupport::Autoload
     autoload :FileResponse
     autoload :FileBody
     autoload :SendfileResponse
@@ -185,8 +206,10 @@ require 'grape/validations/validators/mutual_exclusion'
 require 'grape/validations/validators/presence'
 require 'grape/validations/validators/regexp'
 require 'grape/validations/validators/values'
+require 'grape/validations/validators/except_values'
 require 'grape/validations/params_scope'
 require 'grape/validations/validators/all_or_none'
 require 'grape/validations/types'
+require 'grape/validations/validator_factory'
 
 require 'grape/version'

data/lib/grape/dsl/helpers.rb

@@ -13,7 +13,7 @@ module Grape
         # When called without a block, all known helpers within this scope
         # are included.
         #
-        # @param [Module] new_mod optional module of methods to include
+        # @param [Array] new_modules optional array of modules to include
         # @param [Block] block optional block of methods to include
         #
         # @example Define some helpers.
@@ -26,28 +26,42 @@ module Grape
         #       end
         #     end
         #
-        def helpers(new_mod = nil, &block)
-          if block_given? || new_mod
-            mod = new_mod || Module.new
-            define_boolean_in_mod(mod)
-            inject_api_helpers_to_mod(mod) if new_mod
+        # @example Include many modules
+        #
+        #     class ExampleAPI < Grape::API
+        #       helpers Authentication, Mailer, OtherModule
+        #     end
+        #
+        def helpers(*new_modules, &block)
+          include_new_modules(new_modules) if new_modules.any?
+          include_block(block) if block_given?
+          include_all_in_scope if !block_given? && new_modules.empty?
+        end
 
-            inject_api_helpers_to_mod(mod) do
-              mod.class_eval(&block)
-            end if block_given?
+        protected
 
-            namespace_stackable(:helpers, mod)
-          else
-            mod = Module.new
-            namespace_stackable(:helpers).each do |mod_to_include|
-              mod.send :include, mod_to_include
-            end
-            change!
-            mod
+        def include_new_modules(modules)
+          modules.each { |mod| make_inclusion(mod) }
+        end
+
+        def include_block(block)
+          Module.new.tap do |mod|
+            make_inclusion(mod) { mod.class_eval(&block) }
           end
         end
 
-        protected
+        def make_inclusion(mod, &block)
+          define_boolean_in_mod(mod)
+          inject_api_helpers_to_mod(mod, &block)
+          namespace_stackable(:helpers, mod)
+        end
+
+        def include_all_in_scope
+          Module.new.tap do |mod|
+            namespace_stackable(:helpers).each { |mod_to_include| mod.send :include, mod_to_include }
+            change!
+          end
+        end
 
         def define_boolean_in_mod(mod)
           return if defined? mod::Boolean