BestFriendFinder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18a6e178ab485b0c6720b8ca012571a8b1bbddcf
+  data.tar.gz: 6262bc78087585dd39b3117083ea0189c35f7b79
+SHA512:
+  metadata.gz: db9a2da43692a1b48eaa6a2e57d00974614f520bd561251968e330866f64ebbd37bec37f210f604c23313a67d11b3444676172088ed2d81485a2bede52c9e120
+  data.tar.gz: c3e2b6927d19c9a8eddd9648fddcdc71f60cbc8032216bf1a76c17531d0bae015883bb2970eddb41d5fd8604e16d73f4699a3351de890e0ba59221c33623cb62

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/NOTES.md

@@ -0,0 +1,35 @@
+-------- To Do ----------
+[X] Download gem from bundler
+[X] Set up GitHub Repo
+[X] Copy spec.md from Learn repo
+[X] Watch Resources videos on Learn page
+
+[X] Figure out how the 'require' and environment settings need to work
+[X] Plan out the project structure using test data
+[X] Start with building the executable file
+[X] Begin replacing test data with real data from BFAS site
+[X] List the objects that we can create & start making objects
+[X] Record myself coding for 30 mins.
+--5/13/17--
+[X] Clean up code in CLI #call method
+[X] Break out code into separate methods where necessary
+[X] Remove #find_details_url method from Scraper
+[X] Think through how we can use same methods for cats/birds/etc.
+[X] Write something that does not add the dog object to the list of @@all if the dog already exists
+--5/14/17--
+[X] What if user enters number outside of acceptable range?
+[X] Can we use already-created species variable from AnimalFactory class instead of having them in each animal class?
+[X] Environment file - requiring all files in lib?
+[X] check_attributes_for_nil method - how to make that cleaner?
+-----------
+[X] Update the README file
+[X] Update the specifications of the .gemspec file
+[X] Update the spec.md file
+[X] Write a blog
+[X] Publish blog
+[X] Prepare a video demo on how to use the gem
+[ ] Get permission from BFAS to scrape their site -pending-
+[ ] Publish gem to RubyGems.org
+
+------ Notes -------
+Data to scrape: http://bestfriends.org/adopt/adopt-our-sanctuary

data/README.md

