spotify_rec 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aedef30b3d8aaab2ded28d2dd23ed182260d8283b71a32d5151c1b65c460a17f
-  data.tar.gz: f20aabc8176459235bcba6d93d494444a0ce12ad71b1e997ef131d7a21ec7b88
+  metadata.gz: 6e297d8af48b8d8d7ab6c0636518af40d7051e794ab637c725d544ecfa68679e
+  data.tar.gz: 2297ec4f7c3cfe5372eb30b6b5df7cd5fcf269e56857f9a014f9d9b378a6a8c6
 SHA512:
-  metadata.gz: '068560977ff939f24cd508d75fe362788bb4904eebbf8a45f1ad96cd0bfbf812c0d6bf2d6b3a448ada677eca18ca2d3ff7687a45fde2bc84072c2a7c7a735f61'
-  data.tar.gz: cb5eac0f4cf7ef13c9c4c532e7ed465f4a59aa35f3e30585cdfcbc0d0ba70478b1d17e855b9f997aae74c8d02984b448b2aeac95e9b6ea3f46b22b3dfb1ba9dd
+  metadata.gz: c84dcb222e6107e57ac132796adfc3e05c6562063cfbb2f94cba521c669d095b359f49f0c1653b6395a89bd9c24bc132861b6b09fe6a454d2680a56b6fda0b92
+  data.tar.gz: 88a353cd4e84c0c465e4406bc899acbabe80cde04aee16ac123d019c258cb9508690ac981956b138f7f6bca2a31850c23b709bf67c80323d936cdccf8bc130a9

data/bin/spotify_rec

@@ -25,7 +25,7 @@ include Tutorial
 
 RSpotify.authenticate('712ff89a218a4e6dbe1f169e06f949b9', 'e9e0517f405b4a01a1be8823126459b7')
 
-VERSION = 1.0
+VERSION = 1.5
 
 ARGV << '--run' if ARGV.empty?
 
@@ -54,7 +54,7 @@ parser = OptionParser.new do |opts|
   end
 
   opts.on('-r', '--run', 'Run the application') do
-    Login.login
+    Login.initial_login
   end
 end
 

data/lib/login.rb

@@ -7,22 +7,20 @@ module Login
   @count = 0
 
   # Login Logic Section
+  # Prompts the user to indicate whether they are a new or returning user
   def initial_login
     clear
     ascii_art
     puts '》  Welcome to the Spotify Recommendations App!  《'.colorize(:light_green)
     puts
-    @prompt.select("Are you a new or returning user? \n", %w[New Returning])
-  end
-
-  def login
-    new_returning = initial_login.downcase
-    new_user if new_returning == 'new'
-    returning_user if new_returning == 'returning'
+    selection = @prompt.select("Are you a new or returning user? \n", %w[New Returning])
+    new_user if selection == 'New'
+    returning_user if selection == 'Returning'
   end
 
   # New user
-
+  # Prompts user to enter username for new account. Checks name for any special characters.
+  # Raises error if special character is included, and prompts the user again.
   def new_user
     system('clear')
     File.open(userdata, 'w') { |f| f.write([].to_json) } unless File.exist?(userdata)
@@ -36,6 +34,7 @@ module Login
     new_user
   end
 
