spotify_rec 1.1 → 1.6

data/lib/rec.rb

@@ -1,74 +1,84 @@
-class Rec
+# frozen_string_literal: true
 
+class Rec
   def initialize(user)
     @user_list = user.mylist
     @user = user
     @tracks = []
     @artists = []
     @genres = []
+    @prompt = TTY::Prompt.new
   end
 
+  # Prompts user to choose how many suggestions to generate
+  def amount_of_suggestions
+    system('clear')
+    puts '》  RECOMMENDATIONS  《'
+    amount = @prompt.ask('How many recommendations would you like to generate?'.colorize(:light_green)) do |q|
+      q.in '1-10'
+      q.messages[:range?] = 'Number must be between 1 and 10'
+    end
+    recommend(amount.to_i)
+  end
+
+  # Prompts user to select which recommendations to add to their playlist
+  def recommend(num)
+    system('clear')
+    recommendations = recommendations_generate(num)
+    cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
+    puts '》  RECOMMENDATIONS  《'.colorize(:light_green)
+    puts 'Select the recommendations you want to add to your playlist!'
+    selections = @prompt.multi_select('Hit enter with none selected to skip.', cleaned_recs)
+    clean_recommendations(selections)
+  end
+
+  # Sorts list items into arrays to be used in generating recommendations
   def sort_my_list
     @tracks.clear
     @artists.clear
     @genres.clear
     @user_list.each do |item|
-      @tracks << item["id"] if item["type"] == "track"
-      @artists << item["id"] if item["type"] == "artist"
-      @genres << item["name"].downcase if item["type"] == "genre"
+      @tracks << item['id'] if item['type'] == 'track'
+      @artists << item['id'] if item['type'] == 'artist'
+      @genres << item['name'].downcase if item['type'] == 'genre'
     end
   end
 
-  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|
-      f.puts JSON.pretty_generate(updated_data)
-    end
-    puts "Sweet! Your list has been updated!".colorize(:light_green)
-    $prompt.keypress("Press any key to return to the previous menu..")
-    menu = Menu.new(@user)
-    menu.menu_router
+  # 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 ")
+      details = track.split(' by ')
       song = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
-      song_details = {
-        "name" => song.name,
-        "id" => song.id,
-        "artist" => song.artists[0].name }
-      @user.playlist << song_details
+      song_details(song)
     end
     update_file
   end
 
-  def recommend(num)
-    system("clear")
-    sort_my_list
-    recommendations = RSpotify::Recommendations.generate(limit: num, seed_artists: @artists, seed_genres: @genres, seed_tracks: @tracks)
-    cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
-    puts "》  RECOMMENDATIONS  《".colorize(:light_green)
-    puts "Select the recommendations you want to add to your playlist!"
-    selections = $prompt.multi_select("Hit enter with none selected to skip.", cleaned_recs)
-    clean_recommendations(selections)
+  # Pulls song details from track and stores in a hash. Pushes to user playlist array
+  def song_details(song)
+    song_details = {
+      'name' => song.name,
+      'id' => song.id,
+      'artist' => song.artists[0].name
+    }
+    @user.playlist << song_details
   end
 
-  def amount_of_suggestions
-    system("clear")
-    if @user_list.length <= 0
-      puts "Uh oh! You don't have any items in your list yet, so we can't generate any 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
-    puts "》  RECOMMENDATIONS  《"
-    amount = $prompt.ask("How many recommendations would you like to generate?".colorize(:light_green)) do |q|
-      q.in '1-10'
-      q.messages[:range?] = "Number must be between 1 and 10"
+  # 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|
+      f.puts JSON.pretty_generate(updated_data)
     end
-    recommend(amount.to_i)
+    puts 'Sweet! Your list has been updated!'.colorize(:light_green)
+    @prompt.keypress('Press any key to return to the previous menu..')
+    menu = Menu.new(@user)
+    menu.menu_router
   end
