File Coverage

blib/lib/Chef/REST/Client/environments.pm

Criterion	Covered	Total	%
statement	9	22	40.9
branch	0	4	0.0
condition	0	3	0.0
subroutine	3	5	60.0
pod	2	2	100.0
total	14	36	38.8

#--------------------------------------------------------------------#
# @class  : Chef::Rest::Client::environments                         #
# @author : Bhavin Patel                                             #
#--------------------------------------------------------------------#

package Chef::REST::Client::environments;
use parent qw { Chef::REST::Client::EndPoints };

use Chef::REST::Client::environment;
use Chef::REST::Client::attributes;

$Chef::REST::Client::environments::VERSION = 1.0;

# this module will be passed tha json parsed hash
# under ___data__() or variable.
# process it depending on the content expected.

sub list
{
    my $self = shift;
    my $list_of_environments = $self->___data___;
	 return undef if $self->___data___->{'chef_type'} eq 'environment';

    foreach my $e ( keys(%$list_of_environments) ){
      my $environment = new Chef::REST::Client::environment
      				(
      					'name' => $e,
                     'url'  => $list_of_environments->{$e},
                  );

      push @{'___environments_list___'} , $environment;
    }
    return @{'___environments_list___'};
}

sub details
{
  my $self = shift;
  my $data = $self->___data___;

  return $self->raw() unless ref $data eq 'HASH' && $data->{'name'};
  return new Chef::REST::Client::environment (
  					'name'                => $data->{'name'       },
  					'description'         => $data->{'description'},
  					'default_attributes'  => new Chef::REST::Client::attributes( $data->{'default_attributes' } ),
  					'override_attributes' => new Chef::REST::Client::attributes( $data->{'override_attributes'} ),
					'cookbook_versions'   => $data->{'cookbook_versions'}
         );
}

1;

=pod

=head1 NAME

Chef::REST::Client::environments

=head1 VERSION

1.0

=head1 SYNOPSIS

use Chef::REST::Client::environments;

$obj->environments->list;
$obj->environments('dev')->details;

=head1 DESCRIPTION

Class that represents collection of environments

=head1 METHODS

=head2 list

return list of environments, array of L objects.

=head2 details ( $details )

retun detail about a perticular environment.

=head1 KNOWN BUGS

=head1 SUPPORT

open a github ticket or email comments to Bhavin Patel

=head1 COPYRIGHT AND LICENSE

This Software is free to use , licensed under : The Artisic License 2.0 (GPL Compatible)

=cut