lib/runcible/extensions/consumer.rb in runcible-0.2.1 vs lib/runcible/extensions/consumer.rb in runcible-0.3
- old
+ new
@@ -24,35 +24,66 @@
module Runcible
module Extensions
class Consumer < Runcible::Resources::Consumer
+ # Bind a consumer to all repositories with a given ID
+ #
+ # @param [String] id the consumer ID
+ # @param [String] repo_id the repo ID to bind to
+ # @return [RestClient::Response] set of tasks representing each bind operation
def self.bind_all(id, repo_id)
- # bind the consumer to all repositories with the given repo_id
Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].collect do |d|
self.bind(id, repo_id, d['id'])
end.flatten
end
+ # Unbind a consumer to all repositories with a given ID
+ #
+ # @param [String] id the consumer ID
+ # @param [String] repo_id the repo ID to unbind from
+ # @return [RestClient::Response] set of tasks representing each unbind operation
def self.unbind_all(id, repo_id)
- # unbind the consumer from all repositories with the given repo_id
Runcible::Extensions::Repository.retrieve_with_details(repo_id)['distributors'].collect do |d|
self.unbind(id, repo_id, d['id'])
end.flatten
end
+ # Install content to a consumer
+ #
+ # @param [String] id the consumer ID
+ # @param [String] type_id the type of content to install (e.g. rpm, errata)
+ # @param [Array] units array of units to install
+ # @return [RestClient::Response] task representing the install operation
def self.install_content(id, type_id, units)
self.install_units(id, generate_content(type_id, units))
end
+ # Update content on a consumer
+ #
+ # @param [String] id the consumer ID
+ # @param [String] type_id the type of content to update (e.g. rpm, errata)
+ # @param [Array] units array of units to update
+ # @return [RestClient::Response] task representing the update operation
def self.update_content(id, type_id, units)
self.update_units(id, generate_content(type_id, units))
end
+ # Uninstall content from a consumer
+ #
+ # @param [String] id the consumer ID
+ # @param [String] type_id the type of content to uninstall (e.g. rpm, errata)
+ # @param [Array] units array of units to uninstall
+ # @return [RestClient::Response] task representing the uninstall operation
def self.uninstall_content(id, type_id, units)
self.uninstall_units(id, generate_content(type_id, units))
end
+ # Generate the content units used by other functions
+ #
+ # @param [String] type_id the type of content (e.g. rpm, errata)
+ # @param [Array] units array of units
+ # @return [Array] array of formatted content units
def self.generate_content(type_id, units)
content = []
units.each do |unit|
content_unit = {}
content_unit[:type_id] = type_id