Class: Chef::ApiClient
- Inherits:
-
Object
- Object
- Chef::ApiClient
- Includes:
- Mixin::FromFile, Mixin::ParamsValidate
- Defined in:
- lib/chef/api_client.rb,
lib/chef/api_client/registration.rb
Defined Under Namespace
Classes: Registration
Instance Attribute Summary
Attributes included from Mixin::FromFile
Class Method Summary collapse
- .from_hash(o) ⇒ Object
- .from_json(j) ⇒ Object
- .http_api ⇒ Object
- .list(inflate = false) ⇒ Object
-
.load(name) ⇒ Object
Load a client by name via the API.
- .reregister(name) ⇒ Object
Instance Method Summary collapse
-
#admin(arg = nil) ⇒ True/False
Gets or sets whether this client is an admin.
-
#create ⇒ Object
Create the client via the REST API.
-
#destroy ⇒ Object
Remove this client via the REST API.
- #http_api ⇒ Object
-
#initialize ⇒ ApiClient
constructor
Create a new Chef::ApiClient object.
- #inspect ⇒ Object
-
#name(arg = nil) ⇒ String
Gets or sets the client name.
-
#private_key(arg = nil) ⇒ String
Gets or sets the private key.
-
#public_key(arg = nil) ⇒ String
Gets or sets the public key.
- #reregister ⇒ Object
-
#save ⇒ Object
Save this client via the REST API, returns a hash including the private key.
-
#to_h ⇒ Hash
(also: #to_hash)
The hash representation of the object.
-
#to_json(*a) ⇒ String
The JSON representation of the object.
-
#to_s ⇒ Object
As a string.
-
#validator(arg = nil) ⇒ Boolean
Gets or sets whether this client is a validator.
Methods included from Mixin::ParamsValidate
#lazy, #set_or_return, #validate
Methods included from Mixin::FromFile
Constructor Details
#initialize ⇒ ApiClient
Create a new Chef::ApiClient object.
40 41 42 43 44 45 46 |
# File 'lib/chef/api_client.rb', line 40 def initialize @name = "" @public_key = nil @private_key = nil @admin = false @validator = false end |
Class Method Details
.from_hash(o) ⇒ Object
135 136 137 138 139 140 141 142 143 |
# File 'lib/chef/api_client.rb', line 135 def self.from_hash(o) client = Chef::ApiClient.new client.name(o["name"] || o["clientname"]) client.private_key(o["private_key"]) if o.key?("private_key") client.public_key(o["public_key"]) client.admin(o["admin"]) client.validator(o["validator"]) client end |
.from_json(j) ⇒ Object
145 146 147 |
# File 'lib/chef/api_client.rb', line 145 def self.from_json(j) from_hash(Chef::JSONCompat.parse(j)) end |
.http_api ⇒ Object
149 150 151 |
# File 'lib/chef/api_client.rb', line 149 def self.http_api Chef::ServerAPI.new(Chef::Config[:chef_server_url], { api_version: "0" }) end |
.list(inflate = false) ⇒ Object
158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/chef/api_client.rb', line 158 def self.list(inflate = false) if inflate response = {} Chef::Search::Query.new.search(:client) do |n| n = json_create(n) if n.instance_of?(Hash) response[n.name] = n end response else http_api.get("clients") end end |
.load(name) ⇒ Object
Load a client by name via the API
172 173 174 175 176 177 178 179 |
# File 'lib/chef/api_client.rb', line 172 def self.load(name) response = http_api.get("clients/#{name}") if response.is_a?(Chef::ApiClient) response else from_hash(response) end end |
.reregister(name) ⇒ Object
153 154 155 156 |
# File 'lib/chef/api_client.rb', line 153 def self.reregister(name) api_client = load(name) api_client.reregister end |
Instance Method Details
#admin(arg = nil) ⇒ True/False
Gets or sets whether this client is an admin.
64 65 66 67 68 69 70 |
# File 'lib/chef/api_client.rb', line 64 def admin(arg = nil) set_or_return( :admin, arg, kind_of: [ TrueClass, FalseClass ] ) end |
#create ⇒ Object
Create the client via the REST API
209 210 211 |
# File 'lib/chef/api_client.rb', line 209 def create http_api.post("clients", self) end |
#destroy ⇒ Object
Remove this client via the REST API
182 183 184 |
# File 'lib/chef/api_client.rb', line 182 def destroy http_api.delete("clients/#{@name}") end |
#http_api ⇒ Object
223 224 225 |
# File 'lib/chef/api_client.rb', line 223 def http_api @http_api ||= Chef::ServerAPI.new(Chef::Config[:chef_server_url], { api_version: "0" }) end |
#inspect ⇒ Object
218 219 220 221 |
# File 'lib/chef/api_client.rb', line 218 def inspect "Chef::ApiClient name:'#{name}' admin:'#{admin.inspect}' validator:'#{validator}' " + "public_key:'#{public_key}' private_key:'#{private_key}'" end |
#name(arg = nil) ⇒ String
Gets or sets the client name.
52 53 54 55 56 57 58 |
# File 'lib/chef/api_client.rb', line 52 def name(arg = nil) set_or_return( :name, arg, regex: /^[\-[:alnum:]_\.]+$/ ) end |
#private_key(arg = nil) ⇒ String
Gets or sets the private key.
101 102 103 104 105 106 107 |
# File 'lib/chef/api_client.rb', line 101 def private_key(arg = nil) set_or_return( :private_key, arg, kind_of: [String, FalseClass] ) end |
#public_key(arg = nil) ⇒ String
Gets or sets the public key.
76 77 78 79 80 81 82 |
# File 'lib/chef/api_client.rb', line 76 def public_key(arg = nil) set_or_return( :public_key, arg, kind_of: String ) end |
#reregister ⇒ Object
198 199 200 201 202 203 204 205 206 |
# File 'lib/chef/api_client.rb', line 198 def reregister reregistered_self = http_api.put("clients/#{name}", name: name, admin: admin, validator: validator, private_key: true ) if reregistered_self.respond_to?(:[]) private_key(reregistered_self["private_key"]) else private_key(reregistered_self.private_key) end self end |
#save ⇒ Object
Save this client via the REST API, returns a hash including the private key
187 188 189 190 191 192 193 194 195 196 |
# File 'lib/chef/api_client.rb', line 187 def save http_api.put("clients/#{name}", { name: name, admin: admin, validator: validator }) rescue Net::HTTPClientException => e # If that fails, go ahead and try and update it if e.response.code == "404" http_api.post("clients", { name: name, admin: admin, validator: validator }) else raise e end end |
#to_h ⇒ Hash Also known as: to_hash
The hash representation of the object. Includes the name and public_key. Private key is included if available.
113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/chef/api_client.rb', line 113 def to_h result = { "name" => @name, "public_key" => @public_key, "validator" => @validator, "admin" => @admin, "json_class" => self.class.name, "chef_type" => "client", } result["private_key"] = @private_key if @private_key result end |
#to_json(*a) ⇒ String
The JSON representation of the object.
131 132 133 |
# File 'lib/chef/api_client.rb', line 131 def to_json(*a) Chef::JSONCompat.to_json(to_h, *a) end |
#to_s ⇒ Object
As a string
214 215 216 |
# File 'lib/chef/api_client.rb', line 214 def to_s "client[#{@name}]" end |
#validator(arg = nil) ⇒ Boolean
Gets or sets whether this client is a validator.
89 90 91 92 93 94 95 |
# File 'lib/chef/api_client.rb', line 89 def validator(arg = nil) set_or_return( :validator, arg, kind_of: [TrueClass, FalseClass] ) end |