pet-finder-api
v1.0.1
Published
Petfinder API Javascript Library.
Downloads
48
Maintainers
Readme
Petfinder API
This Module is created to simplify working with the PetFinder API That allows you to look for pets needing adoption. Most Calls Are public and do not require a secret.
Installation
NPM
npm install pet-finder-api --save
--save
adds pet-finder-api to your package.json
file
Package Manager package.json
:
{
...
"dependencies": {
...
"petfinder": "latest"
}
}
Example
// Import module
var petfinder = require('pet-finder-api')('api_key','api_secret');
// Get list of breeds
petfinder.getBreedList('cat', function(err, breeds) {
console.log(breeds)
});
Methods
Pets
// animal = barnyard, bird, cat, dog, horse, pig, reptile, smallfurry
getBreedList( animal, callback )
getPet( petId, options, callback )
getRandomPet ( options, callback )
findPet ( location, options, callback )
Shelters
findShelter( location, options, callback )
getShelter( shelterId, options, callback )
getPetsInShelter( shelterId, options, callback )
// breed get from getBreedList
getSheltersWithBreeds ( animal, breed, options, callback )
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some awesome feature'
) - Push to the remote branch (
git push origin my-new-feature
) - Create a pull request
Running Tests
cp .env.example .env
npm test
to record api calls
REPLAY=record npm test
to debug recorded api calls
DEBUG=replay npm test