api_docs 0.0.4 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. data/Gemfile +8 -0
  2. data/{LICENSE.txt → LICENSE} +0 -0
  3. data/README.md +67 -148
  4. data/Rakefile +29 -14
  5. data/VERSION +1 -1
  6. data/api_docs.gemspec +66 -25
  7. data/app/assets/javascripts/api_docs.js +11 -0
  8. data/app/assets/stylesheets/api_docs.css +62 -0
  9. data/app/controllers/api_docs/docs_controller.rb +8 -0
  10. data/app/views/api_docs/docs/_action.html.erb +41 -0
  11. data/app/views/api_docs/docs/_request_params.html.erb +16 -0
  12. data/app/views/api_docs/docs/index.html.erb +32 -0
  13. data/config/routes.rb +3 -0
  14. data/lib/api_docs/configuration.rb +16 -11
  15. data/lib/api_docs/engine.rb +3 -6
  16. data/lib/api_docs/test_helper.rb +81 -0
  17. data/lib/api_docs.rb +4 -26
  18. data/script/rails +8 -0
  19. data/test/api_docs_test.rb +15 -0
  20. data/test/docs_controller_test.rb +11 -0
  21. data/test/dummy/README.rdoc +261 -0
  22. data/test/dummy/Rakefile +7 -0
  23. data/test/dummy/app/assets/images/glyphicons-halflings-white.png +0 -0
  24. data/test/dummy/app/assets/images/glyphicons-halflings.png +0 -0
  25. data/test/dummy/app/assets/javascripts/application.js +16 -0
  26. data/test/dummy/app/assets/javascripts/bootstrap.min.js +6 -0
  27. data/test/dummy/app/assets/stylesheets/application.css +14 -0
  28. data/test/dummy/app/assets/stylesheets/bootstrap.min.css +9 -0
  29. data/test/dummy/app/controllers/application_controller.rb +25 -0
  30. data/test/dummy/app/helpers/application_helper.rb +2 -0
  31. data/test/dummy/app/mailers/.gitkeep +0 -0
  32. data/test/dummy/app/models/.gitkeep +0 -0
  33. data/test/dummy/app/views/layouts/application.html.erb +16 -0
  34. data/test/dummy/config/application.rb +65 -0
  35. data/test/dummy/config/boot.rb +10 -0
  36. data/test/dummy/config/environment.rb +5 -0
  37. data/test/dummy/config/environments/development.rb +31 -0
  38. data/test/dummy/config/environments/production.rb +64 -0
  39. data/test/dummy/config/environments/test.rb +35 -0
  40. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  41. data/test/dummy/config/initializers/inflections.rb +15 -0
  42. data/test/dummy/config/initializers/mime_types.rb +5 -0
  43. data/test/dummy/config/initializers/secret_token.rb +7 -0
  44. data/test/dummy/config/initializers/session_store.rb +8 -0
  45. data/test/dummy/config/initializers/wrap_parameters.rb +10 -0
  46. data/test/dummy/config/locales/en.yml +5 -0
  47. data/test/dummy/config/routes.rb +4 -0
  48. data/test/dummy/config.ru +4 -0
  49. data/test/dummy/lib/assets/.gitkeep +0 -0
  50. data/test/dummy/log/.gitkeep +0 -0
  51. data/test/dummy/public/404.html +26 -0
  52. data/test/dummy/public/422.html +26 -0
  53. data/test/dummy/public/500.html +25 -0
  54. data/test/dummy/public/favicon.ico +0 -0
  55. data/test/dummy/script/rails +6 -0
  56. data/test/test_helper.rb +14 -0
  57. data/test/test_helper_test.rb +104 -0
  58. metadata +119 -79
  59. data/app/assets/javascripts/api_docs.js.coffee +0 -37
  60. data/app/assets/javascripts/prettify.js +0 -28
  61. data/app/assets/stylesheets/prettify.css +0 -53
  62. data/app/views/api_docs/_api_docs.html.haml +0 -11
  63. data/app/views/api_docs/_curl.html.haml +0 -4
  64. data/app/views/api_docs/_form.html.haml +0 -18
  65. data/app/views/api_docs/_panel.html.haml +0 -33
  66. data/app/views/api_docs/_params.html.haml +0 -15
  67. data/app/views/api_docs/_response.html.haml +0 -16
  68. data/lib/api_docs/railtie.rb +0 -12
data/app/views/api_docs/_response.html.haml DELETED
@@ -1,16 +0,0 @@
1
- - case response[response_type]
2
- - when Hash
3
- .span5
4
- %strong= "#{response_type.capitalize} response:"
5
- %pre.prettyprint= response[response_type].dig('response')
6
- - if response[response_type].dig('data')
7
- %pre.prettyprint= response[response_type].dig('data')
8
-
9
- - when Array
10
- .span5
11
- %strong= "#{response_type.capitalize} responses:"
12
- - response[response_type].each do |res|
13
- %pre.prettyprint= res.dig('response')
14
- - if res.dig('data')
15
- %pre.prettyprint= res.dig('data')
16
- %hr/
data/lib/api_docs/railtie.rb DELETED
@@ -1,12 +0,0 @@
1
- # Configure Rails 3.0 to use public/javascripts/jquery et al
2
- module Jquery
3
- module Rails
4
-
5
- class Railtie < ::Rails::Railtie
6
- config.before_configuration do
7
- config.action_view.javascript_expansions[:defaults] |= ['bootstrap']
8
- end
9
- end
10
-
11
- end
12
- end