trending_entertainment_cli_app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53c4f881efcaae0cc9aa2ebc65f60284edca9862
+  data.tar.gz: 86f3a22ab3d5440d793e6b203931b32414488790
+SHA512:
+  metadata.gz: 661c3f8dcf8ef52217a1c1e9c8305e1349121f3e525aeb11dc46113d84deafa4acaff9df8d624a8fa2d9d0afd60d6ddc70e97b2badcbac9f4d98f94142b99e85
+  data.tar.gz: 831fa8d0b30282165895a928d84a0cd94514c5b1b162811d80e08fb8b9cacb03dd78d579d77b39973885052834a762f20a7fea85c489cf2698cb657ffd887313

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.13.6

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 krishel.lasam@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'
+
+# Specify your gem's dependencies in trending_entertainment_cli_app.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: krishl
+
+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,40 @@
+# Trending Entertainment CLI App
+
+This is a Ruby gem that lists out all currently trending shows and movies with their respective details based on real-time check-in data from Trakt.tv.
+
+A show/movie is considered "Trending" based on the total amount of people who are currently "checked in" on the show/movie's page. The "checked in" status remains for the entire length of the total runtime for the show/movie.
+
+A show/movie is considered "Most Anticipated" based on the total amount of people who have added that particular show/movie onto their "watchlist".
+
+The detail views of each show/movie include publicly available data such as title, content rating, release year, description, genre, runtime, country, and language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trending_entertainment_cli_app'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trending_entertainment_cli_app
+
+## 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/krishl/trending_entertainment_cli_app. 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).

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 "trending_entertainment_cli_app"
+
+# 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

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/trending-ent

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "./lib/trending_entertainment_cli_app"
+
+TrendingEntertainmentCliApp::CLI.new.main_menu

data/lib/trending_entertainment_cli_app.rb

@@ -0,0 +1,7 @@
+require "nokogiri"
+require "open-uri"
+
+require_relative "./trending_entertainment_cli_app/version"
+require_relative "./trending_entertainment_cli_app/cli"
+require_relative "./trending_entertainment_cli_app/index_scraper"
+require_relative "./trending_entertainment_cli_app/details_scraper"

data/lib/trending_entertainment_cli_app/CLI.rb

