Class: Chef::DataBag
- Inherits:
-
Object
- Object
- Chef::DataBag
- Includes:
- Mixin::FromFile, Mixin::ParamsValidate
- Defined in:
- lib/chef/data_bag.rb
Constant Summary collapse
- VALID_NAME =
/^[\.\-[:alnum:]_]+$/
Instance Attribute Summary collapse
-
#chef_server_rest ⇒ Object
Returns the value of attribute chef_server_rest.
Class Method Summary collapse
- .chef_server_rest ⇒ Object
- .from_hash(o) ⇒ Object
-
.json_create(o) ⇒ Object
Create a Chef::Role from JSON.
- .list(inflate = false) ⇒ Object
-
.load(name) ⇒ Object
Load a Data Bag by name via either the RESTful API or local data_bag_path if run in solo mode.
- .validate_name!(name) ⇒ Object
Instance Method Summary collapse
-
#create ⇒ Object
create a data bag via RESTful API.
- #destroy ⇒ Object
-
#initialize(chef_server_rest: nil) ⇒ DataBag
constructor
Create a new Chef::DataBag.
- #name(arg = nil) ⇒ Object
-
#save ⇒ Object
Save the Data Bag via RESTful API.
- #to_hash ⇒ Object
-
#to_json(*a) ⇒ Object
Serialize this object as a hash.
-
#to_s ⇒ Object
As a string.
Methods included from Mixin::ParamsValidate
#lazy, #set_or_return, #validate
Methods included from Mixin::FromFile
Constructor Details
#initialize(chef_server_rest: nil) ⇒ DataBag
Create a new Chef::DataBag
46 47 48 49 |
# File 'lib/chef/data_bag.rb', line 46 def initialize(chef_server_rest: nil) @name = "" @chef_server_rest = chef_server_rest end |
Instance Attribute Details
#chef_server_rest ⇒ Object
Returns the value of attribute chef_server_rest.
37 38 39 |
# File 'lib/chef/data_bag.rb', line 37 def chef_server_rest @chef_server_rest end |
Class Method Details
.chef_server_rest ⇒ Object
77 78 79 |
# File 'lib/chef/data_bag.rb', line 77 def self.chef_server_rest Chef::ServerAPI.new(Chef::Config[:chef_server_url]) end |
.from_hash(o) ⇒ Object
87 88 89 90 91 |
# File 'lib/chef/data_bag.rb', line 87 def self.from_hash(o) bag = new bag.name(o["name"]) bag end |
.json_create(o) ⇒ Object
Create a Chef::Role from JSON
82 83 84 85 |
# File 'lib/chef/data_bag.rb', line 82 def self.json_create(o) Chef.log_deprecation("Auto inflation of JSON data is deprecated. Please use Chef::DataBag#from_hash") from_hash(o) end |
.list(inflate = false) ⇒ Object
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/chef/data_bag.rb', line 93 def self.list(inflate = false) if Chef::Config[:solo_legacy_mode] paths = Array(Chef::Config[:data_bag_path]) names = [] paths.each do |path| unless File.directory?(path) raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{path}' is invalid" end names += Dir.glob(File.join( Chef::Util::PathHelper.escape_glob_dir(path), "*")).map { |f| File.basename(f) }.sort end names.inject({}) { |h, n| h[n] = n; h } else if inflate # Can't search for all data bags like other objects, fall back to N+1 :( list(false).inject({}) do |response, bag_and_uri| response[bag_and_uri.first] = load(bag_and_uri.first) response end else Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("data") end end end |
.load(name) ⇒ Object
Load a Data Bag by name via either the RESTful API or local data_bag_path if run in solo mode
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/chef/data_bag.rb', line 120 def self.load(name) if Chef::Config[:solo_legacy_mode] paths = Array(Chef::Config[:data_bag_path]) data_bag = {} paths.each do |path| unless File.directory?(path) raise Chef::Exceptions::InvalidDataBagPath, "Data bag path '#{path}' is invalid" end Dir.glob(File.join(Chef::Util::PathHelper.escape_glob_dir(path, name.to_s), "*.json")).inject({}) do |bag, f| item = Chef::JSONCompat.parse(IO.read(f)) # Check if we have multiple items with similar names (ids) and raise if their content differs if data_bag.has_key?(item["id"]) && data_bag[item["id"]] != item raise Chef::Exceptions::DuplicateDataBagItem, "Data bag '#{name}' has items with the same name '#{item["id"]}' but different content." else data_bag[item["id"]] = item end end end return data_bag else Chef::ServerAPI.new(Chef::Config[:chef_server_url]).get("data/#{name}") end end |
.validate_name!(name) ⇒ Object
39 40 41 42 43 |
# File 'lib/chef/data_bag.rb', line 39 def self.validate_name!(name) unless name =~ VALID_NAME raise Exceptions::InvalidDataBagName, "DataBags must have a name matching #{VALID_NAME.inspect}, you gave #{name.inspect}" end end |
Instance Method Details
#create ⇒ Object
create a data bag via RESTful API
165 166 167 168 |
# File 'lib/chef/data_bag.rb', line 165 def create chef_server_rest.post("data", self) self end |
#destroy ⇒ Object
146 147 148 |
# File 'lib/chef/data_bag.rb', line 146 def destroy chef_server_rest.delete("data/#{@name}") end |
#name(arg = nil) ⇒ Object
51 52 53 54 55 56 57 |
# File 'lib/chef/data_bag.rb', line 51 def name(arg = nil) set_or_return( :name, arg, :regex => VALID_NAME ) end |
#save ⇒ Object
Save the Data Bag via RESTful API
151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/chef/data_bag.rb', line 151 def save begin if Chef::Config[:why_run] Chef::Log.warn("In why-run mode, so NOT performing data bag save.") else create end rescue Net::HTTPServerException => e raise e unless e.response.code == "409" end self end |
#to_hash ⇒ Object
59 60 61 62 63 64 65 66 |
# File 'lib/chef/data_bag.rb', line 59 def to_hash result = { "name" => @name, "json_class" => self.class.name, "chef_type" => "data_bag", } result end |
#to_json(*a) ⇒ Object
Serialize this object as a hash
69 70 71 |
# File 'lib/chef/data_bag.rb', line 69 def to_json(*a) Chef::JSONCompat.to_json(to_hash, *a) end |
#to_s ⇒ Object
As a string
171 172 173 |
# File 'lib/chef/data_bag.rb', line 171 def to_s "data_bag[#{@name}]" end |