Egg::Plugin::LWP - LWP for Egg Plugin.

Egg-Plugin-LWP documentation Contained in the Egg-Plugin-LWP distribution.

Index

Code Index:

NAME

Top

Egg::Plugin::LWP - LWP for Egg Plugin.

SYNOPSIS

Top

  use Egg qw/ LWP /;

  __PACKAGE__->egg_startup(
   ...
   .....

   plugin_lwp => {
     timeout => 10,
     agent   => 'MyApp Agent.',
     },

    );

  # The GET request is sent.
  my $res= $e->ua->request( GET => 'http://domain.name/hoge/' );

  # The POST request is sent.
  my $res= $e->ua->request( POST => 'http://domain.name/hoge/form', {
    param1 => 'hooo',
    param2 => 'booo',
    } );

  # It requests it GET doing to pass ua the option.
  my $res= $e->ua( agent => 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)' )
             ->request( GET => 'http://domain.name/hoge/' );

  # It turns by using ua made once.
  my $ua= $e->ua( timeout => 5 );
  for my $domain (qw/ domain1 domain2 domain3 /) {
    my $res= $ua->request( GET => "http://$domain/" ) || next;
    $res->is_success || next;
    $res->...
  }

DESCRIPTION

Top

It is a plugin to use LWP::UserAgent.

Please define HASH in 'plugin_lwp' about the setting. All these set values are passed to LWP::UserAgent.

* Please refer to the document of LWP::UserAgent for the option.

METHODS

Top

ua ( [UA_OPTION_HASH] )

The handler object of Egg::Plugin::LWP is returned.

When UA_OPTION_HASH is given, everything is passed to LWP::UserAgent as an option.

UA_OPTION_HASH overwrites a set value of default.

HANDLER METHODS

Top

new

It is a constructor who is called by $e->ua.

LWP::UserAgent object is generated here.

request ( [REQUEST_METHOD], [URL], [ARGS_HASH] )

The request is sent based on generated ua.

When an invalid value to REQUEST_METHOD is passed, it treats as GET request.

URL is not omissible. The exception is generated when omitting it.

ARGS_HASH is treated as an argument passed to HTTP::Request::Common.

HTTP::Response object that ua returns after completing the request is returned.

  my $res= $e->ua->request(0, 'http://domain.name/');

simple_request

Simple_request of LWP::UserAgent is done.

The argument and others is similar to 'request' method.

  my $res= $e->ua->simple_request(0, 'http://domain.name/');

SEE ALSO

Top

Egg::Release, LWP::UserAgent, HTTP::Request::Common,

AUTHOR

Top

Masatoshi Mizuno <lushe&64;cpan.org>

COPYRIGHT AND LICENSE

Top

Copyright (C) 2008 Bee Flag, Corp. <http://egg.bomcity.com/>, All Rights Reserved.

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

Egg-Plugin-LWP documentation Contained in the Egg-Plugin-LWP distribution. 
package Egg::Plugin::LWP;
#
# Masatoshi Mizuno E<lt>lusheE<64>cpan.orgE<gt>
#
# $Id: LWP.pm 319 2008-04-17 12:20:20Z lushe $
#
use strict;
use warnings;

our $VERSION = '3.01';

sub _setup {
	my($e)= @_;
	my $conf= $e->config->{plugin_lwp} ||= {};
	$conf->{timeout} ||= 10;
	$conf->{agent}   ||= __PACKAGE__. " v$VERSION";
	$e->next::method;
}
sub ua { Egg::Plugin::LWP::handler->new(@_) }

package Egg::Plugin::LWP::handler;
use strict;
use warnings;
use LWP::UserAgent;
use HTTP::Request::Common qw/ GET POST /;

{
	no strict 'refs';  ## no critic
	sub request {
		my($self, $method, $url, $args)= _get_args(@_);
		$self->{ua}->request
		( &{$method}($url, ($method=~m{POST} ? [%$args]: %$args) ) );
	}
	sub simple_request {
		my($self, $method, $url, $args)= _get_args(@_);
		$self->{ua}->simple_request
		( &{$method}($url, ($method=~m{POST} ? [%$args]: %$args) ) );
	}
  };

sub new {
	my($class, $e)= splice @_, 0, 2;
	my $ua= LWP::UserAgent->new(
	  %{$e->config->{plugin_lwp}},
	  %{$_[1] ? {@_}: ($_[0] || {})},
	  );
	bless { e=> $e, ua=> $ua }, $class;
}
sub _get_args {
	my $self= shift;
	my $meth= uc(shift) || 'GET';
	my $url = shift || die qq{ I want 'url' };
	($self, $meth, $url, ($_[1] ? {@_}: ($_[0] || {})));
}

1;

__END__