grape 1.5.2 → 1.7.0

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Instance do
   describe 'boolean constant' do
     module DefinesBooleanInstanceSpec
@@ -31,8 +29,9 @@ describe Grape::API::Instance do
 
     context 'Params endpoint type' do
       subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
+
       it 'params type is a boolean' do
-        is_expected.to eq 'Grape::API::Boolean'
+        expect(subject).to eq 'Grape::API::Boolean'
       end
     end
   end

data/spec/grape/api/documentation_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::API do
+  subject { Class.new(described_class) }
+
+  let(:app) { subject }
+
+  context 'an endpoint with documentation' do
+    it 'documents parameters' do
+      subject.params do
+        requires 'price', type: Float, desc: 'Sales price'
+      end
+      subject.get '/'
+
+      expect(subject.routes.first.params['price']).to eq(required: true,
+                                                         type: 'Float',
+                                                         desc: 'Sales price')
+    end
+
+    it 'allows documentation with a hash' do
+      documentation = { example: 'Joe' }
+
+      subject.params do
+        requires 'first_name', documentation: documentation
+      end
+      subject.get '/'
+
+      expect(subject.routes.first.params['first_name'][:documentation]).to eq(documentation)
+    end
+  end
+
+  context 'an endpoint without documentation' do
+    before do
+      subject.do_not_document!
+
+      subject.params do
+        requires :city, type: String, desc: 'Should be ignored'
+        optional :postal_code, type: Integer
+      end
+      subject.post '/' do
+        declared(params).to_json
+      end
+    end
+
+    it 'does not document parameters for the endpoint' do
+      expect(subject.routes.first.params).to eq({})
+    end
+
+    it 'still declares params internally' do
+      data = { city: 'Berlin', postal_code: 10_115 }
+
+      post '/', data
+
+      expect(last_response.body).to eq(data.to_json)
+    end
+  end
+end

data/spec/grape/api/inherited_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   let(:user) { 'Miguel Caneo' }
   let(:id)   { '42' }

data/spec/grape/api/instance_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API::Instance do

data/spec/grape/api/invalid_format_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 
@@ -31,11 +29,13 @@ describe Grape::Endpoint do
       expect(last_response.status).to eq 200
       expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: nil))
     end
+
     it 'json format' do
       get '/foo.json'
       expect(last_response.status).to eq 200
       expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: 'json'))
     end
+
     it 'invalid format' do
       get '/foo.invalid'
       expect(last_response.status).to eq 200

data/spec/grape/api/namespace_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/nested_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   module NestedHelpersSpec
     module HelperMethods

data/spec/grape/api/optional_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/parameters_modification_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/patch_method_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   module PatchHelpersSpec
     class PatchPublic < Grape::API

data/spec/grape/api/recognize_path_spec.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API do
   describe '.recognize_path' do
-    subject { Class.new(Grape::API) }
+    subject { Class.new(described_class) }
 
     it 'fetches endpoint by given path' do
       subject.get('/foo/:id') {}

data/spec/grape/api/required_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/required_parameters_with_invalid_method_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 
@@ -11,7 +9,7 @@ describe Grape::Endpoint do
 
   context 'get' do
     it 'routes to a namespace param with dots' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
         get '/' do
           params[:ns_with_dots]
         end
@@ -23,8 +21,8 @@ describe Grape::Endpoint do
     end
 
     it 'routes to a path with multiple params with dots' do
-      subject.get ':id_with_dots/:another_id_with_dots', requirements: { id_with_dots: %r{[^\/]+},
-                                                                         another_id_with_dots: %r{[^\/]+} } do
+      subject.get ':id_with_dots/:another_id_with_dots', requirements: { id_with_dots: %r{[^/]+},
+                                                                         another_id_with_dots: %r{[^/]+} } do
         "#{params[:id_with_dots]}/#{params[:another_id_with_dots]}"
       end
 
@@ -34,9 +32,9 @@ describe Grape::Endpoint do
     end
 
     it 'routes to namespace and path params with dots, with overridden requirements' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
