spotify_rec 1.0 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00749e0a49528b3d680597ee48924685869ab8963027609a951f0d8e1bd6bfd6'
-  data.tar.gz: ead9a411308f5234a5b4d1919201e0721f1191304a3e486e5f75e644db23fe1b
+  metadata.gz: 6e297d8af48b8d8d7ab6c0636518af40d7051e794ab637c725d544ecfa68679e
+  data.tar.gz: 2297ec4f7c3cfe5372eb30b6b5df7cd5fcf269e56857f9a014f9d9b378a6a8c6
 SHA512:
-  metadata.gz: 88011906853f7d6e5e6e4fe650c5d474f0caa8534ee8ee590e7bd5178b48bf773a4b56c9d12f9fee97db0ce8affb8d7860a783330290ef4024c68e91a0aa43c7
-  data.tar.gz: cd0e528637accbbd6c8a15b6a6de7d58e8b21e04cabe9c73787c9fb8885db2056b27075a6fefd199be3a40924f050f53aec97be5e2bbe1d58d32684700d7dd39
+  metadata.gz: c84dcb222e6107e57ac132796adfc3e05c6562063cfbb2f94cba521c669d095b359f49f0c1653b6395a89bd9c24bc132861b6b09fe6a454d2680a56b6fda0b92
+  data.tar.gz: 88a353cd4e84c0c465e4406bc899acbabe80cde04aee16ac123d019c258cb9508690ac981956b138f7f6bca2a31850c23b709bf67c80323d936cdccf8bc130a9

data/bin/spotify_rec

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # gems
 require 'rspotify'
@@ -15,40 +16,46 @@ require_relative '../lib/login'
 require_relative '../lib/rec'
 require_relative '../lib/menu'
 require_relative '../lib/my_list'
+require_relative '../lib/tutorial'
+require_relative '../lib/error'
 
-#modules
+# modules
 include Login
+include Tutorial
 
-RSpotify.authenticate("712ff89a218a4e6dbe1f169e06f949b9", "e9e0517f405b4a01a1be8823126459b7")
-$prompt = TTY::Prompt.new
+RSpotify.authenticate('712ff89a218a4e6dbe1f169e06f949b9', 'e9e0517f405b4a01a1be8823126459b7')
 
-VERSION = 1.0
+VERSION = 1.5
 
 ARGV << '--run' if ARGV.empty?
 
 options = {}
 parser = OptionParser.new do |opts|
-    opts.banner = "Welcome to Spotify Recommendations! Usage: spotifyrec [options]".colorize(:light_green)
-
-    opts.on("-v", "--version", "Display the version") do
-        puts "Spotify Recommendations version #{VERSION}".colorize(:light_green)
-    end
-
-    opts.on("-h", "--help", "Display the help message") do
-        puts opts
-        exit
-    end
-
-    opts.on("-qGENRE", "--quick=GENRE", "Generate a quick recommendation with the chosen genre") do |genre|
-        recommendations = RSpotify::Recommendations.generate(limit: 5, seed_genres: [genre])
-        cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
-        puts "》  RECOMMENDATIONS  《".colorize(:light_green)
-        cleaned_recs.each { |track| puts track }
-    end
-
-    opts.on("-r", "--run", "Run the application") do
-        Login::login
-    end
+  opts.banner = 'Welcome to Spotify Recommendations! Usage: spotify_rec [options]'.colorize(:light_green)
+
+  opts.on('-v', '--version', 'Display the version') do
+    puts "Spotify Recommendations version #{VERSION}".colorize(:light_green)
+  end
+
+  opts.on('-h', '--help', 'Display the help message') do
+    puts opts
+    exit
+  end
+
+  opts.on('-t', '--tutorial', 'View a brief tutorial') do
+    Tutorial.start
+  end
+
+  opts.on('-qGENRE', '--quick=GENRE', 'Generate a quick recommendation with the chosen genre') do |genre|
+    recommendations = RSpotify::Recommendations.generate(limit: 5, seed_genres: [genre])
+    cleaned_recs = recommendations.tracks.map { |t| "#{t.name} by #{t.artists[0].name}" }
+    puts '》  RECOMMENDATIONS  《'.colorize(:light_green)
+    cleaned_recs.each { |track| puts track }
+  end
+
+  opts.on('-r', '--run', 'Run the application') do
+    Login.initial_login
+  end
 end
 
-parser.parse!
+parser.parse!

