autodoc 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7205ed893f52f005d0dd0da6f6ce4e4791bdcdc6
-  data.tar.gz: 8bdb613feb1e8063aa1f859d0d7ab0d09f2229bb
+  metadata.gz: ac859dfcddee9d293290317ff4039da04edd3eed
+  data.tar.gz: f752329167fe44b3b7f6db9938bf2f80122239a7
 SHA512:
-  metadata.gz: 366c405aaf5bd5413ac7bf06683770f345cdd9e5dcceadda5f7ff168c02a474b453019d8d051d8332bb9e3a52bdcbfe922ab8a0fe8e33f7ffba2054454464f39
-  data.tar.gz: 42a6d8a5717c00d7b3bdb51147d7a3583b33e491cd4d2b46f098b2730d9c5e717bae950e1745c2a552f44d259df882e539325387273df77f222c68ce3819fe38
+  metadata.gz: af8b5f8a3d932fc51013b591ed3968648f512e0b4365ef96cfc526b57332ccd3f59d1b7e1dce0e64d6cbb9d3e3cdd87f7fe09fa60a969fa881391913e63b0600
+  data.tar.gz: b1f555f70b33527afd368f57ab1127b8ef2a882655240027627643748c1e5837cb3466de5c4960f3533033de42f9241082f7c2e7727a06fc9a1c5f37f32bdeaf

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.1
+* prettify JSON request body
+* filter request & response header by Autodoc.configuration.suppress_{request,response}_header
+
 ## 0.3.0
 * change Autodoc::Document interface & template to mimic HTTP text
 

data/README.md

@@ -49,7 +49,8 @@ end
 You can configure `Autodoc.configuration` to change its behavior:
 
 * path - [String] location to put files (default: ./doc)
-* headers - [Array] keys of documented response header (default: ["Location"])
+* suppressed_request_header - [Strings] filtered request header keys
+* suppressed_response_header - [Strings] filtered response header keys
 * template - [String] ERB template for each document (default: [document.md.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/document.md.erb))
 * toc_template - [String] ERB template for ToC (default: [toc.md.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/toc.md.erb))
 * toc - [Boolean] whether to generate toc.md (default: false)

data/lib/autodoc/configuration.rb

@@ -18,8 +18,12 @@ module Autodoc
       "doc"
     end
 
-    property :headers do
-      %w[Location]
+    property :suppressed_request_header do
+      []
+    end
+
+    property :suppressed_response_header do
+      []
     end
 
     property :template do

data/lib/autodoc/document.rb

@@ -1,4 +1,5 @@
 require "action_dispatch/http/request"
+require "active_support/core_ext/hash/slice"
 require "active_support/core_ext/string/strip"
 require "uri"
 require "erb"
@@ -63,7 +64,9 @@ module Autodoc
       table = request_header_from_fixed_keys
       table.merge!(request_header_from_http_prefix)
       table.reject! {|key, value| value.blank? }
-      table.map {|key, value| [key.split(?_).map(&:downcase).map(&:camelize).join(?-), value].join(": ") }.sort.join("\n")
+      table = Hash[table.map {|key, value| [key.split(?_).map(&:downcase).map(&:camelize).join(?-), value] }]
+      table.except!(*Autodoc.configuration.suppressed_request_header)
+      table.map {|key, value| [key, value].join(": ") }.sort.join("\n")
     end
 
     def request_header_from_http_prefix
@@ -89,11 +92,26 @@ module Autodoc
     end
 
     def request_body_section
-      "\n\n#{request_body}" unless request_body.empty?
+      "\n\n#{request_body}" if request_body.present?
     end
 
     def request_body
-      request.body.string
+      if instance_variable_defined?(:@request_body)
+        @request_body
+      else
+        @request_body = begin
+          if request.headers["Content-Type"].try(:include?, "application/json")
+            request_body_parsed_as_json
+          else
+            request.body.string
+          end
+        end
+      end
+    end
+
+    def request_body_parsed_as_json
+      JSON.pretty_generate(JSON.parse(request.body.string))
+    rescue JSON::ParserError
     end
 
     def response_http_version
@@ -101,7 +119,9 @@ module Autodoc
     end
 
     def response_header
-      response.headers.map {|key, value| [key, value].join(": ") }.sort.join("\n")
+      table = response.headers.clone
+      table.except!(*Autodoc.configuration.suppressed_response_header)
+      table.map {|key, value| [key, value].join(": ") }.sort.join("\n")
     end
 
     def response_header_from_fixed_keys
@@ -117,12 +137,22 @@ module Autodoc
     end
 
     def response_body
-      if response.header["Content-Type"].include?("application/json")
-        JSON.pretty_generate(JSON.parse(response.body))
+      if instance_variable_defined?(:@response_body)
+        @response_body
       else
-        response.body
+        @response_body = begin
+          if response.header["Content-Type"].try(:include?, "application/json")
+            response_body_parsed_as_json
+          else
+            response.body
+          end
+        end
       end
-    rescue
+    end
+
+    def response_body_parsed_as_json
+      JSON.pretty_generate(JSON.parse(response.body))
+    rescue JSON::ParserError
     end
 
     def controller

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/dummy/app/controllers/recipes_controller.rb

