Module: HammerCLIForeman

Defined in:
lib/hammer_cli_foreman.rb,
lib/hammer_cli_foreman/api.rb,
lib/hammer_cli_foreman/auth.rb,
lib/hammer_cli_foreman/fact.rb,
lib/hammer_cli_foreman/host.rb,
lib/hammer_cli_foreman/i18n.rb,
lib/hammer_cli_foreman/role.rb,
lib/hammer_cli_foreman/user.rb,
lib/hammer_cli_foreman/image.rb,
lib/hammer_cli_foreman/media.rb,
lib/hammer_cli_foreman/model.rb,
lib/hammer_cli_foreman/realm.rb,
lib/hammer_cli_foreman/domain.rb,
lib/hammer_cli_foreman/filter.rb,
lib/hammer_cli_foreman/report.rb,
lib/hammer_cli_foreman/subnet.rb,
lib/hammer_cli_foreman/version.rb,
lib/hammer_cli_foreman/commands.rb,
lib/hammer_cli_foreman/defaults.rb,
lib/hammer_cli_foreman/location.rb,
lib/hammer_cli_foreman/settings.rb,
lib/hammer_cli_foreman/ssh_keys.rb,
lib/hammer_cli_foreman/template.rb,
lib/hammer_cli_foreman/hostgroup.rb,
lib/hammer_cli_foreman/interface.rb,
lib/hammer_cli_foreman/parameter.rb,
lib/hammer_cli_foreman/usergroup.rb,
lib/hammer_cli_foreman/exceptions.rb,
lib/hammer_cli_foreman/references.rb,
lib/hammer_cli_foreman/auth_source.rb,
lib/hammer_cli_foreman/environment.rb,
lib/hammer_cli_foreman/id_resolver.rb,
lib/hammer_cli_foreman/smart_proxy.rb,
lib/hammer_cli_foreman/architecture.rb,
lib/hammer_cli_foreman/config_group.rb,
lib/hammer_cli_foreman/organization.rb,
lib/hammer_cli_foreman/puppet_class.rb,
lib/hammer_cli_foreman/api/void_auth.rb,
lib/hammer_cli_foreman/param_filters.rb,
lib/hammer_cli_foreman/api/connection.rb,
lib/hammer_cli_foreman/smart_variable.rb,
lib/hammer_cli_foreman/option_builders.rb,
lib/hammer_cli_foreman/partition_table.rb,
lib/hammer_cli_foreman/auth_source_ldap.rb,
lib/hammer_cli_foreman/common_parameter.rb,
lib/hammer_cli_foreman/compute_resource.rb,
lib/hammer_cli_foreman/operating_system.rb,
lib/hammer_cli_foreman/exception_handler.rb,
lib/hammer_cli_foreman/external_usergroup.rb,
lib/hammer_cli_foreman/dependency_resolver.rb,
lib/hammer_cli_foreman/associating_commands.rb,
lib/hammer_cli_foreman/compute_resources/ec2.rb,
lib/hammer_cli_foreman/compute_resources/gce.rb,
lib/hammer_cli_foreman/smart_class_parameter.rb,
lib/hammer_cli_foreman/compute_resources/ovirt.rb,
lib/hammer_cli_foreman/resource_supported_test.rb,
lib/hammer_cli_foreman/compute_resources/vmware.rb,
lib/hammer_cli_foreman/hosts/common_update_help.rb,
lib/hammer_cli_foreman/option_sources/id_params.rb,
lib/hammer_cli_foreman/testing/api_expectations.rb,
lib/hammer_cli_foreman/compute_resources/libvirt.rb,
lib/hammer_cli_foreman/option_sources/ids_params.rb,
lib/hammer_cli_foreman/option_sources/self_param.rb,
lib/hammer_cli_foreman/api/interactive_basic_auth.rb,
lib/hammer_cli_foreman/option_sources/user_params.rb,
lib/hammer_cli_foreman/compute_resources/openstack.rb,
lib/hammer_cli_foreman/compute_resources/rackspace.rb,
lib/hammer_cli_foreman/hosts/common_update_options.rb,
lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb,
lib/hammer_cli_foreman/compute_resources/ec2/host_help_extenstion.rb,
lib/hammer_cli_foreman/compute_resources/gce/host_help_extenstion.rb,
lib/hammer_cli_foreman/compute_resources/ovirt/host_help_extenstion.rb,
lib/hammer_cli_foreman/compute_resources/vmware/host_help_extenstion.rb,
lib/hammer_cli_foreman/compute_resources/libvirt/host_help_extenstion.rb,
lib/hammer_cli_foreman/compute_resources/openstack/host_help_extenstion.rb,
lib/hammer_cli_foreman/compute_resources/rackspace/host_help_extenstion.rb

Defined Under Namespace

Modules: Api, AssociatingCommands, ComputeResources, DomainUpdateCreateCommons, HostgroupUpdateCreateCommons, Hosts, I18n, OptionSources, Output, Parameter, References, ResourceSupportedTest, SmartVariableUpdateCreateCommons, Testing Classes: AbstractParamsFilter, AddAssociatedCommand, Architecture, AssociatedCommand, AssociatedResourceListCommand, Auth, AuthSource, AuthSourceLdap, BuildParams, BuilderConfigurator, Command, CommonParameter, ComputeResource, ConfigGroup, CreateCommand, Defaults, DeleteCommand, DependencyResolver, DependentSearchablesArrayOptionBuilder, DependentSearchablesOptionBuilder, Domain, Environment, ExceptionHandler, ExternalUsergroup, Fact, Filter, ForemanOptionBuilder, Host, Hostgroup, IdArrayParamsFilter, IdOptionBuilder, IdParamsFilter, IdResolver, Image, InfoCommand, Interface, ListCommand, Location, Medium, MissingSearchOptions, Model, OperatingSystem, OperationNotSupportedError, Organization, ParamsFlattener, ParamsNameFilter, PartitionTable, PuppetClass, Realm, RemoveAssociatedCommand, Report, ResolverError, Role, SSHKeys, Searchable, Searchables, SearchablesAbstractOptionBuilder, SearchablesOptionBuilder, SearchablesUpdateOptionBuilder, Settings, SingleResourceCommand, SmartClassParameter, SmartClassParametersBriefList, SmartClassParametersList, SmartProxy, SmartVariable, SmartVariablesBriefList, SmartVariablesList, Subnet, Template, UpdateCommand, User, Usergroup

Constant Summary collapse

RESOURCE_NAME_MAPPING = 
{
  :usergroup => :user_group,
  :usergroups => :user_groups,
  :ptable => :partition_table,
  :ptables => :partition_tables,
  :puppetclass => :puppet_class,
  :puppetclasses => :puppet_classes
}
CONNECTION_NAME = 
'foreman'

Class Method Summary collapse

Class Method Details

.collection_to_common_format(data) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/hammer_cli_foreman/commands.rb', line 39

def self.collection_to_common_format(data)
  if data.class <= Hash && data.has_key?('total') && data.has_key?('results')
    col = HammerCLI::Output::RecordCollection.new(data['results'],
      :total => data['total'],
      :subtotal => data['subtotal'],
      :page => data['page'],
      :per_page => data['per_page'],
      :search => data['search'],
      :sort_by => data['sort']['by'],
      :sort_order => data['sort']['order'])
  elsif data.class <= Hash
    col = HammerCLI::Output::RecordCollection.new(data)
  elsif data.class <= Array
    # remove object types. From [ { 'type' => { 'attr' => val } }, ... ]
    # produce [ { 'attr' => 'val' }, ... ]
    col = HammerCLI::Output::RecordCollection.new(data.map { |r| r.keys.length == 1 ? r[r.keys[0]] : r })
  else
    raise RuntimeError.new(_("Received data of unknown format."))
  end
  col
end

.exception_handler_class ⇒ Object 



7
8
9
 
# File 'lib/hammer_cli_foreman.rb', line 7

def self.exception_handler_class
  HammerCLIForeman::ExceptionHandler
end

.foreman_api ⇒ Object 



14
15
16
 
# File 'lib/hammer_cli_foreman/commands.rb', line 14

def self.foreman_api
  foreman_api_connection
end

.foreman_api_connection ⇒ Object 



88
89
90
91
92
 
# File 'lib/hammer_cli_foreman/api/connection.rb', line 88

def self.foreman_api_connection
  HammerCLI.context[:api_connection].create(CONNECTION_NAME) do
    HammerCLIForeman::Api::Connection.new(HammerCLI::Settings, Logging.logger['API'], HammerCLI::I18n.locale)
  end
end

.foreman_resource(resource_name, options = {}) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/hammer_cli_foreman/commands.rb', line 27

def self.foreman_resource(resource_name, options={})
  begin
    foreman_resource!(resource_name, options)
  rescue NameError
    nil
  end
end

.foreman_resource!(resource_name, options = {}) ⇒ Object 



18
19
20
21
22
23
24
25
 
# File 'lib/hammer_cli_foreman/commands.rb', line 18

def self.foreman_resource!(resource_name, options={})
  if options[:singular]
    resource_name = ApipieBindings::Inflector.pluralize(resource_name.to_s).to_sym
  else
    resource_name = resource_name.to_sym
  end
  foreman_api.resource(resource_name)
end

.init_api_connection ⇒ Object 



94
95
96
 
# File 'lib/hammer_cli_foreman/api/connection.rb', line 94

def self.init_api_connection
  foreman_api_connection
end

.param_to_resource(param_name) ⇒ Object 



35
36
37
 
# File 'lib/hammer_cli_foreman/commands.rb', line 35

def self.param_to_resource(param_name)
  HammerCLIForeman.foreman_resource(param_name.gsub(/_id[s]?$/, ""), :singular => true)
end

.record_to_common_format(data) ⇒ Object 



61
62
63
 
# File 'lib/hammer_cli_foreman/commands.rb', line 61

def self.record_to_common_format(data)
    data.class <= Hash && data.keys.length == 1 ? data[data.keys[0]] : data
end

.version ⇒ Object 



2
3
4
 
# File 'lib/hammer_cli_foreman/version.rb', line 2

def self.version
  @version ||= Gem::Version.new '0.12.1'
end