data/lib/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class RequirementError < StandardError
+end
+
+class MyListEmpty < StandardError
+end
+
+class UserFileError < StandardError
+end

data/lib/login.rb

@@ -1,117 +1,154 @@
-require_relative 'menu'
-
-module Login
-
-  def user
-    return @user
-  end
-
-  def userdata
-    path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
-    userfile = "#{path}/public/users.json"
-    return userfile
-  end
-
-  def clear
-    system("clear")
-  end
-
-  def initial_login
-    clear
-    puts "               ;;;;;;;;;;;;;;;;;;; 
-               ;;;;;;;;;;;;;;;;;;;
-               ;                 ;
-               ;                 ;
-               ;                 ;
-               ;                 ;
-               ;                 ;
-               ;                 ;
-           ,;;;;;            ,;;;;;
-           ;;;;;;            ;;;;;;
-           `;;;;'            `;;;;'
-           ".colorize(:light_green)
-    puts "》  Welcome to the Spotify Recommendations App!  《".colorize(:light_green)
-    puts
-    return $prompt.select("Are you a new or returning user? \n", %w(New Returning))
-  end
-
-  def load_data
-    file = File.read(userdata)
-    return JSON.parse(file)
-  end
-
-  def gen_uid
-    return load_data.length + 1
-  end
-
-  def store_user
-    data = load_data
-    user_details = {
-      "id" => "#{@user.uid}",
-      "username" => @user.username,
-      "password" => @user.password,
-      "playlist" => @user.playlist,
-      "mylist" => @user.mylist
-    }
-    data << user_details
-    File.open(userdata,"w") do |f|
-      f.puts JSON.pretty_generate(data)
-    end
-    puts "You're now registered! Logging you in..".colorize(:light_green)
-    sleep(1)
-    @menu = Menu.new(@user)
-    @menu.menu_router
-  end
-
-  def new_user
-    system("clear")
-    puts "Welcome! Please register for an account to continue.".colorize(:light_green)
-    username = $prompt.ask("Username >") { |u| u.validate(/\A[0-9a-zA-Z'-]*\z/, "Username must only contain letters and numbers")}
-    password = $prompt.mask("Password >")
-    @user = User.new(username, password, gen_uid)
-    @user_playlist = Playlist.new(@user)
-    store_user
-  end
-
-  def returning_user
-    system("clear")
-    puts "Welcome back! Please login to continue.".colorize(:light_green)
-    username = $prompt.ask("Username >")
-    password= $prompt.mask("Password >")
-    authenticate(username, password)
-  end
-
-  def authenticate(username, password)
-    data = load_data
-    auth = false
-    data.each do |hash|
-      if hash["username"].downcase == username.downcase
-        if hash["password"] == password
-          auth = true
-          @user = User.new(username, password, hash["id"], hash["playlist"], hash["mylist"])
-          @user_playlist = Playlist.new(@user)
-          puts "Success! Logging you in..".colorize(:light_green)
-          sleep(1)
-          @menu = Menu.new(@user)
-          @menu.menu_router
-        end
-      end
-    end
-    unless auth
-      puts "Incorrect username or password!".colorize(:red)
-      sleep(1)
-      returning_user
-    end
-  end
-
-  def login
-    new_returning = initial_login.downcase
-    if new_returning == "new"
-      new_user
-    end
-    if new_returning == "returning"
-      returning_user
-    end
-  end
-
-end
+# frozen_string_literal: true
+
+require_relative 'menu'
+
+module Login
+  @prompt = TTY::Prompt.new
+  @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
+    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)
+    puts 'Welcome! Please register for an account to continue.'.colorize(:light_green)
+    username = @prompt.ask('Username >')
+    raise RequirementError.new, 'Requirements not met' if username.match?(/[!@#$%^&*(),.?":{}|<>]/)
+
+    new_user_password(username)
+  rescue RequirementError
+    puts 'Username cannot contain special characters. Please try again!'.colorize(:light_red)
+    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?(/[!@#$%^&*(),.?":{}|<>]/)
+
+    @user = User.new(username, password, gen_uid)
+    @user_playlist = Playlist.new(@user)
+    store_user
+  rescue RequirementError
+    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 = {
+      'id' => @user.uid.to_s,
+      'username' => @user.username,
+      'password' => @user.password,
+      'playlist' => @user.playlist,
+      'mylist' => @user.mylist
+    }
+    data << user_details
+    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)
+    end
+    puts "You're now registered! Logging you in..".colorize(:light_green)
+    sleep(1)
+    go_to_menu
+  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)
+    puts 'Welcome back! Please login to continue.'.colorize(:light_green)
+    username = @prompt.ask('Username >')
+    user_password = @prompt.mask('Password >')
+    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
+
+      next unless hash['password'] == user_password
+
+      @user = User.new(username, user_password, hash['id'], hash['playlist'], hash['mylist'])
+      go_to_menu
+    end
+    @count += 1
+    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)
+    if @count >= 3
+      puts 'You have tried too many times! The application will now close..'.colorize(:light_red)
+      exit
+    end
+    returning_user
+  end
+
+  # Helper Module Methods
+  def user
+    @user
+  end
+
+  def gen_uid
+    load_data.length + 1
+  end
+
+  def userdata
+    path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
+    "#{path}/public/users.json"
+  end
+
+  def load_data
+    file = File.read(userdata)
+    JSON.parse(file)
+  end
+
+  def clear
+    system('clear')
+  end
+
+  def go_to_menu
+    menu = Menu.new(@user)
+    menu.menu_router
+  end
+
+  def ascii_art
+    puts "               ;;;;;;;;;;;;;;;;;;;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+               ;                 ;
+           ,;;;;;            ,;;;;;
+           ;;;;;;            ;;;;;;
+           `;;;;'            `;;;;'\n".colorize(:light_green)
+  end
+end

data/lib/menu.rb

@@ -1,67 +1,116 @@
-class Menu
-
-  def initialize(user)
-    @user = user
-    @prompt = prompt = TTY::Prompt.new
-    @playlist = Playlist.new(@user)
-  end
-
-  def display_menu
-    system("clear")
-    return @prompt.select("》  MAIN MENU  《\n".colorize(:light_green), (["My List", "Recommendations", "Playlist", "Account Details", "Exit"]))
-  end
-
-  def my_list
-    system("clear")
-    selection = @prompt.select("》  MY LIST  《\n".colorize(:light_green), (["Display", "Add", "Remove", "Back"]))
-    mylist = MyList.new(@user)
-    case selection
-      when "Display"
-        mylist.list
-      when "Add"
-        mylist.add_to_list
-      when "Remove"
-        mylist.remove_from_list
-      when "Back"
-        menu_router
-    end
-  end
-
-  def account_details
-    system("clear")
-    selection = @prompt.select("》  ACCOUNT MENU  《 \n".colorize(:light_green), (["View Details", "Change Username", "Change Password", "Delete Account", "Back"]))
-    case selection
-      when "View Details"
-        @user.details
-      when "Change Username"
-        username = @prompt.ask("Please enter your new username >") { |u| u.validate(/\A[0-9a-zA-Z'-]*\z/, "Username must only contain letters and numbers")}
-        @user.change_username(username)
-      when "Change Password"
-        password = @prompt.ask("Please enter your new password >")
-        @user.change_password(password)
-      when "Delete Account"
-        @user.delete_account
-      when "Back"
-        menu_router
-    end
-  end
-
-  def menu_router
-    selection = display_menu
-    case selection
-      when "My List"
-        system("clear")
-        my_list
-      when "Recommendations"
-        recommendation = Rec.new(@user)
-        recommendation.amount_of_suggestions
-      when "Playlist"
-        @playlist.menu
-      when "Account Details"
-        account_details
-      when "Exit"
-        exit
-    end
-  end
-
-end
+# frozen_string_literal: true
+
+class Menu
+  def initialize(user)
+    @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
+      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'
+      @playlist.menu
+    when 'Account Details'
+      account_details
+    when 'Exit'
+      exit
+    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])
+    mylist = MyList.new(@user)
+    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'
+      mylist.list
+    when 'Add'
+      mylist.add_to_list
+    when 'Remove'
+      mylist.remove_from_list
+    when 'Back'
+      menu_router
+    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
+    when 'View Details'
+      @user.details
+    when 'Change Username'
+      username = @prompt.ask('Please enter your new username >')
+      @user.change_username(username)
+    else
+      case_account_details(selection)
+    end
+  end
+
+  # Continues to case the account details menu and route the user
+  def case_account_details(selection)
+    case selection
+    when 'Change Password'
+      password = @prompt.ask('Please enter your new password >')
+      @user.change_password(password)
+    when 'Delete Account'
+      @user.delete_account
+    when 'Back'
+      menu_router
+    end
+  end
+end