@@ -0,0 +1,133 @@
+class TrendingEntertainmentCliApp::CLI
+  def main_menu
+    answer = nil
+    while answer != "exit"
+      puts "Welcome! What would you like to explore, TV Shows or Movies? Type 'exit' to exit."
+      answer = gets.chomp.downcase
+      case answer
+      when "tv shows", "tv", "shows", "tvshows", "tvshow", "show"
+        shows
+      when "movies", "movie"
+        movies
+      when "exit"
+        farewell
+      else
+        puts "Please enter a valid input!"
+      end
+    end
+  end
+
+  def shows
+    answer = nil
+    while answer != ("back" || "exit")
+      puts "Would you like to (1) view currently trending TV Shows or (2) view a list of the most anticipated upcoming shows?"
+      puts "Make your selection by typing either '1' or '2'. Alternatively, type 'back' to go back to the main menu or 'exit' to exit."
+      answer = gets.chomp
+      case answer
+      when "1"
+        puts "--- TRENDING TV SHOWS ---"
+        TrendingEntertainmentCliApp::IndexScraper.all_clear
+        TrendingEntertainmentCliApp::IndexScraper.scrape_index("https://trakt.tv/shows/trending")
+        TrendingEntertainmentCliApp::IndexScraper.all.each.with_index(1) do |element, index|
+          puts "#{index}. #{element.name} (#{element.year})"
+        end
+        puts "Type the number of the show for more details. Alternatively, type 'back' to go back to the main menu or 'exit' to exit."
+        number = gets.chomp
+        if number.to_i.between?(1, 37)
+          TrendingEntertainmentCliApp::IndexScraper.scrape_url("https://trakt.tv/shows/trending", number)
+        elsif number == "back"
+          main_menu
+        elsif number == "exit"
+          farewell
+        else
+          puts "Please enter a valid number!"
+          shows
+        end
+      when "2"
+        puts "--- MOST ANTICIPATED TV SHOWS ---"
+        TrendingEntertainmentCliApp::IndexScraper.all_clear
+        TrendingEntertainmentCliApp::IndexScraper.scrape_index("https://trakt.tv/shows/anticipated")
+        TrendingEntertainmentCliApp::IndexScraper.all.each.with_index(1) do |element, index|
+          puts "#{index}. #{element.name} (#{element.year})"
+        end
+        puts "Type the number of the show for more details. Alternatively, type 'back' to go back to the main menu or 'exit' to exit."
+        number = gets.chomp
+        if number.to_i.between?(1, 37)
+          TrendingEntertainmentCliApp::IndexScraper.scrape_url("https://trakt.tv/shows/anticipated", number)
+        elsif number == "back"
+          main_menu
+        elsif number == "exit"
+          farewell
+        else
+          puts "Please enter a valid number!"
+          shows
+        end
+      when "back"
+        main_menu
+      when "exit"
+        farewell
+      else
+        puts "Please enter a valid input!"
+      end
+    end
+  end
+
+  def movies
+    answer = nil
+    while answer != ("back" || "exit")
+      puts "Would you like to (1) view currently trending movies or (2) view a list of the most anticipated upcoming movies?"
+      puts "Make your selection by typing either '1' or '2'. Alternatively, type 'back' to go back to the main menu or 'exit' to exit."
+      answer = gets.chomp
+      case answer
+      when "1"
+        puts "--- TRENDING MOVIES ---"
+        TrendingEntertainmentCliApp::IndexScraper.all_clear
+        TrendingEntertainmentCliApp::IndexScraper.scrape_index("https://trakt.tv/movies/trending")
+        TrendingEntertainmentCliApp::IndexScraper.all.each.with_index(1) do |element, index|
+          puts "#{index}. #{element.name} (#{element.year})"
+        end
+        puts "Type the number of the movie for more details. Alternatively, type 'back' to go back to the main menu or 'exit' to exit."
+        number = gets.chomp
+        if number.to_i.between?(1, 37)
+          TrendingEntertainmentCliApp::IndexScraper.scrape_url("https://trakt.tv/movies/trending", number)
+        elsif number == "back"
+          main_menu
+        elsif number == "exit"
+          farewell
+        else
+          puts "Please enter a valid number!"
+          movies
+        end
+      when "2"
+        puts "--- MOST ANTICIPATED MOVIES ---"
+        TrendingEntertainmentCliApp::IndexScraper.all_clear
+        TrendingEntertainmentCliApp::IndexScraper.scrape_index("https://trakt.tv/movies/anticipated")
+        TrendingEntertainmentCliApp::IndexScraper.all.each.with_index(1) do |element, index|
+          puts "#{index}. #{element.name} (#{element.year})"
+        end
+        puts "Type the number of the show for more details. Alternatively, type 'back' to go back to the main menu or 'exit' to exit."
+        number = gets.chomp
+        if number.to_i.between?(1, 37)
+          TrendingEntertainmentCliApp::IndexScraper.scrape_url("https://trakt.tv/movies/anticipated", number)
+        elsif number == "back"
+          main_menu
+        elsif number == "exit"
+          farewell
+        else
+          puts "Please enter a valid number!"
+          movies
+        end
+      when "back"
+        main_menu
+      when "exit"
+        farewell
+      else
+        puts "Please enter a valid input!"
+      end
+    end
+  end
+
+  def farewell
+    abort("Have a great day!")
+  end
+end

data/lib/trending_entertainment_cli_app/details_scraper.rb

@@ -0,0 +1,33 @@
+class TrendingEntertainmentCliApp::DetailsScraper
+  attr_accessor :title, :year, :rating, :description, :category, :info
+
+  def self.scrape_details(url)
+    specific = self.new
+    details = Nokogiri::HTML(open(url))
+    specific.title = details.css("div.col-md-10.col-md-offset-2.col-sm-9.col-sm-offset-3.mobile-title h1").text.chomp.gsub(/(\d\d\d\d)/, "")
+    specific.year = details.css("div.col-md-10.col-md-offset-2.col-sm-9.col-sm-offset-3.mobile-title h1 span.year").text
+    specific.rating = details.css("div.col-md-10.col-md-offset-2.col-sm-9.col-sm-offset-3.mobile-title h1 div.certification").text
+    specific.description = details.css("div.col-lg-8.col-md-7 div#overview").text
+    specific.category = details.search("div.col-lg-8.col-md-7 li label").map{ |li| li.text}.drop(2)
+    details.search("label").remove
+    specific.info = details.css("div.col-lg-8.col-md-7 li").map{ |info| info.text}.drop(2)
+
+    puts ""
+    puts "--- TITLE ---"
+    puts "#{specific.title.gsub("#{specific.rating}", "")}"
+    puts ""
+    puts "--- YEAR ---"
+    puts "#{specific.year}"
+    puts ""
+    puts "--- CONTENT RATING ---"
+    puts "#{specific.rating}"
+    puts ""
+    puts "--- DESCRIPTION ---"
+    puts "#{specific.description}"
+    puts ""
+    puts "--- ADDITIONAL INFO ---"
+    combined = specific.category.zip(specific.info).flatten.compact
+    combined.each_slice(2).map { |each| puts "#{each.first} - #{each.last}"}
+    puts ""
+  end
+end

