grape 0.11.0 → 0.12.0

data/lib/grape/validations/validators/regexp.rb

@@ -3,7 +3,7 @@ module Grape
     class RegexpValidator < Base
       def validate_param!(attr_name, params)
         if params.key?(attr_name) &&
-           (params[attr_name].nil? || !(params[attr_name].to_s =~ @option))
+           !params[attr_name].nil? && !(params[attr_name].to_s =~ @option)
           fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :regexp
         end
       end

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/spec/grape/api/custom_validations_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Grape::Validations do
+  before do
+    class DefaultLength < Grape::Validations::Base
+      def validate_param!(attr_name, params)
+        @option = params[:max].to_i if params.key?(:max)
+        unless params[attr_name].length <= @option
+          fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
+        end
+      end
+    end
+  end
+
+  subject do
+    Class.new(Grape::API) do
+      params do
+        requires :text, default_length: 140
+      end
+      get do
+        'bacon'
+      end
+    end
+  end
+
+  def app
+    subject
+  end
+
+  context 'using a custom length validator' do
+    it 'under 140 characters' do
+      get '/', text: 'abc'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'bacon'
+    end
+    it 'over 140 characters' do
+      get '/', text: 'a' * 141
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq 'text must be at the most 140 characters long'
+    end
+    it 'specified in the query string' do
+      get '/', text: 'a' * 141, max: 141
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'bacon'
+    end
+  end
+end

data/spec/grape/api/deeply_included_options_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module API
+  module Defaults
+    extend ActiveSupport::Concern
+    included do
+      format :json
+    end
+  end
+
+  module Admin
+    module Defaults
+      extend ActiveSupport::Concern
+      include API::Defaults
+    end
+
+    class Users < Grape::API
+      include API::Admin::Defaults
+
+      resource :users do
+        get do
+          status 200
+        end
+      end
+    end
+  end
+end
+
+class Main < Grape::API
+  mount API::Admin::Users
+end
+
+describe Grape::API do
+  subject { Main }
+
+  def app
+    subject
+  end
+
+  it 'works for unspecified format' do
+    get '/users'
+    expect(last_response.status).to eql 200
+    expect(last_response.content_type).to eql 'application/json'
+  end
+
+  it 'works for specified format' do
+    get '/users.json'
+    expect(last_response.status).to eql 200
+    expect(last_response.content_type).to eql 'application/json'
+  end
+
+  it "doesn't work for format different than specified" do
+    get '/users.txt'
+    expect(last_response.status).to eql 404
+  end
+end

data/spec/grape/api_spec.rb

@@ -278,7 +278,7 @@ describe Grape::API do
       before do
         subject.format :txt
         subject.content_type :json, 'application/json'
-        subject.formatter :json, ->(object, env) { object }
+        subject.formatter :json, ->(object, _env) { object }
         def subject.enable_root_route!
           get('/') { 'root' }
         end
@@ -419,7 +419,7 @@ describe Grape::API do
             send verb, '/', MultiJson.dump(object), 'CONTENT_TYPE' => 'application/json'
             expect(last_response.status).to eq(verb == :post ? 201 : 200)
             expect(last_response.body).to eql MultiJson.dump(object)
-            expect(last_request.params).to eql Hash.new
+            expect(last_request.params).to eql({})
           end
           it 'stores input in api.request.input' do
             subject.format :json
@@ -804,7 +804,8 @@ describe Grape::API do
     it 'sets content type for json error' do
       subject.format :json
       subject.get('/error') { error!('error in json', 500) }
-      get '/error'
+      get '/error.json'
+      expect(last_response.status).to eql 500
       expect(last_response.headers['Content-Type']).to eql 'application/json'
     end
 
@@ -812,13 +813,14 @@ describe Grape::API do
       subject.format :xml
       subject.get('/error') { error!('error in xml', 500) }
       get '/error'
