File Coverage

blib/lib/Ham/APRS/LastPacket.pm

Criterion	Covered	Total	%
statement	7	9	77.7
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod			n/a
total	10	12	83.3

package Ham::APRS::LastPacket;

# --------------------------------------------------------------------------
# Ham::APRS::LastPacket - A simple interface to retrieve the most recent
# packet data for a station from APRS-IS.
#
# Copyright (c) 2008-2010 Brad McConahay N8QQ.
# Cincinnat, Ohio USA
#
# This module is free software; you can redistribute it and/or
# modify it under the terms of the Artistic License 2.0. For
# details, see the full text of the license in the file LICENSE.
#
# This program is distributed in the hope that it will be
# useful, but it is provided "as is" and without any express
# or implied warranties. For details, see the full text of
# the license in the file LICENSE.
# --------------------------------------------------------------------------

use strict;
use warnings;
use XML::Simple;
use LWP::UserAgent;
use vars qw($VERSION);

our $VERSION = '0.03';

my $aprs_url = "http://aprsearch.net/xml/1.3/report.cgi?call=";
my $site_name = 'aprsearch.net/xml';
my $default_timeout = 10;

sub new
{
	my $class = shift;
	my %args = @_;
	my $self = {};
	$self->{timeout} = $args{timeout} || $default_timeout;
	if ($args{suppress_empty}) {
		$self->{suppress_empty} = $args{suppress_empty};
	} elsif (defined $args{suppress_empty} and !$args{suppress_empty}) {
		$self->{suppress_empty} = '';
	} elsif (exists $args{suppress_empty} and ! defined $args{suppress_empty}) {
		$self->{suppress_empty} = undef;
	} else {
		$self->{suppress_empty} = '';
	}
	bless $self, $class;
	return $self;
}

sub set_callsign
{
	my $self = shift;
	my $callsign = shift;
	if (!$callsign) {
		$self->{is_error} = 1;
		$self->{error_message} = "No callsign was provided";
		return undef;
	}
	$callsign =~ tr/a-z/A-Z/;
	$self->{callsign} = $callsign;
}

sub get_callsign
{
	my $self = shift;
	return $self->{callsign};
}

sub get_data
{
	my $self = shift;
	if (!$self->{callsign}) {
		$self->{is_error} = 1;
		$self->{error_message} = "Can not get data without a callsign";
		return undef;
	}
	return _get_xml($self);
}

sub is_error { my $self = shift; $self->{is_error} }
sub error_message { my $self = shift; $self->{error_message} }

# -----------------------
#	PRIVATE
# -----------------------

sub _get_xml
{
	my $self = shift;
	my $ua = LWP::UserAgent->new( timeout=>$self->{timeout} );
	$ua->agent("Perl Ham-APRS-LastPacket.pm $VERSION");
	my $request = HTTP::Request->new('GET', $aprs_url.$self->{callsign});
	my $response = $ua->request($request);
	if (!$response->is_success) {
		$self->{is_error} = 1;
		$self->{error_message} = "Could not contact site: $site_name - ".HTTP::Status::status_message($response->code);
		return undef;
	}
	my $content = $response->content;
	chomp $content;
	$content =~ s/(\r|\n)//g;

	my $xs = XML::Simple->new(
		SuppressEmpty => $self->{suppress_empty}
	);
	my $data = $xs->XMLin($content);

	if (!$data->{position}) {
		$self->{is_error} = 1;
		$self->{error_message} = "$self->{callsign} was not found at $site_name\n";
		return undef;
	}
	return $data;
}

1;
__END__