restapi_doc 0.0.3 → 0.0.4
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +4 -0
- data/VERSION +1 -1
- data/lib/restapi_doc.rb +6 -3
- data/restapi_doc.gemspec +2 -2
- metadata +14 -14
data/CHANGELOG.rdoc
CHANGED
@@ -10,4 +10,8 @@ Updated README.rdoc to show example of how to document a controller
|
|
10
10
|
Fixed bug #3 - While reading routes when controller is nil.
|
11
11
|
Fixed bug #2 - Omitted routes where method is root.
|
12
12
|
|
13
|
+
=== Version 0.0.4
|
14
|
+
|
15
|
+
Fixed bug #4 - Fails when method is not valid HTTP method in routes
|
16
|
+
|
13
17
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.0.
|
1
|
+
0.0.4
|
data/lib/restapi_doc.rb
CHANGED
@@ -11,6 +11,9 @@ module RestApiDoc
|
|
11
11
|
|
12
12
|
include Config
|
13
13
|
include FileUtils
|
14
|
+
|
15
|
+
# valid api methods
|
16
|
+
METHODS = ["GET", "PUT", "DELETE", "POST"]
|
14
17
|
|
15
18
|
def create_structure
|
16
19
|
File.directory?(config_dir) || mkdir(config_dir)
|
@@ -25,9 +28,9 @@ module RestApiDoc
|
|
25
28
|
controller_info = {}
|
26
29
|
routes = Dir.chdir(::Rails.root.to_s) { `rake routes` }
|
27
30
|
routes.split("\n").each do |entry|
|
28
|
-
method, url, controller_action = entry.split.slice(-3, 3)
|
29
31
|
begin
|
30
|
-
|
32
|
+
method, url, controller_action = entry.split.slice(-3, 3)
|
33
|
+
if METHODS.include? method.upcase
|
31
34
|
controller, action = controller_action.split('#')
|
32
35
|
controller_info[controller] ||= []
|
33
36
|
controller_info[controller] << [action, method, url]
|
@@ -101,4 +104,4 @@ module RestApiDoc
|
|
101
104
|
def remove_structure
|
102
105
|
rm_rf target_dir
|
103
106
|
end
|
104
|
-
end
|
107
|
+
end
|
data/restapi_doc.gemspec
CHANGED
@@ -5,11 +5,11 @@
|
|
5
5
|
|
6
6
|
Gem::Specification.new do |s|
|
7
7
|
s.name = "restapi_doc"
|
8
|
-
s.version = "0.0.
|
8
|
+
s.version = "0.0.4"
|
9
9
|
|
10
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
11
|
s.authors = ["Kevin Haight"]
|
12
|
-
s.date = "2012-
|
12
|
+
s.date = "2012-06-22"
|
13
13
|
s.description = "REST API doc generates an easy way to create a twitter style document for your RESTful interface. \n Leveraging Twitter Bootstrap to create an easy to read document for your RESTful api. "
|
14
14
|
s.email = "kevinjhaight@gmail.com"
|
15
15
|
s.extra_rdoc_files = [
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: restapi_doc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.4
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,11 +9,11 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-
|
12
|
+
date: 2012-06-22 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: activesupport
|
16
|
-
requirement: &
|
16
|
+
requirement: &2152452180 !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
19
|
- - ! '>='
|
@@ -21,10 +21,10 @@ dependencies:
|
|
21
21
|
version: '2.1'
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
|
-
version_requirements: *
|
24
|
+
version_requirements: *2152452180
|
25
25
|
- !ruby/object:Gem::Dependency
|
26
26
|
name: haml
|
27
|
-
requirement: &
|
27
|
+
requirement: &2152451660 !ruby/object:Gem::Requirement
|
28
28
|
none: false
|
29
29
|
requirements:
|
30
30
|
- - =
|
@@ -32,10 +32,10 @@ dependencies:
|
|
32
32
|
version: 3.1.4
|
33
33
|
type: :runtime
|
34
34
|
prerelease: false
|
35
|
-
version_requirements: *
|
35
|
+
version_requirements: *2152451660
|
36
36
|
- !ruby/object:Gem::Dependency
|
37
37
|
name: rake
|
38
|
-
requirement: &
|
38
|
+
requirement: &2152451080 !ruby/object:Gem::Requirement
|
39
39
|
none: false
|
40
40
|
requirements:
|
41
41
|
- - ! '>='
|
@@ -43,10 +43,10 @@ dependencies:
|
|
43
43
|
version: '0'
|
44
44
|
type: :development
|
45
45
|
prerelease: false
|
46
|
-
version_requirements: *
|
46
|
+
version_requirements: *2152451080
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
48
|
name: jeweler
|
49
|
-
requirement: &
|
49
|
+
requirement: &2152450160 !ruby/object:Gem::Requirement
|
50
50
|
none: false
|
51
51
|
requirements:
|
52
52
|
- - ! '>='
|
@@ -54,10 +54,10 @@ dependencies:
|
|
54
54
|
version: '0'
|
55
55
|
type: :development
|
56
56
|
prerelease: false
|
57
|
-
version_requirements: *
|
57
|
+
version_requirements: *2152450160
|
58
58
|
- !ruby/object:Gem::Dependency
|
59
59
|
name: rspec
|
60
|
-
requirement: &
|
60
|
+
requirement: &2152449580 !ruby/object:Gem::Requirement
|
61
61
|
none: false
|
62
62
|
requirements:
|
63
63
|
- - ! '>='
|
@@ -65,10 +65,10 @@ dependencies:
|
|
65
65
|
version: 2.2.0
|
66
66
|
type: :development
|
67
67
|
prerelease: false
|
68
|
-
version_requirements: *
|
68
|
+
version_requirements: *2152449580
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: mocha
|
71
|
-
requirement: &
|
71
|
+
requirement: &2152449040 !ruby/object:Gem::Requirement
|
72
72
|
none: false
|
73
73
|
requirements:
|
74
74
|
- - ! '>='
|
@@ -76,7 +76,7 @@ dependencies:
|
|
76
76
|
version: '0'
|
77
77
|
type: :development
|
78
78
|
prerelease: false
|
79
|
-
version_requirements: *
|
79
|
+
version_requirements: *2152449040
|
80
80
|
description: ! "REST API doc generates an easy way to create a twitter style document
|
81
81
|
for your RESTful interface. \n Leveraging Twitter Bootstrap
|
82
82
|
to create an easy to read document for your RESTful api. "
|