google-video 0.6.0 → 0.7.0

data/CHANGELOG

@@ -1,24 +1,60 @@
-* 2006/11/16
+= 2006/12/05
 
-- [shaper] renamed Video#yesterday_view_count to 
+* [shaper] Handle searches with no results more gracefully, returning
+  a VideoSearchResponse with attributes set appropriately, versus 
+  previous behavior wherein an exception would report that statistics
+  could not be parsed.
+
+* [shaper] Add support for specifying the number of results per page 
+  to retrieve with video search requests, and a constant to access 
+  the maximum number of results per page.
+  
+* [shaper] Added a copy of the full text of the LGPL which was
+  accidentally missing from earlier releases.
+
+* [shaper] Optimized our Hpricot::Elem.all_text to concatenate to a
+  single string rather than allocating a new one as text is built up.
+
+* [shaper] Switch to class constants rather than member data for
+  things like default width/height, host, and user agent.
+
+* [shaper] Revised standard record initialization of our many record
+  objects via hash params to make use of a shared base Record class.
+
+* [shaper] HTML-decode upload user text.
+
+* [shaper] Switch to using DateTime for the upload date rather than Time
+  since the upload date is user-specificiable and is at least sometimes
+  treated more as "the date associated with the video content" than it
+  is an upload date, e.g., a video from the 1950s may have a date in
+  the 1950s in this field, which is incompatible with the Time object
+  which is bound by the standard 1970-based epoch seconds.
+
+* [shaper] Fixed bug where we destructively modified the video search
+  request query string which could result in user surprise down the
+  line should the same request be modified or re-used subsequently.
+
+= 2006/11/16
+
+* [shaper] renamed Video#yesterday_view_count to 
   Video#view_count_yesterday for consistency, and aliased to maintain
   backwards-compatibility.
 
-- [shaper] Updated to reflect video detail page edits:
-  + parse new metrics on email and embed count/rank for today and yesterday
-  + correct parsing to accurately grab from new layout of rank and view 
+* [shaper] Updated to reflect video detail page edits:
+  * parse new metrics on email and embed count/rank for today and yesterday
+  * correct parsing to accurately grab from new layout of rank and view 
     count for today and yesterday
-  + turned Video#rank_delta into a method that returns the delta between
+  * turned Video#rank_delta into a method that returns the delta between
     yesterday and today's rank.
 
-- [shaper] Updated hpricot usage for brevity: use Element#[] for referencing
+* [shaper] Updated hpricot usage for brevity: use Element#[] for referencing
   attributes and Element#% for slicing out elements where we know there
   can be only one.
 
-- [shaper] Fixed typo in rdoc for VideoSearchResponse.
+* [shaper] Fixed typo in rdoc for VideoSearchResponse.
 
-- [shaper] Optimized string building for URLs and the like.
+* [shaper] Optimized string building for URLs and the like.
 
-* 2006/11/07
+= 2006/11/07
 
-- [shaper] Initial version.
+* [shaper] Initial version.

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/Rakefile

@@ -6,17 +6,17 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'google-video'
-  s.version = '0.6.0'
+  s.version = '0.7.0'
   s.author = 'Walter Korman'
   s.email = 'shaper@wgks.org'
   s.platform = Gem::Platform::RUBY
   s.summary = 'A Ruby object-oriented interface to Google Video content.'
   s.rubyforge_project = 'google-video'
   s.has_rdoc = true
-  s.extra_rdoc_files = [ 'README' ]
+  s.extra_rdoc_files = [ 'README', 'CHANGELOG' ]
   s.rdoc_options << '--main' << 'README'
   s.test_files = Dir.glob('test/test_*.rb')
-  s.files = Dir.glob("{examples,lib,test}/**/*") + [ 'AUTHORS', 'CHANGELOG', 'README', 'Rakefile', 'TODO' ]
+  s.files = Dir.glob("{examples,lib,test}/**/*") + [ 'AUTHORS', 'CHANGELOG', 'LICENSE', 'README', 'Rakefile', 'TODO' ]
   s.add_dependency("hpricot", ">= 0.4")
   s.add_dependency("htmlentities", ">= 3.0.1")
 end
