autodoc 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 818671b2a03b5e5604d72453279a0f75e54055be
-  data.tar.gz: 1fd0c526cb6eafd0cb9da26016629157165d78fd
+  metadata.gz: 7205ed893f52f005d0dd0da6f6ce4e4791bdcdc6
+  data.tar.gz: 8bdb613feb1e8063aa1f859d0d7ab0d09f2229bb
 SHA512:
-  metadata.gz: b16942b38765ea37ba19bcf5898c0ef82c9d79c73b1620f88b89f6a428888c9717c06a930df535b416a36af506977888ab3446ed4666669b6bfc3fc318ca9e00
-  data.tar.gz: d8ec61fb2a070a0e5b5405b3c7628fb5ab17ffea611609272db228b5e4c33e79c8001932feb1f7bfd37ca2be8af899643aebdc8217a5fbae21477fc714799a0c
+  metadata.gz: 366c405aaf5bd5413ac7bf06683770f345cdd9e5dcceadda5f7ff168c02a474b453019d8d051d8332bb9e3a52bdcbfe922ab8a0fe8e33f7ffba2054454464f39
+  data.tar.gz: 42a6d8a5717c00d7b3bdb51147d7a3583b33e491cd4d2b46f098b2730d9c5e717bae950e1745c2a552f44d259df882e539325387273df77f222c68ce3819fe38

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.0
+* change Autodoc::Document interface & template to mimic HTTP text
+
 ## 0.2.8
 * include query string into document template
 

data/autodoc.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", ">= 3.0.0"
   spec.add_dependency "actionpack"
   spec.add_dependency "rspec"
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/autodoc/document.rb

@@ -1,4 +1,5 @@
 require "action_dispatch/http/request"
+require "active_support/core_ext/string/strip"
 require "uri"
 require "erb"
 require "pathname"
@@ -58,24 +59,70 @@ module Autodoc
       request.method
     end
 
+    def request_header
+      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")
+    end
+
+    def request_header_from_http_prefix
+      request.headers.inject({}) do |table, (key, value)|
+        if key.start_with?("HTTP_")
+          table.merge(key.gsub(/^HTTP_/, "") => value)
+        else
+          table
+        end
+      end
+    end
+
+    def request_header_from_fixed_keys
+      request.headers.env.slice("CONTENT_TYPE", "CONTENT_LENGTH", "LOCATION")
+    end
+
+    def request_http_version
+      request.env["HTTP_VERSION"] || "HTTP/1.1"
+    end
+
     def request_query
       "?#{URI.unescape(request.query_string)}" unless request.query_string.empty?
     end
 
+    def request_body_section
+      "\n\n#{request_body}" unless request_body.empty?
+    end
+
     def request_body
       request.body.string
     end
 
-    def response_status
-      response.status
+    def response_http_version
+      response.env["HTTP_VERSION"] || "HTTP/1.1"
+    end
+
+    def response_header
+      response.headers.map {|key, value| [key, value].join(": ") }.sort.join("\n")
+    end
+
+    def response_header_from_fixed_keys
+      response.headers.env.slice("CONTENT_TYPE", "CONTENT_LENGTH", "LOCATION")
+    end
+
+    def response_http_version
+      response.header["HTTP_VERSION"] || "HTTP/1.1"
     end
 
-    def response_header(header)
-      response.headers[header]
+    def response_body_section
+      "\n\n#{response_body}" if response_body.present?
     end
 
-    def response_body_raw
-      response.body
+    def response_body
+      if response.header["Content-Type"].include?("application/json")
+        JSON.pretty_generate(JSON.parse(response.body))
+      else
+        response.body
+      end
+    rescue
     end
 
     def controller
@@ -95,27 +142,20 @@ module Autodoc
     end
 
     def description
-      "#{@context.example.description.capitalize}."
+      if @context.respond_to?(:description)
+        @context.description.strip_heredoc
+      else
+        "#{@context.example.description.capitalize}."
+      end
     end
 
     def path
       @context.example.full_description[%r<(GET|POST|PUT|DELETE) ([^ ]+)>, 2]
     end
 
-    def response_body
-      "\n" + JSON.pretty_generate(JSON.parse(response_body_raw))
-    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? && parameters.present?
-        "\n### parameters\n#{parameters}\n"
+        "\n### Parameters\n#{parameters}\n"
       end
     end
 
