grape 0.11.0 → 0.12.0

data/Rakefile

@@ -52,7 +52,7 @@ begin
       end
 
       desc 'Generate and publish YARD docs to GitHub pages.'
-      task :publish => ['doc:pages:checkout', 'doc:pages'] do
+      task publish: ['doc:pages:checkout', 'doc:pages'] do
         Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
           system('git checkout gh-pages')
           system('git add .')

data/UPGRADING.md

@@ -1,9 +1,118 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.12.0
+
+#### Changes in middleware
+
+The Rack response object is no longer converted to an array by the formatter, enabling streaming. If your custom middleware is accessing `@app_response`, update it to expect a `Rack::Response` instance instead of an array.
+
+For example,
+
+```ruby
+class CacheBusterMiddleware < Grape::Middleware::Base
+  def after
+    @app_response[1]['Expires'] = Time.at(0).utc.to_s
+    @app_response
+  end
+end
+```
+
+becomes
+
+```ruby
+class CacheBusterMiddleware < Grape::Middleware::Base
+  def after
+    @app_response.headers['Expires'] = Time.at(0).utc.to_s
+    @app_response
+  end
+end
+```
+
+See [#1029](https://github.com/intridea/grape/pull/1029) for more information.
+
+#### Changes in present
+
+Using `present` with objects that responded to `merge` would cause early evaluation of the represented object, with unexpected side-effects, such as missing parameters or environment within rendering code. Grape now only merges represented objects with a previously rendered body, usually when multiple `present` calls are made in the same route.
+
+See [grape-with-roar#5](https://github.com/dblock/grape-with-roar/issues/5) and [#1023](https://github.com/intridea/grape/issues/1023).
+
+#### Changes to regexp validator
+
+Parameters with `nil` value will now pass `regexp` validation. To disallow `nil` value for an endpoint, add `allow_blank: false`.
+
+```ruby
+params do
+  requires :email, allow_blank: false, regexp: /.+@.+/
+end
+```
+
+See [#957](https://github.com/intridea/grape/pull/957) for more information.
+
+#### Replace error_response with error! in rescue_from blocks
+
+Note: `error_response` is being deprecated, not removed.
+
+```ruby
+def error!(message, status = options[:default_status], headers = {}, backtrace = [])
+  headers = { 'Content-Type' => content_type }.merge(headers)
+  rack_response(format_message(message, backtrace), status, headers)
+end
+```
+
+For example,
+
+```
+error_response({ message: { message: 'No such page.', id: 'missing_page' }, status: 404, headers: { 'Content-Type' => 'api/error' })
+```
+
+becomes
+
+```
+error!({ message: 'No such page.', id: 'missing_page' }, 404, { 'Content-Type' => 'api/error' })
+```
+
+`error!` also supports just passing a message. `error!('Server error.')` and `format: :json` returns the following JSON response
+
+```
+{ 'error': 'Server error. }
+```
+
+with a status code of 500 and a Content Type of text/error.
+
+Optionally, also replace `Rack::Response.new` with `error!.`
+The following are equivalent:
+
+```
+Rack::Response.new([ e.message ], 500, { "Content-type" => "text/error" }).finish
+error!(e)
+```
+
+See [#889](https://github.com/intridea/grape/issues/889) for more information.
+
+#### Changes to routes when using `format`
+
+Version 0.10.0 has introduced a change via [#809](https://github.com/intridea/grape/pull/809) whereas routes no longer got file-type suffixes added if you declared a single API `format`. This has been reverted, it's now again possible to call API with proper suffix when single `format` is defined:
+
+```ruby
+class API < Grape::API
+  format :json
+
+  get :hello do
+    { hello: 'world' }
+  end
+end
+```
+
+Will respond with JSON to `/hello` **and** `/hello.json`.
+
+Will respond with 404 to `/hello.xml`, `/hello.txt` etc.
+
+See the [#1001](https://github.com/intridea/grape/pull/1001) and [#914](https://github.com/intridea/grape/issues/914) for more info.
+
 ### Upgrading to >= 0.11.0
 
-#### Added Rack 1.6.0 Support
+#### Added Rack 1.6.0 support
 
 Grape now supports, but doesn't require Rack 1.6.0. If you encounter an issue with parsing requests larger than 128KB, explictly require Rack 1.6.0 in your Gemfile.
 

data/gemfiles/rails_3.gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gem 'rails', '3.2.19'
 
 group :development, :test do
-  gem 'rubocop', '~> 0.28.0'
+  gem 'rubocop', '~> 0.31.0'
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'

data/gemfiles/rails_4.gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gem 'rails', '4.1.6'
 
 group :development, :test do
-  gem 'rubocop', '~> 0.28.0'
+  gem 'rubocop', '~> 0.31.0'
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'

data/grape.gemspec

@@ -1,4 +1,4 @@
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'grape/version'
 
 Gem::Specification.new do |s|
@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Michael Bleigh']
   s.email       = ['michael@intridea.com']
   s.homepage    = 'https://github.com/intridea/grape'
-  s.summary     = %q{A simple Ruby framework for building REST-like APIs.}
-  s.description = %q{A Ruby framework for rapid API development with great conventions.}
+  s.summary     = 'A simple Ruby framework for building REST-like APIs.'
+  s.description = 'A Ruby framework for rapid API development with great conventions.'
   s.license     = 'MIT'
 
   s.rubyforge_project = 'grape'
@@ -38,6 +38,6 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 end

data/lib/grape.rb

@@ -20,6 +20,7 @@ require 'active_support/ordered_hash'
 require 'active_support/core_ext/object/conversions'
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/dependencies/autoload'
 require 'grape/util/content_types'
 require 'multi_json'
 require 'multi_xml'
@@ -30,102 +31,131 @@ require 'thread'
 I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
 
 module Grape
-  autoload :API,                 'grape/api'
-  autoload :Endpoint,            'grape/endpoint'
+  extend ActiveSupport::Autoload
 
-  autoload :Route,               'grape/route'
-  autoload :Namespace,           'grape/namespace'
+  eager_autoload do
+    autoload :API
+    autoload :Endpoint
 
-  autoload :Path,                'grape/path'
+    autoload :Route
+    autoload :Namespace
 
-  autoload :Cookies,             'grape/cookies'
-  autoload :Validations,         'grape/validations'
-  autoload :Request,             'grape/http/request'
+    autoload :Path
+
+    autoload :Cookies
+    autoload :Validations
+    autoload :Request, 'grape/http/request'
+  end
+
+  module Http
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Headers
+    end
+  end
 
   module Exceptions
-    autoload :Base,                           'grape/exceptions/base'
-    autoload :Validation,                     'grape/exceptions/validation'
-    autoload :ValidationErrors,               'grape/exceptions/validation_errors'
-    autoload :MissingVendorOption,            'grape/exceptions/missing_vendor_option'
-    autoload :MissingMimeType,                'grape/exceptions/missing_mime_type'
-    autoload :MissingOption,                  'grape/exceptions/missing_option'
-    autoload :InvalidFormatter,               'grape/exceptions/invalid_formatter'
-    autoload :InvalidVersionerOption,         'grape/exceptions/invalid_versioner_option'
-    autoload :UnknownValidator,               'grape/exceptions/unknown_validator'
-    autoload :UnknownOptions,                 'grape/exceptions/unknown_options'
-    autoload :InvalidWithOptionForRepresent,  'grape/exceptions/invalid_with_option_for_represent'
-    autoload :IncompatibleOptionValues,       'grape/exceptions/incompatible_option_values'
+    extend ActiveSupport::Autoload
+    autoload :Base
+    autoload :Validation
+    autoload :ValidationErrors
+    autoload :MissingVendorOption
+    autoload :MissingMimeType
+    autoload :MissingOption
+    autoload :InvalidFormatter
+    autoload :InvalidVersionerOption
+    autoload :UnknownValidator
+    autoload :UnknownOptions
+    autoload :InvalidWithOptionForRepresent
+    autoload :IncompatibleOptionValues
     autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
     autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
-    autoload :InvalidMessageBody,             'grape/exceptions/invalid_message_body'
-    autoload :InvalidAcceptHeader,            'grape/exceptions/invalid_accept_header'
+    autoload :InvalidMessageBody
+    autoload :InvalidAcceptHeader
   end
 
   module ErrorFormatter
-    autoload :Base,              'grape/error_formatter/base'
-    autoload :Json,              'grape/error_formatter/json'
-    autoload :Txt,               'grape/error_formatter/txt'
-    autoload :Xml,               'grape/error_formatter/xml'
+    extend ActiveSupport::Autoload
+    autoload :Base
+    autoload :Json
+    autoload :Txt
+    autoload :Xml
   end
 
   module Formatter
-    autoload :Base,              'grape/formatter/base'
-    autoload :Json,              'grape/formatter/json'
-    autoload :SerializableHash,  'grape/formatter/serializable_hash'
-    autoload :Txt,               'grape/formatter/txt'
-    autoload :Xml,               'grape/formatter/xml'
+    extend ActiveSupport::Autoload
+    autoload :Base
+    autoload :Json
+    autoload :SerializableHash
+    autoload :Txt
+    autoload :Xml
   end
 
   module Parser
-    autoload :Base,              'grape/parser/base'
-    autoload :Json,              'grape/parser/json'
-    autoload :Xml,               'grape/parser/xml'
+    extend ActiveSupport::Autoload
+    autoload :Base
+    autoload :Json
+    autoload :Xml
   end
 
   module Middleware
-    autoload :Base,              'grape/middleware/base'
-    autoload :Versioner,         'grape/middleware/versioner'
-    autoload :Formatter,         'grape/middleware/formatter'
-    autoload :Error,             'grape/middleware/error'
+    extend ActiveSupport::Autoload
+    autoload :Base
+    autoload :Versioner
+    autoload :Formatter
+    autoload :Error
+    autoload :Globals
 
     module Auth
-      autoload :Base,            'grape/middleware/auth/base'
-      autoload :DSL,             'grape/middleware/auth/dsl'
-      autoload :StrategyInfo,    'grape/middleware/auth/strategy_info'
-      autoload :Strategies,      'grape/middleware/auth/strategies'
+      extend ActiveSupport::Autoload
+      autoload :Base
+      autoload :DSL
+      autoload :StrategyInfo
+      autoload :Strategies
     end
 
     module Versioner
-      autoload :Path,                 'grape/middleware/versioner/path'
-      autoload :Header,               'grape/middleware/versioner/header'
-      autoload :Param,                'grape/middleware/versioner/param'
-      autoload :AcceptVersionHeader,  'grape/middleware/versioner/accept_version_header'
+      extend ActiveSupport::Autoload
+      autoload :Path
+      autoload :Header
+      autoload :Param
+      autoload :AcceptVersionHeader
     end
   end
 
   module Util
-    autoload :InheritableValues, 'grape/util/inheritable_values'
-    autoload :StackableValues,   'grape/util/stackable_values'
-    autoload :InheritableSetting, 'grape/util/inheritable_setting'
-    autoload :StrictHashConfiguration, 'grape/util/strict_hash_configuration'
+    extend ActiveSupport::Autoload
+    autoload :InheritableValues
+    autoload :StackableValues
+    autoload :InheritableSetting
+    autoload :StrictHashConfiguration
   end
 
   module DSL
-    autoload :API,               'grape/dsl/api'
-    autoload :Callbacks,         'grape/dsl/callbacks'
-    autoload :Settings,          'grape/dsl/settings'
-    autoload :Configuration,     'grape/dsl/configuration'
-    autoload :InsideRoute,       'grape/dsl/inside_route'
-    autoload :Helpers,           'grape/dsl/helpers'
-    autoload :Middleware,        'grape/dsl/middleware'
-    autoload :Parameters,        'grape/dsl/parameters'
-    autoload :RequestResponse,   'grape/dsl/request_response'
-    autoload :Routing,           'grape/dsl/routing'
-    autoload :Validations,       'grape/dsl/validations'
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :API
+      autoload :Callbacks
+      autoload :Settings
+      autoload :Configuration
+      autoload :InsideRoute
+      autoload :Helpers
+      autoload :Middleware
+      autoload :Parameters
+      autoload :RequestResponse
+      autoload :Routing
+      autoload :Validations
+    end
   end
 
   class API
-    autoload :Helpers,           'grape/api/helpers'
+    extend ActiveSupport::Autoload
+    autoload :Helpers
+  end
+
+  module Presenters
+    extend ActiveSupport::Autoload
+    autoload :Presenter
   end
 end
 

data/lib/grape/api.rb

@@ -36,7 +36,7 @@ module Grape
       # Create a scope without affecting the URL.
       #
       # @param name [Symbol] Purely placebo, just allows to name the scope to make the code more readable.
-      def scope(name = nil, &block)
+      def scope(_name = nil, &block)
         within_namespace do
           nest(block)
         end
@@ -95,9 +95,9 @@ module Grape
     end
 
     def call(env)
-      status, headers, body = @route_set.call(env)
-      headers.delete('X-Cascade') unless cascade?
-      [status, headers, body]
+      result = @route_set.call(env)
+      result[1].delete(Grape::Http::Headers::X_CASCADE) unless cascade?
+      result
     end
 
     # Some requests may return a HTTP 404 error if grape cannot find a matching
@@ -142,12 +142,12 @@ module Grape
           methods_per_path.each do |path, methods|
             allowed_methods = methods.dup
             unless self.class.namespace_inheritable(:do_not_route_head)
-              allowed_methods |= ['HEAD'] if allowed_methods.include?('GET')
+              allowed_methods |= [Grape::Http::Headers::HEAD] if allowed_methods.include?(Grape::Http::Headers::GET)
             end
 
-            allow_header = (['OPTIONS'] | allowed_methods).join(', ')
+            allow_header = ([Grape::Http::Headers::OPTIONS] | allowed_methods).join(', ')
             unless self.class.namespace_inheritable(:do_not_route_options)
-              unless allowed_methods.include?('OPTIONS')
+              unless allowed_methods.include?(Grape::Http::Headers::OPTIONS)
                 self.class.options(path, {}) do
                   header 'Allow', allow_header
                   status 204
@@ -157,7 +157,7 @@ module Grape
             end
 
             not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - allowed_methods
-            not_allowed_methods << 'OPTIONS' if self.class.namespace_inheritable(:do_not_route_options)
+            not_allowed_methods << Grape::Http::Headers::OPTIONS if self.class.namespace_inheritable(:do_not_route_options)
             self.class.route(not_allowed_methods, path) do
               header 'Allow', allow_header
               status 405
@@ -168,7 +168,7 @@ module Grape
       end
     end
 
-    def without_versioning(&block)
+    def without_versioning(&_block)
       old_version = self.class.namespace_inheritable(:version)
       old_version_options = self.class.namespace_inheritable(:version_options)
 
@@ -181,7 +181,7 @@ module Grape
       self.class.namespace_inheritable(:version_options, old_version_options)
     end
 
-    def without_root_prefix(&block)
+    def without_root_prefix(&_block)
       old_prefix = self.class.namespace_inheritable(:root_prefix)
 
       self.class.namespace_inheritable_to_nil(:root_prefix)

data/lib/grape/cookies.rb

@@ -12,7 +12,7 @@ module Grape
     end
 
     def write(header)
-      @cookies.select { |key, value| @send_cookies[key] == true }.each do |name, value|
+      @cookies.select { |key, _value| @send_cookies[key] == true }.each do |name, value|
         cookie_value = value.is_a?(Hash) ? value : { value: value }
         Rack::Utils.set_cookie_header! header, name, cookie_value
       end