grape-swagger 0.6.0 → 0.7.0

data/spec/simple_mounted_api_spec.rb

@@ -1,28 +1,38 @@
 require 'spec_helper'
 
 describe "a simple mounted api" do
-  before(:all) do
+  before :all do
+    class CustomType; end
+
     class SimpleMountedApi < Grape::API
       desc "Document root"
       get do
       end
 
-      desc 'this gets something', {
+      desc 'This gets something.', {
         :notes => '_test_'
       }
 
       get '/simple' do
-        {:bla => 'something'}
+        { bla: 'something' }
+      end
+
+      desc 'This gets something for URL using - separator.', {
+        :notes => '_test_'
+      }
+
+      get '/simple-test' do
+        { bla: 'something' }
       end
 
       desc 'this gets something else', {
         :headers => {
-          "XAuthToken" => {description: "A required header.", required: true},
-          "XOtherHeader" => {description: "An optional header.", required: false}
+          "XAuthToken" => { description: "A required header.", required: true },
+          "XOtherHeader" => { description: "An optional header.", required: false }
         },
         :http_codes => {
-        	403 => "invalid pony",
-        	405 => "no ponies left!"
+          403 => "invalid pony",
+          405 => "no ponies left!"
         }
       }
       get '/simple_with_headers' do
@@ -31,12 +41,21 @@ describe "a simple mounted api" do
 
       desc 'this takes an array of parameters', {
         :params => {
-          "items[]" => { :description => "array of items" }
+          "items[]" => { description: "array of items" }
         }
       }
       post '/items' do
         {}
       end
+
+      desc 'this uses a custom parameter', {
+        :params => {
+          "custom" => { type: CustomType, description: "array of items" }
+        }
+      }
+      get '/custom' do
+        {}
+      end
     end
 
     class SimpleApi < Grape::API
@@ -48,22 +67,123 @@ describe "a simple mounted api" do
   def app; SimpleApi 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/simple.{format}\"}, {:path=>\"/swagger_doc/simple_with_headers.{format}\"}, {:path=>\"/swagger_doc/items.{format}\"}, {:path=>\"/swagger_doc/swagger_doc.{format}\"}]}"
+    get '/swagger_doc.json'
+    JSON.parse(last_response.body).should == {
+      "apiVersion" => "0.1",
+      "swaggerVersion" => "1.2",
+      "basePath" => "http://example.org",
+      "info" => {},
+      "produces" => ["application/xml", "application/json", "text/plain"],
+      "operations" => [],
+      "apis" => [
+        { "path" => "/simple.{format}" },
+        { "path" => "/simple-test.{format}" },
+        { "path" => "/simple_with_headers.{format}" },
+        { "path" => "/items.{format}" },
+        { "path" => "/custom.{format}" },
+        { "path" => "/swagger_doc.{format}" }
+      ]
+    }
   end
 
   it "retrieves the documentation for mounted-api" do
-    get '/swagger_doc/simple'
-    last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/simple.{format}\", :operations=>[{:notes=>\"_test_\", :summary=>\"this gets something\", :nickname=>\"GET-simple---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    get '/swagger_doc/simple.json'
+    JSON.parse(last_response.body).should == {
+      "apiVersion" => "0.1",
+      "swaggerVersion" => "1.2",
+      "basePath" => "http://example.org",
+      "resourcePath" => "",
+      "apis" => [{
+        "path" => "/simple.{format}",
+        "operations" => [{
+          "produces" => ["application/xml", "application/json", "text/plain"],
+          "notes" => "_test_",
+          "summary" => "This gets something.",
+          "nickname" => "GET-simple---format-",
+          "httpMethod" => "GET",
+          "parameters" => []
+        }]
+      }]
+    }
   end
 
-  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}], :errorResponses=>[{:code=>403, :reason=>\"invalid pony\"}, {:code=>405, :reason=>\"no ponies left!\"}]}]}]}"
-  end
+  context "retrieves the documentation for mounted-api that" do
+    it "contains '-' in URL" do
+      get '/swagger_doc/simple-test.json'
+      JSON.parse(last_response.body).should == {
+        "apiVersion" => "0.1",
+        "swaggerVersion" => "1.2",
+        "basePath" => "http://example.org",
+        "resourcePath" => "",
+        "apis" => [{
+          "path" => "/simple-test.{format}",
+          "operations" => [{
+            "produces" => ["application/xml", "application/json", "text/plain"],
+            "notes" => "_test_",
+            "summary" => "This gets something for URL using - separator.",
+            "nickname" => "GET-simple-test---format-",
+            "httpMethod" => "GET",
+            "parameters" => []
+          }]
+        }]
+      }
+    end
+
+    it "includes headers" do
+      get '/swagger_doc/simple_with_headers.json'
+      JSON.parse(last_response.body)["apis"].should == [{
+        "path" => "/simple_with_headers.{format}",
+        "operations" => [{
+          "produces" => ["application/xml", "application/json", "text/plain"],
+          "notes" => nil,
+          "notes" => "",
+          "summary" => "this gets something else",
+          "nickname" => "GET-simple_with_headers---format-",
+          "httpMethod" => "GET",
+          "parameters" => [
+            { "paramType" => "header", "name" => "XAuthToken", "description" => "A required header.", "type" => "String", "dataType" => "String", "required" => true },
+            { "paramType" => "header", "name" => "XOtherHeader", "description" => "An optional header.", "type" => "String", "dataType" => "String", "required" => false }
+          ],
+          "responseMessages" => [
+            { "code" => 403, "message" => "invalid pony" },
+            { "code" => 405, "message" => "no ponies left!" }
+          ]
+        }]
+      }]
+    end
+
+    it "supports multiple parameters" do
+      get '/swagger_doc/items.json'
+      JSON.parse(last_response.body)["apis"].should == [{
+        "path" => "/items.{format}",
+        "operations" => [{
+          "produces" => ["application/xml", "application/json", "text/plain"],
+          "notes" => nil,
+          "notes" => "",
+          "summary" => "this takes an array of parameters",
+          "nickname" => "POST-items---format-",
+          "httpMethod" => "POST",
+          "parameters" => [ { "paramType" => "form", "name" => "items[]", "description" => "array of items", "type" => "String", "dataType" => "String", "required" => false } ]
+        }]
+      }]
+    end
+
+    it "supports custom types" do
+      get '/swagger_doc/custom.json'
+      JSON.parse(last_response.body)["apis"].should == [{
+        "path" => "/custom.{format}",
+        "operations" => [{
+          "produces" => ["application/xml", "application/json", "text/plain"],
+          "notes" => nil,
+          "notes" => "",
+          "summary" => "this uses a custom parameter",
+          "nickname" => "GET-custom---format-",
+          "httpMethod" => "GET",
+          "parameters" => [ { "paramType" => "query", "name" => "custom", "description" => "array of items", "type" => "CustomType", "dataType" => "CustomType", "required" => false } ]
+        }]
+      }]
+    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

data/spec/spec_helper.rb

@@ -4,29 +4,21 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
 
 require 'grape'
 require 'grape-swagger'
+require 'grape-entity'
 
 require 'rubygems'
 require 'bundler'
 
 require 'pry'
+require 'json'
 
 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.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -28,7 +28,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: github-markdown
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -165,6 +181,7 @@ extra_rdoc_files:
 - README.markdown
 files:
 - .document
+- .rspec
 - .rvmrc
 - .travis.yml
 - CHANGELOG.markdown
@@ -176,9 +193,12 @@ files:
 - VERSION
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
+- spec/api_models_spec.rb
 - spec/default_api_spec.rb
-- spec/grape-swagger-helper_spec.rb
+- spec/form_params_spec.rb
+- spec/grape-swagger_helper_spec.rb
 - spec/grape-swagger_spec.rb
+- spec/hide_api_spec.rb
 - spec/non_default_api_spec.rb
 - spec/simple_mounted_api_spec.rb
 - spec/spec_helper.rb
@@ -197,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4271109151284297924
+      hash: 1382622318618846643
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -206,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Add swagger compliant documentation to your grape API

data/spec/grape-swagger-helper_spec.rb

@@ -1,88 +0,0 @@
-require 'spec_helper'
-
-describe "helpers" do
-
-  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
-
-  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 form 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: "form", name: :name, description:"A name", dataType: "String", required: true},
-          {paramType: "form", 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
-
-    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}"
-
-    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}"
-    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}"
-    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
-
-end