grape-swagger 0.5.0 → 0.6.0

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/CHANGELOG.markdown

@@ -0,0 +1,46 @@
+### Next Release
+
+### 0.6.0 (June 19, 2013)
+
+* Added Rails 4 support - [@jrhe](https://github.com/jrhe).
+* Fix: document APIs at root level - [@dblock](https://github.com/dblock).
+* Added support for procs in basepath - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Support both `:desc` and `:description` when describing parameters - [@dblock](https://github.com/dblock).
+* Fix: allow parameters such as `name[]` - [@dblock](https://github.com/dblock).
+
+### 0.5.0 (March 28, 2013)
+
+* Added Grape 0.5.0 support - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+
+### 0.4.0 (March 28, 2013)
+
+* Support https - [@cutalion](https://github.com/cutalion).
+
+### 0.3.0 (October 19, 2012)
+
+* Added version support - [@agileanimal](https://github.com/agileanimal), [@fknappe](https://github.com/fknappe).
+* Added support for nested parameters - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Added basic support for specifying parameters that need to be passed in the header - [@agileanimal](https://github.com/agileanimal).
+* Add possibility to hide the documentation paths in the generated swagger documentation - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+
+### 0.2.1 (August 17, 2012)
+
+* Added support for markdown in notes field - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Fix: compatibility with Rails - [@qwert666](https://github.com/qwert666).
+* Fix: swagger UI history - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+
+### 0.2.0 (July 27, 2012)
+
+* Use resource as root for swagger - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Added support for file uploads, and proper `paramType` - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Added tests - [@nathanvda](https://github.com/nathanvda).
+
+### 0.1.0 (July 19, 2012)
+
+* Added some configurability to the generated documentation - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Adapted to rails plugin structure - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+* Allowed cross origin, so swagger can be used from official site - [@tim-vandecasteele](https://github.com/tim-vandecasteele).
+
+### 0.0.0 (July 19, 2012)
+
+* Initial public release - [@tim-vandecasteele](https://github.com/tim-vandecasteele).

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/grape-swagger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "grape-swagger"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Vandecasteele"]
-  s.date = "2013-03-28"
+  s.date = "2013-06-19"
   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 = [
@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rvmrc",
+    ".travis.yml",
+    "CHANGELOG.markdown",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -27,6 +29,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "grape-swagger.gemspec",
     "lib/grape-swagger.rb",
+    "spec/default_api_spec.rb",
     "spec/grape-swagger-helper_spec.rb",
     "spec/grape-swagger_spec.rb",
     "spec/non_default_api_spec.rb",

data/lib/grape-swagger.rb

@@ -5,24 +5,21 @@ module Grape
     class << self
       attr_reader :combined_routes
 
-      alias original_mount mount
-
-      def mount(mounts)
-        original_mount mounts
-        @combined_routes ||= {}
-        mounts::routes.each do |route|
-          resource = route.route_path.match('\/(\w*?)[\.\/\(]').captures.first
-          next if resource.empty?
-          @combined_routes[resource.downcase] ||= []
-          @combined_routes[resource.downcase] << route
-        end
-      end
-
       def add_swagger_documentation(options={})
         documentation_class = create_documentation_class
 
         documentation_class.setup({:target_class => self}.merge(options))
         mount(documentation_class)
+
+        @combined_routes = {}
+        routes.each do |route|
+          resource = route.route_path.match('\/(\w*?)[\.\/\(]').captures.first
+          next if resource.empty?
+          resource.downcase!
+          @combined_routes[resource] ||= []
+          @combined_routes[resource] << route
+        end
+
       end
 
       private
@@ -43,7 +40,8 @@ module Grape
               :base_path => nil,
               :api_version => '0.1',
               :markdown => false,
-              :hide_documentation_path => false
+              :hide_documentation_path => false,
+              :hide_format => false
             }
             options = defaults.merge(options)
 
@@ -52,6 +50,7 @@ module Grape
             @@class_name = options[:class_name] || options[:mount_path].gsub('/','')
             @@markdown = options[:markdown]
             @@hide_documentation_path = options[:hide_documentation_path]
+            @@hide_format = options[:hide_format]
             api_version = options[:api_version]
             base_path = options[:base_path]
 
@@ -66,12 +65,12 @@ module Grape
               end
 
               routes_array = routes.keys.map do |local_route|
-                  { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}.{format}" }
+                  { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}#{@@hide_format ? '' : '.{format}'}" }
               end
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: base_path || request.base_url,
+                basePath: parse_base_path(base_path, request),
                 operations:[],
                 apis: routes_array
               }
@@ -86,7 +85,7 @@ module Grape
               header['Access-Control-Request-Method'] = '*'
               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
+                notes = route.route_notes && @@markdown ? Kramdown::Document.new(strip_heredoc(route.route_notes)).to_html : route.route_notes
                 http_codes = parse_http_codes route.route_http_codes
                 operations = {
                     :notes => notes,
@@ -106,7 +105,7 @@ module Grape
               {
                 apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: base_path || request.base_url,
+                basePath: parse_base_path(base_path, request),
                 resourcePath: "",
                 apis: routes_array
               }
@@ -121,9 +120,9 @@ module Grape
                   value[:type] = 'file' if value.is_a?(Hash) && value[:type] == 'Rack::Multipart::UploadedFile'
 
                   dataType = value.is_a?(Hash) ? value[:type]||'String' : 'String'
-                  description = value.is_a?(Hash) ? value[:desc] : ''
+                  description = value.is_a?(Hash) ? value[:desc] || value[:description] : ''
                   required = value.is_a?(Hash) ? !!value[:required] : false
-                  paramType = path.match(":#{param}") ? 'path' : (method == 'POST') ? 'body' : 'query'
+                  paramType = path.include?(":#{param}") ? 'path' : (method == 'POST') ? 'form' : 'query'
                   name = (value.is_a?(Hash) && value[:full_name]) || param
                   {
                     paramType: paramType,
@@ -161,7 +160,7 @@ module Grape
 
             def parse_path(path, version)
               # adapt format to swagger format
-              parsed_path = path.gsub('(.:format)', '.{format}')
+              parsed_path = path.gsub '(.:format)', ( @@hide_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.
@@ -169,43 +168,35 @@ module Grape
               # 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
+              version ? parsed_path.gsub('{version}', version) : parsed_path
             end
+
             def parse_http_codes codes
               codes ||= {}
               codes.collect do |k, v|
                 {:code => k, :reason => v}
               end
             end
+
+            def try(*a, &b)
+              if a.empty? && block_given?
+                yield self
+              else
+                public_send(*a, &b) if respond_to?(a.first)
+              end
+            end
+
+            def strip_heredoc(string)
+              indent = string.scan(/^[ \t]*(?=\S)/).min.try(:size) || 0
+              string.gsub(/^[ \t]{#{indent}}/, '')
+            end
+
+            def parse_base_path(base_path, request)
+              (base_path.is_a?(Proc) ? base_path.call(request) : base_path) || request.base_url
+            end
           end
         end
       end
     end
   end
 end
-
-class Object
-  ##
-  #   @person ? @person.name : nil
-  # vs
-  #   @person.try(:name)
-  #
-  # File activesupport/lib/active_support/core_ext/object/try.rb#L32
-   def try(*a, &b)
-    if a.empty? && block_given?
-      yield self
-    else
-      __send__(*a, &b)
-    end
-  end
-end
-
-class String
-  # strip_heredoc from rails
-  # File activesupport/lib/active_support/core_ext/string/strip.rb, line 22
-  def strip_heredoc
-    indent = scan(/^[ \t]*(?=\S)/).min.try(:size) || 0
-    gsub(/^[ \t]{#{indent}}/, '')
-  end
-end

data/spec/default_api_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "Default API" do
+
+  before(:all) do
+    class NotAMountedApi < Grape::API
+      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'
+    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

data/spec/grape-swagger-helper_spec.rb

@@ -30,7 +30,7 @@ describe "helpers" do
       ]
     end
 
-    it "should parse params as body for a POST" do
+    it "should parse params as form for a POST" do
       params = {
         name: {type: 'String', :desc =>"A name", required: true },
         level: 'max'
@@ -39,8 +39,8 @@ describe "helpers" do
       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}
+          {paramType: "form", name: :name, description:"A name", dataType: "String", required: true},
+          {paramType: "form", name: :level, description:"", dataType: "String", required: false}
       ]
     end
   end

data/spec/non_default_api_spec.rb

@@ -31,6 +31,34 @@ describe "options: " do
     end
   end
 
+  context "overruling the basepath with a proc" do
+    before(:all) do
+      class ProcBasePathMountedApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithProcBasePath < Grape::API
+        mount ProcBasePathMountedApi
+        add_swagger_documentation :base_path => lambda { |request| "#{request.base_url}/some_value" }
+      end
+    end
+
+    def app; SimpleApiWithProcBasePath end
+
+    it "retrieves the given base-path on /swagger_doc" do
+      get '/swagger_doc'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org/some_value\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/something.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    end
+
+    it "retrieves the same given base-path for mounted-api" do
+      get '/swagger_doc/something'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org/some_value\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    end
+  end
+
   context "overruling the version" do
     before(:all) do
       class ApiVersionMountedApi < Grape::API
@@ -229,4 +257,27 @@ describe "options: " do
       last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"https://example.org:80\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
     end
   end
+
+  context ":hide_format" do
+    before(:all) do
+      class HidePathsApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithHiddenPaths < Grape::API
+        mount ProtectedApi
+        add_swagger_documentation :hide_format => true
+      end
+    end
+
+    def app; SimpleApiWithHiddenPaths; end
+
+    it "has no formats" do
+      get '/swagger_doc/something'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/something\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    end
+  end
 end

data/spec/simple_mounted_api_spec.rb

@@ -20,14 +20,23 @@ describe "a simple mounted api" do
           "XAuthToken" => {description: "A required header.", required: true},
           "XOtherHeader" => {description: "An optional header.", required: false}
         },
-	:http_codes => {
-		403 => "invalid pony",
-		405 => "no ponies left!"
-	}
+        :http_codes => {
+        	403 => "invalid pony",
+        	405 => "no ponies left!"
+        }
       }
       get '/simple_with_headers' do
         {:bla => 'something_else'}
       end
+
+      desc 'this takes an array of parameters', {
+        :params => {
+          "items[]" => { :description => "array of items" }
+        }
+      }
+      post '/items' do
+        {}
+      end
     end
 
     class SimpleApi < Grape::API
@@ -40,7 +49,7 @@ describe "a simple mounted api" do
 
   it "retrieves swagger-documentation 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/simple.{format}\"}, {:path=>\"/swagger_doc/simple_with_headers.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/simple.{format}\"}, {:path=>\"/swagger_doc/simple_with_headers.{format}\"}, {:path=>\"/swagger_doc/items.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
   end
 
   it "retrieves the documentation for mounted-api" do
@@ -52,4 +61,9 @@ describe "a simple mounted api" 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}], :errorResponses=>[{:code=>403, :reason=>\"invalid pony\"}, {:code=>405, :reason=>\"no ponies left!\"}]}]}]}"
   end
+
+  it "retrieves the documentation for mounted-api that supports multiple parameters" do
+    get '/swagger_doc/items'
+    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/items.{format}\", :operations=>[{:notes=>nil, :summary=>\"this takes an array of parameters\", :nickname=>\"POST-items---format-\", :httpMethod=>\"POST\", :parameters=>[{:paramType=>\"form\", :name=>\"items[]\", :description=>\"array of items\", :dataType=>\"String\", :required=>false}]}]}]}"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -166,6 +166,8 @@ extra_rdoc_files:
 files:
 - .document
 - .rvmrc
+- .travis.yml
+- CHANGELOG.markdown
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -174,6 +176,7 @@ files:
 - VERSION
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
+- spec/default_api_spec.rb
 - spec/grape-swagger-helper_spec.rb
 - spec/grape-swagger_spec.rb
 - spec/non_default_api_spec.rb
@@ -194,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 470443031386995496
+      hash: 4271109151284297924
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: