top_box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e0b9977e7c77bbd11f9ce4bed2f90474d09e31bd3767297927af68586d007ba
+  data.tar.gz: 4deae212e5f3e2a03b277863a87b16af453bf1c51299dbebd1fe5e7bca474fdf
+SHA512:
+  metadata.gz: f0620e27f45834e9747d2c0c5c5d4d7e5fd013dffb7dd9298d174e12726697a170bee79f3e2a6911cf271bf24e3eeb0be2458d46c5f5cba71db83a15add71ba2
+  data.tar.gz: f11f72527ab14ce493e4e8111a4737edd105ffdad31cc2b72cde747ed693388b1108f7301febf4cb513c4782f0e84ab23505d4fe82e589932e1435f4ab7af4e1

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_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 'jkam17@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/jk-me/top_box_cli" }
+
+# Specify your gem's dependencies in top_box.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Jenny Kam'
+
+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,30 @@
+# TopBox
+
+This is a Ruby CLI application that allows the user to view summaries and critic reviews of current top box office films. Data provided by imdb.com.
+
+
+##Requirements
+
+This app was built on ruby 2.3.3
+
+## Usage
+
+Initialize application with command below, then follow on screen prompts.
+
+    $ bin/top_box
+
+## Blog
+
+A blog post detailing notes on the creation of this app can be found here: http://jellyjen.com/top_box_cli
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/'jk-me'/top_box. 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 app is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TopBox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'jk-me'/top_box/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

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

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

data/lib/top_box/cli.rb

@@ -0,0 +1,71 @@
+class TopBox::CLI
+
+  def call
+    puts 'Current Top Box Office Movies by imdb.com'
+    TopBox::Movie.new_from_collection(Scraper.scrape_movie_list)
+    list_movies
+    menu
+  end
+
+  def list_movies
+    #parse array of movie objects to output list
+    TopBox::Movie.all.each do |m|
+      puts "#{m.num}. #{m.title}"
+      puts "Week #{m.weeks_in_theater}, Total gross: #{m.total_gross}"
+      puts '--------------'
+    end
+  end
+
+  def menu
+    #takes user input to provide more information
+    puts "Enter number of a movie from the list to view a plot summary, 'list' to see the list of movies again or 'exit' to quit"
+    x = gets.strip.downcase
+    num = x.to_i
+    if num > 0 and num < TopBox::Movie.all.length + 1
+      m = TopBox::Movie.all[num-1]
+      if !m.summary
+        m.get_movie_details
+      end
+
+      puts "---------"
+      puts "#{m.title}, #{m.runtime}"
+      puts "Metascore: #{m.metascore}/100"
+      puts "---------"
+      puts m.summary
+      puts "---------"
+      review_menu(m)
+    elsif x=='exit'
+      exit
+    elsif x=='list'
+      list_movies
+      menu
+    else
+      puts "invalid entry"
+      menu
+    end
+  end
+
+  def review_menu(m)
+    #asks if user would like to see reviews for specific movie
+    puts "Would you like to see some critic reviews from this movie? y/n"
+    x=gets.strip.downcase
+    if  x=='y'
+      m.get_reviews
+      puts "--------------"
+      m.reviews.each{ |review|
+        puts "Score: #{review.score}/100"
+        if review.author==''
+          puts "From: #{review.publication}"
+        else
+          puts "From: #{review.publication}, by #{review.author}"
+        end
+        puts review.summary
+        puts "--------------"
+      }
+      menu
+    else x=='n'
+      menu
+    end
+  end
+
+end

data/lib/top_box/movie.rb

@@ -0,0 +1,46 @@
+class TopBox::Movie
+  attr_accessor :title, :weeks_in_theater, :total_gross, :url, :summary, :metascore, :rating, :runtime, :review_url, :reviews
+  @@all=[]
+
+  def initialize(attribute_hash)
+    @title = attribute_hash[:title]
+    @weeks_in_theater = attribute_hash[:weeks_in_theater]
+    @total_gross = attribute_hash[:total_gross]
+    @url = attribute_hash[:url]
+    @reviews = []
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def num
+    @@all.index(self)+1
+  end
+
+  def self.new_from_collection(movies_attributes_array)
+    movies_attributes_array.each{ |x| TopBox::Movie.new(x) }
+  end
+
+  def get_movie_details
+    movie_page = Scraper.scrape_movie_page(@url) #'/title/tt3104988'
+
+    @summary = movie_page.css('.inline.canwrap span')[0].text.strip
+    @metascore = movie_page.css('.metacriticScore').text.strip
+    @rating = movie_page.css('.txt-block span')[0].text.capitalize
+    @runtime = movie_page.css('.txt-block time').text
+    @review_url = movie_page.css('.titleReviewBarSubItem a').attribute('href').value
+  end
+
+  def get_reviews
+    if @reviews == []
+      reviews_array = Scraper.scrape_review_page("#{@url}/#{@review_url}")
+      reviews_array.each do |x|
+        a = TopBox::Review.new(x)
+        @reviews << a
+      end
+    end
+  end
+
+end

