Merge pull request #21 from cutalion/https_base_path

Use Rack::Request base_url (to make proper urls for https)

Author: tim-vandecasteele

lib/grape-swagger.rb

@@ -70,7 +70,7 @@ def self.setup(options)
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: base_path || "http://#{env['HTTP_HOST']}",
+                basePath: base_path || request.base_url,
                 operations:[],
                 apis: routes_array
               }
@@ -102,7 +102,7 @@ def self.setup(options)
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: base_path || "http://#{env['HTTP_HOST']}",
+                basePath: base_path || request.base_url,
                 resourcePath: "",
                 apis: routes_array
               }

spec/grape-swagger-helper_spec.rb

@@ -2,87 +2,87 @@
 
 describe "helpers" do
 
-	before(:all) do
-		class HelperTestAPI < Grape::API
-			add_swagger_documentation
-		end
+  before(:all) do
+    class HelperTestAPI < Grape::API
+      add_swagger_documentation
+    end
 
-		@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 = 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
 
-	end
+  end
 
-	context "parsing parameters" do
-		it "should parse params as query strings for a GET" do
-			params = {
-				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}
-			]
-		end
+  context "parsing parameters" do
+    it "should parse params as query strings for a GET" do
+      params = {
+        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}
+      ]
+    end
 
-		it "should parse params as body for a POST" do
-			params = {
-				name: {type: 'String', :desc =>"A name", required: true },
-				level: 'max'
-			}
-			path = "/coolness"
-			method = "POST"
-			@api.parse_params(params, path, method).should ==
-			[
-				{paramType: "body", name: :name, description:"A name", dataType: "String", required: true},
-				{paramType: "body", name: :level, description:"", dataType: "String", required: false}
-			]
-		end
-	end
+    it "should parse params as body for a POST" do
+      params = {
+        name: {type: 'String', :desc =>"A name", required: true },
+        level: 'max'
+      }
+      path = "/coolness"
+      method = "POST"
+      @api.parse_params(params, path, method).should ==
+        [
+          {paramType: "body", name: :name, description:"A name", dataType: "String", required: true},
+          {paramType: "body", name: :level, description:"", dataType: "String", required: false}
+      ]
+    end
+  end
 
-	context "parsing the path" do
-		it "should parse the path" do
-			path = ":abc/def(.:format)"
-			@api.parse_path(path, nil).should == "{abc}/def.{format}"
-		end
+  context "parsing the path" do
+    it "should parse 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
       path = "abc/:def_g(.:format)"
-			@api.parse_path(path, nil).should == "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
       path = "abc/:sha1(.:format)"
-			@api.parse_path(path, nil).should == "abc/{sha1}.{format}"
+      @api.parse_path(path, nil).should == "abc/{sha1}.{format}"
     end
 
     it "should parse 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}"
+      @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
-			path = ":abc/{version}/def(.:format)"
-			@api.parse_path(path, 'v1').should == "{abc}/v1/def.{format}"
-		end
-	end
+    it "should parse 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}
-			]
-		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}
+      ]
+    end
+  end
 
 end

spec/non_default_api_spec.rb

@@ -202,5 +202,31 @@ def app; SimpleApiWithVersion end
     end
   end
 
+  context "protected API" do
+    before(:all) do
+      class ProtectedApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+  
+      class SimpleApiWithProtection < Grape::API
+        mount ProtectedApi
+        add_swagger_documentation
+      end
+    end
+  
+    def app; SimpleApiWithProtection; end
+
+    it "should use https schema in mount point" do
+      get '/swagger_doc', {}, 'rack.url_scheme' => 'https'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"https://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/something.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}" 
+    end
 
+    it "should use https schema in endpoint doc" do
+      get '/swagger_doc/something', {}, 'rack.url_scheme' => 'https'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"https://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    end
+  end
 end