File Coverage

blib/lib/Net/Duo/Admin/Phone.pm

Criterion	Covered	Total	%
statement	37	37	100.0
branch	5	6	83.3
condition	2	3	66.6
subroutine	12	12	100.0
pod	6	6	100.0
total	62	64	96.8

# Representation of a single Duo phone for the Admin API.
#
# This class wraps the Duo representation of a single Duo phone, as returned
# by (for example) the Admin /phones REST endpoint.
#
# SPDX-License-Identifier: MIT

package Net::Duo::Admin::Phone 1.02;

use 5.014;
use strict;
use warnings;

use parent qw(Net::Duo::Object);

use Net::Duo::Admin::User;

# Data specification for converting JSON into our object representation.  See
# the Net::Duo::Object documentation for syntax information.
## no critic (Subroutines::ProhibitUnusedPrivateSubroutines)
sub _fields {
    return {
        activated          => 'simple',
        capabilities       => 'array',
        extension          => ['simple', 'set'],
        name               => ['simple', 'set'],
        number             => ['simple', 'set'],
        phone_id           => 'simple',
        platform           => ['simple', 'set'],
        postdelay          => ['simple', 'set'],
        predelay           => ['simple', 'set'],
        sms_passcodes_sent => 'simple',
        type               => ['simple', 'set'],
        users              => 'Net::Duo::Admin::User',
    };
}
## use critic

# Install our accessors.
Net::Duo::Admin::Phone->install_accessors;

# Override the new method to support creating a phone from an ID instead
# of decoded JSON data.
#
# $class      - Class of object to create
# $duo        - Net::Duo object to use to create the object
# $id_or_data - Phone ID or reference to data
#
# Returns: Newly-created object
#  Throws: Net::Duo::Exception on any problem creating the object
sub new {
    my ($class, $duo, $id_or_data) = @_;
    if (!ref($id_or_data)) {
        $id_or_data = $duo->call_json('GET', "/admin/v1/phones/$id_or_data");
    }
    return $class->SUPER::new($duo, $id_or_data);
}

# Override the create method to add the appropriate URI.
#
# $class    - Class of object to create
# $duo      - Net::Duo object to use to create the object
# $data_ref - Data for new object as a reference to a hash
#
# Returns: Newly-created object
#  Throws: Net::Duo::Exception on any problem creating the object
sub create {
    my ($class, $duo, $data_ref) = @_;
    return $class->SUPER::create($duo, '/admin/v1/phones', $data_ref);
}

# Request an activation URL and barcode for a phone.
#
# $self     - The Net::Duo::Admin::Phone object to request activation URLs for
# $args_ref - Arguments for the request (optional)
#   install    - Set to a true value to request an install URL as well
#   valid_secs - Time the URL will be valid in seconds
#
# Returns: A reference to a hash with the following possible keys
#            activation_url     - Activation URL for this phone
#            activation_barcode - Activation URL for QR code for this phone
#            installation_url   - Install URL if one was requested
#            valid_secs         - How long URLs will be valid
#  Throws: Net::Duo::Exception on any problem getting activation URLs
sub activation_url {
    my ($self, $args_ref) = @_;
    my %args = %{$args_ref};

    # Canonicalize the install argument.
    if (defined($args_ref) && defined($args_ref->{install})) {
        $args{install} = $args{install} ? 1 : 0;
    }

    # Make the JSON call and return the results.
    my $uri = "/admin/v1/phones/$self->{phone_id}/activation_url";
    return $self->{_duo}->call_json('POST', $uri, \%args);
}

# Commit any changed data and refresh the object from Duo.
#
# $self - The Net::Duo::Admin::Phone object to commit changes for
#
# Returns: undef
#  Throws: Net::Duo::Exception on any problem updating the object
sub commit {
    my ($self) = @_;
    return $self->SUPER::commit("/admin/v1/phones/$self->{phone_id}");
}

# Delete the phone from Duo.  After this call, the object should be treated as
# read-only since it can no longer be usefully updated.
#
# $self - The Net::Duo::Admin::Phone object to delete
#
# Returns: undef
#  Throws: Net::Duo::Exception on any problem deleting the object
## no critic (Subroutines::ProhibitBuiltinHomonyms)
sub delete {
    my ($self) = @_;
    $self->{_duo}->call_json('DELETE', "/admin/v1/phones/$self->{phone_id}");
    return;
}
## use critic

# Send a new batch of SMS passcodes to a phone.
#
# $self - The Net::Duo::Admin::Phone object to which to send SMS passcodes
#
# Returns: undef
#  Throws: Net::Duo::Exception on any problem sending passcodes
sub send_sms_passcodes {
    my ($self) = @_;
    my $uri = "/admin/v1/phones/$self->{phone_id}/send_sms_passcodes";
    $self->{_duo}->call_json('POST', $uri);
    return;
}

1;
__END__