petfinder 0.0.1 → 0.1.0

data/README.rdoc

@@ -4,7 +4,7 @@ Ruby gem wrapper for the {Petfinder API}[http://www.petfinder.com/developers/api
 
 == Installation
 
- sudo gem install petfinder
+  sudo gem install petfinder
 
 == Get your API key
 
@@ -12,6 +12,38 @@ Get your Petfinder API key at: http://www.petfinder.com/developers/api-key
 
 == Usage
 
+=== Instantiate a client
+
+  petfinder = Petfinder::Client.new('your_api_key', 'your_api_secret')
+    
+=== or configure once
+
+  Petfinder.configure do |config|
+    config.api_key = 'your_api_key'
+    config.api_secret = 'your_api_secret'
+  end
+  petfinder = Petfinder::Client.new
+    
+== Examples
+
+==== Return a list of dogs in the "90210" zip code
+
+  pets = petfinder.find_pets('dog', '90210')
+  pets.count
+  # => "25"
+  
+  pets.first.name
+  # => "Petey"
+
+  pets.first.shelterid
+  # => "CA123"
+
+==== Return information about the shelter with id "CA123"
+
+  shelter = petfinder.shelter('CA123')
+  shelter.name
+  # => "Melrose Place SPCA"
+
 == TODO
 
 * Implement use of security token when Petfinder requires it

data/Rakefile

@@ -11,10 +11,10 @@ begin
     gem.homepage = "http://github.com/ehutzelman/petfinder"
     gem.authors = ["Eric Hutzelman"]
 
-    gem.add_dependency('hashie', '>= 0.1.3')
+    gem.add_dependency('happymapper', '>= 0.3.2')
     gem.add_dependency('httparty', '>= 0.5.0')
     
-    gem.add_development_dependency "shoulda", ">= 2.10.1"
+    gem.add_development_dependency "rspec", ">= 1.3.0"
     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
@@ -23,29 +23,21 @@ 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
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 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
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :test => :check_dependencies
+task :spec => :check_dependencies
 
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/petfinder.rb

@@ -1,6 +1,5 @@
-require 'rubygems'
 require 'httparty'
-require 'hashie'
+require 'happymapper'
 require 'digest/md5'
 
 module Petfinder
@@ -19,4 +18,9 @@ module Petfinder
 end
 
 directory = File.expand_path(File.dirname(__FILE__))
-require File.join(directory, 'petfinder', 'client')
+
+require File.join(directory, 'petfinder', 'client')
+require File.join(directory, 'petfinder', 'pet')
+require File.join(directory, 'petfinder', 'breeds')
+require File.join(directory, 'petfinder', 'shelter')
+require File.join(directory, 'petfinder', 'auth')

data/lib/petfinder/auth.rb

@@ -0,0 +1,13 @@
+module Petfinder
+  
+  class Auth
+    include HappyMapper
+
+    tag 'auth'
+    element :key, String
+    element :token, String
+    element :expires, String
+    element :expiresString, String
+  end
+
+end

data/lib/petfinder/breeds.rb

@@ -0,0 +1,10 @@
+module Petfinder
+
+  class Breeds
+    include HappyMapper
+    tag 'breeds'
+
+    has_many :breeds, String, :tag => 'breed'
+  end
+
+end

data/lib/petfinder/client.rb

@@ -15,64 +15,60 @@ module Petfinder
     # 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)
+      Breeds.parse(response, :single => true).breeds
     end    
 
     def pet(id)
       response = perform_get("/pet.get", :query => {:id => id})
-      response.pet
+      Pet.parse(response, :single => true)
     end
     
     # Options available: animal, breed, size, sex, location, shelterid 
     def random_pet(options = {})
       response = perform_get("/pet.getRandom", :query => {:output => 'full'})
-      response.pet
+      Pet.parse(response, :single => true)
     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)
+      Pet.parse(response)
     end
 
     def shelter(id)
       response = perform_get("/shelter.get", :query => {:id => id})
-      response.shelter      
+      Shelter.parse(response, :single => true)
     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)
+      Shelter.parse(response)
     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)
+      Shelter.parse(response)
     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)
+      Pet.parse(response)
     end
     
     def token
       response = perform_get("/auth.getToken", :query => {:sig => digest_key_and_secret})
