Merge remote-tracking branch 'origin/master' into remove_rack_test

Author: samwgoldman

example/Gemfile

@@ -22,4 +22,5 @@ end
 group :test, :development do
   gem 'rspec-rails'
   gem 'rspec_api_documentation', :path => "../"
+  gem 'raddocs', '0.0.2'
 end

example/Gemfile.lock

@@ -58,6 +58,7 @@ GEM
     erubis (2.7.0)
     execjs (1.2.12)
       multi_json (~> 1.0)
+    haml (3.1.4)
     has_scope (0.5.1)
     hike (1.2.1)
     i18n (0.6.0)
@@ -84,10 +85,16 @@ GEM
       rack (>= 0.4)
     rack-mount (0.8.3)
       rack (>= 1.0.0)
+    rack-protection (1.2.0)
+      rack
     rack-ssl (1.3.2)
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
+    raddocs (0.0.2)
+      haml
+      json
+      sinatra
     rails (3.1.3)
       actionmailer (= 3.1.3)
       actionpack (= 3.1.3)
@@ -126,6 +133,10 @@ GEM
       railties (~> 3.1.0)
       sass (~> 3.1.10)
       tilt (~> 1.3.2)
+    sinatra (1.3.1)
+      rack (~> 1.3, >= 1.3.4)
+      rack-protection (~> 1.1, >= 1.1.2)
+      tilt (~> 1.3, >= 1.3.3)
     sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -152,6 +163,7 @@ DEPENDENCIES
   inherited_resources
   jquery-rails
   json_spec
+  raddocs (= 0.0.2)
   rails (= 3.1.3)
   rspec-rails
   rspec_api_documentation!

example/config/routes.rb

@@ -1,3 +1,5 @@
 Example::Application.routes.draw do
   resources :orders
+
+  match "/docs" => Raddocs, :anchor => false
 end

example/public/docs/index.html renamed to example/docs/index.html

@@ -90,7 +90,7 @@ <h4>Headers</h4>
 X-Ua-Compatible: IE=Edge,chrome=1
 E-Tag: &quot;5fffd66f61cdd4ab8881584dbf5e72cf&quot;
 Cache-Control: max-age=0, private, must-revalidate
-X-Runtime: 0.017610
+X-Runtime: 0.008944
 Content-Length: 58</pre>
             <h4>Status</h4>
             <pre class="response status">201 Created</pre>
@@ -121,7 +121,7 @@ <h4>Headers</h4>
 X-Ua-Compatible: IE=Edge,chrome=1
 E-Tag: &quot;5fffd66f61cdd4ab8881584dbf5e72cf&quot;
 Cache-Control: max-age=0, private, must-revalidate
-X-Runtime: 0.003642
+X-Runtime: 0.003856
 Content-Length: 58</pre>
             <h4>Status</h4>
             <pre class="response status">200 OK</pre>

example/public/docs/index.json renamed to example/docs/index.json

@@ -0,0 +1 @@
+{"resource":"Orders","description":"Creating an order","explanation":null,"parameters":[{"name":"name","description":"Name of order","required":true,"scope":"order"},{"name":"paid","description":"If the order has been paid for","required":true,"scope":"order"},{"name":"email","description":"Email of user that placed the order","scope":"order"}],"requests":[{"request_method":"POST","request_path":"/orders","request_body":"<div class=\"CodeRay\">\n  <div class=\"code\"><pre>{\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>order</span><span style=\"color:#404\">&quot;</span></span>: {\n    <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>name</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"background-color:hsla(0,100%,50%,0.05)\"><span style=\"color:#710\">&quot;</span><span style=\"color:#D20\">Order 1</span><span style=\"color:#710\">&quot;</span></span>,\n    <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>paid</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"color:#088\">true</span>,\n    <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>email</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"background-color:hsla(0,100%,50%,0.05)\"><span style=\"color:#710\">&quot;</span><span style=\"color:#D20\">[email protected]</span><span style=\"color:#710\">&quot;</span></span>\n  }\n}</pre></div>\n</div>\n","request_headers":"Accept: application/json\nContent-Type: application/json\nHost: example.org\nCookie: ","request_query_parameters":null,"response_status":201,"response_status_text":"Created","response_body":"<div class=\"CodeRay\">\n  <div class=\"code\"><pre>{\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>email</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"background-color:hsla(0,100%,50%,0.05)\"><span style=\"color:#710\">&quot;</span><span style=\"color:#D20\">[email protected]</span><span style=\"color:#710\">&quot;</span></span>,\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>name</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"background-color:hsla(0,100%,50%,0.05)\"><span style=\"color:#710\">&quot;</span><span style=\"color:#D20\">Order 1</span><span style=\"color:#710\">&quot;</span></span>,\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>paid</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"color:#088\">true</span>\n}</pre></div>\n</div>\n","response_headers":"Content-Type: application/json; charset=utf-8\nLocation: http://example.org/orders/1\nX-Ua-Compatible: IE=Edge,chrome=1\nE-Tag: \"5fffd66f61cdd4ab8881584dbf5e72cf\"\nCache-Control: max-age=0, private, must-revalidate\nX-Runtime: 0.008944\nContent-Length: 58","curl":"curl http://localhost:3000/orders -d \"{\"order\":{\"name\":\"Order 1\",\"paid\":true,\"email\":\"[email protected]\"}}\" -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Host: example.org\" -H \"Cookie: \""},{"request_method":"GET","request_path":"/orders/1","request_body":null,"request_headers":"Accept: application/json\nContent-Type: application/json\nHost: example.org\nCookie: ","request_query_parameters":null,"response_status":200,"response_status_text":"OK","response_body":"<div class=\"CodeRay\">\n  <div class=\"code\"><pre>{\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>email</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"background-color:hsla(0,100%,50%,0.05)\"><span style=\"color:#710\">&quot;</span><span style=\"color:#D20\">[email protected]</span><span style=\"color:#710\">&quot;</span></span>,\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>name</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"background-color:hsla(0,100%,50%,0.05)\"><span style=\"color:#710\">&quot;</span><span style=\"color:#D20\">Order 1</span><span style=\"color:#710\">&quot;</span></span>,\n  <span style=\"color:#606\"><span style=\"color:#404\">&quot;</span><span>paid</span><span style=\"color:#404\">&quot;</span></span>: <span style=\"color:#088\">true</span>\n}</pre></div>\n</div>\n","response_headers":"Content-Type: application/json; charset=utf-8\nX-Ua-Compatible: IE=Edge,chrome=1\nE-Tag: \"5fffd66f61cdd4ab8881584dbf5e72cf\"\nCache-Control: max-age=0, private, must-revalidate\nX-Runtime: 0.003856\nContent-Length: 58","curl":"curl http://localhost:3000/orders/1 -X GET -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Host: example.org\" -H \"Cookie: \""}]}

example/public/docs/orders/creating_an_order.html renamed to example/docs/orders/creating_an_order.html

@@ -44,7 +44,7 @@ <h4>Headers</h4>
 X-Ua-Compatible: IE=Edge,chrome=1
 E-Tag: &quot;99914b932bd37a50b983c5e7c90ae93b&quot;
 Cache-Control: max-age=0, private, must-revalidate
-X-Runtime: 0.003834
+X-Runtime: 0.004559
 Content-Length: 2</pre>
             <h4>Status</h4>
             <pre class="response status">200 OK</pre>

example/docs/orders/creating_an_order.json

@@ -0,0 +1 @@
+{"resource":"Orders","description":"Deleting an order","explanation":null,"parameters":[],"requests":[{"request_method":"DELETE","request_path":"/orders/1","request_body":null,"request_headers":"Accept: application/json\nContent-Type: application/json\nHost: example.org\nCookie: ","request_query_parameters":null,"response_status":200,"response_status_text":"OK","response_body":"<div class=\"CodeRay\">\n  <div class=\"code\"><pre>{\n}</pre></div>\n</div>\n","response_headers":"Content-Type: application/json; charset=utf-8\nLocation: http://example.org/orders\nX-Ua-Compatible: IE=Edge,chrome=1\nE-Tag: \"99914b932bd37a50b983c5e7c90ae93b\"\nCache-Control: max-age=0, private, must-revalidate\nX-Runtime: 0.004559\nContent-Length: 2","curl":"curl http://localhost:3000/orders/1 -X DELETE -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Host: example.org\" -H \"Cookie: \""}]}

example/public/docs/orders/deleting_an_order.html renamed to example/docs/orders/deleting_an_order.html

@@ -64,7 +64,7 @@ <h4>Headers</h4>
 X-Ua-Compatible: IE=Edge,chrome=1
 E-Tag: &quot;6cd5831e98b0090b64672b5604d9eb2a&quot;
 Cache-Control: max-age=0, private, must-revalidate
-X-Runtime: 0.043226
+X-Runtime: 0.073916
 Content-Length: 121</pre>
             <h4>Status</h4>
             <pre class="response status">200 OK</pre>