animal_info 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a42fb09c3488e3b9a8bc58adde1b24658d7ccb486ae84dc9bca1e33cfdde69e0
+  data.tar.gz: 20b96d68ec8b83107068183d7f3cb2dfd8f80ff28ae1c806997859a8d49108d1
+SHA512:
+  metadata.gz: 2eb06c828bba7feb4a54fb00f9ee5c348efb23f176d2a8ab9dcb4634d260a6dfa3a8639a9dad699490d11c0656d6ab76ba1e285e81074c5d515047f0530a8bfe
+  data.tar.gz: d2a5beb9e3caca5870b8fc98c1111b38f5c660344d08a2d7980a3d78cb074bcb3875ffd6f533d689bda1f029b887e7e6cde240da8a68f6d68edce52fead80e27

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

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 aurangzaib.danial@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in animal_info.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    animal_info (0.1.0)
+      nokogiri (~> 1.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  animal_info!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aurangzaib
+
+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,43 @@
+# Animal-Info
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/animal_info`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'animal_info'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install animal_info
+
+## Usage
+
+In your terminal: animal-info lion
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/aurangzaib-danial/animal_info. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AnimalInfo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aurangzaib-danial/animal_info/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/animal_info.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "animal_info/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "animal_info"
+  spec.version       = AnimalInfo::VERSION
+  spec.authors       = ["Aurangzaib"]
+  spec.email         = ["aurangzaib.danial@gmail.com"]
+
+  spec.summary       = "command line tool for finding info about an animal by scraping wikipedia"
+  spec.description   = "find animal info"
+  spec.homepage      = "https://github.com/aurangzaib-danial/animal_info"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aurangzaib-danial/animal_info"
+  spec.metadata["changelog_uri"] = "https://github.com/aurangzaib-danial/animal_info"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ['animal-info']
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "nokogiri", "~> 1.10.0"
+end

data/bin/animal-info

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "animal_info"
+
+if ARGV.first
+  AnimalInfo::Controller.new(ARGV.first)
+else
+  puts "Provide an animal name! like this --> animal-info lion"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "animal_info"
+
+# 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/animal.rb

@@ -0,0 +1,17 @@
+class AnimalInfo::Animal
+  attr_accessor :name, :kingdom, :phylum, :klass, :order, :url
+
+  def self.new_from_wikipedia(name)
+    properties = AnimalInfo::Scraper.scrape_from_wikipedia(normalize_name(name))
+
+    new.tap do |animal|
+      properties.each do |property,value|
+        animal.send("#{property}=", value)
+      end
+    end
+  end
+
+  def self.normalize_name(name)
+    name.gsub(" ", "_").downcase
+  end
+end

data/lib/animal_info.rb

@@ -0,0 +1,11 @@
+require "animal_info/version"
+
+module AnimalInfo
+  class Error < StandardError; end
+
+end
+require 'nokogiri'
+require 'open-uri'
+require_relative 'animal.rb'
+require_relative 'scraper.rb'
+require_relative 'controller.rb'

data/lib/animal_info/version.rb

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

data/lib/controller.rb

@@ -0,0 +1,28 @@
+class AnimalInfo::Controller
+  attr_reader :animal_name
+
+  def initialize(animal_name)
+    @animal_name = animal_name
+    display_information
+  end
+
+  def display_information
+    puts "Please wait while we fetch info for you!"
+    begin
+      animal = AnimalInfo::Animal.new_from_wikipedia(@animal_name)
+      if animal.kingdom || animal.phylum || animal.klass || animal.order
+        puts
+        puts "Name: #{animal.name}"
+        puts "Kingdom: #{animal.kingdom}"
+        puts "Phylum: #{animal.phylum}"
+        puts "Class: #{animal.klass}"
+        puts "Order: #{animal.order}"
+        puts "Source: #{animal.url}"
+      else
+        puts "Not Found!"
+      end
+    rescue
+      puts "Not Found 404!"
+    end
+  end
+end

data/lib/scraper.rb

@@ -0,0 +1,34 @@
+class AnimalInfo::Scraper
+  def self.scrape_from_wikipedia(name)
+    html = get_html(name)
+    animal_name = html.search("h1#firstHeading").text
+    properties = { name: animal_name }
+    categories = ["Kingdom", "Phylum", "Class", "Order"]
+
+    html.search("table.infobox.biota tr").each do |table_row|
+      table_data = table_row.search("td")
+      if table_data.size == 2
+        category = table_data.first.text.strip.gsub(":", "")
+
+        if categories.include?(category)
+          if !table_data.last.search("b").empty?
+            category_info = table_data.last.search("b").text.strip
+          else
+            category_info = table_data.last.text.strip
+          end
+
+          category = "Klass" if category == "Class"
+
+          properties[category.downcase.to_sym] = category_info
+        end
+      end
+    end
+    properties[:url] = "https://en.wikipedia.org/wiki/#{name}"
+    properties
+  end
+
+  def self.get_html(name)
+    url = "https://en.wikipedia.org/wiki/#{name}"
+    Nokogiri::HTML(open(url))
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: animal_info
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aurangzaib
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: find animal info
+email:
+- aurangzaib.danial@gmail.com
+executables:
+- animal-info
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- animal_info.gemspec
+- bin/animal-info
+- bin/console
+- bin/setup
+- lib/animal.rb
+- lib/animal_info.rb
+- lib/animal_info/version.rb
+- lib/controller.rb
+- lib/scraper.rb
+homepage: https://github.com/aurangzaib-danial/animal_info
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aurangzaib-danial/animal_info
+  source_code_uri: https://github.com/aurangzaib-danial/animal_info
+  changelog_uri: https://github.com/aurangzaib-danial/animal_info
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: command line tool for finding info about an animal by scraping wikipedia
+test_files: []