Class: Puppet::Indirector::REST

Inherits:
Terminus show all
Includes:
Network::HTTP::API::V1
Defined in:
lib/vendor/puppet/indirector/rest.rb

Overview

Access objects via REST

Constant Summary

Constants included from Network::HTTP::API::V1

Network::HTTP::API::V1::METHOD_MAP

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Class Attribute Summary collapse

Attributes included from Util::Docs

#doc, #nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Network::HTTP::API::V1

#indirection2uri, #indirection_method, #plurality, #pluralize, #request_to_uri_and_body, #uri2indirection

Methods inherited from Terminus

abstract_terminus?, const2name, #indirection, indirection_name, inherited, #initialize, mark_as_abstract_terminus, #model, model, #name, name2const, register_terminus_class, terminus_class, terminus_classes, #terminus_type

Methods included from Util::InstanceLoader

#instance_docs, #instance_hash, #instance_load, #instance_loader, #instance_loading?, #loaded_instance, #loaded_instances

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, #execfail, #execpipe, execute, execute_posix, execute_windows, logmethods, memory, path_to_uri, proxy, replace_file, safe_posix_fork, symbolize, symbolizehash, symbolizehash!, synchronize_on, thinmark, #threadlock, uri_to_path, wait_for_output, which, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Constructor Details

This class inherits a constructor from Puppet::Indirector::Terminus

Class Attribute Details

.port_setting ⇒ Object (readonly)

Returns the value of attribute port_setting.



14
15
16
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 14

def port_setting
  @port_setting
end

.server_setting ⇒ Object (readonly)

Returns the value of attribute server_setting.



14
15
16
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 14

def server_setting
  @server_setting
end

Class Method Details

.port ⇒ Object 



31
32
33
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 31

def self.port
  Puppet.settings[port_setting || :masterport].to_i
end

.server ⇒ Object 



22
23
24
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 22

def self.server
  Puppet.settings[server_setting || :server]
end

.use_port_setting(setting) ⇒ Object

Specify the setting that we should use to get the port.



27
28
29
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 27

def self.use_port_setting(setting)
  @port_setting = setting
end

.use_server_setting(setting) ⇒ Object

Specify the setting that we should use to get the server name.



18
19
20
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 18

def self.use_server_setting(setting)
  @server_setting = setting
end

Instance Method Details

#convert_to_http_error(response) ⇒ Object 



60
61
62
63
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 60

def convert_to_http_error(response)
  message = "Error #{response.code} on SERVER: #{(response.body||'').empty? ? response.message : uncompress_body(response)}"
  Net::HTTPError.new(message, response)
end

#deserialize(response, multiple = false) ⇒ Object

Figure out the content type, turn that into a format, and use the format to extract the body of the response.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 37

def deserialize(response, multiple = false)
  case response.code
  when "404"
    return nil
  when /^2/
    raise "No content type in http response; cannot parse" unless response['content-type']

    content_type = response['content-type'].gsub(/\s*;.*$/,'') # strip any appended charset

    body = uncompress_body(response)

    # Convert the response to a deserialized object.
    if multiple
      model.convert_from_multiple(content_type, body)
    else
      model.convert_from(content_type, body)
    end
  else
    # Raise the http error if we didn't get a 'success' of some kind.
    raise convert_to_http_error(response)
  end
end

#destroy(request) ⇒ Object

Raises:

  • (ArgumentError) 


151
152
153
154
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 151

def destroy(request)
  raise ArgumentError, "DELETE does not accept options" unless request.options.empty?
  deserialize http_delete(request, indirection2uri(request), headers)
end

#find(request) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 116

def find(request)
  uri, body = request_to_uri_and_body(request)
  uri_with_query_string = "#{uri}?#{body}"
  # WEBrick in Ruby 1.9.1 only supports up to 1024 character lines in an HTTP request
  # http://redmine.ruby-lang.org/issues/show/3991
  response = if "GET #{uri_with_query_string} HTTP/1.1\r\n".length > 1024
    http_post(request, uri, body, headers)
  else
    http_get(request, uri_with_query_string, headers)
  end
  result = deserialize response
  result.name = request.key if result.respond_to?(:name=)
  result
end

#head(request) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 131

def head(request)
  response = http_head(request, indirection2uri(request), headers)
  case response.code
  when "404"
    return false
  when /^2/
    return true
  else
    # Raise the http error if we didn't get a 'success' of some kind.
    raise convert_to_http_error(response)
  end
end

#headers ⇒ Object

Provide appropriate headers.



66
67
68
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 66

def headers
  add_accept_encoding({"Accept" => model.supported_formats.join(", ")})
end

#http_request(method, request, *args) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 80

def http_request(method, request, *args)
  http_connection = network(request)
  peer_certs = []
  verify_errors = []

  http_connection.verify_callback = proc do |preverify_ok, ssl_context|
    # We use the callback to collect the certificates for use in constructing
    # the error message if the verification failed.  This is necessary since we
    # don't have direct access to the cert that we expected the connection to
    # use otherwise.
    peer_certs << Puppet::SSL::Certificate.from_s(ssl_context.current_cert.to_pem)
    # And also keep the detailed verification error if such an error occurs
    if ssl_context.error_string and not preverify_ok
      verify_errors << "#{ssl_context.error_string} for #{ssl_context.current_cert.subject}"
    end
    preverify_ok
  end

  http_connection.send(method, *args)
rescue OpenSSL::SSL::SSLError => error
  if error.message.include? "certificate verify failed"
    msg = error.message
    msg << ": [" + verify_errors.join('; ') + "]"
    raise Puppet::Error, msg
  elsif error.message =~ /hostname (was )?not match/
    raise unless cert = peer_certs.find { |c| c.name !~ /^puppet ca/i }

    valid_certnames = [cert.name, *cert.subject_alt_names].uniq
    msg = valid_certnames.length > 1 ? "one of #{valid_certnames.join(', ')}" : valid_certnames.first

    raise Puppet::Error, "Server hostname '#{http_connection.address}' did not match server certificate; expected #{msg}"
  else
    raise
  end
end

#network(request) ⇒ Object 



70
71
72
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 70

def network(request)
  Puppet::Network::HttpPool.http_instance(request.server || self.class.server, request.port || self.class.port)
end

#save(request) ⇒ Object

Raises:

  • (ArgumentError) 


156
157
158
159
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 156

def save(request)
  raise ArgumentError, "PUT does not accept options" unless request.options.empty?
  deserialize http_put(request, indirection2uri(request), request.instance.render, headers.merge({ "Content-Type" => request.instance.mime }))
end

#search(request) ⇒ Object 



144
145
146
147
148
149
 
# File 'lib/vendor/puppet/indirector/rest.rb', line 144

def search(request)
  unless result = deserialize(http_get(request, indirection2uri(request), headers), true)
    return []
  end
  result
end