ywx 0.1.1 → 0.1.2

data/CHANGELOG.rdoc

@@ -0,0 +1,44 @@
+= YAHOO_WEATHER_20091226_1_2_0
+
+* [shaper] upped library to version 1.2.0 to reflect changes.
+
+* [shaper] added new client.lookup_by_woeid method which should be
+  used instead of the now-deprecated lookup_location method.  Thanks
+  to Chris Cummer (http://github.com/senorprogrammer) for pointing out
+  the new WOEID-based Yahoo API functionality.
+
+* [shaper] use new Yahoo Weather API at 
+  http://weather.yahooapis.com/forecastrss
+
+* [shaper] shift xml parsing to use nokogiri rather than xml-simple.
+
+* [shaper] shift from Response.image_url to Response.image which
+  contains the new YahooWeather::Image record with the old image url
+  plus more detail as now provided in the API response.
+
+* [shaper] refactor for single class per file.
+
+* [shaper] fix km/h unit speed in test.
+
+= YAHOO_WEATHER_20091209_1_1_0
+
+* [shaper] revise atmosphere.barometer to reflect tri-state as
+  "steady", "rising", or "falling" via one of the new
+  YahooWeather::Atmosphere::Barometer constants, whereas previously it
+  was simply a boolean for whether rising.  Thanks to Andy Weber for
+  suggestion.
+
+= YAHOO_WEATHER_20091021_1_0_1
+
+* [shaper] update documentation to reflect reality and use suffix for
+  rdoc format.
+
+* [shaper] move source repository to github.
+
+* [shaper] use Hoe for Rakefile and gem management.
+
+* [shaper] fix test warnings.
+
+= 20061105
+
+* [shaper] Initial version.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem "httparty", "0.8.3"

data/LICENSE

@@ -0,0 +1,504 @@
+		  GNU LESSER GENERAL PUBLIC LICENSE
+		       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+		  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+  
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+			    NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!
+
+

data/README.rdoc

@@ -0,0 +1,102 @@
+= yahoo-weather
+
+== About
+
+yahoo-weather provides an object-oriented interface to the Yahoo! Weather XML
+RSS feed detailed at http://developer.yahoo.com/weather.
+
+People care a lot about the weather.  This may seem ironic given they
+can just glance out the window.  However, we can all understand a
+fascination with details and forecasting.
+
+Log the weather information to your database!  Graph it to your
+heart's content!  Write a widget that emails the weather to your cell
+phone every five minutes with a link to your friend's PayPal account
+to deposit money if the weather's sunny and you both bet that it would
+be rainy. And the fun doesn't have to stop there.
+
+The RubyForge project page for this library is at
+http://rubyforge.org/projects/yahoo-weather.
+
+Source code is at http://github.com/shaper/yahoo-weather.
+
+NOTE: This library was updated as of December 2009 to use a new
+WOEID-based lookup interface.  Yahoo has deprecated the older
+non-WOEID-based lookup API.  The archived page with the deprecated API
+details is at:
+
+http://developer.yahoo.com/weather/archive.html
+
+The older interface is still operational but users of this library
+should shift from using YahooWeather::Client::lookup_location to
+YahooWeather::Client::lookup_by_woeid.
+
+== Installation
+
+Install +rubygems+ if you don't already have it.  See http://rubyforge.org/projects/rubygems/.
+
+Then install the gem by executing:
+
+ % gem install yahoo-weather
+
+== Usage
+
+A simple example program:
+
+ require 'rubygems'
+ require 'yahoo-weather'
+
+ @client = YahooWeather::Client.new
+ # look up WOEID via http://weather.yahoo.com; enter location by city
+ # name or zip and WOEID is at end of resulting page url.  herein we use
+ # the WOEID for Santa Monica, CA.
+ response = @client.lookup_by_woeid(2488892)
+
+ # straight text output
+ print <<edoc
+ #{response.title}
+ #{response.condition.temp} degrees
+ #{response.condition.text}
+ edoc
+
+ # sample html output
+ print <<edoc
+ <div>
+   <img src="#{response.image.url}"><br/>
+   #{response.condition.temp} degrees #{response.units.temperature}<br/>
+   #{response.condition.text}<br>
+   Forecast:<br/>
+   #{response.forecasts[0].day} - #{response.forecasts[0].text}.  High: #{response.forecasts[0].high} Low: #{response.forecasts[0].low}<br/>
+   #{response.forecasts[1].day} - #{response.forecasts[1].text}.  High: #{response.forecasts[1].high} Low: #{response.forecasts[1].low}<br/>
+   More information <a href="#{response.page_url}">here</a>.
+ </div>
+ edoc
+    
+Produces output as:
+
+ Conditions for Santa Monica, CA at 10:51 am PST
+ 56 degrees
+ Partly Cloudy
+ <div>
+   <img src="http://l.yimg.com/a/i/us/nws/th/main_142b.gif"><br/>
+   56 degrees F<br/>
+   Partly Cloudy<br>
+   Forecast:<br/>
+   Sat - Mostly Cloudy.  High: 59 Low: 46<br/>
+   Sun - Partly Cloudy.  High: 64 Low: 48<br/>
+   More information <a href="http://us.rd.yahoo.com/dailynews/rss/weather/Santa_Monica__CA/*http://weather.yahoo.com/forecast/USCA1024_f.html">here</a>.
+ </div>
+
+There is a variety of detailed weather information in other attributes of the
+YahooWeather::Response object.
+
+== License
+
+This library is provided via the GNU LGPL license at http://www.gnu.org/licenses/lgpl.html.
+
+== Author
+
+Copyright 2006 - 2009, Walter Korman <shaper@fatgoose.com>, 
+http://lemurware.blogspot.com.
+
+Thanks to Matthew Berk for inspiration and initial hack.

data/examples/demo.rb

@@ -0,0 +1,10 @@
+require_relative "lib/yahoo-weather.rb"
+require "pp"
+
+@client = YahooWeather::Client.new('LM816I7V34HgjIFkSrFhatjTI6G1ksJFWwOTVOVOpSssTUFnpRI9iNIijbuQPOaOFR_Y_EmFbPXk03XF45uLqchthxBXWuw')
+
+response = @client.lookup_zip(73072)
+
+pp response
+puts
+pp response.atmosphere

data/lib/yahoo-weather/astronomy.rb

@@ -0,0 +1,13 @@
+# Describes astronomy information for a particular location.
+class YahooWeather::Astronomy
+  # a Time object detailing the sunrise time for a location.
+  attr_reader :sunrise
+
+  # a Time object detailing the sunset time for a location.
+  attr_reader :sunset
+
+  def initialize (payload)
+    @sunrise = YahooWeather._parse_time(payload['sunrise'])
+    @sunset = YahooWeather._parse_time(payload['sunset'])
+  end
+end

data/lib/yahoo-weather/atmosphere.rb

@@ -0,0 +1,40 @@
+# Describes the specific atmospheric conditions at a location.
+class YahooWeather::Atmosphere
+  # Constants representing the state of the barometric pressure.
+  #
+  class Barometer
+    STEADY = 'steady'
+    RISING = 'rising'
+    FALLING = 'falling'
+
+    # lists all possible barometer constants
+    ALL = [ STEADY, RISING, FALLING ]
+  end
+
+  # the humidity of the surroundings.
+  attr_reader :humidity
+
+  # the visibility level of the surroundings
+  attr_reader :visibility
+
+  # the pressure level of the surroundings.
+  attr_reader :pressure
+
+  # the state of the barometer, defined as one of the
+  # YahooWeather::Atmosphere::Barometer constants.
+  attr_reader :barometer
+
+  def initialize (payload)
+    @humidity = payload['humidity'].to_i
+    @visibility = payload['visibility'].to_i
+    @pressure = payload['pressure'].to_f
+
+    # map barometric pressure direction to appropriate constant
+    @barometer = nil
+    case payload['rising'].to_i
+    when 0; @barometer = Barometer::STEADY
+    when 1; @barometer = Barometer::RISING
+    when 2; @barometer = Barometer::FALLING
+    end
+  end
+end

data/lib/yahoo-weather/client.rb

@@ -0,0 +1,73 @@
+# The main client object through which the Yahoo! Weather service may be accessed.
+class YahooWeather::Client
+  include HTTParty
+  
+  # the url with which we obtain weather information from yahoo
+  @@API_URL = "http://weather.yahooapis.com/forecastrss"
+  
+  # Uncomment and fill in below section for hard embedded connection
+  # @@APP_ID = "LIST_FREE_YAHOO_API_HERE"
+  
+  def initialize (app_id = @@APP_ID,api_url = @@API_URL)
+    @api_url = api_url
+    @app_id = app_id
+  end
+
+  # Returns a YahooWeather::Response object detailing the current weather
+  # information for the specified location.
+  #
+  # The lookup requires the unique WOEID for the location whose
+  # weather is sought.. To find your WOEID, browse or search for your
+  # city from the Weather (http://weather.yahoo.com/) home page. The
+  # WOEID is in the URL for the forecast page for that city. You can
+  # also get the WOEID by entering your zip code on the home page. For
+  # example, if you search for Los Angeles on the Weather home page,
+  # the forecast page for that city is
+  # http://weather.yahoo.com/united-states/california/los-angeles-2442047/. The
+  # WOEID is 2442047.
+  #
+  # +units+ allows specifying whether to retrieve information in
+  # +Fahrenheit+ as YahooWeather::Units::FAHRENHEIT, or +Celsius+ as
+  # YahooWeather::Units::CELSIUS, and defaults to fahrenheit.
+  #
+  def lookup_by_woeid (woeid, units = 'f')
+    url = @api_url + '?w=' + CGI.escape(woeid.to_s) + '&u=' + CGI.escape(units)
+    _lookup(woeid, url)
+  end
+
+  # Returns a YahooWeather::Response object detailing the current weather
+  # information for the specified location.
+  #
+  # +zip+ MUST BE A US ZIP CODE
+  #
+  # +units+ allows specifying whether to retrieve information in
+  # +Fahrenheit+ as YahooWeather::Units::FAHRENHEIT, or +Celsius+ as
+  # YahooWeather::Units::CELSIUS, and defaults to fahrenheit.
+  #
+  def lookup_zip(zip, units = 'f')
+    woeid = woe_lookup(zip)
+    lookup_by_woeid(woeid)
+  end
+
+  private
+
+    def _lookup (src, url)
+      begin
+        response = Net::HTTP.get_response(URI.parse(url)).body.to_s
+
+      rescue => e
+        raise RuntimeError.new("failed to get weather [src=#{src}, " +
+                               "url=#{url}, e=#{e}].")
+      end
+
+      # create the response object
+      doc = Nokogiri::XML.parse(response)
+      YahooWeather::Response.new(src, url, doc)
+    end
+    
+    def woe_lookup(zip)
+      p ydata = HTTParty.get("http://where.yahooapis.com/v1/places.q('#{zip}')?appid=[#{@app_id}]")
+      woe_id = ydata["places"]["place"]["woeid"]
+    end
+
+end

data/lib/yahoo-weather/condition.rb

@@ -0,0 +1,20 @@
+class YahooWeather::Condition
+  # the Yahoo! Weather condition code, as detailed at http://developer.yahoo.com/weather.
+  attr_reader :code
+
+  # the date and time associated with these conditions.
+  attr_reader :date
+
+  # the temperature of the location.
+  attr_reader :temp
+
+  # the brief prose text description of the weather conditions of the location.
+  attr_reader :text
+
+  def initialize (payload)
+    @code = payload['code'].to_i
+    @date = YahooWeather._parse_time(payload['date'])
+    @temp = payload['temp'].to_i
+    @text = payload['text']
+  end
+end

data/lib/yahoo-weather/forecast.rb

@@ -0,0 +1,29 @@
+# The forecasted weather conditions for a specific location.
+class YahooWeather::Forecast
+  # the brief name of the day associated with the forecast.
+  attr_reader :day
+
+  # the date associated with the forecast.
+  attr_reader :date
+
+  # the low temperature forecasted.
+  attr_reader :low
+
+  # the high temperature forecasted.
+  attr_reader :high
+
+  # the brief prose text description of the forecasted weather conditions.
+  attr_reader :text
+
+  # the Yahoo! Weather code associated with the forecast, per http://developer.yahoo.com/weather.
+  attr_reader :code
+
+  def initialize (payload)
+    @day = payload['day']
+    @date = YahooWeather._parse_time(payload['date'])
+    @low = payload['low'].to_i
+    @high = payload['high'].to_i
+    @text = payload['text']
+    @code = payload['code'].to_i
+  end
+end

data/lib/yahoo-weather/image.rb

@@ -0,0 +1,25 @@
+class YahooWeather::Image
+  # the height of the image in pixels.
+  attr_reader :height
+
+  # the url intended to be used as a link wrapping the image, for
+  # instance, to send the user to the main Yahoo Weather home page.
+  attr_reader :link
+
+  # the title of hte image.
+  attr_reader :title
+
+  # the full url to the image.
+  attr_reader :url
+
+  # the width of the image in pixels.
+  attr_reader :width
+
+  def initialize (payload)
+    @title = payload.xpath('title').first.content
+    @link = payload.xpath('link').first.content
+    @url = payload.xpath('url').first.content
+    @height = payload.xpath('height').first.content.to_i
+    @width = payload.xpath('width').first.content.to_i
+  end
+end

data/lib/yahoo-weather/location.rb

@@ -0,0 +1,17 @@
+# Describes a geographical location.
+class YahooWeather::Location
+  # the name of the city.
+  attr_reader :city
+
+  # the name of the country.
+  attr_reader :country
+
+  # the name of the region, such as a state.
+  attr_reader :region
+
+  def initialize (payload)
+    @city = payload['city']
+    @country = payload['country']
+    @region = payload['region']
+  end
+end

data/lib/yahoo-weather/response.rb

@@ -0,0 +1,85 @@
+# Describes the weather conditions for a particular requested location.
+class YahooWeather::Response
+  # a YahooWeather::Astronomy object detailing the sunrise and sunset
+  # information for the requested location.
+  attr_reader :astronomy
+
+  # a YahooWeather::Location object detailing the precise geographical names
+  # to which the requested location was mapped.
+  attr_reader :location
+
+  # a YahooWeather::Units object detailing the units corresponding to the
+  # information detailed in the response.
+  attr_reader :units
+
+  # a YahooWeather::Wind object detailing the wind information at the
+  # requested location.
+  attr_reader :wind
+
+  # a YahooWeather::Atmosphere object detailing the atmosphere information
+  # of the requested location.
+  attr_reader :atmosphere
+
+  # a YahooWeather::Condition object detailing the current conditions of the
+  # requested location.
+  attr_reader :condition
+
+  # a list of YahooWeather::Forecast objects detailing the high-level
+  # forecasted weather conditions for upcoming days.
+  attr_reader :forecasts
+
+  # the raw HTML generated by the Yahoo! Weather service summarizing current
+  # weather conditions for the requested location.
+  attr_reader :description
+
+  # a YahooWeather::Image record describing an image icon
+  # representing the current weather.
+  attr_reader :image
+
+  # the latitude of the location for which weather is detailed.
+  attr_reader :latitude
+
+  # the longitude of the location for which weather is detailed.
+  attr_reader :longitude
+
+  # a link to the Yahoo! Weather page with full detailed information on the
+  # requested location's current weather conditions.
+  attr_reader :page_url
+
+  # the location string initially requested of the service.
+  attr_reader :request_location
+
+  # the url with which the Yahoo! Weather service was accessed to build the response.
+  attr_reader :request_url
+
+  # the prose descriptive title of the weather information.
+  attr_reader :title
+
+  def initialize (request_location, request_url, doc)
+    # save off the request params
+    @request_location = request_location
+    @request_url = request_url
+
+    # parse the nokogiri xml document to gather response data
+    root = doc.xpath('/rss/channel').first
+
+    @astronomy = YahooWeather::Astronomy.new(root.xpath('yweather:astronomy').first)
+    @location = YahooWeather::Location.new(root.xpath('yweather:location').first)
+    @units = YahooWeather::Units.new(root.xpath('yweather:units').first)
+    @wind = YahooWeather::Wind.new(root.xpath('yweather:wind').first)
+    @atmosphere = YahooWeather::Atmosphere.new(root.xpath('yweather:atmosphere').first)
+    @image = YahooWeather::Image.new(root.xpath('image').first)
+
+    item = root.xpath('item').first
+    @condition = YahooWeather::Condition.
+      new(item.xpath('yweather:condition').first)
+    @forecasts = []
+    item.xpath('yweather:forecast').each { |forecast| 
+      @forecasts << YahooWeather::Forecast.new(forecast) }
+    @latitude = item.xpath('geo:lat').first.content.to_f
+    @longitude = item.xpath('geo:long').first.content.to_f
+    @page_url = item.xpath('link').first.content
+    @title = item.xpath('title').first.content
+    @description = item.xpath('description').first.content
+  end
+end

data/lib/yahoo-weather/units.rb

@@ -0,0 +1,24 @@
+# Describes the units of measure with which weather information is provided.
+class YahooWeather::Units
+  FAHRENHEIT = 'f'
+  CELSIUS = 'c'
+
+  # the units in which temperature is measured, e.g. +F+ for +Fahrenheit+ or +C+ for +Celsius+.
+  attr_reader :temperature
+
+  # the units in which distance is measured, e.g. +mi+ for +miles+.
+  attr_reader :distance
+
+  # the units in which pressure is measured, e.g. +in+ for +inches+.
+  attr_reader :pressure
+
+  # the units in which speed is measured, e.g. +mph+ for <tt>miles per hour</tt>.
+  attr_reader :speed
+
+  def initialize (payload)
+    @temperature = payload['temperature']
+    @distance = payload['distance']
+    @pressure = payload['pressure']
+    @speed = payload['speed']
+  end
+end

data/lib/yahoo-weather/wind.rb

@@ -0,0 +1,17 @@
+# Describes the specific wind conditions at a location.
+class YahooWeather::Wind
+  # the temperature factoring in wind chill.
+  attr_reader :chill
+
+  # the direction of the wind in degrees.
+  attr_reader :direction
+
+  # the speed of the wind.
+  attr_reader :speed
+
+  def initialize (payload)
+    @chill = payload['chill'].to_i
+    @direction = payload['direction'].to_i
+    @speed = payload['speed'].to_i
+  end
+end

data/lib/ywx.rb

@@ -22,7 +22,7 @@ require 'nokogiri'
 require "httparty"
 
 class YahooWeather
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 
   def self._parse_time (text)
     (text) ? Time.parse(text) : nil

data/test/test_api.rb

@@ -0,0 +1,140 @@
+require 'rubygems'
+require 'test/unit'
+require 'yahoo-weather'
+
+class TestAPI < Test::Unit::TestCase
+  def setup
+    @client = YahooWeather::Client.new
+  end
+
+  def test_lookup_zip
+    # check a seattle, wa zipcode
+    request_location = '98103'
+    response = @client.lookup_location(request_location)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::FAHRENHEIT,
+                           'Seattle', 'WA', 'US')
+  end
+
+  def test_units
+    request_location = '10001'
+    city = 'New York'
+    region = 'NY'
+    country = 'US'
+
+    # check explicitly specifying fahrenheit units
+    response = @client.lookup_location(request_location, 
+                                       YahooWeather::Units::FAHRENHEIT)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::FAHRENHEIT, 
+                           city, region, country)
+
+    # check alternate units
+    response = @client.lookup_location(request_location, 
+                                       YahooWeather::Units::CELSIUS)
+    _assert_valid_response(response, request_location, 
+                           YahooWeather::Units::CELSIUS, 
+                           city, region, country)
+  end
+
+  def test_lookup_by_woeid
+    woeid_sf = '12797168'
+    response = @client.lookup_by_woeid(woeid_sf)
+    _assert_valid_response(response, woeid_sf, 
+                           YahooWeather::Units::FAHRENHEIT,
+                           'San Francisco', 'CA', 'United States')
+  end
+
+  private
+
+    def _assert_valid_response (response, request_location, units, 
+                                city, region, country)
+      assert_not_nil response
+
+      # check the request location and url explicitly against what we
+      # know they should be
+      assert_equal response.request_location, request_location
+      assert_match(/http:\/\/weather\.yahooapis\.com\/forecastrss\?[pw]=#{request_location}&u=#{units}/, response.request_url)
+
+      # check the astronomy info
+      assert_instance_of YahooWeather::Astronomy, response.astronomy
+      assert_instance_of Time, response.astronomy.sunrise
+      assert_instance_of Time, response.astronomy.sunset
+      assert(response.astronomy.sunrise < response.astronomy.sunset)
+
+      # check the location
+      assert_instance_of YahooWeather::Location, response.location
+      assert_equal response.location.city, city
+      assert_equal response.location.region, region
+      assert_equal response.location.country, country
+
+      # check the default units
+      _assert_valid_units(response.units, 
+                          (units == YahooWeather::Units::FAHRENHEIT))
+
+      # check the wind info
+      assert_instance_of YahooWeather::Wind, response.wind
+      assert(response.wind.chill <= response.condition.temp)
+      assert_kind_of Numeric, response.wind.direction
+      assert_kind_of Numeric, response.wind.speed
+
+      # check the atmosphere info
+      assert_instance_of YahooWeather::Atmosphere, response.atmosphere
+      assert_kind_of Numeric, response.atmosphere.humidity
+      assert_kind_of Numeric, response.atmosphere.visibility
+      assert_kind_of Numeric, response.atmosphere.pressure
+      assert(YahooWeather::Atmosphere::Barometer::ALL.include?(response.atmosphere.barometer))
+
+      # check the condition info
+      assert_instance_of YahooWeather::Condition, response.condition
+      _assert_valid_weather_code response.condition.code
+      assert_instance_of Time, response.condition.date
+      assert_kind_of Numeric, response.condition.temp
+      assert(response.condition.text && response.condition.text.length > 0)
+
+      # check the forecast info
+      assert_not_nil response.forecasts
+      assert_kind_of Array, response.forecasts
+      assert_equal response.forecasts.length, 2
+      response.forecasts.each do |forecast|
+        assert_instance_of YahooWeather::Forecast, forecast
+        assert(forecast.day && forecast.day.length == 3)
+        assert_instance_of Time, forecast.date
+        assert_kind_of Numeric, forecast.low
+        assert_kind_of Numeric, forecast.high
+        assert(forecast.low <= forecast.high)
+        assert(forecast.text && forecast.text.length > 0)
+        _assert_valid_weather_code forecast.code
+      end
+
+      # check the basic attributes
+      assert(response.description && response.description.length > 0)
+      assert(response.image.url =~ /yimg\.com/)
+      assert_kind_of Numeric, response.latitude
+      assert_kind_of Numeric, response.longitude
+      assert(response.page_url =~ /\.html$/)
+      assert(response.title && response.title.length > 0)
+      assert_not_nil(response.title.index("#{response.location.city}, #{response.location.region}"))
+    end
+
+    def _assert_valid_weather_code (code)
+      (((code >= 0) && (code <= 47)) || (code == 3200))
+    end
+
+    def _assert_valid_units (units, fahrenheit_based)
+      assert_instance_of YahooWeather::Units, units
+      if fahrenheit_based
+        assert_equal units.temperature, 'F'
+        assert_equal units.distance, 'mi'
+        assert_equal units.pressure, 'in'
+        assert_equal units.speed, 'mph'
+
+      else
+        assert_equal units.temperature, 'C'
+        assert_equal units.distance, 'km'
+        assert_equal units.pressure, 'mb'
+        assert_equal units.speed, 'km/h'
+      end
+    end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ywx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.rdoc
+- examples/demo.rb
+- lib/yahoo-weather/astronomy.rb
+- lib/yahoo-weather/atmosphere.rb
+- lib/yahoo-weather/client.rb
+- lib/yahoo-weather/condition.rb
+- lib/yahoo-weather/forecast.rb
+- lib/yahoo-weather/image.rb
+- lib/yahoo-weather/location.rb
+- lib/yahoo-weather/response.rb
+- lib/yahoo-weather/units.rb
+- lib/yahoo-weather/wind.rb
 - lib/ywx.rb
+- LICENSE
+- Gemfile
+- README.rdoc
+- test/test_api.rb
 homepage: https://github.com/aspires/ywx
 licenses: []
 post_install_message: