api_doc_viewer 0.2.0 → 0.3.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.
- checksums.yaml +4 -4
- data/app/assets/javascripts/api_doc_viewer/angular/controllers/mainController.js.coffee +6 -14
- data/app/assets/javascripts/api_doc_viewer/angular/services/mainService.js.coffee +26 -8
- data/app/assets/javascripts/api_doc_viewer/app.js.coffee +1 -4
- data/app/assets/javascripts/api_doc_viewer/vendor/angular-highlightjs.js +287 -0
- data/app/assets/javascripts/api_doc_viewer/vendor/jquery.ba-bbq.js +1286 -0
- data/app/assets/stylesheets/api_doc_viewer/application.css.scss +12 -2
- data/app/views/api_doc_viewer/main/index.html +4 -5
- data/app/views/layouts/api_doc_viewer/application.html.erb +7 -3
- data/lib/api_doc_viewer/version.rb +1 -1
- metadata +19 -18
- data/README.rdoc +0 -3
@@ -109,7 +109,7 @@ nav {
|
|
109
109
|
padding-right: 1em;
|
110
110
|
font-weight: bold;
|
111
111
|
}
|
112
|
-
.http-method {
|
112
|
+
.http-method {
|
113
113
|
font-size: 0.9em;
|
114
114
|
background-image: -webkit-linear-gradient(top, white 0%, #eee 100%);
|
115
115
|
padding: 0.3em 0.7em;
|
@@ -131,8 +131,18 @@ nav {
|
|
131
131
|
padding: 0.2em 0.4em;
|
132
132
|
border-radius: 0.3em;
|
133
133
|
}
|
134
|
-
|
134
|
+
.hljs {
|
135
135
|
margin-top: 20px;
|
136
|
+
background: white;
|
137
|
+
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
|
138
|
+
font-size: 14px;
|
139
|
+
.hljs-number {
|
140
|
+
color: blue;
|
141
|
+
font-weight: bold;
|
142
|
+
}
|
143
|
+
.hljs-string {
|
144
|
+
color: green;
|
145
|
+
}
|
136
146
|
}
|
137
147
|
}
|
138
148
|
.request {
|
@@ -21,7 +21,8 @@
|
|
21
21
|
</div>
|
22
22
|
<div class="row" ng-repeat="parameter in parameters">
|
23
23
|
<div class="parameter-name">
|
24
|
-
|
24
|
+
<span ng-if="!parameter.scope">{{parameter.name}}</span>
|
25
|
+
<span ng-if="parameter.scope">{{parameter.scope}}[{{parameter.name}}]</span>
|
25
26
|
<span style="color: red;" ng-if="parameter.required">*</span>
|
26
27
|
</div><div class="parameter-descriptions">{{parameter.description}}</div>
|
27
28
|
</div>
|
@@ -55,10 +56,8 @@
|
|
55
56
|
<span class="request-label">Request</span>
|
56
57
|
<span class="response-label">Response</span>
|
57
58
|
</header>
|
58
|
-
<div class="request">
|
59
|
-
|
60
|
-
</div><div class="response">
|
61
|
-
<pre>{{response.body}}</pre>
|
59
|
+
<div class="request" hljs source="request.body">
|
60
|
+
</div><div class="response" hljs source="response.body">
|
62
61
|
</div>
|
63
62
|
</section>
|
64
63
|
</div>
|
@@ -1,9 +1,13 @@
|
|
1
1
|
<!DOCTYPE html>
|
2
|
-
<html ng-app="
|
2
|
+
<html ng-app="apiDocViewer">
|
3
3
|
<head>
|
4
4
|
<title>ApiDocViewer</title>
|
5
|
-
<%= stylesheet_link_tag
|
6
|
-
<%= javascript_include_tag
|
5
|
+
<%= stylesheet_link_tag 'http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.2/styles/default.min.css' %>
|
6
|
+
<%= javascript_include_tag 'http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.2/highlight.min.js' %>
|
7
|
+
<%= javascript_include_tag 'http://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js' %>
|
8
|
+
<!-- Custom CSS & JavaScript -->
|
9
|
+
<%= stylesheet_link_tag 'api_doc_viewer/application' %>
|
10
|
+
<%= javascript_include_tag 'api_doc_viewer/application' %>
|
7
11
|
<%= csrf_meta_tags %>
|
8
12
|
</head>
|
9
13
|
<body ng-controller="mainController">
|
metadata
CHANGED
@@ -1,55 +1,55 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: api_doc_viewer
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Endri Gjiri
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-09-
|
11
|
+
date: 2014-09-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - ~>
|
17
|
+
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: '4.0'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
|
-
- - ~>
|
24
|
+
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '4.0'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: sqlite3
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- -
|
31
|
+
- - ">="
|
32
32
|
- !ruby/object:Gem::Version
|
33
33
|
version: '0'
|
34
34
|
type: :development
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
|
-
- -
|
38
|
+
- - ">="
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '0'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: awesome_print
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- -
|
45
|
+
- - ">="
|
46
46
|
- !ruby/object:Gem::Version
|
47
47
|
version: '0'
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- -
|
52
|
+
- - ">="
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '0'
|
55
55
|
description: Displays the documentation generated by the rspec_api_documentation gem
|
@@ -59,13 +59,17 @@ executables: []
|
|
59
59
|
extensions: []
|
60
60
|
extra_rdoc_files: []
|
61
61
|
files:
|
62
|
+
- MIT-LICENSE
|
63
|
+
- Rakefile
|
62
64
|
- app/assets/javascripts/api_doc_viewer/angular/controllers/mainController.js.coffee
|
63
65
|
- app/assets/javascripts/api_doc_viewer/angular/services/mainService.js.coffee
|
64
66
|
- app/assets/javascripts/api_doc_viewer/app.js.coffee
|
65
67
|
- app/assets/javascripts/api_doc_viewer/application.js
|
66
68
|
- app/assets/javascripts/api_doc_viewer/vendor/angular-1.2.15.min.js
|
69
|
+
- app/assets/javascripts/api_doc_viewer/vendor/angular-highlightjs.js
|
67
70
|
- app/assets/javascripts/api_doc_viewer/vendor/angular-resource-1.2.15.min.js
|
68
71
|
- app/assets/javascripts/api_doc_viewer/vendor/angular-route-1.2.15.min.js
|
72
|
+
- app/assets/javascripts/api_doc_viewer/vendor/jquery.ba-bbq.js
|
69
73
|
- app/assets/stylesheets/api_doc_viewer/application.css.scss
|
70
74
|
- app/controllers/api_doc_viewer/application_controller.rb
|
71
75
|
- app/controllers/api_doc_viewer/main_controller.rb
|
@@ -74,15 +78,14 @@ files:
|
|
74
78
|
- app/views/api_doc_viewer/main/index.html
|
75
79
|
- app/views/layouts/api_doc_viewer/application.html.erb
|
76
80
|
- config/routes.rb
|
81
|
+
- lib/api_doc_viewer.rb
|
77
82
|
- lib/api_doc_viewer/engine.rb
|
78
83
|
- lib/api_doc_viewer/version.rb
|
79
|
-
- lib/api_doc_viewer.rb
|
80
84
|
- lib/tasks/api_doc_viewer_tasks.rake
|
81
|
-
- MIT-LICENSE
|
82
|
-
- Rakefile
|
83
|
-
- README.rdoc
|
84
85
|
- test/api_doc_viewer_test.rb
|
85
86
|
- test/controllers/api_doc_viewer/main_controller_test.rb
|
87
|
+
- test/dummy/README.rdoc
|
88
|
+
- test/dummy/Rakefile
|
86
89
|
- test/dummy/app/assets/javascripts/application.js
|
87
90
|
- test/dummy/app/assets/stylesheets/application.css
|
88
91
|
- test/dummy/app/controllers/application_controller.rb
|
@@ -91,6 +94,7 @@ files:
|
|
91
94
|
- test/dummy/bin/bundle
|
92
95
|
- test/dummy/bin/rails
|
93
96
|
- test/dummy/bin/rake
|
97
|
+
- test/dummy/config.ru
|
94
98
|
- test/dummy/config/application.rb
|
95
99
|
- test/dummy/config/boot.rb
|
96
100
|
- test/dummy/config/database.yml
|
@@ -107,15 +111,12 @@ files:
|
|
107
111
|
- test/dummy/config/initializers/wrap_parameters.rb
|
108
112
|
- test/dummy/config/locales/en.yml
|
109
113
|
- test/dummy/config/routes.rb
|
110
|
-
- test/dummy/config.ru
|
111
114
|
- test/dummy/db/test.sqlite3
|
112
115
|
- test/dummy/log/test.log
|
113
116
|
- test/dummy/public/404.html
|
114
117
|
- test/dummy/public/422.html
|
115
118
|
- test/dummy/public/500.html
|
116
119
|
- test/dummy/public/favicon.ico
|
117
|
-
- test/dummy/Rakefile
|
118
|
-
- test/dummy/README.rdoc
|
119
120
|
- test/helpers/api_doc_viewer/main_helper_test.rb
|
120
121
|
- test/integration/navigation_test.rb
|
121
122
|
- test/test_helper.rb
|
@@ -128,17 +129,17 @@ require_paths:
|
|
128
129
|
- lib
|
129
130
|
required_ruby_version: !ruby/object:Gem::Requirement
|
130
131
|
requirements:
|
131
|
-
- -
|
132
|
+
- - ">="
|
132
133
|
- !ruby/object:Gem::Version
|
133
134
|
version: '0'
|
134
135
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
135
136
|
requirements:
|
136
|
-
- -
|
137
|
+
- - ">="
|
137
138
|
- !ruby/object:Gem::Version
|
138
139
|
version: '0'
|
139
140
|
requirements: []
|
140
141
|
rubyforge_project:
|
141
|
-
rubygems_version: 2.0
|
142
|
+
rubygems_version: 2.2.0
|
142
143
|
signing_key:
|
143
144
|
specification_version: 4
|
144
145
|
summary: Displays the documentation generated by the rspec_api_documentation gem
|
data/README.rdoc
DELETED