grape-swagger 0.1.0 → 0.2.0

data/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

data/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

data/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

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/grape-swagger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "grape-swagger"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Vandecasteele"]
-  s.date = "2012-07-19"
+  s.date = "2012-07-27"
   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 = [
@@ -27,40 +27,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "grape-swagger.gemspec",
     "lib/grape-swagger.rb",
-    "test/dummy/README.rdoc",
-    "test/dummy/Rakefile",
-    "test/dummy/app/assets/javascripts/application.js",
-    "test/dummy/app/assets/stylesheets/application.css",
-    "test/dummy/app/controllers/application_controller.rb",
-    "test/dummy/app/helpers/application_helper.rb",
-    "test/dummy/app/mailers/.gitkeep",
-    "test/dummy/app/models/.gitkeep",
-    "test/dummy/app/views/layouts/application.html.erb",
-    "test/dummy/config.ru",
-    "test/dummy/config/application.rb",
-    "test/dummy/config/boot.rb",
-    "test/dummy/config/database.yml",
-    "test/dummy/config/environment.rb",
-    "test/dummy/config/environments/development.rb",
-    "test/dummy/config/environments/production.rb",
-    "test/dummy/config/environments/test.rb",
-    "test/dummy/config/initializers/backtrace_silencers.rb",
-    "test/dummy/config/initializers/inflections.rb",
-    "test/dummy/config/initializers/mime_types.rb",
-    "test/dummy/config/initializers/secret_token.rb",
-    "test/dummy/config/initializers/session_store.rb",
-    "test/dummy/config/initializers/wrap_parameters.rb",
-    "test/dummy/config/locales/en.yml",
-    "test/dummy/config/routes.rb",
-    "test/dummy/lib/assets/.gitkeep",
-    "test/dummy/log/.gitkeep",
-    "test/dummy/public/404.html",
-    "test/dummy/public/422.html",
-    "test/dummy/public/500.html",
-    "test/dummy/public/favicon.ico",
-    "test/dummy/script/rails",
-    "test/grape-swagger_test.rb",
-    "test/test_helper.rb"
+    "spec/grape-swagger_spec.rb",
+    "spec/non_default_api_spec.rb",
+    "spec/simple_mounted_api_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/tim-vandecasteele/grape-swagger"
   s.licenses = ["MIT"]
@@ -80,6 +50,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jquery-rails>, [">= 0"])
       s.add_development_dependency(%q<rails>, ["~> 3.2"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<grape>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
@@ -89,6 +62,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jquery-rails>, [">= 0"])
       s.add_dependency(%q<rails>, ["~> 3.2"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<grape>, [">= 0"])
@@ -99,6 +75,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jquery-rails>, [">= 0"])
     s.add_dependency(%q<rails>, ["~> 3.2"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/lib/grape-swagger.rb

@@ -8,7 +8,11 @@ module Grape
       def mount(mounts)
         original_mount mounts
         @combined_routes ||= {}
-        @combined_routes[mounts.name.split('::').last.downcase] = mounts::routes
+        mounts::routes.each do |route|
+          resource = route.route_path.match('\/(.*?)[\.\/\(]').captures.first || '/'
+          @combined_routes[resource.downcase] ||= []
+          @combined_routes[resource.downcase] << route
+        end
       end
 
       def add_swagger_documentation(options={})
@@ -21,6 +25,7 @@ module Grape
       private
 
       def create_documentation_class
+
         Class.new(Grape::API) do
           class << self
             def name
@@ -40,8 +45,8 @@ module Grape
             @@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 +58,9 @@ module Grape
                   { :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
               }
@@ -77,15 +82,15 @@ module Grape
                     :summary => route.route_description || '',
                     :nickname   => Random.rand(1000000),
                     :httpMethod => route.route_method,
-                    :parameters => parse_params(route.route_params)
+                    :parameters => parse_params(route.route_params, route.route_path, route.route_method)
                   }]
                 }
               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
               }
@@ -94,17 +99,19 @@ module Grape
 
 
           helpers do
-            def parse_params(params)
+            def parse_params(params, path, method)
               params.map do |param, value|
+                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] : ''
                 required = value.is_a?(Hash) ? !!value[:required] : false
-                paramType = 'path'
+                paramType = path.match(":#{param}") ? 'path' : (method == 'POST') ? 'body' : 'query'
                 {
                   paramType: paramType,
                   name: param,
                   description: description,
-                  dataType: "String",
+                  dataType: dataType,
                   required: required
                 }
               end

data/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

data/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/something.{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/something'
+      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/something.{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/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=>[]}]}]}"
+    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/something.{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/something'
+      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

data/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/something.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+  end
+
+  it "retrieves the documentation for 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=>nil, :summary=>\"this gets something\", :nickname=>0, :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+  end
+end

data/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -139,6 +139,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple way to add proper auto generated documentation - that can be
   displayed with swagger - to your inline described grape API
 email: tim.vandecasteele@gmail.com
@@ -158,40 +206,10 @@ files:
 - VERSION
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.gitkeep
-- test/dummy/app/models/.gitkeep
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/lib/assets/.gitkeep
-- test/dummy/log/.gitkeep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/grape-swagger_test.rb
-- test/test_helper.rb
+- spec/grape-swagger_spec.rb
+- spec/non_default_api_spec.rb
+- spec/simple_mounted_api_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/tim-vandecasteele/grape-swagger
 licenses:
 - MIT
@@ -207,7 +225,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2874052847464971808
+      hash: -2449825622916780559
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: