grape-swagger 0.3.0 → 0.4.0

data/README.markdown

@@ -33,7 +33,15 @@ module API
 end
 ```
 
-To explore your API, either download [Swagger UI](https://github.com/wordnik/swagger-ui) and set it up yourself or go to the [online swagger demo](http://petstore.swagger.wordnik.com/) and enter your localhost url documentation root in the url field (probably something in the line of http://localhost:3000/swagger_doc.json)
+To explore your API, either download [Swagger UI](https://github.com/wordnik/swagger-ui) and set it up yourself or go to the [online swagger demo](http://petstore.swagger.wordnik.com/) and enter your localhost url documentation root in the url field (probably something in the line of http://localhost:3000/swagger_doc.json). 
+If you use the online demo, make sure your API supports foreign requests by enabling CORS in grape, otherwise you'll see the API description, but requests on the API won't return. You can do this by putting below code in your Grape API definition:
+
+```` ruby
+before do
+    header['Access-Control-Allow-Origin'] = '*'
+    header['Access-Control-Request-Method'] = '*'
+end
+````
 
 ## Configure
 You can pass a hash with some configuration possibilities to ```add_swagger_documentation```, all of these are optional:

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/grape-swagger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "grape-swagger"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Vandecasteele"]
-  s.date = "2012-10-19"
+  s.date = "2013-03-28"
   s.description = "A simple way to add proper auto generated documentation - that can be displayed with swagger - to your inline described grape API"
   s.email = "tim.vandecasteele@gmail.com"
   s.extra_rdoc_files = [

data/lib/grape-swagger.rb

@@ -11,7 +11,8 @@ module Grape
         original_mount mounts
         @combined_routes ||= {}
         mounts::routes.each do |route|
-          resource = route.route_path.match('\/(\w*?)[\.\/\(]').captures.first || '/'
+          resource = route.route_path.match('\/(\w*?)[\.\/\(]').captures.first
+          next if resource.empty?
           @combined_routes[resource.downcase] ||= []
           @combined_routes[resource.downcase] << route
         end
@@ -64,13 +65,13 @@ module Grape
                 routes.reject!{ |route, value| "/#{route}/".index(parse_path(@@mount_path, nil) << '/') == 0 }
               end
 
-              routes_array = routes.keys.map do |route|
-                  { :path => "#{@@mount_path}/#{route}.{format}" }
+              routes_array = routes.keys.map do |local_route|
+                  { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}.{format}" }
               end
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: base_path || "http://#{env['HTTP_HOST']}",
+                basePath: base_path || request.base_url,
                 operations:[],
                 apis: routes_array
               }
@@ -86,23 +87,26 @@ module Grape
               routes = @@target_class::combined_routes[params[:name]]
               routes_array = routes.map do |route|
                 notes = route.route_notes && @@markdown ? Kramdown::Document.new(route.route_notes.strip_heredoc).to_html : route.route_notes
-                {
-                  :path => parse_path(route.route_path, api_version),
-                  :operations => [{
+                http_codes = parse_http_codes route.route_http_codes
+                operations = {
                     :notes => notes,
                     :summary => route.route_description || '',
                     :nickname   => route.route_method + route.route_path.gsub(/[\/:\(\)\.]/,'-'),
                     :httpMethod => route.route_method,
                     :parameters => parse_header_params(route.route_headers) +
                       parse_params(route.route_params, route.route_path, route.route_method)
-                  }]
+                }
+                operations.merge!({:errorResponses => http_codes}) unless http_codes.empty?
+                {
+                  :path => parse_path(route.route_path, api_version),
+                  :operations => [operations]
                 }
               end
 
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: base_path || "http://#{env['HTTP_HOST']}",
+                basePath: base_path || request.base_url,
                 resourcePath: "",
                 apis: routes_array
               }
@@ -158,16 +162,22 @@ module Grape
             def parse_path(path, version)
               # adapt format to swagger format
               parsed_path = path.gsub('(.:format)', '.{format}')
-              # This is attempting to emulate the behavior of 
-              # Rack::Mount::Strexp. We cannot use Strexp directly because 
-              # all it does is generate regular expressions for parsing URLs. 
-              # TODO: Implement a Racc tokenizer to properly generate the 
+              # This is attempting to emulate the behavior of
+              # Rack::Mount::Strexp. We cannot use Strexp directly because
+              # all it does is generate regular expressions for parsing URLs.
+              # TODO: Implement a Racc tokenizer to properly generate the
               # parsed path.
               parsed_path = parsed_path.gsub(/:([a-zA-Z_]\w*)/, '{\1}')
               # add the version
               parsed_path = parsed_path.gsub('{version}', version) if version
               parsed_path
             end
+            def parse_http_codes codes
+              codes ||= {}
+              codes.collect do |k, v|
+                {:code => k, :reason => v}
+              end
+            end
           end
         end
       end

data/spec/grape-swagger-helper_spec.rb

@@ -2,87 +2,87 @@ require 'spec_helper'
 
 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

data/spec/non_default_api_spec.rb

@@ -61,6 +61,38 @@ describe "options: " do
     end
   end
 
+  context "mounting in a versioned api" do
+    before(:all) do
+      class SimpleApiToMountInVersionedApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithVersionInPath < Grape::API
+        version 'v1', :using => :path
+
+        mount SimpleApiToMountInVersionedApi
+        add_swagger_documentation
+      end
+    end
+
+    def app; SimpleApiWithVersionInPath end
+
+    it "should get the documentation on a versioned path /v1/swagger_doc" do
+      get '/v1/swagger_doc'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/v1/swagger_doc/something.{format}\"}, {:path=>\"/v1/swagger_doc/swagger_doc.{format}\"}]}"
+    end
+
+    it "should get the resource specific documentation on a versioned path /v1/swagger_doc/something" do
+      get '/v1/swagger_doc/something'
+      last_response.status.should == 200
+    end
+
+  end
+
+
   context "overruling hiding the documentation paths" do
     before(:all) do
       class HideDocumentationPathMountedApi < Grape::API
@@ -80,7 +112,7 @@ describe "options: " do
 
     it "it doesn't show the documentation path on /swagger_doc" 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}\"}]}" 
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/something.{format}\"}]}"
     end
   end
 
@@ -143,32 +175,58 @@ describe "options: " do
       last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>\"<p><em>test</em></p>\\n\", :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
     end
   end
-  
+
   context "versioned API" do
     before(:all) do
       class VersionedMountedApi < Grape::API
         prefix 'api'
         version 'v1'
-  
+
         desc 'this gets something'
         get '/something' do
           {:bla => 'something'}
         end
       end
-  
+
       class SimpleApiWithVersion < Grape::API
         mount VersionedMountedApi
         add_swagger_documentation :api_version => "v1"
       end
     end
-  
+
     def app; SimpleApiWithVersion end
-  
+
     it "parses version and places it in the path" do
       get '/swagger_doc/api'
       last_response.body.should == "{:apiVersion=>\"v1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/api/v1/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-api--version-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
     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

data/spec/simple_mounted_api_spec.rb

@@ -3,18 +3,27 @@ require 'spec_helper'
 describe "a simple mounted api" do
   before(:all) do
     class SimpleMountedApi < Grape::API
+      desc "Document root"
+      get do
+      end
+
       desc 'this gets something', {
         :notes => '_test_'
       }
+
       get '/simple' do
         {:bla => 'something'}
       end
-      
+
       desc 'this gets something else', {
         :headers => {
-          "XAuthToken" => {description: "A required header.", required: true}, 
+          "XAuthToken" => {description: "A required header.", required: true},
           "XOtherHeader" => {description: "An optional header.", required: false}
-        }
+        },
+	:http_codes => {
+		403 => "invalid pony",
+		405 => "no ponies left!"
+	}
       }
       get '/simple_with_headers' do
         {:bla => 'something_else'}
@@ -41,6 +50,6 @@ describe "a simple mounted api" do
 
   it "retrieves the documentation for mounted-api that includes headers" do
     get '/swagger_doc/simple_with_headers'
-    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/simple_with_headers.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something else\", :nickname=>\"GET-simple_with_headers---format-\", :httpMethod=>\"GET\", :parameters=>[{:paramType=>\"header\", :name=>\"XAuthToken\", :description=>\"A required header.\", :dataType=>\"String\", :required=>true}, {:paramType=>\"header\", :name=>\"XOtherHeader\", :description=>\"An optional header.\", :dataType=>\"String\", :required=>false}]}]}]}"
+    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/simple_with_headers.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something else\", :nickname=>\"GET-simple_with_headers---format-\", :httpMethod=>\"GET\", :parameters=>[{:paramType=>\"header\", :name=>\"XAuthToken\", :description=>\"A required header.\", :dataType=>\"String\", :required=>true}, {:paramType=>\"header\", :name=>\"XOtherHeader\", :description=>\"An optional header.\", :dataType=>\"String\", :required=>false}], :errorResponses=>[{:code=>403, :reason=>\"invalid pony\"}, {:code=>405, :reason=>\"no ponies left!\"}]}]}]}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -194,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3307258424823840533
+      hash: -2543404597308803068
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: