File Coverage

blib/lib/Net/Whois/ARIN/Network.pm

Criterion	Covered	Total	%
statement	19	49	38.7
branch	5	8	62.5
condition	1	3	33.3
subroutine	5	6	83.3
pod	3	3	100.0
total	33	69	47.8

package Net::Whois::ARIN::Network;

=head1 NAME

Net::Whois::ARIN::Network - ARIN whois Network record class

=head1 SYNOPSIS

  use Net::Whois::ARIN::Network;

  my $net = Net::Whois::ARIN::Network->new(
               OrgName    => 'Electric Lightwave Inc',
               OrgID      => 'ELIX',
               Address    => '4400 NE 77th Ave',
               City       => 'Vancouver',
               StateProv  => 'WA',
               PostalCode => '98662',
               Country    => 'US',
               RegDate    => '1995-07-25',
               Updated    => '2001-05-17',
               NetRange   => '207.173.0.0 - 207.173.255.255',
               CIDR       => '207.173.0.0/16',
               NetName    => 'ELI-NETBLK5',
               NetHandle  => 'NET-207-173-0-0-1',
               Parent     => 'NET-207-0-0-0-0',
               NetType    => 'Direct Allocation',
               NameServer => 'NS.ELI.NET',
               Comment    => 'ADDRESSES WITHIN THIS BLOCK ARE NON-PORTABLE',
           );

  printf "%s was given a %s of %s by ARIN.\n",
         $net->OrgName,
         lc $net->NetType,
         $net->CIDR;

=head1 DESCRIPTION

The Net::Whois::ARIN::Network module is simple class which is used to store the attributes of an Network record in ARIN's Whois server.  Each attribute of the Network record has an accessor/mutator of the same name.

=cut

use strict;
use Carp "croak";

our $AUTOLOAD;

=head1 METHODS

=over 4

=item B - create a Net::Whois::ARIN::Network object

=cut

sub new {
    my $class = shift;
    return bless { _contacts => [], @_ }, $class;
}

=item B - get/set Net::Whois::ARIN::Contact records

This method accepts a list of Net::Whois::ARIN::Contact instances and associates these objects with the Network record.  If no arguments are specified, the method returns a list of Net::Whois::ARIN::Contact objects.

=back

=cut

sub contacts {
    my $self = shift;
    $self->{_contacts} = [ @_ ] if @_;
    return @{ $self->{_contacts} };
}

=over 4

=item B - return the current whois record

  print $o->dump;

=back

=cut

sub dump {
    my $self = shift;
    my $record = sprintf "\nOrgName:    %s\n", $self->OrgName;
    $record .= sprintf "OrgID:      %s\n",$self->OrgID;
    $record .= sprintf("Address:    %s\n", $_) for @{ $self->Address };
    $record .= sprintf "City:       %s\n",$self->City;
    $record .= sprintf "StateProv:  %s\n",$self->StateProv;
    $record .= sprintf "PostalCode: %s\n",$self->PostalCode;
    $record .= sprintf "Country:    %s\n",$self->Country;
    $record .= sprintf "RegDate:    %s\n",$self->RegDate;
    $record .= sprintf "Updated:    %s\n\n",$self->Updated;

    $record .= sprintf "NetRange:   %s\n",$self->NetRange;
    $record .= sprintf "CIDR:       %s\n",$self->CIDR;
    $record .= sprintf "NetName:    %s\n",$self->NetName;
    $record .= sprintf "NetHandle:  %s\n",$self->NetHandle;
    $record .= sprintf "Parent:     %s\n",$self->Parent;
    $record .= sprintf "NetType:    %s\n",$self->NetType;
    $record .= sprintf("NameServer: %s\n", $_) for @{ $self->NameServer };
    $record .= sprintf "Comment:    %s\n",$self->Comment;
    $record .= sprintf "RegDate:    %s\n",$self->RegDate;
    $record .= sprintf "Updated:    %s\n",$self->Updated;

    foreach my $contact ( $self->contacts ) {
        $record .= sprintf "%sHandle: %s\n", $contact->Type, $contact->Handle;
        $record .= sprintf "%sName: %s\n", $contact->Type, $contact->Name;
        $record .= sprintf "%sPhone: %s\n", $contact->Type, $contact->Phone;
        $record .= sprintf "%sEmail: %s\n", $contact->Type, $contact->Email;
    }

    return $record;
}

=head1 ATTRIBUTES

These methods are the accessors/mutators for the fields found in the Whois record.

=over 4

=item B - get/set the organization name

=item B - get/set the organization id

=item B - get/set the address

=item B - get/set the city

=item B - get/set the state or province

=item B - get/set the postal code

=item B - get/set the country

=item B - get/set the registration date

=item B - get/set the last updated date

=item B - get/set the network range

=item B - get/set the CIDR netblock

=item B - get/set the network name

=item B - get/set the network handle

=item B - get/set the parent network handle

=item B - get/set the network type

=item B - get/set the name servers

=item B - get/set the public comment

=back

=cut

sub AUTOLOAD {
    my $self = shift;
    my $name = $AUTOLOAD;
    $name =~ s/.*://;

    return if $name eq 'DESTROY';

    if ($name !~ /^_/ && exists $self->{$name}) {
        if (@_) {
            return $self->{$name} = shift;
        } else {
            return $self->{$name};
        }
    }

    croak "Undefined subroutine \&$AUTOLOAD called";
}

=head1 AUTHOR

Todd Caine

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2004 Todd Caine.  All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

=cut

1;
__END__