autodoc 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b959243c809886f4e1933c89600e19549fb7bdd
-  data.tar.gz: 8c6413d2c36bf8e717601e4472d160ef09df28b3
+  metadata.gz: 6d6bfb36e5c0208cc5d6b9eec52aab2c27494c4d
+  data.tar.gz: 69af7a3f323a6dff4053c133e304606ae379d207
 SHA512:
-  metadata.gz: 7e37eda35bed6135a209aa11eb6858173509908bbf4a5c7f3e9ca3a5d79f84d6570739189fc1061c004af3b394d48a8a7288c6ef5c7ea2095b2457152b4bb628
-  data.tar.gz: 03dbc7218c2cc2bc93d30d67c6abc0d10d45b4c36d4c6ae303516971f782d7bc42b92720509e75f4925e7086dd38f4f8d6f2c25e55be24e7a0043f42583a07c4
+  metadata.gz: 27ad733e1e05f272b165cbb99617abb74efa465b430bbf819ea6955b0c13c8655774938c576b957e87e098b177052f51dcd8468bd0a064ecce04699c591160f2
+  data.tar.gz: 4c78e9ead939463818b20d20e48885bbb5dd73f4d47f4bf600e7928e4e9841c4f254a3009bce2edc83b039696ead3ea8db658af0d2feba62da277f41d152aa7e

data/lib/autodoc/document.rb

@@ -27,12 +27,17 @@ module Autodoc
       example.full_description[%r<(GET|POST|PUT|DELETE) ([^ ]+)>, 2]
     end
 
-    # request.body can be "" (e.g. in PUT and DELETE request)
-    def request_body
+    def response_body
       "\n" + JSON.parse(response.body).ai(plain: true, indent: -2, index: false)
     rescue JSON::ParserError
     end
 
+    def request_body_section
+      if has_request_body?
+        "\n```\n#{request_body}\n```\n"
+      end
+    end
+
     def parameters_section
       if has_validators?
         "\n### parameters\n#{parameters}\n"
@@ -43,6 +48,14 @@ module Autodoc
       validators.map {|validator| Parameter.new(validator) }.join("\n")
     end
 
+    def request_body
+      request.body.string
+    end
+
+    def has_request_body?
+      request_body.present?
+    end
+
     def has_validators?
       !!(defined?(WeakParameters) && validators)
     end
@@ -99,15 +112,16 @@ end
 
 __END__
 ## <%= request.method %> <%= path %>
-<%= example.description.camelize %>
-
+<%= example.full_description %>.
+<%= parameters_section %>
+### request
 ```
 <%= request.method %> <%= request.path %>
 ```
-<%= parameters_section %>
+<%= request_body_section %>
 ### response
 ```ruby
 Status: <%= response.status %><%= headers %>
-response: <%= request_body %>
+response: <%= response_body %>
 ```
 

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/dummy/doc/recipes.md

@@ -1,13 +1,18 @@
 ## POST /recipes
-Creates a new recipe
+Recipes POST /recipes with valid condition creates a new recipe.
 
+### parameters
+* `name` string (required, except: `["alice", "bob"]`)
+* `type` integer (only: `"1".."3"`)
+
+### request
 ```
 POST /recipes
 ```
 
-### parameters
-* `name` string (required, except: `["alice", "bob"]`)
-* `type` integer (only: `"1".."3"`)
+```
+name=name&type=1
+```
 
 ### response
 ```ruby
@@ -15,10 +20,10 @@ Status: 201
 location: http://www.example.com/recipes/1
 response: 
 {
-  "created_at" => "2013-06-18T06:33:40Z",
+  "created_at" => "2013-07-08T06:11:46Z",
   "id"         => 1,
   "name"       => "name",
-  "updated_at" => "2013-06-18T06:33:40Z"
+  "updated_at" => "2013-07-08T06:11:46Z"
 }
 ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Auto-generate API documents from your request-specs.