Bio/WebAgent.pm

filter: Statementstmt 28.9% 11 / 38 Branchbran 0.0% 0 / 12 Conditioncond 0.0% 0 / 5 MC/DCmcdc 0.0% 0 / 3 Subroutinesub 37.5% 3 / 8 Podpod 100% 5 / 5 totaltotal 26.7% 19 / 71 CC 9 SCAR 23.6
CC
9
Cov
20%
delay
20.0
new
12.0
sleep
12.0
CRAP 10.6
« Bio/SearchIO/blast_pull.pm ↑ Summary Bio/SeqIO/tinyseq/tinyseqHandler.pm »
1 #
2 # BioPerl module for Bio::WebAgent
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Heikki Lehvaslaiho, heikki-at-bioperl-dot-org
7 # For copyright and disclaimer see below.
8 #
9  
10 # POD documentation - main docs before the code
11  
12 =head1 NAME
13  
14 Bio::WebAgent - A base class for Web (any protocol) access
15  
16 =head1 SYNOPSIS
17  
18 # This is a abstract superclass for bioperl modules accessing web
19 # resources - normally you do not instantiate it but one of its
20 # subclasess.
21  
22 =head1 DESCRIPTION
23  
24 This abstract superclass is a subclass of L<LWP::UserAgent> which
25 allows protocol independent access of remote locations over
26 the Net.
27  
28 It takes care of error handling, proxies and various net protocols.
29 BioPerl classes accessing the net should inherit from it. For details,
30 see L<LWP::UserAgent>.
31  
32 The interface is still evolving. For now, two public methods have been
33 copied from Bio::DB::WebDBSeqI: delay() and delay_policy. These are
34 used to prevent overwhelming the server by rapidly repeated . Ideally
35 there should be a common abstract superclass with these. See L<delay>.
36  
37 =head1 SEE ALSO
38  
39 L<LWP::UserAgent>,
40 L<Bio::DB::WebDBSeqI>,
41  
42 =head1 FEEDBACK
43  
44 =head2 Mailing Lists
45  
46 User feedback is an integral part of the evolution of this and other
47 Bioperl modules. Send your comments and suggestions preferably to
48 the Bioperl mailing list. Your participation is much appreciated.
49  
50 bioperl-l@bioperl.org - General discussion
51 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
52  
53 =head2 Support
54  
55 Please direct usage questions or support issues to the mailing list:
56  
57 I<bioperl-l@bioperl.org>
58  
59 rather than to the module maintainer directly. Many experienced and
60 reponsive experts will be able look at the problem and quickly
61 address it. Please include a thorough description of the problem
62 with code and data examples if at all possible.
63  
64 =head2 Reporting Bugs
65  
66 Report bugs to the Bioperl bug tracking system to help us keep track
67 of the bugs and their resolution. Bug reports can be submitted via the
68 web:
69  
70 https://github.com/bioperl/bioperl-live/issues
71  
72 =head1 AUTHOR
73  
74 Heikki Lehvaslaiho, heikki-at-bioperl-dot-org
75  
76 =head1 COPYRIGHT
77  
78 Copyright (c) 2003, Heikki Lehvaslaiho and EMBL-EBI.
79 All Rights Reserved.
80  
81 This module is free software; you can redistribute it and/or modify
82 it under the same terms as Perl itself.
83  
84 =head1 DISCLAIMER
85  
86 This software is provided "as is" without warranty of any kind.
87  
88 =head1 APPENDIX
89  
90 The rest of the documentation details each of the object
91 methods. Internal methods are usually preceded with a _
92  
93 =cut
94  
95  
96 # Let the code begin...
97  
98 package Bio::WebAgent;
99 2 $Bio::WebAgent::VERSION = '1.7.8';
100 2 ▶use vars qw($LAST_INVOCATION_TIME);
Subroutine BEGIN: called CC=1 SCAR=0.0
101 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
102  
103 2 ▶use base qw(LWP::UserAgent Bio::Root::Root);
Subroutine BEGIN: called CC=1 SCAR=0.0
104  
105  
106 0 ▶sub new {
Subroutine new: not called CC=3 SCAR=24.8
Pod documented
107 0 my $class = shift;
108  
109 # We make env_proxy the default here, but it can be
110 # over-ridden by $self->env_proxy later,
111 # or by new(env_proxy=>0) at constructor time
112
113 0 my $self = $class->SUPER::new(env_proxy => 1);
114  
115 0 ▶ while( @_ ) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 0 0 0
116 0 my $key = shift;
117 0 $key =~ s/^-//;
118 0 my $value = shift;
119 0 ▶ $self->can($key) || next;
Branch: 1 branch
BranchTrueFalseTotal
$self->can($key) or next 0 0 0
120 0 $self->$key($value);
121 }
122  
123 0 return $self; # success - we hope!
124  
125 }
126  
127  
128 # -----------------------------------------------------------------------------
129  
130 =head2 url
131  
132 Usage : $agent->url
133 Returns : URL to reach out to Net
134 Args : string
135  
136 =cut
137  
138 0 ▶sub url {
Subroutine url: not called CC=2 SCAR=17.9
Pod documented
139 0 my ($self,$value) = @_;
140 0 ▶ if( defined $value) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 0 0 0
141 0 $self->{'_url'} = $value;
142 }
143 0 return $self->{'_url'};
144 }
145  
146  
147 =head2 delay
148  
149 Title : delay
150 Usage : $secs = $self->delay([$secs])
151 Function: get/set number of seconds to delay between fetches
152 Returns : number of seconds to delay
153 Args : new value
154  
155 NOTE: the default is to use the value specified by delay_policy().
156 This can be overridden by calling this method, or by passing the
157 -delay argument to new().
158  
159 =cut
160  
161 0 ▶sub delay {
Subroutine delay: not called CC=4 SCAR=30.0
Pod documented
162 0 my ($self, $value) = @_;
163 0 ▶ if ($value) {
Branch: 1 branch
BranchTrueFalseTotal
if ($value) 0 0 0
164 0 ▶ $self->throw("Need a positive integer, not [$value]")
Branch: 1 branch
BranchTrueFalseTotal
unless $value >= 0 0 0 0
165 unless $value >= 0;
166 0 $self->{'_delay'} = int $value;
167 }
168 0 ▶ return $self->{'_delay'} || $self->delay_policy;
Condition0%0/3
$self->{'_delay'} || $self->delay_policy
l!l&&r!l&&!r
000
MC/DC0%0/2
$self->{'_delay'} || $self->delay_policy
$self->{'_delay'} $self->delay_policy
Truth table0%0/3
A || B
A= $self->{'_delay'}B= $self->delay_policy
ABresult
1X1
011
000
169 }
170  
171 =head2 delay_policy
172  
173 Title : delay_policy
174 Usage : $secs = $self->delay_policy
175 Function: return number of seconds to delay between calls to remote db
176 Returns : number of seconds to delay
177 Args : none
178  
179 NOTE: The default delay policy is 3s. Override in subclasses to
180 implement other delays. The timer has only second resolution, so the delay
181 will actually be +/- 1s.
182  
183 =cut
184  
185 0 ▶sub delay_policy {
Subroutine delay_policy: not called CC=1 SCAR=6.9
Pod documented
186 0 my $self = shift;
187 0 return 3;
188 }
189  
190  
191 =head2 sleep
192  
193 Title : sleep
194 Usage : $self->sleep
195 Function: sleep for a number of seconds indicated by the delay policy
196 Returns : none
197 Args : none
198  
199 NOTE: This method keeps track of the last time it was called and only
200 imposes a sleep if it was called more recently than the delay_policy()
201 allows.
202  
203 =cut
204  
205 0 ▶sub sleep {
Subroutine sleep: not called CC=3 SCAR=24.8
Pod documented
206 0 my $self = shift;
207 0 ▶ $LAST_INVOCATION_TIME ||= 0;
Condition0%0/2
$Bio::WebAgent::LAST_INVOCATION_TIME ||= 0
l!l
00
MC/DC0%0/1
$Bio::WebAgent::LAST_INVOCATION_TIME ||= 0
$Bio::WebAgent::LAST_INVOCATION_TIME
Truth table0%0/2
A
A= $Bio::WebAgent::LAST_INVOCATION_TIME
Aresult
11
00
208 0 ▶ if (time - $LAST_INVOCATION_TIME < $self->delay) {
Branch: 1 branch
BranchTrueFalseTotal
if (time - $Bio::WebAgent::LAST_INVOCATION_TIME < $self->delay) 0 0 0
209 0 my $delay = $self->delay - (time - $LAST_INVOCATION_TIME);
210 0 $self->debug("sleeping for $delay seconds\n");
211 0 sleep $delay;
212 }
213 0 $LAST_INVOCATION_TIME = time;
214 }
215  
216 2 1;
217  
218 __END__
« Bio/SearchIO/blast_pull.pm ↑ Summary Bio/SeqIO/tinyseq/tinyseqHandler.pm »