whurl_engine 2.0.0 → 2.0.1
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.
- data/README.markdown +8 -0
- data/db/migrate/20110209054322_create_whurls_table.rb +14 -0
- data/db/migrate/20111210192724_add_description_to_whurl.rb +9 -0
- data/db/migrate/20111210201607_add_custom_url_to_whurl.rb +9 -0
- data/db/migrate/20111211030904_rename_whurls_to_requests.rb +8 -0
- data/db/migrate/20111220233800_create_fields_for_whurl_requests.rb +18 -0
- data/db/migrate/20111221011145_drop_data_from_requests.rb +9 -0
- data/db/migrate/20120106033416_create_responses.rb +11 -0
- data/db/migrate/20120106190508_create_categories_table.rb +9 -0
- data/db/migrate/20120107011500_create_resources_table.rb +15 -0
- data/db/migrate/20120107065652_create_parameters_table.rb +12 -0
- data/db/migrate/20120110205837_rename_parameters_to_parameter_definitions.rb +5 -0
- data/db/migrate/20120110205853_rename_requests_to_whurls.rb +19 -0
- data/db/migrate/20120111014928_add_raw_request_to_whurls.rb +5 -0
- data/db/migrate/20120118011913_create_header_definitions_table.rb +10 -0
- data/lib/whurl_engine/version.rb +1 -1
- metadata +40 -39
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/off.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/on.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_center.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_left.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_right.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/off.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/on.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_center.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_left.png +0 -0
- data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_right.png +0 -0
- data/db/migrate/20120212182833_create_schema.rb +0 -57
data/README.markdown
CHANGED
@@ -21,6 +21,14 @@ Then in your main app's routes.rb file, add this to make the whurl_engine routab
|
|
21
21
|
|
22
22
|
mount WhurlEngine::Engine => "/whurl", :as => "whurl_engine"
|
23
23
|
|
24
|
+
Figure out how you want to authorize users for setting up the documentation vs. viewing it. Whurl
|
25
|
+
comes with a default CanCan adapter. To us it install the cancan gem in your app and add a new whurl.rb to config/initializers:
|
26
|
+
|
27
|
+
WhurlEngine.config do |config|
|
28
|
+
config.current_user_method { current_user }
|
29
|
+
config.authorize_with(:cancan)
|
30
|
+
end
|
31
|
+
|
24
32
|
Finally, look at your new API playground by starting your rails server and hitting up the right URL:
|
25
33
|
|
26
34
|
http://localhost:3000/whurl
|
@@ -0,0 +1,14 @@
|
|
1
|
+
class CreateWhurlsTable < ActiveRecord::Migration
|
2
|
+
def self.up
|
3
|
+
create_table :whurls do |t|
|
4
|
+
t.string :hash_key, :limit => 6, :null => false
|
5
|
+
t.text :data
|
6
|
+
t.timestamps
|
7
|
+
end
|
8
|
+
add_index :whurls, :hash_key, :unique => true
|
9
|
+
end
|
10
|
+
|
11
|
+
def self.down
|
12
|
+
drop_table :whurls
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
class CreateFieldsForWhurlRequests < ActiveRecord::Migration
|
2
|
+
def self.up
|
3
|
+
add_column :whurl_engine_requests, :http_method, :string, :limit => 10
|
4
|
+
add_column :whurl_engine_requests, :body, :text
|
5
|
+
add_column :whurl_engine_requests, :query, :text
|
6
|
+
add_column :whurl_engine_requests, :headers, :text
|
7
|
+
add_column :whurl_engine_requests, :url, :text
|
8
|
+
|
9
|
+
end
|
10
|
+
|
11
|
+
def self.down
|
12
|
+
remove_column :whurl_engine_requests, :http_method
|
13
|
+
remove_column :whurl_engine_requests, :body
|
14
|
+
remove_column :whurl_engine_requests, :query
|
15
|
+
remove_column :whurl_engine_requests, :headers
|
16
|
+
remove_column :whurl_engine_requests, :url
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
class CreateResourcesTable < ActiveRecord::Migration
|
2
|
+
def change
|
3
|
+
create_table :whurl_engine_resources do |t|
|
4
|
+
t.integer :category_id
|
5
|
+
t.string :base_uri
|
6
|
+
t.string :relative_path
|
7
|
+
t.string :http_method
|
8
|
+
t.text :description
|
9
|
+
t.boolean :rate_limited
|
10
|
+
t.boolean :requires_authentication
|
11
|
+
t.text :response_formats
|
12
|
+
t.timestamps
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
class CreateParametersTable < ActiveRecord::Migration
|
2
|
+
def change
|
3
|
+
create_table :whurl_engine_parameters do |t|
|
4
|
+
t.integer :resource_id
|
5
|
+
t.string :name
|
6
|
+
t.string :example_value
|
7
|
+
t.text :description
|
8
|
+
t.boolean :required
|
9
|
+
t.timestamps
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
class RenameRequestsToWhurls < ActiveRecord::Migration
|
2
|
+
def up
|
3
|
+
rename_table :whurl_engine_requests, :whurl_engine_whurls
|
4
|
+
drop_table :whurl_engine_responses
|
5
|
+
rename_column :whurl_engine_whurls, :custom_url, :name
|
6
|
+
rename_column :whurl_engine_whurls, :query, :request_parameters
|
7
|
+
rename_column :whurl_engine_whurls, :body, :request_body
|
8
|
+
rename_column :whurl_engine_whurls, :headers, :request_headers
|
9
|
+
rename_column :whurl_engine_whurls, :http_method, :request_method
|
10
|
+
rename_column :whurl_engine_whurls, :url, :request_url
|
11
|
+
add_column :whurl_engine_whurls, :resource_id, :integer
|
12
|
+
add_column :whurl_engine_whurls, :response_body, :text
|
13
|
+
add_column :whurl_engine_whurls, :response_content_type, :string
|
14
|
+
add_column :whurl_engine_whurls, :response_headers, :text
|
15
|
+
end
|
16
|
+
|
17
|
+
def down
|
18
|
+
end
|
19
|
+
end
|
data/lib/whurl_engine/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: whurl_engine
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.1
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,12 +9,12 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-02-
|
12
|
+
date: 2012-02-15 00:00:00.000000000 -08:00
|
13
13
|
default_executable:
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: coderay
|
17
|
-
requirement: &
|
17
|
+
requirement: &2158232900 !ruby/object:Gem::Requirement
|
18
18
|
none: false
|
19
19
|
requirements:
|
20
20
|
- - ~>
|
@@ -22,10 +22,10 @@ dependencies:
|
|
22
22
|
version: 0.9.6
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
|
-
version_requirements: *
|
25
|
+
version_requirements: *2158232900
|
26
26
|
- !ruby/object:Gem::Dependency
|
27
27
|
name: coffee-script
|
28
|
-
requirement: &
|
28
|
+
requirement: &2158232480 !ruby/object:Gem::Requirement
|
29
29
|
none: false
|
30
30
|
requirements:
|
31
31
|
- - ! '>='
|
@@ -33,10 +33,10 @@ dependencies:
|
|
33
33
|
version: '0'
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
|
-
version_requirements: *
|
36
|
+
version_requirements: *2158232480
|
37
37
|
- !ruby/object:Gem::Dependency
|
38
38
|
name: httmultiparty
|
39
|
-
requirement: &
|
39
|
+
requirement: &2158231940 !ruby/object:Gem::Requirement
|
40
40
|
none: false
|
41
41
|
requirements:
|
42
42
|
- - ~>
|
@@ -44,10 +44,10 @@ dependencies:
|
|
44
44
|
version: '0.2'
|
45
45
|
type: :runtime
|
46
46
|
prerelease: false
|
47
|
-
version_requirements: *
|
47
|
+
version_requirements: *2158231940
|
48
48
|
- !ruby/object:Gem::Dependency
|
49
49
|
name: haml
|
50
|
-
requirement: &
|
50
|
+
requirement: &2158231440 !ruby/object:Gem::Requirement
|
51
51
|
none: false
|
52
52
|
requirements:
|
53
53
|
- - ~>
|
@@ -55,10 +55,10 @@ dependencies:
|
|
55
55
|
version: 3.1.4
|
56
56
|
type: :runtime
|
57
57
|
prerelease: false
|
58
|
-
version_requirements: *
|
58
|
+
version_requirements: *2158231440
|
59
59
|
- !ruby/object:Gem::Dependency
|
60
60
|
name: json
|
61
|
-
requirement: &
|
61
|
+
requirement: &2158230980 !ruby/object:Gem::Requirement
|
62
62
|
none: false
|
63
63
|
requirements:
|
64
64
|
- - ! '>='
|
@@ -66,10 +66,10 @@ dependencies:
|
|
66
66
|
version: 1.5.1
|
67
67
|
type: :runtime
|
68
68
|
prerelease: false
|
69
|
-
version_requirements: *
|
69
|
+
version_requirements: *2158230980
|
70
70
|
- !ruby/object:Gem::Dependency
|
71
71
|
name: rails
|
72
|
-
requirement: &
|
72
|
+
requirement: &2158230520 !ruby/object:Gem::Requirement
|
73
73
|
none: false
|
74
74
|
requirements:
|
75
75
|
- - ~>
|
@@ -77,10 +77,10 @@ dependencies:
|
|
77
77
|
version: 3.1.3
|
78
78
|
type: :runtime
|
79
79
|
prerelease: false
|
80
|
-
version_requirements: *
|
80
|
+
version_requirements: *2158230520
|
81
81
|
- !ruby/object:Gem::Dependency
|
82
82
|
name: rinku
|
83
|
-
requirement: &
|
83
|
+
requirement: &2158230060 !ruby/object:Gem::Requirement
|
84
84
|
none: false
|
85
85
|
requirements:
|
86
86
|
- - ~>
|
@@ -88,10 +88,10 @@ dependencies:
|
|
88
88
|
version: 1.5.0
|
89
89
|
type: :runtime
|
90
90
|
prerelease: false
|
91
|
-
version_requirements: *
|
91
|
+
version_requirements: *2158230060
|
92
92
|
- !ruby/object:Gem::Dependency
|
93
93
|
name: sass
|
94
|
-
requirement: &
|
94
|
+
requirement: &2158229600 !ruby/object:Gem::Requirement
|
95
95
|
none: false
|
96
96
|
requirements:
|
97
97
|
- - ~>
|
@@ -99,10 +99,10 @@ dependencies:
|
|
99
99
|
version: 3.1.10
|
100
100
|
type: :runtime
|
101
101
|
prerelease: false
|
102
|
-
version_requirements: *
|
102
|
+
version_requirements: *2158229600
|
103
103
|
- !ruby/object:Gem::Dependency
|
104
104
|
name: uglifier
|
105
|
-
requirement: &
|
105
|
+
requirement: &2158229220 !ruby/object:Gem::Requirement
|
106
106
|
none: false
|
107
107
|
requirements:
|
108
108
|
- - ! '>='
|
@@ -110,10 +110,10 @@ dependencies:
|
|
110
110
|
version: '0'
|
111
111
|
type: :runtime
|
112
112
|
prerelease: false
|
113
|
-
version_requirements: *
|
113
|
+
version_requirements: *2158229220
|
114
114
|
- !ruby/object:Gem::Dependency
|
115
115
|
name: heroku
|
116
|
-
requirement: &
|
116
|
+
requirement: &2158228760 !ruby/object:Gem::Requirement
|
117
117
|
none: false
|
118
118
|
requirements:
|
119
119
|
- - ! '>='
|
@@ -121,10 +121,10 @@ dependencies:
|
|
121
121
|
version: '0'
|
122
122
|
type: :development
|
123
123
|
prerelease: false
|
124
|
-
version_requirements: *
|
124
|
+
version_requirements: *2158228760
|
125
125
|
- !ruby/object:Gem::Dependency
|
126
126
|
name: mysql
|
127
|
-
requirement: &
|
127
|
+
requirement: &2158228260 !ruby/object:Gem::Requirement
|
128
128
|
none: false
|
129
129
|
requirements:
|
130
130
|
- - ~>
|
@@ -132,10 +132,10 @@ dependencies:
|
|
132
132
|
version: 2.8.1
|
133
133
|
type: :development
|
134
134
|
prerelease: false
|
135
|
-
version_requirements: *
|
135
|
+
version_requirements: *2158228260
|
136
136
|
- !ruby/object:Gem::Dependency
|
137
137
|
name: webmock
|
138
|
-
requirement: &
|
138
|
+
requirement: &2158227760 !ruby/object:Gem::Requirement
|
139
139
|
none: false
|
140
140
|
requirements:
|
141
141
|
- - ~>
|
@@ -143,7 +143,7 @@ dependencies:
|
|
143
143
|
version: 1.7.10
|
144
144
|
type: :development
|
145
145
|
prerelease: false
|
146
|
-
version_requirements: *
|
146
|
+
version_requirements: *2158227760
|
147
147
|
description: ! "Whurl is a mountable engine for Rails 3.1+ apps allowing\n you
|
148
148
|
to show the functionality of your API. You can save API calls and share them with
|
149
149
|
your team or the public."
|
@@ -195,18 +195,6 @@ files:
|
|
195
195
|
- app/assets/stylesheets/whurl_engine/custom-theme/images/ui-icons_ef8c08_256x240.png
|
196
196
|
- app/assets/stylesheets/whurl_engine/custom-theme/images/ui-icons_ffffff_256x240.png
|
197
197
|
- app/assets/stylesheets/whurl_engine/custom-theme/jquery-ui-1.8.16.custom.css
|
198
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/off.png
|
199
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/on.png
|
200
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider.png
|
201
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_center.png
|
202
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_left.png
|
203
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_right.png
|
204
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/off.png
|
205
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/on.png
|
206
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider.png
|
207
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_center.png
|
208
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_left.png
|
209
|
-
- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_right.png
|
210
198
|
- app/assets/stylesheets/whurl_engine/whurl.css.scss
|
211
199
|
- app/controllers/whurl_engine/application_controller.rb
|
212
200
|
- app/controllers/whurl_engine/categories_controller.rb
|
@@ -267,7 +255,20 @@ files:
|
|
267
255
|
- config/initializers/nilclass.rb
|
268
256
|
- config/initializers/string.rb
|
269
257
|
- config/routes.rb
|
270
|
-
- db/migrate/
|
258
|
+
- db/migrate/20110209054322_create_whurls_table.rb
|
259
|
+
- db/migrate/20111210192724_add_description_to_whurl.rb
|
260
|
+
- db/migrate/20111210201607_add_custom_url_to_whurl.rb
|
261
|
+
- db/migrate/20111211030904_rename_whurls_to_requests.rb
|
262
|
+
- db/migrate/20111220233800_create_fields_for_whurl_requests.rb
|
263
|
+
- db/migrate/20111221011145_drop_data_from_requests.rb
|
264
|
+
- db/migrate/20120106033416_create_responses.rb
|
265
|
+
- db/migrate/20120106190508_create_categories_table.rb
|
266
|
+
- db/migrate/20120107011500_create_resources_table.rb
|
267
|
+
- db/migrate/20120107065652_create_parameters_table.rb
|
268
|
+
- db/migrate/20120110205837_rename_parameters_to_parameter_definitions.rb
|
269
|
+
- db/migrate/20120110205853_rename_requests_to_whurls.rb
|
270
|
+
- db/migrate/20120111014928_add_raw_request_to_whurls.rb
|
271
|
+
- db/migrate/20120118011913_create_header_definitions_table.rb
|
271
272
|
- db/migrate/20120214074332_add_message_to_whurls.rb
|
272
273
|
- lib/tasks/whurl_engine_tasks.rake
|
273
274
|
- lib/whurl_engine/config.rb
|
data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/off.png
DELETED
Binary file
|
data/app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/on.png
DELETED
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
@@ -1,57 +0,0 @@
|
|
1
|
-
class CreateSchema < ActiveRecord::Migration
|
2
|
-
def up
|
3
|
-
create_table :whurl_engine_categories do |t|
|
4
|
-
t.string :name
|
5
|
-
t.text :description
|
6
|
-
t.timestamps
|
7
|
-
end
|
8
|
-
|
9
|
-
create_table :whurl_engine_header_definitions do |t|
|
10
|
-
t.integer :resource_id
|
11
|
-
t.string :name
|
12
|
-
t.string :example_value
|
13
|
-
t.text :description
|
14
|
-
t.boolean :required
|
15
|
-
t.timestamps
|
16
|
-
end
|
17
|
-
|
18
|
-
create_table :whurl_engine_parameter_definitions do |t|
|
19
|
-
t.integer :resource_id
|
20
|
-
t.string :name
|
21
|
-
t.string :example_value
|
22
|
-
t.text :description
|
23
|
-
t.boolean :required
|
24
|
-
t.timestamps
|
25
|
-
end
|
26
|
-
|
27
|
-
create_table :whurl_engine_resources do |t|
|
28
|
-
t.integer :category_id
|
29
|
-
t.string :base_uri
|
30
|
-
t.string :relative_path
|
31
|
-
t.string :http_method
|
32
|
-
t.text :description
|
33
|
-
t.boolean :rate_limited
|
34
|
-
t.boolean :requires_authentication
|
35
|
-
t.text :response_formats
|
36
|
-
t.timestamps
|
37
|
-
end
|
38
|
-
|
39
|
-
create_table :whurl_engine_whurls do |t|
|
40
|
-
t.string :hash_key, :limit => 6, :null => false
|
41
|
-
t.string :description
|
42
|
-
t.string :request_method, :limit => 10
|
43
|
-
t.text :request_body
|
44
|
-
t.text :request_parameters
|
45
|
-
t.text :request_headers
|
46
|
-
t.text :request_url
|
47
|
-
t.integer :resource_id
|
48
|
-
t.text :response_body
|
49
|
-
t.string :response_content_type
|
50
|
-
t.text :response_headers
|
51
|
-
t.text :raw_request
|
52
|
-
t.timestamps
|
53
|
-
end
|
54
|
-
|
55
|
-
add_index :whurl_engine_whurls, [:hash_key], :name => :index_whurls_on_hash_key, :unique => true
|
56
|
-
end
|
57
|
-
end
|