marvel_101 0.1.0

data/lib/marvel_101/character.rb

@@ -0,0 +1,36 @@
+require_relative 'topic'
+
+class Marvel101::Character < Marvel101::Topic
+
+  attr_accessor :list, :team, :details
+
+  DETAIL_ORDER = [:real_name, :height, :weight, :abilities, :powers,
+                  :group_affiliations, :first_appearance, :origin]
+
+  def display
+    display_description
+    display_details
+    display_links
+    display_empty_message if no_info?
+  end
+
+  def display_details
+    DETAIL_ORDER.each do |type|
+      title = type.to_s.split("_").join(" ").upcase
+      puts "#{title}: #{details[type]}" if details.include?(type)
+    end
+  end
+
+  def display_empty_message
+    puts "Sorry, Marvel doesn't seem to care about #{name}"
+    puts "Type 'source' to open source in browser, but don't get your hopes up"
+  end
+
+  def no_info?
+    !description && details.empty? && urls.size <= 1
+  end
+
+  def valid_input?(input)
+    false
+  end
+end

data/lib/marvel_101/cli.rb

@@ -0,0 +1,85 @@
+class Marvel101::CLI
+
+  SOURCE = "http://marvel.com/characters/"
+
+  STARTING_PAGES = [
+    ["Popular Teams", "list/997/titanic_teams"],
+    ["Popular Heroes", "list/994/top_marvel_heroes"],
+    ["Popular Villains", "list/995/bring_on_the_bad_guys"],
+    ["Featured Characters", "browse"],
+    ["The Women of Marvel", "list/996/women_of_marvel"]
+  ]
+
+  def call
+    puts "\nWelcome to Marvel 101!"
+    main_menu
+  end
+
+  def main_menu
+    display_main
+    input = gets.chomp.downcase
+    if input.to_i.between?(1, STARTING_PAGES.size)
+      name, url = STARTING_PAGES[input.to_i - 1]
+      topic_menu(Marvel101::List.find_or_create_by_name(name, SOURCE + url))
+    elsif input == "exit" || input == "e"
+      exit_message
+    else
+      error("main")
+    end
+  end
+
+  def topic_menu(topic)
+    topic.get_info unless topic.scraped
+    display_topic(topic)
+    input = gets.chomp.downcase
+    case input
+    when "101","wiki" then open_link("url_#{input}".to_sym, topic)
+    when "source" then open_link(:url, topic)
+    when "e","exit" then exit_message
+    when "m","main" then main_menu
+    when "l","list" then topic.list? ? error(topic) : topic_menu(topic.list)
+    when "t","team" then topic.has_team? ? topic_menu(topic.team) : error(topic)
+    else
+      output = topic.valid_input?(input.to_i)
+      output ? topic_menu(output) : error(topic)
+    end
+  end
+
+  def display_main
+    puts "\n" + "-" * 80
+    puts "Here are your primary options:"
+    STARTING_PAGES.each.with_index(1) {|page, idx| puts "#{idx}. #{page[0]}!"}
+    puts "-" * 80
+    puts "You can also enter (E)xit to... exit"
+    puts "Select a number from the options above and we'll get started!"
+  end
+
+  def display_topic(topic)
+    break_len = (80 - topic.name.size) / 2
+    puts "\n" + "-" * break_len + "#{topic.name}" + "-" * break_len
+    topic.display
+    puts "-" * (break_len * 2 + topic.name.size)
+    options_message(topic)
+  end
+
+  def open_link(url, topic)
+    Launchy.open(topic.urls[url]) if topic.urls.include?(url)
+    topic_menu(topic)
+  end
+
+  def exit_message
+    puts "\nOh ok, well have a super day!"
+  end
+
+  def options_message(topic)
+    puts "Enter an option number for more info!" if topic.takes_input?
+    puts "You can enter (M)ain to go back to the main menu or (E)xit to... exit"
+    puts "Type (L)ist to return to #{topic.list.name} menu" if !topic.list?
+    puts "Type (T)eam to return to #{topic.team.name} menu" if topic.has_team?
+  end
+
+  def error(subject)
+    puts "\nSorry, that wasn't a valid option. Let's try again."
+    subject == "main" ? main_menu : topic_menu(subject)
+  end
+end

