SDzoo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 422c510c931c36a62a908347ee2218b4c547f4ee
+  data.tar.gz: 879d61e6e2fd3ad69abf5f804788cf8c3c95dbd6
+SHA512:
+  metadata.gz: 89de33dc8800d10db594df568675b5bea932b666bd6dddfb9b4a0bef2fd41c098df3f48abfa818d259ca61e13b666cae0cea602b73c5104d2e361bcd65ab561a
+  data.tar.gz: 76b4cd5e30eb54c10679eb4fa8ca63e338c0b1239923c0f15f08186d495c84e51839771125929d8b65109214220678248473740134cd0e1dbfe86de66f0c7fa4

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at burra.archana@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in SDzoo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Archana Burra
+
+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,31 @@
+# SDzoo
+
+Welcome to the San Diego Zoo CLI application! Use this CLI app to find information about all the animals listed on the San Diego Zoo website, including life span, conservation status, taxonomic information and a fun fact! The app/author is not affiliated with the SD zoo.
+
+## Installation
+
+    $ gem install SDzoo
+
+## Usage
+
+Type the below and follow the on screen prompts.
+
+    $ SDzoo
+
+## 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/burrahey/SDzoo. 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).
+
+## Code of Conduct
+
+Everyone interacting in the SDzoo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/burrahey/SDzoo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/SDzoo.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "SDzoo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "SDzoo"
+  spec.version       = SDzoo::VERSION
+  spec.authors       = ["Archana Burra"]
+  spec.email         = ["burra.archana@gmail.com"]
+
+  spec.summary       = %q{San Diego Zoo CLI app to view information about various kinds of animals.}
+  spec.description   = %q{Find information about all the animals listed on the San Diego Zoo website, including life span, conservation status, taxonomic information and a fun fact! The app/author is not affiliated with the SD zoo.}
+  spec.homepage      = "https://github.com/burrahey/SDzoo-cli-app"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "nokogiri", "1.6.6.2"
+  spec.add_dependency "colorize", "~> 0"
+
+end

data/bin/SDzoo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/SDzoo.rb'
+
+SDzoo::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "SDzoo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/lib/SDzoo.rb

@@ -0,0 +1,11 @@
+require_relative "SDzoo/version"
+require_relative "SDzoo/cli"
+require_relative "SDzoo/animal"
+require_relative "SDzoo/scraper"
+
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+module SDzoo
+  # Your code goes here...
+end

data/lib/SDzoo/animal.rb

@@ -0,0 +1,68 @@
+class SDzoo::ANIMAL
+  attr_accessor :name, :url, :taxonomy, :conservation_status, :life_span, :fun_fact
+
+  @@all_mammals = []
+  @@all_reptiles = []
+  @@all_birds = []
+  @@all_fish = []
+  @@all_arthropods = []
+  @@all_amphibians = []
+
+  def initialize(name, url, type)
+    @name = name
+    @url = url
+    @type = type
+    self.class.send("all_#{type}") << self
+  end
+
+  def add_attributes_to_animal(animal_hash)
+    animal_hash.each do |type, value|
+      self.send("#{type}=", value)
+    end
+  end
+
+  def self.all_mammals
+  	@@all_mammals
+  end
+
+   def self.all_reptiles
+   	@@all_reptiles
+  end
+
+   def self.all_birds
+   	@@all_birds
+  end
+
+   def self.all_fish
+   	@@all_fish
+  end
+
+   def self.all_arthropods
+   	@@all_arthropods
+  end
+
+   def self.all_amphibians
+   	@@all_amphibians
+  end
+
+  def self.display_all(type)
+    self.send("all_#{type}").each_with_index do |animal, index|
+      puts "#{index+1}. #{animal.name}"
+    end
+    puts "\n"
+  end
+
+  def display_all_attributes
+    puts "NAME: #{@name}"
+    if @conservation_status.downcase.include?("threat") || @conservation_status.downcase.include?("danger")
+      puts "CONSERVATION STATUS: #{@conservation_status}".colorize(:red)
+    else
+      puts "CONSERVATION STATUS: #{@conservation_status}".colorize(:green)
+    end
+    puts "LIFE SPAN: #{@life_span}"
+    puts "FUN FACT: #{@fun_fact}"
+    puts "TAXONOMIC INFO:"
+    puts "#{@taxonomy}"
+    puts "\n"
+  end
+end

data/lib/SDzoo/cli.rb