@@ -33,7 +33,7 @@ end
 desc 'Generate RDoc'
 Rake::RDocTask.new :rdoc do |rd|
   rd.rdoc_dir = 'doc'
-  rd.rdoc_files.add 'lib', 'README'
+  rd.rdoc_files.add 'lib', 'README', 'CHANGELOG'
   rd.main = 'README'
 end
 

data/lib/google-video.rb

@@ -18,7 +18,7 @@
 require 'open-uri'
 require 'hpricot'
 require 'htmlentities'
-require 'time'
+require 'date'
 
 # Extension to Hpricot for our own parsing purposes.
 class Hpricot::Elem
@@ -28,7 +28,7 @@ class Hpricot::Elem
   # have to go it alone.
   def all_text
     text = ''
-    each_child { |c| text += c.to_s if c.is_a?(Hpricot::Text) }
+    each_child { |c| text << c.to_s if c.is_a?(Hpricot::Text) }
     text
   end
 end
@@ -42,8 +42,23 @@ module GoogleVideo
     end
   end
 
-  # Describes a single video file available for viewing on Google Video.
-  class Video
+  # A generic record that initializes instance variables from the supplied hash
+  # mapping symbol names to their respective values.
+  class Record
+    def initialize (params)
+      if params != nil
+        params.each do |key, value| 
+          name = key.to_s
+          instance_variable_set("@#{name}", value) if respond_to?(name)
+        end
+      end
+    end
+  end
+  
+  # Describes a single video file available for viewing on Google Video. 
+  # Parameters are specified via a hash passed to the object on construction
+  # mapping attribute names to their respective values.
+  class Video < Record
     # the prose text describing the video contents.
     attr_reader :description
     
@@ -136,15 +151,15 @@ module GoogleVideo
     attr_reader :view_count_embed
 
     # the default width in pixels for the video embed html.
-    @@DEFAULT_WIDTH = 400
+    DEFAULT_WIDTH = 400
 
     # the default height in pixels for the video embed html.
-    @@DEFAULT_HEIGHT = 326
+    DEFAULT_HEIGHT = 326
 
     # Constructs a Video with the supplied hash mapping attribute names to
     # their respective values.
     def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
+      super(params)
 
       # pull the doc id out of the page url if we've got one
       if (@page_url)
@@ -156,7 +171,7 @@ module GoogleVideo
     # Returns HTML suitable for embedding this video in a web page with the
     # video occupying the specified dimensions.  The generated html matches
     # that which is provided by the Google Video web site embed instructions.
-    def embed_html (width = @@DEFAULT_WIDTH, height = @@DEFAULT_HEIGHT)
+    def embed_html (width = DEFAULT_WIDTH, height = DEFAULT_HEIGHT)
       <<edoc
 <embed style="width:#{width}px; height:#{height}px;" id="VideoPlayback" type="application/x-shockwave-flash" 
  src="http://video.google.com/googleplayer.swf?docId=#{@doc_id}&hl=en" flashvars=""> </embed>
@@ -175,22 +190,22 @@ edoc
   # the actual Google Video site these are linked to auto-pan the video to the
   # start of the scene represented in the thumbnail, but for us there's no
   # direct link of meaning so we've only got static content which is
-  # nevertheless of potential interest and utility.
-  class VideoFrameThumbnail
+  # nevertheless of potential interest and utility. Parameters are specified
+  # via a hash passed to the object on construction mapping attribute names to
+  # their respective values.
+  class VideoFrameThumbnail < Record
     # the title of the video frame, e.g. "at 10 secs", "at 30 secs", etc.
     attr_reader :title
     
     # the full url to the video frame thumbnail image.
     attr_reader :thumbnail_image_url