+  # Prompts for new password. Validates password so no special characters are included.
   def new_user_password(username)
     password = @prompt.mask('Password >')
     raise RequirementError.new, 'Requirements not met' if password.match?(/[!@#$%^&*(),.?":{}|<>]/)
@@ -47,6 +46,7 @@ module Login
     puts 'Password cannot contain special characters. Please try again!'.colorize(:light_red)
   end
 
+  # Converts user details into a hash, ready to be stored in JSON file
   def store_user
     data = load_data
     user_details = {
@@ -60,6 +60,7 @@ module Login
     write_user(data)
   end
 
+  # Writes the hash of user data to the JSON file
   def write_user(data)
     File.open(userdata, 'w') do |f|
       f.puts JSON.pretty_generate(data)
@@ -70,7 +71,7 @@ module Login
   end
 
   # Returning user
-
+  # Prompts user to enter username and password
   def returning_user
     system('clear')
     File.open(userdata, 'w') { |f| f.write([].to_json) } unless File.exist?(userdata)
@@ -80,11 +81,13 @@ module Login
     authenticate(username, user_password)
   end
 
+  # Loads data from JSON file
   def authenticate(username, user_password)
     data_arr = load_data
     user_data(data_arr, username, user_password)
   end
 
+  # Checks whether supplied username and password match any in the userfile
   def user_data(data, username, user_password)
     data.each do |hash|
       next unless hash['username'].downcase == username.downcase
@@ -98,6 +101,7 @@ module Login
     no_auth
   end
 
+  # Method exits application if user is unsuccessful 3 times or more. Otherwise returns to login
   def no_auth
     puts 'Incorrect username or password!'.colorize(:red)
     sleep(1)
@@ -109,7 +113,6 @@ module Login
   end
 
   # Helper Module Methods
-
   def user
     @user
   end

data/lib/menu.rb

@@ -5,27 +5,48 @@ class Menu
     @user = user
     @prompt = TTY::Prompt.new
     @playlist = Playlist.new(@user)
+    @list_length = @user.mylist.length
   end
 
+  # Prompts the user to select an item on the menu
   def display_menu
     system('clear')
     arr = ['My List', 'Recommendations', 'Playlist', 'Account Details', 'Exit']
     @prompt.select("》  MAIN MENU  《\n".colorize(:light_green), arr)
   end
 
+  # Begins to case the user selection from the menu
   def menu_router
     selection = display_menu
     case selection
     when 'My List'
       my_list
     when 'Recommendations'
+      recommendations_menu
+    else
+      case_menu(selection)
+    end
+  end
+
+  # Opens the recommendations menu
+  def recommendations_menu
+    if @list_length.positive?
       recommendation = Rec.new(@user)
       recommendation.amount_of_suggestions
     else
-      case_menu(selection)
+      no_items
     end
   end
 
+  # Sends user back to menu if they don't have any items in 'MyList' yet
+  def no_items
+    puts "Uh oh! You don't have any items in your list yet, so we can't generate any".colorize(:light_red)
+    puts 'recommendations. Please add some before doing this!'.colorize(:light_red)
+    @prompt.keypress('Press any key to return to the previous menu..')
+    display_menu
+  end
+
+  # Continues to case the menu selection and route the user
   def case_menu(selection)
     case selection
     when 'Playlist'
@@ -37,6 +58,7 @@ class Menu
     end
   end
 
+  # Shows the MyList menu
   def my_list
     system('clear')
     selection = @prompt.select("》  MY LIST  《\n".colorize(:light_green), %w[Display Add Remove Back])
@@ -44,6 +66,7 @@ class Menu
     case_my_list(selection, mylist)
   end
 
+  # Cases the selection from the MyList menu and routes to the required method
   def case_my_list(selection, mylist)
     case selection
     when 'Display'
@@ -57,12 +80,14 @@ class Menu
     end
   end
 
+  # Prompts the user to select from the Account details menu
   def account_details_select
     system('clear')
     arr = ['View Details', 'Change Username', 'Change Password', 'Delete Account', 'Back']
     @prompt.select('》  ACCOUNT DETAILS  《\n'.colorize(:light_green), arr)
   end
 
+  # Cases the account details menu and routes the user
   def account_details
     selection = account_details_select
     case selection
@@ -76,6 +101,7 @@ class Menu
     end
   end
 
+  # Continues to case the account details menu and route the user
   def case_account_details(selection)
     case selection
     when 'Change Password'

data/lib/my_list.rb

@@ -9,7 +9,7 @@ class MyList
   end
 
   # Display MyList
-
+  # Displays items in MyList. Raises error if no items in list
   def list
     raise MyListEmpty.new, 'List must not be empty' if @mylist.empty?
 
@@ -20,6 +20,7 @@ class MyList
     empty_list
   end
 
+  # Generates the list in table view and prints it to the screen
   def list_table
     rows = @mylist.map do |hash|
       if hash['type'] == 'track' || hash['type'] == 'album'
@@ -32,6 +33,7 @@ class MyList
     puts table
   end
 
+  # Tells the user they have no items in their list, and returns to menu
   def empty_list
     puts 'Oh no! Your list is currently empty!'.colorize(:light_red)
     puts 'Add up to 5 items to your list. An item can be a song, artist or genre.'.colorize(:light_red)
@@ -41,13 +43,14 @@ class MyList
   end
 
   # Add to MyList
-
+  # Prompts the user to specify what type of item to add
   def add_to_list
     list_too_long if @mylist.length >= 5
     selection = @prompt.select('Which type would you like to add?'.colorize(:light_green), %w[Song Artist Genre Back])
     case_add_to_list(selection)
   end
 
+  # Returns user to menu if the MyList has too many items
   def list_too_long
     puts "Oh no! You've reached maximum capacity in your list! You won't be able to add".colorize(:light_red)
     puts 'another item until you remove an existing one.'.colorize(:light_red)
@@ -56,6 +59,7 @@ class MyList
     @menu.my_list
   end
 
+  # Cases the add to list selection and routes the user
   def case_add_to_list(selection)
     case selection
     when 'Song'
@@ -69,6 +73,7 @@ class MyList
     end
   end
 
+  # Prompts user for song name and searches spotify. Prompts user to select a result
   def search_song
     song_query = @prompt.ask('What is the name of the song?'.colorize(:light_green))
     tracks = RSpotify::Track.search(song_query, limit: 5)
@@ -80,7 +85,8 @@ class MyList
     add_to_list if selection[0] == 'Back'
     store_song(selection)
   end
-
+  
+  # Stores the song in a hash ready to be written to the file
   def store_song(details)
     track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
     song_details = {
@@ -93,6 +99,7 @@ class MyList
     update_file
   end
 
+  # Prompts user for artist name, searches for the artist and prompts user to select a result
   def search_artist
     artist_query = @prompt.ask('What is the name of the artist?'.colorize(:light_green))
     artists = RSpotify::Artist.search(artist_query, limit: 5)
@@ -103,6 +110,7 @@ class MyList
     store_artist(selection)
   end
 
+  # Stores the artist details in a hash, ready to be written to userfile
   def store_artist(details)
     artist = RSpotify::Artist.search(details.to_s, limit: 1).first
     artist_details = {
@@ -114,6 +122,7 @@ class MyList
     update_file
   end
 
+  # Prompts user to select genre from the list. Stores details in hash to be written to file
   def store_genre
     genres = RSpotify::Recommendations.available_genre_seeds
     genre = @prompt.select('Which genre would you like to add to your list?', genres, filter: true)
@@ -126,7 +135,7 @@ class MyList
   end
 
   # Remove From MyList
-
+  # Prompts user to select item to remove from MyList. Removes item from mylist array
   def remove_from_list
     empty_list if @mylist.length <= 0
     item_names = @mylist.map { |item| item['name'] }
@@ -140,7 +149,7 @@ class MyList
   end
 
   # Update userfile
-
+  # Writes the user MyList to the userfile
   def update_file
     updated_data = Login.load_data.each { |user| user['mylist'] = @mylist if user['id'] == @user.uid.to_s }
     File.open(userdata, 'w') do |f|

data/lib/playlist.rb

@@ -10,7 +10,7 @@ class Playlist
   end
 
   # Playlist Menu Section
-
+  # Prompts user to select an item from the menu
   def menu
     system('clear')
     selection = @prompt.select('》  PLAYLIST  《', ['Display', 'Add', 'Remove', 'Export To File', 'Back'])
@@ -22,6 +22,7 @@ class Playlist
     end
   end
 
+  # Cases the user selection and routes the user
   def case_menu(selection)
     case selection
     when 'Add'
@@ -33,6 +34,7 @@ class Playlist
     end
   end
 
+  # Continues to case the selection and route the user
   def second_case_menu(selection)
     case selection
     when 'Export To File'
@@ -44,7 +46,7 @@ class Playlist
   end
 
   # View Playlist
-
+  # Generates table from user playlist and prints it to the screen
   def list
     puts '》  PLAYLIST  《'
     empty if @playlist.empty?
@@ -55,6 +57,7 @@ class Playlist
     menu
   end
 
+  # Tells user if their playlist is empty and sends them back to the menu
   def empty
     puts 'Oh no! Your playlist is currently empty!'
     puts 'You can add songs manually from the previous menu, or generate recommendations and add those!'
@@ -64,7 +67,7 @@ class Playlist
   end
 
   # Add to Playlist
-
+  # Prompts user to enter song name, searches for song and prompts user to select a result
   def add
     song_query = @prompt.ask('What is the name of the song?')
     tracks = RSpotify::Track.search(song_query, limit: 5)
@@ -77,6 +80,7 @@ class Playlist
     store(selection)
   end
 
+  # Turns song details into a hash and adds to playlist array
   def store(details)
     track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
     song_details = {
@@ -89,7 +93,7 @@ class Playlist
   end
 
   # Remove from Playlist
-
+  # Prompts user to select item in playlist to remove and deleted from playlist array
   def remove
     empty if @playlist.length <= 0
     item_names = @playlist.map { |item| "#{item['name']} by #{item['artist']}" }
@@ -103,7 +107,7 @@ class Playlist
   end
 
   # Update Playlist in file
-
+  # Loads userdata and updates playlist in file. Returns the user to the menu
   def update_playlist
     updated_data = Login.load_data.each { |user| user['playlist'] = @playlist if user['id'] == @user.uid.to_s }
     File.open(Login.userdata, 'w') do |f|
@@ -115,7 +119,7 @@ class Playlist
   end
 
   # Export playlist to file
-
+  # Writes user playlist information to a markdown file
   def export_to_file
     path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
     File.open("#{path}/playlist.md", 'w') do |f|
@@ -128,6 +132,7 @@ class Playlist
     copy_to_desktop(path)
   end
 
+  # Copies markdown file to desktop for easy access
   def copy_to_desktop(path)
     system("cp #{path}/playlist.md ~/Desktop/playlist.md")
     puts 'Exported playlist to your Desktop!'

data/lib/rec.rb

@@ -10,9 +10,9 @@ class Rec
     @prompt = TTY::Prompt.new
   end
 
+  # Prompts user to choose how many suggestions to generate
   def amount_of_suggestions
     system('clear')
-    too_many_items if @user_list.length > 5
     puts '》  RECOMMENDATIONS  《'
     amount = @prompt.ask('How many recommendations would you like to generate?'.colorize(:light_green)) do |q|
       q.in '1-10'
@@ -21,14 +21,7 @@ class Rec
     recommend(amount.to_i)
   end
 
-  def too_many_items
-    puts "Uh oh! You don't have any items in your list yet, so we can't generate any".colorize(:light_red)
-    puts 'recommendations. Please add some before doing this!'.colorize(:light_red)
-    @prompt.keypress('Press any key to return to the previous menu..')
-    menu = Menu.new(@user)
-    menu.display_menu
-  end
-
+  # Prompts user to select which recommendations to add to their playlist
   def recommend(num)
     system('clear')
     recommendations = recommendations_generate(num)
@@ -39,6 +32,7 @@ class Rec
     clean_recommendations(selections)
   end
 
+  # Sorts list items into arrays to be used in generating recommendations
   def sort_my_list
     @tracks.clear
     @artists.clear
@@ -50,11 +44,13 @@ class Rec
     end
   end
 
+  # Generates recommendations with RSpotify
   def recommendations_generate(num)
     sort_my_list
     RSpotify::Recommendations.generate(limit: num, seed_artists: @artists, seed_genres: @genres, seed_tracks: @tracks)
   end
 
+  # Searches again for song selections to get the track object rather than just the name and artist
   def clean_recommendations(selections)
     selections.each do |track|
       details = track.split(' by ')
@@ -64,6 +60,7 @@ class Rec
     update_file
   end
 
+  # Pulls song details from track and stores in a hash. Pushes to user playlist array
   def song_details(song)
     song_details = {
       'name' => song.name,
@@ -73,6 +70,7 @@ class Rec
     @user.playlist << song_details
   end
 
+  # Updates file with current user playlist
   def update_file
     updated_data = Login.load_data.each { |user| user['playlist'] = @user.playlist if user['id'] == @user.uid.to_s }
     File.open(userdata, 'w') do |f|

data/lib/spec/rec_spec.rb

@@ -0,0 +1,24 @@
+require 'rspotify'
+require_relative '../user'
+
+RSpotify.authenticate('712ff89a218a4e6dbe1f169e06f949b9', 'e9e0517f405b4a01a1be8823126459b7')
+
+describe 'Recommendations' do
+  it 'should generate a list of recommendations' do
+    genre = 'pop'
+    recommendations = RSpotify::Recommendations.generate(limit: 5, seed_genres: [genre])
+    expect(recommendations.tracks.length).to eq(5)
+  end
+
+  it 'should take the first recommendation and add it to the user playlist' do
+    name = 'user'
+    password = 'password123'
+    uid = '12345'
+    user = User.new(name, password, uid)
+    genre = 'pop'
+    recommendations = RSpotify::Recommendations.generate(limit: 5, seed_genres: [genre])
+    track = recommendations.tracks.first
+    user.playlist << track
+    expect(user.playlist.length).to eq(1)
+  end
+end

data/lib/spec/user_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../user'
+require 'json'
+require 'tty-prompt'
+
+describe 'User' do
+  it 'should create a user with a name, password and user id' do
+    name = 'user'
+    password = 'password123'
+    uid = '12345'
+    user = User.new(name, password, uid)
+    expect(user.username).to eq('user')
+    expect(user.password).to eq('password123')
+    expect(user.uid).to eq('12345')
+  end
+
+  it 'should create a user and add a track to the users MyList' do
+    name = 'user'
+    password = 'password123'
+    uid = '12345'
+    user = User.new(name, password, uid)
+    song = {
+      'name': 'Gyalchester',
+      'artist': 'Drake',
+      'id': '6UjfByV1lDLW0SOVQA4NAi',
+      'type': 'track'
+    }
+    user.mylist << song
+    expect(user.mylist.first[:name]).to eq('Gyalchester')
+    expect(user.mylist.first[:artist]).to eq('Drake')
+    expect(user.mylist.first[:id]).to eq('6UjfByV1lDLW0SOVQA4NAi')
+  end
+end

data/lib/user.rb

@@ -14,29 +14,31 @@ class User
     @prompt = TTY::Prompt.new
   end
 
+  # Prints user details
   def details
     puts "Username: #{@username.colorize(:light_green)}"
     puts "Password: #{@password.colorize(:light_green)}"
     puts "User ID: #{@uid.to_s.colorize(:light_green)}"
     @prompt.keypress('Press any key to continue..')
-    menu = Menu.new(Login.user)
+    menu = Menu.new(self)
     menu.account_details
   end
 
   # Change Username section
-
+  # Changes user name and routes back to menu
   def change_username(new_name)
     update_username(new_name)
     @username = new_name
-    puts "Success! Your new username is #{Login.user.username}".colorize(:light_green)
+    puts "Success! Your new username is #{@username}".colorize(:light_green)
     @prompt.keypress('Press any key to continue..')
-    menu = Menu.new(Login.user)
+    menu = Menu.new(self)
     menu.account_details
   end
 
+  # Updates username in file
   def update_username(new_name)
     updated_data = Login.load_data.each do |user|
-      user['username'] = new_name if user['id'] == Login.user.uid.to_s
+      user['username'] = new_name if user['id'] == @uid.to_s
     end
     File.open(Login.userdata, 'w') do |f|
       f.puts JSON.pretty_generate(updated_data)
@@ -44,16 +46,17 @@ class User
   end
 
   # Change password section
-
+  # Changes user name and routes back to menu
   def change_password(new_password)
     update_password(new_password)
     @password = new_password
     puts 'Success! Your password has been changed.'.colorize(:light_green)
     @prompt.keypress('Press any key to continue..')
-    menu = Menu.new(Login.user)
+    menu = Menu.new(self)
     menu.account_details
   end
 
+  # Updates user password in file
   def update_password(new_password)
     updated_data = Login.load_data.each do |user|
       user['password'] = new_password if user['id'] == Login.user.uid.to_s
@@ -64,7 +67,7 @@ class User
   end
 
   # Delete account section
-
+  #Prompts user to confirm they would like to delete account.
   def delete_account
     puts 'Woah there! Deleting your account is serious business, and cannot be undone.'.colorize(:light_red)
     selection = @prompt.yes?('Are you sure you want to delete your account?'.colorize(:light_red))
@@ -76,6 +79,7 @@ class User
     end
   end
 
+  # Deletes user data from the userfile
   def delete_from_file
     updated_data = []
     Login.load_data.each { |user| updated_data << user unless user['id'] == Login.user.uid.to_s }

data/public/users.json

@@ -1,47 +0,0 @@
-[
-  {
-    "id": "1",
-    "username": "benahale",
-    "password": "password",
-    "playlist": [
-      {
-        "name": "44 More",
-        "id": "3e7Y6sfFlIdBMJhX7wpqVO",
-        "artist": "Logic"
-      },
-      {
-        "name": "Outnumbered",
-        "id": "6UjZ2Yx2g2a52XxiA8ONxZ",
-        "artist": "Dermot Kennedy"
-      }
-    ],
-    "mylist": [
-      {
-        "name": "Dermot Kennedy",
-        "id": "5KNNVgR6LBIABRIomyCwKJ",
-        "type": "artist"
-      },
-      {
-        "name": "MIDDLE CHILD",
-        "artist": "J. Cole",
-        "id": "2JvzF1RMd7lE3KmFlsyZD8",
-        "type": "track"
-      },
-      {
-        "name": "Pop",
-        "type": "genre"
-      },
-      {
-        "name": "Fool's Gold - Acoustic",
-        "artist": "Passenger",
-        "id": "4JPB2Kjr3lkMJFz4sZnt6G",
-        "type": "track"
-      },
-      {
-        "name": "Drake",
-        "id": "3TVXtAsR1Inumwj472S9r4",
-        "type": "artist"
-      }
-    ]
-  }
-]

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: spotify_rec
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
 platform: ruby
 authors:
 - Ben Ahale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
-dependencies: []
+date: 2020-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables:
@@ -24,6 +80,8 @@ files:
 - lib/my_list.rb
 - lib/playlist.rb
 - lib/rec.rb
+- lib/spec/rec_spec.rb
+- lib/spec/user_spec.rb
 - lib/tutorial.rb
 - lib/user.rb
 - public/users.json