grape 1.1.0 → 1.7.1

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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::API::Helpers do
   let(:user) { 'Miguel Caneo' }

data/spec/grape/api/instance_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'shared/versioning_examples'
+
+describe Grape::API::Instance do
+  subject(:an_instance) do
+    Class.new(Grape::API::Instance) do
+      namespace :some_namespace do
+        get 'some_endpoint' do
+          'success'
+        end
+      end
+    end
+  end
+
+  let(:root_api) do
+    to_mount = an_instance
+    Class.new(Grape::API) do
+      mount to_mount
+    end
+  end
+
+  def app
+    root_api
+  end
+
+  context 'when an instance is mounted on the root' do
+    it 'can call the instance endpoint' do
+      get '/some_namespace/some_endpoint'
+      expect(last_response.body).to eq 'success'
+    end
+  end
+
+  context 'when an instance is the root' do
+    let(:root_api) do
+      to_mount = an_instance
+      Class.new(Grape::API::Instance) do
+        mount to_mount
+      end
+    end
+
+    it 'can call the instance endpoint' do
+      get '/some_namespace/some_endpoint'
+      expect(last_response.body).to eq 'success'
+    end
+  end
+
+  context 'top level setting' do
+    it 'does not inherit settings from the superclass (Grape::API::Instance)' do
+      expect(an_instance.top_level_setting.parent).to be_nil
+    end
+  end
+
+  context 'with multiple moutes' do
+    let(:first) do
+      Class.new(Grape::API::Instance) do
+        namespace(:some_namespace) do
+          route :any, '*path' do
+            error!('Not found! (1)', 404)
+          end
+        end
+      end
+    end
+    let(:second) do
+      Class.new(Grape::API::Instance) do
+        namespace(:another_namespace) do
+          route :any, '*path' do
+            error!('Not found! (2)', 404)
+          end
+        end
+      end
+    end
+    let(:root_api) do
+      first_instance = first
+      second_instance = second
+      Class.new(Grape::API) do
+        mount first_instance
+        mount first_instance
+        mount second_instance
+      end
+    end
+
+    it 'does not raise a FrozenError on first instance' do
+      expect { patch '/some_namespace/anything' }.not_to \
+        raise_error
+    end
+
+    it 'responds the correct body at the first instance' do
+      patch '/some_namespace/anything'
+      expect(last_response.body).to eq 'Not found! (1)'
+    end
+
+    it 'does not raise a FrozenError on second instance' do
+      expect { get '/another_namespace/other' }.not_to \
+        raise_error
+    end
+
+    it 'responds the correct body at the second instance' do
+      get '/another_namespace/foobar'
+      expect(last_response.body).to eq 'Not found! (2)'
+    end
+  end
+end

data/spec/grape/api/invalid_format_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
@@ -29,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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }

data/spec/grape/api/nested_helpers_spec.rb

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

data/spec/grape/api/optional_parameters_in_route_spec.rb

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

data/spec/grape/api/parameters_modification_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
@@ -10,7 +10,7 @@ describe Grape::Endpoint do
   before do
     subject.namespace :test do
       params do
-        optional :foo, default: '-abcdef'
+        optional :foo, default: +'-abcdef'
       end
       get do
         params[:foo].slice!(0)

data/spec/grape/api/patch_method_helpers_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::API::Helpers do
   module PatchHelpersSpec

data/spec/grape/api/recognize_path_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }

data/spec/grape/api/required_parameters_with_invalid_method_spec.rb

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

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+describe Grape::Endpoint do
+  subject { Class.new(Grape::API) }
+
+  def app
+    subject
+  end
+
+  context 'get' do
+    it 'routes to a namespace param with dots' do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get '/' do
+          params[:ns_with_dots]
+        end
+      end
+
+      get '/test.id.with.dots'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'test.id.with.dots'
+    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
+        "#{params[:id_with_dots]}/#{params[:another_id_with_dots]}"
+      end
+
+      get '/test.id/test2.id'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'test.id/test2.id'
+    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
+          "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
+        end
+      end
+
+      get '/test.id/test2.id'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'test.id/test2.id'
+    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
+          "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
+        end
+      end
+
+      get '/test.id/test2.id'
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq 'test.id/test2.id'
+    end
+  end
+end

data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb

@@ -1,19 +1,17 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 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
@@ -33,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,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::API::Helpers do
   subject do