cats_to_adopt 0.1.1

data/lib/cats_to_adopt.rb

@@ -0,0 +1,9 @@
+# Environment
+require "cats_to_adopt/version"
+require "cats_to_adopt/CLI"
+require "cats_to_adopt/Cat"
+require "cats_to_adopt/Scraper"
+
+require "open-uri"
+require "nokogiri"
+require "pry"

data/lib/cats_to_adopt/CLI.rb

@@ -0,0 +1,57 @@
+class CatsToAdopt::CLI
+
+  BASE_PATH = "https://la.bestfriends.org/get-involved/adopt/"
+
+  def call
+    intro_message
+    make_cats
+    list_cats
+    menu
+    goodbye
+  end
+
+  def intro_message
+    puts "\n-----------------------------"
+    puts "| Welcome to Cats to Adopt! |"
+    puts "-----------------------------\n\n"
+    puts "Retrieving cat info..."
+  end
+
+  def make_cats
+    CatsToAdopt::Scraper.scrape_main_page(BASE_PATH + 'pets?field_animal_species_tid_selective=958')
+  end
+
+  def list_cats
+    CatsToAdopt::Cat.print_cats
+  end
+
+  def menu
+    input =  ""
+
+    while input != "exit"
+      puts "\nEnter the number of the cat you would like more info on."
+      puts "Type list to list all cats or exit to exit the program."
+      input = gets.strip
+
+      cats = CatsToAdopt::Cat.all
+
+      if input.to_i > 0 && input.to_i < cats.size + 1
+        cat_in_question = cats[input.to_i - 1]
+        attributes = CatsToAdopt::Scraper.scrape_profile_page(BASE_PATH + 'pet/' + cat_in_question.id)
+        cat_in_question.add_cat_attributes(attributes)
+        cat_in_question.print_cat_info
+      elsif input == "list"
+        list_cats
+      elsif input == "exit"
+        puts "\nClosing program ..."
+      else
+        puts "Please enter the number of a cat, list, or exit."
+      end
+    end
+
+    def goodbye
+      puts "\nGoodbye!"
+    end
+  end
+
+end # end CLI class

data/lib/cats_to_adopt/cat.rb

@@ -0,0 +1,46 @@
+class CatsToAdopt::Cat
+  attr_accessor :name, :gender, :size, :location, :profile_url, :id, :age, :color, :weight
+
+  @@all = []
+
+  # INSTANCE METHODS
+  # save a cat when it's created
+  def initialize
+    @@all << self
+  end
+
+  # set additional attributes on a cat
+  def add_cat_attributes(attributes)
+    self.color = attributes[:color]
+    self.weight = attributes[:weight]
+    self.age = attributes[:age]
+    self.profile_url = 'https://la.bestfriends.org/get-involved/adopt/pet/' + self.id
+  end
+
+  # prints detailed information for a cat
+  def print_cat_info
+    puts "\nCat Name: #{self.name}"
+    puts "-- ID: #{self.id}"
+    puts "-- Gender: #{self.gender}"
+    puts "-- Age: #{self.age}"
+    puts "-- Color: #{self.color}"
+    puts "-- Size: #{self.size}"
+    puts "-- Weight: #{self.weight}"
+    puts "-- Location: #{self.location}"
+    puts "-- Profile Link: #{self.profile_url}\n"
+  end
+
+  # CLASS METHODS
+  def self.all
+    @@all
+  end
+
+  def self.print_cats
+    puts "\nCats available now:"
+
+    self.all.each.with_index(1) do |cat, i|
+      puts "#{i}. #{cat.name} - #{cat.gender} - #{cat.size}"
+    end
+  end
+
+end # end Cat class

data/lib/cats_to_adopt/scraper.rb

@@ -0,0 +1,30 @@
+class CatsToAdopt::Scraper
+
+  # for each cat on the main page, scrapes the page for the cat's data and
+  # instantiates a Cat object with that data.
+  def self.scrape_main_page(main_page_url)
+    main_page = Nokogiri::HTML(open(main_page_url))
+
+    main_page.search(".pet-list-item").each do |cat|
+      new_cat = CatsToAdopt::Cat.new
+      new_cat.name = cat.search(".views-field-field-animal-name").text.strip
+      new_cat.id = cat.search(".views-field-field-animal-name a").attr("href").text.gsub("/get-involved/adopt/pet/", "").strip
+      new_cat.gender = cat.search(".views-field-field-animal-sex .field-content").text.strip
+      new_cat.size = cat.search(".views-field-field-animal-size .field-content").text.strip
+      new_cat.location = cat.search(".views-field-field-shelter-state .field-content").text.strip
+    end
+  end
+
+  # given a cat's profile page URL, scrapes the cat's profile page and returns a
+  # hash of additional attributes for that cat
+  def self.scrape_profile_page(profile_url)
+    profile_page = Nokogiri::HTML(open(profile_url))
+    attributes = {}
+
+    attributes[:color] = profile_page.search(".petpoint-pet-color .info").text.strip
+    attributes[:weight] = profile_page.search(".card__info .petpoint-pet-weight:nth-child(7) .info").text.strip
+    attributes[:age] = profile_page.search(".card__info .petpoint-pet-age:nth-child(4) .info").text.strip
+
+    attributes
+  end
+end # end Scraper class

data/lib/cats_to_adopt/version.rb

@@ -0,0 +1,3 @@
+module CatsToAdopt
+  VERSION = "0.1.1"
+end

data/spec.md

@@ -0,0 +1,14 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [X] Have a CLI for interfacing with the application
+
+The CLI shows a list of current cats available for adoption at the NKLA website. It asks the user which cat they would like more info on and also allows them to list the cats again or exit the program. The CLI validates the user input.
+
+- [X] Pull data from an external source
+
+I used Nokogiri & Open URI to scrape data from the NKLA index site for adoptable cats as well as each cat's profile page. I used VCR and WebMock to cache the results of my HTTP requests during testing as to not bombard the NKLA site with requests. The CLI scrapes the index page when the program starts, but each cat's profile page is only scraped when that cat's info is requested by the user to reduce the initial loading time.
+
+- [X] Implement both list and detail views
+
+The user selects a cat number which then shows them additional information about the cat scraped from the cat's profile page.

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: cats_to_adopt
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Allyson Wesman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: 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'
+- !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: nokogiri
+  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'
+description: Created as  Ruby final project for Flatiron School's Online Web Developer
+  pgoram. The gem scrapes No Kill LA's page on cats available to adopt now and lists
+  them in a CLI interface. The user can choose a cat to get more information.
+email:
+- allysonwesman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec_status"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/cats_to_adopt
+- bin/console
+- bin/setup
+- cats_to_adopt.gemspec
+- fixtures/vcr_cassettes/cats_to_adopt.yml
+- lib/cats_to_adopt.rb
+- lib/cats_to_adopt/CLI.rb
+- lib/cats_to_adopt/cat.rb
+- lib/cats_to_adopt/scraper.rb
+- lib/cats_to_adopt/version.rb
+- spec.md
+homepage: https://github.com/allysonw/cats-to-adopt-cli-gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Lists and provides info on current cats available to adopt from NKLA's website.
+test_files: []