@@ -123,10 +163,6 @@ module Autodoc
       validators.map {|validator| Parameter.new(validator) }.join("\n")
     end
 
-    def has_request_body?
-      request_body.present?
-    end
-
     def has_validators?
       !!(defined?(WeakParameters) && validators)
     end
@@ -135,12 +171,6 @@ module Autodoc
       WeakParameters.stats[controller][action].try(:validators)
     end
 
-    def response_headers
-      Autodoc.configuration.headers.map do |header|
-        "\n#{header}: #{response_header(header)}" if response_header(header)
-      end.compact.join
-    end
-
     class Parameter
       attr_reader :validator
 

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

@@ -2,13 +2,13 @@
 ## <%= title %>
 <%= description %>
 <%= parameters_section %>
-### request
+### Example
 ```
-<%= method %> <%= path %><%= request_query %>
+<%= method %> <%= path %><%= request_query %> <%= request_http_version %>
+<%= request_header %><%= request_body_section %>
 ```
-<%= request_body_section %>
-### response
-```ruby
-Status: <%= response_status %><%= response_headers %>
-response: <%= response_body %>
+
+```
+<%= response_http_version %> <%= response.status %>
+<%= response_header %><%= response_body_section %>
 ```

data/lib/autodoc/version.rb

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

data/spec/dummy/doc/entries.md

@@ -1,19 +1,15 @@
 ## GET /entries
 Returns entries.
 
-### request
+## Example
 ```
-GET /entries
+GET /entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
 ```
 
-### response
-```ruby
-Status: 200
-response: 
-[
-  {
-    "title": "Test Title",
-    "body": "Lorem Ipsum"
-  }
-]
+```
+HTTP/1.1 200
+Content-Length: 45
 ```

data/spec/dummy/doc/recipes.md

@@ -1,50 +1,77 @@
 ## GET /recipes/:id
 Returns the recipe.
 
-### request
+## Example
 ```
-GET /recipes/:id
+GET /recipes/:id HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
 ```
 
-### response
-```ruby
-Status: 200
-response: 
+```
+HTTP/1.1 200
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: "349ed81d084907a8583a84c1643c4f26"
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 52ca31ee-4b32-4bdd-ae9e-fed8badaa9b7
+X-Runtime: 0.023516
+X-UA-Compatible: chrome=1
+X-XSS-Protection: 1; mode=block
+
 {
   "id": 1,
   "name": "test",
   "type": 2,
-  "created_at": "2013-12-10T02:07:44.282Z",
-  "updated_at": "2013-12-10T02:07:44.282Z"
+  "created_at": "2013-12-17T08:32:27.415Z",
+  "updated_at": "2013-12-17T08:32:27.415Z"
 }
 ```
 
 ## POST /recipes
-Creates a new recipe.
+Creates
+a
+new
+recipe!
 
-### parameters
+
+### Parameters
 * `name` string (required, except: `["alice", "bob"]`)
 * `type` integer (only: `1..3`)
 
-### request
-```
-POST /recipes
+## Example
 ```
+POST /recipes HTTP/1.1
+Accept: application/json
+Content-Length: 16
+Content-Type: application/x-www-form-urlencoded
+Host: www.example.com
 
-```
 name=name&type=1
 ```
 
-### response
-```ruby
-Status: 201
+```
+HTTP/1.1 201
+Cache-Control: max-age=0, private, must-revalidate
+Content-Length: 111
+Content-Type: application/json; charset=utf-8
+ETag: "fca9b8e000ef821607eda6104ceec86b"
 Location: http://www.example.com/recipes/1
-response: 
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Request-Id: 27e3eef6-2d84-479c-999e-a1142f7ecc74
+X-Runtime: 0.005600
+X-UA-Compatible: chrome=1
+X-XSS-Protection: 1; mode=block
+
 {
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-12-10T02:07:44.355Z",
-  "updated_at": "2013-12-10T02:07:44.355Z"
+  "created_at": "2013-12-17T08:32:27.475Z",
+  "updated_at": "2013-12-17T08:32:27.475Z"
 }
 ```

data/spec/requests/recipes_spec.rb

@@ -64,6 +64,15 @@ describe "Recipes" do
     end
 
     context "with valid condition", :autodoc do
+      let(:description) do
+        <<-EOS
+          Creates
+          a
+          new
+          recipe!
+        EOS
+      end
+
       it "creates a new recipe" do
         post "/recipes", params, env
         response.status.should == 201

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement