rspec_api_documentation 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d028dba15444ec4ec3da4d6be2f55832bfe1348f
-  data.tar.gz: 299d1b2d9bd7d9600975fbfd5982999405cab9cf
+  metadata.gz: 5643d0ed3b32b595746931b4dddf583a56e31ed5
+  data.tar.gz: 87115d7eac49ebc0f51fbfec49fdc9780f9e4332
 SHA512:
-  metadata.gz: a74792e3e273c9522f4047e8edac0819abffb4bdb1a82d8984ad6ca3077a06869361b28d95207ae2efd3696ffb2cb611d1fe19c7bc9fdd6d034c73bbe1cd967d
-  data.tar.gz: 397c2218f5cfaf98654ea1ba251b4156388d4ec3341f07ebd9b741af19fe2551860a7ab6e3b3746db067a28f8572a8a91164d85498d8e92022700b21030a15b0
+  metadata.gz: f15ff0825beca5eca22adc6dc15a044682ea9c835280246a5759bb94e5cf04360e4ba6aa0c5b554cf8c67cd6005ecbe7e2a05ea331efcf390dd08adbc1bb087e
+  data.tar.gz: 9c0aefe90889c51b51e3ae671a3b77f5c0cba7a5d4aa38c7faa90aeb26f9a228493a8615ba772b46137fa4d51b94db98caad30e1bca5ab470492ba841e53b416

data/lib/rspec_api_documentation/client_base.rb

@@ -89,10 +89,9 @@ module RspecApiDocumentation
       return nil if response_body.empty?
       if response_body.encoding == Encoding::ASCII_8BIT
         "[binary data]"
-      elsif response_content_type =~ /application\/json/
-        JSON.pretty_generate(JSON.parse(response_body))
       else
-        response_body
+        formatter = RspecApiDocumentation.configuration.response_body_formatter
+        return formatter.call(response_content_type, response_body)
       end
     end
 

data/lib/rspec_api_documentation/configuration.rb

@@ -80,18 +80,42 @@ module RspecApiDocumentation
     add_setting :response_headers_to_include, :default => nil
     add_setting :html_embedded_css_file, :default => nil
 
+    # renamed to request_body_formatter. here for backwards compatibility
+    add_setting :post_body_formatter, :default => nil
+
     # Change how the post body is formatted by default, you can still override by `raw_post`
     # Can be :json, :xml, or a proc that will be passed the params
     #
     #   RspecApiDocumentation.configure do |config|
-    #     config.post_body_formatter = Proc.new do |params|
+    #     config.request_body_formatter = Proc.new do |params|
     #       # convert to whatever you want
     #       params.to_s
     #     end
     #   end
     #
     # See RspecApiDocumentation::DSL::Endpoint#do_request
-    add_setting :post_body_formatter, :default => Proc.new { |_| Proc.new { |params| params } }
+    add_setting :request_body_formatter, :default => Proc.new { |_| RspecApiDocumentation.configuration.post_body_formatter || Proc.new { |params| params } }
+
+    # Change how the response body is formatted
+    # Can be a proc that will be passed the response body
+    #
+    #   RspecApiDocumentation.configure do |config|
+    #     config.response_body_formatter = Proc.new do |content_type, response_body|
+    #       # convert to whatever you want
+    #       response_body
+    #     end
+    #   end
+    #
+    # See RspecApiDocumentation::DSL::Endpoint#do_request
+    add_setting :response_body_formatter, default: Proc.new { |_, _|
+      Proc.new do |content_type, response_body|
+        if content_type =~ /application\/json/
+          JSON.pretty_generate(JSON.parse(response_body))
+        else
+          response_body
+        end
+      end
+    }
 
     def client_method=(new_client_method)
       RspecApiDocumentation::DSL::Resource.module_eval <<-RUBY

data/lib/rspec_api_documentation/dsl.rb

@@ -18,9 +18,9 @@ module RspecApiDocumentation
     # +block+:: Block to pass into describe
     #
     def resource(*args, &block)
-      options = if args.last.is_a?(Hash) then args.pop else {} end
+      options = args.last.is_a?(Hash) ? args.pop : {}
       options[:api_doc_dsl] = :resource
-      options[:resource_name] = args.first
+      options[:resource_name] = args.first.to_s
       options[:document] ||= :all
       args.push(options)
       describe(*args, &block)
@@ -36,7 +36,7 @@ RSpec.configuration.include RspecApiDocumentation::DSL::Endpoint, :api_doc_dsl =
 RSpec.configuration.include RspecApiDocumentation::DSL::Callback, :api_doc_dsl => :callback
 RSpec.configuration.backtrace_exclusion_patterns << %r{lib/rspec_api_documentation/dsl/}
 
-if defined? RSpec::Rails
+if defined? RSpec::Rails::DIRECTORY_MAPPINGS
   RSpec::Rails::DIRECTORY_MAPPINGS[:acceptance] = %w[spec acceptance]
   RSpec.configuration.infer_spec_type_from_file_location!
 end

data/lib/rspec_api_documentation/dsl/endpoint.rb

@@ -41,7 +41,7 @@ module RspecApiDocumentation::DSL
         if respond_to?(:raw_post)
           params_or_body = raw_post
         else
-          formatter = RspecApiDocumentation.configuration.post_body_formatter
+          formatter = RspecApiDocumentation.configuration.request_body_formatter
           case formatter
           when :json
             params_or_body = params.empty? ? nil : params.to_json

data/lib/tasks/docs.rake

@@ -9,5 +9,5 @@ end
 desc 'Generate API request documentation from API specs (ordered)'
 RSpec::Core::RakeTask.new('docs:generate:ordered') do |t|
   t.pattern = 'spec/acceptance/**/*_spec.rb'
-  t.rspec_opts = ["--format RspecApiDocumentation::ApiFormatter", "--order default"]
+  t.rspec_opts = ["--format RspecApiDocumentation::ApiFormatter", "--order defined"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Chris Cahoon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -323,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A double black belt for your docs