@@ -0,0 +1,50 @@
+# BestFriendFinder
+
+BestFriendFinder helps you find your new best friend by displaying animals that are available for adoption
+at the [Best Friend Animals Society](http://bestfriends.org/adopt/adopt-our-sanctuary)'s sanctuary in Kanab, UT. Help millions of homeless animals by choosing to
+'#AdoptDontShop'.
+
+![](http://dingo.care2.com/pictures/greenliving/1012/1011871.large.jpg)
+
+BestFriendFinder lists available dogs, cats, rabbits, birds, horses, pigs, barnyard and small & furry animals.
+You can learn more about the animal right here in the BestFriendFinder app, or copy/paste the link in your browser
+to find out how to adopt!
+
+All content published by Best Friends is the property of Best Friends and is protected by copyright, trademark, and other intellectual property laws.
+
+For more information on how to use the app, see my [video walkthrough](https://www.youtube.com/watch?v=nJbM3NQelmk&feature=youtu.be)!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+ruby
+gem 'bestfriendfinder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bestfriendfinder
+
+## Usage
+
+Type `bestfriendfinder` in the command line.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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/alexisadorn/BestFriendFinder-cli-app.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bestfriendfinder.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "BestFriendFinder"
+  spec.version       = BestFriendFinder::VERSION
+  spec.authors       = ["'Alexis Dorn'"]
+  spec.email         = ["'alexisadorn@gmail.com'"]
+
+  spec.summary       = %q{A list of animals available for adoption.}
+  spec.description   = %q{CLI app that scrapes information and returns a list of animals available for adoption
+                          and their details from the Best Friends Animal Society sanctuary in Utah. http://bestfriends.org/}
+  spec.homepage      = "https://github.com/alexisadorn/BestFriendFinder-cli-app"
+  spec.licenses      = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["bestfriendfinder"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 0"
+  spec.add_development_dependency "nokogiri", ">= 0"
+  spec.add_development_dependency "pry", ">= 0"
+  spec.add_development_dependency "colorize", "~> 0.8.1"
+end

data/bin/bestfriendfinder

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../config/environment'
+
+CLI.new.call

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/config/environment.rb

@@ -0,0 +1,7 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'require_all'
+require 'colorize'
+
+require_all 'lib'

data/lib/animalfactory.rb

@@ -0,0 +1,25 @@
+class AnimalFactory
+
+  def initialize(species, object)
+    if species == "Small"
+      @species = "small-furry"
+    else
+      @species = species.downcase
+    end
+    @animal_object = object
+
+    scrape_and_create_animals
+  end
+
+  def scrape_and_create_animals # Scrapes page ending with /@species and creates new objects based on the previously defined species object
+    hash_of_pets = Scraper.scrape_adoptable_pets(@species)
+    @animal_object.create_new(hash_of_pets)
+  end
+
+  def self.add_attributes_to_animals(number, animal_object)
+    pet = animal_object.all[number]
+    attributes = Scraper.scrape_pet_profile(pet.url)
+    pet.add_attributes(attributes)
+  end
+
+end

data/lib/animals.rb

@@ -0,0 +1,33 @@
+class Animals
+  attr_accessor :species, :name, :breed, :age, :url, :size, :color, :sex, :description
+
+  def initialize(attributes)
+    attributes.each {|k, v| self.send(("#{k}="), v)}
+    self.class.all << self unless self.class.all.any? {|pet| pet.url == self.url}
+  end
+
+  def self.create_new(pet_array)
+    pet_array.each do |pet_hash|
+      self.new(pet_hash)
+    end
+  end
+
+  def add_attributes(details_hash)
+    details_hash.each do |k, v|
+      self.send(("#{k}="), v)
+    end
+    check_attributes_for_nil
+    self
+  end
+
+  def check_attributes_for_nil
+    attributes = ["species", "name", "breed", "age", "url", "size", "color", "sex", "description"]
+    empty = [" ", "", nil]
+    attributes.each do |var|
+      if empty.any? { |e| self.send("#{var}") == e}
+        self.send(("#{var}="), "N/A")
+      end
+    end
+  end
+
+end

data/lib/animals/barnyard.rb

@@ -0,0 +1,8 @@
+class Barnyard < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/birds.rb

@@ -0,0 +1,8 @@
+class Birds < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/cats.rb

@@ -0,0 +1,8 @@
+class Cats < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/dogs.rb

@@ -0,0 +1,8 @@
+class Dogs < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/equine.rb

@@ -0,0 +1,8 @@
+class Equine < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/pigs.rb

@@ -0,0 +1,8 @@
+class Pigs < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/rabbits.rb

@@ -0,0 +1,8 @@
+class Rabbits < Animals
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/animals/small.rb

@@ -0,0 +1,9 @@
+class Small < Animals
+
+  @@all = []
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/cli.rb

@@ -0,0 +1,100 @@
+class CLI
+  PETS = ["Dogs", "Cats", "Rabbits", "Birds", "Equine", "Pigs", "Barnyard", "Small"]
+
+  def call
+    puts "\nWELCOME TO BEST FRIEND FINDER!".light_blue
+    puts "--------------------------------"
+    start
+  end
+
+  def start
+    puts "What kind of friends would you like to find today? (Please enter a number)\n".cyan
+
+    PETS.each.with_index(1) do |animal, number|
+      puts "#{number}. #{animal}"
+    end
+
+    user_input = number_to_index(gets.chomp)
+
+    if !user_input.between?(0, PETS.size-1)
+      puts "\nI'm sorry, that was an incorrect entry. Please try again.\n".red
+      start
+    end
+
+    @animal_object = define_animal_object(user_input)
+    AnimalFactory.new(PETS[user_input], @animal_object)
+
+    display_all_animals
+  end
+
+  def display_all_animals
+    if @animal_object == Small
+      puts "\n\nAVAILABLE SMALL & FURRY ANIMALS FOR ADOPTION:".light_blue
+    else
+      puts "\n\nAVAILABLE #{@animal_object.to_s.upcase} FOR ADOPTION:".light_blue
+    end
+    puts "Name - Breed - Age".cyan
+    puts "-----------------------------"
+
+    all_pets = @animal_object.all
+    all_pets.each.with_index(1) {|pet, num| puts "#{num}. #{pet.name} - #{pet.breed} - #{pet.age}"}
+
+    puts "\nWhich pet would you like more information on? (Please enter a number)".cyan
+
+    animal_number = number_to_index(gets.chomp)
+
+    if animal_number < 0 || animal_number >= all_pets.size
+      puts "I'm sorry, that was an incorrect entry. Please try again.".red
+      display_all_animals
+    end
+
+    AnimalFactory.add_attributes_to_animals(animal_number, @animal_object)
+    display_details(animal_number)
+  end
+
+  def display_details(num)
+      pet = @animal_object.all[num]
+      if pet.species == "small-furry"
+        puts "\n#{pet.name.upcase} - Small & Furry".light_blue
+      else
+        puts "\n#{pet.name.upcase} - #{pet.species.capitalize}".light_blue
+      end
+      puts "------------------------------".cyan
+      puts "Breed:".green + " #{pet.breed}"
+      puts "Age:".green + " #{pet.age}"
+      puts "Size:".green + " #{pet.size}"
+      puts "Color:".green + " #{pet.color}"
+      puts "Sex:".green  + " #{pet.sex}\n\n"
+      puts "#{pet.description}\n\n"
+      puts "For more info on how to adopt #{pet.name}, visit www.bestfriends.org#{pet.url}"
+
+      repeat?
+  end
+
+  def repeat?
+    puts "\n\nWould you like to search more adoptable pets? (Please enter a number)\n".cyan
+    puts "1. Yes, take me back to the list of available #{@animal_object.to_s.downcase}."
+    puts "2. Yes, take me back to the main menu."
+    puts "3. No, I'm done.\n\n"
+    user_input = gets.chomp
+
+    if user_input == "1"
+      display_all_animals
+    elsif user_input == "2"
+      start
+    elsif user_input == "3"
+      exit
+    else
+      puts "I'm sorry, I didn't understand that answer.".red
+      repeat?
+    end
+  end
+
+  def number_to_index(user_input)
+    user_input.to_i - 1
+  end
+
+  def define_animal_object(user_input)
+    Object.const_get("#{PETS[user_input]}")
+  end
+end

data/lib/scraper.rb

@@ -0,0 +1,38 @@
+class Scraper
+
+  def self.scrape_adoptable_pets(animal)
+    pets = []
+    doc = Nokogiri::HTML(open("http://bestfriends.org/adopt/adopt-our-sanctuary/#{animal}"))
+    doc.css("div.rg-animal").each do |pet|
+      pet_details = {}
+      pet_details[:species] = animal
+      pet_details[:name] = pet.css("span.animalName").text
+      pet_details[:breed] = pet.css("span.animalBreed").text
+      pet_details[:age] = pet.css("span.animalAge").text
+      pet_details[:url] = pet.css("a").attribute("href").value
+      pets << pet_details
+    end
+    pets
+  end
+
+  def self.scrape_pet_profile(url)
+    pet_profile_details = {}
+
+    pet_profile = "http://bestfriends.org" + url
+    doc = Nokogiri::HTML(open(pet_profile))
+
+    pet_items = doc.css("div.rescue-groups-pet-info-item")
+
+    pet_items.each do |attribute|
+      if attribute.css("span.gray").text == "Size:"
+        pet_profile_details[:size] = attribute.css("span.bold.black").text
+      elsif attribute.css("span.gray").text == "Color:"
+        pet_profile_details[:color] = attribute.css("span.bold.black").text
+      elsif attribute.css("span.gray").text == "Sex:"
+        pet_profile_details[:sex] = attribute.css("span.bold.black").text
+      end
+    end
+    pet_profile_details[:description] = doc.css("section.rescue-groups-pet-info-section p").text.gsub("\n                        ", "")
+    pet_profile_details
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module BestFriendFinder
+  VERSION = "0.1.0"
+end

data/spec.md

@@ -0,0 +1,17 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [X] Have a CLI for interfacing with the application
+--> My CLI successfully welcomes the user, allows the user to make decisions by entering in numbers (and informs the user
+if that number is incorrect), view details requested by the user, and allows the user to return to the beginning of the
+application, to the middle of the application, or exit the application.
+
+- [X] Pull data from an external source
+--> Data is being pulled from the Best Friends Animal Society website, specifically under their adoption page. It is scraping
+both the data from the list of animals available for adoption, as well as each individual animal's page.
+
+- [X] Implement both list and detail views
+--> The user is first presented with a list of all available animals based on the type of animal that the user specifies
+(dogs, cats, etc.) This first-level list presents all animals and their name, breed and age. The user can then drill-down
+into more details of each animal by choosing the animal they are interested in. They are presented with a more detailed views
+which includes the initial informationa about the animal, as well as attributes such as size, sex, color and description.

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: BestFriendFinder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Alexis Dorn'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: pry
+  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: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: |-
+  CLI app that scrapes information and returns a list of animals available for adoption
+                            and their details from the Best Friends Animal Society sanctuary in Utah. http://bestfriends.org/
+email:
+- "'alexisadorn@gmail.com'"
+executables:
+- bestfriendfinder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- NOTES.md
+- README.md
+- Rakefile
+- bestfriendfinder.gemspec
+- bin/bestfriendfinder
+- bin/setup
+- config/environment.rb
+- lib/animalfactory.rb
+- lib/animals.rb
+- lib/animals/barnyard.rb
+- lib/animals/birds.rb
+- lib/animals/cats.rb
+- lib/animals/dogs.rb
+- lib/animals/equine.rb
+- lib/animals/pigs.rb
+- lib/animals/rabbits.rb
+- lib/animals/small.rb
+- lib/cli.rb
+- lib/scraper.rb
+- lib/version.rb
+- spec.md
+homepage: https://github.com/alexisadorn/BestFriendFinder-cli-app
+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.11
+signing_key: 
+specification_version: 4
+summary: A list of animals available for adoption.
+test_files: []