petfinder 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Eric Hutzelman
+
+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.

data/README.rdoc

@@ -0,0 +1,31 @@
+= Petfinder
+
+Ruby gem wrapper for the {Petfinder API}[http://www.petfinder.com/developers/api-docs].
+
+== Installation
+
+ sudo gem install petfinder
+
+== Get your API key
+
+Get your Petfinder API key at: http://www.petfinder.com/developers/api-key
+
+== Usage
+
+== TODO
+
+* Implement use of security token when Petfinder requires it
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Eric Hutzelman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "petfinder"
+    gem.summary = %Q{Ruby gem wrapper for the Petfinder API}
+    gem.description = %Q{Ruby gem wrapper for the Petfinder API}
+    gem.email = "ehutzelman@gmail.com"
+    gem.homepage = "http://github.com/ehutzelman/petfinder"
+    gem.authors = ["Eric Hutzelman"]
+
+    gem.add_dependency('hashie', '>= 0.1.3')
+    gem.add_dependency('httparty', '>= 0.5.0')
+    
+    gem.add_development_dependency "shoulda", ">= 2.10.1"
+    gem.add_development_dependency 'fakeweb', '>= 1.2.5'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "petfinder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/petfinder/client.rb

@@ -0,0 +1,98 @@
+module Petfinder
+  
+  class Client
+    include HTTParty
+    format :xml
+    base_uri "http://api.petfinder.com"
+    
+    def initialize(api_key = Petfinder.api_key, api_secret = Petfinder.api_secret)
+      @api_key, @api_secret = api_key, api_secret
+      raise "API key is required" if @api_key.blank?
+
+      self.class.default_params :key => api_key
+    end
+    
+    # Valid animal types: barnyard, bird, cat, dog, horse, pig, reptile, smallfurry
+    def breeds(animal_type)
+      response = perform_get("/breed.list", :query => {:animal => animal_type})
+      return_as_array(response.breeds.breed)
+    end    
+
+    def pet(id)
+      response = perform_get("/pet.get", :query => {:id => id})
+      response.pet
+    end
+    
+    # Options available: animal, breed, size, sex, location, shelterid 
+    def random_pet(options = {})
+      response = perform_get("/pet.getRandom", :query => {:output => 'full'})
+      response.pet
+    end
+    
+    # Options available: breed, size, sex, age, offset, count
+    def find_pets(animal_type, location, options = {})
+      query = options.merge(:animal => animal_type, :location => location)
+      response = perform_get("/pet.find", :query => query)
+      return_as_array(response.pets.pet)
+    end
+
+    def shelter(id)
+      response = perform_get("/shelter.get", :query => {:id => id})
+      response.shelter      
+    end
+    
+    # Options available: name, offset, count
+    def find_shelters(location, options = {})
+      query = options.merge(:location => location)
+      response = perform_get("/shelter.find", :query => query)
+      return_as_array(response.shelters.shelter)
+    end
+
+    # Options available: offset, count    
+    def find_shelters_by_breed(animal_type, breed, options = {})
+      query = options.merge(:animal => animal_type, :breed => breed)
+      response = perform_get("/shelter.listByBreed", :query => query)
+      return_as_array(response.shelters.shelter)
+    end
+    
+    # Options available: status, offset, count
+    def shelter_pets(id, options = {})
+      query = options.merge(:id => id)
+      response = perform_get("/shelter.getPets", :query => query)
+      return_as_array(response.pets.pet)
+    end
+    
+    def token
+      response = perform_get("/auth.getToken", :query => {:sig => digest_key_and_secret})
+      response.auth.token
+    end
+        
+    private
+    
+    def return_as_array(object)
+      object.class == Array ? object : [object]
+    end
+    
+    def digest_key_and_secret      
+      raise "API secret is required" if @api_secret.blank?
+      Digest::MD5.hexdigest(@api_secret + "key=#{@api_key}")
+    end
+
+    def perform_get(uri, options = {})
+      response = self.class.get(uri, options)
+      raise_errors(response)
+      mash = Hashie::Mash.new(response['petfinder'])
+    end
+    
+    def raise_errors(response)
+      if response.code.to_i == 200
+        status = response['petfinder']['header']['status']
+        raise PetfinderError.new("(#{status['code']}) #{status['message']}") if status['code'].to_i != 100
+      else
+        raise RuntimeError.new("Invalid response from server: #{response.code}")
+      end
+    end
+    
+  end
+  
+end

data/lib/petfinder.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'httparty'
+require 'hashie'
+require 'digest/md5'
+
+module Petfinder
+  
+  class PetfinderError < StandardError; end
+
+  class << self
+    attr_accessor :api_key, :api_secret
+  end
+  
+  def self.configure
+    yield self
+    true
+  end
+
+end
+
+directory = File.expand_path(File.dirname(__FILE__))
+require File.join(directory, 'petfinder', 'client')

data/test/fixtures/auth.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<petfinder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://api.petfinder.com/schemas/0.9/petfinder.xsd">
+  <header>
+    <version>0.1</version>
+    <timestamp>2010-04-10T22:29:07Z</timestamp>
+    <status>
+      <code>100</code>
+      <message/>
+    </status>
+  </header>
+  <auth>
+    <key>83bd1e190a9d09ad8041d2f087684753</key>
+    <token>39038a000f404335d90bab019c0c7e2d</token>
+    <expires>1270942147</expires>
+    <expiresString>2010-04-10T23:29:07Z</expiresString>
+  </auth>
+</petfinder>

data/test/fixtures/breed_list.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<petfinder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://api.petfinder.com/schemas/0.9/petfinder.xsd">
+  <header>
+    <version>0.1</version>
+    <timestamp>2010-04-09T06:34:37Z</timestamp>
+    <status>
+      <code>100</code>
+      <message/>
+    </status>
+  </header>
+  <breeds animal="horse">
+    <breed>Appaloosa</breed>
+    <breed>Arabian</breed>
+    <breed>Belgian</breed>
+    <breed>Clydesdale</breed>
+    <breed>Curly Horse</breed>
+    <breed>Donkey/Mule</breed>
+    <breed>Draft</breed>
+    <breed>Gaited</breed>
+    <breed>Grade</breed>
+    <breed>Lipizzan</breed>
+    <breed>Miniature Horse</breed>
+    <breed>Missouri Foxtrotter</breed>
+    <breed>Morgan</breed>
+    <breed>Mustang</breed>
+    <breed>Paint/Pinto</breed>
+    <breed>Palomino</breed>
+    <breed>Paso Fino</breed>
+    <breed>Percheron</breed>
+    <breed>Peruvian Paso</breed>
+    <breed>Pony</breed>
+    <breed>Quarterhorse</breed>
+    <breed>Saddlebred</breed>
+    <breed>Shetland Pony</breed>
+    <breed>Standardbred</breed>
+    <breed>Tennessee Walker</breed>
+    <breed>Thoroughbred</breed>
+    <breed>Warmblood</breed>
+  </breeds>
+</petfinder>

data/test/fixtures/pet.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<petfinder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://api.petfinder.com/schemas/0.9/petfinder.xsd">
+  <header>
+    <version>0.1</version>
+    <timestamp>2010-04-09T06:14:44Z</timestamp>
+    <status>
+      <code>100</code>
+      <message/>
+    </status>
+  </header>
+  <pet>
+    <id>10141994</id>
+    <shelterId>IL173</shelterId>
+    <shelterPetId>0A10503371</shelterPetId>
+    <name>Charlie</name>
+    <animal>Cat</animal>
+    <breeds>
+      <breed>Domestic Short Hair-black</breed>
+    </breeds>
+    <mix>no</mix>
+    <age>Adult</age>
+    <sex>M</sex>
+    <size>M</size>
+    <options>
+      <option>hasShots</option>
+      <option>altered</option>
+    </options>
+    <description><![CDATA[Charlie is an outgoing cat who just loves to be around all the attention.  He runs around and chases anything that moves.  We think he'd be great in an active household!
+<br/><a href="http://www.petfinder.com/petdetail/10141994">View this pet on Petfinder.com</a>
+]]></description>
+    <lastUpdate>2010-04-07T13:43:33Z</lastUpdate>
+    <status>A</status>
+    <media>
+      <photos>
+        <photo id="1" size="x">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-1-x.jpg</photo>
+        <photo id="1" size="t">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-1-t.jpg</photo>
+        <photo id="1" size="pn">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-1-pn.jpg</photo>
+        <photo id="1" size="pnt">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-1-pnt.jpg</photo>
+        <photo id="1" size="fpm">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-1-fpm.jpg</photo>
+        <photo id="2" size="x">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-2-x.jpg</photo>
+        <photo id="2" size="t">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-2-t.jpg</photo>
+        <photo id="2" size="pn">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-2-pn.jpg</photo>
+        <photo id="2" size="pnt">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-2-pnt.jpg</photo>
+        <photo id="2" size="fpm">http://photocache.petfinder.com/fotos/IL173/IL173.10141994-2-fpm.jpg</photo>
+      </photos>
+    </media>
+  </pet>
+</petfinder>