apidoco 0.1.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 (98) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +149 -0
  4. data/Rakefile +34 -0
  5. data/app/assets/config/apidoco_manifest.js +2 -0
  6. data/app/assets/javascripts/apidoco/apidoco_app.js +3 -0
  7. data/app/assets/javascripts/apidoco/application.js +15 -0
  8. data/app/assets/javascripts/apidoco/bootstrap/bootstrap.min.js +7 -0
  9. data/app/assets/javascripts/apidoco/controllers/documentations_controller.js +26 -0
  10. data/app/assets/javascripts/apidoco/directives/angular-scroll.min.js.map +1 -0
  11. data/app/assets/javascripts/apidoco/directives/angular_scroll.min.js +2 -0
  12. data/app/assets/javascripts/apidoco/directives/ng_prettyjson.min.js +22 -0
  13. data/app/assets/javascripts/apidoco/jquery.min.js +5 -0
  14. data/app/assets/stylesheets/apidoco/application.css +15 -0
  15. data/app/assets/stylesheets/apidoco/bootstrap/bootstrap.min.css +6 -0
  16. data/app/assets/stylesheets/apidoco/bootstrap/bootstrap.min.css.map +1 -0
  17. data/app/assets/stylesheets/apidoco/custom.css +15 -0
  18. data/app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.eot +0 -0
  19. data/app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.svg +288 -0
  20. data/app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.ttf +0 -0
  21. data/app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.woff +0 -0
  22. data/app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.woff2 +0 -0
  23. data/app/assets/stylesheets/apidoco/helpers.css +12 -0
  24. data/app/assets/stylesheets/apidoco/ng-prettyjson.min.css +7 -0
  25. data/app/assets/stylesheets/apidoco/simple-sidebar.css +127 -0
  26. data/app/controllers/apidoco/apis_controller.rb +22 -0
  27. data/app/controllers/apidoco/application_controller.rb +5 -0
  28. data/app/helpers/apidoco/application_helper.rb +9 -0
  29. data/app/jobs/apidoco/application_job.rb +4 -0
  30. data/app/mailers/apidoco/application_mailer.rb +6 -0
  31. data/app/models/apidoco/application_record.rb +5 -0
  32. data/app/views/apidoco/apis/_side_bar.html.erb +20 -0
  33. data/app/views/apidoco/apis/show.html.erb +73 -0
  34. data/app/views/layouts/apidoco/application.html.erb +14 -0
  35. data/config/routes.rb +4 -0
  36. data/lib/apidoco.rb +8 -0
  37. data/lib/apidoco/engine.rb +5 -0
  38. data/lib/apidoco/resource_documentation.rb +19 -0
  39. data/lib/apidoco/version.rb +3 -0
  40. data/lib/apidoco/version_documentation.rb +32 -0
  41. data/lib/apidoco/version_parser.rb +24 -0
  42. data/lib/generators/apidoco_generator.rb +82 -0
  43. data/lib/tasks/apidoco_tasks.rake +4 -0
  44. data/spec/dummy/Rakefile +6 -0
  45. data/spec/dummy/app/assets/config/manifest.js +5 -0
  46. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  47. data/spec/dummy/app/assets/javascripts/cable.js +13 -0
  48. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  49. data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
  50. data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
  51. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  52. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  53. data/spec/dummy/app/jobs/application_job.rb +2 -0
  54. data/spec/dummy/app/mailers/application_mailer.rb +4 -0
  55. data/spec/dummy/app/models/application_record.rb +3 -0
  56. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  57. data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
  58. data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
  59. data/spec/dummy/bin/bundle +3 -0
  60. data/spec/dummy/bin/rails +4 -0
  61. data/spec/dummy/bin/rake +4 -0
  62. data/spec/dummy/bin/setup +34 -0
  63. data/spec/dummy/bin/update +29 -0
  64. data/spec/dummy/config.ru +5 -0
  65. data/spec/dummy/config/application.rb +15 -0
  66. data/spec/dummy/config/boot.rb +5 -0
  67. data/spec/dummy/config/cable.yml +9 -0
  68. data/spec/dummy/config/database.yml +25 -0
  69. data/spec/dummy/config/environment.rb +5 -0
  70. data/spec/dummy/config/environments/development.rb +54 -0
  71. data/spec/dummy/config/environments/production.rb +86 -0
  72. data/spec/dummy/config/environments/test.rb +42 -0
  73. data/spec/dummy/config/initializers/application_controller_renderer.rb +6 -0
  74. data/spec/dummy/config/initializers/assets.rb +11 -0
  75. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  76. data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
  77. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  78. data/spec/dummy/config/initializers/inflections.rb +16 -0
  79. data/spec/dummy/config/initializers/mime_types.rb +4 -0
  80. data/spec/dummy/config/initializers/new_framework_defaults.rb +24 -0
  81. data/spec/dummy/config/initializers/session_store.rb +3 -0
  82. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  83. data/spec/dummy/config/locales/en.yml +23 -0
  84. data/spec/dummy/config/puma.rb +47 -0
  85. data/spec/dummy/config/routes.rb +3 -0
  86. data/spec/dummy/config/secrets.yml +22 -0
  87. data/spec/dummy/config/spring.rb +6 -0
  88. data/spec/dummy/db/test.sqlite3 +0 -0
  89. data/spec/dummy/public/404.html +67 -0
  90. data/spec/dummy/public/422.html +67 -0
  91. data/spec/dummy/public/500.html +66 -0
  92. data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
  93. data/spec/dummy/public/apple-touch-icon.png +0 -0
  94. data/spec/dummy/public/favicon.ico +0 -0
  95. data/spec/generators/apidoco_generator_spec.rb +34 -0
  96. data/spec/rails_helper.rb +57 -0
  97. data/spec/spec_helper.rb +17 -0
  98. metadata +281 -0
