Hot_100_CLI 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c14b2684f75020eae7794ca1a7aa2e9975e9a145
+  data.tar.gz: 03cb062f65d0cc6f14be368e4234bc421aad8ccc
+SHA512:
+  metadata.gz: aa2fa01b4fdb5b612d9b993a71b2468ae4e9c5fedafac34b1012cb29e699ef91e18a8a55fbafb10b6cb001614bf01fb70f3bc6379c168a5112d65d6c3461dd32
+  data.tar.gz: efce5efc716dcf9c97a742602b02ed876c1900c6b49bcf209421b28624a32fb99bc426064b007348a830b36353c2abc79b7bc248ceab1dae489190c46f4387e9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Hot_100_CLI.gemspec
+
+gem 'pry'
+gem 'nokogiri'
+gem 'require_all'
+gem 'launchy'
+gem 'rake'

data/Hot_100_CLI.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Hot_100_CLI/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Hot_100_CLI"
+  spec.version       = Hot100CLI::VERSION
+  spec.authors       = ["NStephenson"]
+  spec.email         = ["nickstephenson90@gmail.com"]
+
+  spec.summary       = %q{This gem allows users to view the Billboard Top 100 in the command line.}
+  spec.description   = %q{This gem scrapes the Billboard Top 100 webpage and displays that information in the command line.}
+  spec.homepage      = "https://github.com/NStephenson/Hot_100_CLI"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 NStephenson
+
+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/NOTES.md

@@ -0,0 +1,13 @@
+NOTES FOR HOT 100 CLI
+
+
+This CLI should do the following:
+
+1. Greet the user.
+2. Explain what the CLI does in a sentence or two
+3. Shows the user the top 10 songs for the week
+4. Ask the user if they would like to view the full billboard listing or any other group of ten songs
+5. Should be able to find all songs from a specified artist
+6. Should be able to find songs by name
+7. Asking for more info on a song should give some additional info (TBD)
+8. When user is done, "exit" should close the program and dgive a goodbye message.

data/README.md

