autodoc 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 007f7f2ba421604a63bc0bd1f9b3c81fcb42f56c
-  data.tar.gz: 3ccf8ae635730b8d49f9b666570671d5dd6d6404
+  metadata.gz: a2a5528a44cbd03fbfae762dbaa8c4f274e1a537
+  data.tar.gz: 911b9292db126659555cab615394c675f4442343
 SHA512:
-  metadata.gz: e79775dfc64ae0dac2e710ff82a5626d1ca059549d9e0fc804268d2d4797284cdefd7448f6d52b1b5d8f914b6c3dae74fe4c3059fc1444de32de51c885624c0e
-  data.tar.gz: e9b16bd1f8f98b3cd6a17c46cfbce051fde94757ea541e922988f9a7e03f0d4932af169e2c78d88eb6bb1f604d1f2b9cbcc32c1e774e728567a3db187473d505
+  metadata.gz: 4b05f3d3f81415016e9a18d509d4c3b290866e063d4906360236b95f5161323bdff8e6b40794765bb12ae4afec824dfb065025262c4d2ca7ecfb5ef7b3946cab
+  data.tar.gz: 9e22c29f5e0e8d90a6b07adba30b3c0f25b9afb4236a2c758d0c5e905176d282f4132c69075caa74e41b1e5f36305039861d0467d784f43f9688af9cc484baef

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.5.0
+- Add `Autodoc.configuration.document_path_from_example` (Thx @samuraiT)
+
 ## 0.4.5
 - Support other specs directory than spec/requests (Thx @joe-re)
 

data/README.md

@@ -83,12 +83,26 @@ You can configure `Autodoc.configuration` to change its behavior:
 * toc - [Boolean] whether to generate toc.md (default: false)
 * toc_html_template - [String] ERB template for html ToC (default: [toc.html.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/toc.html.erb))
 * toc_html - [Boolean] whether to generate toc.html - a single page documentation with a toc (default: false)
+* document_path_from_example - [Proc] specify a Proc to change the naming rule of document file paths
 
 ```ruby
-# example
 Autodoc.configuration.path = "doc/api"
 Autodoc.configuration.toc = true
 Autodoc.configuration.toc_html = true
 Autodoc.configuration.template = File.read(File.expand_path("../autodoc/templates/document.md.erb", __FILE__))
+Audocot.configuration.document_path_from_example = -> (example) do
+  example.file_path.gsub(%r<\./spec/requests/api/(.+)_spec\.rb>, '\1.md')
+end
+```
 
