ow_heroes_roster 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f778b4d2ebe8fe0329bf9486d6bffd43445c9ae7
+  data.tar.gz: f60d87f3b5ae7ef7fc975cdb2cccc3b7c8192213
+SHA512:
+  metadata.gz: 117cf642338860a0fd36b954f364e335fe116ebf7cfb83cbab08c73b64215d1bd8b9d88cc39564c7a57d9e869b99785be9c5169db58bfc7b7084470acb9563f1
+  data.tar.gz: 4498ac3d402c01b8e8e8b8304811940473a5d77f82d6bd89a5d0e5af84e74c3c86e8ba3b69e24cb79ea3292b50de156fa415c1ad90c0cde247908955f177272c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.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 jennimacklin@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 ow_heroes_roster.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jlmack13
+
+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,41 @@
+# OwHeroesRoster
+
+Welcome to the Overwatch Heroes Roster Gem! This gem will show you a list of all the current heroes available in the video game Overwatch. You can also see more detailed information about each individual hero if you wish.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ow_heroes_roster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ow_heroes_roster
+
+## Usage
+
+When you run the program you will see a list of instructions and the current roster of heroes. To view more information about a hero, type their name when prompted (alternatively, you can also type 'roster' to see the list again, or 'exit' if you are done with the program).
+
+## 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/jlmack13/ow_heroes_roster. 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 OwHeroesRoster project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jlmack13/ow_heroes_roster/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ow_heroes_roster"
+
+# 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/ow-heroes-roster

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "./lib/ow_heroes_roster"
+
+OwHeroesRoster::CLI.new.call

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/ow_heroes_roster.rb

@@ -0,0 +1,4 @@
+require_relative "ow_heroes_roster/version"
+require_relative "ow_heroes_roster/roster.rb"
+require_relative "ow_heroes_roster/hero.rb"
+require_relative "./ow_heroes_roster/cli"

data/lib/ow_heroes_roster/cli.rb

@@ -0,0 +1,54 @@
+require 'colorize'
+
+class OwHeroesRoster::CLI
+
+  def call
+    puts "\nWELCOME TO THE OVERWATCH HEROES ROSTER GEM!".colorize(:green)
+    puts "\n----***------ INSTRUCTIONS ------***----".colorize(:white)
+    puts "\n1. Enter a hero's name to see their details.".colorize(:white)
+    puts "2. To see the roster again, type 'roster'.".colorize(:white)
+    puts "3. To exit the program, type 'exit'.".colorize(:white)
+    puts "\n----------------------------------------".colorize(:white)
+    Roster.scrape_roster_page
+    list_heroes
+    menu
+  end
+
+  #print the list of heroes scraped from the site
+  def list_heroes
+    puts "\n---***------  HEROES ------***---".colorize(:yellow)
+    @heroes = Hero.all
+    Hero.all.each do |hero|
+      print " --- ".colorize(:magenta)
+      puts "#{hero.name}".colorize(:white)
+    end
+    menu
+  end
+
+  #ask user if they'd like to select a hero (by name or number?) for more details, reprint the list, or exit the program
+  def menu
+    print "\nWhat would you like to do? ".colorize(:green)
+    input = gets.strip.upcase
+    if input == 'ROSTER'
+      list_heroes
+    elsif input == 'EXIT'
+      exit
+    else
+      display_hero(input)
+    end
+  end
+
+  #display the details of the requested hero. do I want this here?
+  def display_hero(input)
+    #use a find by name method to get the right hero and then display the information
+    if Hero.find_by_name(input)
+      hero = Hero.find_by_name(input)
+      hero.display_information
+      menu
+    else
+      puts "\nSorry could not find a hero by that name. Please try again.".colorize(:green)
+      menu
+    end
+  end
+
+end

data/lib/ow_heroes_roster/hero.rb

@@ -0,0 +1,85 @@
+require 'open-uri'
+require 'nokogiri'
+require 'pry'
+require 'colorize'
+
+class Hero
+  attr_accessor :name, :role, :url, :path, :overview, :abilities, :biography, :quote
+
+  @@all = []
+
+  def initialize(name, path)
+    @name = name
+    @url = "https://playoverwatch.com#{path}"
+    @@all << self
+  end
+
+  def self.find_by_name(name)
+    self.all.find{|hero| hero.name == name}
+  end
+
+  #get details by scraping hero page
+  def get_details(index_url)
+    html = open(index_url)
+    doc = Nokogiri::HTML(html)
+
+    #role
+    @role = doc.css(".hero-detail-role-name").text
+
+    #overview
+    @overview = doc.css("#overview .hero-detail-description").text
+
+    #abilities
+    @abilities = []
+    doc.css(".hero-ability").each do |ability|
+      hero_ability = ability.css(".hero-ability-descriptor .h5").text
+      hero_description = ability.css(".hero-ability-descriptor p").text
+      @abilities << {ability: hero_ability, description: hero_description}
+    end
+
+    #biography
+    @biography = {}
+    doc.css("#story .hero-bio").each do |info|
+      hero_real_name = info.css(".name .hero-bio-copy").text
+      hero_occupation = info.css(".occupation .hero-bio-copy").text
+      hero_base = info.css(".base .hero-bio-copy").text
+      hero_affiliation = info.css(".affiliation").text
+      @biography = {real_name: hero_real_name, occupation: hero_occupation, base: hero_base, affiliation: hero_affiliation}
+    end
+
+    #quote
+    @quote = doc.css("#story p.h4").text
+  end
+
+  #display hero details
+  def display_information
+    get_details(url)
+    puts "\n--------------------------------".colorize(:yellow)
+    print "\n**".colorize(:magenta)
+    print " #{self.name.upcase}".colorize(:white)
+    puts  " **".colorize(:magenta)
+    puts "\n--------------------------------".colorize(:yellow)
+    puts "\nROLE: #{self.role}".colorize(:yellow)
+    puts "--------------------------------".colorize(:magenta)
+    puts "OVERVIEW:".colorize(:yellow)
+    puts "#{self.overview}".colorize(:white)
+    puts "--------------------------------".colorize(:magenta)
+    puts "ABILITIES:\n".colorize(:yellow)
+    self.abilities.each do |ability|
+      puts "*#{ability[:ability]}: #{ability[:description]}".colorize(:white)
+    end
+    puts "--------------------------------".colorize(:magenta)
+    puts "BIOGRAPHY:\n".colorize(:yellow)
+    self.biography.each_value {|value| puts "\t*#{value}".colorize(:white) }
+    puts "\n--------------------------------".colorize(:magenta)
+    if self.quote != ""
+      puts "QUOTE: #{self.quote}".colorize(:yellow)
+      puts "--------------------------------".colorize(:magenta)
+    end
+  end
+
+  def self.all
+    @@all
+  end
+
+end

data/lib/ow_heroes_roster/roster.rb

@@ -0,0 +1,29 @@
+require 'open-uri'
+require 'nokogiri'
+require 'pry'
+require_relative './hero.rb'
+
+class Roster
+
+  def self.scrape_roster_page
+    html = open("https://playoverwatch.com/en-us/heroes/")
+    heroes = []
+    doc = Nokogiri::HTML(html)
+    doc.css(".hero-portrait-detailed-container").each do |card|
+      hero_name = card.css(".container .portrait-title").text
+      if hero_name.include?("ú")
+        hero_name = hero_name.gsub(/ú/, 'u')
+      elsif hero_name.include?("ö")
+        hero_name = hero_name.gsub(/ö/, 'o')
+      end
+      hero_url = card.css("a").attr("href").value
+      heroes << {name: hero_name.upcase, url: hero_url}
+    end
+    heroes.each do |hero|
+      hero = Hero.new(hero[:name], hero[:url])
+    end
+
+  end
+
+
+end

data/lib/ow_heroes_roster/version.rb

@@ -0,0 +1,3 @@
+module OwHeroesRoster
+  VERSION = "0.1.2"
+end

data/ow_heroes_roster.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ow_heroes_roster/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ow_heroes_roster"
+  spec.version       = OwHeroesRoster::VERSION
+  spec.authors       = ["jlmack13"]
+  spec.email         = ["jennimacklin@hotmail.com"]
+
+  spec.summary       = %q{Roster of all the heroes in Overwatch.}
+  spec.description   = %q{This gem scrapes the Overwatch website and provides a roster of all current heroes and their details.}
+  spec.homepage      = "https://github.com/jlmack13/jennifer-macklin-cli-app"
+  spec.license       = "MIT"
+
+  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_dependency "colorize"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application : I created a CLI that shows the user a roster of heroes and allows them to either see more information about a specific hero, see the list again, or exit the program.
+- [x] Pull data from an external source : I've pulled data from both the page that has the main list of heroes on the Overwatch site, and data from the individual hero pages that provides detailed information about each of the heroes (different pages for each hero).
+- [x] Implement both list and detail views : My program starts by pulling a list of current heroes from the Overwatch website and displaying it to the user. It also shows the user detail views for each of the heroes, which was also scraped from the Overwatch site. 

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: ow_heroes_roster
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- jlmack13
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-28 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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: 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'
+description: This gem scrapes the Overwatch website and provides a roster of all current
+  heroes and their details.
+email:
+- jennimacklin@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/ow-heroes-roster
+- bin/setup
+- lib/.DS_Store
+- lib/ow_heroes_roster.rb
+- lib/ow_heroes_roster/.DS_Store
+- lib/ow_heroes_roster/cli.rb
+- lib/ow_heroes_roster/hero.rb
+- lib/ow_heroes_roster/roster.rb
+- lib/ow_heroes_roster/version.rb
+- ow_heroes_roster-0.1.0.gem
+- ow_heroes_roster.gemspec
+- spec.md
+homepage: https://github.com/jlmack13/jennifer-macklin-cli-app
+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.12
+signing_key: 
+specification_version: 4
+summary: Roster of all the heroes in Overwatch.
+test_files: []