grape-swagger 0.11.0 → 0.20.0

data/spec/{namespaced_api_spec.rb → swagger_v2/namespaced_api_spec.rb}

@@ -4,8 +4,8 @@ describe 'namespace' do
   context 'at root level' do
     def app
       Class.new(Grape::API) do
-        namespace :aspace, desc: 'Description for aspace' do
-          get '/'
+        namespace :aspace do
+          get '/', desc: 'Description for aspace'
         end
         add_swagger_documentation format: :json
       end
@@ -13,7 +13,7 @@ describe 'namespace' do
 
     subject do
       get '/swagger_doc'
-      JSON.parse(last_response.body)['apis'][0]
+      JSON.parse(last_response.body)['paths']['/aspace']['get']
     end
 
     it 'shows the namespace description in the json spec' do
@@ -24,8 +24,8 @@ describe 'namespace' do
   context 'mounted' do
     def app
       namespaced_api = Class.new(Grape::API) do
-        namespace :aspace, desc: 'Description for aspace' do
-          get '/'
+        namespace :bspace do
+          get '/', desc: 'Description for aspace'
         end
       end
 
@@ -37,31 +37,11 @@ describe 'namespace' do
 
     subject do
       get '/swagger_doc'
-      JSON.parse(last_response.body)['apis'][0]
+      JSON.parse(last_response.body)['paths']['/bspace']['get']
     end
 
     it 'shows the namespace description in the json spec' do
       expect(subject['description']).to eql('Description for aspace')
     end
   end
-
-  context 'with camelcase endpoints' do
-    def app
-      Class.new(Grape::API) do
-        namespace :SomeSpace, desc: 'Description for some space' do
-          get '/'
-        end
-        add_swagger_documentation format: :json
-      end
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)['apis'][0]
-    end
-
-    it 'shows the namespace description in the json spec' do
-      expect(subject['description']).to eql('Description for some space')
-    end
-  end
 end

data/spec/{param_type_spec.rb → swagger_v2/param_type_spec.rb}

@@ -5,9 +5,8 @@ describe 'Params Types' do
     Class.new(Grape::API) do
       format :json
 
-      desc 'description', nickname: 'desc', params: { input1: { type: Integer, param_type: 'query' } }
       params do
-        requires :input2, type: String, documentation: { param_type: 'query' }
+        requires :input, type: String
       end
       post :action do
       end
@@ -20,14 +19,17 @@ describe 'Params Types' do
     get '/swagger_doc/action'
     expect(last_response.status).to eq 200
     body = JSON.parse last_response.body
-    body['apis'].first['operations'].flat_map { |o| o['parameters'] }
+    body['paths']["/action"]['post']['parameters']
   end
 
   it 'reads param type correctly' do
-    expect(subject).to match_array [
-      { 'paramType' => 'query', 'name' => 'input1', 'description' => '', 'type' => 'integer', 'required' => false, 'allowMultiple' => false, 'format' => 'int32' },
-      { 'paramType' => 'query', 'name' => 'input2', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false }
-    ]
+    expect(subject).to eq [{
+      "in"=>"formData",
+      "name"=>"input",
+      "description"=>nil,
+      "type"=>"string",
+      "required"=>true
+    }]
   end
 
   describe 'header params' do
@@ -48,7 +50,7 @@ describe 'Params Types' do
 
     it 'has consistent types' do
       types = subject.map { |param| param['type'] }
-      expect(types).to eq(%w(string string))
+      expect(types).to eq(%w(string))
     end
   end
 end

data/spec/{param_values_spec.rb → swagger_v2/param_values_spec.rb}

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'grape_version'
+# require 'grape_version'
 
 describe 'Convert values to enum or Range' do
   def app
@@ -38,16 +38,20 @@ describe 'Convert values to enum or Range' do
     get "/swagger_doc/#{request}"
     expect(last_response.status).to eq 200
     body = JSON.parse last_response.body
-    body['apis'].first['operations'].first['parameters']
+    body['paths']["/#{request}"]['post']['parameters']
   end
 
   context 'Plain array values' do
     subject(:plain_array) { first_parameter_info('plain_array') }
-
     it 'has values as array in enum' do
-      expect(plain_array).to eq [
-        { 'paramType' => 'form', 'name' => 'letter', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false, 'enum' => %w(a b c) }
-      ]
+      expect(plain_array).to eq [{
+        "in"=>"formData",
+        "name"=>"letter",
+        "description"=>nil,
+        "type"=>"string",
+        "required"=>true,
+        "enum"=>["a", "b", "c"]
+      }]
     end
   end
 
@@ -55,9 +59,14 @@ describe 'Convert values to enum or Range' do
     subject(:array_in_proc) { first_parameter_info('array_in_proc') }
 
     it 'has proc returned values as array in enum' do
-      expect(array_in_proc).to eq [
-        { 'paramType' => 'form', 'name' => 'letter', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false, 'enum' => %w(d e f) }
-      ]
+      expect(array_in_proc).to eq [{
+        "in"=>"formData",
+        "name"=>"letter",
+        "description"=>nil,
+        "type"=>"string",
+        "required"=>true,
+        "enum"=>["d", "e", "f"]
+      }]
     end
   end
 
