Module: MiniApivore::Validation

Defined in:
lib/mini_apivore/validation.rb

Overview

former Validator

Defined Under Namespace

Classes: IndHash

Instance Method Summary collapse

Instance Method Details

#action_dispatch_request_args(path, params: {}, headers: {}) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/mini_apivore/validation.rb', line 129

def action_dispatch_request_args(path, params: {}, headers: {})
  if defined?(ActionPack) && ActionPack::VERSION::MAJOR >= 5
    [path, params: params, headers: headers]
  else
    [path, params, headers]
  end
end

#apivore_build_path(path, data) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/mini_apivore/validation.rb', line 85

def apivore_build_path(path, data)
  path.scan(/\{([^\}]*)\}/).each do |param|
    key = param.first
    dkey = data && ( data[key] || data[key.to_sym] )
    if dkey
      path = path.gsub "{#{key}}", dkey.to_param.to_s
    else
      raise URI::InvalidURIError, "No substitution data found for {#{key}}"\
          " to test the path #{path}.", caller
    end
  end
  path + (data['_query_string'] ? "?#{data['_query_string'].to_param}" : '')
end

#check_request_path ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/mini_apivore/validation.rb', line 62

def check_request_path
  if !swagger_checker.has_path?(@path)
    @errors << "Swagger doc: #{swagger_checker.swagger_path} does not have"\
        " a documented @path for #{@path}"
  elsif !swagger_checker.has_method_at_path?(@path, @verb)
    @errors << "Swagger doc: #{swagger_checker.swagger_path} does not have"\
        " a documented @path for #{@verb} #{@path}"
  elsif !swagger_checker.has_response_code_for_path?(@path, @verb, @expected_response_code)
    @errors << "Swagger doc: #{swagger_checker.swagger_path} does not have"\
        " a documented response code of #{@expected_response_code} at @path"\
        " #{@verb} #{@path}. "\
        "\n             Available response codes: #{swagger_checker.response_codes_for_path(@path, @verb)}"
  elsif @verb == "get" && swagger_checker.fragment(@path, @verb, @expected_response_code).nil?
    @errors << "Swagger doc: #{swagger_checker.swagger_path} missing"\
        " response model for get request with #{@path} for code"\
        " #{@expected_response_code}"
  end
end

#check_response_is_valid ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/mini_apivore/validation.rb', line 110

def check_response_is_valid
  swagger_errors = swagger_checker.has_matching_document_for(
    @path, @verb, response.status, response_body
  )
  unless swagger_errors.empty?
    @errors.concat(
      swagger_errors.map do |e|
        e.sub("'#", "'#{full_path}#").gsub(
          /^The property|in schema.*$/,''
        )
      end
    )
  end
end

#check_route(verb, path, expected_response_code, params = {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'lib/mini_apivore/validation.rb', line 21

def check_route( verb, path, expected_response_code, params = {} )
  prepare_action_env( verb, path, expected_response_code, params )
  assert( match?, "  Failed at: \#{Thread.current.backtrace[2]}\\n\n  Failure message: \#{failure_message},\\n \n  fullpath: \#{full_path}, \\n \n  params causing failure:\#{params}\n" )
end

#check_status_code ⇒ Object 



103
104
105
106
107
108
 
# File 'lib/mini_apivore/validation.rb', line 103

def check_status_code
  if response.status != @expected_response_code
    @errors << "Path #{@path} did not respond with expected status code."\
        " Expected #{@expected_response_code} got #{response.status}"\
    end
end

#failure_message ⇒ Object 



101
 
# File 'lib/mini_apivore/validation.rb', line 101

def failure_message; @errors.join(" ") end

#full_path ⇒ Object 



81
82
83
 
# File 'lib/mini_apivore/validation.rb', line 81

def full_path
  apivore_build_path(swagger_checker.base_path + @path, @params)
end

#has_errors? ⇒ Boolean 



99
 
# File 'lib/mini_apivore/validation.rb', line 99

def has_errors?; !@errors.empty?  end

#match? ⇒ Boolean 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mini_apivore/validation.rb', line 31

def match?
  #pre_checks
  check_request_path

  # request
  unless has_errors?
    send(
      @verb,
      *action_dispatch_request_args(
        full_path,
        params: @params['_data'] || {},
        headers: @params['_headers'] || {}
      )
    )

    #post_checks
    check_status_code
    check_response_is_valid unless has_errors?


    if has_errors? && response.body.length > 0
      @errors << "\nResponse body:\n #{JSON.pretty_generate(JSON.parse(response.body))}"
    end

    swagger_checker.remove_tested_end_point_response(
      @path, @verb, @expected_response_code
    )
  end
  !has_errors?
end

#prepare_action_env(verb, path, expected_response_code, params = {}) ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/mini_apivore/validation.rb', line 11

def prepare_action_env(verb, path, expected_response_code, params = {})
  @errors = []
  @verb = verb.to_s
  @path = path.to_s
  @params = IndHash.new(params)
  @expected_response_code = expected_response_code.to_i
end

#response_body ⇒ Object 



125
126
127
 
# File 'lib/mini_apivore/validation.rb', line 125

def response_body
  JSON.parse(response.body) if response.body && !response.body.empty?
end

#swagger_checker ⇒ Object 



19
 
# File 'lib/mini_apivore/validation.rb', line 19

def swagger_checker; self.class.swagger_checker end