plant_toxicity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e879c7994be042bfdc68380906e3b70b80c2f66
+  data.tar.gz: ee4cb46a3fa39e57ad930a6d55274de3bbde32c0
+SHA512:
+  metadata.gz: 89597d8ce63acbb4d99b7bc9ef5869b2cd1643522cab2360605cba7b12d41582cb90855f92fcbc723ae0f12464d1ec7d2ef9dcf4fe0591727d15bc38ad6f3e9e
+  data.tar.gz: e3b3c26bed778fa49bfe7dded273f4af4d2285e5da9f438355b8025649d223e98964b20b894da4e11321e94baaf63d631952315690d2da89db3d41e4e76b1972

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 'Veronica Miller'
+
+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,38 @@
+# PlantToxicity
+
+This Ruby Gem contains a CLI that can provide details about common plants, including their toxicity to certain pets (dogs, cats, and horses). Based on information from the ASPCA website, the user can obtain a list of plants for any letter of the alphabet (A-Z), and then additional details about specific plants in the list can be requested. These details may include, as available: other common names, scientific name, toxicity, non-toxicity, and clinical signs of poisoning.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plant_toxicity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plant_toxicity
+
+## Usage
+
+After installation, type 'plant-toxicity' and then follow the prompts.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/'vmcmiller-72282'/plant_toxicity. 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/bin/plant-toxicity

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "./lib/plant_toxicity"
+require "bundler/setup"
+
+PlantToxicity::CLI.new.call

data/lib/plant_toxicity.rb

@@ -0,0 +1,9 @@
+require_relative "plant_toxicity/version"
+require_relative './plant_toxicity/cli'
+require_relative './plant_toxicity/list'
+require_relative './plant_toxicity/plant'
+require_relative './plant_toxicity/scraper'
+
+require 'nokogiri'
+require 'open-uri'
+require 'pry'

data/lib/plant_toxicity/cli.rb

@@ -0,0 +1,88 @@
+class PlantToxicity::CLI
+
+  def call
+    puts "Welcome to the Plant Toxicity to Pets tool!"
+    puts "-------------------------------------------"
+    puts "It can tell you whether various common plants are toxic to dogs, cats, and horses."
+    list_plants_by_letter
+    puts "-------------------------------------------"
+    puts "Thank you for using the tool! Goodbye."
+    exit
+  end
+
+  def list_plants_by_letter
+    puts "The plants are listed alphabetically by letter, according to the first letter in each plant's name."
+    puts "To see a list of plants, enter a letter from A to Z. Enter 'exit' to end the session."
+    input = nil
+    until input == "exit"
+      input = gets.strip.downcase
+      if input.match(/\b[a-z]\b/)
+        list = PlantToxicity::List.all.detect {|list| list.letter == input.upcase}
+        if !list
+          list = PlantToxicity::List.new(input.upcase)
+        end
+        display_list(list)
+        puts "Enter a letter from A to Z to see another list of plants, or enter 'exit' to end the session."
+      elsif input == "exit"
+        break
+      else
+        puts "Sorry, that is not a valid option. Enter a letter or 'exit'."
+      end
+    end
+  end
+
+  def display_list(list)
+    if !list.plants.empty?
+      puts "These are the plants that begin with the letter '#{list.letter}':"
+      list.plants.each.with_index(1) do |plant, i|
+        puts "#{i}. #{plant.name}"
+      end
+      puts "-------------------------------------------"
+      puts "Would you like to see more details about a plant in this list? (Y/N)"
+      input = nil
+      until input == "n"
+        input = gets.strip.downcase
+        if input == "y"
+          show_details(list)
+          puts "Would you like more information about another plant in this list? (Y/N)"
+        elsif input == "n"
+          break
+        else
+          puts "Sorry, that is not a valid option. Please enter Y or N."
+        end
+      end
+    else
+      puts "-------------------------------------------"
+      puts "There are no plants that begin with the letter '#{list.letter}'."
+      puts "-------------------------------------------"
+    end
+  end
+
+  def show_details(list)
+    puts "Please enter the plant's number. (1-#{list.plants.length})"
+    input = gets.strip.to_i
+    until input >= 1 && input <= list.plants.length
+      puts "Sorry, that is not a valid option. Please enter a number."
+      input = gets.strip.to_i
+    end
+    plant = list.select_plant(input-1)
+    display_plant(plant)
+  end
+
+  def display_plant(plant)
+    header = "Details for #{plant.name}:"
+    puts "-" * header.length
+    puts header
+    puts "-" * header.length
+    plant.details.each do |detail|
+      puts "Other Names:  #{plant.other_names}" if detail == :@other_names
+      puts "Scientific Name:  #{plant.scientific_name}" if detail == :@scientific_name
+      puts "Toxicity:  #{plant.toxicity}" if detail == :@toxicity
+      puts "Non-Toxicity:  #{plant.non_toxicity}" if detail == :@non_toxicity
+      puts "Clinical Signs:  #{plant.clinical_signs}" if detail == :@clinical_signs
+      puts "" if detail != plant.details.last
+    end
+    puts "-" * header.length
+  end
+
+end

