rspec_api_documentation 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1f384a163dd016f784e49be257ea8c41b36c462
-  data.tar.gz: dd948cacf84ba686f5368bafdc39bf70dfa5fc2b
+  metadata.gz: 8626bf0bd0d6df280166c00c348fa3223d989f74
+  data.tar.gz: d95564e9c4135d446e3652cc4186290aaef69473
 SHA512:
-  metadata.gz: 0eeb83e3a3f341a0df20d1cd50826d34ba29dc45dde5ddfcc1b82d8be3c36936cbcaf093d7f6d2c96b5fb44af6f5954e8267069b172b6030904e418377245837
-  data.tar.gz: 84093be0b80f3550526e337e0038dfab66e857cd66e3629e29ca3568e1a87e486a54b29897f0ed7b37ef58f744e7b2eb53d4d5c99db5b8e5cd4d03f63fc0ad80
+  metadata.gz: ccb8359e19e031785d56aaa2022c75c1dc83678e4f0307b5c877bd3eb51767daf513e58ad02ea3422ab2929fe32f2ee1d1c348e49b80f476cd215f3935377ec3
+  data.tar.gz: 5ca2508704c946625a495a8875e56180cd337e9f4fa6bc5b28a67d46f9e776f55da68b5a6d1d7dfcfdcf243a77ad743f170e14d935e525944dafd3c2113f71f0

data/lib/rspec_api_documentation.rb

@@ -9,7 +9,7 @@ require 'json'
 module RspecApiDocumentation
   extend ActiveSupport::Autoload
 
-  require 'rspec_api_documentation/railtie' if defined?(Rails)
+  require 'rspec_api_documentation/railtie' if defined?(Rails::Railtie)
   include ActiveSupport::JSON
 
   eager_autoload do

data/lib/rspec_api_documentation/client_base.rb

@@ -68,7 +68,7 @@ module RspecApiDocumentation
       request_metadata[:request_content_type] = request_content_type
       request_metadata[:response_status] = status
       request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[status]
-      request_metadata[:response_body] = response_body.empty? ? nil : response_body
+      request_metadata[:response_body] = record_response_body(response_content_type, response_body)
       request_metadata[:response_headers] = response_headers
       request_metadata[:response_content_type] = response_content_type
       request_metadata[:curl] = Curl.new(method, path, request_body, request_headers)
@@ -85,6 +85,17 @@ module RspecApiDocumentation
       request_headers || {}
     end
 
+    def record_response_body(response_content_type, response_body)
+      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
+      end
+    end
+
     def clean_out_uploaded_data(params, request_body)
       params.each do |_, value|
         if value.is_a?(Hash)

data/lib/rspec_api_documentation/dsl/endpoint.rb

@@ -148,16 +148,24 @@ module RspecApiDocumentation::DSL
 
     def set_param(hash, param)
       key = param[:name]
-      return hash if !respond_to?(key) || in_path?(key)
 
-      if param[:scope]
-        hash[param[:scope].to_s] ||= {}
-        hash[param[:scope].to_s][key] = send(key)
-      else
-        hash[key] = send(key)
+      keys = [param[:scope], key].flatten.compact
+      method_name = keys.join('_')
+
+      return hash if in_path?(method_name)
+
+      unless respond_to?(method_name)
+        method_name = key
+        return hash unless respond_to?(method_name)
       end
 
-      hash
+      hash.deep_merge(build_param_hash(keys, method_name))
     end
+
+    def build_param_hash(keys, method_name)
+      value = keys[1] ? build_param_hash(keys[1..-1], method_name) : send(method_name)
+      { keys[0].to_s => value }
+    end
+
   end
 end

data/lib/rspec_api_documentation/dsl/resource.rb

@@ -6,7 +6,7 @@ module RspecApiDocumentation::DSL
     module ClassMethods
       def self.define_action(method)
         define_method method do |*args, &block|
-          options = if args.last.is_a?(Hash) then args.pop else {} end
+          options = args.extract_options!
           options[:method] = method
           options[:route] = args.first
           options[:api_doc_dsl] = :endpoint
@@ -38,7 +38,10 @@ module RspecApiDocumentation::DSL
         context(*args, &block)
       end
 
-      def parameter(name, description, options = {})
+      def parameter(name, *args)
+        options = args.extract_options!
+        description = args.pop || "#{Array(options[:scope]).join(" ")} #{name}".humanize
+
         parameters.push(options.merge(:name => name.to_s, :description => description))
       end
 
@@ -89,7 +92,7 @@ module RspecApiDocumentation::DSL
       requests = example.metadata[:requests]
       example.metadata[:requests] = []
 
-      instance_eval &block
+      instance_eval(&block)
 
       example.metadata[:requests] = requests
     end

data/lib/rspec_api_documentation/views/markup_example.rb

@@ -28,6 +28,21 @@ module RspecApiDocumentation
         "#{basename}.#{extension}"
       end
 
+      def parameters
+        super.each do |parameter|
+          if parameter.has_key?(:scope)
+            scope = Array(parameter[:scope]).each_with_index.map do |scope, index|
+              if index == 0
+                scope
+              else
+                "[#{scope}]"
+              end
+            end.join
+            parameter[:scope] = scope
+          end
+        end
+      end
+
       def requests
         super.map do |hash|
           hash[:request_headers_text] = format_hash(hash[:request_headers])

data/lib/rspec_api_documentation/writers/json_writer.rb

@@ -51,7 +51,9 @@ module RspecApiDocumentation
             {
               :description => example.description,
               :link => "#{example.dirname}/#{example.filename}",
-              :groups => example.metadata[:document]
+              :groups => example.metadata[:document],
+              :route => example.route,
+              :method => example.metadata[:method]
             }
           }
         }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Chris Cahoon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec