blob: 6d41eb913f0e1fb0bbae7f4a0408b0323187f84a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
use strict;
use warnings;
package Test::Reporter::Transport;
use vars qw/$VERSION/;
$VERSION = '1.4002';
$VERSION = eval $VERSION;
sub new { die "Not implemented" }
sub send { die "Not implemented" }
1;
__END__
=head1 NAME
Test::Reporter::Transport - base class for Test::Reporter transports
=head1 SYNOPSIS
# Defines API that must be implemented by subclasses
my $sender = Test::Reporter::Transport::Subclass->new( @args );
$sender->send( $report )
=head1 DESCRIPTION
Transport subclasses provide the means by which CPAN Testers reports are
transmitted to the CPAN Testers mailing list.
This module is an abstract base class that define an API for
Test::Reporter::Transport subclasses. Individual subclasses MUST
implement the methods described below.
=head1 USAGE
A transport method is specified to Test::Reporter using the C<transport>
option. The C<transport> option expects just the module "suffix" that follows
C<Test::Reporter::Transport>. For example:
# use Test::Reporter::Transport::Net::SMTP for transport
my $report = Test::Reporter->new(
transport => 'Net::SMTP'
);
# use Test::Reporter::Transport::Mail::Send for transport
my $report = Test::Reporter->new(
transport => 'Mail::Send'
);
Configuration of the transport is specified with the C<transport_args>
option:
my $report = Test::Reporter->new(
transport => 'Net::SMTP::TLS',
transport_args => [ User => 'John', Password => '123' ],
);
These may also be specified with the C<transport> or C<transport_args> methods:
$report->transport_args( User => 'John', Password => '123' );
These may also be combined in the C<transport> method itself:
$report->transport( 'Net::SMTP::TLS', User => 'John', Password => '123');
=head1 METHODS
The terms 'may', 'must', 'should', etc. used below have their usual RFC
meanings.
=head2 new
my $sender = $subclass->new( @args );
The C<new> method is the object constructor. It MAY take a list of any
necessary configuration options. It MUST return a transport object if one
is successfully created or undef if the object can not be created.
=head2 send
$sender->send( $report );
The C<send> method MUST take a Test::Reporter object as its only argument. It
MUST return true if the report is successfully sent. It SHOULD die with a
message describing the failure if a report cannot be sent. It MUST NOT return
a true value if the report cannot be sent.
=head1 AUTHOR
=over
=item *
David A. Golden (DAGOLDEN)
=item *
Ricardo Signes (RJBS)
=back
=head1 COPYRIGHT
Copyright (C) 2008 David A. Golden
Copyright (C) 2008 Ricardo Signes
All rights reserved.
=head1 LICENSE
This program is free software; you may redistribute it
and/or modify it under the same terms as Perl itself.
=cut
|
