petfinder_V2 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd02de6a3afbd4cb0a38e81db9f708d9048a01464f5a72323882d758e69e29ab
+  data.tar.gz: '01809fe6ef68ff6dda3be1c04076ede962b963c6c2efe1afe47a08a822975032'
+SHA512:
+  metadata.gz: 97c813fc7527263bfd5644fa0522bd2c5030f5b451891b8611bb72f217b682497b0ec520405d5c03f1d5d20b43d8bc1c658067a8acad42790ebbeb4582db225b
+  data.tar.gz: b7bb6499488c91787b9da054a5ca7dea9f23af15901878aed509fd59231611f79498e5242b80d4a89bdd78ee8b1cf5b78f92712dacf2144052137438860c7972

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    petfinder_V2 (0.1.0)
+      faraday
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (11.0.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.9)
+    json (2.2.0)
+    multipart-post (2.0.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  petfinder_V2!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ben Wanicur
+
+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,164 @@
+# PetfinderV2
+
+Wrapper for the <a href="https://www.petfinder.com/developers/v2/docs/" target="_blank">Petfinder V2 API</a>
+
+## Installation
+
+Add this line to your application's Gemfile-
+
+```ruby
+gem 'petfinder_V2'
+```
+
+And then execute-
+
+    $ bundle
+
+Or install it yourself as-
+
+    $ gem install petfinder_V2
+
+## Usage
+
+```ruby
+# configure the client globally
+PetfinderV2::Config.instance.set(client_id: <CLIENT_ID>)
+PetfinderV2::Config.instance.set(client_secret: <CLIENT_SECRET>)
+client = PetfinderV2::Client.new
+
+# or per client instance
+client = PetfinderV2::Client.new(CLIENT_ID, CLIENT_SECRET)
+
+options = {
+  age:  [ 'adult' 'senior' ]
+  gender:  'female'
+  size:  [ 'medium' 'large' ]
+}
+result = client.search_animals(options)
+```
+
+## Methods
+
+- `client.search_animals(options)`
+  - options-  <a href="https://www.petfinder.com/developers/v2/docs/#get-animals" target="_blank">Petfinder V2 Docs</a>
+  - returns-  collection of `Animal` objects
+
+- `client.get_animal(id)`
+  - returns-  `Animal` object
+
+- `client.get_animal_types`
+  - returns-  collection of `AnimalType` objects
+
+- `client.get_animal_type(type_name)`
+    - `type_name` is a type of animal (e.g 'dog' 'cat' etc...)
+    - more documentation <a href="https://www.petfinder.com/developers/v2/docs/#get-animal-types" target="_blank">here</a>
+    - returns `AnimalType` object
+
+- `client.get_animal_breeds(type_name)`
+  - `type_name` is a type of animal (e.g 'dog' 'cat' etc...)
+  - returns-  a collection of `AnimalBreed` objects
+
+- `client.search_organizations(options)`
+  - options-  <a href="https://www.petfinder.com/developers/v2/docs/#get-organizations" target="_blank">Petfinder V2 Docs</a>
+  - returns-  collection of `Organization` objects
+
+- `client.get_organization(id)`
+  - returns-  `Organization` object
+
+## Models
+- Animal
+  - id
+  - name
+  - age
+  - coat
+  - contact
+  - description
+  - gender
+  - organization_id
+  - species
+  - size
+  - status
+  - type
+  - declawed
+  - house_trained
+  - shots_current
+  - spayed_neutered
+  - special_needs
+  - link
+  - organization_link
+  - breeds --> `Breed` object
+  - photos --> `Photos` object
+  - contact --> `Contact` object
+
+- Breed
+  - primary
+  - secondary
+  - mixed
+  - unkown
+
+- AnimalType
+  - name
+  - colors
+  - genders
+  - link
+  - breeds_link
+  
+- AnimalBreed (returned from `get_animal_breeds`)
+  - name
+  - type_link
+
+- Organization  
+  - id
+  - name
+  - email
+  - phone
+  - url
+  - website
+  - mission_statement
+  - adoption_policy
+  - adoption_url
+  - link
+  - animals_link
+  - address --> `Address` object
+  - hours --> `OrgHours` object
+  - social_media --> `SocialMedia` object
+  
+- Photos
+  - small
+  - medium
+  - large
+  - full
+
+- Pagination
+  - count_per_page
+  - total_count
+  - current_page
+  - total_pages
+  - links
+
+- Contact
+  - phone
+  - email
+  - address --> `Address` object
+  
+- Address
+  - address1
+  - address2
+  - city
+  - state
+  - postcode
+  - country
+  
+## 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://github.com/bwanicur/petfinder_V2.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "petfinder_V2"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/petfinder_V2/client.rb

@@ -0,0 +1,107 @@
+require 'json'
+
+module PetfinderV2
+  class Client
+    @@access_token = nil
+    def self.reset_access_token!
+      @@access_token = nil
+    end
+
+    def initialize(client_id = nil, client_secret = nil)
+      @client_id = client_id || Config.instance.read(:client_id)
+      @client_secret = client_secret || Config.instance.read(:client_secret)
+    end
+
+    def search_animals(opts = {})
+      validate_animal_options!(opts)
+      response_data = base_request(:get, 'animals', opts)
+      Serializers::Animal.process_collection(response_data)
+    end
+
+    def get_animal(id)
+      response_data = base_request(:get, "animals/#{id}")
+      Serializers::Animal.new(response_data['animal'])
+    end
+
+    def get_animal_types
+      response_data = base_request(:get, 'types')
+      Serializers::AnimalType.process_collection(response_data)
+    end
+
+    def get_animal_type(name)
+      response_data = base_request(:get, "types/#{name}")
+      Serializers::AnimalType.new(response_data['type'])
+    end
+
+    def get_animal_breeds(animal_type)
+      response_data = base_request(:get, "types/#{animal_type}/breeds")
+      Serializers::AnimalBreed.process_collection(response_data)
+    end
+
+    def search_organizations(opts = {})
+      validate_organization_options!(opts)
+      response_data = base_request(:get, 'organizations', opts)
+      Serializers::Organization.process_collection(response_data)
+    end
+
+    def get_organization(id)
+      response_data = base_request(:get, "organizations/#{id}")
+      Serializers::Organization.new(response_data['organization'])
+    end
+
+    private
+
+    def base_request(http_verb, endpoint, opts = {})
+      res = Requests::Request.new(get_token.token)
+                             .send(http_verb, endpoint, opts)
+      response_data = JSON.parse(res.body)
+      handle_errors!(response_data)
+      response_data
+    end
+
+    def validate_animal_options!(opts)
+      errors = Services::AnimalOptionsValidator.new(opts).run
+      invalid_options_error!(errors)
+    end
+
+    def validate_organization_options!(opts)
+      errors = Services::AnimalOptionsValidator.new(opts).run
+      invalid_options_error!(errors)
+    end
+
+    def invalid_options_error!(errors)
+      raise(InvalidRequestOptionsError, errors.join("\n")) unless errors.empty?
+    end
+
+    def handle_errors!(data)
+      return if !data['status'] || data['status'] < 400
+
+      msg = if data['invalid-params']
+              data['invalid-params']['message']
+            else
+              data['detail']
+            end
+      raise(PetfinderV2::Error, "STATUS: #{data['status']} - #{msg}")
+    end
+
+    def get_token
+      access_token_expired? ? refresh_access_token : @@access_token
+    end
+
+    def access_token_expired?
+      return true if @@access_token.nil?
+
+      @@access_token.expires_at < Time.now
+    end
+
+    def refresh_access_token
+      res = Requests::AccessTokenRequest.new(
+        @client_id,
+        @client_secret
+      ).get_access_token
+      response_data = JSON.parse(res.body)
+      handle_errors!(response_data)
+      Serializers::AccessToken.new(response_data)
+    end
+  end
+end

data/lib/petfinder_V2/config.rb

@@ -0,0 +1,19 @@
+require 'singleton'
+
+module PetfinderV2
+  class Config
+    include Singleton
+
+    def initialize
+      @conf = {}
+    end
+
+    def set(key, value)
+      @conf[key] = value
+    end
+
+    def read(key)
+      key ? (@conf[key.to_s] || @conf[key.to_sym]) : @conf
+    end
+  end
+end

data/lib/petfinder_V2/requests/access_token_request.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+
+module PetfinderV2
+  module Requests
+    class AccessTokenRequest
+      URL = 'https://api.petfinder.com/v2/oauth2/token'.freeze
+
+      def initialize(client_id, client_secret)
+        @client_id = client_id
+        @client_secret = client_secret
+        @conn = Faraday.new
+      end
+
+      def get_access_token
+        @conn.post URL,
+                   client_id: @client_id,
+                   client_secret: @client_secret,
+                   grant_type: 'client_credentials'
+      end
+    end
+  end
+end

data/lib/petfinder_V2/requests/request.rb

@@ -0,0 +1,65 @@
+require 'faraday'
+
+module PetfinderV2
+  module Requests
+    class Request
+      BASE_URL = 'https://api.petfinder.com/v2'.freeze
+
+      COLLECTION_OPTS = %i[
+        age
+        breed
+        coat
+        color
+        gender
+        organization
+        size
+      ].freeze
+
+      SINGLE_OPTS = %i[
+        distance
+        limit
+        location
+        name
+        page
+        sort
+        status
+        type
+      ].freeze
+
+      def initialize(access_token)
+        @access_token = access_token
+        @conn = Faraday.new(BASE_URL)
+      end
+
+      def get(path, opts = {})
+        set_connection_headers
+        set_connection_get_params(opts)
+        @conn.get(path)
+      end
+
+      private
+
+      def set_connection_headers
+        @conn.headers['Content-Type'] = 'application/json'
+        @conn.headers['Authorization'] = "Bearer #{@access_token}"
+      end
+
+      def set_connection_get_params(opts)
+        SINGLE_OPTS.each do |key|
+          @conn.params[key.to_s] = opts[key].to_s if opts[key]
+        end
+        COLLECTION_OPTS.each do |key|
+          @conn.params[key.to_s] = collection_opts(opts[key]) if opts[key]
+        end
+      end
+
+      def collection_opts(collection)
+        if collection.respond_to?(:each)
+          collection.join(',')
+        else
+          collection.to_s
+        end
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/access_token.rb

@@ -0,0 +1,11 @@
+module PetfinderV2
+  module Serializers
+    class AccessToken
+      attr_reader :token, :expires_at
+      def initialize(data)
+        @token = data['access_token']
+        @expires_at = Time.now + data['expires_in'].to_i
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/address.rb

@@ -0,0 +1,17 @@
+module PetfinderV2
+  module Serializers
+    class Address
+      attr_reader :address1, :address2, :city, :state, :postcode, :country
+
+      def initialize(data)
+        @data = data
+        @address1 = data['address1']
+        @address2 = data['address2']
+        @city = data['city']
+        @state = data['state']
+        @postcode = data['postcode']
+        @country = data['country']
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/animal.rb

@@ -0,0 +1,92 @@
+require_relative 'pagination'
+require_relative 'contact'
+require_relative 'photos'
+
+module PetfinderV2
+  module Serializers
+    class Breed
+      attr_reader :primary, :secondary, :mixed, :unknown
+      def initialize(data)
+        @primary = data['primary']
+        @secondary = data['secondary']
+        @mixed = data['mixed']
+        @unknown = data['unknown']
+      end
+    end
+
+    class Animal
+      NESTED_ATTRIBUTE_ATTS = %w[
+        declawed
+        house_trained
+        shots_current
+        spayed_neutered
+        special_needs
+      ].freeze
+
+      def self.process_collection(data)
+        {
+          pagination: PetfinderV2::Serializers::Pagination.new(data['pagination']),
+          animals: data['animals'].map { |d| new(d) }
+        }
+      end
+
+      attr_reader :age,
+                  :coat,
+                  :contact,
+                  :description,
+                  :gender,
+                  :id,
+                  :name,
+                  :organization_id,
+                  :species,
+                  :size,
+                  :status,
+                  :type
+
+      def initialize(data)
+        @data = data
+        @age = data['age']
+        @coat = data['coat']
+        @contact = data['contact']
+        @description = data['description']
+        @gender = data['gender']
+        @id = data['id']
+        @name = data['name']
+        @organization_id = data['organization_id']
+        @photos = data['photos']
+        @species = data['species']
+        @size = data['size']
+        @status = data['status']
+        @type = data['type']
+      end
+
+      NESTED_ATTRIBUTE_ATTS.each do |att|
+        define_method(att.to_sym) { @data['attributes'][att] }
+      end
+
+      def full_response
+        @data
+      end
+
+      def breeds
+        Breed.new(@data['breeds'])
+      end
+
+      def contact
+        Contact.new(@data['contact'])
+      end
+
+      def photos
+        Photos.process_collection(@data['photos'])
+      end
+
+      def link
+        @data['_links']['self']['href']
+      end
+
+      def organization_link
+        @data['_links']['organization']['href']
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/animal_breed.rb

@@ -0,0 +1,16 @@
+module PetfinderV2
+  module Serializers
+    class AnimalBreed
+      attr_accessor :name, :type_link
+
+      def self.process_collection(data)
+        data['breeds'].map { |b| new(b) }
+      end
+
+      def initialize(data)
+        @name = data['name']
+        @type_link = data['_links']['type']['href']
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/animal_type.rb

@@ -0,0 +1,19 @@
+module PetfinderV2
+  module Serializers
+    class AnimalType
+      attr_reader :name, :colors, :genders, :link, :breeds_link
+
+      def self.process_collection(data)
+        data['types'].map { |d| new(d) }
+      end
+
+      def initialize(data)
+        @name = data['name']
+        @colors = data['colors']
+        @genders = data['genders']
+        @link = data['_links']['self']['href']
+        @breeds_link = data['_links']['breeds']['href']
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/contact.rb

@@ -0,0 +1,18 @@
+require_relative 'address'
+
+module PetfinderV2
+  module Serializers
+    class Contact
+      attr_reader :phone, :email
+      def initialize(data)
+        @data = data
+        @phone = data['phone']
+        @email = data['email']
+      end
+
+      def address
+        Address.new(@data['address'])
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/organization.rb

@@ -0,0 +1,83 @@
+require_relative 'address'
+require_relative 'photos'
+require_relative 'pagination'
+
+module PetfinderV2
+  module Serializers
+    class SocialMedia
+      attr_reader :facebook, :twitter, :youtube, :instagram, :pinterest
+      def initialize(data)
+        @facebook = data['facebook']
+        @twitter = data['twitter']
+        @youtube = data['youtube']
+        @instagram = data['instagram']
+        @pinterest = data['pinterest']
+      end
+    end
+
+    class OrgHours
+      attr_reader :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday
+      def initialize(data)
+        @monday = data['monday']
+        @tuesday = data['tuesday']
+        @wednesday = data['wednesday']
+        @thursday = data['thursday']
+        @friday = data['friday']
+        @saturday = data['saturday']
+        @sunday = data['sunday']
+      end
+    end
+
+    class Organization
+      def self.process_collection(data)
+        {
+          pagination: PetfinderV2::Serializers::Pagination.new(data['pagination']),
+          organizations: data['organizations'].map { |o| new(o) }
+        }
+      end
+
+      attr_reader :id,
+                  :name,
+                  :email,
+                  :phone,
+                  :url,
+                  :website,
+                  :mission_statement,
+                  :adoption_policy,
+                  :adoption_url,
+                  :link,
+                  :animals_link
+
+      def initialize(data)
+        @data = data
+        @id = data['id']
+        @name = data['name']
+        @email = data['email']
+        @phone = data['phone']
+        @url = data['url']
+        @website = data['website']
+        @mission_statement = data['mission_statement']
+        @adoption_policy = data['adoption']['policy']
+        @adoption_url = data['adoption']['url']
+        @link = data['_links']['self']['href']
+        @animals_link = data['_links']['animals']['href']
+      end
+
+      def full_response
+        @data
+      end
+
+      def address
+        Address.new(@data['address'])
+      end
+
+      def hours
+        OrgHours.new(@data['hours'])
+      end
+
+      def social_media
+        SocialMedia.new(@data['social_media'])
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/pagination.rb

@@ -0,0 +1,19 @@
+module PetfinderV2
+  module Serializers
+    class Pagination
+      attr_reader :count_per_page,
+                  :total_count,
+                  :current_page,
+                  :total_pages,
+                  :links
+
+      def initialize(data)
+        @count_per_page = data['count_per_page']
+        @total_count = data['total_count']
+        @current_page = data['current_page']
+        @total_pages = data['total_pages']
+        @links = data['_links']
+      end
+    end
+  end
+end

data/lib/petfinder_V2/serializers/photos.rb

@@ -0,0 +1,17 @@
+module PetfinderV2
+  module Serializers
+    class Photos
+      def self.process_collection(collection)
+        collection.inject([]) { |mem, photos_hash| mem << new(photos_hash) }
+      end
+
+      attr_reader :small, :medium, :large, :full
+      def initialize(data)
+        @small = data['small']
+        @medium = data['medium']
+        @large = data['large']
+        @full = data['full']
+      end
+    end
+  end
+end

data/lib/petfinder_V2/services/animal_options_validator.rb

@@ -0,0 +1,57 @@
+require_relative 'option'
+require_relative 'options_validator'
+
+module PetfinderV2
+  module Services
+    class AnimalOptionsValidator < OptionsValidator
+      def my_opts
+        {
+          limit: Option.new(Integer),
+          breed: Option.new(String),
+          color: Option.new(String),
+          orgnanization: Option.new(String),
+
+          type: Option.new(String, %w[
+                             bird
+                             cat
+                             dog
+                             horse
+                             rabbit
+                             small_and_furry
+                             scales_fins_and_other
+                           ]),
+          size: Option.new(String, %w[
+                             small
+                             medium
+                             large
+                             xlarge
+                           ]),
+          gender: Option.new(String, %w[
+                               female
+                               male
+                               unknown
+                             ]),
+          age: Option.new(String, %w[
+                            baby
+                            young
+                            adult
+                            senior
+                          ]),
+          coat: Option.new(String, %w[
+                             short
+                             medium
+                             long
+                             wire
+                             hairless
+                             culrly
+                           ]),
+          status: Option.new(String, %w[
+                               adoptable
+                               adopted
+                               found
+                             ])
+        }.freeze
+      end
+    end
+  end
+end

data/lib/petfinder_V2/services/option.rb

@@ -0,0 +1,33 @@
+module PetfinderV2
+  module Services
+    class Option
+      def initialize(klass, choices = [])
+        @klass = klass
+        @choices = choices
+      end
+
+      def validate_value(value, key)
+        if value.respond_to?(:each)
+          validate_collection_val(value, key)
+        else
+          validate_single_val(value, key)
+        end
+      end
+
+      private
+
+      def validate_single_val(val, key)
+        if !val.is_a?(@klass)
+          "#{key.capitalize}: #{val} must be a kind of #{@klass}"
+        elsif !@choices.empty? && !@choices.include?(val)
+          "#{key.capitalize}: #{val} is not an allowed value.  " \
+            "The allowed values are: #{@choices.join(',')}"
+        end
+      end
+
+      def validate_collection_val(collection, key)
+        collection.inject([]) { |memo, val| memo << validate_single_val(val, key) }
+      end
+    end
+  end
+end

data/lib/petfinder_V2/services/options_validator.rb

@@ -0,0 +1,36 @@
+module PetfinderV2
+  module Services
+    class OptionsValidator
+      BASE_OPTS_MAP = {
+        name: Option.new(String),
+        distance: Option.new(Integer),
+        location: Option.new(String),
+        page: Option.new(Integer),
+        sort: Option.new(String)
+      }.freeze
+
+      def initialize(opts)
+        @opts = opts
+      end
+
+      def my_opts
+        raise 'Abstract Method - Only call in subclasses'
+      end
+
+      def run
+        errors = []
+        my_opts_map = BASE_OPTS_MAP.merge(my_opts)
+        @opts.each do |key, val|
+          key = key.to_sym
+          if my_opts_map[key].nil?
+            errors << "#{key} is not a valid option"
+            next
+          end
+          pf_opt = my_opts_map[key]
+          errors << pf_opt.validate_value(val, key)
+        end
+        errors.flatten.compact
+      end
+    end
+  end
+end

data/lib/petfinder_V2/services/organization_options_validator.rb

@@ -0,0 +1,16 @@
+require_relative 'option'
+require_relative 'options_validator'
+
+module PetfinderV2
+  module Services
+    class OrganizationOptionsValidator < OptionsValidator
+      def my_opts
+        {
+          state: Option.new(String),
+          country: Option.new(String),
+          query: Option.new(String)
+        }
+      end
+    end
+  end
+end

data/lib/petfinder_V2/version.rb

@@ -0,0 +1,3 @@
+module PetfinderV2
+  VERSION = '0.1.1'.freeze
+end

data/lib/petfinder_V2.rb

@@ -0,0 +1,17 @@
+require 'petfinder_V2/version'
+require 'petfinder_V2/client'
+require 'petfinder_V2/config'
+require 'petfinder_V2/services/animal_options_validator'
+require 'petfinder_V2/services/organization_options_validator'
+require 'petfinder_V2/requests/request'
+require 'petfinder_V2/requests/access_token_request'
+require 'petfinder_V2/serializers/access_token'
+require 'petfinder_V2/serializers/animal'
+require 'petfinder_V2/serializers/animal_type'
+require 'petfinder_V2/serializers/animal_breed'
+require 'petfinder_V2/serializers/organization'
+
+module PetfinderV2
+  class Error < StandardError; end
+  class InvalidRequestOptionsError < Error; end
+end

data/petfinder_V2.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'petfinder_V2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'petfinder_V2'
+  spec.version       = PetfinderV2::VERSION
+  spec.authors       = ['Ben Wanicur']
+  spec.email         = ['bwanicur@gmail.com']
+
+  spec.homepage      = 'https://github.com/bwanicur/petfinder_v2'
+  spec.summary       = ' Wrapper for the Petfinder V2 API '
+  spec.description   = ' Wrapper for the Petfinder V2 API '
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: petfinder_V2
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ben Wanicur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Wrapper for the Petfinder V2 API "
+email:
+- bwanicur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/petfinder_V2.rb
+- lib/petfinder_V2/client.rb
+- lib/petfinder_V2/config.rb
+- lib/petfinder_V2/requests/access_token_request.rb
+- lib/petfinder_V2/requests/request.rb
+- lib/petfinder_V2/serializers/access_token.rb
+- lib/petfinder_V2/serializers/address.rb
+- lib/petfinder_V2/serializers/animal.rb
+- lib/petfinder_V2/serializers/animal_breed.rb
+- lib/petfinder_V2/serializers/animal_type.rb
+- lib/petfinder_V2/serializers/contact.rb
+- lib/petfinder_V2/serializers/organization.rb
+- lib/petfinder_V2/serializers/pagination.rb
+- lib/petfinder_V2/serializers/photos.rb
+- lib/petfinder_V2/services/animal_options_validator.rb
+- lib/petfinder_V2/services/option.rb
+- lib/petfinder_V2/services/options_validator.rb
+- lib/petfinder_V2/services/organization_options_validator.rb
+- lib/petfinder_V2/version.rb
+- petfinder_V2.gemspec
+homepage: https://github.com/bwanicur/petfinder_v2
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Petfinder V2 API
+test_files: []