class Apipie::Extractor::Recorder

Constants

MULTIPART_BOUNDARY

Public Class Methods

new() click to toggle source
# File lib/apipie/extractor/recorder.rb, line 6
def initialize
  @ignored_params = [:controller, :action]
end

Public Instance Methods

analyse_controller(controller) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 25
def analyse_controller(controller)
  @controller = controller.class
  @action = Apipie.configuration.api_action_matcher.call(controller)
end
analyse_env(env) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 10
def analyse_env(env)
  @verb = env["REQUEST_METHOD"].to_sym
  @path = env["PATH_INFO"].sub(%r{^/*},"/")
  @query = env["QUERY_STRING"] unless env["QUERY_STRING"].blank?
  @params = Rack::Utils.parse_nested_query(@query)
  @params.merge!(env["action_dispatch.request.request_parameters"] || {})
  rack_input = env["rack.input"]
  if data = parse_data(rack_input.read)
    @request_data = data
  elsif form_hash = env["rack.request.form_hash"]
    @request_data = reformat_multipart_data(form_hash)
  end
  rack_input.rewind
end
analyse_response(response) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 30
def analyse_response(response)
  if response.last.respond_to?(:body) && data = parse_data(response.last.body)
    @response_data = if response[1]['Content-Disposition'].to_s.start_with?('attachment')
                       '<STREAMED ATTACHMENT FILE>'
                     else
                       data
                     end
  end
  @code = response.first
end
analyze_functional_test(test_context) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 41
def analyze_functional_test(test_context)
  request, response = test_context.request, test_context.response
  @verb = request.request_method.to_sym
  @path = request.path
  @params = request.request_parameters
  if [:POST, :PUT, :PATCH, :DELETE].include?(@verb)
    @request_data = request.content_type == "multipart/form-data" ? reformat_multipart_data(@params) : @params
  else
    @query = request.query_string
  end
  if response.media_type != 'application/pdf'
    @response_data = parse_data(response.body)
  end
  @code = response.code
end
content_disposition(name) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 115
def content_disposition(name)
  %{Content-Disposition: form-data; name="#{name}"}
end
parse_data(data) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 57
def parse_data(data)
  return nil if data.strip.blank?
  JSON.parse(data)
rescue StandardError
  data
end
record() click to toggle source
# File lib/apipie/extractor/recorder.rb, line 131
def record
  if @controller
    {:controller => @controller,
     :action => @action,
     :verb => @verb,
     :path => @path,
     :params => @params,
     :query => @query,
     :request_data => @request_data,
     :response_data => @response_data,
     :code => @code}
  else
    nil
  end
end
reformat_array(boundary, attrs, key, lines) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 102
def reformat_array(boundary, attrs, key, lines)
  attrs.each do |item|
    lines << boundary << content_disposition("#{key}[]")
    lines << '' << item
  end
end
reformat_boolean(boundary, attrs, key, lines) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 97
def reformat_boolean(boundary, attrs, key, lines)
  lines << boundary << content_disposition(key)
  lines << '' << attrs.to_s
end
reformat_data(data) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 119
def reformat_data(data)
  parsed = parse_data(data)
  case parsed
  when nil
    nil
  when String
    parsed
  else
    JSON.pretty_generate().gsub(/: \[\s*\]/,": []").gsub(/\{\s*\}/,"{}")
  end
end
reformat_hash(boundary, attrs, lines) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 85
def reformat_hash(boundary, attrs, lines)
  if head = attrs[:head]
    lines << boundary
    lines.concat(head.split("\r\n"))
    # To avoid large and/or binary file bodies, simply indicate the contents in the output.
    lines << '' << %{... contents of "#{attrs[:name]}" ...}
  else
    # Look for subelements that contain a part.
    attrs.each { |k,v| v.is_a?(Hash) and reformat_hash(boundary, v, lines) }
  end
end
reformat_multipart_data(form) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 64
def reformat_multipart_data(form)
  form.empty? and return ''
  lines = ["Content-Type: multipart/form-data; boundary=#{MULTIPART_BOUNDARY}",'']
  boundary = "--#{MULTIPART_BOUNDARY}"
  form.each do |key, attrs|
    if attrs.is_a?(String) # rubocop:disable Style/CaseLikeIf
      lines << boundary << content_disposition(key) << "Content-Length: #{attrs.size}" << '' << attrs
    elsif attrs.is_a?(Rack::Test::UploadedFile) || attrs.is_a?(ActionDispatch::Http::UploadedFile)
      reformat_uploaded_file(boundary, attrs, key, lines)
    elsif attrs.is_a?(Array)
      reformat_array(boundary, attrs, key, lines)
    elsif attrs.is_a?(TrueClass) || attrs.is_a?(FalseClass)
      reformat_boolean(boundary, attrs, key, lines)
    else
      reformat_hash(boundary, attrs, lines)
    end
  end
  lines << "#{boundary}--"
  lines.join("\n")
end
reformat_uploaded_file(boundary, file, key, lines) click to toggle source
# File lib/apipie/extractor/recorder.rb, line 109
def reformat_uploaded_file(boundary, file, key, lines)
  lines << boundary << %{#{content_disposition(key)}; filename="#{file.original_filename}"}
  lines << "Content-Length: #{file.size}" << "Content-Type: #{file.content_type}" << "Content-Transfer-Encoding: binary"
  lines << '' << %{... contents of "#{key}" ...}
end

Protected Instance Methods

api_description() click to toggle source
# File lib/apipie/extractor/recorder.rb, line 149
def api_description
end