grape 0.8.0 → 0.9.0

data/lib/grape/validations/coerce.rb

@@ -6,12 +6,12 @@ module Grape
   module Validations
     class CoerceValidator < SingleOptionValidator
       def validate_param!(attr_name, params)
-        raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message_key: :coerce unless params.is_a? Hash
+        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :coerce unless params.is_a? Hash
         new_value = coerce_value(@option, params[attr_name])
         if valid_type?(new_value)
           params[attr_name] = new_value
         else
-          raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message_key: :coerce
+          raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :coerce
         end
       end
 

data/lib/grape/validations/exactly_one_of.rb

@@ -7,7 +7,7 @@ module Grape
       def validate!(params)
         super
         if none_of_restricted_params_is_present
-          raise Grape::Exceptions::Validation, param: "#{all_keys}", message_key: :exactly_one
+          raise Grape::Exceptions::Validation, params: all_keys, message_key: :exactly_one
         end
         params
       end
@@ -19,7 +19,7 @@ module Grape
       end
 
       def all_keys
-        attrs.map(&:to_sym)
+        attrs.map(&:to_s)
       end
     end
   end

data/lib/grape/validations/mutual_exclusion.rb

@@ -6,7 +6,7 @@ module Grape
       def validate!(params)
         @params = params
         if two_or_more_exclusive_params_are_present
-          raise Grape::Exceptions::Validation, param: "#{keys_in_common.map(&:to_sym)}", message_key: :mutual_exclusion
+          raise Grape::Exceptions::Validation, params: keys_in_common, message_key: :mutual_exclusion
         end
         params
       end
@@ -18,7 +18,7 @@ module Grape
       end
 
       def keys_in_common
-        attrs.map(&:to_s) & params.stringify_keys.keys
+        (attrs.map(&:to_s) & params.stringify_keys.keys).map(&:to_s)
       end
     end
   end

data/lib/grape/validations/presence.rb

@@ -8,7 +8,7 @@ module Grape
 
       def validate_param!(attr_name, params)
         unless params.respond_to?(:key?) && params.key?(attr_name)
-          raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message_key: :presence
+          raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :presence
         end
       end
     end

data/lib/grape/validations/regexp.rb

@@ -4,7 +4,7 @@ module Grape
       def validate_param!(attr_name, params)
         if params.key?(attr_name) &&
           (params[attr_name].nil? || !(params[attr_name].to_s =~ @option))
-          raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message_key: :regexp
+          raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :regexp
         end
       end
     end

data/lib/grape/validations/values.rb

@@ -9,7 +9,7 @@ module Grape
 
       def validate_param!(attr_name, params)
         if (params[attr_name] || required_for_root_scope?) && !(@values.is_a?(Proc) ? @values.call : @values).include?(params[attr_name])
-          raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message_key: :values
+          raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :values
         end
       end
 

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/grape/api/helpers_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Grape::API::Helpers do
+  module SharedParams
+    extend Grape::API::Helpers
+
+    params :pagination do
+      optional :page, type: Integer
+      optional :size, type: Integer
+    end
+  end
+
+  subject do
+    Class.new(Grape::API) do
+      helpers SharedParams
+      format :json
+
+      params do
+        use :pagination
+      end
+      get do
+        declared(params, include_missing: true)
+      end
+    end
+  end
+
+  def app
+    subject
+  end
+
+  it 'defines parameters' do
+    get '/'
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to eq({ page: nil, size: nil }.to_json)
+  end
+end

data/spec/grape/api_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'shared/versioning_examples'
+require 'grape-entity'
 
 describe Grape::API do
   subject { Class.new(Grape::API) }
@@ -121,9 +122,11 @@ describe Grape::API do
 
   describe '.namespace' do
     it 'is retrievable and converted to a path' do
+      internal_namespace = nil
       subject.namespace :awesome do
-        namespace.should == '/awesome'
+        internal_namespace = namespace
       end
+      expect(internal_namespace).to eql("/awesome")
     end
 
     it 'comes after the prefix and version' do
@@ -139,27 +142,31 @@ describe Grape::API do
     end
 
     it 'cancels itself after the block is over' do
+      internal_namespace = nil
       subject.namespace :awesome do
-        namespace.should == '/awesome'
+        internal_namespace = namespace
       end
-
-      expect(subject.namespace).to eq('/')
+      expect(subject.namespace).to eql("/")
     end
 
     it 'is stackable' do
+      internal_namespace = nil
+      internal_second_namespace = nil
       subject.namespace :awesome do
+        internal_namespace = namespace
         namespace :rad do
-          namespace.should == '/awesome/rad'
+          internal_second_namespace = namespace
         end
-        namespace.should == '/awesome'
       end
-      expect(subject.namespace).to eq('/')
+      expect(internal_namespace).to eq('/awesome')
+      expect(internal_second_namespace).to eq('/awesome/rad')
     end
 
     it 'accepts path segments correctly' do
+      inner_namespace = nil
       subject.namespace :members do
         namespace '/:member_id' do
-          namespace.should == '/members/:member_id'
+          inner_namespace = namespace
           get '/' do
             params[:member_id]
           end
@@ -167,6 +174,7 @@ describe Grape::API do
       end
       get '/members/23'
       expect(last_response.body).to eq("23")
+      expect(inner_namespace).to eq('/members/:member_id')
     end
 
     it 'is callable with nil just to push onto the stack' do
@@ -184,9 +192,11 @@ describe Grape::API do
 
     %w(group resource resources segment).each do |als|
       it '`.#{als}` is an alias' do
+        inner_namespace = nil
         subject.send(als, :awesome) do
-          namespace.should ==  "/awesome"
+          inner_namespace = namespace
         end
+        expect(inner_namespace).to eq "/awesome"
       end
     end
   end
@@ -320,8 +330,11 @@ describe Grape::API do
 
     context 'format' do
       before(:each) do
+        allow_any_instance_of(Object).to receive(:to_json).and_return("abc")
+        allow_any_instance_of(Object).to receive(:to_txt).and_return("def")
+
         subject.get("/abc") do
-          RSpec::Mocks::Mock.new(to_json: 'abc', to_txt: 'def')
+          Object.new
         end
       end
 
@@ -792,11 +805,11 @@ describe Grape::API do
         it "uploads and downloads a PNG file via #{url}" do
           image_filename = "grape.png"
           post url, file: Rack::Test::UploadedFile.new(image_filename, 'image/png', true)
-          last_response.status.should == 201
-          last_response.headers['Content-Type'].should == "image/png"
-          last_response.headers['Content-Disposition'].should == "attachment; filename*=UTF-8''grape.png"
+          expect(last_response.status).to eq(201)
+          expect(last_response.headers['Content-Type']).to eq("image/png")
+          expect(last_response.headers['Content-Disposition']).to eq("attachment; filename*=UTF-8''grape.png")
           File.open(image_filename, 'rb') do |io|
-            last_response.body.should eq io.read
+            expect(last_response.body).to eq io.read
           end
         end
       end
@@ -804,11 +817,11 @@ describe Grape::API do
       it "uploads and downloads a Ruby file" do
         filename = __FILE__
         post "/attachment.rb", file: Rack::Test::UploadedFile.new(filename, 'application/x-ruby', true)
-        last_response.status.should == 201
-        last_response.headers['Content-Type'].should == "application/x-ruby"
-        last_response.headers['Content-Disposition'].should == "attachment; filename*=UTF-8''api_spec.rb"
+        expect(last_response.status).to eq(201)
+        expect(last_response.headers['Content-Type']).to eq("application/x-ruby")
+        expect(last_response.headers['Content-Disposition']).to eq("attachment; filename*=UTF-8''api_spec.rb")
         File.open(filename, 'rb') do |io|
-          last_response.body.should eq io.read
+          expect(last_response.body).to eq io.read
         end
       end
     end
@@ -864,13 +877,15 @@ describe Grape::API do
       end
 
       it 'does not show up outside the namespace' do
+        inner_middleware = nil
         subject.use ApiSpec::PhonyMiddleware, 123
         subject.namespace :awesome do
           use ApiSpec::PhonyMiddleware, 'abc'
-          middleware.should == [[ApiSpec::PhonyMiddleware, 123], [ApiSpec::PhonyMiddleware, 'abc']]
+          inner_middleware = middleware
         end
 
         expect(subject.middleware).to eql [[ApiSpec::PhonyMiddleware, 123]]
+        expect(inner_middleware).to eql [[ApiSpec::PhonyMiddleware, 123], [ApiSpec::PhonyMiddleware, 'abc']]
       end
 
       it 'calls the middleware' do
@@ -1748,6 +1763,44 @@ describe Grape::API do
     end
   end
 
+  context 'http_codes' do
+    let(:error_presenter) do
+      Class.new(Grape::Entity) do
+        expose :code
+        expose :static
+
+        def static
+          'some static text'
+        end
+      end
+    end
+
+    it 'is used as presenter' do
+      subject.desc 'some desc', http_codes: [
+        [408, 'Unauthorized', error_presenter]
+      ]
+
+      subject.get '/exception' do
+        error!({ code: 408 }, 408)
+      end
+
+      get '/exception'
+      expect(last_response.status).to eql 408
+      expect(last_response.body).to eql({ code: 408, static: 'some static text' }.to_json)
+    end
+
+    it 'presented with' do
+      error = { code: 408, with: error_presenter }
+      subject.get '/exception' do
+        error! error, 408
+      end
+
+      get '/exception'
+      expect(last_response.status).to eql 408
+      expect(last_response.body).to eql({ code: 408, static: 'some static text' }.to_json)
+    end
+  end
+
   context 'routes' do
     describe 'empty api structure' do
       it 'returns an empty array of routes' do

data/spec/grape/dsl/callbacks_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module CallbacksSpec
+      class Dummy
+        include Grape::DSL::Callbacks
+      end
+    end
+
+    describe Callbacks do
+      subject { Class.new(CallbacksSpec::Dummy) }
+      let(:proc) { ->() {} }
+
+      describe '.before' do
+        it 'adds a block to "before"' do
+          expect(subject).to receive(:imbue).with(:befores, [proc])
+          subject.before(&proc)
+        end
+      end
+
+      describe '.before_validation' do
+        it 'adds a block to "before_validation"' do
+          expect(subject).to receive(:imbue).with(:before_validations, [proc])
+          subject.before_validation(&proc)
+        end
+      end
+
+      describe '.after_validation' do
+        it 'adds a block to "after_validation"' do
+          expect(subject).to receive(:imbue).with(:after_validations, [proc])
+          subject.after_validation(&proc)
+        end
+      end
+
+      describe '.after' do
+        it 'adds a block to "after"' do
+          expect(subject).to receive(:imbue).with(:afters, [proc])
+          subject.after(&proc)
+        end
+      end
+    end
+  end
+end

data/spec/grape/dsl/configuration_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module ConfigurationSpec
+      class Dummy
+        include Grape::DSL::Configuration
+
+        # rubocop:disable TrivialAccessors
+        def self.last_desc
+          @last_description
+        end
+        # rubocop:enable TrivialAccessors
+      end
+    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
+      end
+
+      describe '.desc' do
+        it 'sets a description' do
+          options = { message: 'none' }
+          subject.desc options
+          expect(subject.last_desc).to eq(description: options)
+        end
+      end
+
+    end
+  end
+end

data/spec/grape/dsl/helpers_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module HelpersSpec
+      class Dummy
+        include Grape::DSL::Helpers
+
+        def self.settings
+          @settings ||= Grape::Util::HashStack.new
+        end
+
+        def self.set(_, mod)
+          @mod = mod
+        end
+
+        # rubocop:disable TrivialAccessors
+        def self.mod
+          @mod
+        end
+        # rubocop:enable TrivialAccessors
+      end
+    end
+    describe Helpers do
+      subject { Class.new(HelpersSpec::Dummy) }
+      let(:proc) do
+        ->(*) do
+          def test
+            :test
+          end
+        end
+      end
+
+      describe '.helpers' do
+        it 'adds a module with the given block' do
+          expect(subject).to receive(:set).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original
+          subject.helpers(&proc)
+
+          expect(subject.mod.instance_methods).to include(:test)
+        end
+
+        it 'uses provided modules' do
+          mod = Module.new
+
+          expect(subject).to receive(:set).with(:helpers, kind_of(Grape::DSL::Helpers::BaseHelper)).and_call_original
+          subject.helpers(mod, &proc)
+
+          expect(subject.mod).not_to eq mod
+          expect(subject.mod).to include mod
+        end
+      end
+    end
+  end
+end