data/lib/marvel_101/list.rb

@@ -0,0 +1,14 @@
+require_relative 'topic'
+
+class Marvel101::List < Marvel101::Topic
+
+  attr_accessor :items
+
+  def display
+    items.each.with_index(1) {|item, idx| puts "#{idx}. #{item.name}"}
+  end
+
+  def valid_input?(input)
+    items[input - 1] if input.between?(1, items.size)
+  end
+end

data/lib/marvel_101/scraper.rb

@@ -0,0 +1,88 @@
+class Marvel101::Scraper
+
+  attr_accessor :topic, :doc
+
+  def initialize(topic)
+    @topic = topic
+    @url = topic.urls[:url]
+  end
+
+  def scrape_list
+    get_doc
+    get_items(get_item_cards)
+  end
+
+  def scrape_topic
+    get_doc
+    get_description
+    topic.team? ? get_members : get_details
+    get_101
+    get_wiki
+  end
+
+  def get_doc
+    @doc = Nokogiri::HTML(open(@url))
+  end
+
+  def get_item_cards
+    item_cards = doc.css("div#comicsListing div.row-item")
+    item_cards.empty? ? doc.css("#featured-chars div.row-item") : item_cards
+  end
+
+  def get_items(item_cards)
+    topic.items = item_cards.css("div.row-item-text > h5 > a").collect do |link|
+      name, url = link.text.strip, "http:#{link.attr("href")}"
+      if @url.downcase.include?("team")
+        Marvel101::Team.find_or_create_by_name("The #{name}", url).tap do |team|
+          team.list = topic
+        end
+      else
+        Marvel101::Character.find_or_create_by_name(name, url).tap do |char|
+          char.list = topic
+        end
+      end
+    end
+  end
+
+  def get_description
+    info = doc.css("div.featured-item-desc p:nth-child(2)").text
+    unless info.strip.empty?
+      topic.description = info.gsub(/\r?\n\s*([ml][oe][rs][es])?/," ").strip
+    end
+  end
+
+  def get_members
+    members_grid = doc.css("div.grid-container").first
+    topic.members = members_grid.css("div.row-item").collect do |card|
+      name = card.css("a.meta-title").text.strip
+      url = "http:#{card.css("a.meta-title").attr("href").value}"
+      Marvel101::Character.find_or_create_by_name(name, url).tap do |member|
+        member.list, member.team = topic.list, topic
+      end
+    end
+  end
+
+  def get_details
+    topic.details = {}
+    raw_details = doc.css("div.featured-item-meta")
+    raw_details.css("div div").each do |raw_detail|
+      detail = raw_detail.css("strong").text.downcase.strip.split(" ").join("_")
+      info = raw_detail.css("p:last-child span").text.strip
+      info = raw_detail.css("p:last-child").text if info.empty?
+      topic.details[detail.to_sym] = info
+    end
+  end
+
+  def get_101
+    url_101_text = doc.css("div#MarvelVideo101 script").text
+    unless url_101_text.empty?
+      id = url_101_text.match(/videoId: .([-\w]*)./)[1]
+      topic.urls[:url_101] = "https://www.youtube.com/watch?v=#{id}"
+    end
+  end
+
+  def get_wiki
+    wiki_link = doc.css("div.title-section a.featured-item-notice.primary")
+    topic.urls[:url_wiki] = wiki_link.attr("href").value unless wiki_link.empty?
+  end
+end

data/lib/marvel_101/team.rb

@@ -0,0 +1,21 @@
+require_relative 'topic'
+
+class Marvel101::Team < Marvel101::Topic
+
+  attr_accessor :list, :members
+
+  def display
+    display_description
+    display_members
+    display_links
+  end
+
+  def display_members
+    puts "CORE MEMBERS:" unless members.empty?
+    members.each.with_index(1) {|member, idx| puts "    #{idx}. #{member.name}"}
+  end
+
+  def valid_input?(input)
+    members[input - 1] if input.between?(1, members.size)
+  end
+end

data/lib/marvel_101/topic.rb

@@ -0,0 +1,60 @@
+class Marvel101::Topic
+
+  attr_accessor :name, :description, :urls, :scraped
+
+  @@all = []
+
+  def initialize(name, url)
+    @name = name
+    @urls = {url: url}
+    @scraped = false
+    @@all << self
+  end
+
+  def get_info
+    scraper = Marvel101::Scraper.new(self)
+    self.list? ? scraper.scrape_list : scraper.scrape_topic
+    @scraped = true
+  end
+
+  def display_description
+    puts "DESCRIPTION: #{description}" if description
+  end
+
+  def display_links
+    puts "" if urls.size > 1
+    ["wiki", "101"].each do |url|
+      output = "Marvel #{url} page available! Type '#{url}' to open in browser"
+      puts output if urls.include?("url_#{url}".to_sym)
+    end
+  end
+
+  def takes_input?
+    list? || (team? && !members.empty?)
+  end
+
+  def has_team?
+    char? && team
+  end
+
+  def list?
+    self.is_a?(Marvel101::List)
+  end
+
+  def team?
+    self.is_a?(Marvel101::Team)
+  end
+
+  def char?
+    self.is_a?(Marvel101::Character)
+  end
+
+  def self.find_or_create_by_name(name, url)
+    search = @@all.detect {|topic| topic.name == name}
+    search ? search : self.new(name, url)
+  end
+
+  def self.all
+    @@all
+  end
+end

data/lib/marvel_101/version.rb

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

data/lib/marvel_101.rb

@@ -0,0 +1,11 @@
+require "marvel_101/version"
+require "marvel_101/cli"
+require "marvel_101/team"
+require "marvel_101/list"
+require "marvel_101/character"
+require "marvel_101/scraper"
+require "marvel_101/topic"
+require "nokogiri"
+require "open-uri"
+require "pry"
+require "launchy"

data/marvel_101.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "marvel_101/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "marvel_101"
+  spec.version       = Marvel101::VERSION
+  spec.authors       = ["Tyler Buchheim"]
+  spec.email         = ["tbuchhei@alumni.nd.edu"]
+
+  spec.summary       = "Marvel.com scraper CLI"
+  spec.description   = "A CLI that scrapes marvel.com for info on popular Marvel characters and teams."
+  spec.homepage      = "https://github.com/buchheimt/marvel_101"
+  spec.license       = "MIT"
+  spec.executables  << "marvel_101"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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,11 @@
+Specifications for the CLI Assessment
+
+Specs:
+
+ [X] Have a CLI for interfacing with the application
+ - CLI class takes care of all user interfacing
+ [X] Pull data from an external source
+ - Program scrapes multiple pages of Marvel.com
+ [X] Implement both list and detail views
+ - Lists are a list or teams and characters, teams are both
+ a detail view and another list, and characters are detail views

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: marvel_101
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Buchheim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-11 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: 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: A CLI that scrapes marvel.com for info on popular Marvel characters and
+  teams.
+email:
+- tbuchhei@alumni.nd.edu
+executables:
+- console
+- marvel_101
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/marvel_101
+- bin/setup
+- fixtures/avengers.html
+- fixtures/defenders.html
+- fixtures/featured.html
+- fixtures/gambit.html
+- fixtures/heroes.html
+- fixtures/inhumans.html
+- fixtures/nova.html
+- fixtures/teams.html
+- fixtures/thor.html
+- lib/marvel_101.rb
+- lib/marvel_101/character.rb
+- lib/marvel_101/cli.rb
+- lib/marvel_101/list.rb
+- lib/marvel_101/scraper.rb
+- lib/marvel_101/team.rb
+- lib/marvel_101/topic.rb
+- lib/marvel_101/version.rb
+- marvel_101.gemspec
+- spec.md
+homepage: https://github.com/buchheimt/marvel_101
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Marvel.com scraper CLI
+test_files: []