.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "WebService::CIA::Source::Web 3pm"
.TH WebService::CIA::Source::Web 3pm "2022-06-28" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
WebService::CIA::Source::Web \- An interface to the online CIA World Factbook
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use WebService::CIA::Source::Web;
\&  my $source = WebService::CIA::Source::DBM\->new();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
WebService::CIA::Source::Web is an interface to the live, online version of the \s-1CIA\s0
World Factbook.
.PP
It's a very slow way of doing things, but requires no pre-compiled \s-1DBM.\s0 It's
more likely to be useful for proving concepts or testing.
.SH "METHODS"
.IX Header "METHODS"
Apart from \f(CW\*(C`new\*(C'\fR, these methods are normally accessed via a WebService::CIA object.
.ie n .IP """new( \e%opts )""" 4
.el .IP "\f(CWnew( \e%opts )\fR" 4
.IX Item "new( %opts )"
.Vb 2
\&    my $source = WebService::CIA::Source::Web\->new();
\&    $source = WebService::CIA::Source::Web\->new( { user_agent => $ua } );
.Ve
.Sp
This method creates a new WebService::CIA::Source::Web object. It takes an optional hashref of arguments.
.RS 4
.ie n .IP """user_agent""" 4
.el .IP "\f(CWuser_agent\fR" 4
.IX Item "user_agent"
A user agent object to use. This must implement the same user interface
as \f(CW\*(C`LWP::UserAgent\*(C'\fR (or, at least, a \f(CW\*(C`get()\*(C'\fR method).
.RE
.RS 4
.RE
.ie n .IP """value($country_code, $field)""" 4
.el .IP "\f(CWvalue($country_code, $field)\fR" 4
.IX Item "value($country_code, $field)"
Retrieve a value from the web.
.Sp
\&\f(CW$country_code\fR should be the \s-1FIPS 10\-4\s0 country code as defined in
<https://www.cia.gov/library/publications/the\-world\-factbook/appendix/appendix\-d.html>.
.Sp
\&\f(CW$field\fR should be the name of the field whose value you want to
retrieve, as defined in
<https://www.cia.gov/library/publications/the\-world\-factbook/docs/notesanddefs.html>.
(WebService::CIA::Parser also creates four extra fields: \*(L"\s-1URL\*(R", \*(L"URL\s0 \- Print\*(R",
\&\*(L"\s-1URL\s0 \- Flag\*(R", and \*(L"\s-1URL\s0 \- Map\*(R" which are the URLs of the country's Factbook
page, the printable version of that page, a \s-1GIF\s0 map of the country, and a
\&\s-1GIF\s0 flag of the country respectively.)
.Sp
\&\f(CW\*(C`value\*(C'\fR will return \f(CW\*(C`undef\*(C'\fR if the country or field cannot be found, or if
there is an error GETing the page. This isn't ideal, but I can't think of the
best way around it right now.
.ie n .IP """all($country_code)""" 4
.el .IP "\f(CWall($country_code)\fR" 4
.IX Item "all($country_code)"
Returns a hashref of field-value pairs for \f(CW$country_code\fR or an empty
hashref if \f(CW$country_code\fR isn't available from the Factbook.
.ie n .IP """get($country_code)""" 4
.el .IP "\f(CWget($country_code)\fR" 4
.IX Item "get($country_code)"
Retrieve and cache the data for a country.
.Sp
Returns 1 if successful, 0 if not.
.ie n .IP """cached($country_code)""" 4
.el .IP "\f(CWcached($country_code)\fR" 4
.IX Item "cached($country_code)"
Get/set the country code whose data is cached.
.ie n .IP """cache($hashref)""" 4
.el .IP "\f(CWcache($hashref)\fR" 4
.IX Item "cache($hashref)"
Get/set a hashref of data for the current country.
.ie n .IP """parser()""" 4
.el .IP "\f(CWparser()\fR" 4
.IX Item "parser()"
Returns a reference to the WebService::CIA::Parser object being used.
.ie n .IP """ua( $userAgent )""" 4
.el .IP "\f(CWua( $userAgent )\fR" 4
.IX Item "ua( $userAgent )"
Returns a reference to the user agent object being used. By default
this is an \f(CW\*(C`LWP::UserAgent\*(C'\fR object, but you can pass a different object
in if you wish.
.ie n .IP """last_response()""" 4
.el .IP "\f(CWlast_response()\fR" 4
.IX Item "last_response()"
Returns the \f(CW\*(C`HTTP::Response\*(C'\fR object from the last request.
.SH "CACHING"
.IX Header "CACHING"
In order to make some small improvement in efficiency, WebService::CIA::Source::Web
keeps a copy of the data for the last country downloaded in memory.
.SH "TO DO"
.IX Header "TO DO"
.IP "File system based caching of pages." 4
.IX Item "File system based caching of pages."
.PD 0
.IP "User-definable stack of cached countries, rather than just one." 4
.IX Item "User-definable stack of cached countries, rather than just one."
.IP "Caching of last-modified headers; conditional \s-1GET.\s0" 4
.IX Item "Caching of last-modified headers; conditional GET."
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Ian Malpass (ian\-cpan@indecorous.com)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2003\-2007, Ian Malpass
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
The \s-1CIA\s0 World Factbook's copyright information page
(<https://www.cia.gov/library/publications/the\-world\-factbook/docs/contributor_copyright.html>)
states:
.PP
.Vb 2
\&  The Factbook is in the public domain. Accordingly, it may be copied
\&  freely without permission of the Central Intelligence Agency (CIA).
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
WebService::CIA, WebService::CIA::Parser, WebService::CIA::Source::DBM