autodoc 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bde2cac1410d82fda1b658410d340d9a28e2380c
-  data.tar.gz: 66555b27105db95fda8dbf7708bd660e3bfe16ee
+  metadata.gz: 818671b2a03b5e5604d72453279a0f75e54055be
+  data.tar.gz: 1fd0c526cb6eafd0cb9da26016629157165d78fd
 SHA512:
-  metadata.gz: 3501ef6e99e90e68b9066f07d3c482aa66f3d08e8e93f237487216c9f7e564918ff9c8695aca89b428516d8b7b63fb5e22e5f8464ae239333ea31ce93fe63be0
-  data.tar.gz: 7c5f69a2e0ae6278db85668ebd713715ade005f0d8014d6cbae31158602a282c0bed23bb28ec4076cb9fffe99cef8f7f300524ac3aedfb850e2092bbe6b3d2d7
+  metadata.gz: b16942b38765ea37ba19bcf5898c0ef82c9d79c73b1620f88b89f6a428888c9717c06a930df535b416a36af506977888ab3446ed4666669b6bfc3fc318ca9e00
+  data.tar.gz: d8ec61fb2a070a0e5b5405b3c7628fb5ab17ffea611609272db228b5e4c33e79c8001932feb1f7bfd37ca2be8af899643aebdc8217a5fbae21477fc714799a0c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.8
+* include query string into document template
+
 ## 0.2.7
 * sort list in ToC
 

data/README.md

@@ -1,5 +1,5 @@
 # Autodoc
-Auto-generate JSON API documents from your request-specs.
+Generate documentation from your rack application & request-spec.
 
 ## Installation
 ```ruby
@@ -7,7 +7,7 @@ gem "autodoc", group: :test
 ```
 
 ## Usage
-Run rspec with AUTODOC=1 to generate documents for the specs tagged with `:autodoc`.  
+Run rspec with AUTODOC=1 to generate documents for your request-specs tagged with `:autodoc`.  
 example: [doc/recipes.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/recipes.md), [doc/toc.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/toc.md)
 
 ```sh
@@ -15,12 +15,30 @@ example: [doc/recipes.md](https://github.com/r7kamura/autodoc/blob/master/spec/d
 AUTODOC=1 rspec
 ```
 
+### Example for any Rack application with rack-test
+```ruby
+# spec/requests/entries_spec.rb
+describe "Entries" do
+  include Rack::Test::Methods
+
+  let(:app) do
+    MyRackApplication
+  end
+
+  describe "GET /entries", autodoc: true do
+    get "/entries"
+    last_response.status.should == 200
+  end
+end
+```
+
+### Example for Rails application with rspec-rails
 ```ruby
 # spec/requests/recipes_spec.rb
 describe "Recipes" do
   describe "POST /recipes", autodoc: true do
     it "creates a new recipe" do
-      post "/recipes.json", name: "alice", type: 1
+      post "/recipes", name: "alice", type: 1
       response.status.should == 201
     end
   end

data/lib/autodoc/document.rb

@@ -1,4 +1,5 @@
 require "action_dispatch/http/request"
+require "uri"
 require "erb"
 require "pathname"
 
@@ -57,6 +58,10 @@ module Autodoc
       request.method
     end
 
+    def request_query
+      "?#{URI.unescape(request.query_string)}" unless request.query_string.empty?
+    end
+
     def request_body
       request.body.string
     end

data/lib/autodoc/templates/document.md.erb

@@ -4,7 +4,7 @@
 <%= parameters_section %>
 ### request
 ```
-<%= method %> <%= path %>
+<%= method %> <%= path %><%= request_query %>
 ```
 <%= request_body_section %>
 ### response

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/spec/dummy/doc/entries.md

@@ -0,0 +1,19 @@
+## GET /entries
+Returns entries.
+
+### request
+```
+GET /entries
+```
+
+### response
+```ruby
+Status: 200
+response: 
+[
+  {
+    "title": "Test Title",
+    "body": "Lorem Ipsum"
+  }
+]
+```

data/spec/dummy/doc/recipes.md

@@ -14,8 +14,8 @@ response:
   "id": 1,
   "name": "test",
   "type": 2,
-  "created_at": "2013-11-30T19:04:12.608Z",
-  "updated_at": "2013-11-30T19:04:12.608Z"
+  "created_at": "2013-12-10T02:07:44.282Z",
+  "updated_at": "2013-12-10T02:07:44.282Z"
 }
 ```
 
@@ -44,7 +44,7 @@ response:
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-11-30T19:04:12.684Z",
-  "updated_at": "2013-11-30T19:04:12.684Z"
+  "created_at": "2013-12-10T02:07:44.355Z",
+  "updated_at": "2013-12-10T02:07:44.355Z"
 }
 ```

data/spec/dummy/doc/toc.md

@@ -1,4 +1,6 @@
 ## Table of Contents
+* [entries.md](entries.md)
+ * [GET /entries](entries.md#get-entries)
 * [recipes.md](recipes.md)
  * [GET /recipes/:id](recipes.md#get-recipesid)
  * [POST /recipes](recipes.md#post-recipes)

data/spec/requests/entries_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "Entries" do
+  include Rack::Test::Methods
+
+  let(:env) do
+    { "HTTP_ACCEPT" => "application/json" }
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:app) do
+    lambda do |env|
+      [
+        200,
+        {},
+        [
+          [
+            {
+              title: "Test Title",
+              body: "Lorem Ipsum",
+            },
+          ].to_json,
+        ],
+      ]
+    end
+  end
+
+  describe "GET /entries" do
+    context "with Rack::Test", :autodoc do
+      it "returns entries" do
+        get "/entries", params, env
+        last_response.status.should == 200
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -144,6 +144,7 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/migrate/20130607075126_create_recipes.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/doc/entries.md
 - spec/dummy/doc/recipes.md
 - spec/dummy/doc/toc.md
 - spec/dummy/lib/assets/.gitkeep
@@ -153,6 +154,7 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/requests/entries_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/r7kamura/autodoc
@@ -208,6 +210,7 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/migrate/20130607075126_create_recipes.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/doc/entries.md
 - spec/dummy/doc/recipes.md
 - spec/dummy/doc/toc.md
 - spec/dummy/lib/assets/.gitkeep
@@ -217,5 +220,6 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/requests/entries_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb