petfinder 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47a41c15628e5a05277200f92fe73134cbb5abd9
-  data.tar.gz: e9a0e41e252308424899152388c13a792026a251
+SHA256:
+  metadata.gz: 194b9424594d700859ccb94d133b7a594be01dba5b6aa07649b92c909a0b81a7
+  data.tar.gz: 2d0afad0a028a584d09c25ff5ef3707e9f4f02333507330eba9db0d4e99ec1c1
 SHA512:
-  metadata.gz: 42f1ddc329ac0aba83f4fb1e85b41344a4b9f26d299ba3f5309906c785bd68f2652128b05c0efbc48db9f7c7474e88959b19f11873a81e1d69c4037f0264d105
-  data.tar.gz: 6e7f47c52417058239fb457a55304e895911db0516e717e3fbf74140bc3756fafc890ad513d504bc84fecdaa125eb591f0d3e2b651f19773a14e2d13516b8543
+  metadata.gz: 96cea717773b8116e6d2b76aa35ef97ad8c3fb3231ceaf4ee0ccc997492bba357a71a08a8d0cd108331f937cd9e83647532f48ba51595303e734627f78be4488
+  data.tar.gz: 3be76b22eac55fb37c536eaf8a720d0d4c77c3be947272ed9386127c36e7dc234488f747a0d818667f3e96accdfa21837c257fc4020df17f6cd12c7938d0134a

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

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+2.0.1
+-----
+* Update gem dependencies to latest versions
+
+2.0.0
+-----
+* Rewrite for new petfinder API v2.0 which uses JSON and oauth2
+
+1.0.4
+-----
+
+
+1.0.3
+-----
+* Adding inspect methods and rake console tasks (JessSumner)
+
+1.0.2
+-----
+* Add contact object to pet (lynnaloo)
+
 1.0.1
 -----
 * Update gem dependencies and 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,49 +1,62 @@
 PATH
   remote: .
   specs:
-    petfinder (1.0.1)
-      excon (~> 0.26)
-      nokogiri (~> 1.6)
+    petfinder (2.0.0)
+      hashie
+      oauth2
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
-    coderay (1.0.9)
-    crack (0.4.1)
-      safe_yaml (~> 0.9.0)
-    diff-lcs (1.2.4)
-    excon (0.26.0)
-    method_source (0.8.2)
-    mini_portile (0.5.1)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    safe_yaml (0.9.7)
-    slop (3.4.6)
-    webmock (1.13.0)
-      addressable (>= 2.2.7)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    hashie (4.1.0)
+    jwt (2.2.1)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.4)
+      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.5)
+    rack (2.2.3)
+    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.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      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
+   2.1.4

data/LICENSE.txt

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

data/README.md

@@ -1,6 +1,16 @@
 # Petfinder
 
-Ruby gem wrapper for the [Petfinder API](http://www.petfinder.com/developers/api-docs).
+[![Gem Version](https://badge.fury.io/rb/petfinder.png)][gem]
+[![Build Status](https://secure.travis-ci.org/ehutzelman/petfinder.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/ehutzelman/petfinder.png)](https://codeclimate.com/github/ehutzelman/petfinder)
+
+[gem]: https://rubygems.org/gems/petfinder
+[travis]: http://travis-ci.org/ehutzelman/petfinder
+
+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
 
@@ -18,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
 
@@ -28,36 +38,100 @@ Get your Petfinder API key at: http://www.petfinder.com/developers/api-key
 
 ### or configure once
 
-    Petfinder.configure do |config|
-      config.api_key = 'your_api_key'
-      config.api_secret = 'your_api_secret'
-    end
-    petfinder = Petfinder::Client.new
+```ruby
+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
+#### 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
+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"
+
+pagination.count_per_page
+# => "20"
+pagination.total_pages
+# => "8853"
+```
+
+#### 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
+organizations, pagination = petfinder.organizations({ location: '90210', limit: 5 })
+
+organizations.first.name
+# => "STAR Eco Station"
+
+pagination.count_per_page
+# => "5"
+pagination.total_count
+# => "265"
+pagination.total_pages
+# => "53"
+```
 
-    pets = petfinder.find_pets('dog', '90210')
-    pets.count
-    # => "25"
+#### Return information about the organization (shelter) with id "CA2350"
 
-    pets.first.name
-    # => "Petey"
+```ruby
+organization = petfinder.organization('CA2350')
 
-    pets.first.shelterid
-    # => "CA123"
+organization.name
+# => "Promise 4 Paws"
 
-#### Return information about the shelter with id "CA123"
+organization.address.city
+# => "San Juan Capistrano"
+```
 
-    shelter = petfinder.shelter('CA123')
-    shelter.name
-    # => "Melrose Place SPCA"
+#### Return a list of animal types
+```ruby
+types = petfinder.types
 
-## TODO
+types.first.name
+# => "Dog"
 
-* Implement use of security token when Petfinder requires it
-* Support paging for results
+types.first.colors
+# => ["Brown", "Black", "Yellow"]
+```
+
+#### Return a list of breeds for a given animal type
+```ruby
+breeds = petfinder.breeds('dog')
+
+breeds.length
+# => 275
+
+breeds.first.name
+# => "Affenpinscher"
+```
+
+## 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
+
+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
 
@@ -66,3 +140,10 @@ Get your Petfinder API key at: http://www.petfinder.com/developers/api-key
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2010-2020 Eric Hutzelman.
+See [LICENSE][] for details.
+
+[license]: LICENSE.txt

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