sea_life 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc61dba00cb2b4117d56e02332de357e66dc30aa5efa1ddcfd98ab66c21d8e64
-  data.tar.gz: 05763a4e36c257e163ccc36daba80b76f2a693859cb41de5fc879368369756d7
+  metadata.gz: 1fe7f094b290aa3861eb0b8152902d349da9a4ba025348465821ce4f88725c42
+  data.tar.gz: 840b9b42cc6541a8b81f46e3aa4c8466efe5456fa3f2601461a916ca0dcd5f30
 SHA512:
-  metadata.gz: 3c729a70383c84e67f948494e221799bf0688c21b48ea9e0ea30660e05c7b92b039c8461874ea7cbf540e11ba69463557929398a80e396c6bf55148567c42ebc
-  data.tar.gz: 4e74ffb7538ea273b50f9debf0e3214bd0a445b38c86793a068882ba9a3e6d0c236285bbad95f42cef4ad704296045352a2fa87bcda03527ef5fcd9b4c2789a3
+  metadata.gz: d07de2328538b5dbb32206c8f44912f6d295a44484ad37a9365705d0802a42e63071add1f963ef02ae8d31a2023380f8f974b00a5398d9a614bc6c68056f590f
+  data.tar.gz: ffe95daaa3132548b9d0a0b3978c84135350714a27c12fcdc300bad46b686ffa2749bf62f4d3c1ede247ca71363ca6daea18651b712147604b22ba085fdfeba2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sea_life (0.1.2)
+    sea_life (0.1.3)
       nokogiri (~> 1.8, >= 1.8.0)
 
 GEM

data/README.md

@@ -1,26 +1,20 @@
 # SeaLife
 
-SeaLife is a simple command line interface gem that scrapes information from a website and provides information about sea creatures.
+SeaLife is a simple CLI Gem that scrapes information from Oceana's Marine Life Encyclopedia and provides information about sea creatures.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'sea_life'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Gem can be installed by:
 
     $ gem install sea_life
 
 ## Usage
 
-Usage information will be provided later.
+Run the CLI by typing:
+
+    $ sea_life
+
+After the CLI has loaded you will be presented with a list of categories.  Enter the number of the category you'd like to see and press enter.  The application will present you with a list of animals that belong to that category.  You can then choose one of these animals by entering the number of your selection.
 
 ## Development
 
@@ -34,7 +28,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/mattet
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://github.com/mattetress/sea_life/blob/master/LICENSE.txt).
 
 ## Code of Conduct
 

data/lib/sea_life/animal.rb

@@ -1,11 +1,10 @@
 class SeaLife::Animal
-  attr_accessor :url, :category, :name, :distribution, :habitat, :habits, :status, :taxonomy, :short_desc, :longer_desc, :scientific_name
-
-
+  attr_accessor :url, :name, :distribution, :habitat, :habits, :status, :taxonomy, :short_desc, :longer_desc, :scientific_name
+  attr_reader :category
   @@all = []
 
   def initialize(info)
-    info.each { |k, v| self.send("#{k}=", v) }
+    add_info(info)
     @@all << self
   end
 
@@ -25,6 +24,4 @@ class SeaLife::Animal
   def self.find_by_name(name)
     self.all.detect { |animal| animal.name == name }
   end
-
-
 end

data/lib/sea_life/cli.rb

@@ -1,37 +1,34 @@
 class SeaLife::CLI
 
   def call
-    puts <<-DOC
-------------------------------------------------------------
-
-      _________             .____    .__  _____
-     /   _____/ ____ _____  |    |   |__|/ ____\\____
-     \\_____  \\_/ __ \\\\__  \\ |    |   |  \\   __\\/ __ \\
-     /        \\  ___/ / __ \\|    |___|  ||  | \\  ___/
-    /_________/\\____/ _____/ ________\\__||__|  \\____/
-
-
-------------------------------------------------------------
-
-Welcome!
-DOC
+    puts "------------------------------------------------------------"
+    puts ""
+    puts "      _________             .____    .__  _____"
+    puts "     /   _____/ ____ _____  |    |   |__|/ ____\\____"
+    puts "     \\_____  \\_/ __ \\\\__  \\ |    |   |  \\   __\\/ __ \\"
+    puts "     /        \\  ___/ / __ \\|    |___|  ||  | \\  ___/"
+    puts "    /_________/\\____/ _____/ ________\\__||__|  \\____/"
+    puts ""
+    puts ""
+    puts "------------------------------------------------------------"
+    puts ""
+    puts "Welcome!"
 
     list_categories
-
   end
 
-
-
   def list_categories
     puts ""
     puts "Please choose a category to learn about:"
     puts ""
+
     make_categories if SeaLife::Category.all.size == 0
     categories = SeaLife::Category.all
 
     categories.each_with_index do |category, i|
       puts "#{i + 1}. #{category.name}"
     end