@@ -0,0 +1,57 @@
1
+ # This file is copied to spec/ when you run 'rails generate rspec:install'
2
+ ENV['RAILS_ENV'] ||= 'test'
3
+ require File.expand_path('../../config/environment', __FILE__)
4
+ # Prevent database truncation if the environment is production
5
+ abort("The Rails environment is running in production mode!") if Rails.env.production?
6
+ require 'spec_helper'
7
+ require 'rspec/rails'
8
+ # Add additional requires below this line. Rails is not loaded until this point!
9
+
10
+ # Requires supporting ruby files with custom matchers and macros, etc, in
11
+ # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
12
+ # run as spec files by default. This means that files in spec/support that end
13
+ # in _spec.rb will both be required and run as specs, causing the specs to be
14
+ # run twice. It is recommended that you do not name files matching this glob to
15
+ # end with _spec.rb. You can configure this pattern with the --pattern
16
+ # option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
17
+ #
18
+ # The following line is provided for convenience purposes. It has the downside
19
+ # of increasing the boot-up time by auto-requiring all files in the support
20
+ # directory. Alternatively, in the individual `*_spec.rb` files, manually
21
+ # require only the support files necessary.
22
+ #
23
+ # Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
24
+
25
+ # Checks for pending migration and applies them before tests are run.
26
+ # If you are not using ActiveRecord, you can remove this line.
27
+ ActiveRecord::Migration.maintain_test_schema!
28
+
29
+ RSpec.configure do |config|
30
+ # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
31
+ config.fixture_path = "#{::Rails.root}/spec/fixtures"
32
+
33
+ # If you're not using ActiveRecord, or you'd prefer not to run each of your
34
+ # examples within a transaction, remove the following line or assign false
35
+ # instead of true.
36
+ config.use_transactional_fixtures = true
37
+
38
+ # RSpec Rails can automatically mix in different behaviours to your tests
39
+ # based on their file location, for example enabling you to call `get` and
40
+ # `post` in specs under `spec/controllers`.
41
+ #
42
+ # You can disable this behaviour by removing the line below, and instead
43
+ # explicitly tag your specs with their type, e.g.:
44
+ #
45
+ # RSpec.describe UsersController, :type => :controller do
46
+ # # ...
47
+ # end
48
+ #
49
+ # The different available types are documented in the features, such as in
50
+ # https://relishapp.com/rspec/rspec-rails/docs
51
+ config.infer_spec_type_from_file_location!
52
+
53
+ # Filter lines from Rails gems in backtraces.
54
+ config.filter_rails_from_backtrace!
55
+ # arbitrary gems may also be filtered via:
56
+ # config.filter_gems_from_backtrace("gem name")
57
+ end
@@ -0,0 +1,17 @@
1
+ ENV['RAILS_ENV'] ||= 'test'
2
+
3
+ require File.expand_path("../dummy/config/environment.rb", __FILE__)
4
+ require 'rspec/rails'
5
+ require 'rspec/autorun'
6
+
7
+ Rails.backtrace_cleaner.remove_silencers!
8
+
9
+ # Load support files
10
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
11
+
12
+ RSpec.configure do |config|
13
+ config.mock_with :rspec
14
+ config.use_transactional_fixtures = true
15
+ config.infer_base_class_for_anonymous_controllers = false
16
+ config.order = "random"
17
+ end
metadata ADDED
@@ -0,0 +1,281 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: apidoco
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Al Ameen
8
+ - Sufinsha Musthafa
9
+ - Nidhin S G
10
+ autorequire:
11
+ bindir: bin
12
+ cert_chain: []
13
+ date: 2016-10-06 00:00:00.000000000 Z
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: rails
17
+ requirement: !ruby/object:Gem::Requirement
18
+ requirements:
19
+ - - ">="
20
+ - !ruby/object:Gem::Version
21
+ version: 4.0.0
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: 4.0.0
29
+ - !ruby/object:Gem::Dependency
30
+ name: angularjs-rails
31
+ requirement: !ruby/object:Gem::Requirement
32
+ requirements:
33
+ - - ">="
34
+ - !ruby/object:Gem::Version
35
+ version: '0'
36
+ type: :runtime
37
+ prerelease: false
38
+ version_requirements: !ruby/object:Gem::Requirement
39
+ requirements:
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: '0'
43
+ - !ruby/object:Gem::Dependency
44
+ name: sqlite3
45
+ requirement: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - ">="
48
+ - !ruby/object:Gem::Version
49
+ version: '0'
50
+ type: :development
51
+ prerelease: false
52
+ version_requirements: !ruby/object:Gem::Requirement
53
+ requirements:
54
+ - - ">="
55
+ - !ruby/object:Gem::Version
56
+ version: '0'
57
+ - !ruby/object:Gem::Dependency
58
+ name: rspec-rails
59
+ requirement: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '0'
64
+ type: :development
65
+ prerelease: false
66
+ version_requirements: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ - !ruby/object:Gem::Dependency
72
+ name: capybara
73
+ requirement: !ruby/object:Gem::Requirement
74
+ requirements:
75
+ - - ">="
76
+ - !ruby/object:Gem::Version
77
+ version: '0'
78
+ type: :development
79
+ prerelease: false
80
+ version_requirements: !ruby/object:Gem::Requirement
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ version: '0'
85
+ - !ruby/object:Gem::Dependency
86
+ name: generator_spec
87
+ requirement: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ type: :development
93
+ prerelease: false
94
+ version_requirements: !ruby/object:Gem::Requirement
95
+ requirements:
96
+ - - ">="
97
+ - !ruby/object:Gem::Version
98
+ version: '0'
99
+ description: Document Rest APIs.
100
+ email:
101
+ - k.ameen88@gmail.com
102
+ - nidhinsg@gmail.com
103
+ executables: []
104
+ extensions: []
105
+ extra_rdoc_files: []
106
+ files:
107
+ - MIT-LICENSE
108
+ - README.md
109
+ - Rakefile
110
+ - app/assets/config/apidoco_manifest.js
111
+ - app/assets/javascripts/apidoco/apidoco_app.js
112
+ - app/assets/javascripts/apidoco/application.js
113
+ - app/assets/javascripts/apidoco/bootstrap/bootstrap.min.js
114
+ - app/assets/javascripts/apidoco/controllers/documentations_controller.js
115
+ - app/assets/javascripts/apidoco/directives/angular-scroll.min.js.map
116
+ - app/assets/javascripts/apidoco/directives/angular_scroll.min.js
117
+ - app/assets/javascripts/apidoco/directives/ng_prettyjson.min.js
118
+ - app/assets/javascripts/apidoco/jquery.min.js
119
+ - app/assets/stylesheets/apidoco/application.css
120
+ - app/assets/stylesheets/apidoco/bootstrap/bootstrap.min.css
121
+ - app/assets/stylesheets/apidoco/bootstrap/bootstrap.min.css.map
122
+ - app/assets/stylesheets/apidoco/custom.css
123
+ - app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.eot
124
+ - app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.svg
125
+ - app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.ttf
126
+ - app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.woff
127
+ - app/assets/stylesheets/apidoco/fonts/glyphicons-halflings-regular.woff2
128
+ - app/assets/stylesheets/apidoco/helpers.css
129
+ - app/assets/stylesheets/apidoco/ng-prettyjson.min.css
130
+ - app/assets/stylesheets/apidoco/simple-sidebar.css
131
+ - app/controllers/apidoco/apis_controller.rb
132
+ - app/controllers/apidoco/application_controller.rb
133
+ - app/helpers/apidoco/application_helper.rb
134
+ - app/jobs/apidoco/application_job.rb
135
+ - app/mailers/apidoco/application_mailer.rb
136
+ - app/models/apidoco/application_record.rb
137
+ - app/views/apidoco/apis/_side_bar.html.erb
138
+ - app/views/apidoco/apis/show.html.erb
139
+ - app/views/layouts/apidoco/application.html.erb
140
+ - config/routes.rb
141
+ - lib/apidoco.rb
142
+ - lib/apidoco/engine.rb
143
+ - lib/apidoco/resource_documentation.rb
144
+ - lib/apidoco/version.rb
145
+ - lib/apidoco/version_documentation.rb
146
+ - lib/apidoco/version_parser.rb
147
+ - lib/generators/apidoco_generator.rb
148
+ - lib/tasks/apidoco_tasks.rake
149
+ - spec/dummy/Rakefile
150
+ - spec/dummy/app/assets/config/manifest.js
151
+ - spec/dummy/app/assets/javascripts/application.js
152
+ - spec/dummy/app/assets/javascripts/cable.js
153
+ - spec/dummy/app/assets/stylesheets/application.css
154
+ - spec/dummy/app/channels/application_cable/channel.rb
155
+ - spec/dummy/app/channels/application_cable/connection.rb
156
+ - spec/dummy/app/controllers/application_controller.rb
157
+ - spec/dummy/app/helpers/application_helper.rb
158
+ - spec/dummy/app/jobs/application_job.rb
159
+ - spec/dummy/app/mailers/application_mailer.rb
160
+ - spec/dummy/app/models/application_record.rb
161
+ - spec/dummy/app/views/layouts/application.html.erb
162
+ - spec/dummy/app/views/layouts/mailer.html.erb
163
+ - spec/dummy/app/views/layouts/mailer.text.erb
164
+ - spec/dummy/bin/bundle
165
+ - spec/dummy/bin/rails
166
+ - spec/dummy/bin/rake
167
+ - spec/dummy/bin/setup
168
+ - spec/dummy/bin/update
169
+ - spec/dummy/config.ru
170
+ - spec/dummy/config/application.rb
171
+ - spec/dummy/config/boot.rb
172
+ - spec/dummy/config/cable.yml
173
+ - spec/dummy/config/database.yml
174
+ - spec/dummy/config/environment.rb
175
+ - spec/dummy/config/environments/development.rb
176
+ - spec/dummy/config/environments/production.rb
177
+ - spec/dummy/config/environments/test.rb
178
+ - spec/dummy/config/initializers/application_controller_renderer.rb
179
+ - spec/dummy/config/initializers/assets.rb
180
+ - spec/dummy/config/initializers/backtrace_silencers.rb
181
+ - spec/dummy/config/initializers/cookies_serializer.rb
182
+ - spec/dummy/config/initializers/filter_parameter_logging.rb
183
+ - spec/dummy/config/initializers/inflections.rb
184
+ - spec/dummy/config/initializers/mime_types.rb
185
+ - spec/dummy/config/initializers/new_framework_defaults.rb
186
+ - spec/dummy/config/initializers/session_store.rb
187
+ - spec/dummy/config/initializers/wrap_parameters.rb
188
+ - spec/dummy/config/locales/en.yml
189
+ - spec/dummy/config/puma.rb
190
+ - spec/dummy/config/routes.rb
191
+ - spec/dummy/config/secrets.yml
192
+ - spec/dummy/config/spring.rb
193
+ - spec/dummy/db/test.sqlite3
194
+ - spec/dummy/public/404.html
195
+ - spec/dummy/public/422.html
196
+ - spec/dummy/public/500.html
197
+ - spec/dummy/public/apple-touch-icon-precomposed.png
198
+ - spec/dummy/public/apple-touch-icon.png
199
+ - spec/dummy/public/favicon.ico
200
+ - spec/generators/apidoco_generator_spec.rb
201
+ - spec/rails_helper.rb
202
+ - spec/spec_helper.rb
203
+ homepage: https://github.com/alameenkhader/apidoco
204
+ licenses:
205
+ - MIT
206
+ metadata: {}
207
+ post_install_message:
208
+ rdoc_options: []
209
+ require_paths:
210
+ - lib
211
+ required_ruby_version: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - ">="
214
+ - !ruby/object:Gem::Version
215
+ version: '0'
216
+ required_rubygems_version: !ruby/object:Gem::Requirement
217
+ requirements:
218
+ - - ">="
219
+ - !ruby/object:Gem::Version
220
+ version: '0'
221
+ requirements: []
222
+ rubyforge_project:
223
+ rubygems_version: 2.5.1
224
+ signing_key:
225
+ specification_version: 4
226
+ summary: Document Rest APIs
227
+ test_files:
228
+ - spec/dummy/db/test.sqlite3
229
+ - spec/dummy/config/locales/en.yml
230
+ - spec/dummy/config/cable.yml
231
+ - spec/dummy/config/secrets.yml
232
+ - spec/dummy/config/application.rb
233
+ - spec/dummy/config/database.yml
234
+ - spec/dummy/config/spring.rb
235
+ - spec/dummy/config/initializers/mime_types.rb
236
+ - spec/dummy/config/initializers/filter_parameter_logging.rb
237
+ - spec/dummy/config/initializers/session_store.rb
238
+ - spec/dummy/config/initializers/backtrace_silencers.rb
239
+ - spec/dummy/config/initializers/wrap_parameters.rb
240
+ - spec/dummy/config/initializers/inflections.rb
241
+ - spec/dummy/config/initializers/assets.rb
242
+ - spec/dummy/config/initializers/application_controller_renderer.rb
243
+ - spec/dummy/config/initializers/cookies_serializer.rb
244
+ - spec/dummy/config/initializers/new_framework_defaults.rb
245
+ - spec/dummy/config/boot.rb
246
+ - spec/dummy/config/environment.rb
247
+ - spec/dummy/config/puma.rb
248
+ - spec/dummy/config/routes.rb
249
+ - spec/dummy/config/environments/production.rb
250
+ - spec/dummy/config/environments/development.rb
251
+ - spec/dummy/config/environments/test.rb
252
+ - spec/dummy/Rakefile
253
+ - spec/dummy/config.ru
254
+ - spec/dummy/public/422.html
255
+ - spec/dummy/public/apple-touch-icon.png
256
+ - spec/dummy/public/500.html
257
+ - spec/dummy/public/404.html
258
+ - spec/dummy/public/apple-touch-icon-precomposed.png
259
+ - spec/dummy/public/favicon.ico
260
+ - spec/dummy/app/models/application_record.rb
261
+ - spec/dummy/app/helpers/application_helper.rb
262
+ - spec/dummy/app/jobs/application_job.rb
263
+ - spec/dummy/app/views/layouts/mailer.html.erb
264
+ - spec/dummy/app/views/layouts/application.html.erb
265
+ - spec/dummy/app/views/layouts/mailer.text.erb
266
+ - spec/dummy/app/controllers/application_controller.rb
267
+ - spec/dummy/app/assets/config/manifest.js
268
+ - spec/dummy/app/assets/javascripts/application.js
269
+ - spec/dummy/app/assets/javascripts/cable.js
270
+ - spec/dummy/app/assets/stylesheets/application.css
271
+ - spec/dummy/app/mailers/application_mailer.rb
272
+ - spec/dummy/app/channels/application_cable/channel.rb
273
+ - spec/dummy/app/channels/application_cable/connection.rb
274
+ - spec/dummy/bin/rake
275
+ - spec/dummy/bin/update
276
+ - spec/dummy/bin/rails
277
+ - spec/dummy/bin/setup
278
+ - spec/dummy/bin/bundle
279
+ - spec/generators/apidoco_generator_spec.rb
280
+ - spec/rails_helper.rb
281
+ - spec/spec_helper.rb