Class: Chef::HTTP::BasicClient
- Inherits:
-
Object
- Object
- Chef::HTTP::BasicClient
- Defined in:
- lib/chef/http/basic_client.rb
Constant Summary collapse
- HTTPS =
"https".freeze
Instance Attribute Summary collapse
-
#http_client ⇒ Object
readonly
Returns the value of attribute http_client.
-
#ssl_policy ⇒ Object
readonly
Returns the value of attribute ssl_policy.
-
#url ⇒ Object
readonly
Returns the value of attribute url.
Instance Method Summary collapse
- #build_http_client ⇒ Object
- #config ⇒ Object
- #configure_ssl(http_client) ⇒ Object
- #host ⇒ Object
- #http_client_builder ⇒ Object
- #http_proxy_pass(proxy_uri) ⇒ Object
- #http_proxy_user(proxy_uri) ⇒ Object
-
#initialize(url, opts = {}) ⇒ BasicClient
constructor
Instantiate a BasicClient.
- #port ⇒ Object
- #proxy_uri ⇒ Object
- #request(method, url, req_body, base_headers = {}) ⇒ Object
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
43 44 45 46 47 |
# File 'lib/chef/http/basic_client.rb', line 43 def initialize(url, opts = {}) @url = url @ssl_policy = opts[:ssl_policy] || DefaultSSLPolicy @http_client = build_http_client end |
Instance Attribute Details
#http_client ⇒ Object (readonly)
Returns the value of attribute http_client.
35 36 37 |
# File 'lib/chef/http/basic_client.rb', line 35 def http_client @http_client end |
#ssl_policy ⇒ Object (readonly)
Returns the value of attribute ssl_policy.
36 37 38 |
# File 'lib/chef/http/basic_client.rb', line 36 def ssl_policy @ssl_policy end |
#url ⇒ Object (readonly)
Returns the value of attribute url.
34 35 36 |
# File 'lib/chef/http/basic_client.rb', line 34 def url @url end |
Instance Method Details
#build_http_client ⇒ Object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/chef/http/basic_client.rb', line 102 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] http_client end |
#config ⇒ Object
120 121 122 |
# File 'lib/chef/http/basic_client.rb', line 120 def config Chef::Config end |
#configure_ssl(http_client) ⇒ Object
142 143 144 145 |
# File 'lib/chef/http/basic_client.rb', line 142 def configure_ssl(http_client) http_client.use_ssl = true ssl_policy.apply_to(http_client) end |
#host ⇒ Object
49 50 51 |
# File 'lib/chef/http/basic_client.rb', line 49 def host @url.hostname end |
#http_client_builder ⇒ Object
124 125 126 127 128 129 130 131 132 |
# File 'lib/chef/http/basic_client.rb', line 124 def http_client_builder if proxy_uri.nil? Net::HTTP else Chef::Log.debug("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
138 139 140 |
# File 'lib/chef/http/basic_client.rb', line 138 def http_proxy_pass(proxy_uri) proxy_uri.password || Chef::Config["#{proxy_uri.scheme}_proxy_pass"] end |
#http_proxy_user(proxy_uri) ⇒ Object
134 135 136 |
# File 'lib/chef/http/basic_client.rb', line 134 def http_proxy_user(proxy_uri) proxy_uri.user || Chef::Config["#{proxy_uri.scheme}_proxy_user"] end |
#port ⇒ Object
53 54 55 |
# File 'lib/chef/http/basic_client.rb', line 53 def port @url.port end |
#proxy_uri ⇒ Object
98 99 100 |
# File 'lib/chef/http/basic_client.rb', line 98 def proxy_uri @proxy_uri ||= Chef::Config.proxy_uri(url.scheme, host, port) end |
#request(method, url, req_body, base_headers = {}) ⇒ Object
57 58 59 60 61 62 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 |
# File 'lib/chef/http/basic_client.rb', line 57 def request(method, url, req_body, base_headers = {}) http_request = HTTPRequest.new(method, url, req_body, base_headers).http_request Chef::Log.debug("Initiating #{method} to #{url}") Chef::Log.debug("---- HTTP Request Header Data: ----") base_headers.each do |name, value| Chef::Log.debug("#{name}: #{value}") end Chef::Log.debug("---- End HTTP Request Header Data ----") http_client.request(http_request) do |response| Chef::Log.debug("---- HTTP Status and Header Data: ----") Chef::Log.debug("HTTP #{response.http_version} #{response.code} #{response.msg}") response.each do |header, value| Chef::Log.debug("#{header}: #{value}") end Chef::Log.debug("---- 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.debug("---- HTTP Response Body ----") Chef::Log.debug(response.body) Chef::Log.debug("---- End HTTP Response Body -----") end if req_body Chef::Log.debug("---- HTTP Request Body ----") Chef::Log.debug(req_body) Chef::Log.debug("---- 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.}") raise end |