@@ -0,0 +1,119 @@
+class SDzoo::CLI
+
+  def call
+    puts "Welcome to the San Diego Zoo CLI app!"
+    puts "To get started, what type of animals would you like to learn more about?"
+    main_menu
+    input = gets.strip.downcase
+
+    while input != "exit"
+
+      if valid_input?(input)
+        create_animals(input)
+        SDzoo::ANIMAL.display_all(input)
+
+        puts "What animal would you like to find out more about? Enter a number or name."
+        more = gets.strip
+
+        # Handle the case where they entered a number
+        if more.to_i > 0 && more.to_i < SDzoo::ANIMAL.send("all_#{input}").length
+          search_by_number(input, more)
+        else
+        # Handle the case where they entered a name
+          search_by_name(input, more)
+        end
+
+        sleep(2)
+      else
+        "Sorry, that wasn't valid input."
+      end
+      puts "\nWhat kind of animal would you like to learn about next?"
+      main_menu
+      input = gets.strip.downcase
+    end
+
+    bye
+  end
+
+  def valid_input?(input)
+    valid = ['mammals', 'birds', 'amphibians', 'arthropods', 'fish', 'reptiles']
+    if valid.include?(input)
+      return true
+    else
+      return false
+    end
+  end
+
+  def create_animals(type)
+    animal_array = SDzoo::SCRAPER.scrape_and_create_animals(type)
+  end
+
+  def add_attributes_to_animals(animal)
+    animal_hash = SDzoo::SCRAPER.add_attributes_to_animal(animal.url)
+    animal.add_attributes_to_animal(animal_hash)
+  end
+
+  def search_by_number(input, more)
+    animal = SDzoo::ANIMAL.send("all_#{input}")[more.to_i - 1]
+    add_attributes_to_animals(animal)
+    puts "\nOkay, here's some more info:"
+    animal.display_all_attributes
+
+  end
+
+  def search_by_name(input, more)
+    potential_answers = SDzoo::ANIMAL.send("all_#{input}").select {|animal| animal.name.downcase.include?(more.downcase)}
+    if potential_answers.length == 0
+      puts "\nSorry, none of the animal names match that description."
+    elsif potential_answers.length == 1
+      animal = potential_answers[0]
+      add_attributes_to_animals(animal)
+      animal.display_all_attributes
+    else
+      puts "\nHere are some of the #{input} that match that name: "
+      potential_answers.each do |animal|
+        add_attributes_to_animals(animal)
+        animal.display_all_attributes
+      end
+    end
+  end
+
+  def main_menu
+    puts  <<~HEREDOC
+      Mammals
+      Reptiles
+      Birds
+      Amphibians
+      Arthropods
+      Fish
+    HEREDOC
+    puts "You can choose a name from above, or type 'exit'"
+  end
+
+  def bye
+    puts "Goodbye! Thanks for using the San Diego Zoo CLI app."
+    puts <<~HEREDOC
+    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+    @@@@@@@@@@@@@@@@@@@@@@@'~~~     ~~~`@@@@@@@@@@@@@@@@@@@@@@@@@
+    @@@@@@@@@@@@@@@@@@'                     `@@@@@@@@@@@@@@@@@@@@
+    @@@@@@@@@@@@@@@'                           `@@@@@@@@@@@@@@@@@
+    @@@@@@@@@@@@@'                               `@@@@@@@@@@@@@@@
+    @@@@@@@@@@@'                                   `@@@@@@@@@@@@@
+    @@@@@@@@@@'                                     `@@@@@@@@@@@@
+    @@@@@@@@@'                                       `@@@@@@@@@@@
+    @@@@@@@@@                                         @@@@@@@@@@@
+    @@@@@@@@'                      n,                 `@@@@@@@@@@
+    @@@@@@@@                     _/ | _                @@@@@@@@@@
+    @@@@@@@@                    /'  `'/                @@@@@@@@@@
+    @@@@@@@@a                 <~    .'                a@@@@@@@@@@
+    @@@@@@@@@                 .'    |                 @@@@@@@@@@@
+    @@@@@@@@@a              _/      |                a@@@@@@@@@@@
+    @@@@@@@@@@a           _/      `.`.              a@@@@@@@@@@@@
+    @@@@@@@@@@@a     ____/ '   \__ | |______       a@@@@@@@@@@@@@
+    @@@@@@@@@@@@@a__/___/      /__\ \ \     \___.a@@@@@@@@@@@@@@@
+    @@@@@@@@@@@@@/  (___.'\_______)\_|_|        \@@@@@@@@@@@@@@@@
+    @@@@@@@@@@@@|\________                       ~~~~~\@@@@@@@@@@
+    HEREDOC
+    puts "P.S You can do more to help stop animal extinction here: http://endextinction.org/"
+  end
+end

data/lib/SDzoo/scraper.rb

@@ -0,0 +1,31 @@
+class SDzoo::SCRAPER
+
+  BASE_PATH = "http://animals.sandiegozoo.org/"
+  BASE_TYPE_PATH = "animals/"
+  def self.scrape_and_create_animals(type)
+
+    sections = Nokogiri::HTML(open(BASE_PATH + BASE_TYPE_PATH + type)).search("div.views-field-title span.field-content a")
+
+      sections.each do |section|
+        animal = SDzoo::ANIMAL.new(section.text, section["href"], type)
+      end
+
+  end
+
+  def self.add_attributes_to_animal(file_path)
+    animal_hash = {}
+
+    doc = Nokogiri::HTML(open(BASE_PATH + file_path))
+
+    taxo_array = doc.css("div.field-node--field-classifications.field-name-field-classifications div.field__items div.field__item ul").text.split("\n\t")
+
+    animal_hash[:taxonomy] = taxo_array.join("\n").strip.chomp(",")
+
+    animal_hash[:conservation_status] = doc.search("div.vocabulary-conservation-status div.field__item").text.strip
+    animal_hash[:life_span] = doc.css("div#block-sidebarcontent").text.strip.split("\n\n")[1].strip
+    animal_hash[:fun_fact] = doc.css("div#block-sidebarcontent").text.strip.split("FUN FACTS")[-1].strip.split(".")[0] + "."
+
+    animal_hash
+  end
+
+end

data/lib/SDzoo/version.rb

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

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+- [x] Pull data from an external source
+- [x] Implement both list and detail views

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: SDzoo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Archana Burra
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: Find information about all the animals listed on the San Diego Zoo website,
+  including life span, conservation status, taxonomic information and a fun fact!
+  The app/author is not affiliated with the SD zoo.
+email:
+- burra.archana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SDzoo.gemspec
+- bin/SDzoo
+- bin/console
+- bin/setup
+- lib/SDzoo.rb
+- lib/SDzoo/animal.rb
+- lib/SDzoo/cli.rb
+- lib/SDzoo/scraper.rb
+- lib/SDzoo/version.rb
+- spec.md
+homepage: https://github.com/burrahey/SDzoo-cli-app
+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.6.12
+signing_key: 
+specification_version: 4
+summary: San Diego Zoo CLI app to view information about various kinds of animals.
+test_files: []