grape 1.7.1 → 2.0.0

data/spec/grape/api/deeply_included_options_spec.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module DeeplyIncludedOptionsSpec
-  module Defaults
-    extend ActiveSupport::Concern
-    included do
-      format :json
-    end
-  end
-
-  module Admin
-    module Defaults
-      extend ActiveSupport::Concern
-      include DeeplyIncludedOptionsSpec::Defaults
-    end
-
-    class Users < Grape::API
-      include DeeplyIncludedOptionsSpec::Admin::Defaults
-
-      resource :users do
-        get do
-          status 200
-        end
-      end
-    end
-  end
-
-  class Main < Grape::API
-    mount DeeplyIncludedOptionsSpec::Admin::Users
-  end
-end
-
-describe Grape::API do
-  subject { DeeplyIncludedOptionsSpec::Main }
-
-  def app
-    subject
-  end
-
-  it 'works for unspecified format' do
-    get '/users'
-    expect(last_response.status).to be 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 be 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 be 404
-  end
-end

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::API::Instance do
-  describe 'boolean constant' do
-    module DefinesBooleanInstanceSpec
-      class API < Grape::API
-        params do
-          requires :message, type: Boolean
-        end
-        post :echo do
-          { class: params[:message].class.name, value: params[:message] }
-        end
-      end
-    end
-
-    def app
-      DefinesBooleanInstanceSpec::API
-    end
-
-    let(:expected_body) do
-      { class: 'TrueClass', value: true }.to_s
-    end
-
-    it 'sets Boolean as a type' do
-      post '/echo?message=true'
-      expect(last_response.status).to eq(201)
-      expect(last_response.body).to eq expected_body
-    end
-
-    context 'Params endpoint type' do
-      subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
-
-      it 'params type is a boolean' do
-        expect(subject).to eq 'Grape::API::Boolean'
-      end
-    end
-  end
-end

data/spec/grape/api/documentation_spec.rb

@@ -1,59 +0,0 @@
-# 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,114 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::API::Helpers do
-  let(:user) { 'Miguel Caneo' }
-  let(:id)   { '42' }
-
-  module InheritedHelpersSpec
-    class SuperClass < Grape::API
-      helpers do
-        params(:superclass_params) { requires :id, type: String }
-
-        def current_user
-          params[:user]
-        end
-      end
-    end
-
-    class OverriddenSubClass < SuperClass
-      params { use :superclass_params }
-
-      helpers do
-        def current_user
-          "#{params[:user]} with id"
-        end
-      end
-
-      get 'resource' do
-        "#{current_user}: #{params['id']}"
-      end
-    end
-
-    class SubClass < SuperClass
-      params { use :superclass_params }
-
-      get 'resource' do
-        "#{current_user}: #{params['id']}"
-      end
-    end
-
-    class Example < SubClass
-      params { use :superclass_params }
-
-      get 'resource' do
-        "#{current_user}: #{params['id']}"
-      end
-    end
-  end
-
-  context 'non overriding subclass' do
-    subject { InheritedHelpersSpec::SubClass }
-
-    def app
-      subject
-    end
-
-    context 'given expected params' do
-      it 'inherits helpers from a superclass' do
-        get '/resource', id: id, user: user
-        expect(last_response.body).to eq("#{user}: #{id}")
-      end
-    end
-
-    context 'with lack of expected params' do
-      it 'returns missing error' do
-        get '/resource'
-        expect(last_response.body).to eq('id is missing')
-      end
-    end
-  end
-
-  context 'overriding subclass' do
-    subject { InheritedHelpersSpec::OverriddenSubClass }
-
-    def app
-      subject
-    end
-
-    context 'given expected params' do
-      it 'overrides helpers from a superclass' do
-        get '/resource', id: id, user: user
-        expect(last_response.body).to eq("#{user} with id: #{id}")
-      end
-    end
-
-    context 'with lack of expected params' do
-      it 'returns missing error' do
-        get '/resource'
-        expect(last_response.body).to eq('id is missing')
-      end
-    end
-  end
-
-  context 'example subclass' do
-    subject { InheritedHelpersSpec::Example }
-
-    def app
-      subject
-    end
-
-    context 'given expected params' do
-      it 'inherits helpers from a superclass' do
-        get '/resource', id: id, user: user
-        expect(last_response.body).to eq("#{user}: #{id}")
-      end
-    end
-
-    context 'with lack of expected params' do
-      it 'returns missing error' do
-        get '/resource'
-        expect(last_response.body).to eq('id is missing')
-      end
-    end
-  end
-end

data/spec/grape/api/instance_spec.rb

@@ -1,103 +0,0 @@
-# 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,45 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::Endpoint do
-  subject { Class.new(Grape::API) }
-
-  def app
-    subject
-  end
-
-  before do
-    subject.namespace do
-      format :json
-      content_type :json, 'application/json'
-      params do
-        requires :id, desc: 'Identifier.'
-      end
-      get ':id' do
-        {
-          id: params[:id],
-          format: params[:format]
-        }
-      end
-    end
-  end
-
-  context 'get' do
-    it 'no format' do
-      get '/foo'
-      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
-      expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: 'invalid'))
-    end
-  end
-end

