COPYING @@ -1 +1,84 @@ -This is a README +== Welcome to eBay4R + +eBay4R is a Ruby wrapper for eBay's Web Services SOAP API. Emphasis is on ease +of use and small footprint. + + + +== Requirements + +* SOAP4R library newer than v1.5.5. At the time of this writing, the latest + version was v1.5.5, which will not work. You have to get a snapshot that is + dated 11-06-2005 or newer. You can find development snapshots here: + + http://dev.ctor.org/download + + So, for example, to download the 11-06-2005 snapshot (the one I personally + used during development), go here: + + http://dev.ctor.org/download/archive/soap4r-20051106.tar.gz + + +== Getting started + + +== Tips + +* If "eBay" is your eBay caller object, as in: + + eBay = EBay::API.new( ... ) + + You can see XML wiredumps by doing: + + eBay.debug = true + + before you issue an eBay API call. This is useful to see the raw XML of + what eBay is sending back to you. + + +== Files + +examples/ + Examples of eBay API calls using this library. You will want to check out + these examples before making your own calls. + +lib/eBayAPI.rb + The heart of this library + +lib/eBayDriver.rb + Autogenerated by wsdl2ruby.rb + +lib/eBay.rb + Autogenerated by wsdl2ruby.rb + +lib/RequesterCredentialsHandler.rb + Helper for generating the eBay Authentication header for each call + +test/ + Unit and functional tests + + +== Author + +Garry C. Dolley + +gdolley [at] ucla.edu + + +== Copyright + +Copyright (c) 2005 Garry C. Dolley + +eBay4R is free software; you can redistribute it and/or modify it under the +terms of the GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any later +version. + +eBay4R 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 General Public License for more +details. + +You should have received a copy of the GNU General Public License along with +eBay4R; if not, write to the Free Software Foundation, Inc., 51 Franklin +Street, Fifth Floor, Boston, MA 02110-1301, USA README @@ -25,6 +25,7 @@ require 'RequesterCredentialsHandler.rb' module EBay +# This is the main class of the eBay4R library. Start by instantiating this class (see below) class API attr_writer :debug lib/eBayAPI.rb c7fdb0317656ab4175112f5a8ab7e4d7d24d341f Garry Dolley gdolley@arpnetworks.com http://github.com/up_the_irons/ebay4r/commit/e204d1a1d6ee4648fcb000502f379edbf5462547 e204d1a1d6ee4648fcb000502f379edbf5462547 2005-12-08T19:26:33-08:00 2005-12-08T19:26:33-08:00 Adding COPYING for licensing. Fleshed out README. Added more comments to eBayAPI.rb 0c9d24624df1ea9152a1c4dab19197a3db58a5de Garry Dolley gdolley@arpnetworks.com