data/spec/grape/dsl/inside_route_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+module Grape
+  module DSL
+    module InsideRouteSpec
+      class Dummy
+        include Grape::DSL::InsideRoute
+
+        attr_reader :env, :request, :settings
+
+        def initialize
+          @env = {}
+          @header = {}
+          @settings = Grape::Util::HashStack.new
+        end
+      end
+    end
+
+    describe Endpoint do
+      subject { InsideRouteSpec::Dummy.new }
+
+      describe '#version' do
+        it 'defaults to nil' do
+          expect(subject.version).to be nil
+        end
+
+        it 'returns env[api.version]' do
+          subject.env['api.version'] = 'dummy'
+          expect(subject.version).to eq 'dummy'
+        end
+      end
+
+      describe '#error!' do
+        it 'throws :error' do
+          expect { subject.error! 'Not Found', 404 }.to throw_symbol(:error)
+        end
+
+        describe 'thrown' do
+          before do
+            catch(:error) { subject.error! 'Not Found', 404 }
+          end
+          it 'sets status' do
+            expect(subject.status).to eq 404
+          end
+        end
+
+        describe 'default_error_status' do
+          before do
+            subject.settings[:default_error_status] = 500
+            catch(:error) { subject.error! 'Unknown' }
+          end
+          it 'sets status to default_error_status' do
+            expect(subject.status).to eq 500
+          end
+        end
+
+        # self.status(status || settings[:default_error_status])
+        # throw :error, message: message, status: self.status, headers: headers
+      end
+
+      describe '#redirect' do
+        describe 'default' do
+          before do
+            subject.redirect '/'
+          end
+
+          it 'sets status to 302' do
+            expect(subject.status).to eq 302
+          end
+
+          it 'sets location header' do
+            expect(subject.header['Location']).to eq '/'
+          end
+        end
+
+        describe 'permanent' do
+          before do
+            subject.redirect '/', permanent: true
+          end
+
+          it 'sets status to 301' do
+            expect(subject.status).to eq 301
+          end
+
+          it 'sets location header' do
+            expect(subject.header['Location']).to eq '/'
+          end
+        end
+      end
+
+      describe '#status' do
+        ['GET', 'PUT', 'DELETE', 'OPTIONS'].each do |method|
+          it 'defaults to 200 on GET' do
+            request = Grape::Request.new(Rack::MockRequest.env_for('/', method: method))
+            expect(subject).to receive(:request).and_return(request)
+            expect(subject.status).to eq 200
+          end
+        end
+
+        it 'defaults to 201 on POST' do
+          request = Grape::Request.new(Rack::MockRequest.env_for('/', method: 'POST'))
+          expect(subject).to receive(:request).and_return(request)
+          expect(subject.status).to eq 201
+        end
+
+        it 'returns status set' do
+          subject.status 501
+          expect(subject.status).to eq 501
+        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
+            subject.content_type 'text/plain'
+          end
+
+          it 'returns value' do
+            expect(subject.content_type).to eq 'text/plain'
+          end
+        end
+
+        it 'returns default' do
+          expect(subject.content_type).to be nil
+        end
+      end
+
+      describe '#cookies' do
+        it 'returns an instance of Cookies' do
+          expect(subject.cookies).to be_a Grape::Cookies
+        end
+      end
+
+      describe '#body' do
+        describe 'set' do
+          before do
+            subject.body 'body'
+          end
+
+          it 'returns value' do
+            expect(subject.body).to eq 'body'
+          end
+        end
+
+        it 'returns default' do
+          expect(subject.body).to be nil
+        end
+      end
+
+      describe '#route' do
+        before do
+          subject.env['rack.routing_args'] = {}
+          subject.env['rack.routing_args'][:route_info] = 'dummy'
+        end
+
+        it 'returns route_info' do
+          expect(subject.route).to eq 'dummy'
+        end
+      end
+
+      describe '#present' do
+        # see entity_spec.rb for entity representation spec coverage
+
+        describe 'dummy' do
+          before do
+            subject.present 'dummy'
+          end
+
+          it 'presents dummy object' do
+            expect(subject.body).to eq 'dummy'
+          end
+        end
+
+        describe 'with' do
+          describe 'entity' do
+            let(:entity_mock) do
+              entity_mock = Object.new
+              allow(entity_mock).to receive(:represent).and_return('dummy')
+              entity_mock
+            end
+
+            describe 'instance' do
+              before do
+                subject.present 'dummy', with: entity_mock
+              end
+
+              it 'presents dummy object' do
+                expect(subject.body).to eq 'dummy'
+              end
+            end
+          end
+        end
+      end
+
+      describe '#declared' do
+        # see endpoint_spec.rb#declared for spec coverage
+
+        it 'returns an empty hash' do
+          expect(subject.declared({})).to eq({})
+        end
+      end
+    end
+  end
+end