adopt_a_pet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85768d77d009bb82f767f155bcbd3cab6d27bcb3
+  data.tar.gz: 3cd64da528b83b8dfaa9d727a16728f59d1cf9bf
+SHA512:
+  metadata.gz: cd0686a40bdbe77b722b9abafa72eecc35aba9d9b8f61f996f4b43f031224b1dd5f078c7a9cf056a5ed50e6f53122e976396eafc0ca3482d82e027db7e4a9903
+  data.tar.gz: f871bb63fec835c047808c590f5c07c6f0b3c86925df6ed109780f201c69e5c92440db785acbeb911d8e622304eccaac87b46f5bdc72af6dd61259a747fd38ba

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+MethodLength:
+  Max: 20
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dolan.stephen1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adopt_a_pet.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stephen Dolan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# AdoptAPet
+
+Ruby gem wrapper for the [Adopt-A-Pet API](https://www.adoptapet.com/public/apis/pet_list.html)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adopt_a_pet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adopt_a_pet
+
+## Get Your API Key
+
+Get your Adopt-A-Pet API key by logging into a shelter account, then visiting [the API signup page](http://www.adoptapet.com/shelter/portable_pet_list_api).
+
+## Usage
+
+### Instantiate a Client
+
+`client = AdoptAPet::Client.new('your_api_key')`
+
+## Examples
+
+#### Return a list of pets at shelter '12345'
+
+```
+pet_response = client.pets_at_shelter('12345')
+
+# Determine the number of returned pets
+pet_response.count
+# => 50
+
+# Get the first pet's name
+pet_response.first.name
+# => "Rocky"
+
+# Get the first pet's photo
+pet_response.first.photos.first.dig(:original).url
+# => "https://s3.amazonaws.com/pet-uploads.adoptapet.com/6/f/3/92702234.jpg"
+```
+
+#### Return a list of pets at shelters '12345' and '56789'
+```
+pet_response = client.pets_at_shelters(['12345', '56789'])
+
+# Determine the number of returned pets
+pet_response.count
+# => 50
+
+# Get the first pet's name
+pet_response.first.name
+# => "Rocky"
+
+# Get the first pet's photo
+pet_response.first.photos.first.dig(:original).url
+# => "https://s3.amazonaws.com/pet-uploads.adoptapet.com/6/f/3/92702434.jpg"
+```
+
+#### Return limited details for the pet with ID '1234'
+```
+pet = client.limited_pet_details('1234')
+
+pet.name
+# => "Rocky"
+
+pet.id
+# => "123456"
+
+pet.purebred
+# => "0"
+```
+
+#### Get full pet details for the pet with ID '1234'
+```
+pet = client.pet_details('1234')
+
+pet.name
+# => "Rocky"
+
+pet.id
+# => "123456"
+
+pet.housetrained
+# => "1"
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/stephendolan/adopt_a_pet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/adopt_a_pet.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adopt_a_pet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adopt_a_pet'
+  spec.version       = AdoptAPet::VERSION
+  spec.authors       = ['Stephen Dolan']
+  spec.email         = ['stephen@stephencodes.com']
+
+  spec.summary       = 'Interface with the Adopt-A-Pet API'
+  spec.description   = 'Interface with the Adopt-A-Pet API'
+  spec.homepage      = 'https://gitlab.com/stephendolan/adopt_a_pet_api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.13.1'
+
+  spec.add_development_dependency 'bundler',     '~> 1.14'
+  spec.add_development_dependency 'rake',        '~> 10.0'
+  spec.add_development_dependency 'rspec',       '~> 3.7'
+  spec.add_development_dependency 'pry',         '~> 0.11.3'
+  spec.add_development_dependency 'rb-readline', '~> 0.5.3'
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'adopt_a_pet'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adopt_a_pet.rb

@@ -0,0 +1,20 @@
+require 'faraday'
+require 'json'
+
+require 'adopt_a_pet/version'
+require 'adopt_a_pet/client'
+require 'adopt_a_pet/pet'
+
+# Top-level module for the Adopt-A-Pet API Wrapper
+module AdoptAPet
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :api_key, :api_secret
+  end
+
+  def self.configure
+    yield self
+    true
+  end
+end

data/lib/adopt_a_pet/client.rb

@@ -0,0 +1,206 @@
+module AdoptAPet
+  # Class for interfacing with the Adopt-A-Pet API
+  # @author Stephen Dolan
+  #
+  # @!attribute api_key
+  #   @return [String] the user's API key to use in connections
+  # @!attribute conn
+  #   @return [Faraday::Connection] a Faraday object to make requests
+  class Client
+    attr_accessor :api_key, :conn
+
+    # Create a single instance of a Pet Photo
+    # @author Stephen Dolan
+    #
+    # @param [String] api_key the API key to authenticate with
+    #
+    # @return [void]
+    #
+    # @example Initialize a new Adopt-A-Pet Client
+    #   client = AdoptAPet::Client.new('my_api_key')
+    #   pets   = client.pets_at_shelter('12345')
+    def initialize(api_key = AdoptAPet.api_key)
+      raise(AdoptAPet::Error, 'API key is required.') unless api_key
+
+      self.api_key = api_key
+      self.conn    = setup_connection
+    end
+
+    # Retrieves all pets at a shelter
+    # @author Stephen Dolan
+    #
+    # @param [Integer] shelter_id the ID of the shelter to list pets at
+    # @param [Hash] opts the options to include with the request
+    # @option opts [String] :start_number (1) where to start results
+    # @option opts [String] :end_number (50) where to end results
+    #
+    # @return [Array<Pet>] a collection of Pets
+    #
+    # @example
+    #   client = AdoptAPet::Client.new('my_key')
+    #   pets   = client.pets_at_shelter(12345)
+    #   my_pet_name = pets.first.name
+    def pets_at_shelter(shelter_id, options = {})
+      query = options.merge(shelter_id: shelter_id)
+      response = perform_get('/search/pets_at_shelter', query)
+      Pet.multiple(response)
+    end
+
+    # Retrieves all pets at multiple shelters
+    # @author Stephen Dolan
+    #
+    # @param [Array<Integer>] shelter_ids set of shelter IDs to search for pets at
+    # @param [Hash] opts the options to include with the request
+    # @option opts [String] :start_number (1) where to start results
+    # @option opts [String] :end_number (50) where to end results
+    #
+    # @return [Array<Pet>] a collection of Pets
+    #
+    # @example
+    #   client = AdoptAPet::Client.new('my_key')
+    #   pets   = client.pets_at_shelter(12345, end_number: 1000)
+    #   my_pet_name = pets.first.name
+    def pets_at_shelters(shelter_ids, options = {})
+      query = options.merge(shelter_id: shelter_ids)
+      response = perform_get('/search/pets_at_shelters', query)
+      Pet.multiple(response)
+    end
+
+    # Retrieves a subset of the total pet data for a single pet
+    # @author Stephen Dolan
+    #
+    # @param [Integer] pet_id the ID of a single pet
+    #
+    # @return [Pet] a Pet object
+    #
+    # @example
+    #   client = AdoptAPet::Client.new('my_key')
+    #   pet    = client.limited_pet_details(123456)
+    #   my_pet_special_needs = pet.special_needs
+    def limited_pet_details(pet_id)
+      query = { pet_id: pet_id }
+      response = perform_get('/search/limited_pet_details', query)
+      Pet.new(response.dig('pet'))
+    end
+
+    # Retrieves a complete data set for a single pet
+    # @author Stephen Dolan
+    #
+    # @param [Integer] pet_id the ID of a single pet
+    #
+    # @return [Pet] a Pet object
+    #
+    # @example
+    #   client = AdoptAPet::Client.new('my_key')
+    #   pet    = client.pet_details(123456)
+    #   my_pet_housetrained = pet.housetrained
+    def pet_details(pet_id)
+      query = { pet_id: pet_id }
+      response = perform_get('/search/pet_details', query)
+      Pet.new(response.dig('pet'))
+    end
+
+    private
+
+    # Instantiate a Faraday connector with a base URL and adapter
+    # @author stephen dolan
+    #
+    # @return [faraday::connection] a faraday object to make requests
+    def setup_connection
+      # Set up a flexible connection to append the URI to and make requests with
+      Faraday.new(url: 'https://api.adoptapet.com') do |faraday|
+        # Include to log responses to STDOUT
+        faraday.response :logger
+
+        # Don't encode identical URL paramaeters with []
+        faraday.options.params_encoder = Faraday::FlatParamsEncoder
+
+        # Use the default Net::HTTP adapter
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    # Helper method to fetch data from the Adopt-A-Pet API endpoint
+    # @author Stephen Dolan
+    #
+    # @param [String] the URI to make the GET request to
+    # @param [Hash] opts the options to include with the request
+    # @option opts [String] :start_number (1) where to start results
+    # @option opts [String] :end_number (50) where to end results
+    #
+    # @return [Hash] an Adopt-A-Pet JSON API response parsed to a Ruby Hash
+    def perform_get(uri, options = {})
+      # Always fetch the output in JSON format
+      options = options.merge(output: :json)
+
+      # Always include the API key
+      options = options.merge(key: self.api_key)
+
+      # Always set the API version to version 1
+      options = options.merge(v: 1)
+
+      # Make the request
+      response = self.conn.get(uri, options)
+
+      # Validate the body and transform into a Ruby object
+      process_json_response(response.body)
+    end
+
+    # Parses a JSON body into a Ruby object if it is a valid response
+    # @author Stephen Dolan
+    #
+    # @param [String] the JSON response body from an Adopt-A-Pet API request
+    #
+    # @return [Hash] an Adopt-A-Pet JSON API response parsed to a Ruby Hash
+    def process_json_response(response_body)
+      # Parse the response into a Ruby object
+      response_object = JSON.parse(response_body)
+
+      # Return the Ruby object if the response was valid
+      return response_object if valid_json_response(response_object)
+    end
+
+    # Ensure that the JSON HTTP response received is valid
+    # @author Stephen Dolan
+    #
+    # @param [Hash] a Ruby hash representing an Adopt-A-Pet API response
+    #
+    # @raise [Exception] if the response is not valid, throw an exception
+    #
+    # @return [true] always return true if the method completes
+    def valid_json_response(response_object)
+      # Grab the status from the response
+      response_status = response_object.dig('status')
+
+      # If we receive a status 'ok', make sure there are no exceptions
+      # If we receive a status 'fail', raise an exception
+      # If we receive anything else, raise an exception
+      if response_status == 'ok'
+        check_ok_response(response_object)
+      elsif response_status == 'fail'
+        puts response_object
+        raise 'Bad request. Response returned status "fail".'
+      else
+        raise 'Bad request. Invalid response status returned.'
+      end
+
+      # Return true if all validations pass
+      true
+    end
+
+    # Verify that there was no issue with an 'ok' response
+    # @author Stephen Dolan
+    #
+    # @param [Hash] a Ruby hash representing an Adopt-A-Pet API response
+    #
+    # @raise [Exception] if the response is not valid, throw an exception
+    #
+    # @return [true] always return true if there is no exception
+    def check_ok_response(response_object)
+      return true unless response_object.key? 'exception'
+
+      exception_message = response_object.dig('exception', 'details')
+      raise "Bad request. Exception occurred: #{exception_message}"
+    end
+  end
+end

data/lib/adopt_a_pet/pet.rb

@@ -0,0 +1,268 @@
+# Namespace for classes and modules that handle requests to the Adopt-A-Pet API
+module AdoptAPet
+  # Base class for Adopt-A-Pet Pet objects
+  # @author Stephen Dolan
+  #
+  # @!attribute id
+  #   @return [String] the AdoptAPet identifier for the pet
+  # @!attribute age
+  #   @return [String] a description of the age of the pet
+  # @!attribute name
+  #   @return [String] the name of the pet
+  # @!attribute size
+  #   @return [String] a description of the size of the pet
+  # @!attribute species
+  #   @return [String] a description of the pet's species
+  # @!attribute primary_breed
+  #   @return [String] a description of the pet's primary breed
+  # @!attribute secondary_breed
+  #   @return [String] a description of the pet's secondary breed
+  # @!attribute sex
+  #   @return [String] the pet's gender
+  # @!attribute state_code
+  #   @return [String] the state where the pet resides
+  # @!attribute city
+  #   @return [String] the city where the pet resides
+  # @!attribute details_url
+  #   @return [String] a link to the details page for the pet on Adopt-A-Pet
+  # @!attribute photos
+  #   @return [Array<Photo>] a set of photos for the pet
+  # @!attribute color
+  #   @return [String] a description of the color of the pet
+  # @!attribute description
+  #   @return [String] a description of the pet
+  # @!attribute act_quickly
+  #   @return [String] a string denoting whether action is required quickly for adoption
+  # @!attribute special_needs
+  #   @return [String] a string denoting whether or not the pet has special needs
+  # @!attribute good_with_dogs
+  #   @return [String] a string denoting whether or not the pet is good with dogs
+  # @!attribute purebred
+  #   @return [String] a string denoting whether or not the pet is purebred
+  # @!attribute good_with_kids
+  #   @return [String] a string denoting whether or not the pet is good with kids
+  # @!attribute declawed
+  #   @return [String] a string denoting whether or not the pet is declawed
+  # @!attribute spayed_neutered
+  #   @return [String] a string denoting whether or not the pet is fixed
+  # @!attribute housetrained
+  #   @return [String] a string denoting whether or not the pet is housetrained
+  # @!attribute shots_current
+  #   @return [String] a string denoting whether or not the pet is current with their shots
+  class Pet
+    attr_accessor :id,
+                  :age,
+                  :name,
+                  :size,
+                  :species,
+                  :primary_breed,
+                  :secondary_breed,
+                  :sex,
+                  :state_code,
+                  :city,
+                  :details_url,
+                  :photos,
+                  :act_quickly,
+                  :color,
+                  :special_needs,
+                  :purebred,
+                  :description,
+                  :good_with_dogs,
+                  :declawed,
+                  :spayed_neutered,
+                  :housetrained,
+                  :shots_current,
+                  :good_with_kids
+
+    # Create a single instance of a Pet
+    # @author Stephen Dolan
+    #
+    # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+    #
+    # @return [Pet] a new Pet
+    def initialize(object) # rubocop:disable all
+      extract(object, %w[pet_id],          'id')
+      extract(object, %w[sex],             'sex')
+      extract(object, %w[size],            'size')
+      extract(object, %w[species],         'species')
+      extract(object, %w[act_quickly],     'act_quickly')
+      extract(object, %w[color],           'color')
+      extract(object, %w[special_needs],   'special_needs')
+      extract(object, %w[purebred],        'purebred')
+      extract(object, %w[description],     'description')
+      extract(object, %w[good_with_dogs],  'good_with_dogs')
+      extract(object, %w[declawed],        'declawed')
+      extract(object, %w[spayed_neutered], 'spayed_neutered')
+      extract(object, %w[housetrained],    'housetrained')
+      extract(object, %w[shots_current],   'shots_current')
+      extract(object, %w[good_with_kids],  'good_with_kids')
+      extract(object, %w[primary_breed],   'primary_breed')
+      extract(object, %w[secondary_breed], 'secondary_breed')
+      extract(object, %w[state_code],      'addr_state_code')
+      extract(object, %w[city],            'addr_city')
+      extract(object, %w[name pet_name],   'name')
+      extract(object, %w[details_url pet_details_url], 'details_url')
+      self.photos = ResponseHelper.extract_photos(object)
+    end
+
+    # Create multiple instances of Pet with one response
+    # @author Stephen Dolan
+    #
+    # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+    #
+    # @return [Array<Pet>] Initialize a collection of Pets
+    def self.multiple(object)
+      pets = []
+
+      object.dig('pets').each do |pet|
+        pets = pets.push(Pet.new(pet))
+      end
+
+      pets
+    end
+
+    # Extract a value from a hash, and store it in an object key
+    # @author Stephen Dolan
+    #
+    # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+    # @param [Array<String>] from_keys an array of keys to try and extract a value from
+    # @param [String] to_key the name of the key to store the value in on the Pet
+    #
+    # @return [void]
+    def extract(object, from_keys, to_key)
+      response_item = nil
+
+      # For each source key:
+      # - Search for a value in the object
+      from_keys&.each do |source|
+        response_item = object.dig(source) unless object.dig(source).nil?
+      end
+
+      # Don't set the key if we couldn't find a value
+      return if response_item.nil?
+
+      # Set the Pet attribute at to_key to the object value
+      send("#{to_key}=", response_item)
+    end
+
+    # Class for Adopt-A-Pet Pet API response object helpers
+    # @author Stephen Dolan
+    class ResponseHelper
+      # Extracts photos from a hash and pushes them into the Pet's photos
+      # @author Stephen Dolan
+      #
+      # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+      #
+      # @return [Array<Pet::Photo>] an array of Pet Photos
+      def self.extract_photos(object)
+        photos = []
+
+        # Get the various photos that could be returned for a pet
+        photos = get_results_photo(object, photos)
+        photos = get_large_results_photo(object, photos)
+        get_other_photos(object, photos)
+      end
+
+      # Pull a results photo, if it exists in the API return object
+      # @author Stephen Dolan
+      #
+      # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+      # @param [Array<Pet::Photo>] photos the current collection of Pet Photos
+      #
+      # @return [Array<Pet::Photo>] a (possibly expanded) array of Pet Photos
+      def self.get_results_photo(object, photos)
+        unless object.dig('results_photo_url').nil?
+          photos = photos.push(
+            original: Photo.new(
+              object.dig('results_photo_height'),
+              object.dig('results_photo_width'),
+              object.dig('results_photo_url')
+            )
+          )
+        end
+
+        photos
+      end
+
+      # Pull a large results photo, if it exists in the API return object
+      # @author Stephen Dolan
+      #
+      # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+      # @param [Array<Pet::Photo>] photos the current collection of Pet Photos
+      #
+      # @return [Array<Pet::Photo>] a (possibly expanded) array of Pet Photos
+      def self.get_large_results_photo(object, photos)
+        unless object.dig('large_results_photo_url').nil?
+          photos = photos.push(
+            original: Photo.new(
+              object.dig('large_results_photo_height'),
+              object.dig('large_results_photo_width'),
+              object.dig('large_results_photo_url')
+            )
+          )
+        end
+
+        photos
+      end
+
+      # Pull any additional photos, if they exists in the API return object
+      # @author Stephen Dolan
+      #
+      # @param [Hash] object a JSON response object from the Adopt-A-Pet API
+      # @param [Array<Pet::Photo>] photos the current collection of Pet Photos
+      #
+      # @return [Array<Pet::Photo>] a (possibly expanded) array of Pet Photos
+      def self.get_other_photos(object, photos)
+        if (image_objects = object.dig('images'))
+          image_objects.each do |image|
+            photos = photos.push(
+              original: Photo.new(
+                image.dig('original_height'),
+                image.dig('original_width'),
+                image.dig('original_url')
+              ),
+              thumbnail: Photo.new(
+                image.dig('thumbnail_height'),
+                image.dig('thumbnail_width'),
+                image.dig('thumbnail_url')
+              )
+            )
+          end
+        end
+
+        photos
+      end
+    end
+
+    # Class for Adopt-A-Pet Pet Photos
+    # @author Stephen Dolan
+    #
+    # @!attribute height
+    #   @return [Integer] the height of the Photo
+    # @!attribute width
+    #   @return [Integer] the width of the Photo
+    # @!attribute url
+    #   @return [String] a URL where you can view the Photo
+    class Photo
+      attr_accessor :height, :width, :url
+
+      # Create a single instance of a Pet Photo
+      # @author Stephen Dolan
+      #
+      # @param [Integer] height the height of the photo
+      # @param [Integer] width the width of the Photo
+      # @param [String] url a URL where you can view the photo
+      #
+      # @return [Pet::Photo] a new Pet Photo
+      #
+      # @example Create a new Photo
+      #   my_photo = Pet::Photo.new(100, 100, 'images.com/my_image')
+      #   height = my_photo.height
+      def initialize(height, width, url)
+        self.height  = height
+        self.width   = width
+        self.url     = url
+      end
+    end
+  end
+end

data/lib/adopt_a_pet/version.rb

@@ -0,0 +1,3 @@
+module AdoptAPet
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: adopt_a_pet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Dolan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: Interface with the Adopt-A-Pet API
+email:
+- stephen@stephencodes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adopt_a_pet.gemspec
+- bin/console
+- bin/setup
+- lib/adopt_a_pet.rb
+- lib/adopt_a_pet/client.rb
+- lib/adopt_a_pet/pet.rb
+- lib/adopt_a_pet/version.rb
+homepage: https://gitlab.com/stephendolan/adopt_a_pet_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Interface with the Adopt-A-Pet API
+test_files: []