petfinder-wrap 1.0.0 → 1.0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aac1d2c8207508529a9ccdf00c0958066db0657
-  data.tar.gz: 8ad0045da80784397252b5bfe7108c9f729d7694
+  metadata.gz: 77edfce7c300f6582f65205f797109729bba997a
+  data.tar.gz: 8f6fa5d47055eea64e31b7636ab59a6260a42c95
 SHA512:
-  metadata.gz: 070be214cf4c9f5b37cb37a8344fc130e16522d58cb0d0b34acdcf2bae75a63c8506994feed7b5fcd156ed025620b990d2a60cc0e37d88e0d8a19de9a8c5960d
-  data.tar.gz: d56c5a8ae77803ebb30fb7496f8dbc98f24bb67f40ca0ecbe97e17b2f5551d277025ccf3bd1ae3ca14d45d6b8a7c3ca7f0a46340add9e73d7bf23cbad1dddee5
+  metadata.gz: 1852593cefe69a224708b4ff78279fd121e20a35ae4a752bbfd90111d8e93bb40e29c3d558ba2b3cc137f9da90acc8909eeb79ee0c2881b25045b8f40ccf8ce2
+  data.tar.gz: 6fdbacb05cd5113d4955d05ecc3ae713769cc768cc5a4e41cb5449195999bfbf59a90704972d0872ebb3f2f24a347701226c45ac011cf85b728569f3351689b3

data/README.md

@@ -1,8 +1,8 @@
 # Petfinder::Wrap
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/petfinder/wrap`. To experiment with that code, run `bin/console` for an interactive prompt.
+A simple gem for the Petfinder API using JSON responses and a traversal method.
 
-TODO: Delete this and the text above, and describe your gem
+TODO: build out <#Pet>.photos instance methods for max usability in rails apps.
 
 ## Installation
 
@@ -22,14 +22,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+If you are using in a rails app, place the following into your config/application.rb:
 
-## Development
+```ruby
+      Petfinder.configure do |config|
+        config.api_key = "YOUR API KEY HERE"
+        config.api_secret = "YOUR API SECRET HERE"
+      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.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Additionally, try methods like
+```ruby
+pet = client.find_pet("38747365")
+pet.name # => returns the pet's name
+pet.contact # => returns a hash of contact info
+```
+the same should function for shelters.
 
+Please see below for bug reporting and pull requests.
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/petfinder-wrap.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pdeona/petfinder-wrap.

data/lib/petfinder-wrap.rb

@@ -6,7 +6,7 @@ require_relative 'petfinder/client'
 require 'open-uri'
 
 module Petfinder
-  VERSION = "1.0.0"
+  VERSION = "1.0.1.1"
 
   class Error < StandardError; end
 

data/lib/petfinder/client.rb

@@ -47,16 +47,19 @@ module Petfinder
     end
 
     def find_shelters location
-      find_shelters_request = API_BASE_URI + "shelter.find?key=#{@api_key}&location=#{location}"
+      find_shelters_request = API_BASE_URI + "shelter.find?key=#{@api_key}&location=#{location}&format=json"
       response = open(find_shelters_request).read
-
+      res = []
+      if resp = JSON.parse(response)
+        resp["petfinder"]["shelters"]["shelter"].each do |shelter|
+          res << Shelter.new(shelter)
+        end
+      end
+      res
     end
+
   end
 
   private
 
-  def parse_pet_resp response
-
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petfinder-wrap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1.1
 platform: ruby
 authors:
 - Pedro De Ona