@@ -5,7 +5,7 @@ class RecipesController < ApplicationController
   end
 
   def show
-    respond_with Recipe.find(params[:id])
+    render json: Recipe.find(params[:id])
   end
 
   def create

data/spec/dummy/doc/entries.md

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

data/spec/dummy/doc/recipes.md

@@ -1,11 +1,11 @@
 ## GET /recipes/:id
 Returns the recipe.
 
-## Example
+### Example
 ```
 GET /recipes/:id HTTP/1.1
-Accept: application/json
 Content-Length: 0
+Content-Type: application/json
 Host: example.org
 ```
 
@@ -14,11 +14,11 @@ HTTP/1.1 200
 Cache-Control: max-age=0, private, must-revalidate
 Content-Length: 111
 Content-Type: application/json; charset=utf-8
-ETag: "349ed81d084907a8583a84c1643c4f26"
+ETag: "082bd55a40d73aebcc3f6227e98dcebb"
 X-Content-Type-Options: nosniff
 X-Frame-Options: SAMEORIGIN
-X-Request-Id: 52ca31ee-4b32-4bdd-ae9e-fed8badaa9b7
-X-Runtime: 0.023516
+X-Request-Id: 1ced421d-4c76-44cf-bf5b-241358f73311
+X-Runtime: 0.038226
 X-UA-Compatible: chrome=1
 X-XSS-Protection: 1; mode=block
 
@@ -26,8 +26,8 @@ X-XSS-Protection: 1; mode=block
   "id": 1,
   "name": "test",
   "type": 2,
-  "created_at": "2013-12-17T08:32:27.415Z",
-  "updated_at": "2013-12-17T08:32:27.415Z"
+  "created_at": "2013-12-17T09:17:20.775Z",
+  "updated_at": "2013-12-17T09:17:20.775Z"
 }
 ```
 
@@ -42,15 +42,18 @@ recipe!
 * `name` string (required, except: `["alice", "bob"]`)
 * `type` integer (only: `1..3`)
 
-## Example
+### Example
 ```
 POST /recipes HTTP/1.1
 Accept: application/json
-Content-Length: 16
-Content-Type: application/x-www-form-urlencoded
+Content-Length: 24
+Content-Type: application/json
 Host: www.example.com
 
-name=name&type=1
+{
+  "name": "name",
+  "type": 1
+}
 ```
 
 ```
@@ -58,12 +61,12 @@ HTTP/1.1 201
 Cache-Control: max-age=0, private, must-revalidate
 Content-Length: 111
 Content-Type: application/json; charset=utf-8
-ETag: "fca9b8e000ef821607eda6104ceec86b"
+ETag: "1220735207c1ff5203a3c8975649d37a"
 Location: http://www.example.com/recipes/1
 X-Content-Type-Options: nosniff
 X-Frame-Options: SAMEORIGIN
-X-Request-Id: 27e3eef6-2d84-479c-999e-a1142f7ecc74
-X-Runtime: 0.005600
+X-Request-Id: b1fded86-bbc2-4442-9fa2-d9536bd55dd4
+X-Runtime: 0.006243
 X-UA-Compatible: chrome=1
 X-XSS-Protection: 1; mode=block
 
@@ -71,7 +74,7 @@ X-XSS-Protection: 1; mode=block
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-12-17T08:32:27.475Z",
-  "updated_at": "2013-12-17T08:32:27.475Z"
+  "created_at": "2013-12-17T09:17:20.858Z",
+  "updated_at": "2013-12-17T09:17:20.858Z"
 }
 ```

data/spec/requests/entries_spec.rb

@@ -15,7 +15,7 @@ describe "Entries" do
     lambda do |env|
       [
         200,
-        {},
+        { "Content-Type" => "application/json" },
         [
           [
             {

data/spec/requests/recipes_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe "Recipes" do
   let(:env) do
-    { "HTTP_ACCEPT" => "application/json" }
+    { "ACCEPT" => "application/json", "CONTENT_TYPE" => "application/json" }
   end
 
   let(:params) do
@@ -15,6 +15,10 @@ describe "Recipes" do
     end
 
     context "with valid condition (using Rack::Test)", :autodoc do
+      before do
+        env["Content-Type"] = "application/json"
+      end
+
       include Rack::Test::Methods
 
       it "returns the recipe" do
@@ -36,7 +40,7 @@ describe "Recipes" do
       end
 
       it "returns 400" do
-        post "/recipes", params, env
+        post "/recipes", params.to_json, env
         response.status.should == 400
       end
     end
@@ -47,7 +51,7 @@ describe "Recipes" do
       end
 
       it "returns 400" do
-        post "/recipes", params, env
+        post "/recipes", params.to_json, env
         response.status.should == 400
       end
     end
@@ -58,7 +62,7 @@ describe "Recipes" do
       end
 
       it "creates a new recipe" do
-        post "/recipes", params, env
+        post "/recipes", params.to_json, env
         response.status.should == 201
       end
     end
@@ -74,7 +78,7 @@ describe "Recipes" do
       end
 
       it "creates a new recipe" do
-        post "/recipes", params, env
+        post "/recipes", params.to_json, env
         response.status.should == 201
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryo Nakamura