@@ -65,17 +74,28 @@ describe 'Convert values to enum or Range' do
     subject(:range_letter) { first_parameter_info('range_letter') }
 
     it 'has letter range values' do
-      expect(range_letter).to eq [
-        { 'paramType' => 'form', 'name' => 'letter', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false }
-      ]
+      expect(range_letter).to eq [{
+        "in"=>"formData",
+        "name"=>"letter",
+        "description"=>nil,
+        "type"=>"string",
+        "required"=>true
+      }]
     end
 
     subject(:range_integer) { first_parameter_info('range_integer') }
 
     it 'has integer range values' do
-      expect(range_integer).to eq [
-        { 'paramType' => 'form', 'name' => 'integer', 'description' => '', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32', 'minimum' => -5, 'maximum' => 5 }
-      ]
+      expect(range_integer).to eq [{
+        "in"=>"formData",
+        "name"=>"integer",
+        "description"=>nil,
+        "type"=>"integer",
+        "required"=>true,
+        "format"=>"int32",
+        "minimum"=>-5,
+        "maximum"=>5
+      }]
     end
   end
 end
@@ -105,16 +125,21 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
     get "/swagger_doc/#{request}"
     expect(last_response.status).to eq 200
     body = JSON.parse last_response.body
-    body['apis'].first['operations'].first['parameters']
+    body['paths']["/#{request}"]['post']['parameters']
   end
 
   context 'Non array in proc values' do
     subject(:non_array_in_proc) { first_parameter_info('non_array_in_proc') }
 
     it 'has proc returned value as string in enum' do
-      expect(non_array_in_proc).to eq [
-        { 'paramType' => 'form', 'name' => 'letter', 'description' => '', 'type' => 'string', 'required' => true, 'allowMultiple' => false, 'enum' => 'string' }
-      ]
+      expect(non_array_in_proc).to eq [{
+        "in"=>"formData",
+        "name"=>"letter",
+        "description"=>nil,
+        "type"=>"string",
+        "required"=>true,
+        "enum"=>"string"
+      }]
     end
   end
 
@@ -122,9 +147,14 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
     subject(:range_float) { first_parameter_info('range_float') }
 
     it 'has float range values as string' do
-      expect(range_float).to eq [
-        { 'paramType' => 'form', 'name' => 'float', 'description' => '', 'type' => 'number', 'format' => 'float', 'required' => true, 'allowMultiple' => false }
-      ]
+      expect(range_float).to eq [{
+        "in"=>"formData",
+        "name"=>"float",
+        "description"=>nil,
+        "type"=>"number",
+        "required"=>true,
+        "format"=>"float"
+      }]
     end
   end
 end

data/spec/swagger_v2/params_array_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'Group Params as Array' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :required_group, type: Array do
+          requires :required_param_1
+          requires :required_param_2
+        end
+      end
+      post '/groups' do
+        { 'declared_params' => declared(params) }
+      end
+
+      params do
+        requires :typed_group, type: Array do
+          requires :id, type: Integer, desc: "integer given"
+          requires :name, type: String, desc: "string given"
+          optional :email, type: String, desc: "email given"
+          optional :others, type: Integer, values: [1, 2, 3]
+        end
+      end
+      post '/type_given' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe "retrieves the documentation for grouped parameters" do
+    subject do
+      get '/swagger_doc/groups'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/groups']['post']['parameters']).to eql([
+        {"in"=>"formData", "name"=>"required_group[][required_param_1]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}},
+        {"in"=>"formData", "name"=>"required_group[][required_param_2]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}}
+      ])
+    end
+  end
+
+  describe "retrieves the documentation for typed group parameters" do
+    subject do
+      get '/swagger_doc/type_given'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/type_given']['post']['parameters']).to eql([
+        {"in"=>"formData", "name"=>"typed_group[][id]", "description"=>"integer given", "required"=>true, "type"=>"array", "items"=>{"type"=>"integer"}},
+        {"in"=>"formData", "name"=>"typed_group[][name]", "description"=>"string given", "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}},
+        {"in"=>"formData", "name"=>"typed_group[][email]", "description"=>"email given", "required"=>false, "type"=>"array", "items"=>{"type"=>"string"}},
+        {"in"=>"formData", "name"=>"typed_group[][others]", "description"=>nil, "required"=>false, "type"=>"array", "items"=>{"type"=>"integer"}, "enum"=>[1, 2, 3]}
+      ])
+    end
+  end
+end

