= whitepages
* http://whitepages.rubyforge.org
== DESCRIPTION:
The Whitepages Gem provides a library for consuming the web services provided by "Whitepages":http://www.whitepages.com. More information on the Developer API may be found "here":http://developer.whitepages.com/. This API may be used to lookup people by name as well as reverse lookups based on phone number or address.
There are a couple of limitations to consider (refer to the Whitepages website for any changes):
* Maximum of 1,500 calls per day per API key
* Throttle set at 2 searches per second per API key
== FEATURES/PROBLEMS:
* TBD
== SYNOPSIS:
require 'rubygems'
require 'whitepages'
data = Whitepages.find_person({ "lastname" => "Smith",
"state" => "CO",
"api_key" => "your_key" })
== REQUIREMENTS:
* Requires these gems:
- rubigen
- xmlsimple
- rest_client
== INSTALL:
* sudo gem install whitepages
== LICENSE:
(LGPL version 3 - http://www.gnu.org/licenses/lgpl-3.0.txt)
Copyright (c) 2008 Jason Goecke
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
* http://whitepages.rubyforge.org
== DESCRIPTION:
The Whitepages Gem provides a library for consuming the web services provided by "Whitepages":http://www.whitepages.com. More information on the Developer API may be found "here":http://developer.whitepages.com/. This API may be used to lookup people by name as well as reverse lookups based on phone number or address.
There are a couple of limitations to consider (refer to the Whitepages website for any changes):
* Maximum of 1,500 calls per day per API key
* Throttle set at 2 searches per second per API key
== FEATURES/PROBLEMS:
* TBD
== SYNOPSIS:
require 'rubygems'
require 'whitepages'
data = Whitepages.find_person({ "lastname" => "Smith",
"state" => "CO",
"api_key" => "your_key" })
== REQUIREMENTS:
* Requires these gems:
- rubigen
- xmlsimple
- rest_client
== INSTALL:
* sudo gem install whitepages
== LICENSE:
(LGPL version 3 - http://www.gnu.org/licenses/lgpl-3.0.txt)
Copyright (c) 2008 Jason Goecke
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.