-
-    def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
-    end
   end
 
   # Describes an alternate video as listed in the "Playlist" tab for a
-  # particular video's detailed view page.
-  class PlaylistEntry
+  # particular video's detailed view page.  Parameters are specified via a
+  # hash passed to the object on construction mapping attribute names to their
+  # respective values.
+  class PlaylistEntry < Record
     # the title of the video.
     attr_reader :title
     
@@ -205,14 +220,12 @@ edoc
 
     # the full url at which the video is available for viewing.
     attr_reader :page_url
-
-    def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
-    end
   end
 
-  # Describes an entry on the "top videos" page.
-  class TopVideo
+  # Describes an entry on the "top videos" page.  Parameters are specified via a
+  # hash passed to the object on construction mapping attribute names to their
+  # respective values.
+  class TopVideo < Record
     # the direction the entry moved from the previous day to today: 0 for no
     # change, 1 for moving up, -1 for moving down.
     attr_reader :movement
@@ -225,16 +238,12 @@ edoc
     
     # the entry's video details as a Video object.
     attr_reader :video
-
-    # Constructs a TopVideo with the supplied hash mapping attribute names to
-    # their respective values.
-    def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
-    end
   end
 
   # Describes a request for the current list of top videos on Google Video.
-  class TopVideosRequest
+  # Parameters are specified via a hash passed to the object on construction
+  # mapping attribute names to their respective values.
+  class TopVideosRequest < Record
     # the list of countries by which one can constrain a search for top videos
     COUNTRIES = {
       'All' => 'all',
@@ -291,7 +300,7 @@ edoc
     # Constructs a TopVideosRequest with an optional supplied hash mapping
     # attribute names to their respective values.
     def initialize (params = nil)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) } if (params)
+      super(params)
       
       # validate request parameters
       if @country && !COUNTRIES.include?(@country)
@@ -300,24 +309,25 @@ edoc
     end
   end
 
-  # Describes a response from Google Video providing a list of current top videos.
-  class TopVideosResponse
+  # Describes a response from Google Video providing a list of current top videos.  
+  # Parameters are specified via a hash passed to the object on construction
+  # mapping attribute names to their respective values.
+  class TopVideosResponse < Record
     # the url with which the request was made of the Google Video service.
     attr_reader :request_url
 
     # the list of Video objects comprising the search results.
     attr_reader :videos
-    
-    # Constructs a TopVideosResponse with the supplied hash mapping attribute
-    # names to their respective values.
-    def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
-    end
   end
 
+  # the maximum number of results that can be requested per page in a
+  # VideoSearchRequest.
+  MAX_RESULTS_PER_PAGE = 100
+
   # Describes a search request for videos matching the specified parameters on
-  # Google Video.
-  class VideoSearchRequest
+  # Google Video. Parameters are specified via a hash passed to the object on
+  # construction mapping attribute names to their respective values.
+  class VideoSearchRequest < Record
     # the list of valid sort parameters.
     SORT_OPTIONS = [ 'relevance', 'rating', 'date', 'title' ]
 
@@ -337,11 +347,15 @@ edoc
     
     # optional: the page number of results sought, defaulting to 1.
     attr_reader :page
-    
+
+    # optional: the number of results to display per page, defaulting to 10
+    # and at most 100.
+    attr_reader :results_per_page
+
     # Constructs a VideoSearchRequest with the supplied hash mapping attribute
     # names to their respective values.
     def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
+      super(params)
       
       # validate request parameters
       if @sort && !SORT_OPTIONS.include?(@sort);
@@ -356,8 +370,10 @@ edoc
     end
   end
 
-  # Describes a response to a VideoSearchRequest.
-  class VideoSearchResponse
+  # Describes a response to a VideoSearchRequest.  Parameters are specified
+  # via a hash passed to the object on construction mapping attribute names to
+  # their respective values.
+  class VideoSearchResponse < Record
     # the url with which the request was made of the Google Video service.
     attr_reader :request_url
     
@@ -375,18 +391,14 @@ edoc
     
     # the list of Video objects comprising the search results.
     attr_reader :videos
-
-    # Constructs a VideoSearchResponse with the supplied hash mapping
-    # attribute names to their respective values.
-    def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
-    end
   end
 
   # Describes a request of the Google Video service for details on a specific
   # previously retrieved Video or its stored +doc_id+.  Only one of either
-  # +video+ or +doc_id+ should be specified in the request.
-  class VideoDetailsRequest
+  # +video+ or +doc_id+ should be specified in the request. Parameters are
+  # specified via a hash passed to the object on construction mapping
+  # attribute names to their respective values.
+  class VideoDetailsRequest < Record
     # the Video object whose details are sought.
     attr_reader :video
 
@@ -396,7 +408,7 @@ edoc
     # Constructs a VideoDetailsRequest with the supplied hash mapping
     # attribute names to their respective values.
     def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
+      super(params)
       
       # validate request parameters
       if !@video && !@doc_id
@@ -414,29 +426,33 @@ edoc
     end
   end
 
-  # Describes a response to a VideoDetailsRequest.
-  class VideoDetailsResponse
+  # Describes a response to a VideoDetailsRequest. Parameters are specified
+  # via a hash passed to the object on construction mapping attribute names to
+  # their respective values.
+  class VideoDetailsResponse < Record
     # the url with which the request was made of the Google Video service.
     attr_reader :request_url
 
     # the new Video object providing full detailed information.
     attr_reader :video
-
-    # Constructs a VideoDetailsResponse with the supplied hash mapping
-    # attribute names to their respective values.
-    def initialize (params)
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) }
-    end
   end
 
   # The main client object providing interface methods for retrieving
-  # information from the Google Video server.
-  class Client
+  # information from the Google Video server.  Parameters are specified via a
+  # hash passed to the object on construction mapping attribute names to their
+  # respective values.
+  class Client < Record
+    # the hostname queried to retrieve google video content.
+    attr_reader :host
+    
+    # the user agent submitted with http requests of google video.
+    attr_reader :agent
+    
     # the default hostname queried to retrieve google video content.
-    @@DEFAULT_HOST = 'video.google.com'
+    DEFAULT_HOST = 'video.google.com'
 
     # the default user agent submitted with http requests of google video.
-    @@DEFAULT_AGENT = 'google-video for Ruby (http://www.rubyforge.org/projects/google-video/)'
+    DEFAULT_AGENT = 'google-video for Ruby (http://www.rubyforge.org/projects/google-video/)'
 
     # Constructs a Client for querying the Google Video server.  Optional
     # parameters to be specified as a hash include:
@@ -444,9 +460,10 @@ edoc
     # * agent: optional alternate user agent to submit with http requests
     #   instead of the default agent.
     def initialize (params = nil)
-      @host = @@DEFAULT_HOST
-      @agent = @@DEFAULT_AGENT
-      params.each { |key, value| instance_variable_set('@' + key.to_s, value) } if params
+      super(params)
+
+      @host = DEFAULT_HOST if (!@host)
+      @agent = DEFAULT_AGENT if (!@agent)
     end
 
     # Runs a search query on Google Video with the parameters specified in the
@@ -463,9 +480,27 @@ edoc
       doc = Hpricot(response)
 
       # parse the overall search query stats
