rescue_groups 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dfbb921748d1d79a6af5e575737467216dc5c1d
+  data.tar.gz: 222eb29ce4facded94bd669d84c729b49c55848e
+SHA512:
+  metadata.gz: bb6ad7ded14addd702c324deea89983dd4743f5217154634de9fca526f77ffadcb26cb85a4dedca08d5ee7d3d38b5b2886666c7f94cfe2cad6f30d1f6e5b4513
+  data.tar.gz: b4f9fb29d5c2306aecf9e4c971129e8b466206a630bab0d72581e9cd56f2cadab0fd39c7b4a9733202350226debd12d08ebc2926a0eef60adfa0a2783a140fec

data/.gitignore

@@ -0,0 +1,4 @@
+.ruby-*
+Guardfile
+scripts/*
+.ENV

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm: 2.2.1
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    rescue_groups (0.0.1)
+      httparty (>= 0.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    multi_xml (0.5.5)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  guard-rspec
+  pry
+  rake
+  rescue_groups!
+  rspec
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jake Yesbeck
+
+MIT License
+
+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,226 @@
+## Rescue Groups API
+
+Wrapper for RescueGroups.org API
+
+![Build Status](https://travis-ci.org/yez/rescue_groups.svg?branch=master)
+
+# Purpose
+
+Ruby wrapper for the [HTTP RescueGroups API](https://userguide.rescuegroups.org/display/APIDG/HTTP+API). This is a read only gem that provides basic functionality needed to read from RescueGroups.
+
+# Installation
+
+In your project's Gemfile:
+
+`gem 'rescue_groups'`
+
+In a Rails application, all files will be included by default.
+
+In other Ruby applications, call `require 'rescue_groups'` where RescueGroups is needed.
+
+# Configuration
+
+An API key is required to use the RescueGroups API. An `ENV` variable named `'RESCUE_GROUPS_API_KEY'` is automatically accessed on initialization.
+
+Otherwise, add the following block to an initializer in your application:
+
+```ruby
+RescueGroups.configuration do |config|
+  config.apikey = 'your api key'
+end
+```
+
+# Searching
+
+Two methods, `find` and `where`, are used to request three resources: `Animal`, `Organization`, and `Event`.
+
+### `find`
+
+The find method accepts one to multiple ids and returns one or many results, respectively.
+
+**One ID**
+
+```ruby
+Animal.find(1)
+#=> <Animal id: 1, name: 'Fluffy' ...>
+```
+
+**Multiple IDs**
+
+```ruby
+Animal.find([20, 30, 40])
+#=> [<Animal id: 20, name: 'Mittens' ...>, <Animal id: 30, name: 'Mr. Doom' ...>, <Animal id: 40, name: 'CatDog' ...>]
+```
+
+**404 Response**
+
+If the object(s) is not found, an exception is raised `"Unable to find Animal with id: -1"
+
+### `where`
+
+The where method accepts a hash of attributes and finds animals that match all the criteria. If the returned list of objects is less than the count found by the server, a configuration variable can be added to make additional requests are automatically made with the same search criteria until all results returned.
+
+To enable this feature, set the config in an initializer like:
+
+```ruby
+RescueGroups.configuration do |config|
+  config.load_all_results = true
+end
+```
+
+A full set of fields are defined for [`Animals`](docs/animal_field.md), [`Organizations`](docs/organization_field.md), and [`Events`](docs/event_field.md)
+
+**One attribute**
+
+```ruby
+Organization.where(name: 'Pets-R-Us')
+# => [<Organization id: 1, name: 'Pets-R-Us' ...>]
+```
+
+To search multiple values on the same attribute, use an array:
+
+```ruby
+Animal.where(color: ['black', 'brown'])
+# => [<Animal id: 1, color: 'black' ..>, <Animal id: 5, color: 'brown' ..>]
+```
+
+**Multiple attributes**
+
+```ruby
+Organization.where(name: 'Big Bobs Pets', city: 'Kansas City')
+# => [<Organization id: 42, name: 'Big Bobs Pets', city: 'Kansas City' ...>]
+```
+
+**Complex attributes**
+
+For more sophisticated searches, the following attributes are provided:
+
+* equal
+* not_equal
+* less_than
+* less_than_or_equal
+* greater_than
+* greater_than_or_equal
+* contains
+* not_contain
+* blank
+* not_blank
+
+These attributes may be used in addition to others in a single `where` call or alone
+
+```ruby
+Animal.where(general_age: { less_than: 5})
+# => [<Animal id: 1, age: 2 ..>, <Animal id: 3, age: 1 ..>]
+
+Organization.where(name: { contains: 'shelter'}, location: 90210)
+# => [<Organization id: 1, name: 'Big Animal Shelter', location: 90210 ...>, <Organization id: 2, name: 'Small Animal Shelter', location: 90210 ...>,]
+```
+
+**No results**
+
+```ruby
+Organization.where(name: 'Bad Dogs R Us')
+# => []
+```
+# Relationships
+
+`Animals`, `Organizations`, and `Events` have relationships to one another. `Animals` have a single associated `Organization`, as do `Events`. `Organizations` have 1 or many `Events` and `Animals`.
+
+Calling a relationship that does not exist in memory will automatically fetch the associated object.
+
+```ruby
+organization = Organization.find(1)
+# => <Organization id: 1, name: 'Pets', city: 'Dallas' ...>
+
+# This will issue a remote call that is equivalent to Animal.where(organization_id: 1)
+organization.animals
+# => [<Animal id: 1, organization_id: 1 ...>, <Animal id: 2, organization_id: 1 ...>, ...]
+```
+
+# Test Mocks
+
+For testing, each model has a corresponding mock class. Mocked classes are available by default.
+
+### `find`
+
+Returns a single object as if it was from a successful `find` method call.
+
+```ruby
+RescueGroups::AnimalMock.find
+#=> <Animal id: 123, name: 'fluffy' ...>
+```
+
+Use this method while testing in place of writing your own custom factories/stubbed versions of RescueGroups objects.
+
+```ruby
+describe SomeTestClass do
+  let(:animal) { RescueGroups::AnimalMock.find }
+
+  specify do
+    # test method body
+  end
+end
+```
+
+### `find_not_found`
+
+To emulate an error during a find call for testing, the `find_not_found` method will raise the same error as a typical `find` method.
+
+```ruby
+RescueGroups::AnimalMock.find_not_found
+# => Unable to find Animal
+```
+
+### `where`
+
+Returns an array containing a single object as if it was from a successful `where` method call.
+
+```ruby
+RescueGroups::AnimalMock.where
+#=> [<Animal id: 123, name: 'fluffy' ...>]
+```
+
+Use this method while testing in place of writing your own custom factories/stubbed versions of RescueGroups objects.
+
+```ruby
+describe SomeTestClass do
+  let(:animal_response) { RescueGroups::AnimalMock.where }
+
+  specify do
+    # test method body
+  end
+end
+```
+
+### `where_not_found`
+
+The `where_not_found` method emulates a `where` method that returns no results, and returns an empty array.
+
+```ruby
+RescueGroups::Animal.where_not_found
+#=> []
+```
+
+## Pictures
+
+`Animals` have many `Pictures`
+
+A Picture exposes two methods: `url` and `url_thumb`
+
+Each of these methods accepts an option keyword parameter `secure:`. This param returns a secure url (https) if passed. It it is ommitted, a default http url is returned.
+
+### Default
+
+```ruby
+animal = Animal.find(1)
+animal.pictures.first.url
+#=> "http://image.to.my.animal/1234"
+```
+
+### Secure
+
+```ruby
+animal = Animal.find(1)
+animal.pictures.first.url(secure: true)
+#=> "https://secure.image.to.my.animal/1234"
+```

data/Rakefile

@@ -0,0 +1,30 @@
+require './config/initializer'
+require './spec/fixtures/test_constants'
+
+namespace :fixtures do
+  desc 'reload fixtures from remote API'
+  task :reload do
+    fail 'No API key given' if RescueGroups.config.apikey == ""
+
+    {
+      RescueGroups::Animal       => [TEST_ANIMAL_ID, breed: TEST_ANIMAL_BREED],
+      RescueGroups::Organization => [TEST_ORG_ID, name: TEST_ORG_NAME],
+      RescueGroups::Event        => [TEST_EVENT_ID, name: TEST_EVENT_NAME],
+    }.each do |klass, test_values|
+      find_request = RescueGroups::Requests::Find.new([*test_values[0]].flatten, klass, klass.api_client)
+      where_request = RescueGroups::Requests::Where.new(test_values[1], klass, klass.api_client, klass.search_engine_class)
+
+      find_results = klass.api_client.post_and_respond(find_request.as_json).parsed_body
+      where_results = klass.api_client.post_and_respond(where_request.as_json).parsed_body
+
+      model_name = klass.to_s.split('::').last.downcase
+
+      find_json_file = "#{ File.expand_path('..', __FILE__) }/spec/fixtures/#{ model_name }/find.json"
+      where_json_file =  "#{ File.expand_path('..', __FILE__) }/spec/fixtures/#{ model_name }/where.json"
+
+      File.open(find_json_file, 'w') { |f| f.write(JSON(find_results)) }
+      File.open(where_json_file, 'w') { |f| f.write(JSON(where_results)) }
+    end
+  end
+end
+

data/config/config.rb

@@ -0,0 +1,26 @@
+module RescueGroups
+  class Config
+    attr_accessor :apikey, :load_all_results
+  end
+
+  # method: config
+  # purpose: class method to instantiate or return an already
+  #           instantiated Config class
+  # param: none
+  # return: <Config> - instance of the config class
+  def self.config
+    @config ||= Config.new
+  end
+
+  # method: configuration
+  # purpose: yield to a block of configuration parameters
+  #          example:
+  #            RescueGroups.configuration do |config|
+  #              config.api_key = 'anything'
+  #            end
+  # param: none
+  # return: none
+  def self.configuration
+    yield config
+  end
+end

data/config/initializer.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'httparty'
+# This must be required before configuration can happen
+require_relative '../rescue_groups'
+require_relative './config'
+
+RescueGroups.configuration do |config|
+  # Your API key should be set in an ENV variable called RESCUE_GROUPS_API_KEY
+  config.apikey = ENV['RESCUE_GROUPS_API_KEY'] || ''
+  config.load_all_results = false
+end
+
+require_relative '../models/animal'
+require_relative '../models/organization'
+require_relative '../models/event'

data/docs/animal_field.md

@@ -0,0 +1,138 @@
+## Animal Fields
+* id
+* organization_id
+* activity_level
+* adoption_fee
+* altered
+* available_date
+* birthdate
+* birthdate_exact
+* breed
+* coat_length
+* color
+* color_id
+* color_details
+* courtesy
+* declawed
+* description
+* description_plain
+* distinguishing_marks
+* ear_type
+* energy_level
+* excercise_needs
+* eye_color
+* fence
+* found
+* found_date
+* found_postal_code
+* general_age
+* general_size_potential
+* grooming_needs
+* house_trained
+* indoor_outdoor
+* kill_date
+* kill_reason
+* location
+* location_distance
+* location_city_state
+* microchipped
+* mixed_breed
+* name
+* special_needs
+* special_needs_description
+* needs_foster
+* new_people
+* not_house_trained_reason
+* obedience_training
+* ok_with_adults
+* ok_with_cats
+* ok_with_dogs
+* ok_with_kids
+* owner_experience
+* pattern
+* pattern_id
+* adoption_pending
+* primary_breed
+* primary_breed_id
+* rescue_id
+* search_string
+* secondary_breed
+* secondary_breed_id
+* sex
+* shedding
+* size_current
+* size_potential
+* size_uom
+* species
+* species_id
+* sponsorable
+* sponsors
+* sponsorhip_details
+* sponsorship_minimum
+* status
+* status_id
+* summary
+* tail_type
+* thumbnail_url
+* up_to_date
+* updated_date
+* url
+* vocal
+* yard_required
+* affectionate
+* apartment
+* crate_trained
+* drools
+* eager_to_please
+* escapes
+* even_tempered
+* fetches
+* gentle
+* good_in_car
+* goofy
+* has_allergies
+* hearing_impaired
+* hypoallergenic
+* independent
+* intelligent
+* lap
+* leash_trained
+* needs_companion_animal
+* no_cold
+* no_female_dogs
+* no_heat
+* no_large_dogs
+* no_male_dogs
+* no_small_dogs
+* obedient
+* ok_for_seniors
+* ok_with_farm_animals
+* older_kids_only
+* ongoing_medical
+* playful
+* plays_toys
+* predatory
+* protective
+* sight_impaired
+* skittish
+* special_diet
+* swims
+* timid
+* foster_email
+* foster_first_name
+* foster_last_name
+* foster_name
+* foster_phone_cell
+* foster_phone_home
+* foster_salutation
+* location_addresss
+* location_city
+* location_country
+* location_url
+* location_name
+* location_phone
+* location_state
+* location_postal_code
+* pictures
+* videos
+* video_urls