rspec_api_documentation 0.4.0 → 0.4.1

data/lib/rspec_api_documentation/api_formatter.rb

@@ -1,7 +1,7 @@
-require 'rspec/core/formatters/base_formatter'
+require 'rspec/core/formatters/base_text_formatter'
 
 module RspecApiDocumentation
-  class ApiFormatter < RSpec::Core::Formatters::BaseFormatter
+  class ApiFormatter < RSpec::Core::Formatters::BaseTextFormatter
     def initialize(output)
       super
 

data/lib/rspec_api_documentation/dsl.rb

@@ -109,6 +109,15 @@ module RspecApiDocumentation
       client.send(method, path_or_query, params_or_body)
     end
 
+    def no_doc(&block)
+      requests = example.metadata[:requests]
+      example.metadata[:requests] = []
+
+      instance_eval &block
+
+      example.metadata[:requests] = requests
+    end
+
     def query_string
       query = params.to_a.map do |param|
         param.map! { |a| CGI.escape(a.to_s) }
@@ -199,7 +208,7 @@ def self.resource(*args, &block)
   options = if args.last.is_a?(Hash) then args.pop else {} end
   options[:api_docs_dsl] = true
   options[:resource_name] = args.first
-  options[:document] = true
+  options[:document] ||= :all
   args.push(options)
   describe(*args, &block)
 end

data/lib/rspec_api_documentation/json_writer.rb

@@ -48,7 +48,8 @@ module RspecApiDocumentation
           :examples => section[:examples].map { |example|
             {
               :description => example.description,
-              :link => "#{example.dirname}/#{example.filename}"
+              :link => "#{example.dirname}/#{example.filename}",
+              :groups => example.metadata[:document]
             }
           }
         )

data/lib/rspec_api_documentation/test_client.rb

@@ -79,7 +79,11 @@ module RspecApiDocumentation
       request_metadata[:request_query_parameters] = format_query_hash(last_query_hash)
       request_metadata[:response_status] = last_response.status
       request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[last_response.status]
-      request_metadata[:response_body] = prettify_json(last_response.body)
+      if is_json?(request_body)
+        request_metadata[:response_body] = prettify_json(last_response.body)
+      else
+        request_metadata[:response_body] = last_response.body
+      end
       request_metadata[:response_headers] = format_headers(last_response.headers)
       request_metadata[:curl] = Curl.new(method.to_s, action, request_body, last_headers)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-03 00:00:00.000000000Z
+date: 2012-03-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70173877407600 !ruby/object:Gem::Requirement
+  requirement: &70208656642920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 2.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70173877407600
+  version_requirements: *70208656642920
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70173877407120 !ruby/object:Gem::Requirement
+  requirement: &70208656642360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70173877407120
+  version_requirements: *70208656642360
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70173877406600 !ruby/object:Gem::Requirement
+  requirement: &70208656641780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70173877406600
+  version_requirements: *70208656641780
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70173877406140 !ruby/object:Gem::Requirement
+  requirement: &70208656641040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 0.5.5
   type: :runtime
   prerelease: false
-  version_requirements: *70173877406140
+  version_requirements: *70208656641040
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70173877405680 !ruby/object:Gem::Requirement
+  requirement: &70208656640280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.99.0
   type: :runtime
   prerelease: false
-  version_requirements: *70173877405680
+  version_requirements: *70208656640280
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70173877405220 !ruby/object:Gem::Requirement
+  requirement: &70208656639500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 1.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70173877405220
+  version_requirements: *70208656639500
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70173877404740 !ruby/object:Gem::Requirement
+  requirement: &70208656638740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70173877404740
+  version_requirements: *70208656638740
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70173877404360 !ruby/object:Gem::Requirement
+  requirement: &70208656637980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70173877404360
+  version_requirements: *70208656637980
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70173877403900 !ruby/object:Gem::Requirement
+  requirement: &70208656637420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,7 +111,40 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70173877403900
+  version_requirements: *70208656637420
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70208656636980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70208656636980
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70208656636420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70208656636420
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70208656635940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70208656635940
 description: Generate API docs from your test suite
 email:
 - chris@smartlogicsolutions.com