Be more specific in specs, use JSON output.

Author: dblock

lib/grape-swagger.rb

@@ -67,6 +67,7 @@ def self.setup(options)
               routes_array = routes.keys.map do |local_route|
                   { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}#{@@hide_format ? '' : '.{format}'}" }
               end
+
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
@@ -174,7 +175,7 @@ def parse_path(path, version)
             def parse_http_codes codes
               codes ||= {}
               codes.collect do |k, v|
-                {:code => k, :reason => v}
+                { code: k, reason: v }
               end
             end
 

spec/default_api_spec.rb

@@ -2,11 +2,12 @@
 
 describe "Default API" do
 
-  before(:all) do
+  before :all do
     class NotAMountedApi < Grape::API
-      desc 'this gets something'
+      format :json
+      desc 'This gets something.'
       get '/something' do
-        {:bla => 'something'}
+        { bla: 'something' }
       end
       add_swagger_documentation
     end
@@ -16,7 +17,16 @@ def app; NotAMountedApi; end
 
   it "should document something" do
     get '/swagger_doc'
-    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}\"}]}"
+    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}" }
+      ]
+    }
   end
 
 end

spec/grape-swagger-helper_spec.rb

@@ -2,85 +2,86 @@
 
 describe "helpers" do
 
-  before(:all) do
+  before :all do
     class HelperTestAPI < Grape::API
       add_swagger_documentation
     end
+  end
 
+  before :each do
     @api = Object.new
+
     # after injecting grape-swagger into the Test API we get the helper methods
     # back from the first endpoint's class (the API mounted by grape-swagger
     # to serve the swagger_doc
-    @api.extend HelperTestAPI.endpoints.first.options[:app].helpers
 
+    @api.extend HelperTestAPI.endpoints.first.options[:app].helpers
   end
 
   context "parsing parameters" do
-    it "should parse params as query strings for a GET" do
+    it "parses params as query strings for a GET" do
       params = {
-        name: {type: 'String', :desc => "A name", required: true },
+        name: { type: 'String', desc: "A name", required: true },
         level: 'max'
       }
       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}
+      @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 }
       ]
     end
 
-    it "should parse params as form for a POST" do
+    it "parses params as form for a POST" do
       params = {
-        name: {type: 'String', :desc =>"A name", required: true },
+        name: { type: 'String', :desc => "A name", required: true },
         level: 'max'
       }
       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}
+      @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 }
       ]
     end
   end
 
   context "parsing the path" do
-    it "should parse the path" do
+    it "parses the path" do
       path = ":abc/def(.:format)"
       @api.parse_path(path, nil).should == "{abc}/def.{format}"
     end
 
-    it "should parse a path that has vars with underscores in the name" do
+    it "parses a path that has vars with underscores in the name" do
       path = "abc/:def_g(.:format)"
       @api.parse_path(path, nil).should == "abc/{def_g}.{format}"
-
     end
 
-    it "should parse a path that has vars with numbers in the name" do
+    it "parses a path that has vars with numbers in the name" do
       path = "abc/:sha1(.:format)"
       @api.parse_path(path, nil).should == "abc/{sha1}.{format}"
     end
 
-    it "should parse a path that has multiple variables" do
+    it "parses a path that has multiple variables" do
       path1 = "abc/:def/:geh(.:format)"
       path2 = "abc/:def:geh(.:format)"
       @api.parse_path(path1, nil).should == "abc/{def}/{geh}.{format}"
       @api.parse_path(path2, nil).should == "abc/{def}{geh}.{format}"
     end
 
-    it "should parse the path with a specified version" do
+    it "parses the path with a specified version" do
       path = ":abc/{version}/def(.:format)"
       @api.parse_path(path, 'v1').should == "{abc}/v1/def.{format}"
     end
   end
 
   context "parsing header parameters" do
-    it "should parse params for the header" do
-      params = {"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}
+    it "parses params for the header" do
+      params = {
+        "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 }
       ]
     end
   end

spec/grape-swagger_spec.rb

@@ -10,6 +10,4 @@
     Grape::API.should respond_to :add_swagger_documentation
   end
 
-
-
 end