grape-swagger 1.6.1 → 2.0.0

data/spec/lib/move_params_spec.rb

@@ -1,444 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe GrapeSwagger::DocMethods::MoveParams do
-  include_context 'the api paths/defs'
-
-  subject { described_class }
-
-  it { expect(subject.to_s).to eql 'GrapeSwagger::DocMethods::MoveParams' }
-
-  describe 'parameters can_be_moved' do
-    let(:movable_params) do
-      [
-        { param_type: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-        { param_type: 'body', name: 'in_body', description: 'in_body', type: 'integer', format: 'int32', required: true },
-        { param_type: 'query', name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true },
-        { param_type: 'header', name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true },
-        { param_type: 'formData', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-      ]
-    end
-
-    let(:not_movable_params) do
-      [
-        { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-        { in: 'query', name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true },
-        { in: 'header', name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true },
-        { in: 'formData', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-      ]
-    end
-
-    let(:allowed_verbs) do
-      [:post, :put, :patch, 'POST', 'PUT', 'PATCH']
-    end
-
-    let(:not_allowed_verbs) do
-      [:get, :delete, 'GET', 'DELETE']
-    end
-
-    describe 'movable params' do
-      specify 'allowed verbs' do
-        allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(verb, movable_params)).to be true
-        end
-      end
-
-      specify 'not allowed verbs' do
-        not_allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(verb, movable_params)).to be false
-        end
-      end
-    end
-
-    describe 'not movable params' do
-      specify 'allowed verbs' do
-        allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(verb, not_movable_params)).to be false
-        end
-      end
-
-      specify 'not allowed verbs' do
-        not_allowed_verbs.each do |verb|
-          expect(subject.can_be_moved?(verb, not_movable_params)).to be false
-        end
-      end
-    end
-
-    describe 'movable_params' do
-      before do
-        subject.send(:unify!, movable_params)
-      end
-      let(:expected_params) do
-        [
-          { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-          { in: 'query', name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true },
-          { in: 'header', name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true }
-        ]
-      end
-
-      let(:expected_movable_params) do
-        [
-          { in: 'body', name: 'in_body', description: 'in_body', type: 'integer', format: 'int32', required: true },
-          { in: 'body', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-        ]
-      end
-
-      specify do
-        params_to_move = subject.send(:movable_params, movable_params)
-        expect(movable_params).to eql expected_params
-        expect(params_to_move).to eql expected_movable_params
-      end
-    end
-  end
-
-  describe 'parent_definition_of_params' do
-    let(:path) { '/in_body' }
-    let(:route_options) { { requirements: {} } }
-    describe 'POST' do
-      let(:params) { paths[path][:post][:parameters] }
-      let(:route) { Grape::Router::Route.new('POST', path.dup, **route_options) }
-
-      specify do
-        subject.to_definition(path, params, route, definitions)
-        expect(params).to eql(
-          [
-            { name: 'postInBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/postInBody' } }
-          ]
-        )
-        expect(subject.definitions['postInBody']).not_to include :description
-        expect(subject.definitions['postInBody']).to eql expected_post_defs
-      end
-
-      context 'with a nickname' do
-        let(:route_options) { { nickname: 'post-body' } }
-
-        specify do
-          subject.to_definition(path, params, route, definitions)
-          expect(params).to eql(
-            [
-              { name: 'post-body', in: 'body', required: true, schema: { '$ref' => '#/definitions/post-body' } }
-            ]
-          )
-          expect(subject.definitions['post-body']).not_to include :description
-          expect(subject.definitions['post-body']).to eql expected_post_defs
-        end
-      end
-    end
-
-    describe 'PUT' do
-      let(:params) { paths['/in_body/{key}'][:put][:parameters] }
-      let(:route) { Grape::Router::Route.new('PUT', path.dup, **route_options) }
-
-      specify do
-        subject.to_definition(path, params, route, definitions)
-        expect(params).to eql(
-          [
-            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { name: 'putInBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/putInBody' } }
-          ]
-        )
-        expect(subject.definitions['putInBody']).not_to include :description
-        expect(subject.definitions['putInBody']).to eql expected_put_defs
-      end
-
-      context 'with a nickname' do
-        let(:route_options) { { nickname: 'put-body' } }
-
-        specify do
-          subject.to_definition(path, params, route, definitions)
-          expect(params).to eql(
-            [
-              { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-              { name: 'put-body', in: 'body', required: true, schema: { '$ref' => '#/definitions/put-body' } }
-            ]
-          )
-          expect(subject.definitions['put-body']).not_to include :description
-          expect(subject.definitions['put-body']).to eql expected_put_defs
-        end
-      end
-    end
-  end
-
-  describe 'nested definitions related' do
-    describe 'prepare_nested_names' do
-      let(:property) { 'address' }
-      before do
-        subject.send(:prepare_nested_names, property, params)
-      end
-
-      describe 'simple' do
-        let(:params) { [{ in: 'body', name: 'address[street]', description: 'street', type: 'string', required: true }] }
-        let(:expected) { [{ in: 'body', name: 'street', description: 'street', type: 'string', required: true }] }
-        specify do
-          expect(params).to eql expected
-        end
-      end
-
-      describe 'nested' do
-        let(:params) { [{ in: 'body', name: 'address[street][name]', description: 'street', type: 'string', required: true }] }
-        let(:expected) { [{ in: 'body', name: 'street[name]', description: 'street', type: 'string', required: true }] }
-        specify do
-          expect(params).to eql expected
-        end
-      end
-
-      describe 'array' do
-        let(:params) { [{ in: 'body', name: 'address[street_lines]', description: 'street lines', type: 'array', items: { type: 'string' }, required: true }] }
-        let(:expected) { [{ in: 'body', name: 'street_lines', description: 'street lines', type: 'array', items: { type: 'string' }, required: true }] }
-        specify do
-          expect(params).to eql expected
-        end
-      end
-    end
-  end
-
-  describe 'private methods' do
-    describe 'build_definition' do
-      let(:params) { [{ in: 'body', name: 'address[street][name]', description: 'street', type: 'string', required: true }] }
-      before do
-        subject.instance_variable_set(:@definitions, definitions)
-        subject.send(:build_definition, name, params)
-      end
-
-      let(:name) { 'FooBar' }
-      let(:definitions) { {} }
-
-      specify do
-        definition = definitions.to_a.first
-        expect(definition.first).to eql 'FooBar'
-        expect(definition.last).to eql(type: 'object', properties: {})
-      end
-    end
-
-    describe 'build_body_parameter' do
-      let(:name) { 'Foo' }
-      let(:reference) { 'Bar' }
-      let(:expected_param) do
-        { name: name, in: 'body', required: true, schema: { '$ref' => "#/definitions/#{name}" } }
-      end
-      specify do
-        parameter = subject.send(:build_body_parameter, name, {})
-        expect(parameter).to eql expected_param
-      end
-
-      describe 'body_name option specified' do
-        let(:route_options) { { body_name: 'body' } }
-        let(:expected_param) do
-          { name: route_options[:body_name], in: 'body', required: true, schema: { '$ref' => "#/definitions/#{name}" } }
-        end
-        specify do
-          parameter = subject.send(:build_body_parameter, name, route_options)
-          expect(parameter).to eql expected_param
-        end
-      end
-    end
-
-    describe 'parse_model' do
-      let(:ref) { '#/definitions/InBody' }
-      describe 'post request' do
-        subject(:object) { described_class.send(:parse_model, ref) }
-
-        specify { expect(object).to eql ref }
-      end
-
-      describe 'post request' do
-        let(:put_ref) { '#/definitions/InBody/{id}' }
-        subject(:object) { described_class.send(:parse_model, put_ref) }
-
-        specify { expect(object).to eql ref }
-      end
-    end
-
-    describe 'deletable' do
-      describe 'path' do
-        let(:param) { { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true } }
-        it { expect(subject.send(:deletable?, param)).to be false }
-      end
-
-      describe 'body' do
-        let(:param) { { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true } }
-        it { expect(subject.send(:deletable?, param)).to be true }
-      end
-
-      describe 'query' do
-        let(:param) { { in: 'query', name: 'in_query_1', description: 'in_query_1', type: 'integer', format: 'int32', required: true } }
-        it { expect(subject.send(:deletable?, param)).to be false }
-      end
-
-      describe 'header' do
-        let(:param) { { in: 'header', name: 'in_header_1', description: 'in_header_1', type: 'integer', format: 'int32', required: true } }
-        it { expect(subject.send(:deletable?, param)).to be false }
-      end
-    end
-
-    describe 'unify' do
-      before :each do
-        subject.send(:unify!, params)
-      end
-      describe 'param type with `:in` given' do
-        let(:params) do
-          [
-            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { in: 'body', name: 'in_body', description: 'in_body', type: 'integer', format: 'int32', required: true },
-            { in: 'query', name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true },
-            { in: 'header', name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true },
-            { in: 'formData', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-          ]
-        end
-
-        let(:expected_params) do
-          [
-            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { in: 'body', name: 'in_body', description: 'in_body', type: 'integer', format: 'int32', required: true },
-            { in: 'query', name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true },
-            { in: 'header', name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true },
-            { in: 'body', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-          ]
-        end
-        it { expect(params).to eql expected_params }
-      end
-
-      describe 'let it as is' do
-        let(:params) do
-          [
-            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { in: 'formData', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-          ]
-        end
-
-        let(:expected_params) do
-          [
-            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { in: 'formData', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-          ]
-        end
-        it { expect(params).to eql expected_params }
-      end
-
-      describe 'param type with `:param_type` given' do
-        let(:params) do
-          [
-            { param_type: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
-            { param_type: 'body', name: 'in_body', description: 'in_body', type: 'integer', format: 'int32', required: true },
-            { param_type: 'query', name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true },
-            { param_type: 'header', name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true },
-            { param_type: 'formData', name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true }
-          ]
-        end
-
-        let(:expected_params) do
-          [
-            { name: 'key', description: nil, type: 'integer', format: 'int32', required: true, in: 'path' },
-            { name: 'in_body', description: 'in_body', type: 'integer', format: 'int32', required: true, in: 'body' },
-            { name: 'in_query', description: 'in_query', type: 'integer', format: 'int32', required: true, in: 'query' },
-            { name: 'in_header', description: 'in_header', type: 'integer', format: 'int32', required: true, in: 'header' },
-            { name: 'in_form_data', description: 'in_form_data', type: 'integer', format: 'int32', required: true, in: 'body' }
-          ]
-        end
-        it { expect(params).to eql expected_params }
-      end
-    end
-
-    describe 'add_properties_to_definition' do
-      before :each do
-        subject.send(:add_properties_to_definition, definition, properties, [])
-      end
-
-      context 'when definition has items key' do
-        let(:definition) do
-          {
-            type: 'array',
-            items: {
-              type: 'object',
-              properties: {
-                description: 'Test description'
-              }
-            }
-          }
-        end
-
-        let(:properties) do
-          {
-            strings: {
-              type: 'string',
-              description: 'string elements'
-            }
-          }
-        end
-
-        let(:expected_definition) do
-          {
-            type: 'array',
-            items: {
-              type: 'object',
-              properties: {
-                description: 'Test description',
-                strings: {
-                  type: 'string',
-                  description: 'string elements'
-                }
-              }
-            }
-          }
-        end
-
-        it 'deep merges properties into definition item properties' do
-          expect(definition).to eq expected_definition
-        end
-      end
-
-      context 'when definition does not have items key' do
-        let(:definition) do
-          {
-            type: 'object',
-            properties: {
-              parent: {
-                type: 'object',
-                description: 'Parent to child'
-              }
-            }
-          }
-        end
-
-        let(:properties) do
-          {
-            parent: {
-              type: 'object',
-              properties: {
-                id: {
-                  type: 'string',
-                  description: 'Parent ID'
-                }
-              },
-              required: [:id]
-            }
-          }
-        end
-
-        let(:expected_definition) do
-          {
-            type: 'object',
-            properties: {
-              parent: {
-                type: 'object',
-                description: 'Parent to child',
-                properties: {
-                  id: {
-                    type: 'string',
-                    description: 'Parent ID'
-                  }
-                },
-                required: [:id]
-              }
-            }
-          }
-        end
-
-        it 'deep merges properties into definition properties' do
-          expect(definition).to eq expected_definition
-        end
-      end
-    end
-  end
-end

data/spec/lib/oapi_tasks_spec.rb

@@ -1,163 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe GrapeSwagger::Rake::OapiTasks do
-  module Api
-    class Item < Grape::API
-      version 'v1', using: :path
-
-      namespace :item do
-        get '/'
-      end
-
-      namespace :otherItem do
-        get '/'
-      end
-    end
-
-    class Base < Grape::API
-      prefix :api
-      mount Api::Item
-      add_swagger_documentation add_version: true
-    end
-  end
-
-  subject { described_class.new(Api::Base) }
-
-  let(:api_class) { subject.send(:api_class) }
-  let(:docs_url) { subject.send(:urls_for, api_class).first }
-
-  describe '.new' do
-    it 'accepts class name as a constant' do
-      expect(described_class.new(Api::Base).send(:api_class)).to eq(Api::Base)
-    end
-
-    it 'accepts class name as a string' do
-      expect(described_class.new('::Api::Base').send(:api_class)).to eq(Api::Base)
-    end
-  end
-
-  describe '#make_request' do
-    describe 'complete documentation' do
-      before do
-        subject.send(:make_request, docs_url)
-      end
-
-      describe 'not storing' do
-        it 'has no error' do
-          expect(subject.send(:error?)).to be false
-        end
-
-        it 'does not allow to save' do
-          expect(subject.send(:save_to_file?)).to be false
-        end
-
-        it 'requests doc url' do
-          expect(docs_url).to eql '/api/swagger_doc'
-        end
-      end
-
-      describe 'store it' do
-        before { ENV['store'] = 'true' }
-        after { ENV.delete('store') }
-
-        it 'allows to save' do
-          expect(subject.send(:save_to_file?)).to be true
-        end
-      end
-    end
-
-    describe 'documentation for resource' do
-      before do
-        ENV['resource'] = resource
-        subject.send(:make_request, docs_url)
-      end
-
-      let(:response) do
-        JSON.parse(
-          subject.send(:make_request, docs_url)
-        )
-      end
-
-      after { ENV.delete('resource') }
-
-      describe 'valid name' do
-        let(:resource) { 'otherItem' }
-
-        it 'has no error' do
-          expect(subject.send(:error?)).to be false
-        end
-
-        it 'requests doc url' do
-          expect(docs_url).to eql "/api/swagger_doc/#{resource}"
-        end
-
-        it 'has only one resource path' do
-          expect(response['paths'].length).to eql 1
-          expect(response['paths'].keys.first).to end_with resource
-        end
-      end
-
-      describe 'wrong name' do
-        let(:resource) { 'foo' }
-
-        it 'has error' do
-          expect(subject.send(:error?)).to be true
-        end
-      end
-
-      describe 'empty name' do
-        let(:resource) { nil }
-
-        it 'has no error' do
-          expect(subject.send(:error?)).to be false
-        end
-
-        it 'returns complete doc' do
-          expect(response['paths'].length).to eql 2
-        end
-      end
-    end
-
-    describe 'call it' do
-      before do
-        subject.send(:make_request, docs_url)
-      end
-      specify do
-        expect(subject).to respond_to :oapi
-        expect(subject.oapi).to be_a String
-        expect(subject.oapi).not_to be_empty
-      end
-    end
-  end
-
-  describe '#file' do
-    describe 'no store given' do
-      it 'returns swagger_doc.json' do
-        expect(subject.send(:file, docs_url)).to end_with 'swagger_doc.json'
-      end
-    end
-
-    describe 'store given' do
-      after { ENV.delete('store') }
-
-      describe 'boolean true' do
-        before { ENV['store'] = 'true' }
-
-        it 'returns swagger_doc.json' do
-          expect(subject.send(:file, docs_url)).to end_with 'swagger_doc.json'
-        end
-      end
-
-      describe 'name given' do
-        let(:name) { 'oapi_doc.json' }
-        before { ENV['store'] = name }
-
-        it 'returns swagger_doc.json' do
-          expect(subject.send(:file, docs_url)).to include(name.split('.')[0])
-        end
-      end
-    end
-  end
-end

data/spec/lib/operation_id_spec.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: false
-
-require 'spec_helper'
-
-describe GrapeSwagger::DocMethods::OperationId do
-  subject { described_class }
-
-  specify { expect(subject).to eql GrapeSwagger::DocMethods::OperationId }
-  specify { expect(subject).to respond_to :build }
-
-  describe 'build' do
-    let(:route) { Grape::Router::Route.new(method, '/path', requirements: {}) }
-
-    describe 'GET' do
-      let(:method) { 'GET' }
-      specify { expect(subject.build(route)).to eql 'get' }
-    end
-    describe 'get' do
-      let(:method) { 'get' }
-      specify { expect(subject.build(route)).to eql 'get' }
-    end
-    describe ':get' do
-      let(:method) { :get }
-      specify { expect(subject.build(route)).to eql 'get' }
-    end
-
-    describe 'path given' do
-      let(:method) { 'GET' }
-      it 'GET with path foo' do
-        expect(subject.build(route, 'foo')).to eql 'getFoo'
-      end
-      it 'GET with path /foo' do
-        expect(subject.build(route, '/foo')).to eql 'getFoo'
-      end
-      it 'GET with path bar/foo' do
-        expect(subject.build(route, 'bar/foo')).to eql 'getBarFoo'
-      end
-      it 'GET with path bar/foo{id}' do
-        expect(subject.build(route, 'bar/foo{id}')).to eql 'getBarFooId'
-      end
-      it 'GET with path /bar_foo{id}' do
-        expect(subject.build(route, '/bar_foo{id}')).to eql 'getBarFooId'
-      end
-      it 'GET with path /bar-foo{id}' do
-        expect(subject.build(route, '/bar-foo{id}')).to eql 'getBarFooId'
-      end
-      it 'GET with path /simple_test/bar-foo{id}' do
-        expect(subject.build(route, '/simple_test/bar-foo{id}')).to eql 'getSimpleTestBarFooId'
-      end
-      it 'GET path with optional format' do
-        expect(subject.build(route, 'foo(.{format})')).to eql 'getFoo(.Format)'
-      end
-    end
-  end
-end