data/lib/plant_toxicity/list.rb

@@ -0,0 +1,24 @@
+class PlantToxicity::List
+
+  attr_accessor :letter, :plants
+  attr_reader :scraper
+
+  @@all = []
+
+  def initialize(letter)
+    @letter = letter.upcase
+    @plants = PlantToxicity::Scraper.get_list(@letter)
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def select_plant(input)
+    plant = self.plants[input]
+    PlantToxicity::Scraper.get_plant_details(plant)
+    plant
+  end
+
+end

data/lib/plant_toxicity/plant.rb

@@ -0,0 +1,16 @@
+class PlantToxicity::Plant
+
+  attr_accessor :name, :url, :scientific_name, :other_names, :toxicity, :non_toxicity, :clinical_signs
+
+  def initialize(name, url)
+    @name = name
+    @url = url
+  end
+
+  def details
+    [:@other_names, :@scientific_name, :@toxicity, :@non_toxicity, :@clinical_signs].reject do |var|
+      self.instance_variable_get(var) == nil || self.instance_variable_get(var) == ""
+    end
+  end
+
+end

data/lib/plant_toxicity/scraper.rb

@@ -0,0 +1,49 @@
+class PlantToxicity::Scraper
+
+  URL_BASE = "https://www.aspca.org"
+
+  def self.get_list(letter)
+    plants = []
+    doc = Nokogiri::HTML(open(URL_BASE + "/pet-care/animal-poison-control/toxic-and-non-toxic-plants"))
+    letter_details = doc.search("div.view-content span.views-summary a").detect {|letters| letters.text == letter.upcase}
+    if letter_details != nil
+      pages = []
+      pages << URL_BASE + letter_details.attribute("href").value
+      Nokogiri::HTML(open(pages.first)).search("li.pager-item").each {|page| pages << URL_BASE + page.search("a").attribute("href").value}
+      if pages.length > 1
+        next_page = Nokogiri::HTML(open(pages.last)).search("ul.pager li").detect {|link| link.attribute("class").value == "pager-next"}
+        while next_page
+          pages << URL_BASE + next_page.search("a").attribute("href").value
+          next_page = Nokogiri::HTML(open(pages.last)).search("ul.pager li").detect {|link| link.attribute("class").value == "pager-next"}
+        end
+      end
+      pages.each do |page|
+        Nokogiri::HTML(open(page)).search("div.views-field-title a").each do |plant|
+          plants << PlantToxicity::Plant.new(plant.text, URL_BASE + plant.attribute("href").value)
+        end
+      end
+    end
+    plants
+  end
+
+  def self.get_plant_details(plant)
+    Nokogiri::HTML(open(plant.url)).search("div.pane-entity-field div.field-items").each do |field|
+      if field.search("span.label-inline-format-label").text == "Scientific Name:"
+        plant.scientific_name = field.search("span.values").text.strip
+      end
+      if field.search("span.label-inline-format-label").text == "Additional Common Names:"
+        plant.other_names = field.search("span.values").text.strip
+      end
+      if field.search("span.label-inline-format-label").text == "Toxicity:"
+        plant.toxicity = field.search("span.values").text.strip
+      end
+      if field.search("span.label-inline-format-label").text == "Non-Toxicity:"
+        plant.non_toxicity = field.search("span.values").text.strip
+      end
+      if field.search("span.label-inline-format-label").text == "Clinical Signs:"
+        plant.clinical_signs = field.search("span.values").text.strip
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: plant_toxicity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Veronica Miller'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-03 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: 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'
+- !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'
+description: As prompted by the user, it can list all plants starting with a given
+  letter of the alphabet as well as provide further details about any plant listed.
+email:
+- "'vmcmiller@gmail.com'"
+executables:
+- plant-toxicity
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/plant-toxicity
+- lib/plant_toxicity.rb
+- lib/plant_toxicity/cli.rb
+- lib/plant_toxicity/list.rb
+- lib/plant_toxicity/plant.rb
+- lib/plant_toxicity/scraper.rb
+homepage: http://rubygems.org/gems/plant-toxicity
+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: Provides details about common plants and their toxicity to pets.
+test_files: []