grape 0.13.0 → 0.14.0

data/Rakefile

@@ -17,52 +17,49 @@ end
 task :spec
 
 require 'rainbow/ext/string' unless String.respond_to?(:color)
+
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task default: [:rubocop, :spec]
 
-begin
-  require 'yard'
-  DOC_FILES = ['lib/**/*.rb', 'README.md']
+require 'yard'
+DOC_FILES = ['lib/**/*.rb', 'README.md']
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+end
 
-  YARD::Rake::YardocTask.new(:doc) do |t|
+namespace :doc do
+  YARD::Rake::YardocTask.new(:pages) do |t|
     t.files   = DOC_FILES
+    t.options = ['-o', '../grape.doc/docs']
   end
 
-  namespace :doc do
-    YARD::Rake::YardocTask.new(:pages) do |t|
-      t.files   = DOC_FILES
-      t.options = ['-o', '../grape.doc/docs']
-    end
-
-    namespace :pages do
-      desc 'Check out gh-pages.'
-      task :checkout do
-        dir = File.dirname(__FILE__) + '/../grape.doc'
-        unless Dir.exist?(dir)
-          Dir.mkdir(dir)
-          Dir.chdir(dir) do
-            system('git init')
-            system('git remote add origin git@github.com:ruby-grape/grape.git')
-            system('git pull')
-            system('git checkout gh-pages')
-          end
+  namespace :pages do
+    desc 'Check out gh-pages.'
+    task :checkout do
+      dir = File.dirname(__FILE__) + '/../grape.doc'
+      unless Dir.exist?(dir)
+        Dir.mkdir(dir)
+        Dir.chdir(dir) do
+          system('git init')
+          system('git remote add origin git@github.com:ruby-grape/grape.git')
+          system('git pull')
+          system('git checkout gh-pages')
         end
       end
+    end
 
-      desc 'Generate and publish YARD docs to GitHub pages.'
-      task publish: ['doc:pages:checkout', 'doc:pages'] do
-        Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
-          system('git checkout gh-pages')
-          system('git add .')
-          system('git add -u')
-          system("git commit -m 'Generating docs for version #{Grape::VERSION}.'")
-          system('git push origin gh-pages')
-        end
+    desc 'Generate and publish YARD docs to GitHub pages.'
+    task publish: ['doc:pages:checkout', 'doc:pages'] do
+      Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
+        system('git checkout gh-pages')
+        system('git add .')
+        system('git add -u')
+        system("git commit -m 'Generating docs for version #{Grape::VERSION}.'")
+        system('git push origin gh-pages')
       end
     end
   end
-rescue LoadError
-  puts 'You need to install YARD.'
 end

data/UPGRADING.md