-        get ':another_id_with_dots',     requirements: { ns_with_dots: %r{[^\/]+},
-                                                         another_id_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get ':another_id_with_dots',     requirements: { ns_with_dots: %r{[^/]+},
+                                                         another_id_with_dots: %r{[^/]+} } do
           "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
         end
       end
@@ -47,8 +45,8 @@ describe Grape::Endpoint do
     end
 
     it 'routes to namespace and path params with dots, with merged requirements' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
-        get ':another_id_with_dots',     requirements: { another_id_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get ':another_id_with_dots',     requirements: { another_id_with_dots: %r{[^/]+} } do
           "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
         end
       end

data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
-  subject do
-    shared_params = Module.new do
-      extend Grape::API::Helpers
+  let(:app) do
+    Class.new(Grape::API) do
+      helpers Module.new do
+        extend Grape::API::Helpers
 
-      params :drink do
-        optional :beer
-        optional :wine
-        exactly_one_of :beer, :wine
+        params :drink do
+          optional :beer
+          optional :wine
+          exactly_one_of :beer, :wine
+        end
       end
-    end
-
-    Class.new(Grape::API) do
-      helpers shared_params
       format :json
 
       params do
@@ -35,10 +31,6 @@ describe Grape::API::Helpers do
     end
   end
 
-  def app
-    subject
-  end
-
   it 'defines parameters' do
     get '/', orderType: 'food', pizza: 'mista'
     expect(last_response.status).to eq 200

data/spec/grape/api/shared_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   subject do
     shared_params = Module.new do

data/spec/grape/api_remount_spec.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API do
-  subject(:a_remounted_api) { Class.new(Grape::API) }
-  let(:root_api) { Class.new(Grape::API) }
+  subject(:a_remounted_api) { Class.new(described_class) }
+
+  let(:root_api) { Class.new(described_class) }
 
   def app
     root_api
@@ -68,7 +68,7 @@ describe Grape::API do
     describe 'with dynamic configuration' do
       context 'when mounting an endpoint conditional on a configuration' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get 'always' do
               'success'
             end
@@ -101,7 +101,7 @@ describe Grape::API do
 
       context 'when using an expression derived from a configuration' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get(mounted { "api_name_#{configuration[:api_name]}" }) do
               'success'
             end
@@ -126,7 +126,7 @@ describe Grape::API do
 
         context 'when the expression lives in a namespace' do
           subject(:a_remounted_api) do
-            Class.new(Grape::API) do
+            Class.new(described_class) do
               namespace :base do
                 get(mounted { "api_name_#{configuration[:api_name]}" }) do
                   'success'
@@ -149,7 +149,7 @@ describe Grape::API do
 
       context 'when executing a standard block within a `mounted` block with all dynamic params' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             mounted do
               desc configuration[:description] do
                 headers configuration[:headers]
@@ -191,7 +191,7 @@ describe Grape::API do
 
       context 'when executing a custom block on mount' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get 'always' do
               'success'
             end
@@ -215,7 +215,7 @@ describe Grape::API do
 
       context 'when the configuration is part of the arguments of a method' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get configuration[:endpoint_name] do
               'success'
             end
@@ -237,7 +237,7 @@ describe Grape::API do
 
         context 'when the configuration is the value in a key-arg pair' do
           subject(:a_remounted_api) do
-            Class.new(Grape::API) do
+            Class.new(described_class) do
               version 'v1', using: :param, parameter: configuration[:version_param]
               get 'endpoint' do
                 'version 1'
@@ -267,7 +267,7 @@ describe Grape::API do
 
       context 'on the DescSCope' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             desc 'The description of this' do
               tags ['not_configurable_tag', configuration[:a_configurable_tag]]
             end
@@ -284,7 +284,7 @@ describe Grape::API do
 
       context 'on the ParamScope' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             params do
               requires configuration[:required_param], type: configuration[:required_type]
             end
@@ -314,7 +314,7 @@ describe Grape::API do
 
         context 'on dynamic checks' do
           subject(:a_remounted_api) do
-            Class.new(Grape::API) do
+            Class.new(described_class) do
               params do
                 optional :restricted_values, values: -> { [configuration[:allowed_value], 'always'] }
               end
@@ -363,7 +363,7 @@ describe Grape::API do
 
       context 'a very complex configuration example' do
         before do
-          top_level_api = Class.new(Grape::API) do
+          top_level_api = Class.new(described_class) do
             remounted_api = Class.new(Grape::API) do
               get configuration[:endpoint_name] do
                 configuration[:response]
@@ -431,7 +431,7 @@ describe Grape::API do
 
       context 'when the configuration is read in a helper' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             helpers do
               def printed_response
                 configuration[:some_value]
@@ -454,7 +454,7 @@ describe Grape::API do
 
       context 'when the configuration is read within the response block' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get 'location' do
               configuration[:some_value]
             end