-      response.auth.token
+      Auth.parse(response, :single => true).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}")
@@ -81,7 +77,7 @@ module Petfinder
     def perform_get(uri, options = {})
       response = self.class.get(uri, options)
       raise_errors(response)
-      mash = Hashie::Mash.new(response['petfinder'])
+      response.body
     end
     
     def raise_errors(response)

data/lib/petfinder/pet.rb

@@ -0,0 +1,77 @@
+module Petfinder
+  
+  class Photo
+    include HappyMapper
+
+    tag 'photo'
+    attribute :id, String
+    attribute :size, String
+    element :url, String, :tag => '.'
+  end
+
+  class Pet
+    include HappyMapper
+    attr_accessor :pictures
+    
+    tag 'pet'
+    element :id, Integer
+    element :shelter_id, String, :tag => 'shelterId'
+    element :shelter_pet_id, String, :tag => 'shelterPetId'
+    element :name, String
+    element :animal, String
+    has_many :breeds, String, :tag => 'breed', :deep => true
+    element :mix, String
+    element :age, String
+    element :sex, String
+    element :size, String
+    has_many :options, String, :tag => 'option', :deep => true
+    element :description, String
+    element :last_update, DateTime, :tag => 'lastUpdate'
+    element :status, String
+    has_many :photos, Photo, :tag => 'photo', :deep => true
+
+    private :photos
+
+    after_parse do |pet|
+      pet.remove_link_from_description
+      pet.consolidate_photos
+    end
+    
+    def remove_link_from_description
+      self.description = description[0..description.index("\n") - 1] if description.index("\n")
+    end
+    
+    def consolidate_photos
+      @pictures = []
+      photos.map {|photo| photo.id}.uniq.each do |id|
+        @pictures << Picture.new(photos.select {|photo| photo.id == id})
+      end
+    end
+  end
+
+  class Picture
+    attr_reader :large, :medium, :small, :thumbnail, :tiny
+  
+    def initialize(photos)
+      photos.each do |photo|
+        case photo.size
+        when "x"
+          @large = photo.url
+        when "pn"
+          @medium = photo.url
+        when "fpm"
+          @small = photo.url
+        when "pnt"
+          @thumbnail = photo.url
+        when "t"
+          @tiny = photo.url
+        end
+      end
+    end
+  
+    def to_s
+      large
+    end    
+  end
+
+end

data/lib/petfinder/shelter.rb

@@ -0,0 +1,22 @@
+module Petfinder
+  
+  class Shelter
+    include HappyMapper
+
+    tag 'shelter'
+    element :id, String
+    element :name, String
+    element :address1, String
+    element :address2, String
+    element :city, String
+    element :state, String
+    element :zip, String
+    element :country, String
+    element :latitude, String
+    element :longitude, String
+    element :phone, String
+    element :fax, String
+    element :email, String    
+  end
+
+end