+
     puts ""
     main_menu(categories)
   end
@@ -45,14 +42,19 @@ DOC
   def list_animals(category)
     puts "Loading animals..."
     puts ""
+
     make_animals_from_category(category) if category.animals.size == 0
+
     puts "Please select the animal you'd like to learn about:"
+
     animals = []
     category.animals.each_with_index do |animal, i|
       puts "#{i + 1}. #{animal.name}"
       animals << animal
     end
+
     puts ""
+
     category_menu(animals)
   end
 
@@ -63,6 +65,7 @@ DOC
 
   def show_animal(animal)
     SeaLife::Scraper.scrape_animal_info(animal) unless animal.scientific_name
+
     puts ""
     puts "--------------------------------------------------------------"
     puts "#{animal.name} (#{animal.scientific_name})"
@@ -78,11 +81,13 @@ DOC
     puts ""
     puts "Enter \"MORE\" to continue reading about the #{animal.name}."
     puts "You may also enter \"BACK\", \"MENU\", or \"EXIT\"."
+
     animal_menu(animal)
   end
 
   def animal_menu(animal)
     input = gets.strip.downcase
+
     if input == "more"
       puts ""
       puts "#{animal.longer_desc}"
@@ -104,8 +109,10 @@ DOC
   def main_menu(categories)
     puts "Please enter the number of a category:"
     puts "You may also enter \"EXIT\"."
+
     input = gets.strip
-    if input.to_i > 0
+
+    if input.to_i > 0 && input.to_i <= categories.size
       list_animals(categories[input.to_i - 1])
     elsif input.downcase == "exit"
       goodbye
@@ -118,8 +125,10 @@ DOC
   def category_menu(animals)
     puts "Please enter the number of your selection."
     puts "You may also enter BACK or EXIT"
+
     input = gets.strip
-    if input.to_i > 0
+
+    if input.to_i > 0 && input.to_i <= animals.size
       show_animal(animals[input.to_i - 1])
     elsif input.downcase == "back"
       list_categories
@@ -131,22 +140,16 @@ DOC
     end
   end
 
-
-
   def goodbye
-    puts <<-DOC
-------------------------------------------------------------
-
-      _________             .____    .__  _____
-     /   _____/ ____ _____  |    |   |__|/ ____\\____
-     \\_____  \\_/ __ \\\\__  \\ |    |   |  \\   __\\/ __ \\
-     /        \\  ___/ / __ \\|    |___|  ||  | \\  ___/
-    /_________/\\____/ _____/ ________\\__||__|  \\____/
-                                        See you soon!
-
-------------------------------------------------------------
-DOC
-
+    puts "------------------------------------------------------------"
+    puts ""
+    puts "      _________             .____    .__  _____"
+    puts "     /   _____/ ____ _____  |    |   |__|/ ____\\____"
+    puts "     \\_____  \\_/ __ \\\\__  \\ |    |   |  \\   __\\/ __ \\"
+    puts "     /        \\  ___/ / __ \\|    |___|  ||  | \\  ___/"
+    puts "    /_________/\\____/ _____/ ________\\__||__|  \\____/"
+    puts "                                        See you soon!"
+    puts ""
+    puts "------------------------------------------------------------"
   end
-
 end

data/lib/sea_life/scraper.rb

@@ -5,17 +5,20 @@ class SeaLife::Scraper
   def self.scrape_categories #Scrapes oceana and returns array of categories
     categories = []
     doc = Nokogiri::HTML(open(BASE_URL + "/marine-life"))
+
     doc.css("article.animal-tile").each do |item|
       category = {}
       category[:url] = item.css("div.overlay a").attribute("href").value
       category[:name] = item.css("div.copy h1").text
       categories << category unless category[:name] == "Marine Science and Ecosystems"
     end
+
     categories
   end
 
   def self.scrape_animals(category)
     doc = Nokogiri::HTML(open(BASE_URL + category.url))
+
     doc.css("article").each do |animal|
       animal_info = {}
       animal_info[:category] = category
@@ -25,29 +28,24 @@ class SeaLife::Scraper
     end
   end
 
-  # def self.scrape_animals(category_url)
-  #   doc = Nokogiri::HTML(open(BASE_URL + category_url))
-  #   doc.css("article").each do |animal|
-  #    SeaLife::Animal.new(SeaLife::Scraper.scrape_animals_from_url("#{animal.css("div.overlay a").attribute("href").value}"))
-  #   end
-  # end
-
   def self.scrape_animal_info(animal)
     doc = Nokogiri::HTML(open(BASE_URL + animal.url))
+
     animal_info = {}
-    # animal_info[:category] = doc.css("section.subpage-header div h2").text
-    # animal_info[:name] = doc.css("section.subpage-header div h1").text
     animal_info[:scientific_name] = doc.css("section.subpage-header div p").text
     animal_info[:short_desc] = doc.css("div.animal-description-contain p").text
     animal_info[:longer_desc] = ""
+
     doc.css("section.animal-secondary div.flex-item-2 p").each do |paragraph|
       break if paragraph.text == "Additional Resources:"
       animal_info[:longer_desc] += "\n\n #{paragraph.text}"
     end
+
     i = 0
     while i < doc.css("div.animal-details-side h2").size - 1 do
       info_cat = doc.css("div.animal-details-side h2")[i].text.strip.downcase
       info = doc.css("div.animal-details-side p")[i].text.strip
+
       case info_cat
       when "ecosystem/habitat"
         animal_info[:habitat] = info
@@ -61,6 +59,7 @@ class SeaLife::Scraper
 
       i += 1
     end
+    
     animal.add_info(animal_info)
   end
 

data/lib/sea_life/version.rb

@@ -1,3 +1,3 @@
 module SeaLife
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sea_life
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Matt Etress
@@ -85,7 +85,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- NOTES.md
 - README.md
 - Rakefile
 - bin/console

data/NOTES.md

@@ -1,61 +0,0 @@
-CLI Gem Sea Life
-
-user types in sea_life
-
-shows a list of categories
-
-Welcome to Sea Life!
-Choose a category to learn about:
-
-1. Cephalopods, crustaceans, & other shellfish
-2. Corals and other invertebrates
-3. Marine mammals
-4. Marine science and ecosystems
-5. ocean fishes
-6. sea turtles & reptiles
-7. seabirds
-8. sharks & rays
-
-Please enter your selection:
-
-INPUT — 2
-
-Corals and other invertebrates
-
-info
-
-choices
-
-1.  American oyster
-2. blue glaucus
-3. chilean basket star
-…
-
-
-INPUT — 1
-
-displays american oyster info
-
-Name:  American Oyster
-Scientific Name:  Crassostrea virginica
-
-Distribution:  Sub-tropical to temperate latitudes of the western Atlantic Ocean
-Ecosystem/Habitat: Soft bottoms
-Feeding Habits: Filter feeder
-Conservation Status: Critically Endangered (Very Highly Vulnerable To Extinction)
-Taxonomy: Class Bivalvia (clams, oysters, and relatives), Family Ostreidae (true oysters)
-
-The American oyster is an iconic species of the Chesapeake Bay and other coastal waters of eastern North America. Historically, this species was so common and made such large reefs that it was a documented navigation hazard in some areas. Unfortunately, a history of overexploitation, pollution, and physical damage has reduced the American oyster population size to as low as one percent of its original abundance in some areas.
-
-Type “More” to read more about the American Oyster.  You may also type “Back” or “Exit”.
-
-INPUT  —  More
-
-puts
-American oysters, like all true oysters, live a sessile lifestyle.  After a short mobile phase in the plankton, juveniles settle on dead oyster shells or some other hard surface and permanently cement themselves in place.  From then on, they build strong, calcium carbonate shells.  In this manner, they form very large reefs that provide habitat for several other species of invertebrates and fishes.  American oysters are filter feeders that strain plankton and other organic matter from the water above the surface of their reefs.  In areas with high oyster densities, they can keep the water nearly free of floating matter.  Each American oyster filters approximately 50 gallons of water per day. 
-American oysters reproduce via broadcast spawning, where several females release their eggs and several males release their sperm into the water column at the same time.  This behavior increases the likelihood that eggs will be fertilized and decreases the likelihood that the eggs will be eaten by predators near the reef’s surface.  These oysters are extremely productive, and a single female may release as many as 150 million eggs throughout her lifetime.  When they hatch, all American oysters are male.  Most of them reproduce at least once as male, but as they mature, some individuals change to female.  This sex change is a result of the difference in energy required to make sperm and eggs.  Small individuals can make sperm, while continuing to grow.  Larger individuals that have stopped actively growing can afford to utilize their energy to make the larger eggs.  Reproduction is triggered by temperature in this species.
-The American oyster has been overfished and depleted for more than 120 years.  The Chesapeake Bay population has been exploited particularly hard, and catches peaked as early as the 1880s.  By the early 1900s, it was already depleted.  Catch now is approximately one percent of what it was at its 1880s peak.  The overexploitation of American oysters has changed the Bay significantly.  While the oysters formerly filtered the entire contents of the Bay in short periods of time, that is no longer the case.  High levels of pollution in the Chesapeake are exacerbated by the fact that its natural scrubber system has been removed.  Though it is likely not at risk of full extinction – thanks to its large range and very high reproductive output – the American oyster is severely depleted throughout its range and no longer provides the habitat and filtration services that it once did.
-
-
-categories :    article.animal-tile
-category url:  site.css("article.animal-tile div.overlay a").attribute("href").value