File Coverage

blib/lib/Net/Gnats/Command/LIST.pm

Criterion	Covered	Total	%
statement	36	37	97.3
branch	6	10	60.0
condition			n/a
subroutine	9	9	100.0
pod	2	4	50.0
total	53	60	88.3

package Net::Gnats::Command::LIST;
use parent 'Net::Gnats::Command';
use strictures;
BEGIN {
  $Net::Gnats::Command::LIST::VERSION = '0.20';
}
use vars qw($VERSION);

use Net::Gnats::Constants qw(CODE_TEXT_READY CODE_INVALID_LIST);

=head1 NAME

Net::Gnats::Command::LIST

=head1 DESCRIPTION


Describes various aspects of the database. The lists are returned as
a list of records, one per line. Each line may contain a number of
colon-separated fields.

Possible values for list type include

Categories  : Describes the legal categories for the database.

Submitters  : Describes the set of submitters for the database.

Responsible : Lists the names in the responsible administrative
file, including their full names and email addresses.

States

Lists the states listed in the state administrative file, including
the state type (usually blank for most states; the closed state has
a special type).

FieldNames Lists the entire set of PR fields.

InitialInputFields : Lists the fields that should be present when a
PR is initially entered.

InitialRequiredFields : Lists fields that have to be present and
nonempty when a PR is initially entered (fields containing only
blank characters such as spaces or newlines are considered empty.)

Databases : Lists the set of databases.

=head1 PROTOCOL

 LIST [list type]

=head1 RESPONSES

The possible responses are:

301 (CODE_TEXT_READY) Normal response, followed by the records
making up the list as described above.

416 (CODE_INVALID_LIST) The requested list does not exist.

=cut

my $c = 'LIST';

my $s = { databases   => ['name', 'desc', 'path'],
          categories  => ['name', 'desc', 'contact', 'notify'],
          submitters  => ['name', 'desc', 'contract', 'response',
                         'contact', 'othernotify'],
          responsible => ['name', 'realname', 'email'],
          states      => ['name', 'type', 'desc'],
        };

sub new {
  my ( $class, %options ) = @_;
  my $self = bless \%options, $class;
  return $self;
}

sub as_string {
  my $self = shift;
  return undef if not defined $self->{subcommand};
  return $c . ' ' . $self->{subcommand};
}

sub is_ok {
  my $self = shift;
  return 0 if not defined $self->response;
  return 1 if $self->response->code == CODE_TEXT_READY;
  return 0;
}

sub formatted {
  my $self = shift;
  return [] if not defined $self->response;
  return [] if $self->response->code != CODE_TEXT_READY;

  my $keynames = $s->{lc $self->{subcommand}};

  my $result = [];
  foreach my $row (@{ $self->response->as_list }) {
    my @parts = split ':', $row;
    push @{ $result}, { map { @{ $keynames }[$_] =>
                                $parts[$_] } 0..( scalar @{$keynames} - 1) };
  }
  return $result;
}

1;