grape 0.14.0 → 0.15.0

data/spec/grape/dsl/configuration_spec.rb

@@ -9,81 +9,6 @@ module Grape
     end
     describe Configuration do
       subject { Class.new(ConfigurationSpec::Dummy) }
-      let(:logger) { double(:logger) }
-
-      describe '.logger' do
-        it 'sets a logger' do
-          subject.logger logger
-          expect(subject.logger).to eq logger
-        end
-
-        it 'returns a logger' do
-          expect(subject.logger logger).to eq logger
-        end
-      end
-
-      describe '.desc' do
-        it 'sets a description' do
-          desc_text = 'The description'
-          options = { message: 'none' }
-          subject.desc desc_text, options
-          expect(subject.namespace_setting(:description)).to eq(options.merge(description: desc_text))
-          expect(subject.route_setting(:description)).to eq(options.merge(description: desc_text))
-        end
-
-        it 'can be set with a block' do
-          expected_options = {
-            description: 'The description',
-            detail: 'more details',
-            params: { first: :param },
-            entity: Object,
-            http_codes: [[401, 'Unauthorized', 'Entities::Error']],
-            named: 'My named route',
-            headers: [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                      XOptionalHeader: {
-                        description: 'Not really needed',
-                        required: false
-                      }
-                     ]
-          }
-
-          subject.desc 'The description' do
-            detail 'more details'
-            params(first: :param)
-            success Object
-            failure [[401, 'Unauthorized', 'Entities::Error']]
-            named 'My named route'
-            headers [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                     XOptionalHeader: {
-                       description: 'Not really needed',
-                       required: false
-                     }
-                    ]
-          end
-
-          expect(subject.namespace_setting(:description)).to eq(expected_options)
-          expect(subject.route_setting(:description)).to eq(expected_options)
-        end
-
-        it 'can be set with options and a block' do
-          expect(subject).to receive(:warn).with('[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
-
-          desc_text = 'The description'
-          detail_text = 'more details'
-          options = { message: 'none' }
-          subject.desc desc_text, options do
-            detail detail_text
-          end
-          expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
-          expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
-        end
-      end
     end
   end
 end

data/spec/grape/dsl/desc_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module DescSpec
+      class Dummy
+        extend Grape::DSL::Desc
+      end
+    end
+    describe Desc do
+      subject { Class.new(DescSpec::Dummy) }
+
+      describe '.desc' do
+        it 'sets a description' do
+          desc_text = 'The description'
+          options = { message: 'none' }
+          subject.desc desc_text, options
+          expect(subject.namespace_setting(:description)).to eq(options.merge(description: desc_text))
+          expect(subject.route_setting(:description)).to eq(options.merge(description: desc_text))
+        end
+
+        it 'can be set with a block' do
+          expected_options = {
+            description: 'The description',
+            detail: 'more details',
+            params: { first: :param },
+            entity: Object,
+            http_codes: [[401, 'Unauthorized', 'Entities::Error']],
+            named: 'My named route',
+            headers: [XAuthToken: {
+              description: 'Valdates your identity',
+              required: true
+            },
+                      XOptionalHeader: {
+                        description: 'Not really needed',
+                        required: false
+                      }
+                     ]
+          }
+
+          subject.desc 'The description' do
+            detail 'more details'
+            params(first: :param)
+            success Object
+            failure [[401, 'Unauthorized', 'Entities::Error']]
+            named 'My named route'
+            headers [XAuthToken: {
+              description: 'Valdates your identity',
+              required: true
+            },
+                     XOptionalHeader: {
+                       description: 'Not really needed',
+                       required: false
+                     }
+                    ]
+          end
+
+          expect(subject.namespace_setting(:description)).to eq(expected_options)
+          expect(subject.route_setting(:description)).to eq(expected_options)
+        end
+
+        it 'can be set with options and a block' do
+          expect(subject).to receive(:warn).with('[DEPRECATION] Passing a options hash and a block to `desc` is deprecated. Move all hash options to block.')
+
+          desc_text = 'The description'
+          detail_text = 'more details'
+          options = { message: 'none' }
+          subject.desc desc_text, options do
+            detail detail_text
+          end
+          expect(subject.namespace_setting(:description)).to eq(description: desc_text, detail: detail_text)
+          expect(subject.route_setting(:description)).to eq(description: desc_text, detail: detail_text)
+        end
+      end
+    end
+  end
+end

data/spec/grape/dsl/headers_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module HeadersSpec
+      class Dummy
+        include Grape::DSL::Headers
+      end
+    end
+    describe Headers do
+      subject { HeadersSpec::Dummy.new }
+
+      describe '#header' do
+        describe 'set' do
+          before do
+            subject.header 'Name', 'Value'
+          end
+
+          it 'returns value' do
+            expect(subject.header['Name']).to eq 'Value'
+            expect(subject.header('Name')).to eq 'Value'
+          end
+        end
+
+        it 'returns nil' do
+          expect(subject.header['Name']).to be nil
+          expect(subject.header('Name')).to be nil
+        end
+      end
+    end
+  end
+end

data/spec/grape/dsl/inside_route_spec.rb

@@ -128,24 +128,6 @@ module Grape
         end
       end
 
-      describe '#header' do
-        describe 'set' do
-          before do
-            subject.header 'Name', 'Value'
-          end
-
-          it 'returns value' do
-            expect(subject.header['Name']).to eq 'Value'
-            expect(subject.header('Name')).to eq 'Value'
-          end
-        end
-
-        it 'returns nil' do
-          expect(subject.header['Name']).to be nil
-          expect(subject.header('Name')).to be nil
-        end
-      end
-
       describe '#content_type' do
         describe 'set' do
           before do

data/spec/grape/dsl/logger_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module LoggerSpec
+      class Dummy
+        extend Grape::DSL::Logger
+      end
+    end
+    describe Logger do
+      subject { Class.new(LoggerSpec::Dummy) }
+      let(:logger) { double(:logger) }
+
+      describe '.logger' do
+        it 'sets a logger' do
+          subject.logger logger
+          expect(subject.logger).to eq logger
+        end
+
+        it 'returns a logger' do
+          expect(subject.logger logger).to eq logger
+        end
+      end
+    end
+  end
+end

data/spec/grape/dsl/parameters_spec.rb

@@ -30,6 +30,12 @@ module Grape
         def validates_reader
           @validates
         end
+
+        def extract_message_option(attrs)
+          return nil unless attrs.is_a?(Array)
+          opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+          (opts.key?(:message) && !opts[:message].nil?) ? opts.delete(:message) : nil
+        end
       end
     end
 
@@ -45,13 +51,13 @@ module Grape
         let(:named_params) { { params_group: proc {} } }
 
         it 'calls processes associated with named params' do
-          allow(Grape::DSL::Configuration).to receive(:stacked_hash_to_hash).and_return(named_params)
+          allow(subject.api).to receive(:namespace_stackable_with_hash).and_return(named_params)
           expect(subject).to receive(:instance_exec).with(options).and_yield
           subject.use :params_group, options
         end
 
         it 'raises error when non-existent named param is called' do
-          allow(Grape::DSL::Configuration).to receive(:stacked_hash_to_hash).and_return({})
+          allow(subject.api).to receive(:namespace_stackable_with_hash).and_return({})
           expect { subject.use :params_group }.to raise_error('Params :params_group not found!')
         end
       end
@@ -72,7 +78,7 @@ module Grape
         it 'adds a required parameter' do
           subject.requires :id, type: Integer, desc: 'Identity.'
 
-          expect(subject.validate_attributes_reader).to eq([[:id], { type: Integer, desc: 'Identity.', presence: true }])
+          expect(subject.validate_attributes_reader).to eq([[:id], { type: Integer, desc: 'Identity.', presence: { value: true, message: nil } }])
           expect(subject.push_declared_params_reader).to eq([[:id]])
         end
       end
@@ -90,7 +96,7 @@ module Grape
         it 'adds an mutally exclusive parameter validation' do
           subject.mutually_exclusive :media, :audio
 
-          expect(subject.validates_reader).to eq([[:media, :audio], { mutual_exclusion: true }])
+          expect(subject.validates_reader).to eq([[:media, :audio], { mutual_exclusion: { value: true, message: nil } }])
         end
       end
 
@@ -98,7 +104,7 @@ module Grape
         it 'adds an exactly of one parameter validation' do
           subject.exactly_one_of :media, :audio
 
-          expect(subject.validates_reader).to eq([[:media, :audio], { exactly_one_of: true }])
+          expect(subject.validates_reader).to eq([[:media, :audio], { exactly_one_of: { value: true, message: nil } }])
         end
       end
 
@@ -106,7 +112,7 @@ module Grape
         it 'adds an at least one of parameter validation' do
           subject.at_least_one_of :media, :audio
 
-          expect(subject.validates_reader).to eq([[:media, :audio], { at_least_one_of: true }])
+          expect(subject.validates_reader).to eq([[:media, :audio], { at_least_one_of: { value: true, message: nil } }])
         end
       end
 
@@ -114,7 +120,7 @@ module Grape
         it 'adds an all or none of parameter validation' do
           subject.all_or_none_of :media, :audio
 
-          expect(subject.validates_reader).to eq([[:media, :audio], { all_or_none_of: true }])
+          expect(subject.validates_reader).to eq([[:media, :audio], { all_or_none_of: { value: true, message: nil } }])
         end
       end
 

data/spec/grape/dsl/request_response_spec.rb

@@ -124,9 +124,22 @@ module Grape
           end
 
           it 'sets a rescue handler declared through :with option' do
+            with_block = -> { 'hello' }
             expect(subject).to receive(:namespace_inheritable).with(:rescue_all, true)
             expect(subject).to receive(:namespace_inheritable).with(:all_rescue_handler, an_instance_of(Proc))
-            subject.rescue_from :all, with: 'ExampleHandler'
+            subject.rescue_from :all, with: with_block
+          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')
+          end
+
+          it 'abort if both :with option and block are passed' do
+            expect do
+              subject.rescue_from :all, with: -> { 'hello' } do
+                error!('bye')
+              end
+            end.to raise_error(ArgumentError, 'both :with option and block cannot be passed')
           end
         end
 
@@ -158,9 +171,10 @@ module Grape
           end
 
           it 'sets a rescue handler declared through :with option for each key in hash' do
+            with_block = -> { 'hello' }
             expect(subject).to receive(:namespace_stackable).with(:rescue_handlers, StandardError => an_instance_of(Proc))
-            expect(subject).to receive(:namespace_stackable).with(:rescue_options, with: 'ExampleHandler')
-            subject.rescue_from StandardError, with: 'ExampleHandler'
+            expect(subject).to receive(:namespace_stackable).with(:rescue_options, with: with_block)
+            subject.rescue_from StandardError, with: with_block
           end
         end
       end

data/spec/grape/dsl/routing_spec.rb

@@ -31,6 +31,13 @@ module Grape
         end
       end
 
+      describe '.scope' do
+        it 'create a scope without affecting the URL' do
+          expect(subject).to receive(:within_namespace)
+          subject.scope {}
+        end
+      end
+
       describe '.do_not_route_head!' do
         it 'sets do not route head option' do
           expect(subject).to receive(:namespace_inheritable).with(:do_not_route_head, true)
@@ -95,7 +102,7 @@ module Grape
 
         it 'generates correct endpoint options' do
           allow(subject).to receive(:route_setting).with(:description).and_return(fiz: 'baz')
-          allow(Grape::DSL::Configuration).to receive(:stacked_hash_to_hash).and_return(nuz: 'naz')
+          allow(subject).to receive(:namespace_stackable_with_hash).and_return(nuz: 'naz')
 
           expect(Grape::Endpoint).to receive(:new) do |_inheritable_setting, endpoint_options|
             expect(endpoint_options[:method]).to eq :get

data/spec/grape/dsl/settings_spec.rb

@@ -42,6 +42,13 @@ module Grape
         end
       end
 
+      describe '#unset_global_setting' do
+        it 'delegates to unset' do
+          expect(subject).to receive(:unset).with(:global, :dummy)
+          subject.unset_global_setting(:dummy)
+        end
+      end
+
       describe '#route_setting' do
         it 'delegates to get_or_set' do
           expect(subject).to receive(:get_or_set).with(:route, :dummy, 1)
@@ -58,6 +65,13 @@ module Grape
         end
       end
 
+      describe '#unset_route_setting' do
+        it 'delegates to unset' do
+          expect(subject).to receive(:unset).with(:route, :dummy)
+          subject.unset_route_setting(:dummy)
+        end
+      end
+
       describe '#namespace_setting' do
         it 'delegates to get_or_set' do
           expect(subject).to receive(:get_or_set).with(:namespace, :dummy, 1)
@@ -94,6 +108,13 @@ module Grape
         end
       end
 
+      describe '#unset_namespace_setting' do
+        it 'delegates to unset' do
+          expect(subject).to receive(:unset).with(:namespace, :dummy)
+          subject.unset_namespace_setting(:dummy)
+        end
+      end
+
       describe '#namespace_inheritable' do
         it 'delegates to get_or_set' do
           expect(subject).to receive(:get_or_set).with(:namespace_inheritable, :dummy, 1)
@@ -120,6 +141,13 @@ module Grape
         end
       end
 
+      describe '#unset_namespace_inheritable' do
+        it 'delegates to unset' do
+          expect(subject).to receive(:unset).with(:namespace_inheritable, :dummy)
+          subject.unset_namespace_inheritable(:dummy)
+        end
+      end
+
       describe '#namespace_stackable' do
         it 'delegates to get_or_set' do
           expect(subject).to receive(:get_or_set).with(:namespace_stackable, :dummy, 1)
@@ -146,6 +174,13 @@ module Grape
         end
       end
 
+      describe '#unset_namespace_stackable' do
+        it 'delegates to unset' do
+          expect(subject).to receive(:unset).with(:namespace_stackable, :dummy)
+          subject.unset_namespace_stackable(:dummy)
+        end
+      end
+
       describe '#api_class_setting' do
         it 'delegates to get_or_set' do
           expect(subject).to receive(:get_or_set).with(:api_class, :dummy, 1)
@@ -153,6 +188,13 @@ module Grape
         end
       end
 
+      describe '#unset_api_class_setting' do
+        it 'delegates to unset' do
+          expect(subject).to receive(:unset).with(:api_class, :dummy)
+          subject.unset_api_class_setting(:dummy)
+        end
+      end
+
       describe '#within_namespace' do
         it 'calls start and end for a namespace' do
           expect(subject).to receive :namespace_start