api_docs 1.0.4 → 1.0.5

data/README.md

@@ -30,7 +30,7 @@ Documentation is automatically generated into yaml files from tests you create t
 class UsersTest < ActionDispatch::IntegrationTest
   def test_get_user
     user = users(:default)
-    api_call(:get, '/users/:id', :id => user.to_param) do |doc|
+    api_call(:get, '/users/:id', :id => user.to_param, :format => 'json') do |doc|
       assert_response :success
       assert_equal ({
         'id'    => user.id,
@@ -40,7 +40,7 @@ class UsersTest < ActionDispatch::IntegrationTest
   end
 
   def test_get_user_failure
-    api_call(:get, '/users/:id', :id => 'invalid') do |doc|
+    api_call(:get, '/users/:id', :id => 'invalid', :format => 'json') do |doc|
       doc.description = 'When bad user id is passed'
       assert_response :not_found
       assert_equal ({
@@ -60,6 +60,7 @@ show:
     path: /users/:id
     params:
       id: 12345
+      format: json
     status: 200
     body:
       id: 12345
@@ -70,6 +71,7 @@ show:
     path: /users/:id
     params:
       id: invalid
+      format: json
     status: 404
     body:
       message: User not found
@@ -101,4 +103,4 @@ end
 
 ---
 
-Copyright 2012 Oleg Khabarov, Jack Neto, [The Working Group, Inc](http://twg.ca)
+Copyright 2012 Oleg Khabarov, Jack Neto, [The Working Group, Inc](http://twg.ca)

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.0.5

data/api_docs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "api_docs"
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oleg Khabarov", "Jack Neto", "The Working Group Inc."]
-  s.date = "2012-10-12"
+  s.date = "2013-02-28"
   s.description = "Generate API documentation using integration tests in Ruby on Rails 3"
   s.email = "jack@twg.ca"
   s.extra_rdoc_files = [

data/app/views/api_docs/docs/_action.html.erb

@@ -35,7 +35,9 @@
   
   <tr>
     <th>Body</th>
-    <td><pre><%= JSON.pretty_generate(action['body']) %></pre></td>
+    <td>
+      <pre><%= JSON.pretty_generate(JSON.parse(action['body'])) rescue action['body']%></pre>
+    </td>
   </tr>
   
 </table>

data/lib/api_docs/test_helper.rb

@@ -6,7 +6,7 @@ module ApiDocs::TestHelper
   #     doc.description = 'Something for the docs'
   #     ... regular test code
   #   end
-  def api_call(method, path, params = { }, &block)
+  def api_call(method, path, params = { })
     parsed_params = params.dup
     parsed_path   = path.dup
     
@@ -18,7 +18,8 @@ module ApiDocs::TestHelper
     #   get '/users/12345'
     doc = OpenStruct.new
     send(method, parsed_path, parsed_params)
-    yield doc
+
+    yield doc if block_given?
     
     # Assertions inside test block didn't fail. Preparing file
     # content to be written
@@ -27,11 +28,10 @@ module ApiDocs::TestHelper
     
     file_path = File.expand_path("#{c.gsub('/', ':')}.yml", ApiDocs.config.docs_path)
     params    = api_deep_clean_params(params)
-    body      = JSON.parse(response.body)
     
     # Marking response as an unique
     key = 'ID-' + Digest::MD5.hexdigest("
-      #{method}#{path}#{params}#{response.status}#{api_deep_clean_params(body, :as_response)}
+      #{method}#{path}#{doc.description}#{params}#{response.status}}
     ")
     
     data = if File.exists?(file_path)
@@ -47,7 +47,7 @@ module ApiDocs::TestHelper
       'path'        => path,
       'params'      => api_deep_clean_params(params),
       'status'      => response.status,
-      'body'        => body
+      'body'        => response.body
     }
     FileUtils.mkdir_p(File.dirname(file_path))
     File.open(file_path, 'w'){|f| f.write(data.to_yaml)}
@@ -55,18 +55,14 @@ module ApiDocs::TestHelper
   
   # Cleans up params. Removes things like File object handlers
   # Sets up ignored values so we don't generate new keys for same data
-  def api_deep_clean_params(params, as_response = false)
+  def api_deep_clean_params(params)
     case params
     when Hash
       params.each_with_object({}) do |(key, value), res|
-        if as_response && ApiDocs.config.ignored_attributes.include?(key.to_s)
-          res[key.to_s] = 'IGNORED'
-        else
-          res[key.to_s] = api_deep_clean_params(value, as_response)
-        end
+        res[key.to_s] = api_deep_clean_params(value)
       end
     when Array
-      params.collect{|value| api_deep_clean_params(value, as_response)}
+      params.collect{|value| api_deep_clean_params(value)}
     else
       case params 
       when Rack::Test::UploadedFile

data/test/dummy/app/controllers/application_controller.rb

@@ -2,11 +2,22 @@ class ApplicationController < ActionController::Base
   protect_from_forgery
   
   def index
-    render :text => [{
-      :id         => 1,
-      :name       => 'Test User',
-      :created_at => 1.day.ago
-    }].to_json
+    respond_to do |format|
+      format.json {
+        render :text => [{
+          :id         => 1,
+          :name       => 'Test User',
+          :created_at => 1.day.ago
+        }].to_json
+      }
+      format.xml {
+        render :text => [{
+          :id         => 1,
+          :name       => 'Test User',
+          :created_at => 1.day.ago
+        }].to_xml(:root => 'users')
+      }
+    end
   end
   
   def show
@@ -20,6 +31,14 @@ class ApplicationController < ActionController::Base
     end
     
     response.merge!(:created_at => rand.days.ago) if params[:random]
-    render :text => response.to_json, :status => status
+    
+    respond_to do |format|
+      format.json do
+        render :text => response.to_json, :status => status
+      end
+      format.xml do
+        render :text => response.to_xml(:root => 'user'), :status => status
+      end
+    end
   end
 end

data/test/test_helper_test.rb

@@ -28,17 +28,8 @@ class TestHelperTest < ActionDispatch::IntegrationTest
       api_deep_clean_params({:a => Rack::Test::UploadedFile.new(__FILE__)})
   end
   
-  def test_api_deep_clean_params_with_ignored_params
-    ApiDocs.config.ignored_attributes = ['c']
-    assert_equal ({'c' => 'IGNORED'}),
-      api_deep_clean_params({:c => 'c'}, :as_response)
-    
-    assert_equal ({'a' => [{'b' => 'c', 'c' => 'IGNORED'}]}),
-      api_deep_clean_params({:a => [:b => 'c', :c => 'd']}, :as_response)
-  end
-  
   def test_api_call
-    api_call(:get, '/users/:id', :id => 12345) do |doc|
+    api_call(:get, '/users/:id', :id => 12345, :format => 'json') do |doc|
       assert_response :success
       assert_equal ({
         'id'    => 12345,
@@ -46,7 +37,7 @@ class TestHelperTest < ActionDispatch::IntegrationTest
       }), JSON.parse(response.body)
     end
     
-    api_call(:get, '/users/:id', :id => 'invalid') do |doc|
+    api_call(:get, '/users/:id', :id => 'invalid', :format => 'json') do |doc|
       doc.description = 'Invalid user id'
       assert_response :not_found
       assert_equal ({
@@ -68,27 +59,27 @@ class TestHelperTest < ActionDispatch::IntegrationTest
     object = output['show'][output['show'].keys.first]
     assert_equal 'GET',                                     object['method']
     assert_equal '/users/:id',                              object['path']
-    assert_equal ({'id' => '12345'}),                       object['params']
+    assert_equal ({'id' => '12345', 'format' => 'json'}),   object['params']
     assert_equal 200,                                       object['status']
-    assert_equal ({'id' => 12345, 'name' => 'Test User'}),  object['body']
+    assert_equal ({'id' => 12345, 'name' => 'Test User'}),  JSON.parse(object['body'])
     
     object = output['show'][output['show'].keys.last]
-    assert_equal 'GET',                             object['method']
-    assert_equal '/users/:id',                      object['path']
-    assert_equal ({'id' => 'invalid'}),             object['params']
-    assert_equal 404,                               object['status']
-    assert_equal ({'message' => 'User not found'}), object['body']
+    assert_equal 'GET',                                     object['method']
+    assert_equal '/users/:id',                              object['path']
+    assert_equal ({'id' => 'invalid', 'format' => 'json'}), object['params']
+    assert_equal 404,                                       object['status']
+    assert_equal ({'message' => 'User not found'}),         JSON.parse(object['body'])
   end
   
   def test_api_call_with_ignored_attribute
-    api_call(:get, '/users/:id', :id => 12345) do
+    api_call(:get, '/users/:id', :id => 12345, :format => 'json') do
       assert_response :success
     end
     output = YAML.load_file(ApiDocs.config.docs_path.join('application.yml'))
     assert_equal 1, output['show'].keys.size
     
     ApiDocs.config.ignored_attributes << 'random'
-    api_call(:get, '/users/:id', :id => 12345, :random => 1) do
+    api_call(:get, '/users/:id', :id => 12345, :random => 1, :format => 'json') do
       assert_response :success
     end
     output = YAML.load_file(ApiDocs.config.docs_path.join('application.yml'))
@@ -96,11 +87,27 @@ class TestHelperTest < ActionDispatch::IntegrationTest
     object = output['show'][output['show'].keys.last]
     assert_not_equal 'IGNORED', object['body']['random']
     
-    api_call(:get, '/users/:id', :id => 12345, :random => 1) do
+    api_call(:get, '/users/:id', :id => 12345, :random => 1, :format => 'json') do
       assert_response :success
     end
     output = YAML.load_file(ApiDocs.config.docs_path.join('application.yml'))
     assert_equal 2, output['show'].keys.size
   end
+
+  def test_api_call_with_xml
+    api_call(:get, '/users/:id', :id => 12345, :format => 'xml') do
+      assert_response :success
+      xml_response = <<-eoxml
+<?xml version="1.0" encoding="UTF-8"?>
+<user>
+  <id type="integer">12345</id>
+  <name>Test User</name>
+</user>
+eoxml
+      assert_equal xml_response, response.body
+    end
+    output = YAML.load_file(ApiDocs.config.docs_path.join('application.yml'))
+    assert_equal 1, output['show'].keys.size
+  end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_docs
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4166833951884593024
+      hash: -620307920657419595
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: