/ 
WebService-TimeAndDateCom-NewYearsCountdown-1.001
/ WebService::TimeAndDateCom::NewYearsCountdown

NAME

WebService::TimeAndDateCom::NewYearsCountdown - obtain count downs until New Years from www.timeanddate.com

SYNOPSIS

use WebService::TimeAndDateCom::NewYearsCountdown;

my $hny = WebService::TimeAndDateCom::NewYearsCountdown->new;

my $data = $hny->hny('EST')
    or die $hny->error;

printf "%s left until New Year in %s (%s, [%s])\n",
    @$data{qw/time_left  tz  countries  cities/};


my $all_timezones_data = $hny->hny
    or die $hny->error;

for ( @$all_timezones_data ) {
    printf "%s left until New Year in %s (%s, [%s])\n",
        @$_{qw/time_left  tz  countries  cities/};
}

DESCRIPTION

Module obtains count downs until New Years from www.timeanddate.com.

NOTICE TO THE USER

It's worth noting that www.timeanddate.com has this message at the top of its HTML code:

scripts and programs that download content transparent to
the user are not allowed without permission

...I'm not 100% sure about its meaning.

METHODS

new

my $hny = WebService::TimeAndDateCom::NewYearsCountdown->new;

Constructs and returns a new WebService::TimeAndDateCom::NewYearsCountdown object. Does not take any arguments.

hny

my $all_timezones_data = $hny->hny
    or die $hny->error;

my $data = $hny->hny('EST')
    or die $hny->error;

hny stands for Happy New Year. Takes one optional argument, which is the time zone for which to retrieve the data; valid time zones are listed below. On failure returns an undef or an empty list, depending on the context, and the reason for error will be available using the ->error method. On success returns New Years countdown data. If the time zone is specified, returns a single hashref for that time zone, otherwise returns an arrayref of hashrefs of data for each time zone. The format of the hashrefs is as follows:

{
    'tz' => 'EST',
    'time_left' => '4 days, 02:10:04',
    'countries' => 'regions of U.S.A., regions of Canada and 12 more',
    'cities' => 'New York, Washington DC, Detroit, Havana'
}

  • tz time zone code

  • time_left time until New Years in that time zone

  • countries a brief list of regions/countries in that time zone

  • cities a brief list of cities in that time zone

Valid Time Zones Values For ->hny

ACDT
ACST
AEDT
AEST
AFT
AKST
ANAT
ART
AST
AoE
BOT
BRST
BST
CET
CHADT
CST
CST
CVT
CWST
EET
EST
GMT
HAST
IRST
IST
JST
LINT
MART
MMT
MSK
MST
NFT
NPT
NST
NUT
NZDT
PST
UZT
UTC
VET
WIB

error

my $all_timezones_data = $hny->hny
    or die $hny->error;

Takes no arguments. Returns the human-readable error message, when the last call to ->hny fails.

AUTHOR

Zoffix Znet, <zoffix at cpan.org>

BUGS

Please report any bugs or feature requests to bug-webservice-timeanddatecom-newyearscountdown at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-TimeAndDateCom-NewYearsCountdown. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WebService::TimeAndDateCom::NewYearsCountdown

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 Zoffix Znet.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.