raddocs 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/raddocs/app.rb +8 -2
- data/lib/raddocs/configuration.rb +2 -1
- data/lib/views/example.haml +2 -2
- metadata +22 -39
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 71f055331c834b143aa8a9bb39d54a6664a2d074
|
4
|
+
data.tar.gz: 7fa4ed3fb320faf6879f79cdec6f4d0d1a976d43
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 52bc64c45dac58c23fbce98b6b71407865195aa4101286340c51b30c53d0bafeee4ad1b3b91ce7a66b32f13cbbb2f8dc4c13d77d23265136fe2117335eff0ca3
|
7
|
+
data.tar.gz: faa9822a1919ede42ebacf10df54ea13c121821ed256e8e5a3c360698c707fa98646e2280d4dfd684b7f9a88c98051187cfa0a7e98b51838218d7b67e538e8ed
|
data/lib/raddocs/app.rb
CHANGED
@@ -39,11 +39,17 @@ module Raddocs
|
|
39
39
|
|
40
40
|
helpers do
|
41
41
|
def link_to(name, link)
|
42
|
-
%{<a href="#{
|
42
|
+
%{<a href="#{url_location}#{link}">#{name}</a>}
|
43
43
|
end
|
44
44
|
|
45
45
|
def url_location
|
46
|
-
request.env["SCRIPT_NAME"]
|
46
|
+
"#{url_prefix}#{request.env["SCRIPT_NAME"]}"
|
47
|
+
end
|
48
|
+
|
49
|
+
def url_prefix
|
50
|
+
url = Raddocs.configuration.url_prefix
|
51
|
+
return '' if url.to_s.empty?
|
52
|
+
url.start_with?('/') ? url : "/#{url}"
|
47
53
|
end
|
48
54
|
|
49
55
|
def api_name
|
@@ -13,11 +13,12 @@ module Raddocs
|
|
13
13
|
end
|
14
14
|
end
|
15
15
|
|
16
|
-
add_setting :docs_dir, :default => "
|
16
|
+
add_setting :docs_dir, :default => "doc/api"
|
17
17
|
add_setting :docs_mime_type, :default => /text\/docs\+plain/
|
18
18
|
add_setting :api_name, :default => "Api Documentation"
|
19
19
|
add_setting :include_bootstrap, :default => true
|
20
20
|
add_setting :external_css, :default => []
|
21
|
+
add_setting :url_prefix, :default => nil
|
21
22
|
|
22
23
|
def settings
|
23
24
|
@settings ||= {}
|
data/lib/views/example.haml
CHANGED
@@ -87,7 +87,7 @@
|
|
87
87
|
- if request["request_body"]
|
88
88
|
%section.body
|
89
89
|
%h4 Body
|
90
|
-
.content{ "data-content-type" => request["
|
90
|
+
.content{ "data-content-type" => request["request_headers"]["Content-Type"] }
|
91
91
|
%textarea
|
92
92
|
:preserve
|
93
93
|
#{request["request_body"]}
|
@@ -119,7 +119,7 @@
|
|
119
119
|
- if request["response_body"]
|
120
120
|
%section.body
|
121
121
|
%h4 Body
|
122
|
-
.content{ "data-content-type" => request["
|
122
|
+
.content{ "data-content-type" => request["response_headers"]["Content-Type"] }
|
123
123
|
%textarea
|
124
124
|
:preserve
|
125
125
|
#{request["response_body"]}
|
metadata
CHANGED
@@ -1,126 +1,111 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: raddocs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
5
|
-
prerelease:
|
4
|
+
version: 0.3.0
|
6
5
|
platform: ruby
|
7
6
|
authors:
|
8
7
|
- Eric Oestrich
|
9
8
|
autorequire:
|
10
9
|
bindir: bin
|
11
10
|
cert_chain: []
|
12
|
-
date: 2013-
|
11
|
+
date: 2013-12-16 00:00:00.000000000 Z
|
13
12
|
dependencies:
|
14
13
|
- !ruby/object:Gem::Dependency
|
15
14
|
name: sinatra
|
16
15
|
requirement: !ruby/object:Gem::Requirement
|
17
|
-
none: false
|
18
16
|
requirements:
|
19
|
-
- -
|
17
|
+
- - ">="
|
20
18
|
- !ruby/object:Gem::Version
|
21
19
|
version: '0'
|
22
20
|
type: :runtime
|
23
21
|
prerelease: false
|
24
22
|
version_requirements: !ruby/object:Gem::Requirement
|
25
|
-
none: false
|
26
23
|
requirements:
|
27
|
-
- -
|
24
|
+
- - ">="
|
28
25
|
- !ruby/object:Gem::Version
|
29
26
|
version: '0'
|
30
27
|
- !ruby/object:Gem::Dependency
|
31
28
|
name: haml
|
32
29
|
requirement: !ruby/object:Gem::Requirement
|
33
|
-
none: false
|
34
30
|
requirements:
|
35
|
-
- -
|
31
|
+
- - ">="
|
36
32
|
- !ruby/object:Gem::Version
|
37
33
|
version: '0'
|
38
34
|
type: :runtime
|
39
35
|
prerelease: false
|
40
36
|
version_requirements: !ruby/object:Gem::Requirement
|
41
|
-
none: false
|
42
37
|
requirements:
|
43
|
-
- -
|
38
|
+
- - ">="
|
44
39
|
- !ruby/object:Gem::Version
|
45
40
|
version: '0'
|
46
41
|
- !ruby/object:Gem::Dependency
|
47
42
|
name: json
|
48
43
|
requirement: !ruby/object:Gem::Requirement
|
49
|
-
none: false
|
50
44
|
requirements:
|
51
|
-
- -
|
45
|
+
- - ">="
|
52
46
|
- !ruby/object:Gem::Version
|
53
47
|
version: '0'
|
54
48
|
type: :runtime
|
55
49
|
prerelease: false
|
56
50
|
version_requirements: !ruby/object:Gem::Requirement
|
57
|
-
none: false
|
58
51
|
requirements:
|
59
|
-
- -
|
52
|
+
- - ">="
|
60
53
|
- !ruby/object:Gem::Version
|
61
54
|
version: '0'
|
62
55
|
- !ruby/object:Gem::Dependency
|
63
56
|
name: rspec
|
64
57
|
requirement: !ruby/object:Gem::Requirement
|
65
|
-
none: false
|
66
58
|
requirements:
|
67
|
-
- -
|
59
|
+
- - ">="
|
68
60
|
- !ruby/object:Gem::Version
|
69
61
|
version: '0'
|
70
62
|
type: :development
|
71
63
|
prerelease: false
|
72
64
|
version_requirements: !ruby/object:Gem::Requirement
|
73
|
-
none: false
|
74
65
|
requirements:
|
75
|
-
- -
|
66
|
+
- - ">="
|
76
67
|
- !ruby/object:Gem::Version
|
77
68
|
version: '0'
|
78
69
|
- !ruby/object:Gem::Dependency
|
79
70
|
name: rack-test
|
80
71
|
requirement: !ruby/object:Gem::Requirement
|
81
|
-
none: false
|
82
72
|
requirements:
|
83
|
-
- -
|
73
|
+
- - ">="
|
84
74
|
- !ruby/object:Gem::Version
|
85
75
|
version: '0'
|
86
76
|
type: :development
|
87
77
|
prerelease: false
|
88
78
|
version_requirements: !ruby/object:Gem::Requirement
|
89
|
-
none: false
|
90
79
|
requirements:
|
91
|
-
- -
|
80
|
+
- - ">="
|
92
81
|
- !ruby/object:Gem::Version
|
93
82
|
version: '0'
|
94
83
|
- !ruby/object:Gem::Dependency
|
95
84
|
name: capybara
|
96
85
|
requirement: !ruby/object:Gem::Requirement
|
97
|
-
none: false
|
98
86
|
requirements:
|
99
|
-
- -
|
87
|
+
- - ">="
|
100
88
|
- !ruby/object:Gem::Version
|
101
89
|
version: '0'
|
102
90
|
type: :development
|
103
91
|
prerelease: false
|
104
92
|
version_requirements: !ruby/object:Gem::Requirement
|
105
|
-
none: false
|
106
93
|
requirements:
|
107
|
-
- -
|
94
|
+
- - ">="
|
108
95
|
- !ruby/object:Gem::Version
|
109
96
|
version: '0'
|
110
97
|
- !ruby/object:Gem::Dependency
|
111
98
|
name: rake
|
112
99
|
requirement: !ruby/object:Gem::Requirement
|
113
|
-
none: false
|
114
100
|
requirements:
|
115
|
-
- -
|
101
|
+
- - ">="
|
116
102
|
- !ruby/object:Gem::Version
|
117
103
|
version: '0'
|
118
104
|
type: :development
|
119
105
|
prerelease: false
|
120
106
|
version_requirements: !ruby/object:Gem::Requirement
|
121
|
-
none: false
|
122
107
|
requirements:
|
123
|
-
- -
|
108
|
+
- - ">="
|
124
109
|
- !ruby/object:Gem::Version
|
125
110
|
version: '0'
|
126
111
|
description: Browse documentation generated by the rspec_api_documentation gem
|
@@ -139,37 +124,35 @@ files:
|
|
139
124
|
- lib/public/js/mode/htmlmixed/htmlmixed.js
|
140
125
|
- lib/public/js/mode/javascript/javascript.js
|
141
126
|
- lib/public/js/mode/xml/xml.js
|
127
|
+
- lib/raddocs.rb
|
142
128
|
- lib/raddocs/app.rb
|
143
129
|
- lib/raddocs/configuration.rb
|
144
130
|
- lib/raddocs/middleware.rb
|
145
131
|
- lib/raddocs/parameters.rb
|
146
|
-
- lib/raddocs.rb
|
147
132
|
- lib/views/example.haml
|
148
133
|
- lib/views/index.haml
|
149
134
|
- lib/views/layout.haml
|
150
135
|
homepage: http://github.com/oestrich/raddocs
|
151
136
|
licenses: []
|
137
|
+
metadata: {}
|
152
138
|
post_install_message:
|
153
139
|
rdoc_options: []
|
154
140
|
require_paths:
|
155
141
|
- lib
|
156
142
|
required_ruby_version: !ruby/object:Gem::Requirement
|
157
|
-
none: false
|
158
143
|
requirements:
|
159
|
-
- -
|
144
|
+
- - ">="
|
160
145
|
- !ruby/object:Gem::Version
|
161
146
|
version: '0'
|
162
147
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
163
|
-
none: false
|
164
148
|
requirements:
|
165
|
-
- -
|
149
|
+
- - ">="
|
166
150
|
- !ruby/object:Gem::Version
|
167
151
|
version: 1.3.6
|
168
152
|
requirements: []
|
169
153
|
rubyforge_project:
|
170
|
-
rubygems_version:
|
154
|
+
rubygems_version: 2.2.0
|
171
155
|
signing_key:
|
172
|
-
specification_version:
|
156
|
+
specification_version: 4
|
173
157
|
summary: Browse documentation generated by the rspec_api_documentation gem
|
174
158
|
test_files: []
|
175
|
-
has_rdoc:
|