+      expect(last_response.status).to eql 500
       expect(last_response.headers['Content-Type']).to eql 'application/xml'
     end
 
     context 'with a custom content_type' do
       before do
         subject.content_type :custom, 'application/custom'
-        subject.formatter :custom, ->(object, env) { 'custom' }
+        subject.formatter :custom, ->(_object, _env) { 'custom' }
 
         subject.get('/custom') { 'bar' }
         subject.get('/error') { error!('error in custom', 500) }
@@ -984,7 +986,7 @@ describe Grape::API do
   end
   describe '.http_basic' do
     it 'protects any resources on the same scope' do
-      subject.http_basic do |u, p|
+      subject.http_basic do |u, _p|
         u == 'allow'
       end
       subject.get(:hello) { 'Hello, world.' }
@@ -997,7 +999,7 @@ describe Grape::API do
     it 'is scopable' do
       subject.get(:hello) { 'Hello, world.' }
       subject.namespace :admin do
-        http_basic do |u, p|
+        http_basic do |u, _p|
           u == 'allow'
         end
 
@@ -1011,7 +1013,7 @@ describe Grape::API do
     end
 
     it 'is callable via .auth as well' do
-      subject.auth :http_basic do |u, p|
+      subject.auth :http_basic do |u, _p|
         u == 'allow'
       end
 
@@ -1025,7 +1027,7 @@ describe Grape::API do
     it 'has access to the current endpoint' do
       basic_auth_context = nil
 
-      subject.http_basic do |u, p|
+      subject.http_basic do |u, _p|
         basic_auth_context = self
 
         u == 'allow'
@@ -1055,7 +1057,7 @@ describe Grape::API do
     end
 
     it 'can set instance variables accessible to routes' do
-      subject.http_basic do |u, p|
+      subject.http_basic do |u, _p|
         @hello = 'Hello, world.'
 
         u == 'allow'
@@ -1304,7 +1306,7 @@ describe Grape::API do
       allow(formatter).to receive(:call) { fail StandardError }
       allow(Grape::Formatter::Base).to receive(:formatter_for) { formatter }
 
-      subject.rescue_from :all do |e|
+      subject.rescue_from :all do |_e|
         rack_response('Formatter Error', 500)
       end
       subject.get('/formatter_exception') { 'Hello world' }
@@ -1540,7 +1542,7 @@ describe Grape::API do
     context 'class' do
       before :each do
         class CustomErrorFormatter
-          def self.call(message, backtrace, options, env)
+          def self.call(message, _backtrace, _options, _env)
             "message: #{message} @backtrace"
           end
         end
@@ -1560,7 +1562,7 @@ describe Grape::API do
       context 'class' do
         before :each do
           class CustomErrorFormatter
-            def self.call(message, backtrace, option, env)
+            def self.call(message, _backtrace, _option, _env)
               "message: #{message} @backtrace"
             end
           end
@@ -1646,8 +1648,8 @@ describe Grape::API do
   describe '.formatter' do
     context 'multiple formatters' do
       before :each do
-        subject.formatter :json, ->(object, env) { "{\"custom_formatter\":\"#{object[:some] }\"}" }
-        subject.formatter :txt, ->(object, env) { "custom_formatter: #{object[:some] }" }
+        subject.formatter :json, ->(object, _env) { "{\"custom_formatter\":\"#{object[:some] }\"}" }
+        subject.formatter :txt, ->(object, _env) { "custom_formatter: #{object[:some] }" }
         subject.get :simple do
           { some: 'hash' }
         end
@@ -1665,7 +1667,7 @@ describe Grape::API do
       before :each do
         subject.content_type :json, 'application/json'
         subject.content_type :custom, 'application/custom'
-        subject.formatter :custom, ->(object, env) { "{\"custom_formatter\":\"#{object[:some] }\"}" }
+        subject.formatter :custom, ->(object, _env) { "{\"custom_formatter\":\"#{object[:some] }\"}" }
         subject.get :simple do
           { some: 'hash' }
         end
