petfinder 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b28e75a76d5020eee7da565a46a5fed8474fa20e143264d0052dc53964556cd5
-  data.tar.gz: 49cf181c6c288f43fca0fcff463ced1f28e3a830d0b56957fd8a994669df693b
+  metadata.gz: a4a9842b812f2dfe0d78832d1911c77bbb96a13575c2a539ac71f9bddab55a0f
+  data.tar.gz: f3fa81db5471239ec8b2256f9aee94e054bfadfbe2297acc40e848f27f498f19
 SHA512:
-  metadata.gz: 0eef74086d9f3ab7e342be2736d08c62559745b465efc01972165036f8fa34f0a8bfddf2ac24dbfae6353361689a07da6e9923a1b9705aab64d5c5793369ce16
-  data.tar.gz: 7b1de5fd3613965e76e3676ca4f013faa3cec4068adf2488ad8aaae8e7a77f21b3b32348f238b8c3666b694c188682ecba611b10414d4978e72248a7667667ea
+  metadata.gz: 614b1d2afb98c21d3e7917abafeb944e336b13a0c1187d08f33ca539f15dfb74a769947844939f6867eb1bd5ab879ddec37c8a7c6e469f6c2b7ddf02f33af304
+  data.tar.gz: 940f4c7da2924f0e39a41ce8c5c573c2a80fa6073bb4e15782b0b890814632c11d35dcbca7ce4c95e3dce51b742a0f1da58303eee443d8e3757da8af4dca864e

data/.gitignore

@@ -1,9 +1,13 @@
 .DS_STORE
-coverage/*
-pkg/*
-tmp/*
-*.gem
-.bundle
-.rvmrc
-rdoc/*
-bin
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

data/.travis.yml

@@ -1,5 +1,6 @@
+---
 language: ruby
+cache: bundler
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+2.0.0
+-----
+* Rewrite for new petfinder API v2.0 which uses JSON and oauth2
+
 1.0.4
 -----
 * Update gem dependencies to latest versions

data/Gemfile

@@ -1,14 +1,6 @@
 source 'https://rubygems.org'
-
-gem 'rake'
-
-group :development do
-  gem 'pry'
-end
-
-group :test do
-  gem 'rspec', '>= 2.14'
-  gem 'webmock'
-end
-
 gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "webmock"

data/Gemfile.lock

@@ -1,59 +1,62 @@
 PATH
   remote: .
   specs:
-    petfinder (1.0.4)
-      excon (~> 0.26)
-      nokogiri (~> 1.6)
+    petfinder (2.0.0)
+      hashie
+      oauth2
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    coderay (1.1.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    excon (0.59.0)
-    hashdiff (0.3.7)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    pry (0.11.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.0.1)
-    rake (12.2.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.0)
+    hashie (4.0.0)
+    jwt (2.2.1)
+    multi_json (1.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.2)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    public_suffix (4.0.2)
+    rack (2.0.8)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    safe_yaml (1.0.4)
-    webmock (3.1.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    webmock (3.7.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
   petfinder!
-  pry
-  rake
-  rspec (>= 2.14)
+  rake (~> 12.0)
+  rspec (~> 3.0)
   webmock
 
 BUNDLED WITH
-   1.16.0
+   2.1.2

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Eric Hutzelman
+Copyright (c) 2020 Eric Hutzelman
 
 MIT License
 

data/README.md

@@ -7,7 +7,10 @@
 [gem]: https://rubygems.org/gems/petfinder
 [travis]: http://travis-ci.org/ehutzelman/petfinder
 
-Ruby gem wrapper for the [Petfinder API](http://www.petfinder.com/developers/api-docs).
+Ruby gem wrapper for the [Petfinder API v2.0](https://www.petfinder.com/developers/v2/docs).
+
+**NOTE**: The gem to support v1.0 of the API can be found on the [v1 branch](https://github.com/ehutzelman/petfinder/tree/v1), but be warned that
+Petfinder will be deprecating this v1 API in early 2020.
 
 ## Installation
 
@@ -25,7 +28,7 @@ Or install it yourself as:
 
 ## Get your API key
 
-Get your Petfinder API key at: http://www.petfinder.com/developers/api-key
+Get your Petfinder API key at: https://www.petfinder.com/developers
 
 ## Usage
 
@@ -45,70 +48,90 @@ petfinder = Petfinder::Client.new
 
 ## Examples
 
-#### Return a list of dogs in the "90210" zip code
+#### Return a list of dogs in the "90210" zip code (with pagination)
+A hash of parameters can be passed to this method, but none are required. You can find the full set of allowable parameters here:
+[Petfinder animals endpoint documentation](https://www.petfinder.com/developers/v2/docs/#get-animals).
 
 ```ruby
-pets = petfinder.find_pets('dog', '90210')
-pets.count
-# => "25"
-
-pets.first.name
-# => "Petey"
-
-pets.first.shelterid
-# => "CA123"
+animals, pagination = petfinder.animals(type: 'dog', location: '90210', page: 1)
+
+animals.first.name
+# => "Tyra"
+animals.first.photos.first.full
+# => "https://dl5zpyw5k3jeb.cloudfront.net/photos/pets/47027518/2/?bust=1578168103"
+animals.first.organization_id
+# => "CA2350"
+
+animals.pagination.count_per_page
+# => "20"
+animals.pagination.total_pages
+# => "8853"
 ```
 
-#### Returning paged results
+#### Return a list of organizations (with pagination)
+A hash of parameters can be passed to this method, but none are required. You can find the full set of allowable parameters here:
+[Petfinder organizations endpoint documentation](https://www.petfinder.com/developers/v2/docs/#get-organizations).
 
 ```ruby
-petfinder.find_pets('dog', 77057, count: 25)
-
-# page 2
-petfinder.find_pets('dog', 77057, count: 25, offset: 25)
+organizations, pagination = petfinder.organizations({ location: '90210', limit: 5 })
 
-# page 3
-petfinder.find_pets('dog', 77057, count: 25, offset: 50)
+organizations.first.name
+# => "STAR Eco Station"
 
-# page 4
-petfinder.find_pets('dog', 77057, count: 25, offset: 75)
+organizations.pagination.count_per_page
+# => "5"
+organizations.pagination.total_count
+# => "265"
+organizations.pagination.total_pages
+# => "53"
 ```
 
-#### Return information about the shelter with id "CA123"
+#### Return information about the organization (shelter) with id "CA2350"
 
 ```ruby
-shelter = petfinder.shelter('CA123')
-shelter.name
-# => "Melrose Place SPCA"
-```
+organization = petfinder.organization('CA2350')
+
+organization.name
+# => "Promise 4 Paws"
 
-#### Other available methods
+organization.address.city
+# => "San Juan Capistrano"
+```
 
+#### Return a list of animal types
 ```ruby
-# Valid animal types: barnyard, bird, cat, dog, horse, pig, reptile, smallfurry
-breeds = petfinder.breeds(animal_type)
+types = petfinder.types
 
-# Options available: animal, breed, size, sex, location, shelterid
-pet = petfinder.random_pet(options)
-pet = petfinder.pet(id)
+types.first.name
+# => "Dog"
 
-# Options available: breed, size, sex, age, offset, count
-pets = petfinder.find_pets(animal_type, location, options)
+types.first.colors
+# => ["Brown", "Black", "Yellow"]
+```
 
-# Options available: status, offset, count
-pets = shelter_pets(shelter_id, options)
+#### Return a list of breeds for a given animal type
+```ruby
+breeds = petfinder.breeds('dog')
 
-# Options available: name, offset, count
-shelters = petfinder.find_shelters(location, options)
-shelters = petfinder.find_shelters_by_breed(animal_type, breed)
+breeds.length
+# => 275
 
-shelter = petfinder.shelter(shelter_id)
+breeds.first.name
+# => "Affenpinscher"
 ```
 
-## TODO
+## Handling errors
+A Petfinder::Error exception will be raised if the response fails with a bad response. This exception contains a hash of error information returned by Petfinder.
+
+```ruby
+animals, pagination = petfinder.animals(type: 'invalid_type')
+# => Petfinder::Error (Invalid Request: The request contains invalid parameters.)
+
+rescue Petfinder::Error => exception
 
-* Implement use of security token when Petfinder requires it
-* Support paging for results
+exception.data
+# => {"type"=>"https://www.petfinder.com/developers/v2/docs/errors/ERR-00002/", "status"=>400, "title"=>"Invalid Request", "detail"=>"The request contains invalid parameters.", "invalid-params"=>[{"in"=>"query", "path"=>"type", "message"=>"invalid_type is not a valid animal type."}]}
+```
 
 ## Contributing
 
@@ -120,7 +143,7 @@ shelter = petfinder.shelter(shelter_id)
 
 ## Copyright
 
-Copyright (c) 2010-2013 Eric Hutzelman.
+Copyright (c) 2010-2020 Eric Hutzelman.
 See [LICENSE][] for details.
 
 [license]: LICENSE.txt

data/Rakefile

@@ -4,11 +4,3 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-
-task :console do
-  require "irb"
-  require "irb/completion"
-  require "petfinder"
-  ARGV.clear
-  IRB.start
-end

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end