petfinder-wrap 1.0.3.4 → 1.0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a7c9cb4fc57801cd466d836a5941b01cf0f49e9
-  data.tar.gz: e72912d816c947fc9a851033d53b4651f77aff7a
+  metadata.gz: dc00dae7ebf51c9d7599d4b0b0686f1715b4aab9
+  data.tar.gz: 8c4aee16fc7b2c0637312d32451fd0ce7576e7e3
 SHA512:
-  metadata.gz: 58bea7a08f9a92bcfcbd63e1e4c2cc6cf651fba33d8e860cdae5b83011fa337c671dc9242bf98a2ff7c7def7f3d747d531c4e0d2f60e8f7aa6c88e6a382c0886
-  data.tar.gz: 808b16ff22cfe47857124c5b18fb40b779d83f8afd1b149968754ae34d56e452791246e55328f7ec839e7d51b794c18b38d95c749686ec48f511b0b86ad40c8f
+  metadata.gz: 0ca4a8657817948e9eaad99022115de9cf2581f263120476b2ad296e9752cd27310257d0fd116f6d8ed584e27fd2e4a745262097753c0cfd38b3fd55aaeb7372
+  data.tar.gz: 616219478f3ebe3791e836fb5ee7739621540c3893e1396b2b282a8f19b8901e6acb8b87fd2cfa0c27828e5e2edb02d59170a2b6c57ecb0335108d11644a7315

data/README.md

@@ -2,7 +2,10 @@
 
 A simple gem for the Petfinder API using JSON responses and a traversal method.
 
-TODO: build out Breed.search instance methods for specific searches.
+Coming in the next release:
+
+* Options hashes (you rubes love options hashes)
+* <#Breed>.search_by instance method
 
 ## Installation
 
@@ -16,34 +19,55 @@ And then execute:
 
     $ bundle
 
+OR:
+```
+    $ bundle add petfinder-wrap
+    $ bundle install
+```
+to automatically add it to your Gemfile and install it.
+
 Or install it yourself as:
 
     $ gem install petfinder-wrap
 
 ## Usage
 
-If you are using in a rails app, place the following into your config/application.rb:
+If you are using in a rails app, place the following
+into config/initializers/petfinder.rb:
 
 ```ruby
       Petfinder.configure do |config|
         config.api_key = "YOUR API KEY HERE"
-        config.api_secret = "YOUR API SECRET HERE"
+        config.api_secret = "YOUR API SECRET HERE" # not needed yet, do not use
       end
 ```
+
 note: Currently, the API does not utilize a client secret for any requests. You are probably better off not setting this value in your code. In the future if they add PUT, POST, DELETE endpoints that require auth, the above config will work, if someone wants to build out those methods.
 
+For non-rails applications, add the gem to your Gemfile (see above) then:
+`your_app.rb:`
+```ruby
+      require 'petfinder-wrap'
+
+      Petfinder.configure do |config|
+        config.api_key = "YOUR API KEY HERE"
+        config.api_secret = "YOUR API SECRET HERE" # not needed yet, do not use
+      end
+```
+
 Afterward, you should be able to use
 ```ruby
 client = Petfinder::Client.new
-client.find_pets("dog", "33165") # => returns an array of Pets
-client.find_pet("38747365") # => returns a single Pet
-client.find_shelters("33131") # => returns an array of Shelters
-client.get_shelter("FL54") # => returns a single Shelter object
+client.find_pets "dog", "33165" # => returns an array of Pets
+client.find_pet "38747365" # => returns a single Pet
+client.find_shelters "33131" # => returns an array of Shelters
+client.get_shelter "FL54" # => returns a single Shelter object
 ```
 
+
 Additionally, try methods like
 ```ruby
-pet = client.find_pet("38747365")
+pet = client.find_pet "38747365"
 pet.name # => returns the pet's name
 pet.photos # => returns an array of Photo objects, with multiple size urls accessible by .small, .medium, .large, .thumbnail, .tiny
 pet.contact_info # => returns a hash of callable method names for contact info

data/lib/petfinder-wrap.rb

@@ -7,7 +7,7 @@ require_relative 'petfinder/breed'
 require 'open-uri'
 
 module Petfinder
-  VERSION = "1.0.3.4"
+  VERSION = "1.0.3.5"
 
   class Error < StandardError; end
 

data/lib/petfinder/client.rb

@@ -69,6 +69,23 @@ module Petfinder
       end
     end
 
+    def get_shelter_pets shelter
+      get_shelter_pets = API_BASE_URI + "shelter.getPets?key=#{@api_key}&id=#{shelter.id}&output=basic&format=json"
+      response = open(get_shelter_pets).read
+      res = []
+      if resp = JSON.parse(response)
+        begin
+          resp["petfinder"]["pets"]["pet"].each do |pet|
+            res << Pet.new(pet)
+          end
+        rescue NoMethodError => e
+          puts e.message
+          puts "Invalid response received from API. Check your query"
+        end
+        res
+      end
+    end
+
     def find_shelters location
       find_shelters_request = API_BASE_URI + "shelter.find?key=#{@api_key}&location=#{location}&format=json"
       response = open(find_shelters_request).read

data/lib/petfinder/shelter.rb

@@ -11,15 +11,7 @@ module Petfinder
     end
 
     def get_pets
-      get_shelter_pets = API_BASE_URI + "shelter.getPets?key=#{Client.new.api_key}&id=#{id}&output=basic&format=json"
-      response = open(get_shelter_pets).read
-      res = []
-      if resp = JSON.parse(response)
-        resp["petfinder"]["pets"]["pet"].each do |pet|
-          # res << Petfinder::Pet.new(pet[1][0])
-          res << Pet.new(pet)
-        end
-      end
+      res = Client.new.get_shelter_pets self
       res
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petfinder-wrap
 version: !ruby/object:Gem::Version
-  version: 1.0.3.4
+  version: 1.0.3.5
 platform: ruby
 authors:
 - Pedro De Ona
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the Petfinder RESTful API.