grape 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5959c55c9de8f187ba61237f85df40b8d5a350d
-  data.tar.gz: c9326028a122dd6c7f6574e5ebeabe5e64172b85
+  metadata.gz: a67815e028381f58318d1696015bc15108c15d17
+  data.tar.gz: 52eb9bc3836e2261415148134369dc1e847d8acc
 SHA512:
-  metadata.gz: 2bc47755123872f9aabab1b2a9a842a01a4fc085a7f04df490dca0f7e06ab9ce6739c921f1897c87d988181d91c705ace17408a6fa9bd0fa26e0cf7de18cc9c4
-  data.tar.gz: 54374eaadeb3a8ae9855381f7e87919c78aff99377caf00c025e15f37ee46468261990b686591331be8a34303233e6ea1fedcaab8c81f295491fae48e2cbf7df
+  metadata.gz: 65f9e5ba3c187e41e720bcdeb8727add1d53ba8f4ca68a70e122f87144bb31fc5d20a00583f9a54b41deb7d55a9fdfc9d27dcd26d91b2108e30a0ade4877b6ba
+  data.tar.gz: a35afb5adb3a6dc7a7cc356081d6e9bbb011e22010d388906d3a719722fff6cbdf6eb86697667695d80b6ca1ee2f045410ff214c363371e3fd569c82c51eb73b

data/Appraisals

@@ -14,3 +14,7 @@ end
 appraise 'rack-1.5.2' do
   gem 'rack', '1.5.2'
 end