data/spec/swagger_v2/params_hash_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe 'Group Params as Hash' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :required_group, type: Hash do
+          requires :required_param_1
+          requires :required_param_2
+        end
+      end
+      post '/use_groups' do
+        { 'declared_params' => declared(params) }
+      end
+
+      params do
+        requires :typed_group, type: Hash do
+          requires :id, type: Integer, desc: "integer given"
+          requires :name, type: String, desc: "string given"
+          optional :email, type: String, desc: "email given"
+          optional :others, type: Integer, values: [1, 2, 3]
+        end
+      end
+      post '/use_given_type' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe "grouped parameters" do
+    subject do
+      get '/swagger_doc/use_groups'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/use_groups']['post']).to include('parameters')
+      expect(subject['paths']['/use_groups']['post']['parameters']).to eql([
+        {"in"=>"formData", "name"=>"required_group[required_param_1]", "description"=>nil, "type"=>"string", "required"=>true},
+        {"in"=>"formData", "name"=>"required_group[required_param_2]", "description"=>nil, "type"=>"string", "required"=>true}
+      ])
+    end
+  end
+
+  describe "grouped parameters with given type" do
+    subject do
+      get '/swagger_doc/use_given_type'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/use_given_type']['post']).to include('parameters')
+      expect(subject['paths']['/use_given_type']['post']['parameters']).to eql([
+        {"in"=>"formData", "name"=>"typed_group[id]", "description"=>"integer given", "type"=>"integer", "required"=>true, "format"=>"int32"},
+        {"in"=>"formData", "name"=>"typed_group[name]", "description"=>"string given", "type"=>"string", "required"=>true},
+        {"in"=>"formData", "name"=>"typed_group[email]", "description"=>"email given", "type"=>"string", "required"=>false},
+        {"in"=>"formData", "name"=>"typed_group[others]", "description"=>nil, "type"=>"integer", "required"=>false, "format"=>"int32", "enum"=>[1, 2, 3]}
+      ])
+    end
+  end
+end

data/spec/swagger_v2/params_nested_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'nested group params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :a_array, type: Array do
+          requires :param_1, type: Integer
+          requires :b_array, type: Array do
+            requires :param_2, type: String
+          end
+        end
+      end
+      post '/nested_array' do
+        { 'declared_params' => declared(params) }
+      end
+
+      params do
+        requires :a_hash, type: Hash do
+          requires :param_1, type: Integer
+          requires :b_hash, type: Hash do
+            requires :param_2, type: String
+          end
+        end
+      end
+      post '/nested_hash' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe "retrieves the documentation for nested array parameters" do
+    subject do
+      get '/swagger_doc/nested_array'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/nested_array']['post']['parameters']).to eql([
+        {"in"=>"formData", "name"=>"a_array[][param_1]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"integer"}},
+        {"in"=>"formData", "name"=>"a_array[][b_array][][param_2]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}}
+      ])
+    end
+  end
+
+  describe "retrieves the documentation for nested hash parameters" do
+    subject do
+      get '/swagger_doc/nested_hash'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/nested_hash']['post']['parameters']).to eql([
+        {"in"=>"formData", "name"=>"a_hash[param_1]", "description"=>nil, "required"=>true, "type"=>"integer", "format"=>"int32"},
+        {"in"=>"formData", "name"=>"a_hash[b_hash][param_2]", "description"=>nil, "required"=>true, "type"=>"string"}
+      ])
+    end
+  end
+end

data/spec/{reference_entity.rb → swagger_v2/reference_entity.rb}

@@ -28,15 +28,17 @@ describe 'referenceEntity' do
              params: Entities::Kind.documentation.slice(:something),
              entity: Entities::Kind,
              http_codes: [
-               [200, 'OK', Entities::Kind]
+               { code: 200, message: 'OK', model: Entities::Kind }
              ]
-
+        params do
+          optional :something, desc: 'something as parameter'
+        end
         get '/kind' do
           kind = OpenStruct.new text: 'kind'
           present kind, with: Entities::Kind
         end
 
-        add_swagger_documentation models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
+        add_swagger_documentation #models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
       end
     end
   end
@@ -51,30 +53,23 @@ describe 'referenceEntity' do
   end
 
   it 'should document specified models' do
-    expect(subject['apis'][0]['operations'][0]['parameters']).to eq [{
-      'paramType' => 'query',
-      'name' => 'something',
-      'description' => 'Something interesting.',
-      'type' => 'MySomething',
-      'required' => false,
-      'allowMultiple' => false
+    expect(subject['paths']['/kind']['get']['parameters']).to eq [{
+      "in"=>"query",
+      "name"=>"something",
+      "description"=>"something as parameter",
+      "type"=>"string",
+      "required"=>false,
+      "allowMultiple"=>false
     }]
 
-    expect(subject['models'].keys).to include 'MySomething'
-    expect(subject['models']['MySomething']).to eq(
-      'id' => 'MyAPI::Something',
-      'properties' => {
-        'text' => { 'type' => 'string', 'description' => 'Content of something.' }
-      }
+    expect(subject['definitions'].keys).to include 'Something'
+    expect(subject['definitions']['Something']).to eq(
+      "type"=>"object", "properties"=>{"text"=>{"type"=>"string"}}
     )
 
-    expect(subject['models'].keys).to include 'MyKind'
-    expect(subject['models']['MyKind']).to eq(
-      'id' => 'MyKind',
-      'properties' => {
-        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
-        'something' => { '$ref' => 'MySomething', 'description' => 'Something interesting.' }
-      }
+    expect(subject['definitions'].keys).to include 'Kind'
+    expect(subject['definitions']['Kind']).to eq(
+      "properties" => {"something"=>{"$ref"=>"#/definitions/Something"}}
     )
   end
 end