Merge pull request #1 from nathanvda/master

Merged tests in master.
Now completely decoupled from rails.

Author: tim-vandecasteele

Gemfile

@@ -16,4 +16,9 @@ group :development do
   gem "jquery-rails"
   gem "rails", "~> 3.2"
   gem "sqlite3"
+
+  gem "rack-test"
+
+  gem "rspec-rails"
+  gem "rspec"
 end

Gemfile.lock

@@ -30,6 +30,7 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.0)
+    diff-lcs (1.1.3)
     erubis (2.7.0)
     git (1.2.5)
     grape (0.2.1)
@@ -86,6 +87,19 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    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)
@@ -112,7 +126,10 @@ DEPENDENCIES
   grape
   jeweler (~> 1.8.4)
   jquery-rails
+  rack-test
   rails (~> 3.2)
   rdoc (~> 3.12)
+  rspec
+  rspec-rails
   shoulda
   sqlite3

Rakefile

@@ -29,14 +29,9 @@ Jeweler::RubygemsDotOrgTasks.new
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

lib/grape-swagger.rb

@@ -21,6 +21,7 @@ def add_swagger_documentation(options={})
       private
 
       def create_documentation_class
+
         Class.new(Grape::API) do
           class << self
             def name
@@ -40,8 +41,8 @@ def self.setup(options)
             @@target_class = options[:target_class]
             @@mount_path = options[:mount_path]
             @@class_name = options[:class_name] || options[:mount_path].gsub('/','')
-            @@api_version = options[:api_version]
-            @@base_path = options[:base_path]
+            api_version = options[:api_version]
+            base_path = options[:base_path]
 
             desc 'Swagger compatible API description'
             get @@mount_path do
@@ -53,9 +54,9 @@ def self.setup(options)
                   { :path => "#{@@mount_path}/#{route}.{format}" }
               end
               {
-                apiVersion: @@api_version,
+                apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: @@base_path || "http://#{env['HTTP_HOST']}",
+                basePath: base_path || "http://#{env['HTTP_HOST']}",
                 operations:[],
                 apis: routes_array
               }
@@ -83,9 +84,9 @@ def self.setup(options)
               end
 
               {
-                apiVersion: @@api_version,
+                apiVersion: api_version,
                 swaggerVersion: "1.1",
-                basePath: @@base_path || "http://#{env['HTTP_HOST']}",
+                basePath: base_path || "http://#{env['HTTP_HOST']}",
                 resourcePath: "",
                 apis: routes_array
               }

spec/grape-swagger_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Grape::API do
+
+  it "added combined-routes" do
+    Grape::API.should respond_to :combined_routes
+  end
+
+  it "added add_swagger_documentation" do
+    Grape::API.should respond_to :add_swagger_documentation
+  end
+
+
+
+end

spec/non_default_api_spec.rb

@@ -0,0 +1,88 @@
+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
+
+
+  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
+    end
+
+    subject { SimpleApiWithBasePath.new }
+    def app; subject 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=>\"#{SimpleApiWithBasePath::NON_DEFAULT_BASE_PATH}\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/mountedapi.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    end
+
+    it "retrieves the same given base-path for mounted-api" do
+      Random.stub(:rand) { 0 }
+      get '/swagger_doc/mountedapi'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"#{SimpleApiWithBasePath::NON_DEFAULT_BASE_PATH}\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>0, :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    end
+  end
+
+  context "overruling the basepath" do
+    class SimpleApiWithAPiVersion < Grape::API
+      API_VERSION = "101"
+
+      mount MountedApi
+      add_swagger_documentation :api_version => API_VERSION
+    end
+
+    subject { SimpleApiWithAPiVersion.new }
+    def app; subject end
+
+    it "retrieves the given base-path 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/mountedapi.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    end
+
+    it "retrieves the same given base-path for mounted-api" do
+      Random.stub(:rand) { 0 }
+      get '/swagger_doc/mountedapi'
+      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
+    end
+
+    subject { SimpleApiWithDifferentMount.new }
+    def app; subject end
+
+    it "retrieves the given base-path on /swagger_doc" do
+      get '/api_doc'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :operations=>[], :apis=>[{:path=>\"/swagger_doc/mountedapi.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    end
+
+    it "retrieves the same given base-path for mounted-api" do
+      Random.stub(:rand) { 0 }
+      get '/api_doc/mountedapi'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :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
+
+    it "does not respond to swagger_doc" do
+      get '/swagger_doc'
+      last_response.status.should be == 404
+    end
+  end
+
+
+end

spec/simple_mounted_api_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe "a simple mounted api" do
+
+  class MountedApi < Grape::API
+    desc 'this gets something'
+    get '/something' do
+      {:bla => 'something'}
+    end
+  end
+
+  class SimpleApi < Grape::API
+    mount MountedApi
+    add_swagger_documentation
+  end
+
+  subject { SimpleApi.new }
+  def app; subject end
+
+  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/mountedapi.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+  end
+
+  it "retrieves the documentation for mounted-api" do
+    Random.stub(:rand) { 0 }
+    get '/swagger_doc/mountedapi'
+    last_response.body.should == "{:apiVersion=>\"0.1\", :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

spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
+
+require 'grape'
+require 'grape-swagger'
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test
+
+
+require 'rack/test'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+
+  config.include Rack::Test::Methods
+  #config.include Rack::Test::Methods::Patch
+end