diff options
author | Lamont Granquist <lamont@scriptkiddie.org> | 2016-08-18 11:32:39 -0700 |
---|---|---|
committer | Lamont Granquist <lamont@scriptkiddie.org> | 2016-08-18 11:32:39 -0700 |
commit | 29ee9f94a60fc62a898997d54e06b81d43ad24a9 (patch) | |
tree | caac10de2b9be7883da29e5887b4f63a34a45916 | |
parent | 16f94a4174cf6735dafba59848401aa895b39782 (diff) | |
download | chef-29ee9f94a60fc62a898997d54e06b81d43ad24a9.tar.gz |
rearrange private/public add @api private
Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
-rw-r--r-- | lib/chef/http.rb | 36 |
1 files changed, 25 insertions, 11 deletions
diff --git a/lib/chef/http.rb b/lib/chef/http.rb index e9d1dc7caa..924081bc6b 100644 --- a/lib/chef/http.rb +++ b/lib/chef/http.rb @@ -248,6 +248,15 @@ class Chef end end + # DEPRECATED: This is only kept around to provide access to cache control data in + # lib/chef/provider/remote_file/http.rb + # FIXME: Find a better API. + def last_response + @last_response + end + + private + # @api private def build_http_client(base_url) if chef_zero_uri?(base_url) @@ -265,6 +274,7 @@ class Chef end end + # @api private def create_url(path) return path if path.is_a?(URI) if path =~ /^(http|https|chefzero):\/\//i @@ -279,6 +289,7 @@ class Chef end end + # @api private def apply_request_middleware(method, url, headers, data) middlewares.inject([method, url, headers, data]) do |req_data, middleware| Chef::Log.debug("Chef::HTTP calling #{middleware.class}#handle_request") @@ -286,6 +297,7 @@ class Chef end end + # @api private def apply_response_middleware(response, rest_request, return_value) middlewares.reverse.inject([response, rest_request, return_value]) do |res_data, middleware| Chef::Log.debug("Chef::HTTP calling #{middleware.class}#handle_response") @@ -293,6 +305,7 @@ class Chef end end + # @api private def apply_stream_complete_middleware(response, rest_request, return_value) middlewares.reverse.inject([response, rest_request, return_value]) do |res_data, middleware| Chef::Log.debug("Chef::HTTP calling #{middleware.class}#handle_stream_complete") @@ -300,6 +313,7 @@ class Chef end end + # @api private def log_failed_request(response, return_value) return_value ||= {} error_message = "HTTP Request Returned #{response.code} #{response.message}: " @@ -307,12 +321,14 @@ class Chef Chef::Log.info(error_message) end + # @api private def success_response?(response) response.kind_of?(Net::HTTPSuccess) || response.kind_of?(Net::HTTPRedirection) end # Runs a synchronous HTTP request, with no middleware applied (use #request # to have the middleware applied). The entire response will be loaded into memory. + # @api private def send_http_request(method, url, headers, body, &response_handler) headers = build_headers(method, url, headers, body) @@ -348,6 +364,7 @@ class Chef # Wraps an HTTP request with retry logic. # === Arguments # url:: URL of the request, used for error messages + # @api private def retrying_http_errors(url) http_attempts = 0 begin @@ -397,18 +414,22 @@ class Chef end end + # @api private def http_retry_delay config[:http_retry_delay] end + # @api private def http_retry_count config[:http_retry_count] end + # @api private def config Chef::Config end + # @api private def follow_redirect raise Chef::Exceptions::RedirectLimitExceeded if @redirects_followed >= redirect_limit @redirects_followed += 1 @@ -419,11 +440,13 @@ class Chef @redirects_followed = 0 end + # @api private def chef_zero_uri?(uri) uri = URI.parse(uri) unless uri.respond_to?(:scheme) uri.scheme == "chefzero" end + # @api private def redirected_to(response) return nil unless response.kind_of?(Net::HTTPRedirection) # Net::HTTPNotModified is undesired subclass of Net::HTTPRedirection so test for this @@ -431,6 +454,7 @@ class Chef response["location"] end + # @api private def build_headers(method, url, headers = {}, json_body = false) headers = @default_headers.merge(headers) headers["Content-Length"] = json_body.bytesize.to_s if json_body @@ -438,6 +462,7 @@ class Chef headers end + # @api private def stream_to_tempfile(url, response, &progress_block) content_length = response["Content-Length"] tf = Tempfile.open("chef-rest") @@ -461,16 +486,5 @@ class Chef raise end - ############################################################################ - # DEPRECATED - ############################################################################ - - # This is only kept around to provide access to cache control data in - # lib/chef/provider/remote_file/http.rb - # Find a better API. - def last_response - @last_response - end - end end |