data/petfinder.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{petfinder}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Hutzelman"]
+  s.date = %q{2010-07-09}
+  s.description = %q{Ruby gem wrapper for the Petfinder API}
+  s.email = %q{ehutzelman@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/petfinder.rb",
+     "lib/petfinder/auth.rb",
+     "lib/petfinder/breeds.rb",
+     "lib/petfinder/client.rb",
+     "lib/petfinder/pet.rb",
+     "lib/petfinder/shelter.rb",
+     "petfinder.gemspec",
+     "spec/fixtures/auth.xml",
+     "spec/fixtures/breed_list.xml",
+     "spec/fixtures/pet.xml",
+     "spec/fixtures/pet_list.xml",
+     "spec/fixtures/shelter.xml",
+     "spec/fixtures/shelter_list.xml",
+     "spec/petfinder_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ehutzelman/petfinder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby gem wrapper for the Petfinder API}
+  s.test_files = [
+    "spec/petfinder_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<happymapper>, [">= 0.3.2"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.5"])
+    else
+      s.add_dependency(%q<happymapper>, [">= 0.3.2"])
+      s.add_dependency(%q<httparty>, [">= 0.5.0"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.5"])
+    end
+  else
+    s.add_dependency(%q<happymapper>, [">= 0.3.2"])
+    s.add_dependency(%q<httparty>, [">= 0.5.0"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.5"])
+  end
+end
+

data/spec/petfinder_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Petfinder::Client do
+  before do
+    @client = Petfinder::Client.new('1234567', 'mysekrit')
+  end
+
+  it "should get a random pet" do
+    stub_get("http://api.petfinder.com/pet.getRandom?key=1234567&output=full", "pet.xml")
+    pet = @client.random_pet
+    pet.name.should == 'Charlie'
+  end
+  
+  it "should get a specific pet by id" do
+    stub_get("http://api.petfinder.com/pet.get?key=1234567&id=123", "pet.xml")
+    pet = @client.pet(123)
+    pet.name.should == 'Charlie'
+  end
+  
+  it "should find pets matching a query" do
+    stub_get("http://api.petfinder.com/pet.find?key=1234567&animal=dog&location=77007", "pet_list.xml")
+    pets = @client.find_pets('dog', '77007')
+    pets.first.name.should == 'Petey'    
+  end
+  
+  describe "retrieving a pet" do
+    before do
+      stub_get("http://api.petfinder.com/pet.getRandom?key=1234567&output=full", "pet.xml")
+      @pet = @client.random_pet      
+    end
+    
+    it "should hide photos collection" do
+      @pet.should_not respond_to(:photos)
+    end
+    
+    it "should reorganize photos for pet as pictures" do
+      @pet.pictures[0].thumbnail.should == 'http://photocache.petfinder.com/fotos/IL173/IL173.10141994-1-pnt.jpg'
+      @pet.pictures[1].large.should == 'http://photocache.petfinder.com/fotos/IL173/IL173.10141994-2-x.jpg'
+    end
+  end
+  
+  it "should get the list of breeds for the given animal type" do
+    stub_get("http://api.petfinder.com/breed.list?key=1234567&animal=horse", "breed_list.xml")
+    breeds = @client.breeds('horse')
+    breeds.first.should == "Appaloosa"
+  end
+
+  it "should get a specific shelter by id" do
+    stub_get("http://api.petfinder.com/shelter.get?key=1234567&id=123", "shelter.xml")
+    shelter = @client.shelter(123)
+    shelter.name.should == 'Lucky Dog Rescue'
+  end
+
+  it "should find shelters matching a query" do
+    stub_get("http://api.petfinder.com/shelter.find?key=1234567&location=77007", "shelter_list.xml")
+    shelters = @client.find_shelters('77007')
+    shelters.first.name.should == 'Pup Squad Animal Rescue'
+  end
+
+  it "should find shelters matching a breed" do
+    stub_get("http://api.petfinder.com/shelter.listByBreed?key=1234567&animal=horse&breed=arabian", "shelter_list.xml")
+    shelters = @client.find_shelters_by_breed('horse', 'arabian')
+    shelters.first.name.should == 'Pup Squad Animal Rescue'
+  end
+  
+  it "should get the list of pets available for the given shelter" do
+    stub_get("http://api.petfinder.com/shelter.getPets?key=1234567&id=123", "pet_list.xml")
+    pets = @client.shelter_pets(123)
+    pets.first.name.should == 'Petey'    
+  end
+  
+  it "should get an authorization token" do
+    digest = @client.send(:digest_key_and_secret)
+    stub_get("http://api.petfinder.com/auth.getToken?key=1234567&sig=#{digest}", "auth.xml")
+    @client.token.should == '39038a000f404335d90bab019c0c7e2d'
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/{test/helper.rb → spec/spec_helper.rb}

@@ -1,21 +1,16 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'fakeweb'
-
-begin require 'redgreen'; rescue LoadError; end
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'petfinder'
+require 'spec'
+require 'spec/autorun'
+require 'fakeweb'
 
-class Test::Unit::TestCase
+Spec::Runner.configure do |config|  
 end
 
 def fixture_file(filename)
-  return '' if filename == ''
-  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
-  File.read(file_path)
+  File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
 end
 
 def stub_get(url, filename, options={})

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: petfinder
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Eric Hutzelman
@@ -14,30 +15,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-12 00:00:00 -05:00
+date: 2010-07-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hashie
+  name: happymapper
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
-        - 1
         - 3
-        version: 0.1.3
+        - 2
+        version: 0.3.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 0
         - 5
@@ -46,26 +51,30 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
-        - 2
-        - 10
         - 1
-        version: 2.10.1
+        - 3
+        - 0
+        version: 1.3.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: fakeweb
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 1
         - 2
@@ -90,15 +99,21 @@ files:
 - Rakefile
 - VERSION
 - lib/petfinder.rb
+- lib/petfinder/auth.rb
+- lib/petfinder/breeds.rb
 - lib/petfinder/client.rb
-- test/fixtures/auth.xml
-- test/fixtures/breed_list.xml
-- test/fixtures/pet.xml
-- test/fixtures/pet_list.xml
-- test/fixtures/shelter.xml
-- test/fixtures/shelter_list.xml
-- test/helper.rb
-- test/test_petfinder.rb
+- lib/petfinder/pet.rb
+- lib/petfinder/shelter.rb
+- petfinder.gemspec
+- spec/fixtures/auth.xml
+- spec/fixtures/breed_list.xml
+- spec/fixtures/pet.xml
+- spec/fixtures/pet_list.xml
+- spec/fixtures/shelter.xml
+- spec/fixtures/shelter_list.xml
+- spec/petfinder_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/ehutzelman/petfinder
 licenses: []
@@ -109,26 +124,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby gem wrapper for the Petfinder API
 test_files: 
-- test/helper.rb
-- test/test_petfinder.rb
+- spec/petfinder_spec.rb
+- spec/spec_helper.rb

data/test/test_petfinder.rb

@@ -1,67 +0,0 @@
-require 'helper'
-
-class TestPetfinder < Test::Unit::TestCase
-
-  context "When working with the Petfinder API" do
-    setup do
-      @client = Petfinder::Client.new('1234567', 'mysekrit')
-    end
-
-    should "get a random pet" do
-      stub_get("http://api.petfinder.com/pet.getRandom?key=1234567&output=full", "pet.xml")
-      pet = @client.random_pet
-      assert_equal 'Charlie', pet.name
-    end
-    
-    should "get a specific pet by id" do
-      stub_get("http://api.petfinder.com/pet.get?key=1234567&id=123", "pet.xml")
-      pet = @client.pet(123)
-      assert_equal 'Charlie', pet.name      
-    end
-    
-    should "find pets matching a query" do
-      stub_get("http://api.petfinder.com/pet.find?key=1234567&animal=dog&location=77007", "pet_list.xml")
-      pets = @client.find_pets('dog', '77007')
-      assert_equal 'Petey', pets.first.name
-    end
-    
-    should "get the list of breeds for the given animal type" do
-      stub_get("http://api.petfinder.com/breed.list?key=1234567&animal=horse", "breed_list.xml")
-      breeds = @client.breeds('horse')
-      assert_equal 'Appaloosa', breeds.first
-    end
-
-    should "get a specific shelter by id" do
-      stub_get("http://api.petfinder.com/shelter.get?key=1234567&id=123", "shelter.xml")
-      shelter = @client.shelter(123)
-      assert_equal 'Lucky Dog Rescue', shelter.name      
-    end
-
-    should "find shelters matching a query" do
-      stub_get("http://api.petfinder.com/shelter.find?key=1234567&location=77007", "shelter_list.xml")
-      shelters = @client.find_shelters('77007')
-      assert_equal 'Pup Squad Animal Rescue', shelters.first.name
-    end
-
-    should "find shelters matching a breed" do
-      stub_get("http://api.petfinder.com/shelter.listByBreed?key=1234567&animal=horse&breed=arabian", "shelter_list.xml")
-      shelters = @client.find_shelters_by_breed('horse', 'arabian')
-      assert_equal 'Pup Squad Animal Rescue', shelters.first.name
-    end
-    
-    should "get the list of pets available for the given shelter" do
-      stub_get("http://api.petfinder.com/shelter.getPets?key=1234567&id=123", "pet_list.xml")
-      pets = @client.shelter_pets(123)
-      assert_equal 'Petey', pets.first.name      
-    end
-    
-    should "get an authorization token" do
-      digest = @client.send(:digest_key_and_secret)
-      stub_get("http://api.petfinder.com/auth.getToken?key=1234567&sig=#{digest}", "auth.xml")
-      assert_equal '39038a000f404335d90bab019c0c7e2d', @client.token
-    end
-    
-  end
-
-  
-end