File Coverage

blib/lib/WWW/NOS/Open.pm

Criterion	Covered	Total	%
statement	111	187	59.3
branch	7	16	43.7
condition	0	2	0.0
subroutine	34	46	73.9
pod	7	7	100.0
total	159	258	61.6

# -*- cperl; cperl-indent-level: 4 -*-
# Copyright (C) 2011-2021, Roland van Ipenburg
package WWW::NOS::Open v1.0.4;
use strict;
use warnings;

use utf8;
use 5.014000;

use Date::Calc qw(Add_Delta_Days Date_to_Days Delta_Days Today);
use Date::Format;
use HTTP::Headers;
use HTTP::Request;
use HTTP::Status
  qw(HTTP_OK HTTP_BAD_REQUEST HTTP_UNAUTHORIZED HTTP_FORBIDDEN HTTP_INTERNAL_SERVER_ERROR);
use JSON;
use LWP::UserAgent;
use Log::Log4perl qw(:easy get_logger);
use Moose qw/around has with/;
use Moose::Util::TypeConstraints qw/enum/;
use URI::Escape qw(uri_escape);
use URI;
use XML::Simple;

use namespace::autoclean '-also' => qr/^__/sxm;

use WWW::NOS::Open::Article;
use WWW::NOS::Open::AudioFragment;
use WWW::NOS::Open::Broadcast;
use WWW::NOS::Open::DayGuide;
use WWW::NOS::Open::Document;
use WWW::NOS::Open::Exceptions;
use WWW::NOS::Open::Result;
use WWW::NOS::Open::TypeDef;
use WWW::NOS::Open::Version;
use WWW::NOS::Open::Video;