+
+appraise 'rails-edge' do
+  gem 'arel', github: 'rails/arel'
+end

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 0.19.1 (1/9/2017)
+
+#### Features
+
+* [#1536](https://github.com/ruby-grape/grape/pull/1536): Updates `invalid_versioner_option` translation - [@Lavode](https://github.com/Lavode).
+* [#1543](https://github.com/ruby-grape/grape/pull/1543): Support ruby 2.4 - [@LeFnord](https://github.com/LeFnord), [@namusyaka](https://github.com/namusyaka).
+
+#### Fixes
+
+* [#1548](https://github.com/ruby-grape/grape/pull/1548): Avoid failing even if given path does not match with prefix - [@thomas-peyric](https://github.com/thomas-peyric), [@namusyaka](https://github.com/namusyaka).
+* [#1550](https://github.com/ruby-grape/grape/pull/1550): Use 200 as default status for deletes that reply with content - [@jthornec](https://github.com/jthornec).
+
 ### 0.19.0 (12/18/2016)
 
 #### Features
@@ -42,7 +54,6 @@
 * [#1398](https://github.com/ruby-grape/grape/pull/1398): Add `rescue_from :grape_exceptions` - allow Grape to use the built-in `Grape::Exception` handing and use `rescue :all` behavior for everything else - [@mmclead](https://github.com/mmclead).
 * [#1443](https://github.com/ruby-grape/grape/pull/1443): Extend `given` to receive a `Proc` - [@glaucocustodio](https://github.com/glaucocustodio).
 * [#1455](https://github.com/ruby-grape/grape/pull/1455): Add an automated PR linter - [@orta](https://github.com/orta).
-* Your contribution here.
 
 #### Fixes
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape (0.19.0)
+    grape (0.19.1)
       activesupport
       builder
       hashie (>= 2.1.0)

data/README.md

@@ -32,6 +32,7 @@
   - [Include Missing](#include-missing)
 - [Parameter Validation and Coercion](#parameter-validation-and-coercion)
   - [Supported Parameter Types](#supported-parameter-types)
+  - [Integer/Fixnum and Coercions](#integerfixnum-and-coercions)
   - [Custom Types and Coercions](#custom-types-and-coercions)
   - [Multipart File Parameters](#multipart-file-parameters)
   - [First-Class `JSON` Types](#first-class-json-types)
@@ -105,7 +106,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, 0.19.0.
+You're reading the documentation for the stable release of Grape, 0.19.1.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources
@@ -798,6 +799,28 @@ The following are all valid types, supported out of the box by Grape:
 * Rack::Multipart::UploadedFile (alias `File`)
 * JSON
 
+### Integer/Fixnum and Coercions
+
+Please be aware that the behavior differs between Ruby 2.4 and earlier versions.
+In Ruby 2.4, values consisting of numbers are converted to Integer, but in earlier versions it will be treated as Fixnum.
+
+```ruby
+params do
+  requires :integers, type: Hash do
+    requires :int, coerce: Integer
+  end
+end
+get '/int' do
+  params[:integers][:int].class
+end
+
+...
+
+get '/int' integers: { int: '45' }
+  #=> Integer in ruby 2.4
+  #=> Fixnum in earlier ruby versions
+```
+
 ### Custom Types and Coercions
 
 Aside from the default set of supported types listed above, any class can be
@@ -1740,7 +1763,7 @@ cookies.delete :status_count, path: '/'
 
 ## HTTP Status Code
 
-By default Grape returns a 201 for `POST`-Requests, 204 for `DELETE`-Requests and 200 status code for all other Requests.
+By default Grape returns a 201 for `POST`-Requests, 204 for `DELETE`-Requests that don't return any content, and 200 status code for all other Requests.
 You can use `status` to query and set the actual HTTP Status Code
 
 ```ruby
@@ -2183,6 +2206,14 @@ class API < Grape::API
 end
 ```
 
+To change the logger level.
+
+```ruby
+class API < Grape::API
+  self.logger.level = Logger::INFO
+end
+```
+
 You can also set your own logger.
 
 ```ruby
@@ -2877,7 +2908,7 @@ end
 The behaviour is then:
 
 ```bash
-GET /123        # 'Fixnum'
+GET /123        # 'Integer'
 GET /foo        # 400 error - 'blah is invalid'
 ```
 

data/RELEASING.md

@@ -36,8 +36,7 @@ You're reading the documentation for the stable release of Grape, 0.6.0.
 Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
 
 ```
-0.6.0 (9/16/2013)
-=================
+#### 0.6.0 (9/16/2013)
 ```
 
 Remove the line with "Your contribution here.", since there will be no more contributions to this release.
@@ -75,8 +74,7 @@ The current stable release is [0.6.0](https://github.com/ruby-grape/grape/blob/v
 Add the next release to [CHANGELOG.md](CHANGELOG.md).
 
 ```
-Next Release
-============
+#### 0.6.1 (Next)
 
 * Your contribution here.
 ```
@@ -89,7 +87,7 @@ module Grape
 end
 ```
 
-Comit your changes.
+Commit your changes.
 
 ```
 git add CHANGELOG.md README.md lib/grape/version.rb

data/UPGRADING.md

@@ -1,6 +1,38 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.19.1 (next)
+
+#### DELETE now defaults to status code 200 for responses with a body, or 204 otherwise
+
+Prior to this version, DELETE requests defaulted to a status code of 204 No Content, even when the response included content. This behavior confused some clients and prevented the formatter middleware from running properly. As of this version, DELETE requests will only default to a 204 No Content status code if no response body is provided, and will default to 200 OK otherwise.
+
+Specifically, DELETE behaviour has changed as follows:
+
+- In versions < 0.19.0, all DELETE requests defaulted to a 200 OK status code.
+- In version 0.19.0, all DELETE requests defaulted to a 204 No Content status code, even when content was included in the response.
+- As of version 0.19.1, DELETE requests default to a 204 No Content status code, unless content is supplied, in which case they default to a 200 OK status code.
+
+To achieve the old behavior, one can specify the status code explicitly:
+
+```ruby
+delete :id do
+  status 204 # or 200, for < 0.19.0 behavior
+  'foo successfully deleted'
+end
+```
+
+One can also use the new `return_no_content` helper to explicitly return a 204 status code and an empty body for any request type:
+
+```ruby
+delete :id do
+  return_no_content
+  'this will not be returned'
+end
+```
+
+See [#1550](https://github.com/ruby-grape/grape/pull/1550) for more information.
+
 ### Upgrading to >= 0.18.1
 
 #### Changes in priority of :any routes

data/gemfiles/rails_edge.gemfile

@@ -2,12 +2,12 @@
 
 source 'https://rubygems.org'
 
-gem 'rails', github: 'rails/rails'
+gem 'arel', github: 'rails/arel'
 
 group :development, :test do
   gem 'bundler'
   gem 'rake'
-  gem 'rubocop', '~> 0.45.0'
+  gem 'rubocop', '~> 0.45'
 end
 
 group :development do

data/lib/grape/dsl/inside_route.rb

@@ -122,7 +122,7 @@ module Grape
         when Symbol
           raise ArgumentError, "Status code :#{status} is invalid." unless Rack::Utils::SYMBOL_TO_STATUS_CODE.keys.include?(status)
           @status = Rack::Utils.status_code(status)
-        when Fixnum
+        when Integer
           @status = status
         when nil
           return @status if @status
@@ -130,12 +130,16 @@ module Grape
           when Grape::Http::Headers::POST
             201
           when Grape::Http::Headers::DELETE
-            204
+            if @body.present?
+              200
+            else
+              204
+            end
           else
             200
           end
         else
-          raise ArgumentError, 'Status code must be Fixnum or Symbol.'
+          raise ArgumentError, 'Status code must be Integer or Symbol.'
         end
       end
 
@@ -181,6 +185,20 @@ module Grape
         end
       end
 
+      # Allows you to explicitly return no content.
+      #
+      # @example
+      #   delete :id do
+      #     return_no_content
+      #     "not returned"
+      #   end
+      #
+      #   DELETE /12 # => 204 No Content, ""
+      def return_no_content
+        status 204
+        body false
+      end
+
       # Allows you to define the response as a file-like object.
       #
       # @example

data/lib/grape/locale/en.yml

@@ -26,7 +26,7 @@ en:
         invalid_formatter: 'cannot convert %{klass} to %{to_format}'
         invalid_versioner_option:
           problem: 'Unknown :using for versioner: %{strategy}'
-          resolution: 'available strategy for :using is :path, :header, :param'
+          resolution: 'available strategy for :using is :path, :header, :accept_version_header, :param'
         unknown_validator: 'unknown validator: %{validator_type}'
         unknown_options: 'unknown options: %{options}'
         unknown_parameter: 'unknown parameter: %{param}'

data/lib/grape/middleware/versioner/path.rb

@@ -26,7 +26,7 @@ module Grape
         def before
           path = env[Grape::Http::Headers::PATH_INFO].dup
 
-          if prefix && path.index(prefix).zero?
+          if prefix && path.index(prefix) == 0 # rubocop:disable all
             path.sub!(prefix, '')
             path = Grape::Router.normalize_path(path)
           end

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '0.19.0'.freeze
+  VERSION = '0.19.1'.freeze
 end

data/spec/grape/api_spec.rb

@@ -925,7 +925,7 @@ XML
       end
 
       get '/', id: '32'
-      expect(last_response.body).to eql 'first 32:Fixnum second'
+      expect(last_response.body).to eql "first 32:#{integer_class_name} second"
     end
 
     it 'adds a after filter' do
@@ -2506,7 +2506,7 @@ XML
       end
     end
     describe 'status' do
-      it 'can be set to arbitrary Fixnum value' do
+      it 'can be set to arbitrary Integer value' do
         subject.get '/foo' do
           status 210
         end

data/spec/grape/dsl/inside_route_spec.rb

@@ -111,6 +111,13 @@ describe Grape::Endpoint do
       expect(subject.status).to eq 204
     end
 
+    it 'defaults to 200 on DELETE with a body present' do
+      request = Grape::Request.new(Rack::MockRequest.env_for('/', method: 'DELETE'))
+      subject.body 'content here'
+      expect(subject).to receive(:request).and_return(request)
+      expect(subject.status).to eq 200
+    end
+
     it 'returns status set' do
       subject.status 501
       expect(subject.status).to eq 501
@@ -126,13 +133,21 @@ describe Grape::Endpoint do
         .to raise_error(ArgumentError, 'Status code :foo_bar is invalid.')
     end
 
-    it 'accepts unknown Fixnum status codes' do
+    it 'accepts unknown Integer status codes' do
       expect { subject.status 210 }.to_not raise_error
     end
 
-    it 'raises error if status is not a fixnum or symbol' do
+    it 'raises error if status is not a integer or symbol' do
       expect { subject.status Object.new }
-        .to raise_error(ArgumentError, 'Status code must be Fixnum or Symbol.')
+        .to raise_error(ArgumentError, 'Status code must be Integer or Symbol.')
+    end
+  end
+
+  describe '#return_no_content' do
+    it 'sets the status code and body' do
+      subject.return_no_content
+      expect(subject.status).to eq 204
+      expect(subject.body).to eq ''
     end
   end
 

data/spec/grape/dsl/request_response_spec.rb

@@ -131,7 +131,7 @@ module Grape
           end
 
           it 'abort if :with option value is not Symbol, String or Proc' do
-            expect { subject.rescue_from :all, with: 1234 }.to raise_error(ArgumentError, 'with: Fixnum, expected Symbol, String or Proc')
+            expect { subject.rescue_from :all, with: 1234 }.to raise_error(ArgumentError, "with: #{integer_class_name}, expected Symbol, String or Proc")
           end
 
           it 'abort if both :with option and block are passed' do

data/spec/grape/middleware/versioner/path_spec.rb

@@ -41,4 +41,11 @@ describe Grape::Middleware::Versioner::Path do
       end
     end
   end
+
+  context 'with prefix, but requested version is not matched' do
+    let(:options) { { prefix: '/v1', pattern: /v./i } }
+    it 'recognizes potential version' do
+      expect(subject.call('PATH_INFO' => '/v3/foo').last).to eq('v3')
+    end
+  end
 end

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

@@ -57,9 +57,9 @@ describe Grape::Validations::AllowBlankValidator do
         get '/allow_float_blank'
 
         params do
-          requires :val, type: Fixnum, allow_blank: true
+          requires :val, type: Integer, allow_blank: true
         end
-        get '/allow_fixnum_blank'
+        get '/allow_integer_blank'
 
         params do
           requires :val, type: Symbol, allow_blank: true
@@ -173,9 +173,9 @@ describe Grape::Validations::AllowBlankValidator do
           get '/allow_float_blank'
 
           params do
-            requires :val, type: Fixnum, allow_blank: true
+            requires :val, type: Integer, allow_blank: true
           end
-          get '/allow_fixnum_blank'
+          get '/allow_integer_blank'
 
           params do
             requires :val, type: Symbol, allow_blank: true
@@ -345,8 +345,8 @@ describe Grape::Validations::AllowBlankValidator do
           expect(last_response.status).to eq(200)
         end
 
-        it 'accepts empty when fixnum allow_blank' do
-          get '/custom_message/allow_fixnum_blank', val: ''
+        it 'accepts empty when integer allow_blank' do
+          get '/custom_message/allow_integer_blank', val: ''
           expect(last_response.status).to eq(200)
         end
       end
@@ -483,8 +483,8 @@ describe Grape::Validations::AllowBlankValidator do
         expect(last_response.status).to eq(200)
       end
 
-      it 'accepts empty when fixnum allow_blank' do
-        get '/allow_fixnum_blank', val: ''
+      it 'accepts empty when integer allow_blank' do
+        get '/allow_integer_blank', val: ''
         expect(last_response.status).to eq(200)
       end
     end

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

@@ -175,7 +175,7 @@ describe Grape::Validations::CoerceValidator do
 
         get '/int', int: '45'
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq('Fixnum')
+        expect(last_response.body).to eq(integer_class_name)
       end
 
       context 'Array' do
@@ -189,7 +189,7 @@ describe Grape::Validations::CoerceValidator do
 
           get '/array', arry: %w(1 2 3)
           expect(last_response.status).to eq(200)
-          expect(last_response.body).to eq('Fixnum')
+          expect(last_response.body).to eq(integer_class_name)
         end
 
         it 'Array of Bools' do
@@ -238,7 +238,7 @@ describe Grape::Validations::CoerceValidator do
 
           get '/set', set: Set.new([1, 2, 3, 4]).to_a
           expect(last_response.status).to eq(200)
-          expect(last_response.body).to eq('Fixnum')
+          expect(last_response.body).to eq(integer_class_name)
         end
 
         it 'Set of Bools' do
@@ -326,7 +326,7 @@ describe Grape::Validations::CoerceValidator do
 
         get '/int', integers: { int: '45' }
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq('Fixnum')
+        expect(last_response.body).to eq(integer_class_name)
       end
     end
 
@@ -525,11 +525,11 @@ describe Grape::Validations::CoerceValidator do
 
         get '/', splines: '{"x":"1","y":"woof"}'
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq('Fixnum.String')
+        expect(last_response.body).to eq("#{integer_class_name}.String")
 
         get '/', splines: '[{"x":1,"y":2},{"x":1,"y":"quack"}]'
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq('Fixnum.Fixnum')
+        expect(last_response.body).to eq("#{integer_class_name}.#{integer_class_name}")
 
         get '/', splines: '{"x":"4","y":"woof"}'
         expect(last_response.status).to eq(400)
@@ -576,7 +576,7 @@ describe Grape::Validations::CoerceValidator do
 
         get '/', a: '5'
         expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq('Fixnum')
+        expect(last_response.body).to eq(integer_class_name)
 
         get '/', a: 'anything else'
         expect(last_response.status).to eq(200)

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@ I18n.enforce_available_locales = false
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods
+  config.include Spec::Support::Helpers
   config.raise_errors_for_deprecations!
 
   config.before(:each) { Grape::Util::InheritableSetting.reset_global! }

data/spec/support/basic_auth_encode_helpers.rb

@@ -1,3 +1,9 @@
-def encode_basic_auth(username, password)
-  'Basic ' + Base64.encode64("#{username}:#{password}")
+module Spec
+  module Support
+    module Helpers
+      def encode_basic_auth(username, password)
+        'Basic ' + Base64.encode64("#{username}:#{password}")
+      end
+    end
+  end
 end

data/spec/support/content_type_helpers.rb

@@ -1,11 +1,13 @@
-module ContentTypeHelpers
-  %w(put patch post delete).each do |method|
-    define_method :"#{method}_with_json" do |uri, params = {}, env = {}, &block|
-      params = params.to_json
-      env['CONTENT_TYPE'] ||= 'application/json'
-      send(method, uri, params, env, &block)
+module Spec
+  module Support
+    module Helpers
+      %w(put patch post delete).each do |method|
+        define_method :"#{method}_with_json" do |uri, params = {}, env = {}, &block|
+          params = params.to_json
+          env['CONTENT_TYPE'] ||= 'application/json'
+          send(method, uri, params, env, &block)
+        end
+      end
     end
   end
 end
-
-include(ContentTypeHelpers)

data/spec/support/integer_helpers.rb

@@ -0,0 +1,11 @@
+module Spec
+  module Support
+    module Helpers
+      INTEGER_CLASS_NAME = 0.to_i.class.to_s.freeze
+
+      def integer_class_name
+        INTEGER_CLASS_NAME
+      end
+    end
+  end
+end

data/spec/support/versioned_helpers.rb

@@ -1,50 +1,55 @@
 # Versioning
+module Spec
+  module Support
+    module Helpers
+      # Returns the path with options[:version] prefixed if options[:using] is :path.
+      # Returns normal path otherwise.
+      def versioned_path(options = {})
+        case options[:using]
+        when :path
+          File.join('/', options[:prefix] || '', options[:version], options[:path])
+        when :param
+          File.join('/', options[:prefix] || '', options[:path])
+        when :header
+          File.join('/', options[:prefix] || '', options[:path])
+        when :accept_version_header
+          File.join('/', options[:prefix] || '', options[:path])
+        else
+          raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
+        end
+      end
 
-# Returns the path with options[:version] prefixed if options[:using] is :path.
-# Returns normal path otherwise.
-def versioned_path(options = {})
-  case options[:using]
-  when :path
-    File.join('/', options[:prefix] || '', options[:version], options[:path])
-  when :param
-    File.join('/', options[:prefix] || '', options[:path])
-  when :header
-    File.join('/', options[:prefix] || '', options[:path])
-  when :accept_version_header
-    File.join('/', options[:prefix] || '', options[:path])
-  else
-    raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
-  end
-end
-
-def versioned_headers(options)
-  case options[:using]
-  when :path
-    {}  # no-op
-  when :param
-    {}  # no-op
-  when :header
-    {
-      'HTTP_ACCEPT' => [
-        "application/vnd.#{options[:vendor]}-#{options[:version]}",
-        options[:format]
-      ].compact.join('+')
-    }
-  when :accept_version_header
-    {
-      'HTTP_ACCEPT_VERSION' => options[:version].to_s
-    }
-  else
-    raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
-  end
-end
+      def versioned_headers(options)
+        case options[:using]
+        when :path
+          {}  # no-op
+        when :param
+          {}  # no-op
+        when :header
+          {
+            'HTTP_ACCEPT' => [
+              "application/vnd.#{options[:vendor]}-#{options[:version]}",
+              options[:format]
+            ].compact.join('+')
+          }
+        when :accept_version_header
+          {
+            'HTTP_ACCEPT_VERSION' => options[:version].to_s
+          }
+        else
+          raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
+        end
+      end
 
-def versioned_get(path, version_name, version_options = {})
-  path    = versioned_path(version_options.merge(version: version_name, path: path))
-  headers = versioned_headers(version_options.merge(version: version_name))
-  params = {}
-  if version_options[:using] == :param
-    params = { version_options[:parameter] => version_name }
+      def versioned_get(path, version_name, version_options = {})
+        path    = versioned_path(version_options.merge(version: version_name, path: path))
+        headers = versioned_headers(version_options.merge(version: version_name))
+        params = {}
+        if version_options[:using] == :param
+          params = { version_options[:parameter] => version_name }
+        end
+        get path, params, headers
+      end
+    end
   end
-  get path, params, headers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -277,7 +277,6 @@ files:
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
-- pkg/grape-0.17.0.gem
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/invalid_format_spec.rb
@@ -364,6 +363,7 @@ files:
 - spec/support/content_type_helpers.rb
 - spec/support/endpoint_faker.rb
 - spec/support/file_streamer.rb
+- spec/support/integer_helpers.rb
 - spec/support/versioned_helpers.rb
 homepage: https://github.com/ruby-grape/grape
 licenses:
@@ -476,4 +476,5 @@ test_files:
 - spec/support/content_type_helpers.rb
 - spec/support/endpoint_faker.rb
 - spec/support/file_streamer.rb
+- spec/support/integer_helpers.rb
 - spec/support/versioned_helpers.rb