-      regexp_stats = Regexp.new(/([0-9,]+) \- ([0-9,]+)<\/b> of about <b>([0-9,]+)<\/b> \(<b>([0-9.]+)/)
       row = (doc%"#resultsheadertable/tr/td/font")
-      if !regexp_stats.match(row.inner_html)
+      stats_html = row.inner_html
+
+      # see if we've got no results
+      regexp_no_results = Regexp.new(/No results \(<b>([0-9.]+)/)
+      if regexp_no_results.match(stats_html)
+        execution_time = $1.to_f
+        # nothing doing, so return a simplified response and we're done
+        return VideoSearchResponse.new(:request_url => url,
+                                       :start_index => 0,
+                                       :end_index => 0,
+                                       :total_result_count => 0,
+                                       :execution_time => execution_time,
+                                       :videos => Array.new)
+      end
+
+      # pull out the actual stats now that we know we can
+      regexp_stats = Regexp.new(/([0-9,]+) \- ([0-9,]+)<\/b> of about <b>([0-9,]+)<\/b> \(<b>([0-9.]+)/)
+      if !regexp_stats.match(stats_html)
+        # simple sanity-check here, even though we don't bother below, since if this 
+        # doesn't work nothing else is likely to operate properly
         raise GoogleVideoException.new("failed to parse search query stats")
       end
       ( start_index, end_index, total_result_count, execution_time ) = [ $1.to_i, $2.to_i, $3.to_i, $4.to_f ]
@@ -489,7 +524,7 @@ edoc
         span_channel = (row%"span[@class='channel']")
         channel_html = (span_channel) ? span_channel.inner_html : ''
         channel_html =~ /([^\-]+)/
-        upload_user = _clean_string($1)
+        upload_user = _decode_html(_clean_string($1))
 
         # stars
         star_count = _parse_star_elements(row/"img[@class='star']")
@@ -503,7 +538,7 @@ edoc
         date_html = span_date.inner_html
         date_html =~ /([^\-]+) \- (.*)$/
         duration = _clean_string($1)
-        upload_date = Time.parse(_clean_string($2))
+        upload_date = _parse_date(_clean_string($2))
         
         # construct the video object and tack it onto the video result list
         videos << Video.new(:title => title,
@@ -576,7 +611,7 @@ edoc
         duration_upload_html = duration_parts[0]
         upload_user_domain = duration_parts[1]
       else
-        upload_user = _clean_string(duration_parts[0])
+        upload_user = _decode_html(_clean_string(duration_parts[0]))
         duration_upload_html = duration_parts[1]        
         upload_user_domain = duration_parts[2]
       end
@@ -584,7 +619,7 @@ edoc
       # parse the duration and upload date
       ( duration, upload_date ) = duration_upload_html.split(/\-/)
       duration = _clean_string(duration)
-      upload_date = Time.parse(_clean_string(upload_date))
+      upload_date = _parse_date(_clean_string(upload_date))
 
       # parse the upload user url and domain if present
       if (upload_user_domain =~ /<a.*?href="([^"]+)"[^>]+>([^<]+)<\/a>/)
@@ -741,6 +776,22 @@ edoc
 
     private
 
+    # Parses the supplied date string via <tt>DateTime.parse</tt> and returns
+    # the resulting DateTime object if successful or nil if not.  We have to
+    # use DateTime rather than Time since Google's "upload date" is actually
+    # more like "the date that the video is intended to represent", and is
+    # apparently user-specifiable, as we discovered once running enough
+    # queries to hit upon a few such videos and finding some pre-1970 dates.
+    def _parse_date (time)
+      DateTime.parse(time)
+    rescue ArgumentError => e
+      # XXX should we log our report a failure if we can't parse the date
+      # instead of silently returning nil?
+      # STDERR.print "failed to parse #{time}: #{$!}\n"
+      # STDERR.print e.backtrace.join("\n") + "\n"
+      nil
+    end
+
     # Breakout method used by Client#video_details to make things more
     # manageable, returning a tuple as (view count, rank) for the supplied
     # data row within the "statsall" div element's statistics table.
@@ -840,7 +891,7 @@ edoc
     end
 
     def _search_url (search_request)
-      query = search_request.query
+      query = search_request.query.clone
       if (search_request.duration && search_request.duration != 'all')
         query.concat "+duration:#{search_request.duration}"
       end
@@ -855,6 +906,10 @@ edoc
         url.concat "&so=#{URI.encode(search_request.sort)}"
       end
 
+      if (search_request.results_per_page)
+        url.concat "&num=#{URI.encode(search_request.results_per_page.to_s)}"
+      end
+
       url
     end
 

data/test/test_video_details.rb

@@ -8,7 +8,8 @@ class TestVideoDetails < Test::Unit::TestCase
 
   @@QUERY = 'christina ricci'
   @@DOC_ID = 5338330163635012030
-
+  @@OLD_DATE_DOC_ID = 6020302018400450975
+  
   def setup
     @client = GoogleVideo::Client.new
   end
@@ -61,6 +62,16 @@ class TestVideoDetails < Test::Unit::TestCase
     response = @client.video_details request
     assert_valid_video_detail_response(response)
   end
+  
+  # make sure we can successfully parse dates before the typical 1970 epoch,
+  # since we've found the upload date is user-specifiable and some folks use
+  # it to specify the date associated with the video content, e.g. videos from
+  # 1894 or 1950.
+  def test_video_details_upload_date
+    request = GoogleVideo::VideoDetailsRequest.new(:doc_id => @@OLD_DATE_DOC_ID)
+    response = @client.video_details request
+    assert_valid_video_detail_response(response)
+  end
 
   # TODO: test the three variants of possible "durationetc" span parsing
 
@@ -100,7 +111,7 @@ class TestVideoDetails < Test::Unit::TestCase
     assert_kind_of Numeric, video.view_count_email
     assert_kind_of Numeric, video.view_count_embed
     assert_equal video.view_count_yesterday, video.yesterday_view_count
-    assert_instance_of Time, video.upload_date
+    assert_instance_of DateTime, video.upload_date
 
     # check the video frame thumbnails
     assert (video.video_frame_thumbnails && video.video_frame_thumbnails.length > 0)

data/test/test_video_search.rb

@@ -8,6 +8,7 @@ class TestVideoSearch < Test::Unit::TestCase
   
   @@RESULTS_PER_PAGE = 10
   @@QUERY_STRING = 'tessa'
+  @@NO_RESULTS_QUERY_STRING = 'slingo-blahblahblah'
   @@DURATION = 'long'
   @@PAGE = 2
 
@@ -80,6 +81,26 @@ class TestVideoSearch < Test::Unit::TestCase
     assert_equal response.end_index, ((response.total_result_count < max_result_index) ? response.total_result_count : max_result_index)
   end
   
+  def test_search_results_per_page
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@QUERY_STRING, :results_per_page => GoogleVideo::MAX_RESULTS_PER_PAGE)
+    response = @client.video_search request
+    assert_valid_search_response response
+    
+    assert_equal response.videos.length, GoogleVideo::MAX_RESULTS_PER_PAGE
+  end
+
+  def test_search_no_results
+    request = GoogleVideo::VideoSearchRequest.new(:query => @@NO_RESULTS_QUERY_STRING)
+    response = @client.video_search request
+    assert_valid_search_response response
+    
+    assert_instance_of Float, response.execution_time
+    assert_equal response.start_index, 0
+    assert_equal response.end_index, 0
+    assert_equal response.total_result_count, 0
+    assert_equal response.videos.length, 0
+  end
+  
   def assert_valid_search_response (response)
     assert_not_nil response
     assert_valid_google_video_url response.request_url

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: google-video
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
-date: 2006-11-16 00:00:00 -08:00
+  version: 0.7.0
+date: 2006-12-05 00:00:00 -08:00
 summary: A Ruby object-oriented interface to Google Video content.
 require_paths: 
 - lib
@@ -41,6 +41,7 @@ files:
 - test/video_test_helper.rb
 - AUTHORS
 - CHANGELOG
+- LICENSE
 - README
 - Rakefile
 - TODO
@@ -54,6 +55,7 @@ rdoc_options:
 - README
 extra_rdoc_files: 
 - README
+- CHANGELOG
 executables: []
 
 extensions: []