Update spec for markdown.

Author: tim-vandecasteele

Gemfile

@@ -13,13 +13,10 @@ group :development do
   gem "rdoc", "~> 3.12"
   gem "bundler", "> 1.0.0"
   gem "jeweler", "~> 1.8.4"
-  # jquery-rails is used by the dummy application
-  gem "jquery-rails"
-  gem "rails", "~> 3.2"
-  gem "sqlite3"
+
+  gem "pry"
 
   gem "rack-test"
 
-  gem "rspec-rails"
   gem "rspec"
 end

Gemfile.lock

@@ -1,37 +1,11 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.6)
-      actionpack (= 3.2.6)
-      mail (~> 2.4.4)
-    actionpack (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-    activerecord (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
     activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
+    coderay (1.0.7)
     diff-lcs (1.1.3)
-    erubis (2.7.0)
     git (1.2.5)
     grape (0.2.1)
       hashie (~> 1.2)
@@ -40,51 +14,26 @@ GEM
       rack
       rack-mount
     hashie (1.2.0)
-    hike (1.2.1)
     i18n (0.6.0)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    journey (1.0.4)
-    jquery-rails (2.0.2)
-      railties (>= 3.2.0, < 5.0)
-      thor (~> 0.14)
     json (1.7.3)
     kramdown (0.13.7)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
+    method_source (0.8)
     multi_json (1.3.6)
     multi_xml (0.5.1)
-    polyglot (0.3.3)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
     rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
     rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-ssl (1.3.2)
-      rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.2.6)
-      actionmailer (= 3.2.6)
-      actionpack (= 3.2.6)
-      activerecord (= 3.2.6)
-      activeresource (= 3.2.6)
-      activesupport (= 3.2.6)
-      bundler (~> 1.0)
-      railties (= 3.2.6)
-    railties (3.2.6)
-      actionpack (= 3.2.6)
-      activesupport (= 3.2.6)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -96,28 +45,13 @@ GEM
     rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.1)
-    rspec-rails (2.11.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.11.0)
     shoulda (3.1.1)
       shoulda-context (~> 1.0)
       shoulda-matchers (~> 1.2)
     shoulda-context (1.0.0)
     shoulda-matchers (1.2.0)
       activesupport (>= 3.0.0)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.15.4)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    slop (3.3.2)
 
 PLATFORMS
   ruby
@@ -126,12 +60,9 @@ DEPENDENCIES
   bundler (> 1.0.0)
   grape
   jeweler (~> 1.8.4)
-  jquery-rails
   kramdown
+  pry
   rack-test
-  rails (~> 3.2)
   rdoc (~> 3.12)
   rspec
-  rspec-rails
   shoulda
-  sqlite3

README.markdown

@@ -40,12 +40,14 @@ You can pass a hash with some configuration possibilities to ```add_swagger_docu
 * ```:mount_path``` The path were the API documentation is loaded, default '/swagger_doc'
 * ```:api_version``` Version of the API that's being exposed
 * ```:base_path``` Basepath of the API that's being exposed
+* ```:markdown``` Allow markdown in `notes`, default `false`
 
 ## Swagger additions
 grape-swagger allows you to add an explanation in markdown in the notes field. Which would result in proper formatted markdown in Swagger UI. The default Swagger UI doesn't allow HTML in the notes field, so you need to use an adapted version of Swagger UI (you can find one at https://github.com/tim-vandecasteele/swagger-ui/tree/vasco).
 
 We're using [kramdown](http://kramdown.rubyforge.org) for parsing the markdown, specific syntax can be found [here](http://kramdown.rubyforge.org/syntax.html).
 
+Be sure to enable markdown in the `add_swagger_documentation` call: ':markdown => true'
 
 ``` ruby
 desc "Reserve a virgin in heaven", {

lib/grape-swagger.rb

@@ -41,12 +41,14 @@ def self.setup(options)
               :mount_path => '/swagger_doc',
               :base_path => nil,
               :api_version => '0.1',
+              :markdown => false
             }
             options = defaults.merge(options)
 
             @@target_class = options[:target_class]
             @@mount_path = options[:mount_path]
             @@class_name = options[:class_name] || options[:mount_path].gsub('/','')
+            @@markdown = options[:markdown]
             api_version = options[:api_version]
             base_path = options[:base_path]
 
@@ -77,7 +79,7 @@ def self.setup(options)
               header['Access-Control-Request-Method'] = '*'
               routes = @@target_class::combined_routes[params[:name]]
               routes_array = routes.map do |route|
-                notes = route.route_notes ? Kramdown::Document.new(route.route_notes.strip_heredoc).to_html : nil
+                notes = route.route_notes && @@markdown ? Kramdown::Document.new(route.route_notes.strip_heredoc).to_html : route.route_notes
                 {
                   :path => parse_path(route.route_path),
                   :operations => [{
@@ -133,6 +135,16 @@ def parse_path(path)
   end
 end
 
+class Object
+  ##
+  #   @person ? @person.name : nil
+  # vs
+  #   @person.try(:name)
+  def try(method)
+    send method if respond_to? method
+  end
+end
+
 class String
   # strip_heredoc from rails
   # File activesupport/lib/active_support/core_ext/string/strip.rb, line 22

spec/non_default_api_spec.rb

@@ -1,25 +1,24 @@
 require 'spec_helper'
 
-describe "overruling the defaults for the api documentation generation" do
-
-  class MountedApi < Grape::API
-    desc 'this gets something'
-    get '/something' do
-      {:bla => 'something'}
-    end
-  end
-
-
+describe "options: " do
   context "overruling the basepath" do
-    class SimpleApiWithBasePath < Grape::API
-      NON_DEFAULT_BASE_PATH= "http://www.breakcoregivesmewood.com"
-
-      mount MountedApi
-      add_swagger_documentation :base_path => NON_DEFAULT_BASE_PATH
+    before(:all) do
+      class BasePathMountedApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithBasePath < Grape::API
+        NON_DEFAULT_BASE_PATH= "http://www.breakcoregivesmewood.com"
+
+        mount BasePathMountedApi
+        add_swagger_documentation :base_path => NON_DEFAULT_BASE_PATH
+      end
     end
 
-    subject { SimpleApiWithBasePath.new }
-    def app; subject end
+    def app; SimpleApiWithBasePath end
 
     it "retrieves the given base-path on /swagger_doc" do
       get '/swagger_doc'
@@ -33,43 +32,59 @@ def app; subject end
     end
   end
 
-  context "overruling the basepath" do
-    class SimpleApiWithAPiVersion < Grape::API
-      API_VERSION = "101"
-
-      mount MountedApi
-      add_swagger_documentation :api_version => API_VERSION
+  context "overruling the version" do
+    before(:all) do
+      class ApiVersionMountedApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithApiVersion < Grape::API
+        API_VERSION = "101"
+
+        mount ApiVersionMountedApi
+        add_swagger_documentation :api_version => API_VERSION
+      end
     end
 
-    subject { SimpleApiWithAPiVersion.new }
-    def app; subject end
+    def app; SimpleApiWithApiVersion end
 
-    it "retrieves the given base-path on /swagger_doc" do
+    it "retrieves the api version on /swagger_doc" do
       get '/swagger_doc'
-      last_response.body.should == "{:apiVersion=>\"#{SimpleApiWithAPiVersion::API_VERSION}\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/something.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+      last_response.body.should == "{:apiVersion=>\"#{SimpleApiWithApiVersion::API_VERSION}\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :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
+    it "retrieves the same api version for mounted-api" do
       Random.stub(:rand) { 0 }
       get '/swagger_doc/something'
-      last_response.body.should == "{:apiVersion=>\"#{SimpleApiWithAPiVersion::API_VERSION}\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>0, :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+      last_response.body.should == "{:apiVersion=>\"#{SimpleApiWithApiVersion::API_VERSION}\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>0, :httpMethod=>\"GET\", :parameters=>[]}]}]}"
     end
   end
 
   context "overruling the mount-path" do
-    class SimpleApiWithDifferentMount < Grape::API
-      MOUNT_PATH = "api_doc"
-
-      mount MountedApi
-      add_swagger_documentation :mount_path => MOUNT_PATH
+    before(:all) do
+      class DifferentMountMountedApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithDifferentMount < Grape::API
+        MOUNT_PATH = "/api_doc"
+
+        mount DifferentMountMountedApi
+        add_swagger_documentation :mount_path => MOUNT_PATH
+      end
     end
 
-    subject { SimpleApiWithDifferentMount.new }
-    def app; subject end
+    def app; SimpleApiWithDifferentMount end
 
-    it "retrieves the given base-path on /swagger_doc" do
+    it "retrieves the given base-path on /api_doc" do
       get '/api_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}\"}]}"
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/api_doc/something.{format}\"}, {:path=>\"/api_doc/api_doc.{format}\"}]}"
     end
 
     it "retrieves the same given base-path for mounted-api" do
@@ -84,5 +99,30 @@ def app; subject end
     end
   end
 
+  context "overruling the markdown" do
+    before(:all) do
+      class MarkDownMountedApi < Grape::API
+        desc 'this gets something', {
+          :notes => '_test_'
+        }
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithMarkdown < Grape::API
+        mount MarkDownMountedApi
+        add_swagger_documentation :markdown => true
+      end
+    end
+
+    def app; SimpleApiWithMarkdown end
+
+    it "parses markdown for a mounted-api" do
+      Random.stub(:rand) { 0 }
+      get '/swagger_doc/something'
+      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=>0, :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    end
+  end
 
 end