File Coverage

blib/lib/Net/Dynect/REST/Zone.pm

Criterion	Covered	Total	%
statement	12	138	8.7
branch	0	78	0.0
condition	0	16	0.0
subroutine	4	17	23.5
pod	11	12	91.6
total	27	261	10.3

package Net::Dynect::REST::Zone;
# $Id: Zone.pm 149 2010-09-26 01:33:15Z james $
use strict;
use warnings;
use overload '""' => \&_as_string;
use Carp;
our $VERSION = do { my @r = (q$Revision: 149 $ =~ /\d+/g); sprintf "%d."."%03d" x $#r, @r };

sub new {
    my $proto = shift;
    my $self  = bless {}, ref($proto) || $proto;
    my %args  = @_;
    $self->{connection} = $args{connection} if defined $args{connection};
    $self->get( $args{zone} ) if defined $args{zone};
    return $self;
}

sub get {
    my $self    = shift;
    my $zone    = shift;
    my $request = Net::Dynect::REST::Request->new(
        operation => 'read',
        service   => "Zone/$zone"
    );
    my $response = $self->{connection}->execute($request);
    $self->last_response($response);
    if ( $response->status !~ /^success$/i ) {
        carp $response->msg->[0]->info;
        return;
    }
    $self->name($zone);
    $self->serial( $response->data->serial );
    $self->serial_style( $response->data->serial_style );
    $self->zone_type( $response->data->zone_type );
    return 1;
}

sub save {
    my $self = shift;
    my %args = @_;
    return unless defined $self->{connection};
    return unless defined $self->name;
    if ( not defined $args{rname} ) {
        print "Need an rname (admin email) for the zone.\n";
        return;
    }
    if ( defined $self->serial ) {
        print "Zone already has a serial? Aborting.\n";
        return;
    }

    my $request = Net::Dynect::REST::Request->new(
        operation => 'create',
        service   => "Zone/" . $self->name,
        params    => {
            zone  => $self->name,
            ttl   => $args{ttl} || 3600,
            rname => $args{rname}
        },
        serial_style => $args{serial_style}
          || $self->serial_style
          || 'increment',
        zone_type => $self->zone_type
    );
    my $response = $self->{connection}->execute($request);
    $self->last_response($response);
    return unless $response->status =~ /^success$/i;
    $self->serial( $response->data->serial );
    $self->serial_style( $response->data->serial_style );
    $self->zone_type( $response->data->zone_type );
    return 1;
}

sub delete {
    my $self = shift;
    return unless defined $self->{connection};
    return unless defined $self->name && $self->serial;
    my $request = Net::Dynect::REST::Request->new(
        operation => 'delete',
        service   => 'Zone/' . $self->name
    );
    my $response = $self->{connection}->execute($request);
    $self->last_response($response);
    if ( $response->status =~ /^success$/i ) {
        $self->{name}         = undef;
        $self->{serial}       = undef;
        $self->{serial_style} = undef;
        $self->{zone_type}    = undef;
        $self                 = undef;
        return 1;
    }
    else {
        print $response->msg->[0]->info;
    }
}

sub freeze {
    my $self = shift;
    return unless defined $self->{connection};
    return unless defined $self->name && $self->serial;
    my $request = Net::Dynect::REST::Request->new(
        operation => 'update',
        service   => 'Zone/' . $self->name,
        params    => { freeze => 1 }
    );
    my $response = $self->{connection}->execute($request);
    $self->last_response($response);
    if ( $response->status =~ /^success$/i ) {
        $self->serial( $response->data->serial )
          if defined $response->data->serial;
        $self->serial_style( $response->data->serial_style )
          if defined $response->data->serial_style;
        $self->zone_type( $response->data->zone_type )
          if defined $response->data->zone_type;
        return 1;
    }
}

sub thaw {
    my $self = shift;
    return unless defined $self->{connection};
    return unless defined $self->name && $self->serial;
    my $request = Net::Dynect::REST::Request->new(
        operation => 'update',
        service   => 'Zone/' . $self->name,
        params    => { thaw => 1 }
    );
    my $response = $self->{connection}->execute($request);
    $self->last_response($response);
    if ( $response->status =~ /^success$/i ) {
        $self->serial( $response->data->serial )
          if defined $response->data->serial;
        $self->serial_style( $response->data->serial_style )
          if defined $response->data->serial_style;
        return 1;
    }
}

sub publish {
    my $self = shift;
    return unless defined $self->{connection};
    return unless defined $self->name;
    my $request = Net::Dynect::REST::Request->new(
        operation => 'update',
        service   => 'Zone/' . $self->name,
        params    => { publish => 1 }
    );
    my $response = $self->{connection}->execute($request);
    $self->last_response($response);
    if ( $response->status =~ /^success$/i ) {
        return 1;
    }
}

sub name {
    my $self = shift;
    if (@_) {
        my $new = shift;
        if ( defined $self->{name} ) {
            carp
"Cannot change name from what it has been set to. Create a new instance for a new zone, and delete the old one";
            return;
        }
        elsif ( $new !~ /^\S+/ ) {
            carp "Zone names must not have spaces in them";
            return;
        }
        $self->{name} = $new;
    }
    return $self->{name};
}

sub serial {
    my $self = shift;
    if (@_) {
        my $new = shift;
        if ( $new !~ /^\d+$/ ) {
            carp "Serial should only be numeric";
            return;
        }
        $self->{serial} = $new;
    }
    return $self->{serial};
}

sub serial_style {
    my $self = shift;
    if (@_) {
        my $new = shift;
        if ( $new !~ /^increment|epoch|day|minute$/i ) {
            carp
              "Serial style can only be one of: increment, epoch, day, minute";
            return;
        }
        $self->{serial_style} = lc $new;
    }
    return $self->{serial_style};
}

sub zone_type {
    my $self = shift;
    if (@_) {
        my $new = shift;
        if ( $new !~ /^Primary|Secondary$/ ) {
            carp "Zone type can only be one of: Primary, Secondary";
            return;
        }
        $self->{zone_type} = $new;
    }
    return $self->{zone_type};
}

sub last_response {
    my $self = shift;
    if (@_) {
        my $new = shift;
        $self->{last_response} = $new;
    }
    return $self->{last_response};
}

sub _as_string {
    my $self = shift;
    my @texts;
    push @texts, sprintf "Zone '%s'", $self->name if defined $self->name;
    push @texts, sprintf "Zone Type '%s'", $self->zone_type
      if defined $self->zone_type;
    push @texts, sprintf "Serial '%s'", $self->serial if defined $self->serial;
    push @texts, sprintf "Serial Style '%s'", $self->serial_style
      if defined $self->serial_style;
    return join( ', ', @texts );
}

1;

=head1 NAME

Net::Dynect::REST::Zone - A DNS zone object

=head1 SYNOPSIS

 use Net::Dynect::REST;
 use Net::Dynect::REST::Zone;
 $dynect = Net::Dynect::REST->new(user_name => 'me', customer_name => 'myco', password => 'secret');
 $zone = Net::Dynect::REST::Zone->new(connection => $dynect, zone => 'example.com');
 print "Zone details: $zone\n";

 $zone->freeze;
 $zone->thaw;
 $zone->publish;
 $zone->delete;

 $new_zone = Net::Dynect::REST::Zone->new(connection => $dynect);
 $zone->name('new.example.com');
 $zone->serial_style('increment');
 $zone->zone_type('Primary');
 $zone->save(rname => '[e-mail]', ttl => 900);

=head1 REQUIRES

Net::Dynect::REST, Carp

=head1 EXPORTS

Nothing

=head1 Description

A Net::Dynect::REST::Zone is a representation of a DNS Zone in the Dynect REST interface. It permits the user to load zones that already exist, inspect their attributes (eg, serial number), freeze the zone from modification, thaw the zone, publish zone changes live, delete the zone, and create a new zone.

=head1 METHODS

=head2 Creation

=over 4

=item Net::Dynect::REST::Zone->new(connection => $dynect)

Creates and returns a Net::Dynect::REST::Zone object. You should pass this method your connection object, which should have a valid session established, in order to do anything useful.

=back

=head2 Operations

=over 4

=item $zone->get('zone.to.get.com');

This will attempt to get the details of the zone from Dynect.

=item $zone->save(rname => '[e-mail]', ttl => 900);

This will try to save a new zone (which has already had its name and serial style set via the L below). You must supply the "I" parameter of the email address for the resposible person, and you may supply a I value.


=item $zone->delete();

This will tryt o delete the zone that was previously loaded.

=item $zone->freeze();

This will freeze the zone from any changes.

=item $zone->thaw();

This will unfreeze the zone and permit changes.

=item $zone->publish();

This will commit changes to the zone to the live production environment.

=back

=head2 Attributes

=over 4

=item $zone->name();

This will get (or set) the zone's name, eg: example.com.

=item $zone->serial();

This will get (or set) the zones serial number.

=item $zone->zone_type();

This will get (or set) the zone type, either:

=over 4

=item * Primary

=item * Secondary

=back

=item $zone->serial_style();

This will get or set the serial style for the zone, either

=over 4

=item * increment

=item * epoch

=item * day

=item * minute

=back

=back

=head1 AUTHOR

James Bromberger, [e-mail]

=head1 SEE ALSO

L, L, L, L.

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2010 by James Bromberger

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.1 or,
at your option, any later version of Perl 5 you may have available.




=cut