petfinder_client 0.1

data/spec/client_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+## NOTE: use this as an "integration" test between our different objects
+
+describe "PetFinder::Client" do
+  
+  before(:each) do
+    @client = PetFinder::Client.new('fake')
+  end
+  
+  context "finding list of shelters" do
+    use_vcr_cassette
+    it "should return a list of shelters given a zipcode or city and state" do
+      shelters = @client.find_shelters('92102', {:limit => 2})
+      shelters.map{|s| s.id}.should == two_shelters.map{|s| s.id}
+    end
+  end
+  
+  context "get single shelter with id" do
+    use_vcr_cassette
+    it "should find a single shelter given a shelter id" do
+      shelter = @client.get_shelter('fake')
+      shelter.id.should == one_shelter.id
+    end
+  end
+  
+  context "list breeds" do
+    use_vcr_cassette
+    it "should list breeds given an animal type" do
+      breeds = @client.list_breeds('dog').should == dog_breeds_list
+    end
+  end
+  
+  context "finding list of pets" do
+    use_vcr_cassette
+    it "should return a list of pets given a zipcode or city and state" do
+      pets = @client.find_pets('San Diego, CA', {:count => 2, :animal => 'dog'})
+      pets.map{|p| p.id}.should == two_pets.map{|p| p.id}
+    end
+  end
+  
+  # context "find shelters with breed" do
+  #   use_vcr_cassette
+  #   it "should return a list of shelters with a given animal and breed" do
+  #     client = PetFinder::Client.new('afb752054145806e86da4d38721f2bb6')
+  #     shelters = client.list_shelters_with_breed('dog', 'collie', {:count => 2})
+  #   end
+  # end
+  
+  context "get single pet with id" do
+    use_vcr_cassette 
+    it "should return a single pet with a given id" do
+      pet = @client.get_pet('fake')
+      pet.id.should == one_pet.id
+    end
+  end
+  
+  
+end

data/spec/live_pf_api_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+# NOTE: you need a valid Pet Finder API Key.  Use the PF_API_KEY environment variable.
+# Example: LIVE_PF_API=acbd1234 rspec live_pf_api_spec.rb
+
+
+# TODO: This spec will test the live API - just in case PetFinder changes it's API format.  It should not be run as a normal part of the test suite.
+if ENV['LIVE_PF_API']
+
+  describe "Live testing of the Pet Finder API" do
+  
+    it "should return a valid client with a valid key" do
+      pending "should we test the client upon initialization for a valid API key ?"
+    end
+  
+  end
+
+end

data/spec/pet_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe "PetFinder::Pet" do
+  
+  it "should be able to extract a hash of photo urls from it's data" do
+    pet = full_pet_objs[0]
+    pet.get_photos.should == pet_photos_hash
+  end
+  
+end

