Class: Chef::HTTP::HTTPRequest
- Inherits:
-
Object
- Object
- Chef::HTTP::HTTPRequest
- Defined in:
- lib/chef/http/http_request.rb
Constant Summary collapse
- UA_COMMON =
"/#{::Chef::VERSION} (#{engine}-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}; ohai-#{Ohai::VERSION}; #{RUBY_PLATFORM}; +#{Chef::Dist::WEBSITE})".freeze
- DEFAULT_UA =
"Chef Client" << UA_COMMON
- USER_AGENT =
"User-Agent".freeze
- ACCEPT_ENCODING =
"Accept-Encoding".freeze
- ENCODING_GZIP_DEFLATE =
"gzip;q=1.0,deflate;q=0.6,identity;q=0.3".freeze
- GET =
"get".freeze
- PATCH =
"patch".freeze
- PUT =
"put".freeze
- POST =
"post".freeze
- DELETE =
"delete".freeze
- HEAD =
"head".freeze
- HTTPS =
"https".freeze
- SLASH =
"/".freeze
- HOST_LOWER =
"host".freeze
- URI_SCHEME_DEFAULT_PORT =
{ "http" => 80, "https" => 443 }.freeze
Instance Attribute Summary collapse
-
#headers ⇒ Object
readonly
Returns the value of attribute headers.
-
#http_request ⇒ Object
readonly
Returns the value of attribute http_request.
-
#method ⇒ Object
readonly
Returns the value of attribute method.
-
#url ⇒ Object
readonly
Returns the value of attribute url.
Class Method Summary collapse
Instance Method Summary collapse
-
#call ⇒ Object
deprecated
Deprecated.
Call request on an HTTP client object instead.
- #config ⇒ Object
- #host ⇒ Object
-
#http_client ⇒ Object
deprecated
Deprecated.
Call request on an HTTP client object instead.
-
#initialize(method, url, req_body, base_headers = {}) ⇒ HTTPRequest
constructor
A new instance of HTTPRequest.
- #path ⇒ Object
- #port ⇒ Object
- #query ⇒ Object
- #uri_safe_host ⇒ Object
Constructor Details
#initialize(method, url, req_body, base_headers = {}) ⇒ HTTPRequest
Returns a new instance of HTTPRequest.
77 78 79 80 81 82 |
# File 'lib/chef/http/http_request.rb', line 77 def initialize(method, url, req_body, base_headers = {}) @method, @url = method, url @request_body = nil build_headers(base_headers) configure_http_request(req_body) end |
Instance Attribute Details
#headers ⇒ Object (readonly)
Returns the value of attribute headers.
75 76 77 |
# File 'lib/chef/http/http_request.rb', line 75 def headers @headers end |
#http_request ⇒ Object (readonly)
Returns the value of attribute http_request.
75 76 77 |
# File 'lib/chef/http/http_request.rb', line 75 def http_request @http_request end |
#method ⇒ Object (readonly)
Returns the value of attribute method.
75 76 77 |
# File 'lib/chef/http/http_request.rb', line 75 def method @method end |
#url ⇒ Object (readonly)
Returns the value of attribute url.
75 76 77 |
# File 'lib/chef/http/http_request.rb', line 75 def url @url end |
Class Method Details
.user_agent ⇒ Object
71 72 73 |
# File 'lib/chef/http/http_request.rb', line 71 def self.user_agent @user_agent ||= DEFAULT_UA end |
.user_agent=(ua) ⇒ Object
67 68 69 |
# File 'lib/chef/http/http_request.rb', line 67 def self.user_agent=(ua) @user_agent = ua end |
Instance Method Details
#call ⇒ Object
Deprecated.
Call request on an HTTP client object instead.
105 106 107 108 109 110 111 112 |
# File 'lib/chef/http/http_request.rb', line 105 def call hide_net_http_bug do http_client.request(http_request) do |response| yield response if block_given? response end end end |
#config ⇒ Object
114 115 116 |
# File 'lib/chef/http/http_request.rb', line 114 def config Chef::Config end |
#host ⇒ Object
84 85 86 |
# File 'lib/chef/http/http_request.rb', line 84 def host @url.hostname end |
#http_client ⇒ Object
Deprecated.
Call request on an HTTP client object instead.
119 120 121 |
# File 'lib/chef/http/http_request.rb', line 119 def http_client @http_client ||= BasicClient.new(url).http_client end |
#path ⇒ Object
100 101 102 |
# File 'lib/chef/http/http_request.rb', line 100 def path @url.path.empty? ? SLASH : @url.path end |
#port ⇒ Object
92 93 94 |
# File 'lib/chef/http/http_request.rb', line 92 def port @url.port end |
#query ⇒ Object
96 97 98 |
# File 'lib/chef/http/http_request.rb', line 96 def query @url.query end |
#uri_safe_host ⇒ Object
88 89 90 |
# File 'lib/chef/http/http_request.rb', line 88 def uri_safe_host @url.host end |