Updated to 1.2 w/ passing tests

.gitignore

@@ -29,3 +29,4 @@ test/dummy/.sass-cache
 # For MacOS:
 #
 .DS_Store
+.project

spec/api_models_spec.rb

@@ -28,8 +28,10 @@ def app; ModelsApi; end
     get '/swagger_doc'
     JSON.parse(last_response.body).should == {
       "apiVersion" => "0.1",
-      "swaggerVersion" => "1.1",
+      "swaggerVersion" => "1.2",
       "basePath" => "http://example.org",
+      "info" => {},
+      "produces" => ["application/json"],
       "operations" => [],
       "apis" => [
         { "path" => "/swagger_doc/something.{format}" },
@@ -38,34 +40,35 @@ def app; ModelsApi; end
     }
   end
 
-  it "should include response_class when specified" do
+  it "should include type when specified" do
     get '/swagger_doc/something.json'
     JSON.parse(last_response.body).should == {
       "apiVersion" => "0.1",
-      "swaggerVersion" => "1.1",
+      "swaggerVersion" => "1.2",
       "basePath" => "http://example.org",
       "resourcePath" => "",
-      "apis" => [
-        { "path" => "/something.{format}",
-          "operations" => [
-            { "notes" => nil,
-              "responseClass" => "Something",
-              "summary" => "This gets something.",
-              "nickname" => "GET-something---format-",
-              "httpMethod" => "GET",
-              "parameters" => []
-            }
-          ]
-        }
-      ],
+      "apis" => [{
+        "path" => "/something.{format}",
+        "operations" => [{
+          "produces" => [
+            "application/json"
+          ],
+          "notes" => "",
+          "type" => "Something",
+          "summary" => "This gets something.",
+          "nickname" => "GET-something---format-",
+          "httpMethod" => "GET",
+          "parameters" => []
+        }]
+      }],
       "models" => {
         "Something" => {
           "id" => "Something",
           "name" => "Something",
           "properties" => {
             "text" => {
               "type" => "string",
-              "desc" => "Content of something."
+              "description" => "Content of something."
             }
           }
         }

spec/default_api_spec.rb

@@ -2,31 +2,91 @@
 
 describe "Default API" do
 
-  before :all do
-    class NotAMountedApi < Grape::API
-      format :json
-      desc 'This gets something.'
-      get '/something' do
-        { bla: 'something' }
+  context 'with no additional options' do
+    before :all do
+      class NotAMountedApi < Grape::API
+        format :json
+        desc 'This gets something.'
+        get '/something' do
+          { bla: 'something' }
+        end
+        add_swagger_documentation
+      end
+    end
+
+    def app; NotAMountedApi; end
+
+    it "should document something" do
+      get '/swagger_doc'
+      JSON.parse(last_response.body).should == {
+        "apiVersion" => "0.1",
+        "swaggerVersion" => "1.2",
+        "basePath" => "http://example.org",
+        "info" => {},
+        "produces" => ["application/json"],
+        "operations" => [],
+        "apis" => [
+          { "path" => "/swagger_doc/something.{format}" },
+          { "path" => "/swagger_doc/swagger_doc.{format}" }
+        ]
+      }
+    end
+
+    context "path inside the apis array" do
+      it "should start with a forward slash" do
+        get '/swagger_doc'
+        JSON.parse(last_response.body)['apis'].each do |api|
+          api['path'].should start_with "/"
+        end
       end
-      add_swagger_documentation
     end
   end
 
-  def app; NotAMountedApi; end
-
-  it "should document something" do
-    get '/swagger_doc'
-    JSON.parse(last_response.body).should == {
-      "apiVersion" => "0.1",
-      "swaggerVersion" => "1.1",
-      "basePath" => "http://example.org",
-      "operations" => [],
-      "apis" => [
-        { "path" => "/swagger_doc/something.{format}" },
-        { "path" => "/swagger_doc/swagger_doc.{format}" }
-      ]
-    }
+  context 'with API info' do
+    before :all do
+      class ApiInfoTest < Grape::API
+        format :json
+        add_swagger_documentation info: {
+          title: 'My API Title',
+          description: 'A description of my API',
+          license: 'Apache 2',
+          license_url: 'http://test.com',
+          terms_of_service_url: 'http://terms.com',
+          contact: 'support@test.com'
+        }
+      end
+      get '/swagger_doc'
+    end
+
+    def app; ApiInfoTest; end
+
+    subject do
+      JSON.parse(last_response.body)['info']
+    end
+
+    it 'should document API title' do
+      expect(subject['title']).to eql('My API Title')
+    end
+
+    it 'should document API description' do
+      expect(subject['description']).to eql('A description of my API')
+    end
+
+    it 'should document the license' do
+      expect(subject['license']).to eql('Apache 2')
+    end
+
+    it 'should document the license url' do
+      expect(subject['licenseUrl']).to eql('http://test.com')
+    end
+
+    it 'should document the terms of service url' do
+      expect(subject['termsOfServiceUrl']).to eql('http://terms.com')
+    end
+
+    it 'should document the contact email' do
+      expect(subject['contact']).to eql('support@test.com')
+    end
   end
 
 end

spec/grape-swagger_helper_spec.rb

@@ -27,8 +27,8 @@ class HelperTestAPI < Grape::API
       path = "/coolness"
       method = "GET"
       @api.parse_params(params, path, method).should == [
-        { paramType: "query", name: :name, description: "A name", dataType: "String", required: true },
-        { paramType: "query", name: :level, description: "", dataType: "String", required: false }
+        { paramType: "query", name: :name, description: "A name", type: "String", required: true },
+        { paramType: "query", name: :level, description: "", type: "String", required: false }
       ]
     end
 
@@ -40,8 +40,8 @@ class HelperTestAPI < Grape::API
       path = "/coolness"
       method = "POST"
       @api.parse_params(params, path, method).should == [
-        { paramType: "form", name: :name, description: "A name", dataType: "String", required: true },
-        { paramType: "form", name: :level, description: "", dataType: "String", required: false }
+        { paramType: "form", name: :name, description: "A name", type: "String", required: true },
+        { paramType: "form", name: :level, description: "", type: "String", required: false }
       ]
     end
 
@@ -57,7 +57,7 @@ class CustomType
         path = "/coolness"
         method = "GET"
         @api.parse_params(params, path, method).should == [
-          { paramType: "query", name: :option, description: "Custom option", dataType: "CustomType", required: false }
+          { paramType: "query", name: :option, description: "Custom option", type: "CustomType", required: false }
         ]
       end
     end
@@ -99,7 +99,7 @@ class CustomType
         "XAuthToken" => { description: "A required header.", required: true }
       }
       @api.parse_header_params(params).should == [
-        { paramType: "header", name: "XAuthToken", description: "A required header.", dataType: "String", required: true }
+        { paramType: "header", name: "XAuthToken", description: "A required header.", type: "String", required: true }
       ]
     end
   end

spec/hide_api_spec.rb

@@ -28,8 +28,10 @@ def app; HideApi end
     get '/swagger_doc.json'
     JSON.parse(last_response.body).should == {
       "apiVersion" => "0.1",
-      "swaggerVersion" => "1.1",
+      "swaggerVersion" => "1.2",
       "basePath" => "http://example.org",
+      "info" => {},
+      "produces" => ["application/xml", "application/json", "text/plain"],
       "operations" => [],
       "apis" => [
         { "path" => "/swagger_doc/simple.{format}" },
@@ -68,8 +70,10 @@ def app; HideNamespaceApi end
     get '/swagger_doc.json'
     JSON.parse(last_response.body).should == {
       "apiVersion" => "0.1",
-      "swaggerVersion" => "1.1",
+      "swaggerVersion" => "1.2",
       "basePath" => "http://example.org",
+      "info" => {},
+      "produces" => ["application/xml", "application/json", "text/plain"],
       "operations" => [],
       "apis" => [
         { "path" => "/swagger_doc/simple.{format}" },
@@ -82,23 +86,21 @@ def app; HideNamespaceApi end
     get '/swagger_doc/simple.json'
     JSON.parse(last_response.body).should == {
       "apiVersion" => "0.1",
-      "swaggerVersion" => "1.1",
+      "swaggerVersion" => "1.2",
       "basePath" => "http://example.org",
       "resourcePath" => "",
-      "apis" => [
-        {
-          "path" => "/simple/show.{format}",
-          "operations" => [
-            {
-              "notes" => nil,
-              "summary" => "Show this endpoint",
-              "nickname" => "GET-simple-show---format-",
-              "httpMethod" => "GET",
-              "parameters" => []
-            }
-          ]
-        }
-      ]
+      "apis" => [{
+        "path" => "/simple/show.{format}",
+        "operations" => [{
+          "produces" => ["application/xml", "application/json", "text/plain"],
+          "notes" => nil,
+          "notes" => "",
+          "summary" => "Show this endpoint",
+          "nickname" => "GET-simple-show---format-",
+          "httpMethod" => "GET",
+          "parameters" => []
+        }]
+      }]
     }
   end
 end