data/lib/top_box/review.rb

@@ -0,0 +1,11 @@
+class TopBox::Review
+  attr_accessor :score, :publication, :author, :summary
+
+  def initialize(attribute_hash)
+    @score = attribute_hash[:score]
+    @publication = attribute_hash[:publication]
+    @summary = attribute_hash[:summary]
+    @author = attribute_hash[:author]
+  end
+
+end

data/lib/top_box/scraper.rb

@@ -0,0 +1,49 @@
+class Scraper
+  def self.scrape_movie_list
+    doc = Nokogiri::HTML(open('https://www.imdb.com/chart/boxoffice/'))
+    titles = doc.css('tr .titleColumn').collect{|x| x.text.strip}
+    urls = doc.css('tr .titleColumn a').collect{|x| x.attribute('href').value[0,16]} #/title/tt3104988
+    weeks_in_theater = doc.css('.weeksColumn').collect{|x| x.text}
+    total_gross = doc.css('.ratingColumn .secondaryInfo').collect{|x| x.text}
+
+    movies_attributes=[]
+    i=0
+    while i<titles.length
+      att_hash={}
+      att_hash[:url] = urls[i]
+      att_hash[:title] = titles[i]
+      att_hash[:weeks_in_theater] = weeks_in_theater[i]
+      att_hash[:total_gross] = total_gross[i]
+      movies_attributes << att_hash
+      i+=1
+    end
+    movies_attributes
+  end
+
+  def self.scrape_movie_page( url ) #'/title/tt3104988'
+    doc = Nokogiri::HTML(open('https://www.imdb.com' + url))
+  end
+
+  def self.scrape_review_page( url ) #'/title/tt3104988/criticreviews?ref_=tt_ov_rt'
+    doc = Nokogiri::HTML(open('https://www.imdb.com/' + url))
+    scores = doc.css('.critscore').collect{|y| y.text.strip}
+    publications = doc.css('.review b span').collect{|y| y.text}
+    authors = doc.css('.review span span').collect{|y| y.text}
+      #some_reviews may not have authors listed
+    summarys = doc.css('.review div').collect{|y| y.text.strip}
+
+    review_attributes=[]
+    i=0
+    while i < scores.length
+      att_hash={}
+      att_hash[:score] = scores[i]
+      att_hash[:publication] = publications[i]
+      att_hash[:author] = authors[i]
+      att_hash[:summary] = summarys[i]
+      review_attributes << att_hash
+      i+=1
+    end
+    review_attributes
+  end
+
+end

data/lib/top_box/version.rb

@@ -0,0 +1,4 @@
+module TopBox
+  VERSION = "0.1.0"
+
+end

data/lib/top_box_env.rb

@@ -0,0 +1,9 @@
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+require_relative "top_box/version"
+require_relative "top_box/cli"
+require_relative "top_box/scraper"
+require_relative "top_box/movie"
+require_relative "top_box/review"

data/top_box.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "top_box/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "top_box"
+  spec.version       = '0.1.0'
+  spec.authors       = ["'Jenny Kam'"]
+  spec.email         = ["'jkam17@gmail.com'"]
+
+  spec.summary       = %q{Top grossing movies currently in theaters. }
+  spec.description   = %q{Provides top box office movie summaries, and critic reviews from imdb.com}
+  spec.homepage      = "https://github.com/jk-me/top_box_cli"
+  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"] = 'http://mygemserver.com'
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: top_box
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Jenny Kam'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Provides top box office movie summaries, and critic reviews from imdb.com
+email:
+- "'jkam17@gmail.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/top_box
+- lib/top_box/cli.rb
+- lib/top_box/movie.rb
+- lib/top_box/review.rb
+- lib/top_box/scraper.rb
+- lib/top_box/version.rb
+- lib/top_box_env.rb
+- top_box.gemspec
+homepage: https://github.com/jk-me/top_box_cli
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Top grossing movies currently in theaters.
+test_files: []