data/lib/trending_entertainment_cli_app/index_scraper.rb

@@ -0,0 +1,35 @@
+class TrendingEntertainmentCliApp::IndexScraper
+  attr_accessor :name, :year
+  @@all = []
+
+  def initialize(name = nil, year = nil)
+    @name = name
+    @year = year
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.all_clear
+    @@all.clear
+  end
+
+  def self.scrape_index(url)
+    puts = ""
+    index = Nokogiri::HTML(open(url))
+    index.css("div.titles h3").each do |element|
+      individual = self.new
+      individual.name = element.text.chomp.gsub(/\s\d\d\d\d$/, "")
+      individual.year = element.text.chomp.gsub("#{individual.name} ", "").gsub("#{individual.name}", "")
+    end
+  end
+
+  def self.scrape_url(path, number)
+    index = Nokogiri::HTML(open(path))
+    count = number.to_i - 1
+    url = index.search("div.grid-item.col-sm-6 meta[itemprop='url']")[count]["content"]
+    TrendingEntertainmentCliApp::DetailsScraper.scrape_details(url)
+  end
+end

data/lib/trending_entertainment_cli_app/version.rb

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

data/spec.md

@@ -0,0 +1,15 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+- [x] Pull data from an external source
+  I pulled data from Trakt.tv, a website that lets users track the movies and
+  shows that they are currently watching or have already seen. I pulled data from
+  a total of four different categories: Trending Shows, Most Anticipated Upcoming Shows, Trending Movies, and Most Anticipated Upcoming Movies. From these four
+  categories, I then pulled the details of each show/movie from their individual
+  pages. Since this is based on real-time data and the data is always changing, I identified how the URLs for each page are set up to get past this obstacle.
+- [x] Implement both list and detail views
+  There are a total of four lists in this project: Trending Shows, Most Anticipated Upcoming Shows, Trending Movies, and Most Anticipated Upcoming Movies.
+  The detail views include data such as title, release year, description, genre,
+  runtime, country, and language. Not all data categories are available for every
+  detail page if they are currently unknown. For example, a detail page for an upcoming movie would not be likely to have a runtime length or genre available yet. This program was written to adjust these discrepancies by first listing out the most commonly available detail categories, before the variable details.

data/trending_entertainment_cli_app.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trending_entertainment_cli_app/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trending_entertainment_cli_app"
+  spec.version       = TrendingEntertainmentCliApp::VERSION
+  spec.authors       = ["Krishel Lasam"]
+  spec.email         = ["krishel.lasam@gmail.com"]
+
+  spec.summary       = "Lists all currently trending shows and movies with their respective details based on real-time check-in data from Trakt.tv"
+  spec.homepage      = "https://github.com/krishl/trending-entertainment-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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: trending_entertainment_cli_app
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krishel Lasam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 
+email:
+- krishel.lasam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/trending-ent
+- lib/trending_entertainment_cli_app.rb
+- lib/trending_entertainment_cli_app/CLI.rb
+- lib/trending_entertainment_cli_app/details_scraper.rb
+- lib/trending_entertainment_cli_app/index_scraper.rb
+- lib/trending_entertainment_cli_app/version.rb
+- spec.md
+- trending_entertainment_cli_app.gemspec
+homepage: https://github.com/krishl/trending-entertainment-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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Lists all currently trending shows and movies with their respective details
+  based on real-time check-in data from Trakt.tv
+test_files: []