Ruby gem wrapper for the Petfinder API.
Add this line to your application's Gemfile:
gem 'petfinder'
And then execute:
$ bundle
Or install it yourself as:
$ gem install petfinder
Get your Petfinder API key at: http://www.petfinder.com/developers/api-key
petfinder = Petfinder::Client.new('your_api_key', 'your_api_secret')
Petfinder.configure do |config|
config.api_key = 'your_api_key'
config.api_secret = 'your_api_secret'
end
petfinder = Petfinder::Client.newpets = petfinder.find_pets('dog', '90210')
pets.count
# => "25"
pets.first.name
# => "Petey"
pets.first.shelterid
# => "CA123"petfinder.find_pets('dog', 77057, count: 25)
# page 2
petfinder.find_pets('dog', 77057, count: 25, offset: 25)
# page 3
petfinder.find_pets('dog', 77057, count: 25, offset: 50)
# page 4
petfinder.find_pets('dog', 77057, count: 25, offset: 75)shelter = petfinder.shelter('CA123')
shelter.name
# => "Melrose Place SPCA"# Valid animal types: barnyard, bird, cat, dog, horse, pig, reptile, smallfurry
breeds = petfinder.breeds(animal_type)
# Options available: animal, breed, size, sex, location, shelterid
pet = petfinder.random_pet(options)
pet = petfinder.pet(id)
# Options available: breed, size, sex, age, offset, count
pets = petfinder.find_pets(animal_type, location, options)
# Options available: status, offset, count
pets = shelter_pets(shelter_id, options)
# Options available: name, offset, count
shelters = petfinder.find_shelters(location, options)
shelters = petfinder.find_shelters_by_breed(animal_type, breed)
shelter = petfinder.shelter(shelter_id)- Implement use of security token when Petfinder requires it
- Support paging for results
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Copyright (c) 2010-2013 Eric Hutzelman. See LICENSE for details.