grape-swagger 0.7.2 → 0.8.0

data/test/config.ru

@@ -1,2 +1,10 @@
-require './nested_api'
-run SimpleApi.new
+require 'rack/cors'
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '*', headers: :any, methods: [ :get, :post, :put, :delete, :options ]
+  end
+end
+
+require './api'
+run Api.new

metadata

@@ -1,235 +1,289 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.7.2
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   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: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  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: rack-test
+  name: rack-cors
   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
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.24.1
   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
+        version: 0.24.1
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: 
+email:
+- tim.vandecasteele@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.markdown
+extra_rdoc_files: []
 files:
-- .document
-- .rspec
-- .rvmrc
-- .travis.yml
-- CHANGELOG.markdown
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.markdown
+- README.md
+- RELEASING.md
 - Rakefile
-- VERSION
+- UPGRADING.md
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
+- lib/grape-swagger/errors.rb
+- lib/grape-swagger/markdown.rb
+- lib/grape-swagger/markdown/kramdown_adapter.rb
+- lib/grape-swagger/markdown/redcarpet_adapter.rb
+- lib/grape-swagger/version.rb
+- spec/api_description_spec.rb
+- spec/api_global_models_spec.rb
 - spec/api_models_spec.rb
 - spec/default_api_spec.rb
 - spec/form_params_spec.rb
 - spec/grape-swagger_helper_spec.rb
 - spec/grape-swagger_spec.rb
 - spec/hide_api_spec.rb
+- spec/markdown/kramdown_adapter_spec.rb
+- spec/markdown/markdown_spec.rb
+- spec/markdown/redcarpet_adapter_spec.rb
+- spec/namespaced_api_spec.rb
 - spec/non_default_api_spec.rb
+- spec/response_model_spec.rb
 - spec/simple_mounted_api_spec.rb
 - spec/spec_helper.rb
+- spec/version_spec.rb
+- test/api.rb
 - test/config.ru
-- test/nested_api.rb
-homepage: http://github.com/tim-vandecasteele/grape-swagger
+- test/splines.png
+homepage: https://github.com/tim-vandecasteele/grape-swagger
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -17008049882572761
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: Add swagger compliant documentation to your grape API
-test_files: []
+specification_version: 4
+summary: A simple way to add auto generated documentation to your Grape API that can
+  be displayed with Swagger.
+test_files:
+- spec/api_description_spec.rb
+- spec/api_global_models_spec.rb
+- spec/api_models_spec.rb
+- spec/default_api_spec.rb
+- spec/form_params_spec.rb
+- spec/grape-swagger_helper_spec.rb
+- spec/grape-swagger_spec.rb
+- spec/hide_api_spec.rb
+- spec/markdown/kramdown_adapter_spec.rb
+- spec/markdown/markdown_spec.rb
+- spec/markdown/redcarpet_adapter_spec.rb
+- spec/namespaced_api_spec.rb
+- spec/non_default_api_spec.rb
+- spec/response_model_spec.rb
+- spec/simple_mounted_api_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb
+- test/api.rb
+- test/config.ru
+- test/splines.png

data/.rvmrc

@@ -1,48 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3@grape-swagger"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.14.3 (stable)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
-# fi

data/CHANGELOG.markdown

@@ -1,55 +0,0 @@
-### Next Release
-
-* Fix: translate parameter `type` to String, enables using Mongoid fields as parameter definitions - [@dblock](https://github.com/dblock).
-* Adding support for generating swagger responseClass and models from Grape Entities - [@calebwoods](https://github.com/calebwoods).
-* Adding hidden endpoints - [@arturoherrero](https://github.com/arturoherrero).
-* Fix: allow urls with `-` - [@dadario](https://github.com/dadario).
-* Fix: mounting multiple documentations - [@Drakula2k](https://github.com/Drakula2k).
-* Fix: resource groupings for prefixed APIs - [@aew](https://github.com/aew).
-* Fix: hide_documentation_path on prefixed APIs - [@spier](https://github.com/spier).
-* Your Contribution Here
-
-### 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).