File Coverage

blib/lib/Net/EPP/Frame/Command/Create/Domain.pm

Criterion	Covered	Total	%
statement	12	95	12.6
branch	0	10	0.0
condition	0	6	0.0
subroutine	4	17	23.5
pod	1	12	8.3
total	17	140	12.1

package Net::EPP::Frame::Command::Create::Domain;
use List::Util qw(any);
use base       qw(Net::EPP::Frame::Command::Create);
use Net::EPP::Frame::ObjectSpec;
use strict;

=pod

=head1 NAME

Net::EPP::Frame::Command::Create::Domain - an instance of L
for domain objects.

=head1 SYNOPSIS

	use Net::EPP::Frame::Command::Create::Domain;
	use strict;

	my $create = Net::EPP::Frame::Command::Create::Domain->new;
	$create->setDomain('example.uk.com);

	print $create->toString(1);

This results in an XML document like this:



	  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	  xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
	  epp-1.0.xsd">



	          xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
	          xsi:schemaLocation="urn:ietf:params:xml:ns:contact-1.0
	          contact-1.0.xsd">
	            example-1.tldE/domain:name>


	      0cf1b8f7e14547d26f03b7641660c641d9e79f45



=head1 OBJECT HIERARCHY

    L
    +----L
        +----L
            +----L
                +----L
                    +----L

=cut

sub new {
    my $package = shift;
    my $self    = bless($package->SUPER::new('create'), $package);

    $self->addObject(Net::EPP::Frame::ObjectSpec->spec('domain'));

    return $self;
}

=pod

=head1 METHODS

	my $element = $frame->setDomain($domain_name);

This sets the name of the object to be created. Returns the
Cdomain:nameE> element.

=cut

sub setDomain {
    my ($self, $domain) = @_;

    my $name = $self->createElement('domain:name');
    $name->appendText($domain);

    $self->getNode('create')->getChildNodes->shift->appendChild($name);

    return 1;
}

=pod

=head1

	$frame->setPeriod(1, 'y');

Set the initial registration period. The second argument is optional.

=cut

sub setPeriod {
    my ($self, $period, $unit) = @_;

    $unit = 'y' if (!defined($unit) || $unit eq '');

    my $el = $self->createElement('domain:period');
    $el->setAttribute('unit', $unit);
    $el->appendText(int($period));

    $self->getNode('create')->getChildNodes->shift->appendChild($el);

    return 1;
}

=pod

=head1

	$frame->setRegistrant($id);

Set the registrant.

=cut

sub setRegistrant {
    my ($self, $contact) = @_;

    my $registrant = $self->createElement('domain:registrant');
    $registrant->appendText($contact);

    $self->getNode('create')->getChildNodes->shift->appendChild($registrant);

    return 1;
}

=pod

=head1

	$frame->setContacts({
		'admin'   => 'H12345',
		'tech'    => 'H54321',
		'billing' => 'H23451',
	}));

Set the contacts.

=cut

sub setContacts {
    my ($self, $contacts) = @_;
    my $parent = $self->getNode('create')->getChildNodes->shift;

    foreach my $type (keys(%{$contacts})) {
        my $contact = $self->createElement('domain:contact');
        $contact->setAttribute('type', $type);
        $contact->appendText($contacts->{$type});

        $parent->appendChild($contact);
    }

    return 1;
}

#
# Type of elements of @ns depends on NS model used by EPP server.
#   hostObj model:
#       each element is a name of NS host object
#   hostAttr model:
#       each element is a hashref:
#       {
#           name => 'ns1.example.com,
#           addrs => [
#               { version => 'v4', addr => '192.168.0.10', },
#               { version => 'v4', addr => '192.168.0.20', },
#               ...
#           ];
#        }
#
sub setNS {
    my ($self, @ns) = @_;

    if (ref $ns[0] eq 'HASH') {
        $self->addHostAttrNS(@ns);
    } else {
        $self->addHostObjNS(@ns);
    }

    return 1;
}

sub addHostAttrNS {
    my ($self, @ns) = @_;

    my $ns = $self->createElement('domain:ns');

    # Adding attributes
    foreach my $host (@ns) {
        my $hostAttr = $self->createElement('domain:hostAttr');

        # Adding NS name
        my $hostName = $self->createElement('domain:hostName');
        $hostName->appendText($host->{name});
        $hostAttr->appendChild($hostName);

        # Adding IP addresses
        if (exists $host->{addrs} && ref $host->{addrs} eq 'ARRAY') {
            foreach my $addr (@{$host->{addrs}}) {
                my $hostAddr = $self->createElement('domain:hostAddr');
                $hostAddr->appendText($addr->{addr});
                $hostAddr->setAttribute(ip => $addr->{version});
                $hostAttr->appendChild($hostAddr);
            }
        }

        # Adding host info to frame
        $ns->appendChild($hostAttr);
    }
    $self->getNode('create')->getChildNodes->shift->appendChild($ns);
    return 1;
}

sub addHostObjNS {
    my ($self, @ns) = @_;

    my $ns = $self->createElement('domain:ns');
    foreach my $host (@ns) {
        my $el = $self->createElement('domain:hostObj');
        $el->appendText($host);
        $ns->appendChild($el);
    }
    $self->getNode('create')->getChildNodes->shift->appendChild($ns);
    return 1;
}

sub setAuthInfo {
    my ($self, $authInfo) = @_;
    my $el = $self->addEl('authInfo');
    my $pw = $self->createElement('domain:pw');
    $pw->appendText($authInfo);
    $el->appendChild($pw);
    return $el;
}

sub appendStatus {
    my ($self, $status) = @_;
    return $self->addEl('status', $status);
}

sub addEl {
    my ($self, $name, $value) = @_;

    my $el = $self->createElement('domain:' . $name);
    $el->appendText($value) if defined($value);

    $self->getNode('create')->getChildNodes->shift->appendChild($el);

    return $el;

}

=pod

=head2 TTL Extension

    $frame->setTTLs({
        NS => 3600,
        DS => 900,
    });

Specify TTLs for DNS records above the zone cut. The server must support the
TTL extension.

=cut

sub setTTLs {
    my ($self, $ttls) = @_;

    foreach my $type (keys(%{$ttls})) {
        my $ttl = $self->createExtensionElementFor(Net::EPP::Frame::ObjectSpec->xmlns('ttl'))->appendChild($self->createElement('ttl'));
        $ttl->appendText($ttls->{$type});
        if (any { $type eq $_ } qw(NS DS DNAME A AAAA)) {
            $ttl->setAttribute('for', $type);

        } else {
            $ttl->setAttribute('for',    'custom');
            $ttl->setAttribute('custom', $type);

        }
    }
}

1;