Zoffix Znet > WWW-Proxy4FreeCom-1.003 > WWW::Proxy4FreeCom

Download:
WWW-Proxy4FreeCom-1.003.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.003   Source  

NAME ^

WWW::Proxy4FreeCom - fetch proxy list from http://proxy4free.com/

SYNOPSIS ^

    use strict;
    use warnings;
    use WWW::Proxy4FreeCom;

    my $prox = WWW::Proxy4FreeCom->new;

    my $proxies = $prox->get_list
        or die $prox->error;

    printf "%-40s (last tested %s ago)\n", @$_{ qw(domain last_test) }
        for @$proxies;

DESCRIPTION ^

The module provides means to fetch proxy list from http://proxy4free.com/ website.

CONSTRUCTOR ^

new

    my $prox = WWW::Proxy4FreeCom->new;

    my $prox = WWW::Proxy4FreeCom->new(
        timeout => 10,
        debug   => 1,
    );

    my $prox = WWW::Proxy4FreeCom->new(
        ua => LWP::UserAgent->new(
            timeout => 10,
            agent   => 'ProxUA',
        ),
    );

Constructs and returns a brand new yummy juicy WWW::Proxy4FreeCom object. Takes a few optional arguments. Possible arguments are as follows:

timeout

    ->new( timeout => 10 );

Optional. Specifies the timeout argument of LWP::UserAgent's constructor, which is used for retrieving data. Defaults to: 30 seconds.

ua

    ->new( ua => LWP::UserAgent->new(agent => 'Foos!') );

Optional. If the timeout argument is not enough for your needs of mutilating the LWP::UserAgent object used for retrieving proxy list, feel free to specify the ua argument which takes an LWP::UserAgent object as a value. Note: the timeout argument to the constructor will not do anything if you specify the ua argument as well. Defaults to: plain boring default LWP::UserAgent object with timeout argument set to whatever WWW::Proxy4FreeCom's timeout argument is set to as well as agent argument is set to mimic Firefox.

debug

    ->new( debug => 1 );

When get_list() is called any unsuccessfull page retrievals will be silently ignored. Setting debug argument to a true value will carp() any network errors if they occur.

METHODS ^

get_list

    my $list_ref = $prox->get_list # just from the "proxy list 1"
        or die $prox->error;

    my $list_ref = $prox->get_list( 2 ) # just from the "proxy list 2"
        or die $prox->error;

    $prox->get_list( [3,5] ) # lists 3 and 5 only
        or die $prox->error;

Instructs the objects to fetch a fresh list of proxies from http://proxy4free.com/. On failure returns undef or an empty list, depending on the context, and the human-readable error will be available by calling the ->error method. On success returns an arrayref of hashrefs, each representing a proxy entry. Takes one optional argument which can be either a number between 1 and 14 (inclusive) or an arrayref with several of these numbers. The numbers represent the page number of proxy list pages on http://proxy4free.com/. By default only the list from the "proxy list 1" will be fetched.

Each hashref in the returned arrayref is in a following format (if any field is missing on the site it will be reported as a string N/A):

    {
        'domain' => 'localfast.info',
        'rating' => '65',
        'country' => 'Germany',
        'access_time' => '1.3',
        'uptime' => '96',
        'online_since' => '16 hours',
        'last_test' => '30 minutes',
        'features_hian' => '1',
        'features_ssl' => '0',
    }

Where all the values correspond to the proxy list table columns on the website. The features_hian and features_ssl keys will be set to true values, if the proxy offers HiAn or SSL features respectively.

error

    my $list = $prox->get_list # just from the "proxy list 1"
        or die $prox->error;

If get_list() method fails it will return either undef or an empty list, depending on the context, and the reason for the error will be available via error() method. Takes no arguments, return a human-readable error message explaining the failure.

list

    my $last_list_ref = $prox->list;

Must be called after a successfull call to get_list(). Takes no arguments, returns the same arrayref of hashrefs as last call to get_list() returned.

ua

    my $old_LWP_UA_obj = $prox->ua;

    $prox->ua( LWP::UserAgent->new( timeout => 10, agent => 'foos' );

Returns a currently used LWP::UserAgent object used for retrieving data. Takes one optional argument which must be an LWP::UserAgent object, and the object you specify will be used in any subsequent calls to get_list().

debug

    my $old_debug => $prox->debug;

    $prox->debug(1);

Returns a currently set debug value, when called with an optional argument (which can be either a true or false value) will set debug to that value. See debug argument to constructor for more information.

AUTHOR ^

'Zoffix, <'zoffix at cpan.org'> (http://zoffix.com, http://haslayout.net)

BUGS ^

Please report any bugs or feature requests to bug-www-proxy4freecom at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Proxy4FreeCom. 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 WWW::Proxy4FreeCom

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2008 'Zoffix, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: