top_100 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e21dac25608831639b77949e53ffafb7c0c4c252
-  data.tar.gz: b13d90db57f2109b578276d1cb4163efb5ea23e1
+  metadata.gz: 80b7a337d41c32d15679fbb43e063b7153c01dd2
+  data.tar.gz: 92bef06913a8b7e7476d25730f2c9741afe9b416
 SHA512:
-  metadata.gz: de7abbd93ef1cd9fc8b3dc80b8f48a080618d4e6302f1c3b8c177106a4b27c4f8f9e19c13d2faa7e6ecab7b03f45b9b96ab4618f783edc0094676b36aefc2993
-  data.tar.gz: aab81a239aab2d9497085dd6bea3cb4cf8501b2c9fa7a6afabd627b0b6d28383b513031cbb409b6ce58fbab9b7dea909a22f74529817fd753af334b12c05f92d
+  metadata.gz: 6de66ededf599ac13c1adff49bf8f52bd4ca3196b8c7538e913166356b80f3f745219fe885b50aea75e7751d4dc97d5c938af38df5ee05555879d4afb59fc143
+  data.tar.gz: ece663afd0399b4bec751db111e6b3b4676375dbcad91294c79c71d8d42a9d8671624e6a45e09898b214865f6e9c7855efc73b0f8a5fb29b6a072c244a6948a0

data/README.md

@@ -1,20 +1,10 @@
 # Top100
 
-This gem allows the user to interact with the Billboard's Top 100 via the command line interface. Users can acquire a real time list of trending songs and acquire more information about the artists responsible for the works. Users can also open up Spotify links in their default browser of any songs they wish to hear. Information is acquired through the use of the Nokogiri gem and OpenUri in order to scrape data and information from the Billboard website.
+This gem allows the user to interact with the Billboard's Top 100 via the command line interface. Users can acquire a real time list of trending songs and acquire more information about the artists responsible for the works. Users can also open up Spotify links in their default browser of any songs they wish to hear. Information is acquired through multiple sources, including RSS feeds, the Spotify API, and the Nokogiri gem and OpenUri for data scraping purposes.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'top_100', :git => 'https://github.com/viparthasarathy/top-100.git'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Type the following command in terminal: 
 
     $ gem install top_100
 
@@ -22,11 +12,6 @@ Or install it yourself as:
 
 After installation, execute the gem by inputting top_100 into the console. The user will now be able to interact with the gem and request more information about the Billboard Top 100 or read the biographical information about trending artists.
 
-## 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
 

data/bin/top_100

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "top_100"
+# require "bundler/setup"
+require_relative "../lib/top_100"
 
 CLI.new.call

data/lib/top_100/artist.rb

@@ -13,20 +13,12 @@ class Artist
     end
   end
 
-  def display_details
-    puts "Name: #{self.name}"
-    puts "From: #{self.location}"
-    puts "Formed: #{self.date} "
-    song_names = self.songs.map {|song| song.name}
-    puts "Currently Trending Songs: #{song_names.join(", ")}"
-    puts "Bio: #{self.bio}"
-  end
-
   def self.all
     @@artists
   end
 
   #Artists have unique names, search for a match using the name or create a new Artist object.
+  # ISSUE: song.artist_name and Artist.name will not match if the song has collaborators, meaning that a new artist object will be created each time.
   def self.find_or_create(artist_name)
     Artist.all.each {|artist| return artist if artist.name == artist_name}
     Artist.new(artist_name)

data/lib/top_100/billboard_scraper.rb

@@ -11,7 +11,10 @@ class BillboardScraper
       song_hash = {
         rank: rank,
         name: name,
-        #feed doesn't seem to offer an artist value, requiring us to extract artist name from description instead.
+        #ISSUE: RSS Parser feed doesn't seem to offer an artist value, requiring us to extract artist name from description instead. Alternatively, Nokogiri::XML can also open up the RSS information.
+        # Regardless, the HTML page has to be opened for the artist_url information, and as a result, the gem is suspectible to breaking due to front-end design changes.
+        #ISSUE: Collaborators saved as part of the artist name, which causes some difficulties with the search term for looking up the artist biography.
+        # One possible solution would be to compare artist_name and the artist_url slug value in order to determine where the artist name begins and ends and then save that value to song instead.
         artist_name: song.description.split("#{name} by ")[1].split(" ranks ##{rank}")[0],
         artist_url: billboard_page.css('a.chart-row__artist')[index].attribute('href').value + '/biography',
       }

data/lib/top_100/cli.rb

@@ -13,23 +13,6 @@ class CLI
     present_options
   end
 
-  def display_chart
-    if self.tracker >= 100
-      puts "There are no more songs to display."
-    else
-      20.times do
-        Song.all[self.tracker].display
-        self.tracker += 1
-      end
-    end
-  end
-
-  def display_artist(name)
-    artist = Artist.find_or_create(name)
-    artist.name == nil ? puts("Artist not found.") : artist.display_details
-    puts "--------------------------------"
-  end
-
   def present_options
     puts "Options: 1. type in 'exit' to exit. 2. type in 'next' for the next twenty songs. 3. type 'song' to play a song sample. 4. type in the full artist title of a song to learn more about the main artist."
     choice = gets.chomp
@@ -42,7 +25,7 @@ class CLI
     when 'song'
       puts "Enter the chart number of the song you would like to play."
       rank = gets.chomp
-      Song.play(rank)
+      play_song(Song.find_by_rank(rank))
       present_options
     else
       begin
@@ -55,4 +38,50 @@ class CLI
     end
   end
 
+  def play_song(song)
+    if song.nil?
+      puts "You've entered an invalid chart rank."
+    else
+      song.url = song.spotify_link
+      #check if song has a valid url, copyright issues with certain songs
+      if !!song.url
+        puts "Playing song..."
+        `open #{song.url}`
+      else
+        puts "Sorry, that artist does not have their song on Spotify."
+      end
+    end
+  end
+
+  def display_chart
+    if self.tracker >= 100
+      puts "There are no more songs to display."
+    else
+      20.times do
+        display_song(Song.all[self.tracker])
+        self.tracker += 1
+      end
+    end
+  end
+
+  def display_artist(name)
+    artist = Artist.find_or_create(name)
+    if artist.name == nil
+      puts "Artist not found."
+    else
+      song_names = artist.songs.map {|song| song.name}
+      puts "Name: #{artist.name}"
+      puts "From: #{artist.location}"
+      puts "Formed: #{artist.date} "
+      puts "Currently Trending Songs: #{song_names.join(", ")}"
+      puts "Bio: #{artist.bio}"
+    end
+    puts "--------------------------------"
+  end
+
+  def display_song(song)
+    puts "##{song.rank}: #{song.name} by #{song.artist_name}."
+    puts "--------------------------------"
+  end
+
 end

data/lib/top_100/song.rb

@@ -7,20 +7,15 @@ class Song
     @@songs << self
   end
 
-  def display
-    puts "##{self.rank}: #{self.name} by #{self.artist_name}."
-    puts "--------------------------------"
-  end
-
   #slug method used to help make query for spotify API request
   def slug
     self.name.gsub(/\s+/, "%20").delete('^a-zA-Z0-9\%').downcase
   end
 
-
   def spotify_link
     response = open("https://api.spotify.com/v1/search?q=#{self.slug}&type=track").read
     json_info = JSON.parse(response)
+    # songs share same track name, ensure that artist name includes the first artist to find a match.
     song_details = json_info["tracks"]["items"].find { |info| self.artist_name.downcase.include?(info["artists"][0]["name"].downcase) }
     song_details == nil ? nil : song_details["preview_url"]
   end
@@ -31,20 +26,8 @@ class Song
     @@songs
   end
 
-  def self.play(rank)
+  def self.find_by_rank(rank)
     song = Song.all.find {|song| song.rank == rank }
-    if song.nil?
-      puts "You've entered an invalid chart name."
-    else
-      song.url = song.spotify_link
-      #check if song has a valid url, copyright issues with certain songs
-      if !!song.url
-        puts "Playing song..."
-        `open #{song.url}`
-      else
-        puts "Sorry, that artist does not have their song on Spotify."
-      end
-    end
   end
 
 end

data/lib/top_100/version.rb

@@ -1,3 +1,3 @@
 module Top100
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: top_100
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - viparthasarathy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler