grape 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d283d4483281266120c9894d4abf116577e4f6d0
-  data.tar.gz: d730405b71975b6d471a9fd0366bc49715377725
+  metadata.gz: f90062d2ff701a0d5a85be85c6658ba4f586849b
+  data.tar.gz: f43b46740851eb22a55e1fae15c8173875d5da9f
 SHA512:
-  metadata.gz: 134c53c62b330e7ff63acb341d30ae493b303d29610d57a8746796533698e9c83addbee84836440a921240f3a38451139e3699ec3f273cfb2eaeabdb162c1560
-  data.tar.gz: dd02f3635d42061cdfe7ee32984541c0284f39c38c38b3e541b409ba64af66cfd9f691c400c68ff899d42e387784a25e08eb8176e462c04995b3f8b55363d180
+  metadata.gz: c3385b8c8c88db4eefd090030a8b73af0cd00b7b5ff5a247221a21fddfb3956d0268a7b2ed40ef74e222dee81fc4c5b3e99065501d5b044297e50edfc3c32054
+  data.tar.gz: 7cd058957cf3f3d8e770db3887a016e9a0dfa000985487973afb399203a1fda0a0a95a94e2e4a3541a2641008197d94c182ef4d92a85ffde0def8440099184bc

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 1.0.1 (9/8/2017)
+
+#### Features
+
+* [#1652](https://github.com/ruby-grape/grape/pull/1652): Add the original exception to the error_formatter the original exception - [@dcsg](https://github.com/dcsg).
+* [#1665](https://github.com/ruby-grape/grape/pull/1665): Make helpers available in subclasses - [@pablonahuelgomez](https://github.com/pablonahuelgomez).
+* [#1674](https://github.com/ruby-grape/grape/pull/1674): Add parameter alias (`as`) - [@glaucocustodio](https://github.com/glaucocustodio).
+
+#### Fixes
+
+* [#1652](https://github.com/ruby-grape/grape/pull/1652): Fix missing backtrace that was not being bubbled up to the `error_formatter` - [@dcsg](https://github.com/dcsg).
+* [#1661](https://github.com/ruby-grape/grape/pull/1661): Handle deeply-nested dependencies correctly - [@rnubel](https://github.com/rnubel), [@jnardone](https://github.com/jnardone).
+* [#1679](https://github.com/ruby-grape/grape/pull/1679): Treat StandardError from explicit values validator proc as false - [@jlfaber](https://github.com/jlfaber).
+
 ### 1.0.0 (7/3/2017)
 
 #### Features

data/Gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape (1.0.0)
+    grape (1.0.1)
       activesupport
       builder
       mustermann-grape (~> 1.0.0)
@@ -12,13 +12,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.2)
+    activesupport (5.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     appraisal (2.2.0)
       bundler
       rake
@@ -35,7 +35,7 @@ GEM
       cork
       nap
       open4 (~> 1.3)
-    coderay (1.1.1)
+    coderay (1.1.2)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     colored (1.2)
@@ -70,7 +70,7 @@ GEM
     diff-lcs (1.3)
     docile (1.1.5)
     equalizer (0.0.11)
-    faraday (0.12.1)
+    faraday (0.13.1)
       multipart-post (>= 1.2, < 3)
     faraday-http-cache (1.3.1)
       faraday (~> 0.8)
@@ -97,8 +97,8 @@ GEM
     guard-rubocop (1.3.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    hashie (3.5.5)
-    i18n (0.8.4)
+    hashie (3.5.6)
+    i18n (0.8.6)
     ice_nine (0.11.2)
     json (2.1.0)
     kramdown (1.14.0)
@@ -112,10 +112,10 @@ GEM
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    minitest (5.10.2)
-    multi_json (1.12.1)
+    minitest (5.10.3)
+    multi_json (1.12.2)
     multipart-post (2.0.0)
-    mustermann (1.0.0)
+    mustermann (1.0.1)
     mustermann-grape (1.0.0)
       mustermann (~> 1.0.0)
     nap (1.1.0)
@@ -133,7 +133,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (2.0.5)
+    public_suffix (3.0.0)
     rack (2.0.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
@@ -180,7 +180,7 @@ GEM
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.1)
+    simplecov-html (0.10.2)
     slop (3.6.0)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
@@ -217,7 +217,7 @@ DEPENDENCIES
   maruku
   mime-types
   rack-jsonp
-  rack-test
+  rack-test (~> 0.6.3)
   rake
   redcarpet
   rspec (~> 3.0)
@@ -226,4 +226,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.14.6
+   1.15.3

data/README.md

@@ -42,6 +42,7 @@
   - [Validation of Nested Parameters](#validation-of-nested-parameters)
   - [Dependent Parameters](#dependent-parameters)
   - [Group Options](#group-options)
+  - [Alias](#alias)
   - [Built-in Validators](#built-in-validators)
   - [Namespace Validation and Coercion](#namespace-validation-and-coercion)
   - [Custom Validators](#custom-validators)
@@ -109,7 +110,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, 1.0.0.
+You're reading the documentation for the stable release of Grape, 1.0.1.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources
@@ -1093,6 +1094,23 @@ params do
 end
 ```
 
+### Alias
+
+You can set an alias for parameters using `as`, which can be useful when refactoring existing APIs:
+
+```ruby
+resource :users do
+  params do
+    requires :email_address, as: :email
+    requires :password
+  end
+  post do
+    User.create!(declared(params)) # User takes email and password
+  end
+end
+```
+
+The value passed to `as` will be the key when calling `params` or `declared(params)`.
 
 ### Built-in Validators
 
@@ -1160,7 +1178,8 @@ end
 
 Alternatively, a Proc with arity one (i.e. taking one argument) can be used to explicitly validate
 each parameter value.  In that case, the Proc is expected to return a truthy value if the parameter
-value is valid.
+value is valid. The parameter will be considered invalid if the Proc returns a falsy value or if it
+raises a StandardError.
 
 ```ruby
 params do

data/gemfiles/multi_json.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/multi_xml.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/rack_1.5.2.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/rack_edge.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/rails_3.gemfile

@@ -25,7 +25,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/rails_4.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/rails_5.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/gemfiles/rails_edge.gemfile

@@ -24,7 +24,7 @@ end
 group :test do
   gem 'grape-entity', '~> 0.6'
   gem 'maruku'
-  gem 'rack-test'
+  gem 'rack-test', '~> 0.6.3'
   gem 'rspec', '~> 3.0'
   gem 'cookiejar'
   gem 'rack-jsonp', require: 'rack/jsonp'

data/lib/grape.rb

@@ -13,6 +13,7 @@ require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
@@ -198,6 +199,7 @@ require 'grape/util/content_types'
 require 'grape/validations/validators/base'
 require 'grape/validations/attributes_iterator'
 require 'grape/validations/validators/allow_blank'
+require 'grape/validations/validators/as'
 require 'grape/validations/validators/at_least_one_of'
 require 'grape/validations/validators/coerce'
 require 'grape/validations/validators/default'

data/lib/grape/dsl/inside_route.rb

@@ -50,8 +50,16 @@ module Grape
             # If it is not a Hash then it does not have children.
             # Find its value or set it to nil.
             if !declared_param.is_a?(Hash)
-              next unless options[:include_missing] || passed_params.key?(declared_param)
-              memo[optioned_param_key(declared_param, options)] = passed_params[declared_param]
+              has_alias = route_setting(:aliased_params) && route_setting(:aliased_params).find { |current| current[declared_param] }
+              param_alias = has_alias[declared_param] if has_alias
+
+              next unless options[:include_missing] || passed_params.key?(declared_param) || param_alias
+
+              if param_alias
+                memo[optioned_param_key(param_alias, options)] = passed_params[param_alias]
+              else
+                memo[optioned_param_key(declared_param, options)] = passed_params[declared_param]
+              end
             else
               declared_param.each_pair do |declared_parent_param, declared_children_params|
                 next unless options[:include_missing] || passed_params.key?(declared_parent_param)

data/lib/grape/dsl/parameters.rb

@@ -131,8 +131,7 @@ module Grape
           require_required_and_optional_fields(attrs.first, opts)
         else
           validate_attributes(attrs, opts, &block)
-
-          block_given? ? new_scope(orig_attrs, &block) : push_declared_params(attrs)
+          block_given? ? new_scope(orig_attrs, &block) : push_declared_params(attrs, opts.slice(:as))
         end
       end
 
@@ -158,7 +157,7 @@ module Grape
         else
           validate_attributes(attrs, opts, &block)
 
-          block_given? ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs)
+          block_given? ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs, opts.slice(:as))
         end
       end
 

data/lib/grape/dsl/settings.rb

@@ -2,7 +2,7 @@ require 'active_support/concern'
 
 module Grape
   module DSL
-    # Keeps track of settings (impemented as key-value pairs, grouped by
+    # Keeps track of settings (implemented as key-value pairs, grouped by
     # types), in two contexts: top-level settings which apply globally no
     # matter where they're defined, and inheritable settings which apply only
     # in the current scope and scopes nested under it.
@@ -13,7 +13,7 @@ module Grape
 
       # Fetch our top-level settings, which apply to all endpoints in the API.
       def top_level_setting
-        @top_level_setting ||= Grape::Util::InheritableSetting.new
+        @top_level_setting ||= build_top_level_setting
       end
 
       # Fetch our current inheritable settings, which are inherited by
@@ -162,6 +162,18 @@ module Grape
 
         result
       end
+
+      private
+
+      # Builds the current class :inheritable_setting. If available, it returns the superclass's :inheritable_setting.
+      # Otherwise, a clean :inheritable_setting is returned.
+      def build_top_level_setting
+        if defined?(superclass) && superclass.respond_to?(:inheritable_setting) && superclass != Grape::API
+          superclass.inheritable_setting
+        else
+          Grape::Util::InheritableSetting.new
+        end
+      end
     end
   end
 end

data/lib/grape/error_formatter/json.rb

@@ -4,12 +4,16 @@ module Grape
       extend Base
 
       class << self
-        def call(message, backtrace, options = {}, env = nil)
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
           result = wrap_message(present(message, env))
 
-          if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
+          rescue_options = options[:rescue_options] || {}
+          if rescue_options[:backtrace] && backtrace && !backtrace.empty?
             result = result.merge(backtrace: backtrace)
           end
+          if rescue_options[:original_exception] && original_exception
+            result = result.merge(original_exception: original_exception.inspect)
+          end
           ::Grape::Json.dump(result)
         end
 

data/lib/grape/error_formatter/txt.rb

@@ -4,14 +4,19 @@ module Grape
       extend Base
 
       class << self
-        def call(message, backtrace, options = {}, env = nil)
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
           message = present(message, env)
 
           result = message.is_a?(Hash) ? ::Grape::Json.dump(message) : message
-          if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
-            result += "\r\n "
+          rescue_options = options[:rescue_options] || {}
+          if rescue_options[:backtrace] && backtrace && !backtrace.empty?
+            result += "\r\n backtrace:"
             result += backtrace.join("\r\n ")
           end
+          if rescue_options[:original_exception] && original_exception
+            result += "\r\n original exception:"
+            result += "\r\n #{original_exception.inspect}"
+          end
           result
         end
       end

data/lib/grape/error_formatter/xml.rb

@@ -4,13 +4,17 @@ module Grape
       extend Base
 
       class << self
-        def call(message, backtrace, options = {}, env = nil)
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
           message = present(message, env)
 
           result = message.is_a?(Hash) ? message : { message: message }
-          if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
+          rescue_options = options[:rescue_options] || {}
+          if rescue_options[:backtrace] && backtrace && !backtrace.empty?
             result = result.merge(backtrace: backtrace)
           end
+          if rescue_options[:original_exception] && original_exception
+            result = result.merge(original_exception: original_exception.inspect)
+          end
           result.respond_to?(:to_xml) ? result.to_xml(root: :error) : result.to_s
         end
       end

data/lib/grape/middleware/error.rb

@@ -14,7 +14,10 @@ module Grape
           rescue_all: false, # true to rescue all exceptions
           rescue_grape_exceptions: false,
           rescue_subclasses: true, # rescue subclasses of exceptions listed
-          rescue_options: { backtrace: false }, # true to display backtrace, true to let Grape handle Grape::Exceptions
+          rescue_options: {
+            backtrace: false, # true to display backtrace, true to let Grape handle Grape::Exceptions
+            original_exception: false, # true to display exception
+          },
           rescue_handlers: {}, # rescue handler blocks
           base_only_rescue_handlers: {}, # rescue handler blocks rescuing only the base class
           all_rescue_handler: nil # rescue handler block to rescue from all exceptions
@@ -77,13 +80,13 @@ module Grape
         end
       end
 
-      def error!(message, status = options[:default_status], headers = {}, backtrace = [])
+      def error!(message, status = options[:default_status], headers = {}, backtrace = [], original_exception = nil)
         headers = headers.reverse_merge(Grape::Http::Headers::CONTENT_TYPE => content_type)
-        rack_response(format_message(message, backtrace), status, headers)
+        rack_response(format_message(message, backtrace, original_exception), status, headers)
       end
 
       def handle_error(e)
-        error_response(message: e.message, backtrace: e.backtrace)
+        error_response(message: e.message, backtrace: e.backtrace, original_exception: e)
       end
 
       # TODO: This method is deprecated. Refactor out.
@@ -92,19 +95,24 @@ module Grape
         message = error[:message] || options[:default_message]
         headers = { Grape::Http::Headers::CONTENT_TYPE => content_type }
         headers.merge!(error[:headers]) if error[:headers].is_a?(Hash)
-        backtrace = error[:backtrace] || []
-        rack_response(format_message(message, backtrace), status, headers)
+        backtrace = error[:backtrace] || error[:original_exception] && error[:original_exception].backtrace || []
+        original_exception = error.is_a?(Exception) ? error : error[:original_exception] || nil
+        rack_response(format_message(message, backtrace, original_exception), status, headers)
       end
 
       def rack_response(message, status = options[:default_status], headers = { Grape::Http::Headers::CONTENT_TYPE => content_type })
         Rack::Response.new([message], status, headers).finish
       end
 
-      def format_message(message, backtrace)
+      def format_message(message, backtrace, original_exception = nil)
         format = env[Grape::Env::API_FORMAT] || options[:format]
         formatter = Grape::ErrorFormatter.formatter_for(format, options)
-        throw :error, status: 406, message: "The requested format '#{format}' is not supported." unless formatter
-        formatter.call(message, backtrace, options, env)
+        throw :error,
+              status: 406,
+              message: "The requested format '#{format}' is not supported.",
+              backtrace: backtrace,
+              original_exception: original_exception unless formatter
+        formatter.call(message, backtrace, options, env, original_exception)
       end
 
       private