+## WeakParameters integration
+If your app uses [WeakParameters](https://github.com/r7kamura/weak_parameters) to define parameters schema
+in your controller, autodoc scans them and provides `### Parameters` section to generated docs.
+
+```rb
+class RecipesController < ApplicationController
+  validates :create do
+    string :name, required: true, except: ["charlie", "dave"]
+    integer :type, only: 1..3
+  end
 ```

data/autodoc.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack"
   spec.add_dependency "rspec"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rails", ">= 3.2.11"
+  spec.add_development_dependency "rails", "4.2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sqlite3"
 end

data/lib/autodoc/configuration.rb

@@ -14,6 +14,9 @@ module Autodoc
       end
     end
 
+    property :document_path_from_example do
+    end
+
     property :path do
       "doc"
     end

data/lib/autodoc/document.rb

@@ -7,6 +7,10 @@ require "pathname"
 
 module Autodoc
   class Document
+    DEFAULT_DOCUMENT_PATH_FROM_EXAMPLE = -> (example) do
+      example.file_path.gsub(%r<\./spec/[^/]+/(.+)_spec\.rb>, '\1.md')
+    end
+
     def self.render(*args)
       new(*args).render
     end
@@ -17,9 +21,8 @@ module Autodoc
     end
 
     def pathname
-      @path ||= begin
-        payload = example.file_path.gsub(%r<\./spec/[^/]+/(.+)_spec\.rb>, '\1.md')
-        Autodoc.configuration.pathname + payload
+      @pathname ||= begin
+        Autodoc.configuration.pathname + document_path_from_example.call(example)
       end
     end
 
@@ -37,6 +40,10 @@ module Autodoc
 
     private
 
+    def document_path_from_example
+      Autodoc.configuration.document_path_from_example || DEFAULT_DOCUMENT_PATH_FROM_EXAMPLE
+    end
+
     def example
       if ::RSpec::Core::Version::STRING.match /\A(?:3\.|2.99\.)/
         @example

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.4.5"
+  VERSION = "0.5.0"
 end

data/spec/autodoc/documents_spec.rb

@@ -82,6 +82,21 @@ describe Autodoc::Documents do
         expect(toc).to include("[admin/recipes.md](admin/recipes.md)")
         expect(toc).to include("[GET /admin/recipes](admin/recipes.md#get-adminrecipes)")
       end
+
+      context "with document_path_from_example configuration" do
+        around do |example|
+          origin = Autodoc.configuration.document_path_from_example
+          Autodoc.configuration.document_path_from_example = -> (example) { "test.md" }
+          example.run
+          Autodoc.configuration.document_path_from_example = origin
+        end
+
+        it "change the naming rule of document file paths" do
+          toc = documents.send(:render_toc)
+          expect(toc).to include("[test.md](test.md)")
+          expect(toc).to include("[GET /admin/recipes](test.md#get-adminrecipes)")
+        end
+      end
     end
   end
 end

data/spec/dummy/config/application.rb

@@ -44,14 +44,7 @@ module Dummy
     # like if you have constraints or database-specific column types
     # config.active_record.schema_format = :sql
 
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
   end
 end
-

data/spec/dummy/config/environments/development.rb

@@ -1,6 +1,8 @@
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
+  config.eager_load = false
+
   # In the development environment your application's code is reloaded on
   # every request. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
@@ -10,9 +12,6 @@ Dummy::Application.configure do
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 

data/spec/dummy/config/environments/production.rb

@@ -1,6 +1,8 @@
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
+  config.eager_load = true
+
   # Code is not reloaded between requests
   config.cache_classes = true
 

data/spec/dummy/config/environments/test.rb

@@ -1,6 +1,8 @@
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
+  config.eager_load = false
+
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that
   # your test database is "scratch space" for the test suite and is wiped

data/spec/dummy/doc/admin/entries.md

@@ -2,6 +2,8 @@
 Returns entries.
 
 ### Example
+
+#### Request
 ```
 GET /admin/entries HTTP/1.1
 Accept: application/json
@@ -9,6 +11,7 @@ Content-Length: 0
 Host: example.org
 ```
 
+#### Response
 ```
 HTTP/1.1 200
 Content-Length: 45

data/spec/dummy/doc/entries.md

@@ -2,6 +2,8 @@
 Returns entries.
 
 ### Example
+
+#### Request
 ```
 GET /entries HTTP/1.1
 Accept: application/json
@@ -9,6 +11,7 @@ Content-Length: 0
 Host: example.org
 ```
 
+#### Response
 ```
 HTTP/1.1 200
 Content-Length: 45

data/spec/dummy/doc/recipes.md

@@ -2,6 +2,8 @@
 Returns the recipe.
 
 ### Example
+
+#### Request
 ```
 GET /recipes/1 HTTP/1.1
 Content-Length: 0
@@ -9,25 +11,25 @@ Content-Type: application/json
 Host: example.org
 ```
 
+#### Response
 ```
 HTTP/1.1 200
 Cache-Control: max-age=0, private, must-revalidate
 Content-Length: 111
 Content-Type: application/json; charset=utf-8
-ETag: "d2bb4f3624c215dcc71b683ec7d58ebd"
+ETag: W/"569e12b49f55be4160858ca7de2935c3"
 X-Content-Type-Options: nosniff
 X-Frame-Options: SAMEORIGIN
-X-Request-Id: 5f84d51d-9709-4a8f-a02c-77732902252b
-X-Runtime: 0.013851
-X-UA-Compatible: chrome=1
+X-Request-Id: cbf1563c-2e0f-421f-b734-5234a7388f70
+X-Runtime: 0.001643
 X-XSS-Protection: 1; mode=block
 
 {
   "id": 1,
   "name": "test",
   "type": 2,
-  "created_at": "2013-12-29T14:22:59.625Z",
-  "updated_at": "2013-12-29T14:22:59.625Z"
+  "created_at": "2015-04-21T14:55:09.351Z",
+  "updated_at": "2015-04-21T14:55:09.351Z"
 }
 ```
 
@@ -43,6 +45,8 @@ recipe!
 * `type` integer (only: `1..3`)
 
 ### Example
+
+#### Request
 ```
 POST /recipes HTTP/1.1
 Accept: application/json
@@ -56,25 +60,25 @@ Host: www.example.com
 }
 ```
 
+#### Response
 ```
 HTTP/1.1 201
 Cache-Control: max-age=0, private, must-revalidate
 Content-Length: 111
 Content-Type: application/json; charset=utf-8
-ETag: "0d698f869368039f2145c92927b36720"
+ETag: W/"499417290ebf67a5283002fb2b214c12"
 Location: http://www.example.com/recipes/1
 X-Content-Type-Options: nosniff
 X-Frame-Options: SAMEORIGIN
-X-Request-Id: 84349101-dc40-4416-83a0-a767242881f9
-X-Runtime: 0.003861
-X-UA-Compatible: chrome=1
+X-Request-Id: fac5ae8a-1eec-41c5-a533-c1cd0991ea92
+X-Runtime: 0.003226
 X-XSS-Protection: 1; mode=block
 
 {
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-12-29T14:22:59.676Z",
-  "updated_at": "2013-12-29T14:22:59.676Z"
+  "created_at": "2015-04-21T14:55:09.377Z",
+  "updated_at": "2015-04-21T14:55:09.377Z"
 }
 ```

data/spec/dummy/doc/spec/requests/admin/entries.md

@@ -0,0 +1,26 @@
+## GET /admin/entries
+Returns entries.
+
+### Example
+
+#### Request
+```
+GET /admin/entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+```
+
+#### Response
+```
+HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    "title": "Test Title",
+    "body": "Lorem Ipsum"
+  }
+]
+```

data/spec/dummy/doc/spec/requests/entries.md

@@ -0,0 +1,26 @@
+## GET /entries
+Returns entries.
+
+### Example
+
+#### Request
+```
+GET /entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+```
+
+#### Response
+```
+HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    "title": "Test Title",
+    "body": "Lorem Ipsum"
+  }
+]
+```

data/spec/dummy/doc/spec/requests/recipes.md

@@ -0,0 +1,84 @@
+## GET /recipes/:id
+Returns the recipe.
+
+### Example
+
+#### Request
+```
+GET /recipes/1 HTTP/1.1
+Content-Length: 0
+Content-Type: application/json
+Host: example.org
+```
+
+#### Response
+```
+HTTP/1.1 200
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: W/"c95e174a05580bffa98c6cb95a2e9ae2"
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 0bb04a6a-b8f3-4640-a487-6f97023efef0
+X-Runtime: 0.013095
+X-XSS-Protection: 1; mode=block
+
+{
+  "id": 1,
+  "name": "test",
+  "type": 2,
+  "created_at": "2015-04-21T14:55:09.299Z",
+  "updated_at": "2015-04-21T14:55:09.299Z"
+}
+```
+
+## POST /recipes
+Creates
+a
+new
+recipe!
+
+
+### Parameters
+* `name` string (required, except: `["alice", "bob"]`)
+* `type` integer (only: `1..3`)
+
+### Example
+
+#### Request
+```
+POST /recipes HTTP/1.1
+Accept: application/json
+Content-Length: 24
+Content-Type: application/json
+Host: www.example.com
+
+{
+  "name": "name",
+  "type": 1
+}
+```
+
+#### Response
+```
+HTTP/1.1 201
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: W/"145ecc23e52083cbc00658e547234672"
+Location: http://www.example.com/recipes/1
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 50bd40e2-d110-40e8-b6cb-7589262fd00a
+X-Runtime: 0.003226
+X-XSS-Protection: 1; mode=block
+
+{
+  "id": 1,
+  "name": "name",
+  "type": 1,
+  "created_at": "2015-04-21T14:55:09.346Z",
+  "updated_at": "2015-04-21T14:55:09.346Z"
+}
+```

data/spec/dummy/doc/toc.html

@@ -0,0 +1,369 @@
+<head>
+  <style>
+    .api-docs {
+      left: 210px;
+    }
+
+    .api-docs, .api-docs-toc {
+      width: 66%;
+     }
+
+     .api-action {
+       padding: 10px;
+     }
+
+    .tocify-wrapper {
+      overflow-y: auto;
+      overflow-x: hidden;
+      position: fixed;
+      width: 210px;
+      float: left;
+      font-size: 16px;
+      background-color: #AAAADD;
+      top: 1px;
+      bottom: -1px;
+      padding: 10px;
+    }
+
+    .generated-at {
+      position: fixed;
+      bottom: 10px;
+    }
+
+    .api-resource {
+      border-bottom: black 1px solid;
+    }
+
+    pre {
+      padding: 10px;
+      background-color: #CCCCEE;
+    }
+
+    .page-wrapper {
+      margin-left: 240px;
+      min-width: 700px;
+      position: relative;
+      z-index: 10;
+    }
+  </style>
+</head>
+
+
+<html>
+<div class='tocify-wrapper'>
+<h1> Table of Contents </h1>
+      <li>
+    <a href="#spec/dummy/doc/admin/entries.md">admin/entries.md</a>
+  </li>
+  
+      <li>
+    <a href="#spec/dummy/doc/entries.md">entries.md</a>
+  </li>
+  
+      <li>
+    <a href="#spec/dummy/doc/recipes.md">recipes.md</a>
+  </li>
+  
+      <li>
+    <a href="#spec/dummy/doc/spec/requests/admin/entries.md">spec/requests/admin/entries.md</a>
+  </li>
+  
+      <li>
+    <a href="#spec/dummy/doc/spec/requests/entries.md">spec/requests/entries.md</a>
+  </li>
+  
+      <li>
+    <a href="#spec/dummy/doc/spec/requests/recipes.md">spec/requests/recipes.md</a>
+  </li>
+  
+<div class='generated-at'>
+Generated at:
+<br>
+2015-04-21 23:55:09 +0900</div>
+</div>
+
+<div class='page-wrapper'>
+  <div id="spec/dummy/doc/admin/entries.md" class="api-resource"><div class="api-action"><h2>GET /admin/entries</h2>
+
+<p>Returns entries.</p>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>GET /admin/entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    &quot;title&quot;: &quot;Test Title&quot;,
+    &quot;body&quot;: &quot;Lorem Ipsum&quot;
+  }
+]
+</code></pre>
+</div></div><div id="spec/dummy/doc/entries.md" class="api-resource"><div class="api-action"><h2>GET /entries</h2>
+
+<p>Returns entries.</p>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>GET /entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    &quot;title&quot;: &quot;Test Title&quot;,
+    &quot;body&quot;: &quot;Lorem Ipsum&quot;
+  }
+]
+</code></pre>
+</div></div><div id="spec/dummy/doc/recipes.md" class="api-resource"><div class="api-action"><h2>GET /recipes/:id</h2>
+
+<p>Returns the recipe.</p>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>GET /recipes/1 HTTP/1.1
+Content-Length: 0
+Content-Type: application/json
+Host: example.org
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 200
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: W/&quot;569e12b49f55be4160858ca7de2935c3&quot;
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: cbf1563c-2e0f-421f-b734-5234a7388f70
+X-Runtime: 0.001643
+X-XSS-Protection: 1; mode=block
+
+{
+  &quot;id&quot;: 1,
+  &quot;name&quot;: &quot;test&quot;,
+  &quot;type&quot;: 2,
+  &quot;created_at&quot;: &quot;2015-04-21T14:55:09.351Z&quot;,
+  &quot;updated_at&quot;: &quot;2015-04-21T14:55:09.351Z&quot;
+}
+</code></pre>
+</div><div class="api-action"><h2>POST /recipes</h2>
+
+<p>Creates
+a
+new
+recipe!</p>
+
+<h3>Parameters</h3>
+
+<ul>
+<li><code>name</code> string (required, except: <code>[&quot;alice&quot;, &quot;bob&quot;]</code>)</li>
+<li><code>type</code> integer (only: <code>1..3</code>)</li>
+</ul>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>POST /recipes HTTP/1.1
+Accept: application/json
+Content-Length: 24
+Content-Type: application/json
+Host: www.example.com
+
+{
+  &quot;name&quot;: &quot;name&quot;,
+  &quot;type&quot;: 1
+}
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 201
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: W/&quot;499417290ebf67a5283002fb2b214c12&quot;
+Location: http://www.example.com/recipes/1
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: fac5ae8a-1eec-41c5-a533-c1cd0991ea92
+X-Runtime: 0.003226
+X-XSS-Protection: 1; mode=block
+
+{
+  &quot;id&quot;: 1,
+  &quot;name&quot;: &quot;name&quot;,
+  &quot;type&quot;: 1,
+  &quot;created_at&quot;: &quot;2015-04-21T14:55:09.377Z&quot;,
+  &quot;updated_at&quot;: &quot;2015-04-21T14:55:09.377Z&quot;
+}
+</code></pre>
+</div></div><div id="spec/dummy/doc/spec/requests/admin/entries.md" class="api-resource"><div class="api-action"><h2>GET /admin/entries</h2>
+
+<p>Returns entries.</p>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>GET /admin/entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    &quot;title&quot;: &quot;Test Title&quot;,
+    &quot;body&quot;: &quot;Lorem Ipsum&quot;
+  }
+]
+</code></pre>
+</div></div><div id="spec/dummy/doc/spec/requests/entries.md" class="api-resource"><div class="api-action"><h2>GET /entries</h2>
+
+<p>Returns entries.</p>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>GET /entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    &quot;title&quot;: &quot;Test Title&quot;,
+    &quot;body&quot;: &quot;Lorem Ipsum&quot;
+  }
+]
+</code></pre>
+</div></div><div id="spec/dummy/doc/spec/requests/recipes.md" class="api-resource"><div class="api-action"><h2>GET /recipes/:id</h2>
+
+<p>Returns the recipe.</p>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>GET /recipes/1 HTTP/1.1
+Content-Length: 0
+Content-Type: application/json
+Host: example.org
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 200
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: W/&quot;c95e174a05580bffa98c6cb95a2e9ae2&quot;
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 0bb04a6a-b8f3-4640-a487-6f97023efef0
+X-Runtime: 0.013095
+X-XSS-Protection: 1; mode=block
+
+{
+  &quot;id&quot;: 1,
+  &quot;name&quot;: &quot;test&quot;,
+  &quot;type&quot;: 2,
+  &quot;created_at&quot;: &quot;2015-04-21T14:55:09.299Z&quot;,
+  &quot;updated_at&quot;: &quot;2015-04-21T14:55:09.299Z&quot;
+}
+</code></pre>
+</div><div class="api-action"><h2>POST /recipes</h2>
+
+<p>Creates
+a
+new
+recipe!</p>
+
+<h3>Parameters</h3>
+
+<ul>
+<li><code>name</code> string (required, except: <code>[&quot;alice&quot;, &quot;bob&quot;]</code>)</li>
+<li><code>type</code> integer (only: <code>1..3</code>)</li>
+</ul>
+
+<h3>Example</h3>
+
+<h4>Request</h4>
+
+<pre><code>POST /recipes HTTP/1.1
+Accept: application/json
+Content-Length: 24
+Content-Type: application/json
+Host: www.example.com
+
+{
+  &quot;name&quot;: &quot;name&quot;,
+  &quot;type&quot;: 1
+}
+</code></pre>
+
+<h4>Response</h4>
+
+<pre><code>HTTP/1.1 201
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: W/&quot;145ecc23e52083cbc00658e547234672&quot;
+Location: http://www.example.com/recipes/1
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 50bd40e2-d110-40e8-b6cb-7589262fd00a
+X-Runtime: 0.003226
+X-XSS-Protection: 1; mode=block
+
+{
+  &quot;id&quot;: 1,
+  &quot;name&quot;: &quot;name&quot;,
+  &quot;type&quot;: 1,
+  &quot;created_at&quot;: &quot;2015-04-21T14:55:09.346Z&quot;,
+  &quot;updated_at&quot;: &quot;2015-04-21T14:55:09.346Z&quot;
+}
+</code></pre>
+</div></div></div>
+</html>

