grape-swagger 0.26.1 → 0.27.0

data/spec/issues/582_file_response_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#582 respond with a file' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_582 do
+        desc 'produces given',
+             success: File,
+             produces: ['application/pdf', 'text/csv']
+        get '/produces_given' do
+          'responds a file'
+        end
+
+        desc 'automatic produces',
+             success: 'file'
+        get '/automatic_produces' do
+          'responds a file'
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  describe 'produces given' do
+    let(:produces) { subject['paths']['/issue_582/produces_given']['get']['produces'] }
+    let(:response) { subject['paths']['/issue_582/produces_given']['get']['responses']['200'] }
+
+    specify do
+      expect(produces).to eql ['application/pdf', 'text/csv']
+      expect(response).to include 'schema'
+      expect(response['schema']).to eql 'type' => 'file'
+    end
+  end
+
+  describe 'automatic_produces' do
+    let(:produces) { subject['paths']['/issue_582/automatic_produces']['get']['produces'] }
+    let(:response) { subject['paths']['/issue_582/automatic_produces']['get']['responses']['200'] }
+
+    specify do
+      expect(produces).to eql ['application/octet-stream']
+      expect(response).to include 'schema'
+      expect(response['schema']).to eql 'type' => 'file'
+    end
+  end
+end

data/spec/issues/587_range_parameter_delimited_by_dash_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#587 process route with parameters delimited by dash' do
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :range_parameter do
+        desc 'Get a array with range'
+        get '/range/:range_start-:range_end' do
+          present []
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)['paths']
+  end
+
+  specify { expect(subject.keys).to include '/range_parameter/range/{range_start}-{range_end}' }
+  specify { expect(subject['/range_parameter/range/{range_start}-{range_end}']['get']['operationId']).to eql 'getRangeParameterRangeRangeStart-RangeEnd' }
+end

data/spec/lib/data_type_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::DataType do

data/spec/lib/endpoint_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/lib/extensions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::Extensions do

data/spec/lib/model_parsers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::ModelParsers do

data/spec/lib/move_params_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::MoveParams do
@@ -91,18 +93,19 @@ describe GrapeSwagger::DocMethods::MoveParams do
   end
 
   describe 'parent_definition_of_params' do
+    let(:path) { '/in_body' }
     describe 'POST' do
-      let(:params) { paths['/in_body'][:post][:parameters] }
+      let(:params) { paths[path][:post][:parameters] }
       let(:options)  do
         {
           method: 'POST'
         }
       end
-      let(:env) { Rack::MockRequest.env_for('/in_body', options) }
+      let(:env) { Rack::MockRequest.env_for(path, options) }
       let(:request) { Grape::Request.new(env) }
 
       specify do
-        subject.to_definition(params, request, definitions)
+        subject.to_definition(path, params, request, definitions)
         expect(params).to eql(
           [
             { name: 'InBody', in: 'body', required: true, schema: { '$ref' => '#/definitions/postInBody' } }
@@ -120,11 +123,11 @@ describe GrapeSwagger::DocMethods::MoveParams do
           method: 'PUT'
         }
       end
-      let(:env) { Rack::MockRequest.env_for('/in_body', options) }
+      let(:env) { Rack::MockRequest.env_for(path, options) }
       let(:request) { Grape::Request.new(env) }
 
       specify do
-        subject.to_definition(params, request, definitions)
+        subject.to_definition(path, params, request, definitions)
         expect(params).to eql(
           [
             { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },

data/spec/lib/oapi_tasks_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe GrapeSwagger::Rake::OapiTasks do

data/spec/lib/operation_id_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::OperationId do

data/spec/lib/optional_object_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::OptionalObject do
@@ -34,7 +36,10 @@ describe GrapeSwagger::DocMethods::OptionalObject do
     end
 
     describe 'option is a proc' do
-      let(:options) { { host: proc { |request| request.host =~ /^example/ ? '/api-example' : '/api' } } }
+      # rubocop:disable RegexpMatch
+      let(:options) do
+        { host: proc { |request| request.host =~ /^example/ ? '/api-example' : '/api' } }
+      end
       specify do
         expect(subject.build(key, options, request)).to eql '/api-example'
       end

data/spec/lib/parse_params_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::ParseParams do

data/spec/lib/path_string_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::PathString do
@@ -6,7 +8,14 @@ describe GrapeSwagger::DocMethods::PathString do
   specify { expect(subject).to eql GrapeSwagger::DocMethods::PathString }
   specify { expect(subject).to respond_to :build }
 
-  describe 'operation_id_object' do
+  describe 'path_string_object' do
+    specify 'The original route path is not mutated' do
+      route = Struct.new(:version, :path).new
+      route.path = '/foo/:dynamic/bar'
+      subject.build(route, add_version: true)
+      expect(route.path).to eq '/foo/:dynamic/bar'
+    end
+
     describe 'version' do
       describe 'defaults: given, true' do
         let(:options) { { add_version: true } }

data/spec/lib/produces_consumes_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::ProducesConsumes do

data/spec/lib/tag_name_description_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::TagNameDescription do
@@ -6,7 +8,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
     subject { described_class.send(:build_memo, tag) }
 
     specify do
-      expect(subject.keys).to eql [:name, :description]
+      expect(subject.keys).to eql %i(name description)
       expect(subject).to eql(
         name: tag,
         description: "Operations about #{tag.pluralize}"
@@ -15,11 +17,12 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
   end
 
   describe '#build' do
-    subject { described_class.build(paths) }
+    let(:object) { described_class.build(paths) }
+
     describe 'empty paths' do
       let(:paths) { {} }
       specify do
-        expect(subject).to eql([])
+        expect(object).to eql([])
       end
     end
 
@@ -30,7 +33,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
         end
 
         specify do
-          expect(subject).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
+          expect(object).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
         end
       end
 
@@ -40,7 +43,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
         end
 
         specify do
-          expect(subject).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
+          expect(object).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
         end
       end
 
@@ -53,7 +56,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
           end
 
           specify do
-            expect(subject).to eql [
+            expect(object).to eql [
               { name: 'tags_given', description: 'Operations about tags_givens' },
               { name: 'another_tag_given', description: 'Operations about another_tag_givens' }
             ]
@@ -68,7 +71,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
           end
 
           specify do
-            expect(subject).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
+            expect(object).to eql [{ name: 'tags_given', description: 'Operations about tags_givens' }]
           end
         end
       end

data/spec/lib/version_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GrapeSwagger::DocMethods::Version do
@@ -7,7 +9,7 @@ describe GrapeSwagger::DocMethods::Version do
   describe 'grape 0.16.2 version' do
     let(:version) { '[:v1, :v2]' }
     it { is_expected.to be_a Array }
-    it { is_expected.to eql [:v1, :v2] }
+    it { is_expected.to eql %i(v1 v2) }
   end
 
   describe 'newer grape versions' do
@@ -18,9 +20,9 @@ describe GrapeSwagger::DocMethods::Version do
     end
 
     describe 'as Array' do
-      let(:version) { [:v1, :v2] }
+      let(:version) { %i(v1 v2) }
       it { is_expected.to be_a Array }
-      it { is_expected.to eql [:v1, :v2] }
+      it { is_expected.to eql %i(v1 v2) }
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'coveralls'
 
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
 SimpleCov.start do
   add_filter 'spec/'
   add_filter 'example/'
 end
-
 Coveralls.wear!
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

data/spec/support/empty_model_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class EmptyClass
 end
 

data/spec/support/grape_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class GrapeVersion
   class << self
     def current_version

data/spec/support/mock_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   class MockParser
     attr_reader :model

data/spec/support/model_parsers/entity_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_context 'entity swagger example' do
   before :all do
     module Entities

data/spec/support/model_parsers/mock_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_context 'mock swagger example' do
   before :all do
     module Entities

data/spec/support/model_parsers/representable_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'representable/json'
 
 RSpec.shared_context 'representable swagger example' do

data/spec/support/namespace_tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_context 'namespace example' do
   before :all do
     module TheApi

data/spec/support/the_paths_definitions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_context 'the api paths/defs' do
   let(:paths) do
     {

data/spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'body parameter definitions' do

data/spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'definitions/models' do

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 def details
   <<-DETAILS
-# Burgers in Heaven
+    # Burgers in Heaven
 
-> A burger doesn't come for free
+    > A burger doesn't come for free
 
-If you want to reserve a burger in heaven, you have to do
-some crazy stuff on earth.
+    If you want to reserve a burger in heaven, you have to do
+    some crazy stuff on earth.
 
-```
-def do_good
-puts 'help people'
-end
-```
+    ```
+    def do_good
+    puts 'help people'
+    end
+    ```
 
-* _Will go to Heaven:_ Probably
-* _Will go to Hell:_ Probably not
-DETAILS
+    * _Will go to Heaven:_ Probably
+    * _Will go to Hell:_ Probably not
+  DETAILS
 end
 
 describe 'details' do

data/spec/swagger_v2/api_swagger_v2_extensions_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'extensions' do

data/spec/swagger_v2/api_swagger_v2_format-content_type_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'format, content_type' do