yahoo-video 0.1.0

data/AUTHORS

@@ -0,0 +1 @@
+Walter Korman <shaper@wgks.org>

data/CHANGELOG

@@ -0,0 +1,3 @@
+* 2006/12/05
+
+- [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/README

@@ -0,0 +1,54 @@
+= Yahoo! Video
+
+A Ruby object-oriented interface to the video content available on Yahoo! Video at http://video.yahoo.com.
+
+The RubyForge project is at http://rubyforge.org/projects/yahoo-video.
+
+== About
+
+This library builds on top of the Yahoo! Video REST API as documented at http://developer.yahoo.com/search/video/V1/videoSearch.html.  All of the relevant Yahoo! Video search parameters are supported.
+
+See also the YouTube[http://rubyforge.org/projects/youtube] and Google Video[http://google-video.rubyforge.org] Ruby libraries.
+
+== Installing
+
+We recommend installing <tt>yahoo-video</tt> via rubygems[http://rubyforge.org/projects/rubygems/] (see also http://www.rubygems.org).
+
+Once you have +rubygems+ installed on your system, you can easily install the <tt>yahoo-video</tt> gem by executing:
+
+  % gem install --include-dependencies yahoo-video
+
+== Usage
+
+You will need an application id from Yahoo to make use of the service.  Ids can be obtained from Yahoo's registration page at http://api.search.yahoo.com/webservices/register_application.
+
+Instantiate a YahooVideo::Client, create and configure a YahooVideo::SearchRequest record, and use YahooVideo::Client#search to make requests of the Yahoo! Video server.  See method and record documentation for links and more information.
+
+An example program showing a simple script to run queries via the command-line follows.  The script is available in the distribution under <tt>examples/example.rb</tt>.
+
+  #!/usr/bin/env ruby
+
+  require 'pp'
+  require 'rubygems'
+  require 'yahoo-video'
+
+  # your application id for use with the yahoo search services.  you can
+  # get one at http://api.search.yahoo.com/webservices/register_application.
+  APP_ID = YOUR_APP_ID_HERE
+
+  query = ARGV[0]
+  print "Running a video search for '#{query}'...\n"
+
+  client = YahooVideo::Client.new APP_ID
+  request = YahooVideo::SearchRequest.new :query => query
+  response = client.search request
+
+  pp(response)
+
+== License
+
+This library is provided via the GNU LGPL license at http://www.gnu.org/licenses/lgpl.html.
+
+== Authors
+
+Copyright 2006, Walter Korman <shaper@wgks.org>, http://www.lemurware.com.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'yahoo-video'
+  s.version = '0.1.0'
+  s.author = 'Walter Korman'
+  s.email = 'shaper@wgks.org'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A Ruby object-oriented interface to Yahoo! Video content.'
+  s.rubyforge_project = 'yahoo-video'
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ 'README' ]
+  s.rdoc_options << '--main' << 'README'
+  s.test_files = Dir.glob('test/test_*.rb')
+  s.files = Dir.glob("{examples,lib,test}/**/*") + [ 'AUTHORS', 'CHANGELOG', 'LICENSE', 'README', 'Rakefile', 'TODO' ]
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README'
+  rd.main = 'README'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]

data/TODO

@@ -0,0 +1,3 @@
+2 report error codes
+2 support compressed data transport via user agent or otherwise
+2 make use of a mock service to perform static testing w/o net access

data/examples/example.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require 'rubygems'
+require 'yahoo-video'
+
+# your application id for use with the yahoo search services.  you can
+# get one at http://api.search.yahoo.com/webservices/register_application.
+APP_ID = YOUR_APP_ID_HERE
+
+query = ARGV[0]
+print "Running a video search for '#{query}'...\n"
+
+client = YahooVideo::Client.new APP_ID
+request = YahooVideo::SearchRequest.new :query => query
+response = client.search request
+
+pp(response)

data/lib/yahoo-video.rb

@@ -0,0 +1,315 @@
+# yahoo-video -- provides OO access to the Yahoo! Video web site content
+# Copyright (C) 2006 Walter Korman <shaper@wgks.org>
+#
+# 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
+
+require 'open-uri'
+require 'rexml/document'
+
+module YahooVideo
+
+  # An exception thrown by the YahooVideo module should something untoward
+  # occur.
+  class YahooVideoException < RuntimeError
+    def initialize (message)
+      super(message)
+    end
+  end
+
+  # 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
+        params.each do |key, value| 
+          name = key.to_s
+          instance_variable_set("@#{name}", value) if respond_to?(name)
+        end
+      end
+    end
+  end
+
+  # the maximum number of results that can be requested from the search
+  # service with a single request.
+  MAX_RESULTS_PER_PAGE = 50
+
+  # Describes a search request's parameters for submission to the Yahoo! Video
+  # search service via Client#search.  Parameters are passed to the
+  # constructor as hash key/value pairs.
+  class SearchRequest < Record
+    # Optional: a boolean value representing whether adult-only results are
+    # permitted in the result set, defaulting to false.
+    attr_reader :adult_ok
+    
+    # Required: the application id to associate with the request, as obtained
+    # from http://developer.yahoo.com/faq/index.html#appid.
+    attr_reader :app_id
+    
+    # the name of the callback function to wrap around JSON data if requested
+    # in the output format.  since we require xml for parsing and aren't
+    # making a request via javascript, this doesn't pertain to us.
+    # attr_reader :callback
+
+    # Optional: a list of the output formats by which the search should be
+    # constrained.  One of <tt>any</tt> (default), +avi+, +flash+, +mpeg+,
+    # +msmedia+, +quicktime+, +realmedia+.
+    attr_reader :format
+
+    # Optional: the format for the output.  since we require xml for parsing
+    # this doesn't pertain to us and we always request only xml which also
+    # happens to be the default.    
+    # attr_reader :output
+
+    # Required: the query string representing the query to search for. 
+    # Supports <tt>+</tt>, to include terms, <tt>-</tt> to exclude terms, and
+    # quotes around "exact phrase" matching.
+    attr_reader :query
+
+    # Optional: the number of results to return, defaulting to 10 and at
+    # most 50.
+    attr_reader :results
+
+    # Optional: a list of the site domains by which the search should be
+    # constrained, e.g., <tt>www.yahoo.com</tt>.
+    attr_reader :site
+
+    # Optional: The starting result index to return (1-based), defaulting
+    # to 1.  The finishing position <tt>(start + results - 1)</tt> cannot 
+    # exceed 1000.
+    attr_reader :start
+
+    # Optional: the kind of search to execute, one of <tt>all</tt> (default),
+    # <tt>any</tt>, or <tt>phrase</tt>.
+    #
+    # * <tt>all</tt>: returns results with all query terms.
+    # * <tt>any</tt>: returns results with one or more of the query terms.
+    # * <tt>phrase</tt>: returns results containing the query terms as a phrase.
+    attr_reader :type
+  end
+
+  # Describes a SearchResult file thumbnail image.  Parameters are passed to
+  # the constructor as hash key/value pairs.
+  class Thumbnail < Record
+    # the url of the video thumbnail image.
+    attr_reader :url
+    
+    # the width of the video thumbnail image in pixels.
+    attr_reader :width
+
+    # the height of the video thumbnail image in pixels.
+    attr_reader :height
+  end
+
+  # Describes a single search result as returned by the Yahoo! Video search
+  # service.  Parameters are passed to the constructor as hash key/value
+  # pairs.
+  class SearchResult < Record
+    # the number of channels in the audio.  usually 1 (mono) or 2 (stereo).
+    attr_reader :channels
+    
+    # the url for linking to the video file.  
+    attr_reader :click_url
+    
+    # the copyright owner.
+    attr_reader :copyright
+    
+    # the duration of the video file in seconds.
+    attr_reader :duration
+    
+    # the format of the video file -- one of +avi+, +flash+, +mpeg+,
+    # +msmedia+, +quicktime+, or +realmedia+.
+    attr_reader :file_format
+    
+    # the size of the video file in bytes.
+    attr_reader :file_size
+    
+    # the height of the keyframe Yahoo! extracted from the video in pixels.
+    # the video has this height if rendered at 100%.
+    attr_reader :height
+
+    # the creator of the video file.
+    attr_reader :publisher
+    
+    # the url of the web page hosting the content.
+    attr_reader :referer_url
+    
+    # Provides any restrictions for this media object. Restrictions include
+    # +noframe+ and +noinline+.
+    #
+    # * +noframe+ means that you should not display it with a framed page on
+    #   your site.
+    # * +noinline+ means that you should not inline the object in the frame up
+    #   top (it won't work because the site has some protection based on the
+    #   "referrer" field).
+    attr_reader :restrictions
+
+    # whether the video file is streaming (true) or not (false).
+    attr_reader :streaming
+    
+    # summary text description associated with the video file.
+    attr_reader :summary
+    
+    # the Thumbnail record describing the url of the thumbnail file and its
+    # height and width in pixels.
+    attr_reader :thumbnail
+
+    # the title of the video file.
+    attr_reader :title
+    
+    # the url for the video file or stream.
+    attr_reader :url
+    
+    # the width of the keyframe Yahoo! extracted from the video in pixels. 
+    # the video has this width if rendered at 100%.
+    attr_reader :width
+  end
+
+  # Describes a response to a Yahoo! Video search executed via Client#search. 
+  # Parameters are passed to the constructor as hash key/value pairs.
+  class SearchResponse < Record
+    # the position of the first result in the overall search.
+    attr_reader :first_result_position
+    
+    # the list of zero or more SearchResult records comprising the results of
+    # the executed search query.
+    attr_reader :results
+    
+    # the number of query matches in the database.
+    attr_reader :total_results_available
+    
+    # the number of query matches returned.  this may be lower than the number
+    # of results requested if there were fewer total results available.
+    attr_reader :total_results_returned
+  end
+
+  class Client
+    # the default hostname queried to retrieve yahoo video content.
+    DEFAULT_API_URL = 'http://search.yahooapis.com/VideoSearchService/V1/videoSearch'
+
+    # the default user agent submitted with http requests of yahoo video.
+    DEFAULT_AGENT = 'yahoo-video for Ruby (http://www.rubyforge.org/projects/yahoo-video/)'
+
+    # constructs a Client with the supplied parameters as:
+    #
+    # * +app_id+: the Yahoo! Video application id to submit with API requests.
+    # * +api_url+: the root url via which to make requests of the Yahoo! Video
+    #   API.
+    # * +agent+: the user agent to pass along with http requests made of the
+    #   Yahoo! Video API.
+    def initialize (app_id, api_url = DEFAULT_API_URL, agent = DEFAULT_AGENT)
+      @app_id = app_id
+      @api_url = api_url
+      @agent = agent
+    end
+
+    # submits a search request of the Yahoo! Video service with the supplied
+    # SearchRequest parameters, returning a SearchResponse record detailing
+    # the results.
+    def search (request)
+      # submit the api request
+      url = _video_search_url(request)
+      response = _request(url)
+      
+      # build an xml document with which to analyze the results
+      doc = REXML::Document.new response
+      root = doc.root
+
+      # parse out all of the search result records
+      results = []
+      root.elements.each('Result') do |re|
+        # parse out the thumbnail record
+        te = re.elements["Thumbnail"]
+        thumbnail = Thumbnail.new(:url => te.elements["Url"].text,
+                                  :width => _text_or_nil(te, "Height", 'to_i'),
+                                  :height => _text_or_nil(te, "Height", 'to_i'))
+
+        # tack on the new search result record
+        results << SearchResult.new(:title => re.elements["Title"].text,
+                                    :summary => re.elements["Summary"].text,
+                                    :click_url => re.elements["ClickUrl"].text,
+                                    :url => re.elements["Url"].text,
+                                    :referer_url => re.elements["RefererUrl"].text,
+                                    :file_size => re.elements["FileSize"].text.to_i,
+                                    :file_format => re.elements["FileFormat"].text,
+                                    :height => re.elements["Height"].text.to_i,
+                                    :width => re.elements["Width"].text.to_i,
+                                    :duration => re.elements["Duration"].text.to_i,
+                                    :streaming => YahooVideo::_string_to_boolean(re.elements["Streaming"].text),
+                                    :channels => re.elements["Channels"].text.to_i,
+                                    :thumbnail => thumbnail)
+      end
+
+      # construct and return our final response record
+      SearchResponse.new(:first_result_position => root.attributes['firstResultPosition'].to_i,
+                         :results => results,
+                         :total_results_available => root.attributes['totalResultsAvailable'].to_i,
+                         :total_results_returned => root.attributes['totalResultsReturned'].to_i)
+    end
+
+    private
+    
+      def _text_or_nil (element, key, format = 'to_s')
+        value = element.elements[key]
+        (value) ? value.text.send(format) : nil
+      end
+
+      # returns a url string with the given request's parameters encoded
+      # appropriately for making a REST call of the Yahoo! Video API service.
+      def _video_search_url (request)
+        url = "#{@api_url}?appid=#{@app_id}"
+        url << "&query=#{URI.encode(request.query)}"
+        url << "&type=#{request.type}" if (request.type)
+        url << "&results=#{request.results}" if (request.results)
+        url << "&start=#{request.start}" if (request.start)
+        url << "&#{_list_to_query_params('format', request.format)}" if (request.format)
+        url << "&adult_ok=1" if (request.adult_ok)
+        url << "&#{_list_to_query_params('site', request.site)}" if (request.site)
+        url
+      end
+
+      # returns a string representing one or more key/value pairs built up
+      # from the supplied parameters, suitable for inclusion as part of a
+      # url's query parameters.
+      def _list_to_query_params (key, values)
+        return "#{key}=#{values}" if values.is_a?(String)
+        str = ''
+        values.each_with_index do |value, index|
+          str << '&' if (index > 0)
+          str << "#{key}=#{value}"
+        end
+      end
+
+      # makes an http request of the given url and returns the html response
+      # as a string.
+      def _request (url)
+        begin
+          content = ''
+          open(url, "User-Agent" => @agent) { |f| content = f.read }
+          content
+        rescue
+          raise YahooVideoException.new("failed to request '#{url}': " + $!)
+        end
+      end
+  end
+
+  private
+
+    # Returns the Ruby boolean object as TrueClass or FalseClass based on
+    # the supplied string value.  TrueClass is returned if the value is
+    # non-nil and "true" (case-insensitive), else FalseClass is returned.
+    def self._string_to_boolean (bool_str)
+      (bool_str && bool_str.downcase == "true")
+    end
+end

data/test/test_client.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require 'yahoo-video'
+require File.dirname(__FILE__) + '/video_test_helper'
+
+class TestClient < Test::Unit::TestCase
+  include VideoTestHelper
+
+  def test_validation
+    # make sure we can do basic client instantiation
+    assert_nothing_raised do
+      @client = YahooVideo::Client.new APP_ID
+    end
+    
+    # make sure we get an error if we specify a bad api url
+    assert_raise YahooVideo::YahooVideoException do
+      @client = YahooVideo::Client.new APP_ID, 'http://nO)domain#!badbadbad'
+      request = YahooVideo::SearchRequest.new :query => 'chicken'
+      @client.search request
+    end
+    
+    # TODO: test specifying a custom user agent
+  end
+end

data/test/test_video_search.rb

@@ -0,0 +1,190 @@
+require 'pp'
+require 'test/unit'
+require 'yahoo-video'
+require File.dirname(__FILE__) + '/video_test_helper'
+
+class TestVideoSearch < Test::Unit::TestCase
+  include VideoTestHelper
+
+  QUERY_STRING = 'tessa'
+  ADULT_QUERY_STRING = 'asia carrera'
+  COMMON_QUERY_STRING = 'eminem'
+
+  def setup
+    @client = YahooVideo::Client.new APP_ID
+  end
+
+  def test_request_validation
+    # make sure some general valid requests work ok
+    assert_nothing_raised do
+      YahooVideo::SearchRequest.new :query => QUERY_STRING
+    end
+
+    # make sure a query string is required
+    assert_raise ArgumentError do
+      YahooVideo::SearchRequest.new
+    end
+  end
+
+  def test_search
+    request = YahooVideo::SearchRequest.new :query => QUERY_STRING
+    response = @client.search request
+    assert_valid_search_response response
+  end
+  
+  def test_search_adult
+    # test to make sure adult searches return a different result set
+    
+    # fetch safe results
+    request = YahooVideo::SearchRequest.new :query => ADULT_QUERY_STRING
+    safe_response = @client.search request
+    assert_valid_search_response safe_response
+
+    # fetch adult results
+    request = YahooVideo::SearchRequest.new :query => ADULT_QUERY_STRING, :adult_ok => true
+    adult_response = @client.search request
+    assert_valid_search_response adult_response
+
+    # make sure we have a different number of results
+    assert_not_equal safe_response.total_results_available, adult_response.total_results_available
+    # and the first result's url should differ
+    assert_not_equal safe_response.results.first.url, adult_response.results.first.url
+  end
+
+  def test_search_format
+    # test to make sure specifying particular video formats does the 
+    # right thing.  we just try a couple formats we know are valid.
+
+    # test .avi format
+    request = YahooVideo::SearchRequest.new :query => COMMON_QUERY_STRING, :format => 'avi'
+    response = @client.search request
+    assert_valid_search_response response
+
+    # test quicktime format
+    request = YahooVideo::SearchRequest.new :query => COMMON_QUERY_STRING, :format => 'quicktime'
+    response = @client.search request
+    assert_valid_search_response response
+    response.results.each { |result| assert_equal 'quicktime', result.file_format }
+  end
+
+  def test_search_result_count
+    # test to make sure specifying a different result count works
+    
+    # the default should give us 10
+    request = YahooVideo::SearchRequest.new :query => COMMON_QUERY_STRING
+    response = @client.search request
+    assert_valid_search_response response
+    assert_equal 10, response.total_results_returned
+    
+    # specifying more should give us more
+    request = YahooVideo::SearchRequest.new :query => COMMON_QUERY_STRING, :results => 25
+    response = @client.search request
+    assert_valid_search_response response
+    assert_equal 25, response.total_results_returned
+  end
+
+  def test_search_site
+    # test to make sure specifying a site to which results are to be 
+    # constrained works
+    request = YahooVideo::SearchRequest.new :query => COMMON_QUERY_STRING, :site => 'yahoo.com'
+    response = @client.search request
+    assert_valid_search_response response
+    
+    # make sure the domains in the returned video urls all match
+    response.results.each { |result| assert_match /https?:\/\/.*?yahoo\.com\//i, result.url }
+  end
+  
+  def test_search_start
+    # test to make sure specifying the start index does the right thing
+
+    # run a query for the first page
+    request = YahooVideo::SearchRequest.new :query => QUERY_STRING
+    first_response = @client.search request
+    assert_valid_search_response first_response
+    assert_equal first_response.first_result_position, 1
+    
+    # run a query for the second page
+    request = YahooVideo::SearchRequest.new :query => QUERY_STRING, :start => 11
+    second_response = @client.search request
+    assert_valid_search_response second_response
+    assert_equal second_response.first_result_position, 11
+    
+    # make sure the top result on second page isn't the same as the first
+    assert_not_equal first_response.results.first.url, second_response.results.first.url
+    
+    # try grabbing just the last result on the first page.  we've commented
+    # this out for now since it appears different servers may return different
+    # results, such that this test won't consistently pass.
+    # request = YahooVideo::SearchRequest.new :query => QUERY_STRING, :start => 10, :results => 1
+    # third_response = @client.search request
+    # assert_valid_search_response third_response
+    # assert_equal first_response.results.last.url, third_response.results.first.url
+  end
+
+  def test_search_type
+    # make sure specifying an alternate search type provides different results
+    
+    # grab an initial set of results allowing any kind of match
+    request = YahooVideo::SearchRequest.new :query => 'winona ryder'
+    first_response = @client.search request
+    assert_valid_search_response first_response
+
+    # specify a phrase match
+    request = YahooVideo::SearchRequest.new :query => 'winona ryder', :type => 'phrase'
+    second_response = @client.search request
+    assert_valid_search_response second_response
+    
+    # make sure we get at least one different result
+    diff = false
+    second_response.results.each_with_index do |result, index|
+      if result.url != first_response.results[index].url
+        diff = true
+        break
+      end
+    end
+    assert diff
+  end
+
+  def assert_valid_search_response (response)
+    assert_not_nil response
+    assert_kind_of Numeric, response.first_result_position
+    assert (response.first_result_position > 0)
+    assert_kind_of Numeric, response.total_results_available
+    assert_kind_of Numeric, response.total_results_returned
+    assert (response.total_results_available >= response.total_results_returned)
+    response.results.each { |result| assert_valid_search_result(result) }
+  end
+  
+  def assert_valid_search_result (result)
+    assert_not_nil result
+    assert_kind_of Numeric, result.channels
+    assert_valid_url result.click_url
+    assert_instance_of(String, result.copyright) if result.copyright
+    assert_kind_of(Numeric, result.duration) if result.duration
+    assert_instance_of(String, result.file_format) if result.file_format
+    assert_kind_of(Numeric, result.file_size) if result.file_size
+    assert_kind_of Numeric, result.height
+    assert_instance_of(String, result.publisher) if result.publisher
+    assert_instance_of String, result.referer_url
+    assert_match(/^(noframe|noinline)$/, result.restrictions) if result.restrictions
+    assert_instance_of(String, result.summary) if result.summary
+    assert_valid_thumbnail result.thumbnail
+    assert_instance_of String, result.title
+    assert_valid_url result.url
+    assert_kind_of Numeric, result.width
+  end
+
+  def assert_valid_thumbnail (thumb)
+    assert_not_nil thumb
+    assert_valid_url thumb.url
+    assert_kind_of(Numeric, thumb.width) if thumb.width
+    assert_kind_of(Numeric, thumb.height) if thumb.height
+  end
+  
+  # just a rudimentary check will serve us fine
+  VALID_URL_REGEXP = /^https?:\/\/[a-z0-9]/i
+
+  def assert_valid_url (url)
+    assert_match VALID_URL_REGEXP, url
+  end
+end

data/test/video_test_helper.rb

@@ -0,0 +1,3 @@
+module VideoTestHelper
+  APP_ID = YOUR_APP_ID_HERE
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: yahoo-video
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-12-05 00:00:00 -08:00
+summary: A Ruby object-oriented interface to Yahoo! Video content.
+require_paths: 
+- lib
+email: shaper@wgks.org
+homepage: 
+rubyforge_project: yahoo-video
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Walter Korman
+files: 
+- examples/example.rb
+- lib/yahoo-video.rb
+- test/test_client.rb
+- test/test_video_search.rb
+- test/video_test_helper.rb
+- AUTHORS
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- TODO
+test_files: 
+- test/test_client.rb
+- test/test_video_search.rb
+rdoc_options: 
+- --main
+- README
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+