octave_packages/financial-0.4.0/yahoo.m

   1 ## Copyright (C) 2008 Bill Denney <bill@denney.ws>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{conn} =} yahoo ()
  18 ## @deftypefnx {Function File} {@var{conn} =} yahoo (@var{URL}, @var{ipaddress}, @var{port})
  19 ##
  20 ## Prepare a Yahoo connection for the fetch command to get Yahoo
  21 ## historical quote data.
  22 ##
  23 ## If given, the @var{URL} must be "http://quote.yahoo.com".  The
  24 ## @var{ipaddress} and @var{port} is the proxy ipaddress and port. These
  25 ## parameters are currently ignored (with a warning if given).
  26 ##
  27 ## @seealso{fetch, google}
  28 ## @end deftypefn
  29
  30 ## FIXME: Actually use the proxy info if given.
  31
  32 function conn = yahoo (url="http://quote.yahoo.com", ipaddr="", port=[])
  33
  34   if ! strcmpi (url, "http://quote.yahoo.com")
  35     error ("url must be 'http://quote.yahoo.com'")
  36   elseif ! (isempty (ipaddr) && isempty (port))
  37     warning ("Proxy information is currently ignored")
  38   endif
  39
  40   conn.url  = url;
  41   conn.ip   = ipaddr;
  42   conn.port = port;
  43
  44 endfunction