Skip to content

Commit 76ec3fe

Browse files
Copilotdavorg
Copilot
and
davorg
committed
Add useragent attribute and method to XML::Feed class
Co-authored-by: davorg <24642+davorg@users.noreply.github.com>
1 parent 57c68eb commit 76ec3fe

File tree

2 files changed

+196
-6
lines changed

2 files changed

+196
-6
lines changed

‎lib/XML/Feed.pm‎

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,32 @@ BEGIN {
2323
sub new {
2424
my $class = shift;
2525
my $format = shift // 'Atom';
26+
27+
# Handle optional args hash
28+
my %args;
29+
if (@_ && ref($_[-1]) eq 'HASH' && exists $_[-1]->{useragent}) {
30+
%args = %{pop @_};
31+
# Validate useragent parameter
32+
if (exists $args{useragent}) {
33+
unless (blessed($args{useragent}) && $args{useragent}->isa('LWP::UserAgent')) {
34+
Carp::croak("useragent must be an LWP::UserAgent object");
35+
}
36+
}
37+
# Only useragent is allowed for now
38+
my @invalid_keys = grep { $_ ne 'useragent' } keys %args;
39+
if (@invalid_keys) {
40+
Carp::croak("Invalid argument(s): " . join(', ', @invalid_keys));
41+
}
42+
}
43+
2644
my $format_class = 'XML::Feed::Format::' . $format;
2745
eval "use $format_class";
2846
Carp::croak("Unsupported format $format: $@") if $@;
2947
my $feed = bless {}, join('::', __PACKAGE__, "Format", $format);
48+
49+
# Store useragent if provided
50+
$feed->{useragent} = $args{useragent} if exists $args{useragent};
51+
3052
$feed->init_empty(@_) or return $class->error($feed->errstr);
3153
$feed;
3254
}
@@ -40,13 +62,13 @@ sub parse {
4062
my $feed = bless {}, $class;
4163
my $xml = '';
4264
if (blessed($stream) and $stream->isa('URI')) {
43-
$xml = $class->get_uri($stream);
65+
$xml = $feed->get_uri($stream);
4466
} elsif (ref($stream) eq 'SCALAR') {
4567
$xml = $$stream;
4668
} elsif (ref($stream)) {
47-
$xml = $class->get_fh($stream);
69+
$xml = $feed->get_fh($stream);
4870
} else {
49-
$xml = $class->get_file($stream);
71+
$xml = $feed->get_file($stream);
5072
}
5173
my $errstr = "Can't get feed XML content from $stream";
5274
if ($class->errstr) {
@@ -97,9 +119,16 @@ sub get_uri {
97119
my $class = shift;
98120
my ($stream) = @_;
99121

100-
my $ua = LWP::UserAgent->new;
101-
$ua->agent(__PACKAGE__ . "/$VERSION");
102-
$ua->env_proxy; # force allowing of proxies
122+
# Get or create UserAgent
123+
my $ua;
124+
if (blessed($class) && $class->{useragent}) {
125+
$ua = $class->{useragent};
126+
} else {
127+
$ua = LWP::UserAgent->new;
128+
$ua->agent(__PACKAGE__ . "/$VERSION");
129+
$ua->env_proxy; # force allowing of proxies
130+
}
131+
103132
my $res = URI::Fetch->fetch($stream, UserAgent => $ua)
104133
or return $class->error(URI::Fetch->errstr);
105134
return $class->error("This feed has been permanently removed")
@@ -180,6 +209,27 @@ sub _convert_entry {
180209
return $entry->convert($feed_format);
181210
}
182211

212+
sub useragent {
213+
my $feed = shift;
214+
if (@_) {
215+
# Setter: validate the useragent
216+
my $ua = shift;
217+
unless (blessed($ua) && $ua->isa('LWP::UserAgent')) {
218+
Carp::croak("useragent must be an LWP::UserAgent object");
219+
}
220+
$feed->{useragent} = $ua;
221+
return $ua;
222+
} else {
223+
# Getter: return existing or create new one
224+
unless ($feed->{useragent}) {
225+
$feed->{useragent} = LWP::UserAgent->new;
226+
$feed->{useragent}->agent(__PACKAGE__ . "/$VERSION");
227+
$feed->{useragent}->env_proxy;
228+
}
229+
return $feed->{useragent};
230+
}
231+
}
232+
183233
sub base;
184234
sub format;
185235
sub title;
@@ -262,12 +312,31 @@ L<DateTime> objects, which it then returns to the caller.
262312
263313
=head2 XML::Feed->new($format)
264314
315+
=head2 XML::Feed->new($format, \%args)
316+
265317
Creates a new empty I<XML::Feed> object using the format I<$format>.
266318
267319
$feed = XML::Feed->new('Atom');
268320
$feed = XML::Feed->new('RSS');
269321
$feed = XML::Feed->new('RSS', version => '0.91');
270322
323+
An optional hashref of arguments can be provided as the last parameter:
324+
325+
my $ua = LWP::UserAgent->new;
326+
$ua->timeout(30);
327+
$feed = XML::Feed->new('Atom', { useragent => $ua });
328+
329+
Currently supported arguments:
330+
331+
=over 4
332+
333+
=item * useragent
334+
335+
An L<LWP::UserAgent> object (or subclass) to use for fetching feeds via URI.
336+
If not provided, a default UserAgent will be created when needed.
337+
338+
=back
339+
271340
=head2 XML::Feed->parse($stream)
272341
273342
=head2 XML::Feed->parse($stream, $format)
@@ -405,6 +474,23 @@ object in the correct format for the feed.
405474
Returns an XML representation of the feed, in the format determined by
406475
the current format of the I<$feed> object.
407476
477+
=head2 $feed->useragent([ $ua ])
478+
479+
Get or set the L<LWP::UserAgent> object used for fetching feeds.
480+
481+
If called without arguments, returns the current UserAgent object,
482+
creating a default one if it doesn't exist.
483+
484+
If called with an L<LWP::UserAgent> object (or subclass), sets it as
485+
the UserAgent for this feed.
486+
487+
my $ua = LWP::UserAgent->new;
488+
$ua->timeout(30);
489+
$feed->useragent($ua);
490+
491+
# Later, retrieve it
492+
my $current_ua = $feed->useragent;
493+
408494
=head2 $feed->first_link ([ $uri ])
409495
410496
The Atom First-link for feed paging and archiving (RFC 5005).

‎t/31-useragent.t‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
use strict;
2+
use warnings;
3+
use Test::More;
4+
use XML::Feed;
5+
use LWP::UserAgent;
6+
7+
# Test 1: Create feed without useragent
8+
{
9+
my $feed = XML::Feed->new('Atom');
10+
isa_ok($feed, 'XML::Feed::Format::Atom', 'Feed created without useragent');
11+
ok(!exists $feed->{useragent}, 'No useragent stored initially');
12+
}
13+
14+
# Test 2: Create feed with useragent
15+
{
16+
my $ua = LWP::UserAgent->new;
17+
$ua->agent('TestAgent/1.0');
18+
19+
my $feed = XML::Feed->new('Atom', { useragent => $ua });
20+
isa_ok($feed, 'XML::Feed::Format::Atom', 'Feed created with useragent');
21+
isa_ok($feed->{useragent}, 'LWP::UserAgent', 'UserAgent stored correctly');
22+
is($feed->{useragent}->agent, 'TestAgent/1.0', 'UserAgent is the same object');
23+
}
24+
25+
# Test 3: Create feed with invalid useragent (should die)
26+
{
27+
eval {
28+
my $feed = XML::Feed->new('Atom', { useragent => 'not an object' });
29+
};
30+
like($@, qr/useragent must be an LWP::UserAgent object/, 'Dies with invalid useragent');
31+
}
32+
33+
# Test 4: Create feed with invalid argument (should die)
34+
{
35+
eval {
36+
my $feed = XML::Feed->new('Atom', { invalid_arg => 'value' });
37+
};
38+
like($@, qr/Invalid argument/, 'Dies with invalid argument');
39+
}
40+
41+
# Test 5: useragent() getter creates one if it doesn't exist
42+
{
43+
my $feed = XML::Feed->new('Atom');
44+
ok(!exists $feed->{useragent}, 'No useragent initially');
45+
46+
my $ua = $feed->useragent;
47+
isa_ok($ua, 'LWP::UserAgent', 'useragent() returns LWP::UserAgent');
48+
ok(exists $feed->{useragent}, 'UserAgent stored after getter call');
49+
like($ua->agent, qr/XML::Feed/, 'UserAgent has default agent string');
50+
}
51+
52+
# Test 6: useragent() getter returns existing one
53+
{
54+
my $ua1 = LWP::UserAgent->new;
55+
$ua1->agent('TestAgent/2.0');
56+
57+
my $feed = XML::Feed->new('Atom', { useragent => $ua1 });
58+
my $ua2 = $feed->useragent;
59+
60+
is($ua2, $ua1, 'useragent() returns the same object');
61+
is($ua2->agent, 'TestAgent/2.0', 'Agent string is preserved');
62+
}
63+
64+
# Test 7: useragent() setter
65+
{
66+
my $feed = XML::Feed->new('Atom');
67+
68+
my $ua = LWP::UserAgent->new;
69+
$ua->agent('TestAgent/3.0');
70+
71+
my $result = $feed->useragent($ua);
72+
is($result, $ua, 'useragent() setter returns the UserAgent');
73+
is($feed->useragent->agent, 'TestAgent/3.0', 'UserAgent set correctly');
74+
}
75+
76+
# Test 8: useragent() setter with invalid value (should die)
77+
{
78+
my $feed = XML::Feed->new('Atom');
79+
80+
eval {
81+
$feed->useragent('not an object');
82+
};
83+
like($@, qr/useragent must be an LWP::UserAgent object/, 'Dies when setting invalid useragent');
84+
}
85+
86+
# Test 9: RSS feed with useragent
87+
{
88+
my $ua = LWP::UserAgent->new;
89+
$ua->agent('RSSTestAgent/1.0');
90+
91+
my $feed = XML::Feed->new('RSS', { useragent => $ua });
92+
isa_ok($feed, 'XML::Feed::Format::RSS', 'RSS feed created with useragent');
93+
is($feed->useragent->agent, 'RSSTestAgent/1.0', 'UserAgent preserved in RSS feed');
94+
}
95+
96+
# Test 10: LWP::UserAgent subclass should be accepted
97+
SKIP: {
98+
skip "Creating subclass inline for testing", 2;
99+
100+
# This would test that subclasses of LWP::UserAgent are accepted
101+
# but we'll skip it for now as it requires more setup
102+
}
103+
104+
done_testing;

0 commit comments

Comments
 (0)