@@ -1,6 +1,37 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.14.0
+
+#### Changes to availability of DSL methods in filters
+
+The `#declared` method of the route DSL is no longer available in the `before` filter.  Using `declared` in a `before` filter will now raise `Grape::DSL::InsideRoute::MethodNotYetAvailable`.
+
+See [#1074](https://github.com/ruby-grape/grape/issues/1074) for discussion of the issue.
+
+#### Changes to header versioning and invalid header version handling
+
+Identical endpoints with different versions now work correctly. A regression introduced in Grape 0.11.0 caused all but the first-mounted version for such an endpoint to wrongly throw an `InvalidAcceptHeader`. As a side effect, requests with a correct vendor but invalid version can no longer be rescued from a `rescue_from` block.
+
+See [#1114](https://github.com/ruby-grape/grape/pull/1114) for more information.
+
+#### Bypasses formatters when status code indicates no content
+
+To be consistent with rack and it's handling of standard responses
+associated with no content, both default and custom formatters will now
+be bypassed when processing responses for status codes defined [by rack](https://github.com/rack/rack/blob/master/lib/rack/utils.rb#L567)
+
+See [#1190](https://github.com/ruby-grape/grape/pull/1190) for more information.
+
+#### Redirects respond as plain text with message
+
+`#redirect` now uses `text/plain` regardless of whether that format has
+been enabled. This prevents formatters from attempting to serialize the
+message body and allows for a descriptive message body to be provided - and
+optionally overridden - that better fulfills the theme of the HTTP spec.
+
+See [#1194](https://github.com/ruby-grape/grape/pull/1194) for more information.
+
 ### Upgrading to >= 0.12.0
 
 #### Changes in middleware

data/benchmark/simple.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'grape'
+require 'benchmark/ips'
+
+class API < Grape::API
+  prefix :api
+  version 'v1', using: :path
+  get '/' do
+    'hello'
+  end
+end
+
+options = {
+  method: 'GET'
+}
+
+env = Rack::MockRequest.env_for('/api/v1', options)
+
+10.times do |i|
+  env["HTTP_HEADER#{i}"] = '123'
+end
+
+Benchmark.ips do |ips|
+  ips.report('simple') do
+    API.call env
+  end
+end

data/gemfiles/rack_1.5.2.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rack', '1.5.2'
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+end
+
+gemspec path: '../'

data/gemfiles/rails_3.gemfile

@@ -3,12 +3,12 @@
 source 'https://rubygems.org'
 
 gem 'rails', '3.2.19'
+gem 'rack-cache', '<= 1.2'
 
 group :development, :test do
-  gem 'rubocop', '~> 0.31.0'
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'
 end
 
-gemspec :path => '../'
+gemspec path: '../'

data/gemfiles/rails_4.gemfile

@@ -5,10 +5,9 @@ source 'https://rubygems.org'
 gem 'rails', '4.1.6'
 
 group :development, :test do
-  gem 'rubocop', '~> 0.31.0'
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'
 end
 
-gemspec :path => '../'
+gemspec path: '../'

data/grape.gemspec

@@ -31,11 +31,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'cookiejar'
   s.add_development_dependency 'rack-contrib'
-  s.add_development_dependency 'mime-types'
+  s.add_development_dependency 'mime-types', '< 3.0'
   s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'benchmark-ips'
+  s.add_development_dependency 'rubocop', '0.35.1'
 
-  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.files         = Dir['**/*'].keep_if { |file| File.file?(file) }
+  s.test_files    = Dir['spec/**/*']
   s.require_paths = ['lib']
 end

data/lib/grape.rb

@@ -9,19 +9,21 @@ require 'hashie'
 require 'set'
 require 'active_support/version'
 require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/ordered_hash'
-require 'active_support/core_ext/object/conversions'
+require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/array/extract_options'
+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/dependencies/autoload'
 require 'active_support/notifications'
 require 'multi_json'
 require 'multi_xml'
-require 'virtus'
 require 'i18n'
 require 'thread'
 
+require 'virtus'
+
 I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
 
 module Grape
@@ -38,7 +40,8 @@ module Grape
 
     autoload :Cookies
     autoload :Validations
-    autoload :Request, 'grape/http/request'
+    autoload :Request
+    autoload :Env, 'grape/util/env'
   end
 
   module Http
@@ -67,6 +70,7 @@ module Grape
     autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
     autoload :InvalidMessageBody
     autoload :InvalidAcceptHeader
+    autoload :InvalidVersionHeader
   end
 
   module ErrorFormatter
@@ -156,7 +160,6 @@ module Grape
 end
 
 require 'grape/util/content_types'
-require 'grape/util/parameter_types'
 
 require 'grape/validations/validators/base'
 require 'grape/validations/attributes_iterator'
@@ -171,5 +174,6 @@ require 'grape/validations/validators/regexp'
 require 'grape/validations/validators/values'
 require 'grape/validations/params_scope'
 require 'grape/validations/validators/all_or_none'
+require 'grape/validations/types'
 
 require 'grape/version'

data/lib/grape/dsl/configuration.rb

@@ -64,6 +64,9 @@ module Grape
             end
 
             config_class.configure(&config_block)
+            unless options.empty?
+              warn '[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.'
+            end
             options = config_class.settings
           else
             options = options.merge(description: description)
@@ -94,8 +97,8 @@ module Grape
 
       # Merge multiple layers of settings into one hash.
       def stacked_hash_to_hash(settings)
-        return nil if settings.nil? || settings.blank?
-        settings.each_with_object(ActiveSupport::OrderedHash.new) { |value, result| result.deep_merge!(value) }
+        return if settings.blank?
+        settings.each_with_object({}) { |value, result| result.deep_merge!(value) }
       end
 
       # Returns an object which configures itself via an instance-context DSL.

data/lib/grape/dsl/helpers.rb

@@ -29,6 +29,7 @@ module Grape
         def helpers(new_mod = nil, &block)
           if block_given? || new_mod
             mod = new_mod || Module.new
+            define_boolean_in_mod(mod)
             if new_mod
               inject_api_helpers_to_mod(new_mod) if new_mod.is_a?(BaseHelper)
             end
@@ -51,6 +52,11 @@ module Grape
 
         protected
 
+        def define_boolean_in_mod(mod)
+          return if defined? mod::Boolean
+          mod.const_set('Boolean', Virtus::Attribute::Boolean)
+        end
+
         def inject_api_helpers_to_mod(mod, &_block)
           mod.extend(BaseHelper)
           yield if block_given?
@@ -75,9 +81,8 @@ module Grape
         protected
 
         def process_named_params
-          if @named_params && @named_params.any?
-            api.namespace_stackable(:named_params, @named_params)
-          end
+          return unless @named_params && @named_params.any?
+          api.namespace_stackable(:named_params, @named_params)
         end
       end
     end

data/lib/grape/dsl/inside_route.rb

@@ -6,57 +6,74 @@ module Grape
       extend ActiveSupport::Concern
       include Grape::DSL::Settings
 
-      # A filtering method that will return a hash
-      # consisting only of keys that have been declared by a
-      # `params` statement against the current/target endpoint or parent
-      # namespaces.
-      #
-      # @param params [Hash] The initial hash to filter. Usually this will just be `params`
-      # @param options [Hash] Can pass `:include_missing`, `:stringify` and `:include_parent_namespaces`
-      # options. `:include_parent_namespaces` defaults to true, hence must be set to false if
-      # you want only to return params declared against the current/target endpoint.
-      def declared(params, options = {}, declared_params = nil)
-        options[:include_missing] = true unless options.key?(:include_missing)
-        options[:include_parent_namespaces] = true unless options.key?(:include_parent_namespaces)
-
-        if declared_params.nil?
-          declared_params = (!options[:include_parent_namespaces] ? route_setting(:declared_params) :
-              (route_setting(:saved_declared_params) || [])).flatten(1) || []
-        end
+      # Denotes a situation where a DSL method has been invoked in a
+      # filter which it should not yet be available in
+      class MethodNotYetAvailable < StandardError; end
 
-        unless declared_params
-          fail ArgumentError, 'Tried to filter for declared parameters but none exist.'
-        end
+      # @param type [Symbol] The type of filter for which evaluation has been
+      #   completed
+      # @return [Module] A module containing method overrides suitable for the
+      #   position in the filter evaluation sequence denoted by +type+.  This
+      #   defaults to an empty module if no overrides are defined for the given
+      #   filter +type+.
+      def self.post_filter_methods(type)
+        @post_filter_modules ||= { before: PostBeforeFilter }
+        @post_filter_modules[type]
+      end
 
-        if params.is_a? Array
-          params.map do |param|
-            declared(param || {}, options, declared_params)
-          end
-        else
-          declared_params.inject(Hashie::Mash.new) do |hash, key|
-            key = { key => nil } unless key.is_a? Hash
+      # Methods which should not be available in filters until the before filter
+      # has completed
+      module PostBeforeFilter
+        def declared(params, options = {}, declared_params = nil)
+          options = options.reverse_merge(include_missing: true, include_parent_namespaces: true)
 
-            key.each_pair do |parent, children|
-              output_key = options[:stringify] ? parent.to_s : parent.to_sym
+          declared_params ||= (!options[:include_parent_namespaces] ? route_setting(:declared_params) : (route_setting(:saved_declared_params) || [])).flatten(1) || []
 
-              next unless options[:include_missing] || params.key?(parent)
+          fail ArgumentError, 'Tried to filter for declared parameters but none exist.' unless declared_params
 
-              hash[output_key] = if children
-                                   children_params = params[parent] || (children.is_a?(Array) ? [] : {})
-                                   declared(children_params, options, Array(children))
-                                 else
-                                   params[parent]
-                                 end
+          if params.is_a? Array
+            params.map do |param|
+              declared(param || {}, options, declared_params)
             end
+          else
+            declared_params.each_with_object(Hashie::Mash.new) do |key, hash|
+              key = { key => nil } unless key.is_a? Hash
 
-            hash
+              key.each_pair do |parent, children|
+                output_key = options[:stringify] ? parent.to_s : parent.to_sym
+
+                next unless options[:include_missing] || params.key?(parent)
+
+                hash[output_key] = if children
+                                     children_params = params[parent] || (children.is_a?(Array) ? [] : {})
+                                     declared(children_params, options, Array(children))
+                                   else
+                                     params[parent]
+                                   end
+              end
+            end
           end
         end
       end
 
+      # A filtering method that will return a hash
+      # consisting only of keys that have been declared by a
+      # `params` statement against the current/target endpoint or parent
+      # namespaces.
+      #
+      # @see +PostBeforeFilter#declared+
+      #
+      # @param params [Hash] The initial hash to filter. Usually this will just be `params`
+      # @param options [Hash] Can pass `:include_missing`, `:stringify` and `:include_parent_namespaces`
+      # options. `:include_parent_namespaces` defaults to true, hence must be set to false if
+      # you want only to return params declared against the current/target endpoint.
+      def declared(*)
+        fail MethodNotYetAvailable, '#declared is not available prior to parameter validation.'
+      end
+
       # The API version as specified in the URL.
       def version
-        env['api.version']
+        env[Grape::Env::API_VERSION]
       end
 
       # End the request and display an error to the
@@ -74,19 +91,25 @@ module Grape
       # @param url [String] The url to be redirect.
       # @param options [Hash] The options used when redirect.
       #                       :permanent, default false.
+      #                       :body, default a short message including the URL.
       def redirect(url, options = {})
-        merged_options = { permanent: false }.merge(options)
-        if merged_options[:permanent]
+        permanent = options.fetch(:permanent, false)
+        body_message = options.fetch(:body, nil)
+        if permanent
           status 301
+          body_message ||= "This resource has been moved permanently to #{url}."
         else
           if env[Grape::Http::Headers::HTTP_VERSION] == 'HTTP/1.1' && request.request_method.to_s.upcase != Grape::Http::Headers::GET
             status 303
+            body_message ||= "An alternate resource is located at #{url}."
           else
             status 302
+            body_message ||= "This resource has been moved temporarily to #{url}."
           end
         end
         header 'Location', url
-        body ''
+        content_type 'text/plain'
+        body body_message
       end
 
       # Set or retrieve the HTTP status code.
@@ -241,7 +264,7 @@ module Grape
         if key
           representation = (@body || {}).merge(key => representation)
         elsif entity_class.present? && @body
-          fail ArgumentError, "Representation of type #{representation.class} cannot be merged." unless representation.respond_to?('merge')
+          fail ArgumentError, "Representation of type #{representation.class} cannot be merged." unless representation.respond_to?(:merge)
           representation = @body.merge(representation)
         end
 
@@ -257,7 +280,7 @@ module Grape
       #     route.route_description
       #   end
       def route
-        env['rack.routing_args'][:route_info]
+        env[Grape::Env::RACK_ROUTING_ARGS][:route_info]
       end
 
       # Attempt to locate the Entity class for a given object, if not given
@@ -293,7 +316,7 @@ module Grape
       #   the given entity_class.
       def entity_representation_for(entity_class, object, options)
         embeds = { env: env }
-        embeds[:version] = env['api.version'] if env['api.version']
+        embeds[:version] = env[Grape::Env::API_VERSION] if env[Grape::Env::API_VERSION]
         entity_class.represent(object, embeds.merge(options))
       end
     end