data/spec/dummy/doc/toc.md

@@ -6,3 +6,10 @@
 * [recipes.md](recipes.md)
  * [GET /recipes/:id](recipes.md#get-recipesid)
  * [POST /recipes](recipes.md#post-recipes)
+* [spec/requests/admin/entries.md](spec/requests/admin/entries.md)
+ * [GET /admin/entries](spec/requests/admin/entries.md#get-adminentries)
+* [spec/requests/entries.md](spec/requests/entries.md)
+ * [GET /entries](spec/requests/entries.md#get-entries)
+* [spec/requests/recipes.md](spec/requests/recipes.md)
+ * [GET /recipes/:id](spec/requests/recipes.md#get-recipesid)
+ * [POST /recipes](spec/requests/recipes.md#post-recipes)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,16 +70,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,10 @@ files:
 - spec/dummy/doc/admin/entries.md
 - spec/dummy/doc/entries.md
 - spec/dummy/doc/recipes.md
+- spec/dummy/doc/spec/requests/admin/entries.md
+- spec/dummy/doc/spec/requests/entries.md
+- spec/dummy/doc/spec/requests/recipes.md
+- spec/dummy/doc/toc.html
 - spec/dummy/doc/toc.md
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep
@@ -232,6 +236,10 @@ test_files:
 - spec/dummy/doc/admin/entries.md
 - spec/dummy/doc/entries.md
 - spec/dummy/doc/recipes.md
+- spec/dummy/doc/spec/requests/admin/entries.md
+- spec/dummy/doc/spec/requests/entries.md
+- spec/dummy/doc/spec/requests/recipes.md
+- spec/dummy/doc/toc.html
 - spec/dummy/doc/toc.md
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep