Class: Chef::ChefFS::FileSystem::ChefServer::RestListEntry

Inherits:
BaseFSObject
  • Object
show all
Defined in:
lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb

Instance Attribute Summary

Attributes inherited from BaseFSObject

#name, #parent, #path

Instance Method Summary collapse

Methods inherited from BaseFSObject

#can_have_child?, #child, #children, #create_child, #dir?, #root

Constructor Details

#initialize(name, parent, exists = nil) ⇒ RestListEntry

Returns a new instance of RestListEntry.



30
31
32
33
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 30

def initialize(name, parent, exists = nil)
  super(name, parent)
  @exists = exists
end

Instance Method Details

#_read_jsonObject



98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 98

def _read_json
  begin
    # Minimize the value (get rid of defaults) so the results don't look terrible
    root.get_json(api_path)
  rescue Timeout::Error => e
    raise Chef::ChefFS::FileSystem::OperationFailedError.new(:read, self, e, "Timeout reading: #{e}")
  rescue Net::HTTPServerException => e
    if $!.response.code == "404"
      raise Chef::ChefFS::FileSystem::NotFoundError.new(self, e)
    else
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:read, self, e, "HTTP error reading: #{e}")
    end
  end
end

#api_child_nameObject



39
40
41
42
43
44
45
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 39

def api_child_name
  if %w{ .rb .json }.include? File.extname(name)
    File.basename(name, ".*")
  else
    name
  end
end

#api_error_text(response) ⇒ Object



185
186
187
188
189
190
191
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 185

def api_error_text(response)
  begin
    Chef::JSONCompat.parse(response.body)["error"].join("\n")
  rescue
    response.body
  end
end

#api_pathObject



47
48
49
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 47

def api_path
  "#{parent.api_path}/#{api_child_name}"
end

#chef_objectObject



113
114
115
116
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 113

def chef_object
  # REST will inflate the Chef object using json_class
  data_handler.json_class.from_hash(read)
end

#compare_to(other) ⇒ Object



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 122

def compare_to(other)
  # TODO this pair of reads can be parallelized

  # Grab the other value
  begin
    other_value_json = other.read
  rescue Chef::ChefFS::FileSystem::NotFoundError
    return [ nil, nil, :none ]
  end

  # Grab this value
  begin
    value = _read_json
  rescue Chef::ChefFS::FileSystem::NotFoundError
    return [ false, :none, other_value_json ]
  end

  # Minimize (and normalize) both values for easy and beautiful diffs
  value = minimize_value(value)
  value_json = Chef::JSONCompat.to_json_pretty(value)
  begin
    other_value = Chef::JSONCompat.parse(other_value_json)
  rescue Chef::Exceptions::JSON::ParseError => e
    Chef::Log.warn("Parse error reading #{other.path_for_printing} as JSON: #{e}")
    return [ nil, value_json, other_value_json ]
  end
  other_value = minimize_value(other_value)
  other_value_json = Chef::JSONCompat.to_json_pretty(other_value)

  [ value == other_value, value_json, other_value_json ]
end

#data_handlerObject



35
36
37
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 35

def data_handler
  parent.data_handler
end

#delete(recurse) ⇒ Object



80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 80

def delete(recurse)
  begin
    rest.delete(api_path)
  rescue Timeout::Error => e
    raise Chef::ChefFS::FileSystem::OperationFailedError.new(:delete, self, e, "Timeout deleting: #{e}")
  rescue Net::HTTPServerException => e
    if e.response.code == "404"
      raise Chef::ChefFS::FileSystem::NotFoundError.new(self, e)
    else
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:delete, self, e, "Timeout deleting: #{e}")
    end
  end
end

#display_nameObject



57
58
59
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 57

def display_name
  File.basename(display_path)
end

#display_pathObject Also known as: path_for_printing



51
52
53
54
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 51

def display_path
  pth = api_path.start_with?("/") ? api_path : "/#{api_path}"
  File.extname(pth).empty? ? pth + ".json" : pth
end

#environmentObject



65
66
67
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 65

def environment
  parent.environment
end

#exists?Boolean

Returns:

  • (Boolean)


69
70
71
72
73
74
75
76
77
78
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 69

def exists?
  if @exists.nil?
    begin
      @exists = parent.children.any? { |child| child.api_child_name == api_child_name }
    rescue Chef::ChefFS::FileSystem::NotFoundError
      @exists = false
    end
  end
  @exists
end

#minimize_value(value) ⇒ Object



118
119
120
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 118

def minimize_value(value)
  data_handler.minimize(data_handler.normalize(value, self), self)
end

#orgObject



61
62
63
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 61

def org
  parent.org
end

#readObject



94
95
96
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 94

def read
  Chef::JSONCompat.to_json_pretty(minimize_value(_read_json))
end

#restObject



154
155
156
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 154

def rest
  parent.rest
end

#write(file_contents) ⇒ Object



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/chef/chef_fs/file_system/chef_server/rest_list_entry.rb', line 158

def write(file_contents)
  begin
    object = Chef::JSONCompat.parse(file_contents)
  rescue Chef::Exceptions::JSON::ParseError => e
    raise Chef::ChefFS::FileSystem::OperationFailedError.new(:write, self, e, "Parse error reading JSON: #{e}")
  end

  if data_handler
    object = data_handler.normalize_for_put(object, self)
    data_handler.verify_integrity(object, self) do |error|
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:write, self, nil, "#{error}")
    end
  end

  begin
    rest.put(api_path, object)
  rescue Timeout::Error => e
    raise Chef::ChefFS::FileSystem::OperationFailedError.new(:write, self, e, "Timeout writing: #{e}")
  rescue Net::HTTPServerException => e
    if e.response.code == "404"
      raise Chef::ChefFS::FileSystem::NotFoundError.new(self, e)
    else
      raise Chef::ChefFS::FileSystem::OperationFailedError.new(:write, self, e, "HTTP error writing: #{e}")
    end
  end
end