Class: Chef::REST

Inherits:
HTTP show all
Defined in:
lib/chef/rest.rb,
lib/chef/rest.rb

Overview

Chef::REST

Chef’s custom REST client with built-in JSON support and RSA signed header authentication.

Direct Known Subclasses

Shell::ShellREST

Constant Summary collapse

RESTRequest =

Backwards compatibility for things that use Chef::REST::RESTRequest or its constants

HTTP::HTTPRequest

Instance Attribute Summary collapse

Attributes inherited from HTTP

#middlewares

Instance Method Summary collapse

Methods inherited from HTTP

#delete, #head, #last_response, middlewares, #post, #put, #request, use

Constructor Details

#initialize(url, client_name = Chef::Config[:node_name], signing_key_filename = Chef::Config[:client_key], options = {}) ⇒ REST

Create a REST client object. The supplied url is used as the base for all subsequent requests. For example, when initialized with a base url localhost:4000, a call to get_rest with ‘nodes’ will make an HTTP GET request to localhost:4000/nodes



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/chef/rest.rb', line 59

def initialize(url, client_name=Chef::Config[:node_name], signing_key_filename=Chef::Config[:client_key], options={})
  options = options.dup
  options[:client_name] = client_name
  options[:signing_key_filename] = signing_key_filename
  super(url, options)

  @decompressor = Decompressor.new(options)
  @authenticator = Authenticator.new(options)
  @request_id = RemoteRequestID.new(options)

  @middlewares << JSONInput.new(options)
  @middlewares << JSONToModelOutput.new(options)
  @middlewares << CookieManager.new(options)
  @middlewares << @decompressor
  @middlewares << @authenticator
  @middlewares << @request_id

  # ValidateContentLength should come after Decompressor
  # because the order of middlewares is reversed when handling
  # responses.
  @middlewares << ValidateContentLength.new(options)

end

Instance Attribute Details

#authenticator ⇒ Object (readonly)

Returns the value of attribute authenticator.



53
54
55
 
# File 'lib/chef/rest.rb', line 53

def authenticator
  @authenticator
end

#cookies ⇒ Object

Returns the value of attribute cookies.



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

def cookies
  @cookies
end

#redirect_limit ⇒ Object

Returns the value of attribute redirect_limit.



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

def redirect_limit
  @redirect_limit
end

#sign_on_redirect ⇒ Object

Returns the value of attribute sign_on_redirect.



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

def sign_on_redirect
  @sign_on_redirect
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

Instance Method Details

#auth_credentials ⇒ Object 



87
88
89
 
# File 'lib/chef/rest.rb', line 87

def auth_credentials
  authenticator.auth_credentials
end

#authentication_headers(method, url, json_body = nil) ⇒ Object 



204
205
206
 
# File 'lib/chef/rest.rb', line 204

def authentication_headers(method, url, json_body=nil)
  authenticator.authentication_headers(method, url, json_body)
end

#client_name ⇒ Object 



91
92
93
 
# File 'lib/chef/rest.rb', line 91

def client_name
  authenticator.client_name
end

#decompress_body(body) ⇒ Object

DEPRECATED



200
201
202
 
# File 'lib/chef/rest.rb', line 200

def decompress_body(body)
  @decompressor.decompress_body(body)
end

#fetch(path, headers = {}) ⇒ Object

Streams a download to a tempfile, then yields the tempfile to a block. After the download, the tempfile will be closed and unlinked. If you rename the tempfile, it will not be deleted. Beware that if the server streams infinite content, this method will stream it until you run out of disk space.



132
133
134
 
# File 'lib/chef/rest.rb', line 132

def fetch(path, headers={})
  streaming_request(create_url(path), headers) {|tmp_file| yield tmp_file }
end

#follow_redirect ⇒ Object 



180
181
182
183
184
185
186
187
 
# File 'lib/chef/rest.rb', line 180

def follow_redirect
  unless @sign_on_redirect
    @authenticator.sign_request = false
  end
  super
ensure
  @authenticator.sign_request = true
end

#get(path, raw = false, headers = {}) ⇒ Object Also known as: get_rest

Send an HTTP GET request to the path

Using this method to fetch a file is considered deprecated.

Parameters

path

The path to GET

raw

Whether you want the raw body returned, or JSON inflated. Defaults

to JSON inflated.



111
112
113
114
115
116
117
 
# File 'lib/chef/rest.rb', line 111

def get(path, raw=false, headers={})
  if raw
    streaming_request(path, headers)
  else
    request(:GET, path, headers)
  end
end

#http_client(base_url = nil) ⇒ Object 



191
192
193
194
 
# File 'lib/chef/rest.rb', line 191

def http_client(base_url=nil)
  base_url ||= url
  BasicClient.new(base_url, :ssl_policy => Chef::HTTP::APISSLPolicy)
end

#raw_http_request(method, path, headers, data) ⇒ Object

Do a HTTP request where no middleware is loaded (e.g. JSON input/output conversion) but the standard Chef Authentication headers are added to the request.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/chef/rest.rb', line 141

def raw_http_request(method, path, headers, data)
  url = create_url(path)
  method, url, headers, data = @authenticator.handle_request(method, url, headers, data)
  method, url, headers, data = @request_id.handle_request(method, url, headers, data)
  response, rest_request, return_value = send_http_request(method, url, headers, data)
  response.error! unless success_response?(response)
  return_value
rescue Exception => exception
  log_failed_request(response, return_value) unless response.nil?

  if exception.respond_to?(:chef_rest_request=)
    exception.chef_rest_request = rest_request
  end
  raise
end

#retriable_http_request(method, url, req_body, headers) ⇒ Object Also known as: retriable_rest_request

Deprecated: Responsibilities of this method have been split up. The #http_client is now responsible for making individual requests, while #retrying_http_errors handles error/retry logic.



161
162
163
164
165
166
167
168
169
 
# File 'lib/chef/rest.rb', line 161

def retriable_http_request(method, url, req_body, headers)
  rest_request = Chef::HTTP::HTTPRequest.new(method, url, req_body, headers)

  Chef::Log.debug("Sending HTTP Request via #{method} to #{url.host}:#{url.port}#{rest_request.path}")

  retrying_http_errors(url) do
    yield rest_request
  end
end

#sign_requests? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/chef/rest.rb', line 99

def sign_requests?
  authenticator.sign_requests?
end

#signing_key ⇒ Object 



95
96
97
 
# File 'lib/chef/rest.rb', line 95

def signing_key
  authenticator.raw_key
end

#signing_key_filename ⇒ Object 



83
84
85
 
# File 'lib/chef/rest.rb', line 83

def signing_key_filename
  authenticator.signing_key_filename
end

#streaming_request(url, headers, &block) ⇒ Object

Customized streaming behavior; sets the accepted content type to “/” if not otherwise specified for compatibility purposes



173
174
175
176
 
# File 'lib/chef/rest.rb', line 173

def streaming_request(url, headers, &block)
  headers["Accept"] ||= "*/*"
  super
end