use Readonly;
Readonly::Scalar my $SERVER  => $ENV{'NOSOPEN_SERVER'} || q{http://open.nos.nl};
Readonly::Scalar my $TIMEOUT => 15;
Readonly::Scalar my $AGENT   => q{WWW::NOS::Open/} . $WWW::NOS::Open::VERSION;
Readonly::Scalar my $DATE_FORMAT      => q{%04u-%02u-%02u};
Readonly::Scalar my $DEFAULT_START    => -1;                  # Yesterday
Readonly::Scalar my $DEFAULT_END      => 1;                   # Tomorrow
Readonly::Scalar my $MAX_RANGE        => 14;                  # Two weeks
Readonly::Scalar my $GET              => q{GET};
Readonly::Scalar my $DEFAULT_API_KEY  => q{TEST};
Readonly::Scalar my $DEFAULT_OUTPUT   => q{xml};
Readonly::Scalar my $DEFAULT_CATEGORY => q{nieuws};
Readonly::Scalar my $DASH             => q{-};
Readonly::Scalar my $DOUBLE_COLON     => q{::};
Readonly::Scalar my $FRAGMENT         => q{Fragment};
Readonly::Scalar my $VERSION_PATH => q{%s/v1/index/version/key/%s/output/%s/};
Readonly::Scalar my $LATEST_PATH  =>
  q{%s/v1/latest/%s/key/%s/output/%s/category/%s/};
Readonly::Scalar my $SEARCH_PATH => q{%s/v1/search/query/key/%s/output/%s/q/%s};
Readonly::Scalar my $GUIDE_PATH  =>
  q{%s/v1/guide/%s/key/%s/output/%s/start/%s/end/%s/};
Readonly::Scalar my $STRIP_PRIVATE => qr{^_}smx;

Readonly::Hash my %ERR => (
    'INTERNAL_SERVER' => q{Internal server error or no response recieved},
    'EXCEEDED_RANGE'  => qq{Date range exceeds maximum of $MAX_RANGE days},
);
Readonly::Hash my %LOG => (
    'REQUESTING'    => q{Requesting %s},
    'RESPONSE_CODE' => q{Response code %d},
);

Log::Log4perl::easy_init($ERROR);

my $log = Log::Log4perl->get_logger(__PACKAGE__);

has '_ua' => (
    'is'      => 'ro',
    'isa'     => 'LWP::UserAgent',
    'default' => sub {
        LWP::UserAgent->new(
            'timeout' => $TIMEOUT,
            'agent'   => $AGENT,
        );
    },
);

has '_version' => (
    'is'  => 'ro',
    'isa' => 'WWW::NOS::Open::Version',
);

sub get_version {
    my $self = shift;
    my $url  = sprintf $VERSION_PATH, $SERVER,
      URI::Escape::uri_escape( $self->get_api_key ),
      URI::Escape::uri_escape( $self->_get_default_output );
    my $response = $self->_do_request($url);
    my $version  = $self->_parse_version( $response->decoded_content );
    return $version;
}

sub _parse_version {
    my ( $self, $body ) = @_;
    my ( $version, $build );
    my $xml = XML::Simple->new( 'ForceArray' => 1 )->XMLin($body);
    $version = $xml->{'item'}[0]->{'version'}[0];
    $build   = $xml->{'item'}[0]->{'build'}[0];
    return WWW::NOS::Open::Version->new( $version, $build );
}

has '_default_output' => (
    'is'       => 'ro',
    'isa'      => 'Str',
    'default'  => $DEFAULT_OUTPUT,
    'reader'   => '_get_default_output',
    'init_arg' => 'default_output',
);

has '_api_key' => (
    'is'       => 'rw',
    'isa'      => 'Str',
    'default'  => $DEFAULT_API_KEY,
    'reader'   => 'get_api_key',
    'writer'   => 'set_api_key',
    'init_arg' => 'api_key',
);

sub _get_latest_resources {
    my ( $self, $type, $category ) = @_;
    ( defined $category ) || ( $category = $DEFAULT_CATEGORY );
    my $url = sprintf $LATEST_PATH,
      $SERVER,
      URI::Escape::uri_escape($type),
      URI::Escape::uri_escape( $self->get_api_key ),
      URI::Escape::uri_escape( $self->_get_default_output ),
      URI::Escape::uri_escape($category);
    my $response = $self->_do_request($url);
    my @resources =
      $self->_parse_resources( $type, $response->decoded_content );
    return @resources;
}

sub get_latest_articles {
    my ( $self, @param ) = @_;
    return $self->_get_latest_resources( q{article}, @param );
}

sub __get_props {
    my $meta  = shift;
    my @props = map { $_->name } $meta->get_all_attributes;
    for (@props) {
        s/$STRIP_PRIVATE//smx;
    }
    return @props;
}

sub _parse_resource {
    my ( $self, $type, $hr_resource ) = @_;
    my %mapping = (
        'article'   => __PACKAGE__ . $DOUBLE_COLON . ucfirst $type,
        'video'     => __PACKAGE__ . $DOUBLE_COLON . ucfirst $type,
        'audio'     => __PACKAGE__ . $DOUBLE_COLON . ucfirst $type . $FRAGMENT,
        'document'  => __PACKAGE__ . $DOUBLE_COLON . ucfirst $type,
        'broadcast' => __PACKAGE__ . $DOUBLE_COLON . ucfirst $type,
    );

    my @props = __get_props( ( $mapping{$type} )->meta );
    my %param;
    while ( my $prop = shift @props ) {
        $param{$prop} =
          ( q{HASH} eq ref $hr_resource->{$prop}[0] )
          ? %{ $hr_resource->{$prop}[0] }
          : $hr_resource->{$prop}[0];
    }
    $param{'keywords'} = $hr_resource->{'keywords'}->[0]->{'keyword'} || [];
    return ( $mapping{$type} )->new(%param);
}

sub _parse_resources {
    my ( $self, $type, $body ) = @_;
    my @resources;
    my $xml           = XML::Simple->new( 'ForceArray' => 1 )->XMLin($body);
    my @xml_resources = @{ $xml->{$type} };
    while ( my $resource = shift @xml_resources ) {
        push @resources, $self->_parse_resource( $type, $resource );
    }
    return @resources;
}

sub get_latest_videos {
    my ( $self, @param ) = @_;
    return $self->_get_latest_resources( q{video}, @param );
}

sub get_latest_audio_fragments {
    my ( $self, @param ) = @_;
    return $self->_get_latest_resources( q{audio}, @param );
}

sub _parse_result {
    my ( $self, $body ) = @_;
    my @documents;
    my $xml           = XML::Simple->new( 'ForceArray' => 1 )->XMLin($body);
    my @xml_documents = @{ $xml->{'documents'}->[0]->{'document'} };
    while ( my $hr_document = shift @xml_documents ) {
        push @documents, $self->_parse_resource( q{document}, $hr_document );
    }
    my $result = WWW::NOS::Open::Result->new(
        'documents' => [@documents],
        'related'   => $xml->{'related'}->[0]->{'related'},
    );
    return $result;
}

sub search {
    my ( $self, $query ) = @_;
    my $url = sprintf $SEARCH_PATH,
      $SERVER,
      URI::Escape::uri_escape( $self->get_api_key ),
      URI::Escape::uri_escape( $self->_get_default_output ),
      URI::Escape::uri_escape($query);
    my $response = $self->_do_request($url);
    my $result   = $self->_parse_result( $response->decoded_content );
    return $result;
}

sub __get_date {
    my ( $start_day, $end_day ) = @_;
    my $today = Date_to_Days(Today);
    return (
        (
            sprintf $DATE_FORMAT,
            Add_Delta_Days( 1, 1, 1, $today + $start_day - 1 ),
        ),
        (
            sprintf $DATE_FORMAT,
            Add_Delta_Days( 1, 1, 1, $today + $end_day - 1 ),
        ),
    );
}

sub _parse_dayguide {
    my ( $self, $hr_dayguide ) = @_;

    my @props = __get_props( WWW::NOS::Open::DayGuide->meta );
    my %param;
    while ( my $prop = shift @props ) {
        $param{$prop} = $hr_dayguide->{$prop};
    }
    $param{'broadcasts'} = [];
    my @broadcasts = $hr_dayguide->{'item'};
    while ( my $ar_broadcast = shift @broadcasts ) {
        push @{ $param{'broadcasts'} },
          $self->_parse_resource( q{broadcast}, $ar_broadcast->[0] );
    }
    return WWW::NOS::Open::DayGuide->new(%param);
}

sub _parse_guide {
    my ( $self, $body ) = @_;
    my @dayguides;
    my $xml           = XML::Simple->new( 'ForceArray' => 1 )->XMLin($body);
    my @xml_dayguides = @{ $xml->{'dayguide'} };
    while ( my $hr_dayguide = shift @xml_dayguides ) {
        push @dayguides, $self->_parse_dayguide($hr_dayguide);
    }
    return @dayguides;
}

sub _get_broadcasts {
    my ( $self, $type, $start, $end, $channel ) = @_;

    my ( $default_start, $default_end ) =
      __get_date( $DEFAULT_START, $DEFAULT_END );
    ( defined $start ) || ( $start = $default_start );
    ( defined $end )   || ( $end   = $default_end );

    foreach ( $start, $end ) {
        ( q{DateTime} eq ref ) && ( $_ = $_->ymd );
    }
    if ( Delta_Days( split /$DASH/smx, qq{$start$DASH$end} ) > $MAX_RANGE ) {
        ## no critic qw(RequireExplicitInclusion)
        NOSOpenExceededRangeException->throw(
            ## use critic
            'error' => $ERR{'EXCEEDED_RANGE'},
        );
    }
    my $url = sprintf $GUIDE_PATH,
      $SERVER,
      URI::Escape::uri_escape($type),
      URI::Escape::uri_escape( $self->get_api_key ),
      URI::Escape::uri_escape( $self->_get_default_output ),
      URI::Escape::uri_escape($start),
      URI::Escape::uri_escape($end);
    my $response   = $self->_do_request($url);
    my @guide_days = $self->_parse_guide( $response->decoded_content );
    return @guide_days;
}

sub get_tv_broadcasts {
    my ( $self, @param ) = @_;
    return $self->_get_broadcasts( q{tv}, @param );
}

sub get_radio_broadcasts {
    my ( $self, @param ) = @_;
    return $self->_get_broadcasts( q{radio}, @param );
}

sub __throw {
    my $json = JSON->new;
    my %map  = (
        HTTP::Status::HTTP_BAD_REQUEST  => q{NOSOpenBadRequestException},
        HTTP::Status::HTTP_UNAUTHORIZED => q{NOSOpenUnauthorizedException},
        HTTP::Status::HTTP_FORBIDDEN    => q{NOSOpenForbiddenException},
    );
    my $res = shift;
    $map{ $res->code }
      ->throw( 'error' => $json->decode( $res->decoded_content ), );
}

sub _do_request {
    my ( $self, $url ) = @_;
    my $request = HTTP::Request->new(
        $GET => $url,
        HTTP::Headers->new(),
    );
    $log->debug( sprintf $LOG{'REQUESTING'}, $url );
    my $response = $self->_ua->request($request);
    $log->debug( sprintf $LOG{'RESPONSE_CODE'}, $response->code );
    if ( $response->code == HTTP_INTERNAL_SERVER_ERROR ) {
        ## no critic qw(RequireExplicitInclusion)
        NOSOpenInternalServerErrorException->throw(
            ## use critic
            'error' => $ERR{'INTERNAL_SERVER'},
        );
    }
    elsif ( $response->code > HTTP_OK ) {
        __throw($response);
    }
    return $response;
}

around 'BUILDARGS' => sub {
    my $orig  = shift;
    my $class = shift;
    my ( $api_key, $default_output ) = @_;

    return $class->$orig(
        'api_key'        => $api_key        || $DEFAULT_API_KEY,
        'default_output' => $default_output || $DEFAULT_OUTPUT,
    );
};

with 'WWW::NOS::Open::Interface';

no Moose;

__PACKAGE__->meta->make_immutable;

1;

__END__

=encoding utf8

=for stopwords Bitbucket DateTime perl JSON Readonly URI PHP Ipenburg
MERCHANTABILITY

=head1 NAME

WWW::NOS::Open - Perl framework for the Open NOS REST API

=head1 VERSION

This document describes WWW::NOS::Open version C<v1.0.4>.

=head1 SYNOPSIS

    use WWW::NOS::Open;
    my $nos = WWW::NOS::Open->new($API_KEY);
    @latest_articles = $nos->get_latest_articles('nieuws');

=head1 DESCRIPTION

The L<Dutch public broadcasting foundation NOS|http:://www.nos.nl> provides a
REST API to their content. This module provides a wrapper around that API to
use data from the Open NOS platform with Perl.

=head1 SUBROUTINES/METHODS

=head2 C<new>

Create a new WWW::NOS::Open object.

=over

=item 1. The API key to use in the connection to the Open NOS service. You
need to L<register at Open NOS|http://open.nos.nl/registratie/> to get an API
key, and link your IP address to that account to do authorized requests.

=back

=head2 C<get_version>

Gets the version of the REST API as a
L<WWW::NOS::Open::Version|WWW::NOS::Open::Version> object.

=head2 C<get_latest_articles>

Returns the ten most recent articles as an array of
L<WWW::NOS::Open::Article|WWW::NOS::Open::Article> objects.

=over

=item 1. The optional category of the requested articles, C<nieuws> or
C<sport>. Defaults to the category C<nieuws>.

=back

=head2 C<get_latest_videos>

Returns the ten most recent videos as an array of
L<WWW::NOS::Open::Video|WWW::NOS::Open::Video> objects.

=over

=item 1. The optional category of the requested videos, C<nieuws> or C<sport>.
Defaults to the category C<nieuws>.

=back

=head2 C<get_latest_audio_fragments>

Returns the ten most recent audio fragments as an array of
L<WWW::NOS::Open::AudioFragment|WWW::NOS::Open::AudioFragment> objects.

=over

=item 1. The optional category of the requested audio fragments, C<nieuws> or
C<sport>.  Defaults to the category C<nieuws>.

=back

=head2 C<search>

Search the search engine from L<NOS|http://www.nos.nl> for keywords. Returns
a L<WWW::NOS::Open::Results|WWW::NOS::Open::Results> object with a maximum of
25 items.

=over

=item 1. The keyword or a combination of keywords, for example C<cricket>,
C<cricket AND engeland>, C<cricket OR curling>.

=back

=head2 C<get_tv_broadcasts>

Gets a collection of television broadcasts between two optional dates. Returns
an array of L<WWW::NOS::Open::DayGuide|WWW::NOS::Open::DayGuide> objects. The
period defaults to starting yesterday and ending tomorrow. The period has an
upper limit of 14 days. An C<NOSOpenExceededRangeException> is thrown when
this limit is exceeded.

=over

=item 1. Start date in the format C<YYYY-MM-DD> or as L<DateTime|DateTime>
object.

=item 2. End date in the format C<YYYY-MM-DD> or as L<DateTime|DateTime>
object.

=back

=head2 C<get_radio_broadcasts>

Gets a collection of radio broadcasts between two optional dates. Returns an
array of L<WWW::NOS::Open::DayGuide|WWW::NOS::Open::DayGuide> objects. The
period defaults to starting yesterday and ending tomorrow. The period has an
upper limit of 14 days. An C<NOSOpenExceededRangeException> is thrown when this
limit is exceeded.

=over

=item 1. Start date in the format C<YYYY-MM-DD> or as L<DateTime|DateTime>
object.

=item 2. End date in the format C<YYYY-MM-DD> or as L<DateTime|DateTime>
object.

=back

=head1 CONFIGURATION AND ENVIRONMENT

To use this module with the live content of Open NOS you need an API key which
can be obtained by registering at L<Open NOS|http://open.nos.nl/registratie/>
and then configure your account there with the IP range you'll be accessing
the service from.

This module can use the optional environment variable C<NOSOPEN_SERVER> to
specify a server URL that is not the default Open NOS live service at
L<http://open.nos.nl|http://open.nos.nl>.

The user agent identifier used in the request to the REST API is
C<WWW::NOS::Open/v1.0.4>.

=head1 DEPENDENCIES

=over

=item * perl 5.14

=item * L<Date::Calc|Date::Calc>

=item * L<Date::Format|Date::Format>

=item * L<HTTP::Headers|HTTP::Headers>

=item * L<HTTP::Request|HTTP::Request>

=item * L<HTTP::Status|HTTP::Status>

=item * L<JSON|JSON>

=item * L<LWP::UserAgent|LWP::UserAgent>

=item * L<Log::Log4perl|Log::Log4perl>

=item * L<Moose|Moose>

=item * L<Moose::Util::TypeConstraints|Moose::Util::TypeConstraints>

=item * L<Readonly|Readonly>

=item * L<URI|URI>, L<URI::Escape|URI::Escape>

=item * L<WWW::NOS::Open::Article|WWW::NOS::Open::Article>

=item * L<WWW::NOS::Open::AudioFragment|WWW::NOS::Open::AudioFragment>

=item * L<WWW::NOS::Open::Broadcast|WWW::NOS::Open::Broadcast>

=item * L<WWW::NOS::Open::DayGuide|WWW::NOS::Open::DayGuide>

=item * L<WWW::NOS::Open::Document|WWW::NOS::Open::Document>

=item * L<WWW::NOS::Open::Exceptions|WWW::NOS::Open::Exceptions>

=item * L<WWW::NOS::Open::Result|WWW::NOS::Open::Result>

=item * L<WWW::NOS::Open::TypeDef|WWW::NOS::Open::TypeDef>

=item * L<WWW::NOS::Open::Version|WWW::NOS::Open::Version>

=item * L<WWW::NOS::Open::Video|WWW::NOS::Open::Video>

=item * L<XML::Simple|XML::Simple>

=item * L<namespace::autoclean|namespace::autoclean>

=back

=head1 INCOMPATIBILITIES

None.

=head1 DIAGNOSTICS

Exceptions in the form of an L<Exception::Class|Exception::Class> are thrown
when the Open NOS service reports an exception:

=head2 C<NOSOpenUnauthorizedException>

When a request was made without a valid API key, or from an IP address not
configured to be valid for that API key.

=head2 C<NOSOpenExceededRangeException>

When the time period for a guide request exceeds the supported range of 14
days.

=head2 C<NOSOpenInternalServerErrorException>

When an internal server error has occurred in the Open NOS service.

=head2 C<NOSOpenBadRequestException>

When the Open NOS service reports the request had bad syntax.

=head1 BUGS AND LIMITATIONS

Currently this module only uses the XML output of the Open NOS service and has
no option to use the JSON or serialized PHP formats. When the API matures the
other output options might be added and the content of the raw responses
exposed for further processing in an appropriate environment.

Please report any bugs or feature requests at
L<Bitbucket|https://bitbucket.org/rolandvanipenburg/www-nos-open/issues>.

=head1 AUTHOR

Roland van Ipenburg, E<lt>[e-mail]<gt>

=head1 LICENSE AND COPYRIGHT

Copyright 2011-2021 by Roland van Ipenburg

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

=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

=cut