data/spec/grape/api/namespace_parameters_in_route_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::Endpoint do
-  subject { Class.new(Grape::API) }
-
-  def app
-    subject
-  end
-
-  before do
-    subject.namespace :me do
-      namespace :pending do
-        get '/' do
-          'banana'
-        end
-      end
-      put ':id' do
-        params[:id]
-      end
-    end
-  end
-
-  context 'get' do
-    it 'responds without ext' do
-      get '/me/pending'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'banana'
-    end
-  end
-
-  context 'put' do
-    it 'responds' do
-      put '/me/foo'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'foo'
-    end
-  end
-end

data/spec/grape/api/nested_helpers_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::API::Helpers do
-  module NestedHelpersSpec
-    module HelperMethods
-      extend Grape::API::Helpers
-      def current_user
-        @current_user ||= params[:current_user]
-      end
-    end
-
-    class Nested < Grape::API
-      resource :level1 do
-        helpers HelperMethods
-
-        get do
-          current_user
-        end
-
-        resource :level2 do
-          get do
-            current_user
-          end
-        end
-      end
-    end
-
-    class Main < Grape::API
-      mount Nested
-    end
-  end
-
-  subject do
-    NestedHelpersSpec::Main
-  end
-
-  def app
-    subject
-  end
-
-  it 'can access helpers from a mounted resource' do
-    get '/level1', current_user: 'hello'
-    expect(last_response.body).to eq('hello')
-  end
-
-  it 'can access helpers from a mounted resource in a nested resource' do
-    get '/level1/level2', current_user: 'world'
-    expect(last_response.body).to eq('world')
-  end
-end

data/spec/grape/api/optional_parameters_in_route_spec.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::Endpoint do
-  subject { Class.new(Grape::API) }
-
-  def app
-    subject
-  end
-
-  before do
-    subject.namespace :api do
-      get ':id(/:ext)' do
-        [params[:id], params[:ext]].compact.join('/')
-      end
-
-      put ':id' do
-        params[:id]
-      end
-    end
-  end
-
-  context 'get' do
-    it 'responds without ext' do
-      get '/api/foo'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'foo'
-    end
-
-    it 'responds with ext' do
-      get '/api/foo/bar'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'foo/bar'
-    end
-  end
-
-  context 'put' do
-    it 'responds' do
-      put '/api/foo'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'foo'
-    end
-  end
-end

data/spec/grape/api/parameters_modification_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::Endpoint do
-  subject { Class.new(Grape::API) }
-
-  def app
-    subject
-  end
-
-  before do
-    subject.namespace :test do
-      params do
-        optional :foo, default: +'-abcdef'
-      end
-      get do
-        params[:foo].slice!(0)
-        params[:foo]
-      end
-    end
-  end
-
-  context 'when route modifies param value' do
-    it 'param default should not change' do
-      get '/test'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'abcdef'
-
-      get '/test'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'abcdef'
-
-      get '/test?foo=-123456'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq '123456'
-
-      get '/test'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq 'abcdef'
-    end
-  end
-end

data/spec/grape/api/patch_method_helpers_spec.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::API::Helpers do
-  module PatchHelpersSpec
-    class PatchPublic < Grape::API
-      format :json
-      version 'public-v1', using: :header, vendor: 'grape'
-
-      get do
-        { ok: 'public' }
-      end
-    end
-
-    module AuthMethods
-      def authenticate!; end
-    end
-
-    class PatchPrivate < Grape::API
-      format :json
-      version 'private-v1', using: :header, vendor: 'grape'
-
-      helpers AuthMethods
-
-      before do
-        authenticate!
-      end
-
-      get do
-        { ok: 'private' }
-      end
-    end
-
-    class Main < Grape::API
-      mount PatchPublic
-      mount PatchPrivate
-    end
-  end
-
-  def app
-    PatchHelpersSpec::Main
-  end
-
-  context 'patch' do
-    it 'public' do
-      patch '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-public-v1+json'
-      expect(last_response.status).to eq 405
-    end
-
-    it 'private' do
-      patch '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-private-v1+json'
-      expect(last_response.status).to eq 405
-    end
-
-    it 'default' do
-      patch '/'
-      expect(last_response.status).to eq 405
-    end
-  end
-
-  context 'default' do
-    it 'public' do
-      get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-public-v1+json'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq({ ok: 'public' }.to_json)
-    end
-
-    it 'private' do
-      get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.grape-private-v1+json'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq({ ok: 'private' }.to_json)
-    end
-
-    it 'default' do
-      get '/'
-      expect(last_response.status).to eq 200
-      expect(last_response.body).to eq({ ok: 'public' }.to_json)
-    end
-  end
-end

data/spec/grape/api/recognize_path_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-describe Grape::API do
-  describe '.recognize_path' do
-    subject { Class.new(described_class) }
-
-    it 'fetches endpoint by given path' do
-      subject.get('/foo/:id') {}
-      subject.get('/bar/:id') {}
-      subject.get('/baz/:id') {}
-
-      actual = subject.recognize_path('/bar/1234').routes[0].origin
-      expect(actual).to eq('/bar/:id')
-    end
-
-    it 'returns nil if given path does not match with registered routes' do
-      subject.get {}
-      expect(subject.recognize_path('/bar/1234')).to be_nil
-    end
-  end
-end