-
-
-end
+end

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/tutorial.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Contains methods to display tutorial screens
+module Tutorial
+  @prompt = TTY::Prompt.new
+
+  def start
+    system('clear')
+    puts '》  WELCOME TO SPOTIFY REC  《'.colorize(:light_green)
+    puts 'This tutorial will walk you through the basics to using the app.'
+    puts "There are 3 main areas that you'll need to understand:"
+    puts '- My List'
+    puts '- Recommendations'
+    puts '- Playlist'
+    puts
+    @prompt.keypress('Press any key to continue..')
+    my_list
+  end
+
+  def my_list
+    system('clear')
+    puts '》  MY LIST  《'.colorize(:light_green)
+    puts 'My List is the base that your recommendations are generated from. It can consist of'
+    puts "up to 5 of any 'items'. An item is either a track, artist or genre. You can add and remove"
+    puts 'items from my list, so make sure to change them up regularly to get a range of recommendations!'
+    puts "Searching for an item will return the top 5 results for your keywords, so if yours doesn't show"
+    puts 'up, try searching again with a more specific query!'
+    puts
+    @prompt.keypress('Press any key to continue..')
+    recommendations
+  end
+
+  def recommendations
+    system('clear')
+    puts '》  RECOMMENDATIONS  《'.colorize(:light_green)
+    puts 'As mentioned on the previous screen, recommendations are tracks, and are generated based on the'
+    puts "items in your list. You can select the amount you'd like to generate, and select any number of"
+    puts 'the recommendations to store in your playlist. Recommendations are capped at 10 per generate,'
+    puts 'but you can repeat the generate step as many times as you would like.'
+    puts
+    @prompt.keypress('Press any key to continue..')
+    playlist
+  end
+
+  def playlist
+    system('clear')
+    puts '》  PLAYLIST 《'.colorize(:light_green)
+    puts "Your playlist stores all of the recommendations you've chosen, but you can also manually add and"
+    puts "remove songs as well. This can all be done from the playlist menu. At any point you'd like to look"
+    puts 'at your playlist outside of Spotify Rec, you can export the contents to a file on your desktop.'
+    puts 'This file includes a link to each song on Spotify, so you can easily go and start listening!'
+    puts
+    @prompt.keypress('Press any key to return to finish..')
+    exit
+  end
+end

data/lib/user.rb

@@ -1,69 +1,93 @@
-class User
-
-  attr_reader :username, :password, :uid
-  attr_accessor :playlist, :mylist
-
-  def initialize(username, password, uid, playlist=[], mylist=[])
-    @username = username
-    @password = password
-    @playlist = playlist
-    @uid = uid
-    @mylist = mylist
-  end
-
-  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.account_details
-  end
-
-  def change_username(new_name)
-    updated_data = Login.load_data.each { |user| user["username"] = new_name if user["id"] == Login::user.uid.to_s }
-    File.open((Login::userdata),"w") do |f|
-      f.puts JSON.pretty_generate(updated_data)
-    end
-    @username = new_name
-    puts "Success! Your new username is #{Login::user.username}".colorize(:light_green)
-    $prompt.keypress("Press any key to continue..")
-    menu = Menu.new(Login::user)
-    menu.account_details
-  end
-
-  def change_password(new_password)
-    updated_data = Login.load_data.each { |user| user["password"] = new_password if user["id"] == Login::user.uid.to_s }
-    File.open((Login::userdata),"w") do |f|
-      f.puts JSON.pretty_generate(updated_data)
-    end
-    @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.account_details
-  end
-
-  def delete_from_file
-    updated_data = []
-    Login.load_data.each { |user| updated_data << user unless user["id"] == Login::user.uid.to_s }
-    File.open((Login::userdata),"w") do |f|
-      f.puts JSON.pretty_generate(updated_data)
-    end
-    puts "Your account has been deleted. The program will now exit.".colorize(:light_red)
-    $prompt.keypress("Press any key to continue..")
-    exit
-  end
-  
-
-  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)
-    unless selection
-      menu = Menu.new(Login::user)
-    else
-      delete_from_file
-    end
-  end
-
-end
+# frozen_string_literal: true
+
+# An instance of User should be made for everyone who logs in or signs up
+class User
+  attr_reader :username, :password, :uid
+  attr_accessor :playlist, :mylist
+
+  def initialize(username, password, uid, playlist = [], mylist = [])
+    @username = username
+    @password = password
+    @playlist = playlist
+    @uid = uid
+    @mylist = mylist
+    @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(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 #{@username}".colorize(:light_green)
+    @prompt.keypress('Press any key to continue..')
+    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'] == @uid.to_s
+    end
+    File.open(Login.userdata, 'w') do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+  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(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
+    end
+    File.open(Login.userdata, 'w') do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+  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))
+    if selection
+      delete_from_file
+    else
+      menu = Menu.new(Login.user)
+      menu.account_details
+    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 }
+    File.open(Login.userdata, 'w') do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    puts 'Your account has been deleted. The program will now exit.'.colorize(:light_red)
+    @prompt.keypress('Press any key to continue..')
+    exit
+  end
+end

data/public/users.json

@@ -1,13 +1 @@
-[
-  {
-    "id": "1",
-    "username": "benahale",
-    "password": "Tsurani7",
-    "playlist": [
-
-    ],
-    "mylist": [
-
-    ]
-  }
-]
+[]

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: spotify_rec
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.6'
 platform: ruby
 authors:
 - Ben Ahale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 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:
@@ -18,12 +74,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/spotify_rec
+- lib/error.rb
 - lib/login.rb
 - lib/menu.rb
 - lib/my_list.rb
 - lib/playlist.rb
 - lib/rec.rb
-- lib/run.rb
+- lib/spec/rec_spec.rb
+- lib/spec/user_spec.rb
+- lib/tutorial.rb
 - lib/user.rb
 - public/users.json
 homepage: 
@@ -38,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="