Class: Chef::HTTP::JSONOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/http/json_output.rb

Overview

Middleware that takes an HTTP response, parses it as JSON if possible.

Direct Known Subclasses

JSONToModelOutput

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ JSONOutput

Returns a new instance of JSONOutput.



32
33
34
35
 
# File 'lib/chef/http/json_output.rb', line 32

def initialize(opts = {})
  @raw_output = opts[:raw_output]
  @inflate_json_class = opts[:inflate_json_class]
end

Instance Attribute Details

#inflate_json_class ⇒ Object

Returns the value of attribute inflate_json_class.



30
31
32
 
# File 'lib/chef/http/json_output.rb', line 30

def inflate_json_class
  @inflate_json_class
end

#raw_output ⇒ Object

Returns the value of attribute raw_output.



29
30
31
 
# File 'lib/chef/http/json_output.rb', line 29

def raw_output
  @raw_output
end

Instance Method Details

#handle_request(method, url, headers = {}, data = false) ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/chef/http/json_output.rb', line 37

def handle_request(method, url, headers = {}, data = false)
  # Ideally this should always set Accept to application/json, but
  # Chef::REST is sometimes used to make non-JSON requests, so it sets
  # Accept to the desired value before middlewares get called.
  headers["Accept"] ||= "application/json"
  [method, url, headers, data]
end

#handle_response(http_response, rest_request, return_value) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/chef/http/json_output.rb', line 45

def handle_response(http_response, rest_request, return_value)
  # temporary hack, skip processing if return_value is false
  # needed to keep conditional get stuff working correctly.
  return [http_response, rest_request, return_value] if return_value == false

  if /json/.match?(http_response["content-type"])
    if http_response.body.nil?
      return_value = nil
    elsif raw_output
      return_value = http_response.body.to_s
    else
      if inflate_json_class
        return_value = Chef::JSONCompat.from_json(http_response.body.chomp)
      else
        return_value = Chef::JSONCompat.parse(http_response.body.chomp)
      end
    end
    [http_response, rest_request, return_value]
  else
    Chef::Log.trace("Expected JSON response, but got content-type '#{http_response["content-type"]}'")
    if http_response.body
      Chef::Log.trace("Response body contains:\n#{http_response.body.length < 256 ? http_response.body : http_response.body[0..256] + " [...truncated...]"}")
    end
    [http_response, rest_request, http_response.body.to_s]
  end
end

#handle_stream_complete(http_response, rest_request, return_value) ⇒ Object 



72
73
74
 
# File 'lib/chef/http/json_output.rb', line 72

def handle_stream_complete(http_response, rest_request, return_value)
  [http_response, rest_request, return_value]
end

#stream_response_handler(response) ⇒ Object 



76
77
78
 
# File 'lib/chef/http/json_output.rb', line 76

def stream_response_handler(response)
  nil
end