@@ -1681,7 +1683,7 @@ describe Grape::API do
     end
     context 'custom formatter class' do
       module CustomFormatter
-        def self.call(object, env)
+        def self.call(object, _env)
           "{\"custom_formatter\":\"#{object[:some] }\"}"
         end
       end
@@ -1718,7 +1720,7 @@ describe Grape::API do
       before :each do
         subject.content_type :txt, 'text/plain'
         subject.content_type :custom, 'text/custom'
-        subject.parser :custom, ->(object, env) { { object.to_sym => object.to_s.reverse } }
+        subject.parser :custom, ->(object, _env) { { object.to_sym => object.to_s.reverse } }
         subject.put :simple do
           params[:simple]
         end
@@ -1733,7 +1735,7 @@ describe Grape::API do
     end
     context 'custom parser class' do
       module CustomParser
-        def self.call(object, env)
+        def self.call(object, _env)
           { object.to_sym => object.to_s.reverse }
         end
       end
@@ -2031,6 +2033,22 @@ describe Grape::API do
         expect(route.route_settings[:custom]).to eq(key: 'value')
       end
     end
+    describe 'status' do
+      it 'can be set to arbitrary Fixnum value' do
+        subject.get '/foo' do
+          status 210
+        end
+        get '/foo'
+        expect(last_response.status).to eq 210
+      end
+      it 'can be set with a status code symbol' do
+        subject.get '/foo' do
+          status :see_other
+        end
+        get '/foo'
+        expect(last_response.status).to eq 303
+      end
+    end
   end
 
   context 'desc' do
@@ -2043,7 +2061,7 @@ describe Grape::API do
     end
     it 'describes a method' do
       subject.desc 'first method'
-      subject.get :first do ; end
+      subject.get :first do; end
       expect(subject.routes.length).to eq(1)
       route = subject.routes.first
       expect(route.route_description).to eq('first method')
@@ -2052,47 +2070,47 @@ describe Grape::API do
     end
     it 'describes methods separately' do
       subject.desc 'first method'
-      subject.get :first do ; end
+      subject.get :first do; end
       subject.desc 'second method'
-      subject.get :second do ; end
+      subject.get :second do; end
       expect(subject.routes.count).to eq(2)
       expect(subject.routes.map { |route|
         { description: route.route_description, params: route.route_params }
       }).to eq [
         { description: 'first method', params: {} },
         { description: 'second method', params: {} }
-    ]
+      ]
     end
     it 'resets desc' do
       subject.desc 'first method'
-      subject.get :first do ; end
-      subject.get :second do ; end
+      subject.get :first do; end
+      subject.get :second do; end
       expect(subject.routes.map { |route|
         { description: route.route_description, params: route.route_params }
       }).to eq [
         { description: 'first method', params: {} },
         { description: nil, params: {} }
-    ]
+      ]
     end
     it 'namespaces and describe arbitrary parameters' do
       subject.namespace 'ns' do
         desc 'ns second', foo: 'bar'
-        get 'second' do ; end
+        get 'second' do; end
       end
       expect(subject.routes.map { |route|
         { description: route.route_description, foo: route.route_foo, params: route.route_params }
       }).to eq [
         { description: 'ns second', foo: 'bar', params: {} }
-    ]
+      ]
     end
     it 'includes details' do
       subject.desc 'method', details: 'method details'
-      subject.get 'method' do ; end
+      subject.get 'method' do; end
       expect(subject.routes.map { |route|
         { description: route.route_description, details: route.route_details, params: route.route_params }
       }).to eq [
         { description: 'method', details: 'method details', params: {} }
-    ]
+      ]
     end
     it 'describes a method with parameters' do
       subject.desc 'Reverses a string.', params: { 's' => { desc: 'string to reverse', type: 'string' } }
