Class: Chef::HTTP::BasicClient

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

Constant Summary collapse

HTTPS = 
"https".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, opts = {}) ⇒ BasicClient

Instantiate a BasicClient.

Arguments:

url

An URI for the remote server.

Options:

ssl_policy

The SSL Policy to use, defaults to DefaultSSLPolicy



45
46
47
48
49
 
# File 'lib/chef/http/basic_client.rb', line 45

def initialize(url, opts = {})
  @url = url
  @ssl_policy = opts[:ssl_policy] || DefaultSSLPolicy
  @keepalives = opts[:keepalives] || false
end

Instance Attribute Details

#keepalives ⇒ Object (readonly)

Returns the value of attribute keepalives.



38
39
40
 
# File 'lib/chef/http/basic_client.rb', line 38

def keepalives
  @keepalives
end

#ssl_policy ⇒ Object (readonly)

Returns the value of attribute ssl_policy.



37
38
39
 
# File 'lib/chef/http/basic_client.rb', line 37

def ssl_policy
  @ssl_policy
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



36
37
38
 
# File 'lib/chef/http/basic_client.rb', line 36

def url
  @url
end

Instance Method Details

#build_http_client ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/chef/http/basic_client.rb', line 108

def build_http_client
  # Note: the last nil in the new below forces Net::HTTP to ignore the
  # no_proxy environment variable. This is a workaround for limitations
  # in Net::HTTP use of the no_proxy environment variable. We internally
  # match no_proxy with a fuzzy matcher, rather than letting Net::HTTP
  # do it.
  http_client = http_client_builder.new(host, port, nil)
  http_client.proxy_port = nil if http_client.proxy_address.nil?

  if url.scheme == HTTPS
    configure_ssl(http_client)
  end

  http_client.read_timeout = config[:rest_timeout]
  http_client.open_timeout = config[:rest_timeout]
  if keepalives
    http_client.start
  else
    http_client
  end
end

#config ⇒ Object 



130
131
132
 
# File 'lib/chef/http/basic_client.rb', line 130

def config
  Chef::Config
end

#configure_ssl(http_client) ⇒ Object 



152
153
154
155
 
# File 'lib/chef/http/basic_client.rb', line 152

def configure_ssl(http_client)
  http_client.use_ssl = true
  ssl_policy.apply_to(http_client)
end

#host ⇒ Object 



55
56
57
 
# File 'lib/chef/http/basic_client.rb', line 55

def host
  @url.hostname
end

#http_client ⇒ Object 



51
52
53
 
# File 'lib/chef/http/basic_client.rb', line 51

def http_client
  @http_client ||= build_http_client
end

#http_client_builder ⇒ Object 



134
135
136
137
138
139
140
141
142
 
# File 'lib/chef/http/basic_client.rb', line 134

def http_client_builder
  if proxy_uri.nil?
    Net::HTTP
  else
    Chef::Log.trace("Using #{proxy_uri.host}:#{proxy_uri.port} for proxy")
    Net::HTTP.Proxy(proxy_uri.host, proxy_uri.port, http_proxy_user(proxy_uri),
      http_proxy_pass(proxy_uri))
  end
end

#http_proxy_pass(proxy_uri) ⇒ Object 



148
149
150
 
# File 'lib/chef/http/basic_client.rb', line 148

def http_proxy_pass(proxy_uri)
  proxy_uri.password || Chef::Config["#{proxy_uri.scheme}_proxy_pass"]
end

#http_proxy_user(proxy_uri) ⇒ Object 



144
145
146
 
# File 'lib/chef/http/basic_client.rb', line 144

def http_proxy_user(proxy_uri)
  proxy_uri.user || Chef::Config["#{proxy_uri.scheme}_proxy_user"]
end

#port ⇒ Object 



59
60
61
 
# File 'lib/chef/http/basic_client.rb', line 59

def port
  @url.port
end

#proxy_uri ⇒ Object 



104
105
106
 
# File 'lib/chef/http/basic_client.rb', line 104

def proxy_uri
  @proxy_uri ||= Chef::Config.proxy_uri(url.scheme, host, port)
end

#request(method, url, req_body, base_headers = {}) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/chef/http/basic_client.rb', line 63

def request(method, url, req_body, base_headers = {})
  http_request = HTTPRequest.new(method, url, req_body, base_headers).http_request
  Chef::Log.trace("Initiating #{method} to #{url}")
  Chef::Log.trace("---- HTTP Request Header Data: ----")
  base_headers.each do |name, value|
    Chef::Log.trace("#{name}: #{value}")
  end
  Chef::Log.trace("---- End HTTP Request Header Data ----")
  http_client.request(http_request) do |response|
    Chef::Log.trace("---- HTTP Status and Header Data: ----")
    Chef::Log.trace("HTTP #{response.http_version} #{response.code} #{response.msg}")

    response.each do |header, value|
      Chef::Log.trace("#{header}: #{value}")
    end
    Chef::Log.trace("---- End HTTP Status/Header Data ----")

    # For non-400's, log the request and response bodies
    if !response.code || !response.code.start_with?("2")
      if response.body
        Chef::Log.trace("---- HTTP Response Body ----")
        Chef::Log.trace(response.body)
        Chef::Log.trace("---- End HTTP Response Body -----")
      end
      if req_body
        Chef::Log.trace("---- HTTP Request Body ----")
        Chef::Log.trace(req_body)
        Chef::Log.trace("---- End HTTP Request Body ----")
      end
    end

    yield response if block_given?
    # http_client.request may not have the return signature we want, so
    # force the issue:
    return [http_request, response]
  end
rescue OpenSSL::SSL::SSLError => e
  Chef::Log.error("SSL Validation failure connecting to host: #{host} - #{e.message}")
  raise
end