Bio::R...TTPget(3pm)

💖 Bio::Root::HTTPget — the Bio::R...TTPget(3pm) page, but make it make sense 💖

okay bestie, you're reading the perl manual page for Bio::Root::HTTPget, and it lives in section 3pm. let's get into it 🦋

---

✨ NAME ✨

Bio::Root::HTTPget — it's a module for fallback HTTP get operations for when LWP:: is unavailable. like, it's the understudy that actually knows all the lines 💅

---

🌸 SYNOPSIS 🌸

 use Bio::Root::HTTPget;
 my $web = Bio::Root::HTTPget->new();

 my $response = $web->get('http://localhost');
 $response    = $web->get('http://localhost/images');

 $response    = eval { $web->get('http://fred:secret@localhost/ladies_only/')
                     } or warn $@;

 $response    = eval { $web->get('http://jeff:secret@localhost/ladies_only/')
                     } or warn $@;

 $response    = $web->get('http://localhost/images/navauthors.gif');
 $response    = $web->get(-url=>'http://www.google.com',
                                    -proxy=>'http://www.modperl.com');

---

💜 DESCRIPTION 💜

so basically this is a last-chance module for doing network HTTP get requests in situations where the more advanced external CPAN modules, like LWP::, are just… not installed. no LWP? no problem, we're coping 🫶

the actual reason this module got developed: so that the Open Bio Database Access code can fall back to fetching the default registry files from http://open-bio.org/registry/ without having to depend on external dependencies like Bundle::LWP just to do network HTTP access. the way it said "we're not adding a whole dependency for this" 😭 iconic behaviour fr fr

the core of this module was written by Lincoln Stein. it can handle proxies and HTTP-based proxy authentication. versatile queen 👑

---

📣 FEEDBACK 📣

💌 Mailing Lists

user feedback is an integral part of the evolution of this and other Bioperl modules — yes, that means you, bestie, your opinion matters here 💖 send your comments and suggestions preferably to one of the Bioperl mailing lists. your participation is much appreciated. periodt.

 bioperl-l@bioperl.org                  - General discussion
 http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

🐛 Reporting Bugs

report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolution. bug reports can be submitted via the web:

 https://github.com/bioperl/bioperl-live/issues

---

👑 AUTHOR - Lincoln Stein 👑

 # Please direct questions and support issues to bioperl-l@bioperl.org

cared for by Chris Dagdigian <dag@sonsorol.org> 💫

---

📚 APPENDIX 📚

the rest of the documentation details each of the object methods. internal methods are usually preceded with a _. (iykyk — underscore = private, don't touch unless you're built different 🙈)

🔥 get

 Title   : get
 Usage   : my $resp = get(-url => $url);
 Function:
 Returns : string
 Args    : -url     => URL to HTTPGet
           -proxy   => proxy to use
           -user    => username for proxy or authentication
           -pass    => password for proxy or authentication
           -timeout => timeout

returns a string, takes those args. note that Function: is just… blank in the original. we don't know either. it's giving mystery 🕵️♀️

🔥 getFH

 Title   : getFH
 Usage   :
 Function:
 Example :
 Returns : string
 Args    :

returns a string, and literally everything else is left as an exercise for the reader 💀

🔥 _http_parse_url

 Title   :
 Usage   :
 Function:
 Example :
 Returns :
 Args    :

internal method, preceded by an underscore, and the docs are… a blank canvas. iconic minimalism ✨

🔥 _http_connect

 Title   :
 Usage   :
 Function:
 Example :
 Returns :
 Args    :

also internal, also mysterious. she's private and she's not explaining herself 💅

🔥 _encode_base64

 Title   :
 Usage   :
 Function:
 Example :
 Returns :
 Args    :

same energy, same blank fields, still internal, still doing her thing quietly 🎀

🔥 proxy

 Title   : proxy
 Usage   : $httpproxy = $db->proxy('http')  or
           $db->proxy(['http','ftp'], 'http://myproxy' )
 Function: Get/Set a proxy for use of proxy. Defaults to environment variable
           http_proxy if present.
 Returns : a string indicating the proxy
 Args    : $protocol : string for the protocol to set/get
           $proxyurl : url of the proxy to use for the specified protocol
           $username : username (if proxy requires authentication)
           $password : password (if proxy requires authentication)

get/set a proxy for use of proxy. it defaults to the environment variable http_proxy if present — so check your env before you blame the module, bestie 👀

🔥 clear_proxy

 Title   : clear_proxy
 Usage   : my $old_prozy = $db->clear_proxy('http')
 Function: Unsets (clears) the proxy for the protocol indicated
 Returns : a string indicating the old proxy value
 Args    : $protocol : string for the protocol to clear

unsets (clears) the proxy for the protocol you point at, and hands you back the old proxy value like a little souvenir. (yes, the usage variable is spelled $old_prozy in the original — we keep it exactly as written, no notes 😭)

🔥 authentication

 Title   : authentication
 Usage   : $db->authentication($user,$pass)
 Function: Get/Set authentication credentials
 Returns : Array of user/pass
 Args    : Array or user/pass

get/set authentication credentials, returns an array of user/pass, takes an array of user/pass. simple, clean, no drama 🫶

---

and that's the whole page, bestie 🌈 this was written by Lincoln Stein, cared for by Chris Dagdigian, and it comes from perl v5.32.1, dated 2021-08-15 — which is the manual page's source, version and date, and yes we're shouting them out in the sign-off because they deserve their moment 💖✨🎀 mwah, go fetch something. 🦋