@@ -0,0 +1,51 @@
+# Hot100CLI
+
+Welcome to your the Hot 100 CLI!. This gem scrapes the Billboard Top 100 page (http://www.billboard.com/charts/hot-100) and gives the full top 100 list, additiontional info on each song, and will allow the user to launch links to the song on spotify or vevo if available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Hot_100_CLI'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Hot_100_CLI
+
+## Usage
+
+Upon opening, Hot 100 CLI will display the top ten songs on the chart for the current week. After this, there are a variety of inputs you can give for more information about the list.
+
+"Hot 100" - Displays the full hot 100 listing
+
+"Artists" - Displays a list of all the artists on the list, alphabetized.
+
+"Song [song name]" - Displays information on the name of the song given. This will also give an option of playing the song or viewing the music video of the song.
+
+"Artist [artist name]" - Displays a list of all the songs by the given artist that appears on the Billboard Top 100.
+
+"Help" - Displays the list of available inputs.
+
+- Additionally, inputting a number between 1 and 100 will display more info on the song in that position. Giving a range of numbers between 1 and 100 separated with a hyphen will show all the entires on the list between those two numbers.
+
+## 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/nstephenson/Hot_100_CLI.
+
+
+## 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/HOT-100-CLI

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/Hot_100_CLI.rb'
+
+
+Hot100::CLI.new.call

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative '../lib/Hot_100_CLI.rb'
+# require "Hot_100_CLI"
+
+# 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/lib/Hot_100_CLI/artist.rb

@@ -0,0 +1,51 @@
+class Artist
+
+  attr_accessor :name, :songs
+
+  @@all = []
+
+  def initialize(name)
+    @name = name
+    @songs = []
+
+  end
+
+  def self.all
+    @@all
+  end
+
+  def save
+    @@all << self
+  end
+
+  def self.find_by_name(name)
+    all.detect { |artist| artist.name.downcase == name.downcase }
+  end
+
+ 
+  def self.create_by_list_name(list_name)
+    artists = []
+    list_name[:name].split(" Featuring ").map do |name|
+      if name.include?(" & ")
+        name.split(" & ").map do |name|
+          artists << Artist.find_or_new_by_name(name)
+        end
+      else
+        artists << Artist.find_or_new_by_name(name)
+      end
+    end
+    artists
+  end
+
+  def self.find_or_new_by_name(name)
+    if self.all.detect{ |song| song.name == name  }
+      artist = self.all.detect{ |song| song.name == name  }
+    else 
+      artist = Artist.new(name)
+      artist.save
+    end
+    artist
+  end
+
+
+end

data/lib/Hot_100_CLI/billboard_scraper.rb

@@ -0,0 +1,62 @@
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+class BillboardScraper
+
+
+  def initialize
+    doc = Nokogiri::HTML(open('http://www.billboard.com/charts/hot-100'))
+    scrape(doc)
+  end
+
+
+
+ 
+  def scrape(doc)
+    doc.css('.chart-data .chart-row').map do |entry|
+      song_info = {}
+      song_info[:chart_status] = { 
+        rank: entry.css('.chart-row__current-week').text, 
+        previous_week: entry.css('.chart-row__last-week .chart-row__value').text,
+        peak_position: entry.css('.chart-row__top-spot .chart-row__value').text,
+        weeks_charted: entry.css('.chart-row__weeks-on-chart .chart-row__value').text 
+      } 
+
+      song_info[:song] = { title: entry.css('.chart-row__song').text, 
+                           spotify_link: parse_spotify_link_if_present(entry), 
+                           vevo_link: parse_vevo_link_if_present(entry) }
+
+      song_info[:artist] = { name: entry.css(".chart-row__artist").text.strip }
+      create_song_from_scraper(song_info)
+    end
+  end
+
+
+  def create_song_from_scraper(song_info)
+    song = Song.create(song_info[:song])
+    Artist.create_by_list_name(song_info[:artist]).each { |artist| song.artists << artist }
+    song.chart_status = ChartStatus.new(song_info[:chart_status])
+
+    song.chart_status.song = song
+    song.artists.each { |artist| artist.songs << song }
+  end
+
+
+  def parse_spotify_link_if_present(entry)
+    if !entry.css('.js-spotify-play-full').empty?
+      entry.css('.js-spotify-play-full').attr('data-href').text
+    else
+      "error"
+    end
+  end
+
+    def parse_vevo_link_if_present(entry)
+    if !entry.css('.js-chart-row-vevo').empty?
+      entry.css('.js-chart-row-vevo').attr('data-href').text
+    else
+      "error"
+    end
+  end
+
+
+end

data/lib/Hot_100_CLI/chart_status.rb

@@ -0,0 +1,48 @@
+class ChartStatus
+
+  attr_accessor :song, :rank, :weeks_charted, :peak_position, :previous_week
+
+  def initialize(song_info)
+    @rank = song_info[:rank].to_i
+    @previous_week = song_info[:previous_week].to_i
+    @peak_position = song_info[:peak_position].to_i
+    @weeks_charted = song_info[:weeks_charted].to_i
+  end
+
+
+  def self.new_songs
+    Song.all.select { | song | song.previous_week == "--" }
+  end
+
+  def is_new?
+    previous_week == "--"
+  end
+
+  def position_change
+    if previous_week > rank
+      puts "#{song.title} moved up from \##{previous_week} to \##{rank}!"
+    elsif previous_week < rank
+      puts "#{song.title} moved down from \##{previous_week} to \##{rank}."
+    elsif previous_week == rank
+      puts "#{song.title} remained at #{rank}."
+    end
+  end
+
+  def peak_status
+    if rank == peak_position
+      puts "It's currently at it's peak position!!"
+    else
+      puts "It's down from it's peak position, which was number #{peak_position}."
+    end  
+  end
+
+  def weeks_status
+    puts "#{song.title} has been on the charts for #{weeks_charted} weeks."
+  end
+    
+
+
+
+
+
+end

data/lib/Hot_100_CLI/cli.rb

@@ -0,0 +1,196 @@
+require 'Launchy'
+class Hot100::CLI
+
+  def call
+    puts 'Starting...'
+    puts ' '
+    BillboardScraper.new
+    greeting
+    display_songs_in_range("1-10")
+    puts "You may now choose to view the rest of the list or get more information on any of the songs on the list by typing the appropriate command. For a list of commands, type 'help'."
+    puts " "
+    menu
+    farewell
+  end
+
+  def greeting
+    puts "Hello, Welcome to the Billboard Top 100 CLI"
+    puts " "
+    puts "These are the top ten songs this week!"
+    puts " "
+    puts "For the full list type 'hot 100'!"
+  end 
+
+  def menu
+    input = nil
+    while input != "exit" do
+      puts "Please enter a command:"
+      input = gets.chomp.downcase
+      case input
+      when "hot 100"
+        display_songs_in_range("1-100")
+      when /\A\d+\z/
+         chart_index_if_valid(input)
+      when /\A\d+-\d+\z/
+        chart_range_if_valid(input)
+      when /\Aartist\s.+/
+        display_artist_songs(input) 
+      when /\Aartists\z/
+        display_artist_list
+      when /\Asong\s.+/
+        more_info_song(input) 
+      when "help"
+        list_commands
+      when "exit"
+        puts "Aw that's it?"
+      else
+        puts "That command seems to be invalid, type 'help' for a list of commands."
+      end
+    end
+  end
+
+  def list_commands
+    puts "To see the full billboard list, type hot 100. Otherwise enter a range of entries to view"
+    puts "For more info on a song, type 'song' followed by that song's name or chart position"
+    puts "To see all charted songs by a particular artist, type 'artist' followed by that artist's name"
+    puts "To exit, simply type exit"
+    puts "For help, type help, but I think you have this one figured out already."
+  end
+
+  def farewell
+    puts "See You Next Tuesday."
+  end
+
+  def display_artist_songs(input)
+    artist = Artist.find_by_name(input.split('artist ')[1])
+    if artist
+      puts ' '
+      puts "This week, #{artist.name} charted these songs:"
+      puts ' '
+      artist.songs.each { |song| puts "#{song.rank}. #{song.title}" }
+      puts ' '
+    else
+      puts ' '
+      puts "That artist isn't on the charts this week. Maybe next week?"
+      puts ' '
+    end
+  end
+
+  def more_info_song(input)
+    if !input[/\Asong/]
+      song = Song.find_by_rank(input)
+    else
+      song = Song.find_by_title(input.split("song ")[1])
+    end
+    if song
+      puts ' '
+      puts "     #{song.title}"
+      puts  "          By #{song.artist_listing}"
+      puts ' '
+      puts "This week, #{song.title} was number #{song.rank} on the Billboard Top 100 Charts."
+      puts ' '
+      song_history(song)
+      ask_to_play_song(song)
+    else
+      puts "That song doesn't seem to be on the charts this week."
+    end
+  end
+
+  def valid_range?(range)
+    range[0].between?(1,99) && range[1].between?(2,100) && range[0] < range[1]
+  end
+
+  def split_input_to_range(input)
+    input.split("-").map { |num| num.to_i }
+  end
+
+  def display_songs_in_range(input)
+    range = split_input_to_range(input)
+    songs = Song.all.select do |song|
+      song.rank >= range[0] && range[1] >= song.rank
+    end 
+    display_songs(songs)
+  end
+
+  def display_songs(songs)
+    songs.each { |song| puts "#{song.rank}. #{song.title} - #{song.artist_listing}" }
+    puts " "
+    puts "For more info on a song, please type it's rank or type 'song ' then the song's title."
+  end
+
+
+  def ask_to_play_song(song)
+    puts ' '
+    puts 'To listen to this song on spotify, type \'listen\'. To watch this song\'s music video, type \'watch\'. Otherwise, type \'exit\'.'
+    puts ' '
+    input = gets.chomp
+    if input == 'listen'
+      launch_spotify_link(song)
+    elsif input == 'watch'
+      launch_vevo_link(song)
+    end
+  end
+
+  def launch_spotify_link(song)
+    if song.spotify_link != 'error'
+      Launchy.open(song.spotify_link)
+      puts ' '
+      puts '♪ ♪ ♪ Enjoy!♪ ♪ ♪' 
+      puts ' '
+    else
+      puts ' '
+      puts 'Unfortunately, it this song is not on Spotify :('
+      puts ' '
+    end
+  end
+
+  def launch_vevo_link(song)
+    if song.vevo_link != 'error'
+      Launchy.open(song.vevo_link)
+      puts ' '
+      puts '♪ ♪ ♪ Enjoy!♪ ♪ ♪' 
+      puts ' '
+    else
+      puts ' '
+      puts 'Unfortunately, it this song is not on Vevo :('
+      puts ' '
+    end
+  end
+
+  def song_history(song) #need to add logic for a song returning to the top 100
+    if song.chart_status.is_new?
+      puts "This is #{song.title}'s debut week on the Hot 100 charts!"
+    else
+      song.chart_status.position_change
+      song.chart_status.peak_status
+      song.chart_status.weeks_status
+    end
+  end
+
+  def display_artist_list
+    Artist.all.each do |artist|
+      puts artist.name
+    end
+  end
+
+  def chart_range_if_valid(input)
+    if valid_range?(split_input_to_range(input))
+      display_songs_in_range(input)
+    else
+      puts "That number range feels off. Check your numbers and format and try again."
+    end
+  end
+
+  def chart_index_if_valid(input)
+    if input.to_i.between?(1,100) 
+          more_info_song(input)
+        else
+          puts "Not a valid entry, choose a number between 1 and 100"
+        end
+  end
+
+
+
+
+
+end

data/lib/Hot_100_CLI/song.rb

@@ -0,0 +1,69 @@
+require 'pry'
+class Song
+
+  attr_accessor :title, :artists, :spotify_link, :chart_status, :vevo_link
+
+  @@all = []
+
+  def initialize(title)
+    @title = title
+    @artists = []
+  end
+
+  def self.create(song_hash)
+    song = Song.new(song_hash[:title])
+    song.spotify_link = song_hash[:spotify_link]
+    song.vevo_link = song_hash[:vevo_link]
+    song.save
+    song
+  end
+
+  def self.all
+    @@all
+  end
+
+  def save
+    @@all << self
+  end
+
+  def self.find_by_title(title)
+    Song.all.detect { |song| song.title.downcase == title.downcase }
+  end
+
+  def self.find_by_rank(int)
+    Song.all.detect { |song| song.rank == int.to_i }
+  end
+
+
+  #association methods
+
+
+  def rank
+    chart_status.rank
+  end
+
+  def weeks_charted
+    chart_status.weeks_charted
+  end
+
+  def peak_position
+    chart_status.peak_position
+  end
+
+  def previous_week
+    chart_status.previous_week
+  end
+
+  def artist_listing
+    if artists.length < 3
+      artists.map { |artist| artist.name }.join(" Featuring ")
+    else
+      listing = artists[0].name + " Featuring " + artists[1].name
+      artists.each_with_index do |artist, i|
+        listing += " & " + artist.name if i > 1
+      end
+      listing
+    end
+  end
+
+end

data/lib/Hot_100_CLI/version.rb

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

data/lib/Hot_100_CLI.rb

@@ -0,0 +1,6 @@
+require_relative "Hot_100_CLI/version.rb"
+require_relative "./Hot_100_CLI/cli.rb"
+require_relative "./Hot_100_CLI/artist.rb"
+require_relative "./Hot_100_CLI/billboard_scraper.rb"
+require_relative "./Hot_100_CLI/chart_status.rb"
+require_relative "./Hot_100_CLI/song.rb"

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: Hot_100_CLI
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- NStephenson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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 Billboard Top 100 webpage and displays that information
+  in the command line.
+email:
+- nickstephenson90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Hot_100_CLI.gemspec
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/HOT-100-CLI
+- bin/console
+- bin/setup
+- lib/Hot_100_CLI.rb
+- lib/Hot_100_CLI/artist.rb
+- lib/Hot_100_CLI/billboard_scraper.rb
+- lib/Hot_100_CLI/chart_status.rb
+- lib/Hot_100_CLI/cli.rb
+- lib/Hot_100_CLI/song.rb
+- lib/Hot_100_CLI/version.rb
+homepage: https://github.com/NStephenson/Hot_100_CLI
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This gem allows users to view the Billboard Top 100 in the command line.
+test_files: []