@@ -2103,7 +2121,7 @@ describe Grape::API do
         { description: route.route_description, params: route.route_params }
       }).to eq [
         { description: 'Reverses a string.', params: { 's' => { desc: 'string to reverse', type: 'string' } } }
-    ]
+      ]
     end
     it 'merges the parameters of the namespace with the parameters of the method' do
       subject.desc 'namespace'
@@ -2115,7 +2133,7 @@ describe Grape::API do
         params do
           optional :method_param, desc: 'method parameter'
         end
-        get 'method' do ; end
+        get 'method' do; end
       end
 
       routes_doc = subject.routes.map { |route|
@@ -2128,7 +2146,7 @@ describe Grape::API do
             'method_param' => { required: false, desc: 'method parameter' }
           }
         }
-    ]
+      ]
     end
     it 'merges the parameters of nested namespaces' do
       subject.desc 'ns1'
@@ -2147,7 +2165,7 @@ describe Grape::API do
           params do
             optional :method_param, desc: 'method param'
           end
-          get 'method' do ; end
+          get 'method' do; end
         end
       end
       expect(subject.routes.map { |route|
@@ -2161,7 +2179,7 @@ describe Grape::API do
             'method_param' => { required: false, desc: 'method param' }
           }
         }
-    ]
+      ]
     end
     it 'groups nested params and prevents overwriting of params with same name in different groups' do
       subject.desc 'method'
@@ -2175,7 +2193,7 @@ describe Grape::API do
           requires :param2, desc: 'group2 param2 desc'
         end
       end
-      subject.get 'method' do ; end
+      subject.get 'method' do; end
 
       expect(subject.routes.map(&:route_params)).to eq [{
         'group1'         => { required: true, type: 'Array' },
@@ -2194,7 +2212,7 @@ describe Grape::API do
           requires :nested_param, desc: 'nested param'
         end
       end
-      subject.get 'method' do ; end
+      subject.get 'method' do; end
       expect(subject.routes.map { |route|
         { description: route.route_description, params: route.route_params }
       }).to eq [
@@ -2205,7 +2223,7 @@ describe Grape::API do
             'nested[nested_param]' => { required: true, desc: 'nested param' }
           }
         }
-    ]
+      ]
     end
     it 'allows to set the type attribute on :group element' do
       subject.params do
@@ -2218,12 +2236,12 @@ describe Grape::API do
       subject.params do
         requires :one_param, desc: 'one param'
       end
-      subject.get 'method' do ; end
+      subject.get 'method' do; end
       expect(subject.routes.map { |route|
         { description: route.route_description, params: route.route_params }
       }).to eq [
         { description: nil, params: { 'one_param' => { required: true, desc: 'one param' } } }
-    ]
+      ]
     end
     it 'does not symbolize params' do
       subject.desc 'Reverses a string.', params: { 's' => { desc: 'string to reverse', type: 'string' } }
@@ -2234,12 +2252,12 @@ describe Grape::API do
         { description: route.route_description, params: route.route_params }
       }).to eq [
         { description: 'Reverses a string.', params: { 's' => { desc: 'string to reverse', type: 'string' } } }
-    ]
+      ]
     end
   end
 
   describe '.mount' do
-    let(:mounted_app) { ->(env) { [200, {}, ['MOUNTED']] } }
+    let(:mounted_app) { ->(_env) { [200, {}, ['MOUNTED']] } }
 
     context 'with a bare rack app' do
       before do
@@ -2626,7 +2644,11 @@ describe Grape::API do
         get '/meaning_of_life'
         expect(last_response.body).to eq({ meaning_of_life: 42 }.to_s)
       end
-      it 'does not accept any extensions' do
+      it 'accepts specified extension' do
+        get '/meaning_of_life.txt'
+        expect(last_response.body).to eq({ meaning_of_life: 42 }.to_s)
+      end
+      it 'does not accept extensions other than specified' do
         get '/meaning_of_life.json'
         expect(last_response.status).to eq(404)
       end