data/spec/shelter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+
+describe "PetFinder::Shelter" do
+  
+  context "shelter pets" do
+    use_vcr_cassette
+    it "should return a list of pets that belong to a given shelter" do
+      shelter = one_shelter
+      # note: we need to instansiate the client here to make this unit test pass - yucky.  cost of having the 
+      #       shelter classes dependent on the client class.  maybe this method should be moved to the the client class ?
+      client = PetFinder::Client.new('fake')
+      pets = shelter.get_pets({:count => 2})
+      pets.map{|p| p.id}.should == two_shelter_pets.map{|p| p.id}
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,118 @@
+$:.unshift(File.join(File.dirname(__FILE__)))
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+require 'rubygems'
+require 'rspec'
+require 'vcr'
+require 'active_support/core_ext'
+
+require 'pet_finder'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.stub_with :webmock
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end
+
+CASSETTE_BASE_PATH = 'spec/cassettes/PetFinder_Client/'
+
+def two_shelters
+  res = []
+  # note: this is really just testing HTTParty...
+  # yaml = YAML.load(File.open(CASSETTE_BASE_PATH + 'finding_list_of_shelters.yml'))
+  # xml = get_cassette_xml(yaml)
+  # doc = Nokogiri(xml)
+  # doc.xpath('//shelters/shelter').each do |node|
+  #   res << PetFinder::Shelter.new(Hash.from_xml(node.to_s)['shelter'])
+  # end
+  shelter_ids = ['CA1080','CA1482']
+  shelter_ids.each{|id| res <<  PetFinder::Shelter.new({:id => id})}
+  res
+end
+
+def one_shelter
+  two_shelters[0]
+end
+
+def dog_breeds_list
+  #   yaml = YAML.load(File.open(CASSETTE_BASE_PATH + 'list_breeds.yml'))
+  #   xml = get_cassette_xml(yaml)
+  #   doc = Nokogiri(xml)
+  #   Hash.from_xml(doc.xpath('//breeds').to_s)['breeds']['breed']
+  ["Affenpinscher", "Afghan Hound", "Airedale Terrier", "Akbash", "Akita", "Alaskan Malamute", "American Bulldog", "American Eskimo Dog", "American Hairless Terrier", "American Staffordshire Terrier", "American Water Spaniel", "Anatolian Shepherd", "Appenzell Mountain Dog", "Australian Cattle Dog (Blue Heeler)", "Australian Kelpie", "Australian Shepherd", "Australian Terrier", "Basenji", "Basset Hound", "Beagle", "Bearded Collie", "Beauceron", "Bedlington Terrier", "Belgian Shepherd Dog Sheepdog", "Belgian Shepherd Laekenois", "Belgian Shepherd Malinois", "Belgian Shepherd Tervuren", "Bernese Mountain Dog", "Bichon Frise", "Black and Tan Coonhound", "Black Labrador Retriever", "Black Mouth Cur", "Black Russian Terrier", "Bloodhound", "Blue Lacy", "Bluetick Coonhound", "Boerboel", "Bolognese", "Border Collie", "Border Terrier", "Borzoi", "Boston Terrier", "Bouvier des Flanders", "Boxer", "Boykin Spaniel", "Briard", "Brittany Spaniel", "Brussels Griffon", "Bull Terrier", "Bullmastiff", "Cairn Terrier", "Canaan Dog", "Cane Corso Mastiff", "Carolina Dog", "Catahoula Leopard Dog", "Cattle Dog", "Caucasian Sheepdog (Caucasian Ovtcharka)", "Cavalier King Charles Spaniel", "Chesapeake Bay Retriever", "Chihuahua", "Chinese Crested Dog", "Chinese Foo Dog", "Chinook", "Chocolate Labrador Retriever", "Chow Chow", "Cirneco dell'Etna", "Clumber Spaniel", "Cockapoo", "Cocker Spaniel", "Collie", "Coonhound", "Corgi", "Coton de Tulear", "Curly-Coated Retriever", "Dachshund", "Dalmatian", "Dandi Dinmont Terrier", "Doberman Pinscher", "Dogo Argentino", "Dogue de Bordeaux", "Dutch Shepherd", "English Bulldog", "English Cocker Spaniel", "English Coonhound", "English Pointer", "English Setter", "English Shepherd", "English Springer Spaniel", "English Toy Spaniel", "Entlebucher", "Eskimo Dog", "Feist", "Field Spaniel", "Fila Brasileiro", "Finnish Lapphund", "Finnish Spitz", "Flat-coated Retriever", "Fox Terrier", "Foxhound", "French Bulldog", "Galgo Spanish Greyhound", "German Pinscher", "German Shepherd Dog", "German Shorthaired Pointer", "German Spitz", "German Wirehaired Pointer", "Giant Schnauzer", "Glen of Imaal Terrier", "Golden Retriever", "Gordon Setter", "Great Dane", "Great Pyrenees", "Greater Swiss Mountain Dog", "Greyhound", "Harrier", "Havanese", "Hound", "Hovawart", "Husky", "Ibizan Hound", "Illyrian Sheepdog", "Irish Setter", "Irish Terrier", "Irish Water Spaniel", "Irish Wolfhound", "Italian Greyhound", "Italian Spinone", "Jack Russell Terrier", "Jack Russell Terrier (Parson Russell Terrier)", "Japanese Chin", "Jindo", "Kai Dog", "Karelian Bear Dog", "Keeshond", "Kerry Blue Terrier", "Kishu", "Klee Kai", "Komondor", "Kuvasz", "Kyi Leo", "Labrador Retriever", "Lakeland Terrier", "Lancashire Heeler", "Leonberger", "Lhasa Apso", "Lowchen", "Maltese", "Manchester Terrier", "Maremma Sheepdog", "Mastiff", "McNab", "Miniature Pinscher", "Mountain Cur", "Mountain Dog", "Munsterlander", "Neapolitan Mastiff", "New Guinea Singing Dog", "Newfoundland Dog", "Norfolk Terrier", "Norwegian Buhund", "Norwegian Elkhound", "Norwegian Lundehund", "Norwich Terrier", "Nova Scotia Duck-Tolling Retriever", "Old English Sheepdog", "Otterhound", "Papillon", "Patterdale Terrier (Fell Terrier)", "Pekingese", "Peruvian Inca Orchid", "Petit Basset Griffon Vendeen", "Pharaoh Hound", "Pit Bull Terrier", "Plott Hound", "Podengo Portugueso", "Pointer", "Polish Lowland Sheepdog", "Pomeranian", "Poodle", "Portuguese Water Dog", "Presa Canario", "Pug", "Puli", "Pumi", "Rat Terrier", "Redbone Coonhound", "Retriever", "Rhodesian Ridgeback", "Rottweiler", "Saint Bernard St. Bernard", "Saluki", "Samoyed", "Sarplaninac", "Schipperke", "Schnauzer", "Scottish Deerhound", "Scottish Terrier Scottie", "Sealyham Terrier", "Setter", "Shar Pei", "Sheep Dog", "Shepherd", "Shetland Sheepdog Sheltie", "Shiba Inu", "Shih Tzu", "Siberian Husky", "Silky Terrier", "Skye Terrier", "Sloughi", "Smooth Fox Terrier", "South Russian Ovtcharka", "Spaniel", "Spitz", "Staffordshire Bull Terrier", "Standard Poodle", "Sussex Spaniel", "Swedish Vallhund", "Terrier", "Thai Ridgeback", "Tibetan Mastiff", "Tibetan Spaniel", "Tibetan Terrier", "Tosa Inu", "Toy Fox Terrier", "Treeing Walker Coonhound", "Vizsla", "Weimaraner", "Welsh Corgi", "Welsh Springer Spaniel", "Welsh Terrier", "West Highland White Terrier Westie", "Wheaten Terrier", "Whippet", "White German Shepherd", "Wire Fox Terrier", "Wire-haired Pointing Griffon", "Wirehaired Terrier", "Xoloitzcuintle (Mexican Hairless)", "Yellow Labrador Retriever", "Yorkshire Terrier Yorkie"]
+end
+
+def two_pets
+  res = []
+  #   yaml = YAML.load(File.open(CASSETTE_BASE_PATH + 'finding_list_of_pets.yml'))
+  #   xml = get_cassette_xml(yaml)
+  #   doc = Nokogiri(xml)
+  #   doc.xpath('//pets/pet').each{|node| res << PetFinder::Pet.new(Hash.from_xml(node.to_s)['pet'])}
+  pet_ids = ['19901761','20775306']
+  pet_ids.each{|id| res << PetFinder::Pet.new({:id => id})}
+  res
+end
+
+def one_pet
+  two_pets[0]
+end
+
+def full_pet_objs
+  res = []
+  yaml = YAML.load(File.open(CASSETTE_BASE_PATH + 'finding_list_of_pets.yml'))
+  xml = get_cassette_xml(yaml)
+  doc = Nokogiri(xml)
+  doc.xpath('//pets/pet').each{|node| res << PetFinder::Pet.new(Hash.from_xml(node.to_s)['pet'])}
+  res
+end
+
+def pet_photos_hash
+  my_pet_photos = {}
+  yaml = YAML.load(File.open(CASSETTE_BASE_PATH + 'finding_list_of_pets.yml'))
+  xml = get_cassette_xml(yaml)
+  doc = Nokogiri(xml)
+  first_pet_photos_node = doc.xpath('//pets/pet/media/photos')[0]
+  all_photos = []
+  0..5.times do |x|
+    all_photos << first_pet_photos_node.children.select{|node| node['id'] == x.to_s}
+  end
+  all_photos.each_with_index do |photo_array, idx|
+    res_hash = {
+      '500x500' => nil,
+      'max50_height' => nil,
+      '300x250' => nil,
+      'max60_wide' => nil,
+      'max95_wide' => nil
+    }
+    photo_array.each do |photo_node|
+      res_hash['500x500'] = photo_node.text if photo_node.text.match(/x\.jpg$/)
+      res_hash['max50_height'] = photo_node.text if photo_node.text.match(/t\.jpg$/)
+      res_hash['300x250'] = photo_node.text if photo_node.text.match(/pn\.jpg$/)
+      res_hash['max60_wide'] = photo_node.text if photo_node.text.match(/pnt\.jpg$/)
+      res_hash['max95_wide'] = photo_node.text if photo_node.text.match(/fpm\.jpg$/)
+    end
+    my_pet_photos["photo_#{idx.to_s}"] = res_hash unless res_hash.values.compact.empty?
+  end
+  my_pet_photos
+end
+
+def two_shelter_pets
+  res = []
+  # yaml = YAML.load(File.open('spec/cassettes/PetFinder_Shelter/shelter_pets.yml'))
+  # xml = get_cassette_xml(yaml)
+  # doc = Nokogiri(xml)
+  # doc.xpath('//pets/pet').each{|node| res << PetFinder::Pet.new(Hash.from_xml(node.to_s)['pet'])}
+  pet_ids = ['10937712','11482281']
+  pet_ids.each{|id| res << PetFinder::Pet.new({:id => id})}
+  res
+end
+
+def get_cassette_xml(yaml)
+  yaml['http_interactions'][0]['response']['body']['string']
+end
+
+
+
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: petfinder_client
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- Ben Wanicur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.2"
+  type: :runtime
+  version_requirements: *id003
+description: Wrapper for Petfinder API
+email: bwanicur@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pet_finder/client.rb
+- lib/pet_finder/pet.rb
+- lib/pet_finder/shelter.rb
+- lib/pet_finder.rb
+- spec/cassettes/PetFinder_Client/finding_list_of_pets.yml
+- spec/cassettes/PetFinder_Client/finding_list_of_shelters.yml
+- spec/cassettes/PetFinder_Client/get_single_pet_with_id.yml
+- spec/cassettes/PetFinder_Client/get_single_shelter_with_id.yml
+- spec/cassettes/PetFinder_Client/list_breeds.yml
+- spec/cassettes/PetFinder_Shelter/shelter_pets.yml
+- spec/client_spec.rb
+- spec/live_pf_api_spec.rb
+- spec/pet_spec.rb
+- spec/shelter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/bwanicur/petfinder_client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: petfinder_client
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Wrapper for Petfinder API
+test_files: []
+